summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dateiliste/README
blob: e4c8cbb4796d7914af5f2213277b5b3e35b0de6e (plain)
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
This README is for version:
      2006/07/27 v0.3 %
----------------
([de] unten - [eo] sube)
----------------
[en]
LaTeX-package 'dateiliste' - include list of used files
(like \listfiles) in the document, and related features.

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 typesetting of the documentation needs 'pauldoc' (from the
same author).
Additionally you'll need the packages 'ltxtable', 'tabularx',
'longtable' and 'rcsinfo'.

The package comes as .dtx + .ins.
Run "latex dateiliste.ins" to create the style file and the
README-files (and maybe put them to texmf/tex/latex/paul/, if
your docstrip is configured accordingly), (after that and
maybe updating your TeX hash) run "latex dateiliste.dtx"
(some times) to create the documentation.

 Usage
-------
The package has three main features, which can
be used independently, but together are specially
useful.

(1) automatic version infos:

  If you have your LaTeX source files in a CVS,
  you may use the ID tag to generate the date and
  version number for the version string in \listfiles.
  Use

    \ProvideFileInfos{$Id: dateiliste.dtx,v 2.1 2006/07/27 10:39:02 epaul Exp $}
                     {short description}

  in your file, and do a CVS commit.

(2) include main file:

  Normally the "main" file (given on the command
  line to LaTeX) does not appear in the list given
  by \listfiles. This is changed by the package for
  the case that the file has the name \jobname.tex.

  (More precisely, the package adds \jobname.tex
   iff this file exists and it not can be determinded[1]
   to be already in the file list [2].)

  This is enabled by default and may be disabled
  using the package option 'noaddmain'.
  The macro
    \mainFileToList
  may also be invoked manually to add the main file.

(3) include file list also in the (dvi) result

  You can use the command

    \printFileList[<section command>]

  to include a pretty-printed version of the
  file list as a section (by default \section*,
  any sectioning command may be given as an
  optional argument).

  You also have to use \listfiles in the
  document preamble (otherwise you'll only get
  an error message).

  The table only appears from the second LaTeX-run,
  from the third one is complete, and may need some
  more runs to align correctly.

  The title, preamble and table headers may be localized
  with babel - translations for 'english', 'german',
  'ngerman' and 'esperanto' are included.
  If you need something else or don't use babel, you have
  to redefine the following macros:

  \fileListName     - title ("List of Files")
  \fileListPreamble - preamble (typeset before the table)
  \fileNameName     - table header "file name"
  \dateName         - table header "date"
  \verName          - table header "version"
  \descriptionName  - table header "description"

-----
[1] this determination can be configured with
    the package options
    nocat12 - does only work with eTeX, else
       may give double entry
    cat12 - works also without eTeX, but may
       have some side effects to other macro
       packages, since it converts \@filelist
       to cat 12.
    The default setting works like cat12 on non-eTeX
    and like nocat12 on eTeX.

[2] this may occur when you invoke
    LaTeX with "\input{mainfile.tex}".
----------------
[de]
LaTeX-Paket 'dateiliste' - Liste der verwendeten Dateien im Dokument

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
(-> http://www.math.hu-berlin.de/~ebermann/alg-script/),
aber  vielleicht ist es auch für andere von Nutzen.

Zum Setzen der Dokumentation wird das Paket 'pauldoc'
(vom selben Autor) benötigt.

Das Paket kommt als .dtx + .ins.
Mit "latex dateiliste.ins" wird die .sty-Datei erstellt (und
eventuell gleich nach texmf/tex/latex/paul/ installiert,
wenn docstrip entsprechend eingerichtet ist), mit
latex dateiliste.dtx kann (danach und eventuell nach einer
Aktualisierung der TeX-Dateidatenbank) die Dokumentation neu
erstellt werden.

Zur Verwendung siehe dateiliste.pdf.
----------------
[eo-h]
LaTeX-pakajho 'dateiliste' - Variajho de \DeclareRobustCommand,
kiu antaue elprovas, chu la nomo jam ekzistas.

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 bezonas la pakajhojn 'ltxtable', 'longtable',
'tabularx' kaj 'rcsinfo'.
Por krei la dokumentadon vi krome bezonas 'pauldoc' (de la sama autoro).

La pakajho venas en .dtx + .ins.
Voku "latex dateiliste.ins" por krei la .sty-dosieron (kaj
eble meti ghin al texmf/tex/latex/paul/, se via docstrip estis
konfigurita laue), voku "latex dateiliste.dtx" por rekrei
la dokumentaron.

 Uzado
-------

La pakajho konsistas el tri chefaj bonajhoj, kiujn
oni povas uzi sendepende, sed kune ili estas speciale
utile.

(1) automataj versio-informoj.

  Se via LaTeX-dosieroj estas ene de CVS, vi povas
  uzi tion por automate generi la daton kaj
  versi-numeron por la listo kreita de \listfiles
  (kaj la listo de (3).)
  Uzu

    \ProvideFileInfos{$Id: dateiliste.dtx,v 2.1 2006/07/27 10:39:02 epaul Exp $}
                     {mallonga priskribo}

  en via dosiero, kaj faru 'cvs commit'. (CVS enmetos
  informojn, kiun \ProvideFileInfos uzas.)

(2) aldono de chefa dosiero

  Kutime la chefa dosiero (kiun vi donis en la
  latex-voko) ne aperas en la listo kreita de
  \listfiles. Tiun la pakajho shanghas, se tiu
  dosiero havas la nomfinajhon .tex

  (Pli precize, la pakajho aldonas '\jobname.tex',
   se tiu dosiero ekzistas, kaj se ne eblas eltrovi[1],
   ke la dosiero estas jam en la listo[2].)

  Tiu aldonado estas kutime shaltita, sed eblas
  malshalti ghin per la pakajh-opcio 'noaddmain'.
  Tiam ankau eblas voki
    \mainFileToList
  por fari tion.

(3) enmetu la dosierliston en la rezulton

  Vi povas uzi la komandon

    \printFileList[<section command>]

  por enmeti bele formatitan version de la
  dosierlisto kiel sekcio (kutime '\section*',
  sed vi povas uzi iun ajn sekci-komandon kiel
  opcia argumento) en la dokumenton.

  Vi krome devas uzi \listfiles en la komenca
  parto de la dokumento (antau \begin{document}),
  alikaze vi nur ricevos erarmesaghon.

  La tabelo nur aperos ekde la dua LaTeX-voko, kaj
  eble bezonos kelkajn pliajn por aspekti ghuste.

  Eblas traduki la titolon de la sekcio, la antautekston
  kaj la tabelkapoj helpe de la babel-pakajho - tradukojn
  por 'english', 'german', 'ngerman' kaj 'esperanto' estas
  la pakajho jam enhavas.
  Se vi bezonas aliajn lingvojn au ne uzas 'babel',
  redifinu la sekvajn makroojn:

  \fileListName     - titolo ("Listo de dosieroj")
  \fileListPreamble - antauteksto (printita inter titolo
                       kaj tabelo)
  \fileNameName     - tabelkapo "dosiernomo"
  \dateName         - tabelkapo "dato"
  \verName          - tabelkapo "versio"
  \descriptionName  - tabelkapo "priskribo"

-----
[1] Tiun determinadon vi povas konfiguri per la
    pakajh-opcioj:
     nocat12 - nur funkcias se vi uzas eTeX, alikaze
       eble la cxef-dosiero aperos dufoje.
     cat12 - funkcias kun aux sen eTeX, koncertante
       la enhavon de \@filelist al kategorio 12.
    Se vi neniun de tiuj opcioj donas, gxi laboras
    kiel 'nocat12' en eTeX kaj kiel 'cat12' en ne-eTeX.

[2] Tio povas okazi ekzemple, se vi invokas
    LaTeX kun "\input{mainfile.tex}".