summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/dateiliste/README-eo
blob: 9f2dd54ec1eda4e266af6277e09c75bf84def63e (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
Tiu README (legumin) estas por versio:
      2012/10/13 v0.6 %
----------------
LaTeX-pakaĵo 'dateiliste' - Variaĵo de \DeclareRobustCommand,
kiu antaŭe elprovas, ĉu la nomo jam ekzistas.

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 bezonas la pakaĵojn 'ltxtable', 'longtable',
'tabularx' kaj 'rcsinfo'.
Por krei la dokumentadon vi krome bezonas 'pauldoc' (de la sama aŭtoro).

La pakaĵo venas en .dtx + .ins.
Voku "latex dateiliste.ins" por krei la .sty-dosieron (kaj
eble meti ĝin al texmf/tex/latex/paul/, se via docstrip estis
konfigurita laŭe), voku "latex dateiliste.dtx" por rekrei
la dokumentaron.

 Uzado
-------

La pakaĵo konsistas el tri ĉefaj bonaĵoj, kiujn
oni povas uzi sendepende, sed kune ili estas speciale
utile.

(1) Aŭtomataj versio-informoj.

  Se vi uzas versio-kontrolan sistemon kiel Subversion aŭ
  CVS/RCS, vi povas uzi tion por aŭtomate generi la daton
  kaj versi-numeron por la listo kreita de \listfiles
  (kaj la listo de (3).)
  Uzu

    \ProvideFileInfos{$<>Id$}{mallonga priskribo}

  en via dosiero, forprenu la '<>', kaj faru 'svn commit' aŭ
  'cvs commit'. (CVS aŭ SVN tiam enmetos informojn, kiun
  \ProvideFileInfos uzos.)
  En la Subversion-kazo necesas antaŭe informi Subversion
  pri tio, ke vi volas anstataŭi 'Id' per alia afero:
     svn propset svn:keywords Id <dosiernomo>
  Ankaŭ necesas uzi la pakaĵ-opcion 'svn' aŭ 'subversion',
  kiel tie:
     \usepackage[svn]{dateiliste}

(2) Aldono de ĉefa dosiero

  Kutime la ĉefa dosiero (kiun vi donis en la
  latex-voko) ne aperas en la listo kreita de
  \listfiles. Tion la pakaĵo ŝanĝas, se tiu
  dosiero havas la nomfinaĵon .tex

  (Pli precize, la pakaĵo 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 ŝaltita, sed eblas
  malŝalti ĝin per la pakaĵ-opcio 'noaddmain'.
  Tiam ankaŭ 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 (antaŭ \begin{document}),
  alikaze vi nur ricevos erarmesaĝon.

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

  Eblas traduki la titolon de la sekcio, la antaŭtekston
  kaj la tabelkapoj helpe de la babel-pakaĵo - tradukojn
  por 'english', 'german', 'ngerman' kaj 'esperanto' la
  pakaĵo jam enhavas.
  Se vi bezonas aliajn lingvojn aŭ ne uzas 'babel',
  redifinu la sekvajn makroojn:

  \fileListName     - titolo ("Listo de dosieroj")
  \fileListPreamble - antaŭteksto (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
    pakaĵ-opcioj:
     nocat12 - nur funkcias se vi uzas eTeX, alikaze
       eble la cxef-dosiero aperos dufoje.
     cat12 - funkcias kun aŭ sen eTeX, konvertante
       la enhavon de \@filelist al kategorio 12.
    Se vi neniun de tiuj opcioj donas, ĝi laboras
    kiel 'nocat12' en eTeX kaj kiel 'cat12' en ne-eTeX.

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