From 41862aee3f93850e517e176a9c6879670e1ff68b Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 28 Nov 2010 23:51:04 +0000 Subject: new latex package fileinfo (28nov10) git-svn-id: svn://tug.org/texlive/trunk@20590 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/fileinfo/CONTENTs.txt | 17 +++ Master/texmf-dist/doc/latex/fileinfo/README | 39 ++++++ Master/texmf-dist/doc/latex/fileinfo/README.txt | 39 ++++++ .../doc/latex/fileinfo/docsrc/README.tex | 11 ++ .../doc/latex/fileinfo/docsrc/makedoc.cfg | 41 +++++++ .../doc/latex/fileinfo/docsrc/myfilist.tex | 134 +++++++++++++++++++++ .../doc/latex/fileinfo/docsrc/readprov.tex | 129 ++++++++++++++++++++ Master/texmf-dist/doc/latex/fileinfo/gather.tex | 8 ++ Master/texmf-dist/doc/latex/fileinfo/myfilist.pdf | Bin 0 -> 156733 bytes Master/texmf-dist/doc/latex/fileinfo/readprov.pdf | Bin 0 -> 155848 bytes 10 files changed, 418 insertions(+) create mode 100644 Master/texmf-dist/doc/latex/fileinfo/CONTENTs.txt create mode 100644 Master/texmf-dist/doc/latex/fileinfo/README create mode 100644 Master/texmf-dist/doc/latex/fileinfo/README.txt create mode 100644 Master/texmf-dist/doc/latex/fileinfo/docsrc/README.tex create mode 100644 Master/texmf-dist/doc/latex/fileinfo/docsrc/makedoc.cfg create mode 100644 Master/texmf-dist/doc/latex/fileinfo/docsrc/myfilist.tex create mode 100644 Master/texmf-dist/doc/latex/fileinfo/docsrc/readprov.tex create mode 100644 Master/texmf-dist/doc/latex/fileinfo/gather.tex create mode 100644 Master/texmf-dist/doc/latex/fileinfo/myfilist.pdf create mode 100644 Master/texmf-dist/doc/latex/fileinfo/readprov.pdf (limited to 'Master/texmf-dist/doc') diff --git a/Master/texmf-dist/doc/latex/fileinfo/CONTENTs.txt b/Master/texmf-dist/doc/latex/fileinfo/CONTENTs.txt new file mode 100644 index 00000000000..602be4ff8fd --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/CONTENTs.txt @@ -0,0 +1,17 @@ + + *File List* +readprov.sty 2010/11/27 v0.3 file infos without loading (UL) +myfilist.sty 2010/11/27 v0.3 \listfiles -- mine only (UL) +readprov.tex 2010/11/27 documenting readprov.sty +myfilist.tex 2010/11/27 documenting myfilist.sty + makedoc.cfg 2010/11/26 documentation settings + README.tex 2010/11/27 make README.pdf +fifinddo.sty 2010/11/25 v0.42 filtering TeX(t) files by TeX (UL) + makedoc.sty 2010/03/30 v0.4 TeX input from *.sty (UL) +niceverb.sty 2010/11/09 v0.41a minimize doc markup (UL) + gather.tex 2010/11/27 collect file infos + *********** + + List made at 2010/11/27, 21:25 + from script file gather.tex + diff --git a/Master/texmf-dist/doc/latex/fileinfo/README b/Master/texmf-dist/doc/latex/fileinfo/README new file mode 100644 index 00000000000..04c9eff3fa8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/README @@ -0,0 +1,39 @@ + == README for the `fileinfo' bundle == + +This bundle has packages `readprov.sty' and `myfilist.sty'. + +`readprov.sty' + + renders \GetFileInfo from LaTeX's `doc.sty' (without the + latter being required), as well as 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). 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 ... + +`myfilist.sty' + + makes this "bug" a feature. In a "TeX script," you can choose + some files and their order. Their names can be output into a + plain text file with their dates, version ids, and one-line + descriptions, formatted in the way \listfiles does it after + a LaTeX run. This way you can get an overview of, e.g., some + package bundle ... + + (So this is quite different from `dateiliste'.) + +`readprov' and `myfilist' are licensed according to the LaTeX +Project Public License (see files; NO WARRANTY!). They are +author-maintained. + +The two packages are described in more detail in `readprov.pdf' +and `myfilist.pdf'. These documentation files also serve to +demonstrate some .txt->.tex functionality of the `nicetext' bundle. + +2010/11/28, U.L., http://contact-ednotes.sty.de.vu + diff --git a/Master/texmf-dist/doc/latex/fileinfo/README.txt b/Master/texmf-dist/doc/latex/fileinfo/README.txt new file mode 100644 index 00000000000..04c9eff3fa8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/README.txt @@ -0,0 +1,39 @@ + == README for the `fileinfo' bundle == + +This bundle has packages `readprov.sty' and `myfilist.sty'. + +`readprov.sty' + + renders \GetFileInfo from LaTeX's `doc.sty' (without the + latter being required), as well as 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). 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 ... + +`myfilist.sty' + + makes this "bug" a feature. In a "TeX script," you can choose + some files and their order. Their names can be output into a + plain text file with their dates, version ids, and one-line + descriptions, formatted in the way \listfiles does it after + a LaTeX run. This way you can get an overview of, e.g., some + package bundle ... + + (So this is quite different from `dateiliste'.) + +`readprov' and `myfilist' are licensed according to the LaTeX +Project Public License (see files; NO WARRANTY!). They are +author-maintained. + +The two packages are described in more detail in `readprov.pdf' +and `myfilist.pdf'. These documentation files also serve to +demonstrate some .txt->.tex functionality of the `nicetext' bundle. + +2010/11/28, U.L., http://contact-ednotes.sty.de.vu + diff --git a/Master/texmf-dist/doc/latex/fileinfo/docsrc/README.tex b/Master/texmf-dist/doc/latex/fileinfo/docsrc/README.tex new file mode 100644 index 00000000000..ce26748edb5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/docsrc/README.tex @@ -0,0 +1,11 @@ +\ProvidesFile{README.tex}[2010/11/27 make README.pdf] +\listfiles + +\documentclass[12pt]{article} +\usepackage{verbatim} +\pagestyle{empty} +\begin{document} +\vspace*{-2\baselineskip} +\enlargethispage{1\baselineskip} +\verbatiminput{README.txt} +\end{document} diff --git a/Master/texmf-dist/doc/latex/fileinfo/docsrc/makedoc.cfg b/Master/texmf-dist/doc/latex/fileinfo/docsrc/makedoc.cfg new file mode 100644 index 00000000000..0dfda857b69 --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/docsrc/makedoc.cfg @@ -0,0 +1,41 @@ +\ProvidesFile{makedoc.cfg}[2010/11/26 documentation settings] + +\author{Uwe L\"uck\thanks{\url{http://contact-ednotes.sty.de.vu}}} +% \author{Uwe L\"uck---{\tt http://contact-ednotes.sty.de.vu}} + +%% hyperref: +\RequirePackage{ifpdf} +\usepackage[% + \ifpdf + bookmarksnumbered, +% bookmarks=false, +% bookmarksopen, +% pdfpagemode=UseNone, +% pdfstartpage=10, +% pdfstartview=FitH, + citebordercolor={.6 1 .6}, + filebordercolor={1 .6 1}, + linkbordercolor={1 .9 .7}, +% urlbodercolor={1 0 0}, + \else + draft + \fi +]{hyperref} + +%% struts for wide border colors: +\makeatletter + \let\@strut@tocline\@dottedtocline + \renewcommand*{\@dottedtocline}[4]{% + \@strut@tocline{#1}{#2}{#3}{\mathstrut#4\mathstrut}} + \let\@strut@section\l@section + \renewcommand*{\l@section}[1]{% + \@strut@section{\mathstrut#1\mathstrut}} +\makeatother + +\RequirePackage{niceverb}[2010/03/20] + +\errorcontextlines=4 +\pagestyle{headings} + +\endinput + diff --git a/Master/texmf-dist/doc/latex/fileinfo/docsrc/myfilist.tex b/Master/texmf-dist/doc/latex/fileinfo/docsrc/myfilist.tex new file mode 100644 index 00000000000..a7498f2791a --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/docsrc/myfilist.tex @@ -0,0 +1,134 @@ +\ProvidesFile{myfilist.tex}[2010/11/27 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{LaTeX2e}{LaTeX2e }{\LaTeXe }{LEAVE} +% \MakeExpandableAllReplacer{TeX}{\TeX }{\TeX{} }{LEAVE} +\PrependExpandableAllReplacer{log}{ .log}{ `.log'} +\PrependExpandableAllReplacer{tex}{ .tex}{ `.tex'} +\PrependExpandableAllReplacer{cls}{ .cls}{ `.cls'} +\PrependExpandableAllReplacer{sty}{ .sty}{ `.sty'} +\PrependExpandableAllReplacer{NOTE}{NOTE: }{\textbf{Note: }} +\SetPatternCodes{\MakeOther\\} %% less care needed +\PrependExpandableAllReplacer{dots}{...}{$\dots$} +\PrependExpandableAllReplacer{provf}{\ProvidesFile}{`\ProvidesFile'} +\PrependExpandableAllReplacer{loads}{"loads"}{``loads''} +\PrependExpandableAllReplacer{USAGE}{USAGE:}{\section{Usage}} +\PrependExpandableAllReplacer{IMPLEM} + {IMPLEMENTATION:}{\section{Implementation}} +\PrependExpandableAllReplacer{gather} + {gather.tex}{`gather.tex'} +\PrependExpandableAllReplacer{readprov.pdf} + {readprov.pdf}{`readprov.pdf'} +\PrependExpandableAllReplacer{readprov-} %% 2010/11/26 + {readprov-.sty}{readprov.sty} +\PrependExpandableAllReplacer{readprov} + {readprov.sty}{'readprov.sty'} +\PrependExpandableAllReplacer{myfilist-} %% 2010/11/26 + {myfilist-.sty}{myfilist.sty} +\PrependExpandableAllReplacer{myfilist} + {myfilist.sty}{'myfilist.sty'} +\PrependExpandableAllReplacer{rungather}[\MakeOther\ ]% +{run gather.tex}{\emph{run} gather.tex} + %% <- TODO \PrependStandardEnhancement... +\SetCorrectHookJobLast +\ResetPatternCodes + +\MainDocParser{\ProcessInputWith{PScomment}} +\LaTeXresultFile{myfilist.doc} +\MakeCloseDoc{myfilist.sty} + %% <- 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 +\usepackage{readprov} +\ReadPackageInfos{myfilist} +\input{makedoc.cfg} +\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} +\begingroup \MakeActive\" + \gdef\fineDQ{``\begingroup + \let\do\MakeOther \dospecials \tt + \def"{\endgroup''}}% +\endgroup + +\pagestyle{headings} +\usepackage{parskip} + +\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',\footnote{\url{http://ctan.org/pkg/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: 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} + + The code of this package is two years old; presenting it \emph{now} is + a kind of study on improving + 'nicetext''s\footnote{\url{http://ctan.org/pkg/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 ruly strictly here). + The new idea is adding 'wiki.sty''s ``environments'' + feature to 'makedoc' and 'niceverb''s ``auto mode" + 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{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 +\wikiEnvironments %% TODO fails with "or" 2010/03/31 +\MakeActiveLetHere\"\fineDQ %% fails with "loads" +\AutoCmdInput{myfilist.doc} +\nowikiEnvironments + +\section{Example} +`gather.tex' for the present bundle has been as follows + %% TODO 2010/11/27: +(added development versions of 'fifinddo.sty' etc.): +\verbatiminput{gather} %% 2010/11/27 + +\end{document} diff --git a/Master/texmf-dist/doc/latex/fileinfo/docsrc/readprov.tex b/Master/texmf-dist/doc/latex/fileinfo/docsrc/readprov.tex new file mode 100644 index 00000000000..8d8253d422a --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/docsrc/readprov.tex @@ -0,0 +1,129 @@ +\ProvidesFile{readprov.tex}[2010/11/27 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'} +\PrependExpandableAllReplacer{sty}{ .sty}{ `.sty'} +\PrependExpandableAllReplacer{cls}{.cls}{`.cls'} +\PrependExpandableAllReplacer{etc}{etc. }{etc.\ } +% \PrependExpandableAllReplacer{etc...}{etc. ...}{etc.\ $\dots$} +\SetPatternCodes{\MakeOther\\} %% less care needed +\PrependExpandableAllReplacer{LaTeX}{LaTeX}{\LaTeX} +\PrependExpandableAllReplacer{xpbl}{expandable}{\emph{expandable}} +\PrependExpandableAllReplacer{rob}{robust}{\emph{robust}} +\PrependExpandableAllReplacer{frag}{fragile}{\emph{fragile}} +\PrependExpandableAllReplacer{doc}{doc.sty}{'doc.sty'} +\PrependExpandableAllReplacer{myfilist}{myfilist.sty}{'myfilist.sty'} +\PrependExpandableAllReplacer{readprov}{readprov.sty}{'readprov.sty'} +\PrependExpandableAllReplacer{provf}{\ProvidesFile}{`\ProvidesFile'} +\PrependExpandableAllReplacer{NOTE}{NOTE:}{\paragraph{Note:}} +% \PrependExpandableAllReplacer{Note}{Note:}{\emph{Note:} } +\PrependExpandableAllReplacer{prov}{provided}{\emph{provided}} +\PrependExpandableAllReplacer{*fail*}{*fail*}{\emph{fail}} +\PrependExpandableAllReplacer{INSTALL}{INSTALL:}{\section{Installation}} +\PrependExpandableAllReplacer{USAGE}{USAGE:}{\section{Usage}} +\PrependExpandableAllReplacer{IMPLEM} + {IMPLEMENTATION:}{\section{Implementation}} +\PrependExpandableAllReplacer{LOAD}{LOADING:} + {\paragraph{Loading:}} +\PrependExpandableAllReplacer{INS}{INSERTING:} + {\paragraph{Inserting:}} +\PrependExpandableAllReplacer{READ}{EXTRACTING:} + {\paragraph{Extracting:}} +\PrependExpandableAllReplacer{TODO}{TODO} + {\textcolor{blue}{TODO}} +\SetPatternCodes{\MakeOther\\\MakeOther\$} +\PrependExpandableAllReplacer{dots}{...}{$\dots$} +\SetCorrectHookJobLast +\ResetPatternCodes + +\LaTeXresultFile{readprov.doc} +\MakeCloseDoc{readprov.sty} + %% <- 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} + +\begin{document} + +\maketitle + +\begin{abstract}\sloppy\noindent +'readprov.sty' + renders `\GetFileInfo' from \LaTeX's + 'doc.sty'\footnote{\url{http://ctan.org/pkg/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\footnote{\url{httpref://ctan.org/pkg/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 +\makeatletter + \newcommand*{\docnewline}{\leavevmode\@normalcr[\topsep]} + %% <- \leavevmode for use with \paragraph. + %% sometimes needs to be preceded by a space. +\makeatother +\AddToNoVerbList{% + \LaTeX\emph\dots\quad\paragraph\texttt\textcolor\\} +\MakeActiveLetHere\"\fineDQ +\let\\\docnewline +%% CARE! from next line on, code line indents are special! +\wikiEnvironments %% TODO fails with "or" 2010/03/31 +\AutoCmdInput{readprov.doc} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/fileinfo/gather.tex b/Master/texmf-dist/doc/latex/fileinfo/gather.tex new file mode 100644 index 00000000000..4428ece92da --- /dev/null +++ b/Master/texmf-dist/doc/latex/fileinfo/gather.tex @@ -0,0 +1,8 @@ +\RequirePackage{myfilist} +\ProvidesFile{gather.tex}[2010/11/27 collect file infos] +\EmptyFileList[readprov.sty,myfilist.sty] +\ReadPackageInfos{readprov,myfilist} +\ReadFileInfos{readprov.tex,myfilist.tex,makedoc.cfg,README.tex} +\ReadPackageInfos{fifinddo,makedoc,niceverb} +\ReadFileInfos{gather} +\ListInfos[CONTENTs.txt] diff --git a/Master/texmf-dist/doc/latex/fileinfo/myfilist.pdf b/Master/texmf-dist/doc/latex/fileinfo/myfilist.pdf new file mode 100644 index 00000000000..0324be07362 Binary files /dev/null and b/Master/texmf-dist/doc/latex/fileinfo/myfilist.pdf differ diff --git a/Master/texmf-dist/doc/latex/fileinfo/readprov.pdf b/Master/texmf-dist/doc/latex/fileinfo/readprov.pdf new file mode 100644 index 00000000000..9c71e89ae5a Binary files /dev/null and b/Master/texmf-dist/doc/latex/fileinfo/readprov.pdf differ -- cgit v1.2.3