Debian Codegraph @

texmf-dist/source/latex/fileinfo/myfilist.tex

raw
1 \ProvidesFile{myfilist.tex}[2012/11/30 documenting myfilist.sty]
2 \title{\textsf{myfilist}\\---\\
3 List Infos on just the Files\\You Want to Know About%
4 \GetFileInfo{myfilist.sty}\thanks{%
5 This file describes version
6 \textcolor{blue}{\fileversion} % \textbf{\fileversion}
7 of \textsf{\filename} as of \filedate.}}
8 % \listfiles
9
10 %% Preprocessing:
11 \RequirePackage{makedoc}
12 \CopyFDconditionFromTo{PScomment}{comment}
13 % \MainDocParser{\ProcessInputWith{PScomment}}
14 %% Replacements:
15 \SetPatternCodes{\MakeOther\\\MakeOther\ } %% CARE!
16 \MakeExpandableAllReplacer{TeX}{TeX }{\TeX{} }{LEAVE} %% 2012/09/28
17 % \let\do\PrependExpandableAllReplacer %% 2012/09/28
18 \renewcommand*{\do}{\PrependExpandableAllReplacer*} %% re 2012/11/22
19 \do{LaTeX }{\LaTeX{} }
20 \do{LaTeX2e }{\LaTeXe{} }
21 \do{ .log}{ `.log'}
22 \do{ .tex}{ `.tex'}
23 \do{ .cls}{ `.cls'}
24 \do{ .sty}{ `.sty'}
25 \do{NOTE: }{\textbf{Note: }}
26 \SetPatternCodes{\MakeOther\\} %% less care needed
27 \do{...}{$\dots$}
28 \do{\ProvidesFile}{`\ProvidesFile'}
29 \do{"loads"}{``loads''}
30 \do{USAGE:}{\section{Usage}}
31 \do{TRICKS:}{\section{Tricks, Package Option}}
32 %% 2012/09/28 for v0.5, generation support:
33 \do{VARIANTS:}{\section{Variants}}
34 % \do{<txt-file>}{\MetaVar{txt-file}} %% 2012/09/28
35 \do{IMPLEMENTATION:}{\section{Implementation}}
36 \do{gather.tex}{`gather.tex'}
37 \do{readprov.pdf}{`readprov.pdf'}
38 \do{readprov-.sty}{readprov.sty} %% 2010/11/26
39 \do{readprov.sty}{'readprov.sty'}
40 \do{myfilist-.sty}{myfilist.sty} %% 2010/11/26
41 \do{myfilist.sty}{'myfilist.sty'} %% 2012/09/28
42 \do{ifnextok.sty}{'ifnextok.sty'}
43 \do{adhocfilelist}{'adhocfilelist'}
44 \do{filedate.sty}{'filedate.sty'} %% 2012/10/25
45 \do[\MakeOther\ ]%
46 {run gather.tex}{\emph{run} gather.tex}
47 %% <- TODO \PrependStandardEnhancement...
48 \SetCorrectHookJobLast
49 \ResetPatternCodes
50
51 \MainDocParser{\ProcessInputWith{PScomment}}
52 \LaTeXresultFile{myfilist.doc}
53 \MakeCloseDoc*{myfilist.sty} %% 2012/03/18
54 %% <- we must NOT read mdoccorr.cfg here!
55 %% (or put the above setup into a new one!) ->
56 % \MakeJobDoc{0}{\ProcessInputWith{PScomment}}
57
58 %% Typesetting:
59 \documentclass{article}
60 \usepackage{color} %% for highlighting package version!? TODO
61 \input{makedoc.cfg}
62 \ReadPackageInfos{myfilist}
63 \usepackage{wiki}
64 %% TeX markup inserted by the txt-to-TeX function must be
65 %% declared here for using 'niceverb''s ``auto mode.''
66 \AddToNoVerbList{\LaTeXe\dots\textbf\emph\
67 %% <- at end of line! 2012/11/22 TODO not working!?!
68 \\ %% 2012/11/22
69 \TeX\LaTeX} %% 2012/09/28
70 \begingroup \MakeActive\"
71 \gdef\fineDQ{``\begingroup
72 \let\do\MakeOther \dospecials \tt
73 \def"{\endgroup''}}%
74 \endgroup
75
76 \pagestyle{headings}
77 \usepackage{parskip}
78
79 \MDfinaldatechecks
80 \begin{document}
81
82 \maketitle
83
84 \begin{abstract}\sloppy\noindent
85 'myfilist' addresses lazy file versions management,
86 when you move your package or chapter files through
87 various computers and various directories and after a while
88 wonder where the most recent versions are.
89
90 Like Paul Ebermann's
91 'dateiliste',\urlfoot{CtanPkgRef}{dateiliste}
92 'myfilist' varies \LaTeX's `\listfiles'
93 for listing file (especially version) informations.
94 Differences to 'dateiliste' and \LaTeX\ are:
95 \begin{enumerate}
96 \item You choose the files (and their order) to be listed;
97 \item indeed (according to original intention):
98 this has very little to do with files used in
99 typesetting some document;
100 \item output is just screen, `.log', or a `.txt'-type file
101 that you choose.
102 \end{enumerate}
103 %% 2012/11/22 while mentioning 'nicetext' moves to final section:
104 However, `\ListFileInfos[<txt-file>]' from here can also be used
105 to \emph{with} typesetting in order to get `\listfiles' output
106 in a separate plain text file `<txt-file>'
107 (\emph{without} remaining `.log' content).
108
109 \end{abstract}
110
111 % \pagebreak
112 \tableofcontents
113
114 \section{Installing}
115 The file '\jobname.sty' is provided ready, installation only requires
116 putting it somewhere where \TeX\ finds it
117 (which may need updating the filename data
118 base).\urlfoot{ukfaqref}{inst-wlcf}
119
120 \section{File Info Header}
121 \sloppy
122 \let\\\MDdocnewline %% 2012/11/22
123 \setlength\topsep{\smallskipamount} %% 2012/11/22
124 \enlargethispage{2\baselineskip} %% 2012/11/22
125 \wikiEnvironments %% TODO fails with "or" 2010/03/31
126 \MakeActiveLetHere\"\fineDQ %% fails with "loads"
127 \AutoCmdInput{myfilist.doc}
128 \nowikiEnvironments
129
130 \section{Example}
131 % \setlength{\parskip}{0pt} %% 2012/11/13
132 \AddQuotes
133 `gather.tex' for the present bundle has been as follows.
134 % %% TODO 2010/11/27:
135 % (added development versions of 'fifinddo.sty' etc.):
136 %% 2012/11/12:
137 `filedate' and `fdatechk' refer to checking ``date consistency''
138 with the \ctanpkgref{filedate} package, at the same time
139 as updating the ``source file list'' `SrcFILEs.txt'
140 which is generated by
141 \[`\NoStopListInfos[SrcFILEs.txt]'\]
142 Some entries refer to the \ctanpkgref{nicetext} bundle
143 that has been used (``\code{----USED.---}'')
144 to generate the documentation file `myfilist.pdf'.
145 \setlength{\topsep}{.5\bigskipamount} %% 2012/11/30
146 \MDsamplecodeinput{gather} %% 2010/11/27 2012/11/13
147 As to `fdatechk.tex':
148 \MDsamplecodeinput{fdatechk}
149
150 \section{Relation to 'nicetext' bundle.}
151 %% 2012/11/22 moves from abstract
152 The code of this package was ready in spring 2008;
153 in spring 2010 I presented it as a kind of study on improving
154 'nicetext''s\urlfoot{CtanPkgRef}{nicetext}
155 `txt'-to-\LaTeX\ processing after 'nicetext v0.4'
156 (aim was to do this without modifying the documented file,
157 yet I did not obey this rule strictly here).
158 The new idea is adding 'wiki.sty''s ``environments''
159 feature to 'makedoc' and 'niceverb''s ``auto mode'' %% was " 2012/11/22
160 in order to interprete `txt' comment indents in the package file,
161 while 'wiki.sty''s \emph{font} switching
162 still is not compatible with 'niceverb''s. Easy script
163 commands for achieving this are still missing (sorry; see the code
164 in 'myfilist.tex' that achieved the present formatting.)
165
166 \end{document}