1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
[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/).
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], 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-pakajho 'pauldoc' - Kelkaj iloj por helpi la
dokumentadon de LaTeX-pakajhoj en la germana lingvo.
Autoro: Paulo 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 ghi ankau
uzeblas por aliaj.
La dokumentaro (escepte tiu chi dosiero) estas nur en la germana
lingvo.
La pakajho venas en .dtx + .ins.
Voku "latex pauldoc.ins" por krei la .sty-dosieron (kaj
eble meti ghin al texmf/tex/latex/paul/, se via docstrip estis
konfigurita laue), voku "latex pauldoc.dtx" por rekrei
la dokumentaron.
Uzado
-------
La pakajho estas uzata por krei la dokumentajhon por
la aliaj pakajhoj de Paul Ebermann, do kutime vi ne
devos uzi ghin rekte.
(Kaj ghi nur taugas por dokumenti germanlingve
LaTeX-pakajhojn, do prefere vi legu la germanlingvan
dokumentajhon en pauldoc.pdf.)
Uzu la pakajhon en via propra .dtx-dosiero en
la sekcio, kiu enhavas la dokumentajh-kreilon:
%<*driver>
\nonstopmode
\documentclass[draft,ngerman]{ltxdoc}
\usepackage{pauldoc}
\usepackage{miaPakajho}
\begin{document}
\DocInput{miaPakajho.dtx}
\end{document}
%</driver>
En la dokumentajho vi nun povas uzu kelkajn
aldonajn komandojn:
\pack{} - belprintas pakajhnomojn.
\includeLicense - enmetas la dosieron \lpplfilename
(kutime 'lppl.tex') en la dokumentajon,
se la dosiero ekzistas.
La kategoriaj kodoj estas shanghitaj antaue
kaj poste, por eviti problemojn.
\IfReferenceExists{refNomo}{jes}{ne} - kondicha uzo
de iu teksto, depende chu iu 'label' estis
difinita (en la antaua voko de LaTeX), do
chu nun uzo de \ref{refNomo} kaj \pageref{refNomo}
estus sukcesaj.
Tio estas tauga por referencoj al la implementa
parto au al la licenco, kiuj povus au ne povus
enesti la dokumenton.
\cmd, \cs, \marg, \oarg, \parg - tiuj komandoj estas
simple kopiitaj el ltxdoc, por ke oni povu
uzi ilin ankau kun alia dokumentklaso kaj
'doc' (kaj pauldoc').
Aldone, pauldoc vokas 'babel' kun opcio [ngerman],
'fontenc' kun [T1], 'inputenc' kun [latin1].
Ghi difinas "'" kiel "verbatim"-shaltilo, enshaltas
linnumerojn, indeksadon lau tiuj, kolektadon de
shanghlisto kaj krucreferencadon.
Ghi tradukas la titolon de la shanghlisto kaj la
prologon de la indekso al la germana. Krome la
indekso uzas nur du kolumnojn (anstatau tri).
|
