Différences

Ci-dessous, les différences entre deux révisions de la page.

--- 6_distributions:comment_contribuer_a_ctan [2021/08/24 16:54] – Correction de lien interne. jejust
+++ 6_distributions:comment_contribuer_a_ctan [2022/06/30 20:00] (Version actuelle) – dbitouze
@@ Ligne 1: / Ligne 1: @@
-====== Contributing a file to the archives ======
+====== Comment déposer un fichier sur le CTAN? ======
+Vous avez quelque chose à déposer sur le [[1_generalites:glossaire:qu_est_ce_que_le_ctan|CTAN]]?
+C'est une excellente nouvelle ! C'est grâce à toutes les contributions individuelles
+que l'écosystème LaTeX se développe.
-You have something to submit to the archive --- good news!
+===== Que vérifier avant le dépôt? =====
-$\Reponse$ Before we even start, here's a check-list of things to sort out:
+Avant de commencer, voici une check-list des choses à régler:
-  * **Licence**: in the spirit of TeX, we hope for free software; in the spirit of today's lawyer-enthralled society, CTAN provides a [[http://mirror.ctan.org/help/Catalogue/licenses.html|list of "standard" licence statements]]. make sure that there's a formal statement of the licence of your package, somewhere in the files you upload; beyond the CTAN installation, your package is a candidate for inclusion in (La)TeX distributions ... and thereafter, also in operating system distributions ... and the people who bundle all these things up need a clear statement of your intent.
+==== Licence ====
-  * **Documentation**: it's good for users to be able to browse documentation before downloading a package.  You need at least a plain text ''README'' file (possible names are "README", "README.txt", and "README.md", but no other variants); in addition a PDF file of the package documentation, prepared for screen reading, is highly desirable.
-  * **Name**: endless confusion is caused by name clashes.  If your package has the same name as one already on CTAN, or if your package installation generates files of the same name as something in a "normal" distribution, the CTAN team will delay installation while they check that you're doing the right thing: they may nag you to change the name, or to negotiate a take-over with the author of the original package.  [[5_fichiers:comment_trouver_un_fichier|Browse the archive]] to ensure uniqueness.
-The name you choose should also (as far as possible) be somewhat
+Dans l'esprit de TeX, on attend des logiciels libres; dans l'esprit de la société juridicisée d'aujourd'hui,
-descriptive of what your submission actually //does//; while
+le CTAN propose une [[http://mirror.ctan.org/help/Catalogue/licenses.html|liste de licences «standards»]]
-"descriptiveness" is to some extent in the eye of the beholder,
+parmi lesquelles vous pouvez choisir. Assurez-vous de faire apparaître clairement la licence sous laquelle
-it's clear that names such as ''mypackage'' or ''jiffy''
+votre contribution sera distribuée, quelque part dans les fichiers que vous déposez.
-aren't suitable.
-  * **Version**: Every submission of every CTAN package has to contain a "version identifier" that permits to distinguish this version of the package from earlier or later ones. This tag should be put into a place where it is easy to find, such as the latest entry of a Changes file, a "VERSION" file, or an easily accessible place (preferably: the top part) in the "README" file.
+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.
-This version identifier may consist of either a version number
+==== Documentation ====
-(i.e. something like ''1.0'', or ''3.0.17'', or ''2.1a'', or a version
-date (i.e.: preferably in ''YYYY-MM-DD'' or ''YYYY/MM/DD'' notation,
-like ''2021-04-01'' or ''2021/04/01''), or a string consisting of
-both the aforementioned data.
+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).
-You upload via the [[https://ctan.org/upload|CTAN upload redirector]]
+L'audience du CTAN étant internationale, le mieux est d'écrire le fichier ''README'' en anglais,
-(the archive's main page has a link).  The upload page shows what it
+même si votre travail concerne une autre langue.
-needs to know, and allows you to enter the information.  The mechanism
+Bien sûr, vous pouvez fournir un autre fichier ''README'' dans une autre langue si vous le souhaitez.
-can only accept one file per upload: if you had intended to upload
+Tous ces fichiers doivent être encodés en UTF-8.
-lots of files, you need to bundle them into an "archive" file of some
-sort; acceptable formats are ''zip'' and ''tar.gz''
-(most uploads are packed in ''zip'' format).  Once you have
-completed your upload, the redirector assigns it to a member of the
-team for processing.
-If you can't use this method, or if you find something confusing, ask
+De plus, un fichier PDF de la documentation de votre travail, préparé pour la lecture à l'écran, est hautement souhaitable.
-advice of the [[https://ctan.org/contact|CTAN management team]].
+Le code-source de cette documentation doit aussi être fourni.
-If your package is large, or regularly updated, it may be appropriate
+==== Nom ====
-to "mirror" your contribution direct into CTAN.
-Mirroring is only practical using ''ftp'' or ''rsync'', so
+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,
-this facility is limited to packages offered by a server that uses one
+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»,
-of those protocols.
+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.
+[[5_fichiers:comment_trouver_un_fichier|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 [[https://ctan.org/upload|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 à [[https://ctan.org/contact|l'équipe de gestion du CTAN]].
+===== Que va-t-il se passer ensuite? =====
+Chaque soumission est décompressée et vérifiée par un responsable de l'équipe de gestion du CTAN.
+Les petits défauts seront immédiatement corrigés par cette personne. Vous recevrez un compte-rendu à ce sujet,
+par mail, et il vous sera demandé d'appliquer le(s) même(s) type(s) de correction(s)
+à vos propres fichiers en vue du prochain upload.
+S'il y a un problème non trivial qui ne peut être résolu sans votre aide, l'équipe vous demandera quoi faire
+et le processus d'installation sera momentanément interrompu jusqu'à ce qu'elle reçoive une réponse de votre part.
+Dans certains cas, un nouvel upload peut s'avérer nécessaire (si c'est à vous de faire les corrections).
+Après le dépôt de votre contribution sur le serveur central du CTAN, le fichier XML correspondant
+du [[1_generalites:documentation:le_catalogue_du_ctan|Catalogue]] sera soit créé (pour les nouvelles extensions),
+soit mis à jour (dans tous les autres cas).
+Lorsque tout cela aura été fait, l'un des responsables du téléchargement vous enverra un courriel à l'adresse que vous avez indiquée
+dans le formulaire d'upload. Cela peut prendre quelques heures (jusqu'à 24 heures) pour que vos fichiers soient propagés
+à tous les miroirs du monde.
+Si votre contribution est nouvelle ou si vous avez demandé une annonce, un message sera envoyé à [[https://www.ctan.org/ctan-ann|CTAN-Announce]]
+peu après la fin de ce temps de propagation.
+C'est uen bonne idée de vérifier ce que vous voyez aux URL indiquées dans le courrier d'accusé de réception, environ 24 heures après l'installation
+et d'informer l'équipe du CTAN de tout problème éventuel.
@@ Ligne 50: / Ligne 103: @@
   * [[https://www.ctan.org/file/help/ctan/CTAN-upload-addendum|Additional Information for CTAN Uploaders]].
-{{htmlmetatags>metatag-keywords=(LaTeX,faire un package,écrire une extension,publier une extension)
+{{htmlmetatags>metatag-keywords=(LaTeX,faire un package,écrire une extension,publier une extension,documentation sur le CTAN)
-metatag-og:title=(Contributing a file to the archives)
+metatag-og:title=(Comment déposer un fichier sur le CTAN?)
 metatag-og:site_name=(FAQ LaTeX francophone)
 }}