Hilfe zu CTAN

Welche Readme-Datei wird im CTAN-Browser direkt angezeigt?

Der zu einem Paket gehörende Ordner im CTAN-Browser zeigt einen Text zu dem aktuellen Verzeichnis direkt an. Diese Information kann von dem Paket-Autor bereitgestellt werden. Das Portal such nach einigen Dateien und bettet die erste, gefundene Datei ein – abhängig von ihrem Typ:

Man beachte, dass die Readme-Dateien, deren Basis-Name nicht nur aus Großbuchstaben besteht nur für historische Pakete angezeigt werden. Sie werden in neuen Paketen nicht akzeptiert.

Typ TEXT

Der Typ TEXT wird als eingebettetet, vorformatierter Text dargestellt. Die Zeilenumbrüche bleiben dabei unberührt. Die Zeichen werden nötigenfalls geschützt, um unverändert dargestellt werden zu können.

Typ MARKDOWN

Der Text wird auf Basis der Regeln für CTAN-Markdown interpretiert. Diese Regeln sind eine Variante des Github-flavoured markdown. Sie legen fest, wie eine Textdatei ansprechend dargestellt werden kann, wenn man von einem lesbaren Quelltext ausgeht.