From fea99e4d6d4fbbd9fc68e58db96227c13a8be2e9 Mon Sep 17 00:00:00 2001 From: Manuel Pégourié-Gonnard Date: Fri, 30 May 2008 22:11:26 +0000 Subject: docmpf v1.2b 2004/05/14 with new pdf entering tlpkg-ctan-check git-svn-id: svn://tug.org/texlive/trunk@8421 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/docmfp/README | 55 +++++++++-- Master/texmf-dist/doc/latex/docmfp/docmfp.pdf | Bin 0 -> 182001 bytes Master/texmf-dist/source/latex/docmfp/docmfp.dtx | 119 ++++++++++++++++++----- Master/texmf-dist/source/latex/docmfp/docmfp.ins | 51 ++++++---- Master/texmf-dist/tex/latex/docmfp/docmfp.sty | 36 +++++-- 5 files changed, 203 insertions(+), 58 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/docmfp/docmfp.pdf (limited to 'Master/texmf-dist') diff --git a/Master/texmf-dist/doc/latex/docmfp/README b/Master/texmf-dist/doc/latex/docmfp/README index fcb0a8ea2d4..b0e4e8ae40f 100644 --- a/Master/texmf-dist/doc/latex/docmfp/README +++ b/Master/texmf-dist/doc/latex/docmfp/README @@ -1,27 +1,62 @@ The docmfp package extends the doc package to cater for documenting non-LaTeX code, such as Metafont and Metapost, or even C code. - The distribution consists of the following files: -README (this file) -docmfp.ins -docmfp.dtx - - The distribution is provided under the terms of the LaTeX -Project Public License (LPPL). +Changes in version 1.2a/b +---------------------- +o Changed license from LPPL v1.0 to v1.3 +o Fixed minor typos Changes in version 1.1 ---------------------- o Added a general \Describe macro o Added a general Code environment +----------------------------------------------------------------- + Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net + Copyright 1999 --- 2005 Peter R. Wilson + + This work may be distributed and/or modified under the + conditions of the LaTeX Project Public License, either + version 1.3 of this license or (at your option) any + later version. + The latest version of the license is in + http://www.latex-project.org/lppl.txt + and version 1.3 or later is part of all distributions of + LaTeX version 2003/06/01 or later. + + This work has the LPPL maintenance status "author-maintained". + + This work consists of the files: +README (this file) +docmfp.dtx +docmfp.ins +docmfp.pdf (user manual) + and the derived files: +docmfp.sty + + The distribution consists of the following files: +README (this file) +docmfp.ins +docmfp.dtx +docmfp.pdf + +----------------------------------------------------------------- + To install the package: o run: latex docmfp.ins (which will generate docmfp.sty) +o Move docmfp.sty to a location where LaTeX will find it + (typically in a local texmf tree at tex/latex/docmfp) and refresh the + file database. See the FAQ on CTAN at help/uk-tex-faq or + http://www.tug.ac.uk/faq for more information on this. + + To process the user manual: o run: latex docmfp.dtx o run: makeindex -s gind.ist docmfp o run: latex docmfp.dtx o Print docmfp.dvi for a hardcopy of the package manual -o Move docmfp.sty to a location where LaTeX will find it. -2000/10/28 +2005/03/23 Peter Wilson -peter.r.wilson@boeing.com +herries dot press at earthlink dot net + + diff --git a/Master/texmf-dist/doc/latex/docmfp/docmfp.pdf b/Master/texmf-dist/doc/latex/docmfp/docmfp.pdf new file mode 100644 index 00000000000..e5ff8023301 Binary files /dev/null and b/Master/texmf-dist/doc/latex/docmfp/docmfp.pdf differ diff --git a/Master/texmf-dist/source/latex/docmfp/docmfp.dtx b/Master/texmf-dist/source/latex/docmfp/docmfp.dtx index 1f57c50c84a..dd732c0c3fe 100644 --- a/Master/texmf-dist/source/latex/docmfp/docmfp.dtx +++ b/Master/texmf-dist/source/latex/docmfp/docmfp.dtx @@ -1,20 +1,42 @@ % \iffalse meta-comment % % docmfp.dtx -% Copyright 1999 Peter R. Wilson +% Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net +% Copyright 1999 --- 2005 Peter R. Wilson % -% This program is provided under the terms of the -% LaTeX Project Public License distributed from CTAN -% archives in directory macros/latex/base/lppl.txt. +% This work may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either +% version 1.3 of this license or (at your option) any +% later version. +% The latest version of the license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3 or later is part of all distributions of +% LaTeX version 2003/06/01 or later. +% +% This work has the LPPL maintenance status "author-maintained". +% +% This work consists of the files listed in the README file. % -% Author: Peter Wilson (CUA and NIST) (now at: peter.r.wilson@boeing.com) % % %<*driver> -\documentclass{ltxdoc} +\documentclass[twoside]{ltxdoc} %% %% %%\usepackage{docmfp} +\usepackage{url} +\usepackage[draft=false, + plainpages=false, + pdfpagelabels, + bookmarksnumbered, + hyperindex=false + ]{hyperref} +\makeatletter + \@mparswitchfalse +\makeatother +\renewcommand{\MakeUppercase}[1]{#1} +\pagestyle{headings} \EnableCrossrefs \CodelineIndex +%%% \OnlyDescription \setcounter{StandardModuleDepth}{1} \begin{document} \DocInput{docmfp.dtx} @@ -23,7 +45,7 @@ % % \fi % -% \CheckSum{303} +% \CheckSum{322} % % \DoNotIndex{\',\.,\@M,\@@input,\@addtoreset,\@arabic,\@badmath} % \DoNotIndex{\@centercr,\@cite} @@ -68,11 +90,18 @@ % % \changes{v1.0}{1999/04/11}{First public release} % \changes{v1.1}{2000/10/28}{Added general marking commands} -% -% ^^A \def\fileversion{v1.0} -% ^^A \def\filedate{1999/04/11} -% \def\fileversion{v1.1} -% \def\filedate{2000/10/28} +% \changes{v1.2}{2001/02/11}{Revised the doc check sum code} +% \changes{v1.2a}{2004/04/22}{Changed license from LPPL v1.0 to v1.3} +% \changes{v1.2b}{2004/05/14}{Minor fix for checksum} +% \changes{v1.2c}{2005/03/26}{Fixed some typos in the description part, no code changes} +% +% \def\dtxfile{docmfp.dtx} +% \def\fileversion{v1.0} \def\filedate{1999/04/11} +% \def\fileversion{v1.1} \def\filedate{2000/10/28} +% \def\fileversion{v1.2} \def\filedate{2001/02/11} +% \def\fileversion{v1.2a} \def\filedate{2004/04/22} +% \def\fileversion{v1.2b} \def\filedate{2004/05/14} +% \def\fileversion{v1.2c} \def\filedate{2005/03/26} % \newcommand*{\Lpack}[1]{\textsf {#1}} ^^A typeset a package % \newcommand*{\Lopt}[1]{\textsf {#1}} ^^A typeset an option % \newcommand*{\file}[1]{\texttt {#1}} ^^A typeset a file @@ -82,13 +111,12 @@ % \newcommand*{\Mfp}{Metafont/post} % % \title{The \Lpack{docmfp} package\thanks{This -% file has version number \fileversion, last revised +% file (\texttt{\dtxfile}) has version number \fileversion, last revised % \filedate.}} % % \author{% -% Peter Wilson\\ -% Catholic University of America \\ -% Now at {\tt peter.r.wilson@boeing.com} +% Peter Wilson\thanks{\texttt{herries dot press at earthlink dot net}}\\ +% Herries Press % } % \date{\filedate} % \maketitle @@ -99,9 +127,6 @@ % \end{abstract} % \tableofcontents % -% \StopEventually{} -% -% % % \section{Introduction} % @@ -147,8 +172,8 @@ % routine names. They can be changed via |\renewcommand|. Their default % definitions are: % \begin{verbatim} -% \newcommand{\mfpmstring}{\space(routine)} -% \newcommand{\mfpmheadname}{routines:} +% \newcommand{\routinestring}{\space(routine)} +% \newcommand{\routineheadname}{routines:} % \end{verbatim} % % \DescribeMacro{\DescribeVariable} @@ -198,7 +223,7 @@ % be a subsidiary entry of |name| under the main heading |head|. % % Essentially, |\begin{routine}{name}| is equivalent to: \\ -% |\begin{Code}{\mfpmheadname}{\mfpmstring}{name}| +% |\begin{Code}{\routineheadname}{\routinestring}{name}| % % For example, if you are documenting Java code, then you may wish % to use commands like: \\ @@ -328,6 +353,7 @@ % to documenting \Mfp{} code. It could just as well be used for documenting C, % C++, Java, or practically any other kind of code. % +% \StopEventually{} % % % \section{The package code} \label{sec:code} @@ -337,7 +363,7 @@ % \begin{macrocode} %<*usc> \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{docmfp}[2000/10/28 v1.1 General coding extension to the doc package] +\ProvidesPackage{docmfp}[2004/05/14 v1.2b General coding extension to the doc package] % \end{macrocode} % @@ -627,6 +653,53 @@ % \end{macrocode} % \end{macro} % +% \begin{macro}{\check@checksum} +% After some experience with using \Lpack{docmfp} for code that had +% no resemblence at all to \LaTeX, I found that if there were no +% backslashes present, then \Lpack{doc} whined about there being no +% checksum and said that the |\CheckSum| should be set to zero, which +% it was. This is the relevent code from the \Lpack{doc} package. +% \changes{v1.2}{2001/02/11}{Redefined the \cs{check@checksum} command} +% \changes{v1.2b}{2004/05/14}{Fixed \cs{checksum} typo, thanks to Dan Luecking} +% \begin{verbatim} +% \def\check@checksum{\relax +% \ifnum\check@sum=\z@ +% \typeout{**********************************}% +% \typeout{* This macro file has no checksum!}% +% \typeout{* The checksum should be \the\bslash@cnt!}% +% \typeout{**********************************}% +% \else +% \ifnum\check@sum=\bslash@cnt +% \typeout{*******************}% +% \typeout{* Checksum passed *}% +% \typeout{*******************}% +% \else +% \PackageError{doc}{Checksum not passed +% (\the\check@sum<>\the\bslash@cnt)}% +% {The file currently documented seems to be wrong.^^J% +% Try to get a correct version.}% +% \fi +% \fi +% \global\check@sum\z@} +% \end{verbatim} +% For the purposes of the \Lpack{docmfp} package this needs redefining +% as a zero check sum is acceptable. +% \begin{macrocode} +\renewcommand{\check@checksum}{\relax + \ifnum\check@sum=\bslash@cnt + \typeout{*******************}% + \typeout{* Checksum passed *}% + \typeout{*******************}% + \else + \PackageError{docmfp}{Checksum not passed + (\the\check@sum<>\the\bslash@cnt)}% + {The file currently documented seems to be wrong.^^J% + Try to get a correct version.}% + \fi + \global\check@sum\z@} + +% \end{macrocode} +% \end{macro} % % % diff --git a/Master/texmf-dist/source/latex/docmfp/docmfp.ins b/Master/texmf-dist/source/latex/docmfp/docmfp.ins index b1430a72c61..fcb3a99b6ea 100644 --- a/Master/texmf-dist/source/latex/docmfp/docmfp.ins +++ b/Master/texmf-dist/source/latex/docmfp/docmfp.ins @@ -1,17 +1,23 @@ -%% %% docmfp.ins -%% Copyright 1999 Peter R. Wilson +%% Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net +%% Copyright 1999 --- 2005 Peter R. Wilson +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3 of this license or (at your option) any +%% later version. +%% The latest version of the license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of +%% LaTeX version 2003/06/01 or later. +%% +%% This work has the LPPL maintenance status "author-maintained". %% -%% This program is provided under the terms of the -%% LaTeX Project Public License distributed from CTAN -%% archives in directory macros/latex/base/lppl.txt. +%% This work consists of the files listed in the README file. %% -%% Author: Peter Wilson (CUA) -%% now at: peter.r.wilson@boeing.com -%% %% This file will generate fast loadable files and documentation -%% driver files from the doc files in this package when run through -%% LaTeX or TeX. +%% driver files from the doc files in this work when run through +%% LaTeX. %% %% --------------- start of docstrip commands ------------------ %% @@ -19,14 +25,23 @@ \input docstrip.tex \preamble - Copyright 1999 Peter R. Wilson - - This program is provided under the terms of the - LaTeX Project Public License distributed from CTAN - archives in directory macros/latex/base/lppl.txt. - -Author: Peter Wilson (CUA) - now at: peter.r.wilson@boeing.com +----------------------------------------------------------------- + Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net + Copyright 1999 --- 2005 Peter R. Wilson + + This work may be distributed and/or modified under the + conditions of the LaTeX Project Public License, either + version 1.3 of this license or (at your option) any + later version. + The latest version of the license is in + http://www.latex-project.org/lppl.txt + and version 1.3 or later is part of all distributions of + LaTeX version 2003/06/01 or later. + + This work has the LPPL maintenance status "author-maintained". + + This work consists of the files listed in the README file. +----------------------------------------------------------------- \endpreamble diff --git a/Master/texmf-dist/tex/latex/docmfp/docmfp.sty b/Master/texmf-dist/tex/latex/docmfp/docmfp.sty index f27333d300a..3d212801f5c 100644 --- a/Master/texmf-dist/tex/latex/docmfp/docmfp.sty +++ b/Master/texmf-dist/tex/latex/docmfp/docmfp.sty @@ -6,17 +6,26 @@ %% %% docmfp.dtx (with options: `usc') %% -%% Copyright 1999 Peter R. Wilson +%% ----------------------------------------------------------------- +%% Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net +%% Copyright 1999 --- 2005 Peter R. Wilson %% -%% This program is provided under the terms of the -%% LaTeX Project Public License distributed from CTAN -%% archives in directory macros/latex/base/lppl.txt. +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3 of this license or (at your option) any +%% later version. +%% The latest version of the license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of +%% LaTeX version 2003/06/01 or later. %% -%% Author: Peter Wilson (CUA) -%% now at: peter.r.wilson@boeing.com +%% This work has the LPPL maintenance status "author-maintained". +%% +%% This work consists of the files listed in the README file. +%% ----------------------------------------------------------------- %% \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{docmfp}[2000/10/28 v1.1 General coding extension to the doc package] +\ProvidesPackage{docmfp}[2004/05/14 v1.2b General coding extension to the doc package] \newcommand{\m@fpmakeuscoreletter}{\catcode`\_11\relax} \newcommand{\m@fpmakehashletter}{\catcode`\#11\relax} @@ -129,6 +138,19 @@ \encapchar usage} \@esphack} +\renewcommand{\check@checksum}{\relax + \ifnum\check@sum=\bslash@cnt + \typeout{*******************}% + \typeout{* Checksum passed *}% + \typeout{*******************}% + \else + \PackageError{docmfp}{Checksum not passed + (\the\check@sum<>\the\bslash@cnt)}% + {The file currently documented seems to be wrong.^^J% + Try to get a correct version.}% + \fi + \global\check@sum\z@} + \endinput %% %% End of file `docmfp.sty'. -- cgit v1.2.3