| 1 |
\ProvidesFile{readprov.tex}[2012/11/22 documenting readprov.sty] |
| 2 |
% \ProvidesFile{readprov.tex}[2012/03/18 documenting readprov.sty] |
| 3 |
% \ProvidesFile{readprov.tex}[2011/01/29 documenting readprov.sty] |
| 4 |
|
| 5 |
\title{\textsf{readprov}\\---\\Get File Info without Loading% |
| 6 |
% \GetFileInfo{readprov.sty}% |
| 7 |
% \ReadFileInfos{readprov.sty}% %% \NeedsTeXFormat |
| 8 |
\thanks{% |
| 9 |
This file describes |
| 10 |
% \protect\GetFileInfo{readprov.sty}% %% FAILS! |
| 11 |
version |
| 12 |
% \textbf{\fileversion} of \textsf{\filename} as of \filedate.}% |
| 13 |
\textcolor{blue}{\UseVersionOf{readprov.sty}} |
| 14 |
of \textsf{readprov.sty} as of \UseDateOf{readprov.sty}.}% |
| 15 |
} %% <- TODO macro in makedoc.cfg |
| 16 |
% \listfiles |
| 17 |
|
| 18 |
%% Preprocessing: |
| 19 |
\RequirePackage{makedoc} |
| 20 |
\CopyFDconditionFromTo{PScomment}{comment} |
| 21 |
\MainDocParser{\ProcessInputWith{PScomment}} |
| 22 |
%% Replacements: |
| 23 |
\StartPrependingChain |
| 24 |
\SetPatternCodes{\MakeOther\\\MakeOther\ } %% CARE! |
| 25 |
% \PrependExpandableAllReplacer{tex}{ .tex}{ `.tex'} |
| 26 |
\renewcommand*{\do}{\PrependExpandableAllReplacer} %% 2012/11/22 |
| 27 |
\do{sty}{ .sty}{ `.sty'} |
| 28 |
\do{cls}{.cls}{`.cls'} |
| 29 |
\do{etc}{etc. }{etc.\ } |
| 30 |
% \PrependExpandableAllReplacer{etc...}{etc. ...}{etc.\ $\dots$} |
| 31 |
\SetPatternCodes{\MakeOther\\} %% less care needed |
| 32 |
\do{LaTeX}{LaTeX}{\LaTeX} |
| 33 |
\do{xpbl}{expandable}{\emph{expandable}} |
| 34 |
\do{rob}{robust}{\emph{robust}} |
| 35 |
\do{frag}{fragile}{\emph{fragile}} |
| 36 |
\do{doc}{doc.sty}{'doc.sty'} |
| 37 |
\do{myfilist}{myfilist.sty}{'myfilist.sty'} |
| 38 |
\do{readprov}{readprov.sty}{'readprov.sty'} |
| 39 |
% \do{provf}{\ProvidesFile}{`\ProvidesFile'} %% rm. 2012/11/22 |
| 40 |
\do{NOTE}{NOTE:}{\paragraph{Note:}} |
| 41 |
% \PrependExpandableAllReplacer{Note}{Note:}{\emph{Note:} } |
| 42 |
\do{prov}{provided}{\emph{provided}} |
| 43 |
\do{*fail*}{*fail*}{\emph{fail}} |
| 44 |
\do{INSTALL}{INSTALL:}{\section{Installation}} |
| 45 |
\do{USAGE}{USAGE:}{\section{Usage}} |
| 46 |
\do{IMPLEM}{IMPLEMENTATION:}{\section{Implementation}} |
| 47 |
\do{LOAD}{LOADING:}{\paragraph{Loading:}} |
| 48 |
\do{INS}{INSERTING:}{\paragraph{Inserting:}} |
| 49 |
\do{READ}{EXTRACTING:}{\paragraph{Extracting:}} |
| 50 |
\do{TODO}{TODO}{\textcolor{blue}{TODO}} |
| 51 |
\SetPatternCodes{\MakeOther\\\MakeOther\$} |
| 52 |
\do{dots}{...}{$\dots$} |
| 53 |
\SetCorrectHookJobLast |
| 54 |
\ResetPatternCodes |
| 55 |
|
| 56 |
\LaTeXresultFile{readprov.doc} |
| 57 |
\MakeCloseDoc*{readprov.sty} %% star 2012/03/18 |
| 58 |
%% <- we must NOT read mdoccorr.cfg here! |
| 59 |
%% (or put the above setup into a new one!) -> |
| 60 |
% \MakeJobDoc{0}{\ProcessInputWith{PScomment}} |
| 61 |
|
| 62 |
%% Typesetting: |
| 63 |
\documentclass{article} |
| 64 |
\usepackage{color} %% for highlighting package version!? TODO |
| 65 |
\input{makedoc.cfg} |
| 66 |
\usepackage{readprov} |
| 67 |
% \ReadFileInfos{report.cls} %% WORKS! 2010/11/27 |
| 68 |
\usepackage{wiki} |
| 69 |
\begingroup \MakeActive\" |
| 70 |
\gdef\fineDQ{``\begingroup |
| 71 |
\let\do\MakeOther \dospecials \tt |
| 72 |
\def"{\endgroup''}}% |
| 73 |
\endgroup |
| 74 |
% \makeatletter \MakeLetter\_ |
| 75 |
|
| 76 |
\pagestyle{headings} |
| 77 |
% \usepackage{parskip} |
| 78 |
|
| 79 |
\MDfinaldatechecks |
| 80 |
\begin{document} |
| 81 |
|
| 82 |
\maketitle |
| 83 |
|
| 84 |
\begin{abstract}\sloppy\noindent |
| 85 |
'readprov.sty' |
| 86 |
renders `\GetFileInfo' from \LaTeX's |
| 87 |
'doc.sty'\urlfoot{CtanPkgRef}{doc} |
| 88 |
(without the latter being required) |
| 89 |
and new robust (expandable) variants of it, |
| 90 |
usable with files that are not really loaded |
| 91 |
(they are quit when their file info is found, cf. the 'zwgetfdate' |
| 92 |
package\urlfoot{CtanPkgRef}{zwgetfdate}). |
| 93 |
So, e.g., you can describe packages that are incompatible |
| 94 |
with each other or with packages that your document uses. |
| 95 |
You even can report about various class files. |
| 96 |
|
| 97 |
Such packages then also appear with \LaTeX's `\listfiles'. |
| 98 |
You may consider this a bug $\dots$ |
| 99 |
'myfilist.sty' |
| 100 |
makes it a feature (see `myfilist.pdf'). |
| 101 |
\end{abstract} |
| 102 |
|
| 103 |
% \pagebreak |
| 104 |
\tableofcontents |
| 105 |
|
| 106 |
\section{Installing} |
| 107 |
The file '\jobname.sty' is provided ready, installation only requires |
| 108 |
putting it somewhere where \TeX\ finds it |
| 109 |
(which may need updating the filename data |
| 110 |
base).\footnote{\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf}} |
| 111 |
|
| 112 |
\section{File Info Header} |
| 113 |
|
| 114 |
\sloppy |
| 115 |
\AddToNoVerbList{% |
| 116 |
\LaTeX\emph\dots\quad\paragraph\texttt\textcolor\\% |
| 117 |
\-} %% 2012/11/11 |
| 118 |
\MakeActiveLetHere\"\fineDQ |
| 119 |
\let\\\MDdocnewline %% MD 2012/11/12 |
| 120 |
%% CARE! from next line on, code line indents are special! |
| 121 |
\wikiEnvironments %% TODO fails with "or" 2010/03/31 |
| 122 |
\AutoCmdInput{readprov.doc} |
| 123 |
\nowikiEnvironments %% 2012/11/12 |
| 124 |
|
| 125 |
\end{document} |