Hilfe zu CTAN

Wie kann ich ein Paket hoch laden?

Ein Paket kann auf CTAN über das Upload-Formular hochgeladen werden. In diesem Upload-Formlar wird man aufgefordert, einige Informationen über sich selbst und das Paket anzugeben. Diese werden für die Katalogisierung und Bearbeitung auf CTAN benötigt. Das Paket selbst wird in einer Archiv-Datei erwartet, die alle zugehörigen Dateien enthält.

Das Upload-Formular ist absichtlich in Englisch ausgeführt. CTAN und TeX sind international und die Kommunikationssprache ist Englisch. Auch wenn einige CTAN-Teammitglieder andere Sprache verstehen, sollte die Kommunikation in Englisch erfolgen.

Die folgende Liste enthält einige Regeln, wie ein Paket für CTAN vorzubereiten werden sollte.

• Bitte packe deinen Beitrag als ein ZIP-Archiv mit der Dateinamenserweiterung .zip oder ein gzip-komprimiertes tar-Archiv mit der Dateinamenserweiterung .tar.gz oder .tgz.

  Das CTAN-Team hat entschieden, dass die Pakete in einem Archiv in einer Browser-freundlichen Layout angeboten werden sollen. Das bedeutet, dass alle Dateien in einem Verzeichnis liegen. Dies wird im folgenden illustriert:

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

  Dabei ist my-package der CTAN-Name des Pakets.

• Sehr große Pakete – wie beispielsweise moderne Font-Distributionen – werden durch eine zusätzliche Verzeichnisebene 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.

• Parallel zum Haupt-Verzeichnis bietet CTAN die Möglichkeit, ein Zip-Archiv nach der TDS-Struktur mitzuliefern. Solch eine Datei wird von CTAN nur zusätzlich zum Upload-Inhalt akzeptiert aber nicht als Ersatz dafür.

  Diese Datei ist für einfache Pakete absolut überflüssig. Deshalb sollte sie beispilesweise für normale LaTeX-Pakete weggelassen werden. Diese Datei kann eventuell gebraucht werden, wenn das Paket sehr komplex ist.

  Falls man solch eine Datei in den Upload aufnehmen will, dann sollte man die TDS guidelines beachten. die Datei sollte my-package.tds.zip heißen und im Hauptbverzeichnis des Archivs (neben dem Verzeichnis my-package) liegen.

  my-package.zip:
    my-package.tds.zip
    my-package/
      README.md
      ...

• Selbst wenn eine Aktualisierung eines existierenden Pakets hochgeladen wird, müssen alle Dateien enthalten sein – egal ob sie sich geändert haben oder nicht. Wir haben Werkzeuge, die vollständige Pakete erwarten und damit zu den wenigsten Fehlern auf unserer Seite führen.

• CTAN enthält Tausende von Paketen und viele Tausend Dateien. Unseren Besuchern wird dadurch geholfen und die Pakete erhalten die gebührende Aufmerksamkeit, dadurch dass sie gefunden werden.

  • Das Paket muss eine Text-Datei enthalten, die Informationen enthält, damit ein CTAN-Besucher entscheiden kann, ob das Paket für ihn nützlich sein kann. Diese Datei sollte eine kurze Beschreibung und Lizenzbeschränkungen sowie Abhängigkeiten des Pakets, beispielsweise zu Fonts oder einer speziellen Plattform, enthalten. Der Name dieser Datei muss README.md oder einfach README sein, weil das CTAN-Portal diese Dateien prominent präsentiert, wenn der Besucher das Archiv-Verzeichnis browst. Diese Datei muss in der UTF-8-Kodierung abgespeichert werden.

    Für eine internationale Anwenderschaft ist es das Beste, die README-Datei in Englisch zu verfassen. Es ist möglich eine weitere README-Datei hinzuzufügen, die in einer anderen Sprache verfasst ist, falls dies gewünscht wird.

    Die Datei README.md oder README muss eine Festlegung zu der gewählten Lizenz enthalten. Damit kann ein Anwender entscheiden, ob das Paket für ihn nutzbar ist – beispielsweise wenn die Lizenz die kommerzielle Nutzung ausschließt. Dazu genügt etwas wie This material is subject to the LaTeX Project Public License 1.3c.

  • So gut wie alle Pakete sollten eine Dokumentation enthalten, die über die Datei README.md oder README hinaus geht. Diese muss im PDF-Format vorliegen, da das von unseren Besuchern im Web am einfachsten gelesen werden kann; insbesondere sind PostScript oder DVI nicht akzeptabel. Die Quellen der Dokumentation müssen in dem Paket enthalten sein, weil ansonsten Distributionen wie TeX Live dieses Paket nicht verwenden können.

    Für viele LaTeX-Paket-Autoren sollte die Erzeugung der Dokumentation durch das Verarbeiten der .dtx-Datei mit LaTeX ausreichen:

      latex <docname>.dtx

• Das Paket sollte keine Dateien enthalten, die aus anderen Dateien des Pakets erzeugt werden können – ausgenommen von der Dokumentation. Damit dürfen die temporären Dateien, wie sie von TeX und LaTeX erzeugt werden, nicht enthalten sein.

  Für LaTeX-Pakete, die aus einer dtx-Datei erstellt werden, dürfen keine Dateien, die dabei generiert werden, enthalten sein.

Wenn man ein Paket für den Upload auf CTAN vorbereitet, könnte sich eines der unterstützenden Pakete als hilfreich erweisen. Unter dem Thema ctan kann man solche Pakete finden.

Einige weitere praktische Tipps findet man in Additional Information for CTAN Uploaders. Ebenfalls kann die Information unter http://tug.org/texlive/pkgcontrib.html sein.