diff options
author | Karl Berry <karl@freefriends.org> | 2011-08-26 22:17:31 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-08-26 22:17:31 +0000 |
commit | 80219992c1ed63efeca5390194411fcdcedb17bb (patch) | |
tree | 71fa8ca43e70073fc77a5ff97454bf43549dee9a /Master/texmf-dist/tex/latex/nicetext/run | |
parent | 87f1685a45c8f23851013817d1ead13ff8c20677 (diff) |
nicetex 0.43 (24aug11)
git-svn-id: svn://tug.org/texlive/trunk@23703 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/tex/latex/nicetext/run')
15 files changed, 469 insertions, 0 deletions
diff --git a/Master/texmf-dist/tex/latex/nicetext/run/README-run.txt b/Master/texmf-dist/tex/latex/nicetext/run/README-run.txt new file mode 100644 index 00000000000..e4229bfc571 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/README-run.txt @@ -0,0 +1,9 @@ +The .tex files can be run with latex ("script files"). +arseneau.tex and substr.tex demonstrate the "auto" feature +of makedoc.sty, see makedoc.pdf. +copyfile.tex and fdtxttex.tex are dialogues. +Replace copyfile.cfg by atari.cfg to get a conversion sample. +The .tpl files are templates for script files. +See FILEs.txt and fifinddo.pdf for additional informations. + +UL 2011-08-23 diff --git a/Master/texmf-dist/tex/latex/nicetext/run/arseneau.tex b/Master/texmf-dist/tex/latex/nicetext/run/arseneau.tex new file mode 100644 index 00000000000..10b86dc6254 --- /dev/null +++ b/Master/texmf-dist/tex/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/tex/latex/nicetext/run/atari.cfg b/Master/texmf-dist/tex/latex/nicetext/run/atari.cfg new file mode 100644 index 00000000000..fa7179f5788 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/atari.cfg @@ -0,0 +1,7 @@ +\ProvidesFile{atari.cfg}[2011/08/23 sample for copyfile.tex] +\catcode`\_=11 +\InputFile{atari.txt} +\TextCodesFile{atari.fdf} +\ResultFile{iso.txt} +% \toscreentrue +\endinput diff --git a/Master/texmf-dist/tex/latex/nicetext/run/atari.fdf b/Master/texmf-dist/tex/latex/nicetext/run/atari.fdf new file mode 100644 index 00000000000..6037cab688f --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/atari.fdf @@ -0,0 +1,9 @@ +\ProvidesFile{atari.fdf}[2010/08/23 Atari to ISO-8859-1 with blog.sty] +%% was \AtariCodes from 2010/08/24 till 2011/08/22: +\def\TextCodes{% + \MakeActiveDefŽ{Ä}\MakeActiveDef™{Ö}\MakeActiveDefš{Ü}% + \MakeActiveDef„{ä}\MakeActiveDef”{ö}\MakeActiveDef{ü}% + \MakeActiveDefž{ß}% +} +\endinput + diff --git a/Master/texmf-dist/tex/latex/nicetext/run/atari.txt b/Master/texmf-dist/tex/latex/nicetext/run/atari.txt new file mode 100644 index 00000000000..8a5ffe937ca --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/atari.txt @@ -0,0 +1,2 @@ +„”ž +Ž™š diff --git a/Master/texmf-dist/tex/latex/nicetext/run/copyfile.cfg b/Master/texmf-dist/tex/latex/nicetext/run/copyfile.cfg new file mode 100644 index 00000000000..d4f1f469435 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/copyfile.cfg @@ -0,0 +1,7 @@ +\ProvidesFile{copyfile.cfg}[2011/08/22 initializing copyfile.tex] +\catcode`\_=11 +\InputFile{lines.txt} +\TextCodesFile{} +\ResultFile{lns.txt} +% \toscreentrue +\endinput diff --git a/Master/texmf-dist/tex/latex/nicetext/run/copyfile.tex b/Master/texmf-dist/tex/latex/nicetext/run/copyfile.tex new file mode 100644 index 00000000000..3c8ae98da3e --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/copyfile.tex @@ -0,0 +1,28 @@ +\ProvidesFile{copyfile.tex}[{2011/08/22 copy*ing/converting (UL)}] +\RequirePackage{fddial0g} +\newcommand*{\TextCodesFile}{\def\text_codes_file_name} +\TextCodesFile{} \let\TextCodes\relax +\input{copyfile.cfg} + +\Announce{ * copyfile.tex * compressing blank lines/converting + ^^J} + {copyfile.cfg} +\newcommand*{\Dialogue}{% + \FD_dialogue_screen{% + \string\InputFile {\input_file_name}^^J% + \string\TextCodesFile{\text_codes_file_name}^^J% + \string\ResultFile{\result_file_dialogue}% + }% +} +\newcommand*{\RunWithSettings}{% + \run_with_settings_gen{% + \ifx\text_codes_file_name\empty\else + \input{\text_codes_file_name}% + \fi + \CopyFile*[\TextCodes]{\input_file_name}% + }% +} +\Dialogue + +\stop + diff --git a/Master/texmf-dist/tex/latex/nicetext/run/fddial0g.sty b/Master/texmf-dist/tex/latex/nicetext/run/fddial0g.sty new file mode 100644 index 00000000000..6c9b255c6e6 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/fddial0g.sty @@ -0,0 +1,74 @@ +\ProvidesPackage{fddial0g}[2011/08/23 dialogues with fifinddo (UL)] +%% copyright (C) 2011 Uwe L\"uck, +%% +%% http://www.contact-ednotes.sty.de.vu +%% +%% -- author-maintained in the sense of LPPL below -- +%% This file can be redistributed and/or modified under +%% the terms of the LaTeX Project Public License; either +%% version 1.3c of the License, or any later version. +%% The latest version of this license is in +%% +%% http://www.latex-project.org/lppl.txt +%% +%% We did our best to help you, but there is NO WARRANTY. +%% Please report bugs, problems, and suggestions via +%% +%% http://www.contact-ednotes.sty.de.vu +%% +%% T0D0: more abstract setting and using of variables +%% so the user must not invent names and see underscores. +%% (Probably use namemod.) +%% +\RequirePackage{fifinddo} + +\catcode`\_=11 + +%% |\ResultFile| gets a different meaning here +%% in order to keep the dialogue nice. +%% `\result_file_name' must be reserved for the original +%% meaning of `\ResultFile'. +\let\UseResultFile\ResultFile +\def\ResultFile{\def\result_file_dialogue} +\newcommand\InputFile{\def\input_file_name} +\newif\iftoscreen + +\def\Announce#1#2{% + \typeout{% + \FD_dialogue_double_line + ^^J#1^^J% + The screen shows most recent settings commands.^^J% + You can modify initial settings in #2.^^J% + }% +} +\def\FD_dialogue_screen#1{% + \typeout{% + \FD_dialogue_double_line^^J% + #1% + \FD_dialogue_double_line + }% + \typein[\action]% + {Run with these settings? (Y)es? (C)hange? (Otherwise quit.)}% + \csname action_\action \endcsname +} +\def\FD_dialogue_double_line{% + ^^J% + ===========================================================} +\def\run_with_settings_gen#1{% + \UseResultFile{\result_file_dialogue}% + #1% + \CloseResultFile + \typeout{Done.}% + \Dialogue +} +\def\FD_corrected_input_line{% + \expandafter \MakeDocCorrectHook \expandafter{\fdInputLine}} +\@namedef{action_y}{\RunWithSettings} +\@namedef{action_Y}{\RunWithSettings} +\def\change_settings{% + \typein[\change]{^^JType setting command(s).}% + \change \Dialogue} +\expandafter\let\csname action_c\endcsname \change_settings +\expandafter\let\csname action_C\endcsname \change_settings + +\endinput diff --git a/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.cfg b/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.cfg new file mode 100644 index 00000000000..50c52d6eaab --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.cfg @@ -0,0 +1,8 @@ +\ProvidesFile{fdtxttex.cfg}[2010/11/25 initializing fdtxttex.tex] +\catcode`\_=11 +\CorrectionFile{mdoccorr.cfg} +%% Note different meaning for 'fdtxttex.tex': +\ResultFile{sample.tex} +\InputFile{sample.txt} +% \toscreentrue +\endinput diff --git a/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.tex b/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.tex new file mode 100644 index 00000000000..81353508933 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.tex @@ -0,0 +1,39 @@ +\ProvidesFile{fdtxttex.tex}[2011/08/23 txt to TeX by dialogue (UL)] +\RequirePackage{fddial0g} +%% Dialogue settings: +\newcommand\CorrectionFile{\def\mdoc_corr} +%% Default settings (modify for your own): +\input{fdtxttex.cfg} +%% Screen: +\Announce{ *fdtxttex.tex* txt to TeX by dialogue^^J + (apply \string\MakeDocCorrectHook)^^J} + {fdtxttex.cfg} +\newcommand*{\Dialogue}{% + \FD_dialogue_screen{% + \string\CorrectionFile{\mdoc_corr} + \space (define \BackslashChar MakeDocCorrectHook)^^J% + \string\InputFile \space\space\space\space\space + {\input_file_name}^^J% + \string\ResultFile\space\space\space\space + {\result_file_dialogue} + \space\space\space + \string\toscreen\iftoscreen true\else false\fi + }% +}% +\newcommand*{\RunWithSettings}{% + \run_with_settings_gen{% + \input{\mdoc_corr}% + \WriteProvides + \ProcessFileWith{\input_file_name}{% + \WriteResult{\FD_corrected_input_line}% + \iftoscreen + \typeout{\FD_corrected_input_line}% + \else + \message{.}% + \fi}% + }% +} + \errorcontextlines=4 +\Dialogue + +\stop diff --git a/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.tpl b/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.tpl new file mode 100644 index 00000000000..30f3978847f --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/fdtxttex.tpl @@ -0,0 +1,14 @@ +\ProvidesFile{fdtxttex.tpl}[{2011/08/21 [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/tex/latex/nicetext/run/lines.txt b/Master/texmf-dist/tex/latex/nicetext/run/lines.txt new file mode 100644 index 00000000000..66681434654 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/lines.txt @@ -0,0 +1,4 @@ +abba + + +abba
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/nicetext/run/makedoc.tpl b/Master/texmf-dist/tex/latex/nicetext/run/makedoc.tpl new file mode 100644 index 00000000000..cd38f303933 --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/makedoc.tpl @@ -0,0 +1,19 @@ +\ProvidesFile{makedoc.tpl}[{2011/08/23 + makedoc preprocessing template}] +\typeout{makedoc.tpl 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 diff --git a/Master/texmf-dist/tex/latex/nicetext/run/sample.txt b/Master/texmf-dist/tex/latex/nicetext/run/sample.txt new file mode 100644 index 00000000000..69408f90fd8 --- /dev/null +++ b/Master/texmf-dist/tex/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/tex/latex/nicetext/run/substr.tex b/Master/texmf-dist/tex/latex/nicetext/run/substr.tex new file mode 100644 index 00000000000..1974b2e15bf --- /dev/null +++ b/Master/texmf-dist/tex/latex/nicetext/run/substr.tex @@ -0,0 +1,93 @@ +\ProvidesFile{substr.tex}[{2011/08/20 [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 +2011/08/20 \ProvidesFile for fileinfo + |