diff options
author | Karl Berry <karl@freefriends.org> | 2011-01-31 23:54:47 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-01-31 23:54:47 +0000 |
commit | dc52eaa9c7d13f6ed9b95c22f4ed1388b0075520 (patch) | |
tree | fb0327b827ab8e54f462e9cbc1498f479de22eb8 /Master/texmf-dist/doc | |
parent | 48e42e1b03975e2e28043aa45334e2ffc10d627c (diff) |
nicetext (30jan11)
git-svn-id: svn://tug.org/texlive/trunk@21245 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
27 files changed, 542 insertions, 91 deletions
diff --git a/Master/texmf-dist/doc/latex/nicetext/FILES.txt b/Master/texmf-dist/doc/latex/nicetext/FILES.txt index 21a8c5d6f2b..f9dc3a20e57 100644 --- a/Master/texmf-dist/doc/latex/nicetext/FILES.txt +++ b/Master/texmf-dist/doc/latex/nicetext/FILES.txt @@ -1,8 +1,10 @@ FILES IN CTAN DIRECTORY /macros/latex/contrib/nicetext: - FILES.txt present file -README summary -README.txt copy of README + FILES.txt present file +FileList.txt source file versions + README summary + README.txt copy of README + README.pdf PDF version of README fifinddo.sty parsing and file handling makedoc.sty package to documentation preprocessing @@ -18,9 +20,10 @@ demo automatically generated documentation ... doc documentation |____CHANGE.LOG bundle changes -|____CHANGE.txt copy of CHANGE.LOG in case +|____CHANGE.txt copy of CHANGE.LOG |___NNOUNCE.txt announcement for present release -|__RELEAS03.txt announcement for previous release +|__RELEAS03.txt announcement for earlier release +|__RELEAS04.txt announcement for earlier release |__fifinddo.pdf for fifinddo.sty |___makedoc.pdf for makedoc.sty |_mdoccheat.pdf lists makedoc+fifinddo commands @@ -28,10 +31,12 @@ doc documentation |_wikicheat.pdf lists wiki.sty features docsrc documentation sources +|____README.tex generates README.pdf |__fifinddo.tex +|____gather.tex gather source file versions |___makedoc.tex |___makedoc.cfg shared style settings -|__mdocchea.tex +|_mdoccheat.tex |__niceverb.tex |_wikicheat.tex @@ -44,4 +49,4 @@ run dialogues/templates/examples |____substr.tex typesets substr.sty documentation __________________________ -this file 2010/04/05, U.L. +this file 2011/01/26, U.L. diff --git a/Master/texmf-dist/doc/latex/nicetext/FileList.txt b/Master/texmf-dist/doc/latex/nicetext/FileList.txt new file mode 100644 index 00000000000..83f382ebe98 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/FileList.txt @@ -0,0 +1,17 @@ + + *File List* +fifinddo.sty 2011/01/25 v0.42 filtering TeX(t) files by TeX (UL) + makedoc.sty 2011/01/25 v0.41 TeX input from *.sty (UL) +niceverb.sty 2011/01/26 v0.42 minimize doc markup (UL) + wiki.sty 2008/07/02 v0.2 LaTeX through Wiki markup +fifinddo.tex 2010/11/27 documenting fifinddo.sty + makedoc.tex 2011/01/25 documenting makedoc.sty +niceverb.tex 2011/01/26 documenting niceverb.sty + makedoc.cfg 2011/01/24 documentation settings +mdoccorr.cfg 2011/01/12 local typographical corrections with makedoc.sty + gather.tex 2010/11/27 collect file infos + *********** + + List made at 2011/01/26, 17:48 + from script file gather.tex + diff --git a/Master/texmf-dist/doc/latex/nicetext/README b/Master/texmf-dist/doc/latex/nicetext/README index 252dc30865b..5ce1fb0b0c4 100644 --- a/Master/texmf-dist/doc/latex/nicetext/README +++ b/Master/texmf-dist/doc/latex/nicetext/README @@ -1,6 +1,6 @@ The NICETEXT bundle - (c) 2009 2010 Uwe Lueck http://contact-ednotes.sty.de.vu + (c) 2009-2011 Uwe Lueck http://contact-ednotes.sty.de.vu == General Idea == @@ -113,7 +113,7 @@ their main purpose is updating. The bundle is AUTHOR-MAINTAINED in the sense of the LPPL. -Copyright (C) 2009, 2010 Uwe Lueck, +Copyright (C) 2009-2011 Uwe Lueck, http://www.contact-ednotes.sty.de.vu @@ -122,4 +122,4 @@ form. ________________________________ - [This file 2010/04/05 Uwe Lueck] + [This file 2011/01/26 Uwe Lueck] diff --git a/Master/texmf-dist/doc/latex/nicetext/README.txt b/Master/texmf-dist/doc/latex/nicetext/README.txt index 252dc30865b..5ce1fb0b0c4 100644 --- a/Master/texmf-dist/doc/latex/nicetext/README.txt +++ b/Master/texmf-dist/doc/latex/nicetext/README.txt @@ -1,6 +1,6 @@ The NICETEXT bundle - (c) 2009 2010 Uwe Lueck http://contact-ednotes.sty.de.vu + (c) 2009-2011 Uwe Lueck http://contact-ednotes.sty.de.vu == General Idea == @@ -113,7 +113,7 @@ their main purpose is updating. The bundle is AUTHOR-MAINTAINED in the sense of the LPPL. -Copyright (C) 2009, 2010 Uwe Lueck, +Copyright (C) 2009-2011 Uwe Lueck, http://www.contact-ednotes.sty.de.vu @@ -122,4 +122,4 @@ form. ________________________________ - [This file 2010/04/05 Uwe Lueck] + [This file 2011/01/26 Uwe Lueck] diff --git a/Master/texmf-dist/doc/latex/nicetext/CHANGE.LOG b/Master/texmf-dist/doc/latex/nicetext/doc/CHANGE.LOG index b13f2a0df41..4bad6ce9db4 100644 --- a/Master/texmf-dist/doc/latex/nicetext/CHANGE.LOG +++ b/Master/texmf-dist/doc/latex/nicetext/doc/CHANGE.LOG @@ -1,5 +1,26 @@ ______________________________________________________________________ -nicetext RELEASE v0.41 2010/04/05 SUMMARY: documentation changes, +nicetext RELEASE 0.42 2011/01/26 SUMMARY: corrected `makedoc.sty', + enhanced `fifinddo.sty' and + .txt->.tex, use `hypertoc.sty' + and `texlinks.sty', minor fixes, + documentation enhancements + + README(.txt) 2011/01/26 updated + README.pdf 2011/01/26 new, README version + README.tex 2010/11/27 new, generates README.pdf + CHANGE.LOG/txt 2011/01/26 updated + FileList.txt/gather.tex2011/01/26 new for source file versions + fifinddo.sty v0.42 2011/01/25 code and documentation enhanced + fifinddo.tex/pdf 2010/11/27 uses `readprov.sty', +TODO + makedoc.cfg 2011/01/24 uses `hypertoc' and `readprov' + makedoc.sty v0.41 2011/01/25 corrected! + makedoc.tex/pdf 2011/01/25 uses `readprov.sty' + mdoccorr.cfg 2011/01/12 `<-', `->'; `...' re-implem. + niceverb.sty v0.42 2011/01/26 fixes, code to `texlinks.sty' + nicetext.tex/pdf 2011/01/26 enhanced, uses `readprov.sty' + +______________________________________________________________________ +nicetext RELEASE 0.41 2010/04/05 SUMMARY: documentation changes, corrected `niceverb.sty', added third-party example @@ -15,7 +36,7 @@ nicetext RELEASE v0.41 2010/04/05 SUMMARY: documentation changes, nicetext.tex/pdf 2010/04/05 corrected ______________________________________________________________________ -nicetext RELEASE v0.4 2010/03/30 SUMMARY: `% ' commenting style +nicetext RELEASE 0.4 2010/03/30 SUMMARY: `% ' commenting style supported, applied to packages by Donald Arseneau, extended formatting through specific @@ -61,7 +82,7 @@ nicetext RELEASE v0.4 2010/03/30 SUMMARY: `% ' commenting style substr.pdf 2010/03/30 first CTAN release ______________________________________________________________________ -nicetext RELEASE v0.3 2010/03/23 SUMMARY: `makedoc' simplified, +nicetext RELEASE 0.3 2010/03/23 SUMMARY: `makedoc' simplified, `niceverb' robustified, `fifinddo' re-implemented & slightly enhanced, diff --git a/Master/texmf-dist/doc/latex/nicetext/CHANGE.txt b/Master/texmf-dist/doc/latex/nicetext/doc/CHANGE.txt index b13f2a0df41..4bad6ce9db4 100644 --- a/Master/texmf-dist/doc/latex/nicetext/CHANGE.txt +++ b/Master/texmf-dist/doc/latex/nicetext/doc/CHANGE.txt @@ -1,5 +1,26 @@ ______________________________________________________________________ -nicetext RELEASE v0.41 2010/04/05 SUMMARY: documentation changes, +nicetext RELEASE 0.42 2011/01/26 SUMMARY: corrected `makedoc.sty', + enhanced `fifinddo.sty' and + .txt->.tex, use `hypertoc.sty' + and `texlinks.sty', minor fixes, + documentation enhancements + + README(.txt) 2011/01/26 updated + README.pdf 2011/01/26 new, README version + README.tex 2010/11/27 new, generates README.pdf + CHANGE.LOG/txt 2011/01/26 updated + FileList.txt/gather.tex2011/01/26 new for source file versions + fifinddo.sty v0.42 2011/01/25 code and documentation enhanced + fifinddo.tex/pdf 2010/11/27 uses `readprov.sty', +TODO + makedoc.cfg 2011/01/24 uses `hypertoc' and `readprov' + makedoc.sty v0.41 2011/01/25 corrected! + makedoc.tex/pdf 2011/01/25 uses `readprov.sty' + mdoccorr.cfg 2011/01/12 `<-', `->'; `...' re-implem. + niceverb.sty v0.42 2011/01/26 fixes, code to `texlinks.sty' + nicetext.tex/pdf 2011/01/26 enhanced, uses `readprov.sty' + +______________________________________________________________________ +nicetext RELEASE 0.41 2010/04/05 SUMMARY: documentation changes, corrected `niceverb.sty', added third-party example @@ -15,7 +36,7 @@ nicetext RELEASE v0.41 2010/04/05 SUMMARY: documentation changes, nicetext.tex/pdf 2010/04/05 corrected ______________________________________________________________________ -nicetext RELEASE v0.4 2010/03/30 SUMMARY: `% ' commenting style +nicetext RELEASE 0.4 2010/03/30 SUMMARY: `% ' commenting style supported, applied to packages by Donald Arseneau, extended formatting through specific @@ -61,7 +82,7 @@ nicetext RELEASE v0.4 2010/03/30 SUMMARY: `% ' commenting style substr.pdf 2010/03/30 first CTAN release ______________________________________________________________________ -nicetext RELEASE v0.3 2010/03/23 SUMMARY: `makedoc' simplified, +nicetext RELEASE 0.3 2010/03/23 SUMMARY: `makedoc' simplified, `niceverb' robustified, `fifinddo' re-implemented & slightly enhanced, diff --git a/Master/texmf-dist/doc/latex/nicetext/doc/NNOUNCE.txt b/Master/texmf-dist/doc/latex/nicetext/doc/NNOUNCE.txt new file mode 100644 index 00000000000..a39e9134bac --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/doc/NNOUNCE.txt @@ -0,0 +1,26 @@ +Minimal markup for simple text (Wikipedia style) and documentation +================================================================== +New with release 0.42: + + `makedoc.sty' \small starting \mdPackageCode spoiled all + documentations 2009/2010! (fixed); + \ResetCodeLineNumbers fixed + +`mdoccorr.cfg' `<-' and `->' typeset arrows, `...' re-implemented + +`fifinddo.sty' new macros \IfFDpreviousInputEmpty ("compression" + of empty lines), \BasicNormalCatcodes, \CopyFile* + (compress), \CopyLine, \StartPrependingChain + (per-line jobs), documentation modified + +`niceverb.sty' fixed `\ ' in auto mode; + \ctanpkgref moves to `texlinks.sty'; + additions in introduction + + `makedoc.cfg' loads `hypertoc.sty' and `texlinks.sty' + +-- dedicated to my sister for her birthday! + + + + diff --git a/Master/texmf-dist/doc/latex/nicetext/RELEAS03.txt b/Master/texmf-dist/doc/latex/nicetext/doc/RELEAS03.txt index 2c1905a37e2..2c1905a37e2 100644 --- a/Master/texmf-dist/doc/latex/nicetext/RELEAS03.txt +++ b/Master/texmf-dist/doc/latex/nicetext/doc/RELEAS03.txt diff --git a/Master/texmf-dist/doc/latex/nicetext/NNOUNCE.txt b/Master/texmf-dist/doc/latex/nicetext/doc/RELEAS04.txt index acc9f8f74f5..acc9f8f74f5 100644 --- a/Master/texmf-dist/doc/latex/nicetext/NNOUNCE.txt +++ b/Master/texmf-dist/doc/latex/nicetext/doc/RELEAS04.txt diff --git a/Master/texmf-dist/doc/latex/nicetext/doc/fifinddo.pdf b/Master/texmf-dist/doc/latex/nicetext/doc/fifinddo.pdf Binary files differnew file mode 100644 index 00000000000..7551e473cd7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/doc/fifinddo.pdf diff --git a/Master/texmf-dist/doc/latex/nicetext/makedoc.pdf b/Master/texmf-dist/doc/latex/nicetext/doc/makedoc.pdf Binary files differindex eab15048fec..d2e6a4a2be9 100644 --- a/Master/texmf-dist/doc/latex/nicetext/makedoc.pdf +++ b/Master/texmf-dist/doc/latex/nicetext/doc/makedoc.pdf diff --git a/Master/texmf-dist/doc/latex/nicetext/mdoccheat.pdf b/Master/texmf-dist/doc/latex/nicetext/doc/mdoccheat.pdf Binary files differindex 1ead8986302..1ead8986302 100644 --- a/Master/texmf-dist/doc/latex/nicetext/mdoccheat.pdf +++ b/Master/texmf-dist/doc/latex/nicetext/doc/mdoccheat.pdf diff --git a/Master/texmf-dist/doc/latex/nicetext/niceverb.pdf b/Master/texmf-dist/doc/latex/nicetext/doc/niceverb.pdf Binary files differindex fd2e0bd90c8..a1fa66d2e67 100644 --- a/Master/texmf-dist/doc/latex/nicetext/niceverb.pdf +++ b/Master/texmf-dist/doc/latex/nicetext/doc/niceverb.pdf diff --git a/Master/texmf-dist/doc/latex/nicetext/wikicheat.pdf b/Master/texmf-dist/doc/latex/nicetext/doc/wikicheat.pdf Binary files differindex 481c7e314d4..481c7e314d4 100644 --- a/Master/texmf-dist/doc/latex/nicetext/wikicheat.pdf +++ b/Master/texmf-dist/doc/latex/nicetext/doc/wikicheat.pdf diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/README.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/README.tex new file mode 100644 index 00000000000..ce26748edb5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/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/nicetext/docsrc/fifinddo.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/fifinddo.tex index 91234d2b73c..f517ad3a3e7 100644 --- a/Master/texmf-dist/doc/latex/nicetext/docsrc/fifinddo.tex +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/fifinddo.tex @@ -1,12 +1,21 @@ -\ProvidesFile{fifinddo.tex}[2010/03/23 documentation for `fifinddo'] -\title{\textsf{fifinddo}\\---\\Filtering \TeX(t) Files by \TeX} -\author{Uwe L\"uck\,---\,{\tt http://contact-ednotes.sty.de.vu}} +\ProvidesFile{fifinddo.tex}[2010/11/27 documenting fifinddo.sty] +\title{\textsf{fifinddo}\\---\\Filtering \TeX(t) Files by + \TeX\thanks{This file describes +% \protect\GetFileInfo{\jobname.sty}% + version \fileversion\ of \textsf{\filename} as of \filedate.}} + %% ^ 2010/11/26 % \listfiles \documentclass{article} \usepackage{makedoc} % \usepackage{substr} %% for failure examples TODO 2010/03/17 \input{makedoc.cfg} +%% <- TODO -> makedoc.cfg +\usepackage{readprov} +\ReadPackageInfos{fifinddo} +% \ReadFileInfos{fifinddo.sty} +% \hypersetup{pdfstartview=FitH} %% fine! 2010/11/11 \begin{document} +% \GetFileInfo{fifinddo.sty} %% 2010/11/25/26 \maketitle \begin{flushright}\small\it FIDO, FIND!\\or:\\FIND FIDO!\\oder:\\FIFI, @@ -25,7 +34,7 @@ marks from package files and inserts listing commands. Parsing macros are not defined anew at every input chunk, but once before a file is processed. This also allows for \emph{expandable} sequences of replacements, -e.g., with `txt'$\to$\TeX\ functionality. +e.g., with `txt'\,$\to$\,\TeX\ functionality. The method of testing for substrings is carefully discussed, revealing an earlier mistake (then) shared with 'substr.sty' and \LaTeX's internal `\in@'. @@ -282,16 +291,16 @@ This way some things are easier than with usual \TeX\ applications: load packages needed for typesetting. One may even try to keep the macros and settings for preprocessing local to a group. \end{enumerate} -% -Once there may be an option to read input with some usual \TeX\ -category codes as well, it may be useful to (some of) -\begin{itemize} -\item avoid matching substrings of control words, -\item skip blank spaces as \TeX\ does it usually, -\item catch \emph{balanced} input pieces, -\item ignore comments, -\item ignore certain characters. -\end{itemize} +%% done, moving to .sty 2010/04/06: +% Once there may be an option to read input with some usual \TeX\ +% category codes as well, it may be useful to (some of) +% \begin{itemize} +% \item avoid matching substrings of control words, +% \item skip blank spaces as \TeX\ does it usually, +% \item catch \emph{balanced} input pieces, +% \item ignore comments, +% \item ignore certain characters. +% \end{itemize} The essential approach of 'fifinddo' to looking for single strings is described in some detail in section~\ref{sec:theory}. @@ -309,17 +318,25 @@ together with their syntax description. \MakeInputJobDoc{23}{\SectionLevelTwoParseInput} \end{document} -TODO cf. Kastrup 'makematch' and others 2009/04/09 +TODO cf. Kastrup 'makematch' and others 2009/04/09, + 'parselines' 2010/11/13 -2009/04/10: title break, by -> with(!?); `boxed/coloured' -2009/04/12: useful: own shorthands -2009/04/13: substr.sty, \emph{expandable}, w/o `implement'!? -2009/04/15: same with \in@ -2010/03/08: EPS application removed -2010/03/17: use \MakeInputJobDoc -2010/03/18: `Missing' -> `Comparisons' etc.; \Require... -2010/03/19: Catalogue \url; '' -> " -2010/03/20: \ctanpkgref -2010/03/22: debugging; done ... -2010/03/23: more URLs; abstract "then shared"; +2009/04/10 title break, by -> with(!?); `boxed/coloured' +2009/04/12 useful: own shorthands +2009/04/13 substr.sty, \emph{expandable}, w/o `implement'!? +2009/04/15 same with \in@ +2010/03/08 EPS application removed +2010/03/17 use \MakeInputJobDoc +2010/03/18 `Missing' -> `Comparisons' etc.; \Require... +2010/03/19 Catalogue \url; '' -> " +2010/03/20 \ctanpkgref +2010/03/22 debugging; done ... +2010/03/23 more URLs; abstract "then shared"; removed dates from 2009, fdtxttex.tex/tpl +2010/04/06 possible uses of reading TeX category codes moved to .sty +2010/11/11 \thanks <- package version +2010/11/12 package date updated, \author -> makedoc.cfg +2010/11/13 package date updated; parselines +2010/11/24 debugging +2010/11/25f. using readprov.sty +2010/11/27 reworked \ProvidesFile diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/gather.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/gather.tex new file mode 100644 index 00000000000..5a14c651361 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/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} +\ReadPackageInfos{fifinddo,makedoc,niceverb,wiki} +\ReadFileInfos{fifinddo,makedoc,niceverb,makedoc.cfg,mdoccorr.cfg} %%% ,mdoccheat,wikicheat} +\ReadFileInfos{gather} +\ListInfos[FileList.txt] diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.cfg b/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.cfg deleted file mode 100644 index 418482a3a34..00000000000 --- a/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.cfg +++ /dev/null @@ -1,29 +0,0 @@ -\ProvidesFile{makedoc.cfg}[2010/03/20 - doc formatting settings] - -\RequirePackage{ifpdf} -\ifpdf -% \usepackage[bookmarksnumbered]{hyperref} -% \usepackage[bookmarks=false]{hyperref} -% \usepackage[bookmarks=false,pdfstartview=FitH]{hyperref} - %% <- 2010/03/12 -> - \usepackage[bookmarksnumbered,pdfstartview=FitH]{hyperref} -% \usepackage[pdfpagemode=UseNone]{hyperref} -\else - \usepackage[draft]{hyperref} - %% <- 2010/03/11 -> -% \let\url\texttt \def\href#1#2{#2} %% \@secondoftwo -\fi -\author{Uwe L\"uck\thanks{\url{http://contact-ednotes.sty.de.vu}}} -% \author{Uwe L\"uck---{\tt http://contact-ednotes.sty.de.vu}} - -\RequirePackage{niceverb}[2010/03/10] -%% <- TODO move!? (\DeclareRobust...) -> -\providecommand*{\ctanpkgref}[1] - {\href{http://ctan.org/pkg/#1}{\textsf{#1}}} - -\errorcontextlines=4 -\pagestyle{headings} - -\endinput - diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex index 28cdf0e4c85..b6c78135c42 100644 --- a/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex @@ -1,11 +1,10 @@ -\typeout{makedoc.tex 2010/03/30 documentation for `makedoc.sty'} -\listfiles +\ProvidesFile{makedoc.tex}[2011/01/25 documenting makedoc.sty] \RequirePackage{makedoc} \documentclass{article} -\input{makedoc.cfg} %% with pdf stuff and 'niceverb' -%% removed for niceverb v0.31 TODO!? 2010/03/20: -\sfcode`/=1001 %% TODO makedoc.cfg!? 2010/03/21 -% \makeatletter %% TEST for hyperref compatibility 2010/03/11 +\input{makedoc.cfg} +\usepackage{color} %% 2011/01/25 +\sfcode`/=1001 %% TODO makedoc.cfg!? 2010/03/21 niceverb!? 2011/01/25 +\makeatletter %% TEST for hyperref compatibility 2010/03/11 % \def\@testdef #1#2#3{% % \def\reserved@a{#3}% % \expandafter \ifx \csname #1@#2\endcsname @@ -20,8 +19,10 @@ % } % \makeatother \begin{document} -\title{'makedoc'---Preprocessing documentation by \TeX} - %% 2009/04/10: \\---\\\ breaks TOC +\title{'makedoc'---Preprocessing documentation by \TeX\thanks{% + This document describes %% 2011/01/25 + version~\textcolor{blue}{\UseVersionOf{makedoc.sty}} + of 'makedoc.sty' as of \UseDateOf{makedoc.sty}.}} \maketitle \begin{abstract}\noindent 'makedoc' provides commands for generating \LaTeX\ input from a @@ -641,3 +642,5 @@ end of a file it writes. %% todo TeXbook where? 2009/04/08 2010/03/29 \ResetCodeLineNumbers, examples and explanations for v0.4 2010/03/30 \listfiles test +2010/11/27 \ProvidesFile for myfilist +2011/01/25 \thanks with readprov.sty diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex index 08358f3fd71..f4b380b985f 100644 --- a/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex @@ -1,15 +1,16 @@ -\typeout{niceverb.tex 2010/04/05 documenting niceverb.sty} +\ProvidesFile{niceverb.tex}[2011/01/26 documenting niceverb.sty] \title{\textsf{niceverb.sty}\\---\\Minimizing - Markup\\for Documenting \LaTeX\ packages%%% \thanks{This -% manual describes package version -% version 0.2 as of April 09, 2009%%%\fileversion\ as of \filedate\ -% .}}%%%of the package.}% + Markup\\for Documenting \LaTeX\ packages\thanks{This + document describes version + \textcolor{blue}{\UseVersionOf{niceverb.sty}} + of \pkgnamefmt{niceverb.sty} as of \UseDateOf{niceverb.sty}.} } % \listfiles 2010/03/19 { \RequirePackage{makedoc} \ProcessLineMessage{} %% 2010/03/11 \MakeJobDoc{19}{\SectionLevelThreeParseInput} } \documentclass{article}%% TODO paper dimensions!? \input{makedoc.cfg} %% shared formatting settings +\usepackage{color} \begin{document} \maketitle \begin{abstract}\noindent @@ -63,9 +64,9 @@ documentations of nowadays commonly expected typographical quality for packages that so far only had plain text documentations. \subsection{Acknowledgement/Basic Ideas} -Three ideas of Stephan I. B\"ottcher's in documenting his -\ctanpkgref{lineno} -inspired the present work: +\emph{Four} %% 2011/01/26 +ideas of Stephan I. B\"ottcher's in documenting his +\ctanpkgref{lineno} inspired the present work: \begin{enumerate} \item The markup and its definitions are short and simple, @@ -84,6 +85,9 @@ An active character (\lq&|\rq) issues a `\string' \emph{and} switches to typewriter typeface for typesetting a command verbatim---so this works without changing category codes (which is the usual idea of typesetting code), therefore it works even in macro arguments. +\item %% 2011/01/26 +\lq\HardNVerb+<meta-variable>+\rq\ produces \lq<meta-variable>\rq. +(\qtd{&\lessthan} stores the original \qtd{&<}.) \end{enumerate} \subsection{The Commands and Features of 'niceverb'} @@ -175,6 +179,10 @@ command from \LaTeX. To get \emph{usual} single quotes, you can use their standard substitutes `\lq' and `\rq', or for pairs of them, |\qtd{<text>}| in place of `\lq <text>\rq'---or even `\lq <text>\rq\ '. +To get single quotes around some verbatim <verb>, +often `\qtd{&<verb>}' works. +It is for this reason that I have refrained from different +solutions as in \ctanpkgref{newverbs} (so far). \item[Single right quotes for &\textsf:] Package names are (by some convention I often yet not always @@ -242,7 +250,7 @@ command (and its syntax, allowing meta-variables) verbatim. However, there are some exceptions, which are collected in a macro |\niceverbNoVerbList|. &\begin, &\end, and &\item belong to this list, you can redefine (`\renewcommand') it, or add <macros> to it by -|\AddToMacro{\niceverbNoVerbList}{<macros>}| +|\AddToNoVerbList}{<macros>}| %% 2010/12/29 There is also a command |\NormalCommand{<letters>}| \emph{issuing} the command `\<letters>' instead of typesetting it. Since auto mode is somewhat dangerous, you have to start it explicitly @@ -396,6 +404,8 @@ These are the first applications of 'niceverb''s ``auto mode" to % personal style and should be modifiable, especially by package % options.\footnote{Please sponsor the project or support it % otherwise!} +\item ``auto mode" seems not to work in section titles. (2011/01/26) + %% <- noted with edtnotesc \item Certain difficulties with typesetting code in macro arguments may be overcome easily using $\varepsilon$\mbox{-}\TeX\ features, I need to find out $\dots$ @@ -436,3 +446,8 @@ HISTORY 2010/03/27 ``auto mode," 2010/03/29 \mbox -> \hbox in display; arseneau.tex/pdf 2010/04/05 Harder -> Harders +2010/11/27 \ProvidesFile for myfilist +2010/12/29 \AddToNoVerbList +2011/01/26 using color.sty and readprov.sty; + ack. Stephan B. for <...>; auto headings issue + diff --git a/Master/texmf-dist/doc/latex/nicetext/fifinddo.pdf b/Master/texmf-dist/doc/latex/nicetext/fifinddo.pdf Binary files differdeleted file mode 100644 index b7652e34cba..00000000000 --- a/Master/texmf-dist/doc/latex/nicetext/fifinddo.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/nicetext/run/arseneau.tex b/Master/texmf-dist/doc/latex/nicetext/run/arseneau.tex new file mode 100644 index 00000000000..10b86dc6254 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/run/arseneau.tex @@ -0,0 +1,153 @@ +\ProvidesFile{arseneau.tex} + [2010/04/05 some packages by D. Arseneau (ul)] +\title{A Few Packages by Donald Arseneau} +\author{Uwe L\"uck\thanks{applying \url{http://ctan.org/pkg/nicetext}}} +% \listfiles + +%% Preprocessing: +\RequirePackage{makedoc} +% \CopyFDconditionFromTo{PScomment}{comment} +\ProcessLineMessage{} +\MainDocParser{\ProcessInputWith{PScomment}} +%% nolbreaks: +%% Replacements: +\SetPatternCodes{\MakeOther\\\MakeOther\ } +\MakeExpandableAllReplacer{LaTeX}{LaTeX }{\LaTeX{} }{LEAVE} +% \MakeExpandableAllReplacer{TeX}{\TeX }{\TeX{} }{LEAVE} +\PrependExpandableAllReplacer{opt}{[ragged]}{`[ragged]'} +\PrependExpandableAllReplacer{braces}[\Delimiters<>]<{ }><`{ }'> +\SetCorrectHookJobLast + +\HeaderLines{2} +\LaTeXresultFile{nolbreaks.doc} +\MakeCloseDoc{nolbreaks.sty} + +%% notoccite: +\MakeExpandableAllReplacer{LaTeX}{LaTeX }{\LaTeX{} }{LEAVE} +\PrependExpandableAllReplacer{caption}% +{ \caption [}{\DISPLAY\caption[} +\PrependExpandableAllReplacer{unsrt}{unsrt}{`unsrt'} +\PrependExpandableAllReplacer{toc}{ toc}{ `.toc'} +\PrependExpandableAllReplacer{lof}{lof}{`.lof'} +\PrependExpandableAllReplacer{latex}{latex}{`latex'} +\PrependExpandableAllReplacer{NOTE}{*NOTE*}{\textbf{NOTE:\enspace}} +\PrependExpandableAllReplacer{does}{*does*}{\emph{does}} +\PrependExpandableAllReplacer{bibtex}{bibtex}{`bibtex'} +\ResetPatternCodes +\SetCorrectHookJobLast + +\HeaderLines{3} +\LaTeXresultFile{notoccite.doc} +\MakeCloseDoc{notoccite.sty} + +\ProcessLineMessage{\message{.}} +%% optional: +% \SetPatternCodes{\MakeOther\\\MakeOther\ } +\SetPatternCodes{\MakeOther\\} +\MakeExpandableAllReplacer{LaTeX:}{LaTeX:}{\LaTeX:}{LEAVE} +\PrependExpandableAllReplacer{LaTeX}[\MakeOther\ ]% +{LaTeX }{\LaTeX{} } +\PrependExpandableAllReplacer{pkg}{optional.sty}{'optional.sty'} +\PrependExpandableAllReplacer{IS}{*IS*}{\emph{is}} +\PrependExpandableAllReplacer{tildes}[\MakeOther\ ]% +{HOW TO USE}{\SECT{How to Use}} +% \SetPatternCodes{\MakeOther\~} +% \PrependExpandableAllReplacer{tildes}[\MakeOther\~]{U}{X} + %% <- TODO \MakeOther\~ hangs up +\SetCorrectHookJobLast + +\HeaderLines{14} +\LaTeXresultFile{optional.doc} +\MakeCloseDoc{optional.sty} + + +%% Typesetting: +\documentclass{article} +\usepackage{hyperref,niceverb,wiki} %% niceverb after hyperref! +\AddToNoVerbList{\DISPLAY\textbf\enspace\emph\LaTeX\SECT} +\newcommand*{\DISPLAY}{% + \\[\smallskipamount]\leavevmode\null\hfil} +\makeatletter + \newcommand*{\SECT}[1]{% + \par\medskip\textbf{#1}\par\smallskip\@afterheading} +\makeatother +\makeatletter \MakeLetter\_ +% {\MakeActive\"\gdef\DQcode#1"{\dqtd{\texttt{#1}}}} +% {\MakeActive\"\gdef\DQcode#1"{\texttt{#1}}} +{\MakeActive\" + \gdef\DQtt{\begingroup + \let\do\MakeOther \dospecials \tt \let"\endgroup} + \gdef\fineDQ{``\begingroup + \let\do\MakeOther \dospecials \tt \def"{\endgroup''}}} +%% weird problems: +% \newcommand*{\startDQcode} +% {``\begingroup\MakeActiveLetHere\"\enddQcode\tt} +% \def\endDQcode{\endgroup"} +\pagestyle{headings} +\usepackage{parskip} +\begin{document} +\maketitle + +\begin{abstract}\noindent + This document demonstrates the present + (i.e., 'nicetext' bundle release v0.4) + capabilities of 'makedoc' and 'niceverb' + to typeset \LaTeX\ quality documentation from + third-party package files having ASCII comments only, + without modifying such package files manually.\footnote{See + \url{http://ctan.org/pkg/nicetext} + for more on these packages.} + Such packages usually mark comments by lines starting with + \lq`% '\rq. This is somewhat difficult when the ``comment mark" + \lq`%'\rq\ + may at the same time be used for ``commenting out" in place of + ``true commenting." As opposed to 'substr.sty' that conforms to the + easier \lq`%% '\rq\ style, the packages 'nolbreaks' and 'notoccite' + by Donald Arseneau exemplify the \lq`% '\rq\ commenting style. + + The ASCII documentation of packages of this kind + does not always clearly indicate when switching to `\tt' is appropriate. + This problem is solved here by string replacements very specific + to the package files. + The setup for these replacements + (in the source file 'arseneau.tex') + still may be simplified. + %% <- 2010/03/29 + + Moreover, some similar packages cannot be properly typeset with + 'nicetext' at present because 'makedoc''s loop is too rigid to deal with + (i)~ASCII indents, displays, lists and with (ii)~instructions + after `\endinput'. (On 2010/04/05, we try addressing (i) with + 'wiki.sty', applied to Donald Arseneau's 'optional'. + A 'nicetext' bug with replacing tildes shows up.) + + It should be clear that all the package desriptions are Donald Arseneau's, + 'nicetext' just formats them. +\end{abstract} +\tableofcontents +\pagebreak + +\sloppy +\MakeNormal\| + +\section{'nolbreaks'} +% \MakeActiveLet\_\textunderscore +% \MakeActive\*\def*{\texttt{\string*}} +% \MakeActiveLetHere\"\startDQcode +\MakeActiveLetHere\"\DQtt +% \errorcontextlines=6 +\AutoCmdInput{nolbreaks.doc} + +\section{'notoccite'} +\ResetCodeLineNumbers +\AutoCmdInput{notoccite.doc} + +\section{'optional'} %% 2010/04/02 +\ResetCodeLineNumbers +\wikiEnvironments +\MakeActiveLet\"\DQtt +% \AddToNoVerbList{\tracingmacros} +\let~\relax %% TODO replacement bug 2010/04/05 +\AutoCmdInput{optional.doc} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/nicetext/run/fdtxttex.tex b/Master/texmf-dist/doc/latex/nicetext/run/fdtxttex.tex new file mode 100644 index 00000000000..a7ea6de14d4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/run/fdtxttex.tex @@ -0,0 +1,58 @@ + \makeatletter +\typeout{^^J*fdtxttex.tex* 2010/03/30 txt to TeX by dialogue^^J + (apply \string\MakeDocCorrectHook) + ^^J} + +\RequirePackage{fifinddo} + +\catcode`\_=11 +\def\CorrectionFile{\def\mdoc_corr} +\CorrectionFile{mdoccorr.cfg} +\ResultFile{sample.tex} +\def\InputFile{\def\input_file_name} +\InputFile{sample.txt} +\newif\iftoscreen + +\def\FD_dialogue{% + \typeout{^^J% + ===========================================================^^J% + \string\CorrectionFile{\mdoc_corr} + \space (define \@backslashchar MakeDocCorrectHook)^^J% + \string\InputFile {\input_file_name}^^J% + \string\ResultFile{\result_file_name} + \space\space\space\space\space\space\space + \string\toscreen\iftoscreen true\else false\fi ^^J% + ===========================================================% + }% + \typein[\action]% + {Run with these settings? (Y)es? (C)hange? (Otherwise quit.)}% + \csname action_\action \endcsname +} +\def\run_with_settings{% + \input{\mdoc_corr}% + \WriteProvides + \ProcessFileWith{\input_file_name}{% + \WriteResult{\expandafter \MakeDocCorrectHook + \expandafter{\fdInputLine}}% + \iftoscreen + \typeout{\expandafter \MakeDocCorrectHook + \expandafter{\fdInputLine}}% + \else + \message{.}% + \fi} + \CloseResultFile + \typeout{Done.}% + \FD_dialogue +} +\expandafter\let\csname action_y\endcsname \run_with_settings +\expandafter\let\csname action_Y\endcsname \run_with_settings + +\def\change_settings{% + \typein[\change]{^^JType setting command(s).}% + \change \FD_dialogue} +\expandafter\let\csname action_c\endcsname \change_settings +\expandafter\let\csname action_C\endcsname \change_settings + +\FD_dialogue + +\stop diff --git a/Master/texmf-dist/doc/latex/nicetext/run/fdtxttex.tpl b/Master/texmf-dist/doc/latex/nicetext/run/fdtxttex.tpl new file mode 100644 index 00000000000..9b97a0a9f7c --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/run/fdtxttex.tpl @@ -0,0 +1,13 @@ +\typeout{fdtxttex.tpl 2010/03/30 fifinddo correction template} +\RequirePackage{fifinddo} +\input{mdoccorr.cfg} +\ResultFile{sample.tex} +\WriteProvides +\ProcessFileWith{sample.txt}{% + \typeout{\expandafter \MakeDocCorrectHook + \expandafter{\fdInputLine}}% + \WriteResult{\expandafter \MakeDocCorrectHook + \expandafter{\fdInputLine}}% +} +\CloseResultFile +\stop diff --git a/Master/texmf-dist/doc/latex/nicetext/run/makedoc.tpl b/Master/texmf-dist/doc/latex/nicetext/run/makedoc.tpl new file mode 100644 index 00000000000..e508d8cded5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/run/makedoc.tpl @@ -0,0 +1,17 @@ +\typeout{makedoc.tpl 2010/03/23 makedoc correction template} +\RequirePackage{makedoc} +\renewcommand*{\mdJobName}{SAMPLE} +\input{mdoccorr.cfg} +\LaTeXresultFile{\mdJobName.doc} +\HeaderLines{0} +\ProcessLineMessage{} +\MainDocParser{% +% \typeout{\ProcessInputWith{dots}}% +% \WriteResult{\ProcessInputWith{dots}}% + \typeout{\expandafter \MakeDocCorrectHook + \expandafter{\fdInputLine}}% + \WriteResult{\expandafter \MakeDocCorrectHook + \expandafter{\fdInputLine}}% +} +\MakeCloseDoc{\mdJobName.TEX} +\stop
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/nicetext/run/sample.txt b/Master/texmf-dist/doc/latex/nicetext/run/sample.txt new file mode 100644 index 00000000000..69408f90fd8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/run/sample.txt @@ -0,0 +1,3 @@ +blabla ... blabla +blabla cf. bla +etc. bla bla
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/nicetext/run/substr.tex b/Master/texmf-dist/doc/latex/nicetext/run/substr.tex new file mode 100644 index 00000000000..f876d173289 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/run/substr.tex @@ -0,0 +1,92 @@ +\typeout{substr.tex 2010/03/30 documentation for substr.sty} +\title{\textsf{substr.sty}\thanks{See + \url{http://ctan.org/pkg/substr} for more about + \textsf{substr.sty}.}---Substring + Functions with \LaTeX} +\author{Harald Harders\thanks{Joint work with Heiko Oberdiek, + one line + documentation tool + by Uwe L\"uck.}} +% \listfiles + +%% Preprocessing 'substr.sty': +\RequirePackage{makedoc} + +%% Replacements: +\SetPatternCodes{\MakeOther\\} +\MakeExpandableAllReplacer{Cmds} + {Commands:}{\SECT{Commands:}}{LEAVE} +\PrependExpandableAllReplacer{Change}{ChangeLog}{\SECT{ChangeLog}} +\PrependExpandableAllReplacer{CR}{Copyright}{\COPYRIGHT} +\PrependExpandableAllReplacer{LaTeX} + [\MakeOther\ ]{LaTeX }{\LaTeX{} } +\PrependExpandableAllReplacer{HH@} + {h.harders@tu-bs.de} + {`h.harders@tu-bs.de'\MEDSK} +\PrependExpandableAllReplacer{COMP} + {de.comp.text.tex} + {`de.comp.text.tex'} +\PrependExpandableAllReplacer{LPPL} + {macros/latex/base/lppl.txt} + {`macros/latex/base/lppl.txt'} +\PrependExpandableAllReplacer{Hist}[\MakeOther\ ]% +{History of this package:}{\SECT{History of this package:}} +\ResetPatternCodes +\SetCorrectHookJobLast + +\HeaderLines{3} +\MainDocParser{\ProcessInputWith{comment}} +\LaTeXresultFile{substr.doc} +\MakeCloseDoc{substr.sty} + +\documentclass{article} + +\usepackage{hyperref,makedoc,niceverb} %% niceverb after hyperref! +\AddToNoVerbList{\MEDSK\SECT\textbf\COPYRIGHT,\LaTeX} +\newcommand*{\MEDSK}{\par\medskip} +\newcommand*{\SECT}[1]{\MEDSK\textbf{#1}\nopagebreak\par} +\newcommand*{\COPYRIGHT}{\MEDSK\textbf{Copyright} } +\usepackage[utf8]{inputenc} %% for v1.2 + +\pagestyle{myheadings} +\markboth{\textsf{substr.sty}}{\textsf{substr.sty}} +\usepackage{parskip} + +\begin{document} +\maketitle + +\begin{abstract}\noindent + This documentation of 'substr.sty' has been typeset + by automatical ASCII\slash UTF\hbox{-}8~$\to$ \LaTeX\ + enhancement provided by 'makedoc.sty' and 'niceverb.sty''s + ``auto mode."\footnote{See + \url{http://ctan.org/pkg/nicetext} + for more on these packages.} + Some extended formatting---kind of sectioning, + switches to `\tt'---have been achieved by string replacements + specific to the comment text of the package file + (see source file 'substr.tex'). + + 'substr.sty' especially demonstrates the rather rare + \lq`%% '\rq\ style of package comments that is somewhat + favoured by 'makedoc' because this way ``true comments" + are easily distinguishable from mere ``commenting out." +% +% The idea to use 'parskip.sty' for formatting the documentation +% (as opposed to the version of the present file of one week ago) +% is due to the quite recent +% 'import.tex'\footnote{\url{http://ctan.org/pkg/import}} +% that +%% ??? +\end{abstract} +\sloppy +% \MakeJobDoc{3}{\ProcessInputWith{comment}} +\AutoCmdInput{substr.doc} +\end{document} + +%% HISTORY +2010/03/18 sent to CTAN +2010/03/27 removed `\usepackage{substr}' +2010/03/28 extended formatting by replacing words +2010/03/29 \SetPatternCodes etc. +2010/03/30 import -> substr; see source file + |