diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/pauldoc/README |
Initial commit
Diffstat (limited to 'macros/latex/contrib/pauldoc/README')
-rw-r--r-- | macros/latex/contrib/pauldoc/README | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/macros/latex/contrib/pauldoc/README b/macros/latex/contrib/pauldoc/README new file mode 100644 index 0000000000..8f9ad94cf7 --- /dev/null +++ b/macros/latex/contrib/pauldoc/README @@ -0,0 +1,173 @@ +[en] +LaTeX-package 'pauldoc' - some macros to facilate the creation of +LaTeX package documentation in german language. + +Author: Paul Ebermann <Paul-Ebermann@gmx.de> +License: LPPL 1.3b or later, author-maintained + (see http://www.latex-project.org/lppl/). +Version: v0.5 + +All Documentation (other than this file) is in german. + +The package comes as .dtx + .ins. +Run "latex pauldoc.ins" to create the style file (and maybe put +it to texmf/tex/latex/paul/, if your docstrip is configured +accordingly), run (after that and maybe updating your TeX hash) +"latex pauldoc.dtx" to create the documentation. + + + Usage +------- +This package is used to create the documentation of the +other packages from Paul Ebermann - so most times you +won't need to use it directly. +(And it is only of use for creating german language + package documentation, so preferably read the german + language documentation in pauldoc.pdf.) + +Use the package in your own .dtx-file in +a the doc-driver-section: + +%<*driver> +\nonstopmode +\documentclass[draft,ngerman]{ltxdoc} +\usepackage{pauldoc} +\usepackage{myPackage} +\begin{document} + \DocInput{myPackage.dtx} +\end{document} +%</driver> + +In the documentation you then can use some +additional commands: + + \pack{} - typesets package names. + \includeLicense - includes \lpplfilename (by + default 'lppl.tex') in the documentation, + if the file exists. + The catcodes are changed before and after + so there should be no problems. + + \IfReferenceExists{refName}{yes}{no} - execute + some LaTeX code conditionally, dependent + of whether some label was defined (in + the previous LaTeX run), so a \ref or + \pageref would succeed. + Useful for references to the implementation + section or the licence, which may or may not + be included. + + \cmd, \cs, \marg, \oarg, \parg - copied from ltxdoc, + so they can also be used if doc (and pauldoc) + are used with another document class. + +Additionally, 'pauldoc' loads babel with [ngerman], +fontenc with [T1], inputenc with [latin1] (or [utf8], +if you gave this as package parameter to pauldoc), +defines "'" as verbatim character, enables indexing by +codelines, recording of changes, and cross referencing. +The change list title and the index prologue are +translated to german, the index is typeset in two +columns (instead of three). + +---------------- +[de] +LaTeX-Paket 'pauldoc' - Einige Makros, um LaTeX-Pakete +besser (auf deutsch) dokumentieren zu können. + +Autor: Paul Ebermann (Paul-Ebermann@gmx.de). +Lizenz: LPPL 1.3b oder später, mit Maintenance-Status + "author-maintained". Siehe http://www.latex-project.org/lppl/. + +Geschrieben für den eigenen Gebrauch +(d.h. die Dokumentation der LaTeX-Pakete von + Paul Ebermann), aber vielleicht ist es auch +für andere von Nutzen. + +Das Paket kommt als .dtx + .ins. +Mit "latex pauldoc.ins" wird die .sty-Datei erstellt (und +eventuell gleich nach texmf/tex/latex/paul/ installiert, +wenn docstrip entsprechend eingerichtet ist), mit +"latex pauldoc.dtx" kann (danach und eventuell nach einer +Aktualisierung der TeX-Dateidatenbank) die Dokumentation neu +erstellt werden. + +Zur Verwendung siehe pauldoc.pdf. + +---------------- +[eo-h] +LaTeX-pakaĵo 'pauldoc' - Kelkaj iloj por helpi la +dokumentadon de LaTeX-pakaĵoj en la germana lingvo. + +Aŭtoro: Paŭlo Ebermann (Paul-Ebermann@gmx.de). +Licenzo: LPPL 1.3, 'author-maintained' + (-> http://www.latex-project.org/lppl/). + +Kreitaj por propra uzo, sed eble iom de ĝi ankaŭ +uzeblas por aliaj. + +La dokumentaro (escepte tiu ĉi dosiero) estas nur en la germana +lingvo. + +La pakaĵo venas en .dtx + .ins. +Voku "latex pauldoc.ins" por krei la .sty-dosieron (kaj +eble meti ĝin al texmf/tex/latex/paul/, se via docstrip estis +konfigurita laŭe), voku "latex pauldoc.dtx" por rekrei +la dokumentaron. + + Uzado +------- +La pakaĵo estas uzata por krei la dokumentaĵon por +la aliaj pakaĵoj de Paŭlo Ebermann, do kutime vi ne +devos uzi ĝin rekte. +(Kaj ĝi nur taŭgas por dokumenti germanlingve + LaTeX-pakaĵojn, do prefere vi legu la germanlingvan + dokumentaĵon en pauldoc.pdf.) + + +Uzu la pakaĵon en via propra .dtx-dosiero en +la sekcio, kiu enhavas la dokumentaĵ-kreilon: + +%<*driver> +\nonstopmode +\documentclass[draft,ngerman]{ltxdoc} +\usepackage{pauldoc} +\usepackage{miaPakajho} +\begin{document} + \DocInput{miaPakajho.dtx} +\end{document} +%</driver> + +En la dokumentaĵo vi nun povas uzu kelkajn +aldonajn komandojn: + + \pack{} - belprintas pakaĵnomojn. + \includeLicense - enmetas la dosieron \lpplfilename + (kutime 'lppl.tex') en la dokumentajon, + se la dosiero ekzistas. + La kategoriaj kodoj estas ŝanĝitaj antaŭe + kaj poste, por eviti problemojn. + + \IfReferenceExists{refNomo}{jes}{ne} - kondiĉa uzo + de iu teksto, depende ĉu iu 'label' estis + difinita (en la antaŭa voko de LaTeX), do + ĉu nun uzo de \ref{refNomo} kaj \pageref{refNomo} + estus sukcesaj. + Tio estas taŭga por referencoj al la implementa + parto aŭ al la licenco, kiuj povus aŭ ne povus + enesti la dokumenton. + + \cmd, \cs, \marg, \oarg, \parg - tiuj komandoj estas + simple kopiitaj el ltxdoc, por ke oni povu + uzi ilin ankaŭ kun alia dokumentklaso kaj + 'doc' (kaj pauldoc'). + +Aldone, pauldoc vokas 'babel' kun opcio [ngerman], +'fontenc' kun [T1], 'inputenc' kun [latin1] (aŭ +[utf8], se vi donis [utf8] al pauldoc). +Ĝi difinas "'" kiel "verbatim"-ŝaltilo, enŝaltas +linnumerojn, indeksadon laŭ tiuj, kolektadon de +ŝanĝlisto kaj krucreferencadon. +Ĝi tradukas la titolon de la ŝanĝlisto kaj la +prologon de la indekso al la germana. Krome la +indekso uzas nur du kolumnojn (anstataŭ tri). |