summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/fileinfo/docsrc/myfilist.tex
blob: 4cb47374cc518a4b08efc587615bfdd50144a61e (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
\ProvidesFile{myfilist.tex}[2012/11/30 documenting myfilist.sty]
\title{\textsf{myfilist}\\---\\
       List Infos on just the Files\\You Want to Know About%
       \GetFileInfo{myfilist.sty}\thanks{%
            This file describes version 
            \textcolor{blue}{\fileversion} % \textbf{\fileversion}
            of \textsf{\filename} as of \filedate.}}
% \listfiles

%% Preprocessing:
\RequirePackage{makedoc}
\CopyFDconditionFromTo{PScomment}{comment}
% \MainDocParser{\ProcessInputWith{PScomment}}
%% Replacements:
\SetPatternCodes{\MakeOther\\\MakeOther\ } %% CARE!
\MakeExpandableAllReplacer{TeX}{TeX }{\TeX{} }{LEAVE}   %% 2012/09/28
% \let\do\PrependExpandableAllReplacer                    %% 2012/09/28
\renewcommand*{\do}{\PrependExpandableAllReplacer*}  %% re 2012/11/22
\do{LaTeX }{\LaTeX{} } 
\do{LaTeX2e }{\LaTeXe{} } 
\do{ .log}{ `.log'} 
\do{ .tex}{ `.tex'} 
\do{ .cls}{ `.cls'} 
\do{ .sty}{ `.sty'} 
\do{NOTE: }{\textbf{Note: }} 
\SetPatternCodes{\MakeOther\\}             %% less care needed 
\do{...}{$\dots$} 
\do{\ProvidesFile}{`\ProvidesFile'} 
\do{"loads"}{``loads''} 
\do{USAGE:}{\section{Usage}} 
\do{TRICKS:}{\section{Tricks, Package Option}} 
%% 2012/09/28 for v0.5, generation support:
\do{VARIANTS:}{\section{Variants}} 
% \do{<txt-file>}{\MetaVar{txt-file}}     %% 2012/09/28
\do{IMPLEMENTATION:}{\section{Implementation}} 
\do{gather.tex}{`gather.tex'}
\do{readprov.pdf}{`readprov.pdf'}
\do{readprov-.sty}{readprov.sty}            %% 2010/11/26
\do{readprov.sty}{'readprov.sty'}
\do{myfilist-.sty}{myfilist.sty}            %% 2010/11/26
\do{myfilist.sty}{'myfilist.sty'}           %% 2012/09/28
\do{ifnextok.sty}{'ifnextok.sty'} 
\do{adhocfilelist}{'adhocfilelist'} 
\do{filedate.sty}{'filedate.sty'}           %% 2012/10/25
\do[\MakeOther\ ]%
{run gather.tex}{\emph{run} gather.tex}
  %% <- TODO \PrependStandardEnhancement...
\SetCorrectHookJobLast
\ResetPatternCodes

\MainDocParser{\ProcessInputWith{PScomment}}
\LaTeXresultFile{myfilist.doc}
\MakeCloseDoc*{myfilist.sty}                        %% 2012/03/18
  %% <- we must NOT read mdoccorr.cfg here! 
  %%    (or put the above setup into a new one!) ->
% \MakeJobDoc{0}{\ProcessInputWith{PScomment}}

%% Typesetting:
\documentclass{article} 
\usepackage{color} %% for highlighting package version!? TODO
\input{makedoc.cfg}
\ReadPackageInfos{myfilist}
\usepackage{wiki}
%% TeX markup inserted by the txt-to-TeX function must be 
%% declared here for using 'niceverb''s ``auto mode.'' 
\AddToNoVerbList{\LaTeXe\dots\textbf\emph\ 
                 %% <- at end of line! 2012/11/22 TODO not working!?!
                 \\                         %% 2012/11/22
                 \TeX\LaTeX}                %% 2012/09/28
\begingroup \MakeActive\" 
 \gdef\fineDQ{``\begingroup
   \let\do\MakeOther \dospecials \tt
   \def"{\endgroup''}}%
\endgroup

\pagestyle{headings}
\usepackage{parskip}

\MDfinaldatechecks
\begin{document}

\maketitle 

\begin{abstract}\sloppy\noindent
  'myfilist' addresses lazy file versions management, 
  when you move your package or chapter files through 
  various computers and various directories and after a while 
  wonder where the most recent versions are.

  Like Paul Ebermann's 
  'dateiliste',\urlfoot{CtanPkgRef}{dateiliste}
  'myfilist' varies \LaTeX's `\listfiles' 
  for listing file (especially version) informations. 
  Differences to 'dateiliste' and \LaTeX\ are:
  \begin{enumerate}
    \item You choose the files (and their order) to be listed;
    \item indeed (according to original intention): 
          this has very little to do with files used in 
          typesetting some document;
    \item output is just screen, `.log', or a `.txt'-type file 
          that you choose. 
  \end{enumerate}
  %% 2012/11/22 while mentioning 'nicetext' moves to final section:
  However, `\ListFileInfos[<txt-file>]' from here can also be used 
  to \emph{with} typesetting in order to get `\listfiles' output 
  in a separate plain text file `<txt-file>' 
  (\emph{without} remaining `.log' content).

\end{abstract}

% \pagebreak
\tableofcontents

\section{Installing}
The file '\jobname.sty' is provided ready, installation only requires 
putting it somewhere where \TeX\ finds it 
(which may need updating the filename data 
 base).\urlfoot{ukfaqref}{inst-wlcf}

\section{File Info Header}
\sloppy 
\let\\\MDdocnewline                         %% 2012/11/22
\setlength\topsep{\smallskipamount}         %% 2012/11/22
\enlargethispage{2\baselineskip}            %% 2012/11/22
\wikiEnvironments      %% TODO fails with "or" 2010/03/31
\MakeActiveLetHere\"\fineDQ %% fails with "loads"
\AutoCmdInput{myfilist.doc}
\nowikiEnvironments

\section{Example}
% \setlength{\parskip}{0pt}           %% 2012/11/13
\AddQuotes
`gather.tex' for the present bundle has been as follows.
%   %% TODO 2010/11/27:
% (added development versions of 'fifinddo.sty' etc.):
%% 2012/11/12:
`filedate' and `fdatechk' refer to checking ``date consistency''
with the \ctanpkgref{filedate} package, at the same time 
as updating the ``source file list'' `SrcFILEs.txt' 
which is generated by
\[`\NoStopListInfos[SrcFILEs.txt]'\]
Some entries refer to the \ctanpkgref{nicetext} bundle 
that has been used (``\code{----USED.---}'') 
to generate the documentation file `myfilist.pdf'.
\setlength{\topsep}{.5\bigskipamount}   %% 2012/11/30
\MDsamplecodeinput{gather}              %% 2010/11/27 2012/11/13
As to `fdatechk.tex':
\MDsamplecodeinput{fdatechk}

\section{Relation to 'nicetext' bundle.}
%% 2012/11/22 moves from abstract
The code of this package was ready in spring 2008; 
in spring 2010 I presented it as a kind of study on improving 
'nicetext''s\urlfoot{CtanPkgRef}{nicetext}
`txt'-to-\LaTeX\ processing after 'nicetext v0.4' 
(aim was to do this without modifying the documented file, 
 yet I did not obey this rule strictly here).
The new idea is adding 'wiki.sty''s ``environments'' 
feature to 'makedoc' and 'niceverb''s ``auto mode'' %% was " 2012/11/22
in order to interprete `txt' comment indents in the package file, 
while 'wiki.sty''s \emph{font} switching 
still is not compatible with 'niceverb''s. Easy script 
commands for achieving this are still missing (sorry; see the code 
in 'myfilist.tex' that achieved the present formatting.)

\end{document}