CTAN
Comprehensive TeX Archive Network

Hilfe

Wie kann ich ein Paket hoch laden?

Ein Paket kann auf CTAN über das Upload-For­mu­lar hochge­laden wer­den. In diesem Upload-Form­lar wird man aufge­fordert, einige In­for­ma­tio­nen über sich selbst und das Paket anzugeben. Diese wer­den für die Kat­a­l­o­gisierung und Bear­beitung auf CTAN benötigt. Das Paket selbst wird in einer Archiv-Datei er­wartet, die alle zuge­höri­gen Dateien en­thält.

Das Upload-For­mu­lar ist ab­sichtlich in Englisch aus­ge­führt. CTAN und sind in­ter­na­tional und die Kom­mu­nika­tion­ssprache ist Englisch. Auch wenn einige CTAN-Team­mit­glieder an­dere Sprache ver­ste­hen, sollte die Kom­mu­nika­tion in Englisch er­fol­gen.

Die fol­gende Liste en­thält einige Regeln, wie ein Paket für CTAN vorzu­bere­iten wer­den sollte.

  • Bitte packen Sie ihren Beitrag als ein ZIP-Archiv mit der Dateina­menser­weiterung .zip oder ein gzip-kom­prim­iertes tar-Archiv mit der Dateina­menser­weiterung .tar.gz oder .tgz.

    Das CTAN-Team hat entschieden, dass die Pakete in einem Archiv in einer Browser-fre­undlichen Lay­out ange­boten wer­den sollen. Das be­deutet, dass alle Dateien in einem Verze­ich­nis liegen. Dies wird im fol­gen­den il­lus­tri­ert:

    my-package.zip:
      my-package/
        README.md
        my-package.dtx
        my-package.ins
        my-package.pdf

    Dabei ist my-pack­age der CTAN-Name des Pakets.

  • Sehr große Pakete – wie beispiel­sweise mod­erne Font-Distri­bu­tio­nen – wer­den durch eine zusät­zliche Verze­ich­nisebene verbessert:

    my-package.zip:
      my-package/
        README.md
        doc/
          my-package-doc.tex
          my-package-doc.pdf
        tex/
          use-my-package.sty
          t1my-package.fd
          ...
        source/
          my-package.sfd
          my-package-Italic.sfd
          ...
        ...

    und so weiter.

  • Par­al­lel zum Haupt-Verze­ich­nis bi­etet CTAN die Möglichkeit, ein Un­ter­verze­ich­nis install/ vorzuhal­ten, das Zip-Archive nach der TDS-Struk­tur en­thält. Solch eine Datei wird von CTAN nur zusät­zlich zum Upload-In­halt akzep­tiert aber nicht als Er­satz dafür.

    Diese Datei ist für ein­fache Pakete ab­so­lut über­flüs­sig. De­shalb sollte sie beispilesweise für nor­male -Pakete wegge­lassen wer­den. Diese Datei kann eventuell ge­braucht wer­den, wenn das Paket sehr kom­plex ist.

    Falls man solch eine Datei in den Upload aufnehmen will, dann sollte man die TDS guide­lines beachten. die Datei sollte my-package.tds.zip heißen und im Haupt­b­verze­ich­nis des Archivs (neben dem Verze­ich­nis my-package) liegen.

    my-package.zip:
      my-package.tds.zip
      my-package/
        README.md
        ...
  • Selbst wenn eine Ak­tu­al­isierung eines ex­istieren­den Pakets hochge­laden wird, müssen alle Dateien en­thal­ten sein – egal ob sie sich geän­dert haben oder nicht. Wir haben Werkzeuge, die voll­ständige Pakete er­warten und damit zu den wenig­sten Fehlern auf un­serer Seite führen.

  • CTAN en­thält Tausende von Paketen und viele Tausend Dateien. Unseren Be­such­ern wird dadurch geholfen und die Pakete er­hal­ten die gebührende Aufmerk­samkeit, dadurch dass sie ge­fun­den wer­den.

    • Das Paket muss eine Text-Datei en­thal­ten, die In­for­ma­tio­nen en­thält, damit ein CTAN-Be­sucher entschei­den kann, ob das Paket für ihn nüt­zlich sein kann. Diese Datei sollte eine kurze Beschrei­bung und Lizenzbeschränkun­gen sowie Ab­hängigkeiten des Pakets, beispiel­sweise zu Fonts oder einer speziellen Plat­tform, en­thal­ten. Der Name dieser Datei muss README.md oder ein­fach README sein, weil das CTAN-Por­tal diese Dateien promi­nent präsen­tiert, wenn der Be­sucher das Archiv-Verze­ich­nis browst. Diese Datei muss in der UTF-8-Kodierung abge­spe­ichert wer­den.

      Für eine in­ter­na­tionale An­wen­der­schaft ist es das Beste, die README-Datei in Englisch zu ver­fassen. Es ist möglich eine weit­ere README-Datei hinzuzufü­gen, die in einer an­deren Sprache ver­fasst ist, falls dies gewün­scht wird.

      Die Datei README.md oder README muss eine Festle­gung zu der gewählten Lizenz en­thal­ten. Damit kann ein An­wen­der entschei­den, ob das Paket für ihn nutzbar ist – beispiel­sweise wenn die Lizenz die kom­merzielle Nutzung auss­chließt. Dazu genügt et­was wie This ma­te­rial is sub­ject to the Project Public Li­cense 1.3c.

    • So gut wie alle Pakete soll­ten eine Doku­men­ta­tion en­thal­ten, die über die Datei README.md oder README hin­aus geht. Diese muss im PDF-For­mat vor­liegen, da das von un­seren Be­such­ern im Web am ein­fach­sten gele­sen wer­den kann; ins­beson­dere sind PostScript oder DVI nicht akzept­abel. Die Quellen der Doku­men­ta­tion müssen in dem Paket en­thal­ten sein, weil an­son­sten Distri­bu­tio­nen wie  Live dieses Paket nicht ver­wen­den kön­nen.

      Für viele -Paket-Au­toren sollte die Erzeu­gung der Doku­men­ta­tion durch das Ver­ar­beiten der .dtx-Datei mit aus­re­ichen:

        latex <docname>.dtx

  • Das Paket sollte keine Dateien en­thal­ten, die aus an­deren Dateien des Pakets erzeugt wer­den kön­nen – ausgenom­men von der Doku­men­ta­tion. Damit dür­fen die tem­porären Dateien, wie sie von und erzeugt wer­den, nicht en­thal­ten sein.

    Für -Pakete, die aus einer dtx-Datei er­stellt wer­den, dür­fen keine Dateien, die dabei gener­iert wer­den, en­thal­ten sein.

Wenn man ein Paket für den Upload auf CTAN vor­bere­itet, kön­nte sich eines der un­ter­stützen­den Pakete als hil­fre­ich er­weisen. Un­ter dem Thema ctan kann man solche Pakete finden.

Einige weit­ere prak­tis­che Tipps findet man in Ad­di­tional In­for­ma­tion for CTAN Upload­ers. Eben­falls kann die In­for­ma­tion unter http://tug.org/texlive/pkg­con­trib.html sein.

Gästebuch Seiten-Struktur Impressum Autor kontaktieren