Ceci est une ancienne révision du document !
Comment déposer un fichier sur le CTAN?
Vous avez quelque chose à déposer sur le CTAN? C'est une excellente nouvelle! C'est grâce à toutes les contributions individuelles que l'écosystème LaTeX se développe.
Que vérifier avant le dépôt?
Avant de commencer, voici une check-list des choses à régler:
Licence
Dans l'esprit de TeX, on attend des logiciels libres; dans l'esprit de la société juridicisée d'aujourd'hui, le CTAN propose une liste de licences «standards» parmi lesquelles vous pouvez choisir. Assurez-vous de faire apparaître clairement la licence sous laquelle votre contribution sera distribuée, quelque part dans les fichiers que vous déposez.
N'oubliez pas qu'une fois sur le CTAN, votre contribution est susceptible d'être incluse dans des distributions LaTeX… et par la suite, également dans des distributions de systèmes d'exploitation… Pour cela, les personnes qui vont ainsi s'occuper de redistribuer vos fichiers ont besoin d'une déclaration claire de vos intentions.
Documentation
C'est bien que les utilisateurs puissent consulter la documentation avant de télécharger une extension.
Vous avez besoin d'au moins un fichier README
en texte brut (les noms possibles sont “README”, “README.txt” et “README.md”,
mais aucune autre variante).
De plus, un fichier PDF de la documentation de votre travailo, préparé pour la lecture à l'écran, est hautement souhaitable. Le code-source de cette documentation doit aussi être fourni.
Nom
Les conflits de noms sont une source de confusion sans fin. Si votre extension a le même nom qu'une autre déjà présente sur le CTAN, ou si l'installation de votre extension produit des fichiers de même nom que d'autres qu'on peut trouver dans une distribution «normale», l'équipe du CTAN retardera la procédure pendant qu'elle vérifiera que vous faites bien ce qu'il faut: elle pourra vous harceler pour changer le nom, ou pour négocier une collaboration avec l'auteur de l'extension originale. Parcourez le CTAN pour vous assurer de l'unicité du nom que vous voulez.
Le nom que vous choisissez doit également (dans la mesure du possible) être quelque peu descriptif du contenu de votre contribution;
bien sûr, c'est toujours un peu subjectif, mais il est clair que des noms tels que mon_extension
ou exemple
ne conviennent pas.
Numéro de version
Chaque soumission d'une extension au CTAN doit contenir un «identifiant de version» qui permet de distinguer cette version
des versions antérieures ou ultérieures. Cet identifiant doit être placé à un endroit où il est facile à trouver,
comme le début du fichier README
ou, mieux, un fichier VERSION
.
Ne vous contentez pas de ce qui est mentionné dans le fichier d'historique de votre travail.
Cet identifiant de version peut consister soit en un numéro de version (c'est-à-dire quelque chose comme 1.0
, ou 3.0.17
, ou 2.1a
),
ou une date de version (de préférence en notation AAAA-MM-JJ
ou AAAA/MM/JJ
, comme 2021-04-01
ou 2021/04/01
),
ou une chaîne de caractères composée des deux données susmentionnées.
Comment uploader mes fichiers?
Le dépôt s'effectue via la page d'upload du CTAN
(la page d'accueil du CTAN fournit un lien).
La page d'upload propose un formulaire, et beaucoup d'aide, pour vous indiquer les informations
à entrer. Elle ne peut accepter qu'un seul fichier par upload:
si vous avez l'intention de télécharger de nombreux fichiers, vous devez les regrouper dans un fichier archive quelconque;
les formats acceptables sont zip
et tar.gz
. Une fois que vous avez terminé votre upload,
le serveur le confie à un membre de l'équipe du CTAN pour qu'il le traite.
Si vous ne pouvez pas utiliser cette méthode, ou si quelque chose n'est pas clair, demandez conseil à l'équipe de gestion du CTAN.
Que va-t-il se passer ensuite?
- Every upload will be unpacked and checked by an upload manager from the CTAN management team.
- Small deficiencies will be corrected immediately by that person. You will receive feedback about this and be asked to apply the same sort of change(s) to your own file(s) before your next upload.
If there is a non-trivial problem that cannot be fixed without your help the team will ask back and the installation process will be momentarily stalled until they receive an answer to their question. In some cases even a re-upload may become necessary.
- After installation of the package on the CTAN central server, the corresponding `.xml` source file of the [Catalogue](FAQ-catalogue) entry will either be created (for new packages) or be updated (in all other cases).
When all of this has been done, one of the upload managers will send you an email to the address you entered into the upload form. It may take a few hours (up to 24 hours) for your files to arrive on all the mirrors worldwide.
If your upload is a new one or if you have requested an announcement, the message to [`CTAN-Announce`](https://www.ctan.org/ctan-ann) will be posted shortly after the end of that propagation time
It is always helpful if you check what you see at the URLs indicated in the acknowledgement mail around 24 hours after installation and inform the CTAN team about any possible flaws in the presentation.
Sources: