Wie lege ich das Dokumentations-PDF für mein Paket fest?

Wie lege ich das Dokumentations-PDF für mein Paket fest?

Ich wollte die Syntax von etwas in einem meiner Pakete überprüfen und anstatt auf meinem System nach der Datei zu suchen, habe ich es einfach texdoc hobbyüber die Befehlszeile getan. Zu meinem Entsetzen wurde dabei das PDF mit demCode, nicht die Hauptdokumentation. Als ich das Paket bei CTAN einreichte, teilte ich die Dokumentation in zwei Teile auf: die Benutzerdokumentation und die Codedokumentation. Da letztere aus erstellt wird .dtx, erhält sie den Namen hobby.pdf, die Benutzerdokumentation kann beliebig benannt werden, also habe ich gewählt hobby_doc.pdf. Es ist durchaus vernünftig, dass texdoc hobbyerstellt hobby.pdf(und texdoc hobby_docdie Benutzerdokumentation erstellt), aber aus der Sicht eines Benutzers scheint das nicht das Richtige zu sein.

Es scheint mir, dass es zwei Möglichkeiten gibt, dies zu beheben:

  1. Ändern Sie meine Dateinamen, sodass der Code zu hobby_code.pdfund die Dokumentation zu wird hobby.pdf. Im Idealfall soll das automatisch passieren, sodass ich weiterhin hobby.dtxund habe, hobby.texaber pdflatex hobby.dtxerzeugt . Ich weiß, dass man innerhalb eines Dokuments hobby_code.pdfnichts ändern kann , aber da es sich um ein handelt, dachte ich, dass der Kompilierungsprozess vielleicht nicht so einfach ist, wie er scheint, und dass es vielleicht trotzdem möglich ist, den Ausgabedateinamen zu ändern. Ist das so?\jobname.dtx

  2. Richten Sie es texdocso ein, dass texdoc hobbyauf verweist hobby_doc.pdf. So wie ich es verstehe, ist dies durchaus möglich, müsste aber offiziell durchgeführt werden. Wie gehe ich also vor, um eine solche Änderung vorzunehmen, und ist es einfach, danach zu fragen? (Wenn es kompliziert ist, sollte ich eindeutig Option 1 verwenden, auch wenn ich dies nicht automatisch tun kann.)

Antwort1

Ich habe von Zeit zu Zeit Anfragen auf derTex Live-Listevon Autoren wie auch von Benutzern, um für texdocein bestimmtes Paket einen anderen Standard festzulegen (aufgrund ähnlich »falscher« Standarddokumentation). Sie könnten wahrscheinlich dasselbe tun.

verwandte Informationen