diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/fileinfo/docsrc |
Initial commit
Diffstat (limited to 'macros/latex/contrib/fileinfo/docsrc')
-rw-r--r-- | macros/latex/contrib/fileinfo/docsrc/README.tex | 12 | ||||
-rw-r--r-- | macros/latex/contrib/fileinfo/docsrc/fdatechk.tex | 11 | ||||
-rw-r--r-- | macros/latex/contrib/fileinfo/docsrc/gather.tex | 20 | ||||
-rw-r--r-- | macros/latex/contrib/fileinfo/docsrc/myfilist.tex | 166 | ||||
-rw-r--r-- | macros/latex/contrib/fileinfo/docsrc/readprov.tex | 125 |
5 files changed, 334 insertions, 0 deletions
diff --git a/macros/latex/contrib/fileinfo/docsrc/README.tex b/macros/latex/contrib/fileinfo/docsrc/README.tex new file mode 100644 index 0000000000..a4bf82368f --- /dev/null +++ b/macros/latex/contrib/fileinfo/docsrc/README.tex @@ -0,0 +1,12 @@ +\ProvidesFile{README.tex}[2012/03/18 make README.pdf] +\listfiles + +\documentclass[12pt]{article} +\usepackage{verbatim} +\pagestyle{empty} +\begin{document} +\vspace*{-3\baselineskip} +\enlargethispage{2\baselineskip} +% \small %% 2011/02/14 +\verbatiminput{README.txt} +\end{document} diff --git a/macros/latex/contrib/fileinfo/docsrc/fdatechk.tex b/macros/latex/contrib/fileinfo/docsrc/fdatechk.tex new file mode 100644 index 0000000000..f150161a1e --- /dev/null +++ b/macros/latex/contrib/fileinfo/docsrc/fdatechk.tex @@ -0,0 +1,11 @@ +\ProvidesFile{fdatechk.tex}[2012/11/13 filedate checks] +%% TODO shorter notation +\ModDates +%\EqualityMessages +\FileDateAutoChecks +\ReadFileInfos{fileinfo.RLS, + readprov.sty,myfilist.sty, + readprov,myfilist, + gather,fdatechk} +\DatesDiffWarnings +\CheckDateOfToday{fileinfo.RLS} diff --git a/macros/latex/contrib/fileinfo/docsrc/gather.tex b/macros/latex/contrib/fileinfo/docsrc/gather.tex new file mode 100644 index 0000000000..2cdbd9f23c --- /dev/null +++ b/macros/latex/contrib/fileinfo/docsrc/gather.tex @@ -0,0 +1,20 @@ +\ProvidesFile{gather.tex}[2012/11/22 collect file infos] +\RequirePackage[no-bot]{myfilist} +\RequirePackage{dowith,filedate} +\EqualityMessages \FileDateAutoChecks %% works 2012/11/22 +\EmptyFileList[readprov.sty,myfilist.sty] +\FileListRemark[----------]{-RELEASE.---} +\ReadFileInfos{fileinfo.RLS} +\FileListRemark[----------]{-----USE.---} +\ReadPackageInfos{myfilist,readprov} +\FileListRemark[----------]{-----DOC.---} +\ReadFileInfos{myfilist,readprov} +\FileListRemark[----------]{----USED.---} +\ReadFileInfos{makedoc.cfg} +\ReadPackageInfos{fifinddo,makedoc,niceverb} +\ReadFileInfos{README,fdatechk,gather} +\NoStopListInfos[SrcFILEs.txt] +% \input{fdatechk.tex} +%% <- 2012/11/22 -> +\DatesDiffWarnings \CheckDateOfToday{fileinfo.RLS} +\stop diff --git a/macros/latex/contrib/fileinfo/docsrc/myfilist.tex b/macros/latex/contrib/fileinfo/docsrc/myfilist.tex new file mode 100644 index 0000000000..4cb47374cc --- /dev/null +++ b/macros/latex/contrib/fileinfo/docsrc/myfilist.tex @@ -0,0 +1,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} diff --git a/macros/latex/contrib/fileinfo/docsrc/readprov.tex b/macros/latex/contrib/fileinfo/docsrc/readprov.tex new file mode 100644 index 0000000000..1ee52288a7 --- /dev/null +++ b/macros/latex/contrib/fileinfo/docsrc/readprov.tex @@ -0,0 +1,125 @@ +\ProvidesFile{readprov.tex}[2012/11/22 documenting readprov.sty] +% \ProvidesFile{readprov.tex}[2012/03/18 documenting readprov.sty] +% \ProvidesFile{readprov.tex}[2011/01/29 documenting readprov.sty] + +\title{\textsf{readprov}\\---\\Get File Info without Loading% +% \GetFileInfo{readprov.sty}% +% \ReadFileInfos{readprov.sty}% %% \NeedsTeXFormat + \thanks{% + This file describes +% \protect\GetFileInfo{readprov.sty}% %% FAILS! + version +% \textbf{\fileversion} of \textsf{\filename} as of \filedate.}% + \textcolor{blue}{\UseVersionOf{readprov.sty}} + of \textsf{readprov.sty} as of \UseDateOf{readprov.sty}.}% +} %% <- TODO macro in makedoc.cfg +% \listfiles + +%% Preprocessing: +\RequirePackage{makedoc} +\CopyFDconditionFromTo{PScomment}{comment} +\MainDocParser{\ProcessInputWith{PScomment}} +%% Replacements: +\StartPrependingChain +\SetPatternCodes{\MakeOther\\\MakeOther\ } %% CARE! +% \PrependExpandableAllReplacer{tex}{ .tex}{ `.tex'} +\renewcommand*{\do}{\PrependExpandableAllReplacer} %% 2012/11/22 +\do{sty}{ .sty}{ `.sty'} +\do{cls}{.cls}{`.cls'} +\do{etc}{etc. }{etc.\ } +% \PrependExpandableAllReplacer{etc...}{etc. ...}{etc.\ $\dots$} +\SetPatternCodes{\MakeOther\\} %% less care needed +\do{LaTeX}{LaTeX}{\LaTeX} +\do{xpbl}{expandable}{\emph{expandable}} +\do{rob}{robust}{\emph{robust}} +\do{frag}{fragile}{\emph{fragile}} +\do{doc}{doc.sty}{'doc.sty'} +\do{myfilist}{myfilist.sty}{'myfilist.sty'} +\do{readprov}{readprov.sty}{'readprov.sty'} +% \do{provf}{\ProvidesFile}{`\ProvidesFile'} %% rm. 2012/11/22 +\do{NOTE}{NOTE:}{\paragraph{Note:}} +% \PrependExpandableAllReplacer{Note}{Note:}{\emph{Note:} } +\do{prov}{provided}{\emph{provided}} +\do{*fail*}{*fail*}{\emph{fail}} +\do{INSTALL}{INSTALL:}{\section{Installation}} +\do{USAGE}{USAGE:}{\section{Usage}} +\do{IMPLEM}{IMPLEMENTATION:}{\section{Implementation}} +\do{LOAD}{LOADING:}{\paragraph{Loading:}} +\do{INS}{INSERTING:}{\paragraph{Inserting:}} +\do{READ}{EXTRACTING:}{\paragraph{Extracting:}} +\do{TODO}{TODO}{\textcolor{blue}{TODO}} +\SetPatternCodes{\MakeOther\\\MakeOther\$} +\do{dots}{...}{$\dots$} +\SetCorrectHookJobLast +\ResetPatternCodes + +\LaTeXresultFile{readprov.doc} +\MakeCloseDoc*{readprov.sty} %% star 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} +\usepackage{readprov} +% \ReadFileInfos{report.cls} %% WORKS! 2010/11/27 +\usepackage{wiki} +\begingroup \MakeActive\" + \gdef\fineDQ{``\begingroup + \let\do\MakeOther \dospecials \tt + \def"{\endgroup''}}% +\endgroup +% \makeatletter \MakeLetter\_ + +\pagestyle{headings} +% \usepackage{parskip} + +\MDfinaldatechecks +\begin{document} + +\maketitle + +\begin{abstract}\sloppy\noindent + 'readprov.sty' + renders `\GetFileInfo' from \LaTeX's + 'doc.sty'\urlfoot{CtanPkgRef}{doc} + (without the latter being required) + and new robust (expandable) variants of it, + usable with files that are not really loaded + (they are quit when their file info is found, cf. the 'zwgetfdate' + package\urlfoot{CtanPkgRef}{zwgetfdate}). + So, e.g., you can describe packages that are incompatible + with each other or with packages that your document uses. + You even can report about various class files. + + Such packages then also appear with \LaTeX's `\listfiles'. + You may consider this a bug $\dots$ +'myfilist.sty' + makes it a feature (see `myfilist.pdf'). +\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).\footnote{\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf}} + +\section{File Info Header} + +\sloppy +\AddToNoVerbList{% + \LaTeX\emph\dots\quad\paragraph\texttt\textcolor\\% + \-} %% 2012/11/11 +\MakeActiveLetHere\"\fineDQ +\let\\\MDdocnewline %% MD 2012/11/12 +%% CARE! from next line on, code line indents are special! +\wikiEnvironments %% TODO fails with "or" 2010/03/31 +\AutoCmdInput{readprov.doc} +\nowikiEnvironments %% 2012/11/12 + +\end{document} |