gmdoc

git-svn-id: svn://tug.org/texlive/trunk@20441 c570f23f-e606-0410-a88d-b1316a301751

4 files changed, 173 insertions, 294 deletions

diff --git a/Master/texmf-dist/doc/latex/gmdoc/README b/Master/texmf-dist/doc/latex/gmdoc/README
index e3e2b56904e..a2e161e1375 100644
--- a/Master/texmf-dist/doc/latex/gmdoc/README
+++ b/Master/texmf-dist/doc/latex/gmdoc/README
@@ -1,121 +1,121 @@
-The gmdoc.zip package

-is a work of Grzegorz Murzynowski,

-<natror at o2 dot pl>

-

-   

-1. Copyright 2006, 2007, 2008, 2009, 2010 by Grzegorz `Natror' Murzynowski

-

-This program is subject to the LaTeX Project Public License. 

-See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html

-for the details of that license.

-

-

-2. Introduction

-

-This package provides a tool for documenting of (La)TeX

-packages, classes etc., i.e., the .sty, .cls

-etc. The author just writes the code and adds the commentary 

-preceded with % sign (or another sign properly declared). No special

-environments are necessary.

-

-The package tends to be compatible with the standard doc.sty

-package, i.e., the .dtx files are also compilable with

-gmdoc (they may need very little adjustment, in some rather

-special cases).

-

-The tools are integrated with hyperref.sty's advantages such as

-hyperlinking of index entries, of contents entries and

-of cross-references.

-

-

-3. Installation

-

-Unpack the gmdoc-tds.zip archive in a texmf directory or put the

-gmdoc.sty, gmdocc.cls and gmoldcomm.sty somewhere in the

-texmf/tex/latex branch on your own and also the gmiflink.sty,

-gmverb.sty and gmiflink.sty files (available on CTAN in separate

-packages).  (Creating a /texmf/tex/latex/gm directory may be advisable

-if you consider using other packages written by me.)

-

-Moreover, you should put the gmglo.ist file, a MakeIndex style for the

-changes' history, into some texmf/makeindex directory.

-

-Then you should refresh your TeX distribution's files'

-database most probably.

-

-

-4. Contents

-

-The distribution of this package consists of the following five files.

-

-gmdoc.sty

-gmdocc.cls

-gmglo.ist

-README

-gmdoc.pdf

-gmdoc-tds.zip

-

-5. Documentation

-

-The last of the above files (the .pdf) is a documentation compiled

-from the .sty file by running LaTeX on the gmdocDoc.tex file twice:

-xelatex gmdoc.sty

- in the directory you wish the documentation to be in, 

-you don't have copy the .sty file  there---TeX will find it,

-then MakeIndex on the gmdoc.idx and gmdoc.glo files, and then LaTeX

-on gmdocDoc.tex twice again.

-

-MakeIndex shell commands:

-  makeindex -r gmdocDoc

-  makeindex -r -s gmglo.ist -o gmdocDoc.gls gmdocDoc.glo 

-The -r switch is to forbid MakeIndex make implicit ranges since the

-(code line) numbers will be hyperlinks.

-The -s switch makes MakeIndex use the style file instead of the

-default settings and the -o switch declares the not-default name of

-the output file

-

-Compiling of the documentation requires the packages gmdoc.sty (with

-the gmdocc.cls class), gmiflink.sty, gmverb.sty, gmutils.sty and also

-some standard packages: hyperref.sty, xcolor.sty, geometry.sty,

-multicol.sty, lmodern.sty, fontenc.sty that should be installed on

-your computer by default.

-

-The gmglo.ist file, a MakeIndex style for the changes' history, is

-provided on CTAN in the gmdoc .zip archive and should 

-be put into some texmf/makeindex directory.

-

-If you have not installed the mwcls classes (available on CTAN and

-present in TeX Lives e.g.), the result of your compilation may differ

-a bit from the .pdf provided in this .zip archive in formattings: If

-you have not installed mwcls, the standard article.cls will be

-used.

-

-

-DEPENDS ON (only non-standard files listed):

-

-gmiflink.sty

-gmutils.sty

-gmverb.sty

-gmglo.ist

-

-*if you typeset The LaTeX 2e Source

-

-BONUS: Base drivers

-

-As a bonus and example of doc-compatibility 

-there are driver files included

-(cf. Palestrina, Missa papae Marcelli ;-):

-

-source2e_gmdoc.tex

-docstrip_gmdoc.tex

-doc_gmdoc.tex

-

-(gmsource2e.ist is generated from source2e_gmdoc.tex)

-gmoldcomm.sty

-

-These drivers typeset the respective files from the

-.../texmf-dist/source/latex/base

-directory of TeXLive2005 distribution.

-Probably you should redefine the \BasePath macro in them

-so that it points that directory on your computer.

-

+The gmdoc.zip package
+is a work of Grzegorz Murzynowski,
+<natror at o2 dot pl>
+
+   
+1. Copyright 2006, 2007, 2008, 2009, 2010 by Grzegorz `Natror' Murzynowski
+
+This program is subject to the LaTeX Project Public License. 
+See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
+for the details of that license.
+
+
+2. Introduction
+
+This package provides a tool for documenting of (La)TeX
+packages, classes etc., i.e., the .sty, .cls
+etc. The author just writes the code and adds the commentary 
+preceded with % sign (or another sign properly declared). No special
+environments are necessary.
+
+The package tends to be compatible with the standard doc.sty
+package, i.e., the .dtx files are also compilable with
+gmdoc (they may need very little adjustment, in some rather
+special cases).
+
+The tools are integrated with hyperref.sty's advantages such as
+hyperlinking of index entries, of contents entries and
+of cross-references.
+
+
+3. Installation
+
+Unpack the gmdoc-tds.zip archive in a texmf directory or put the
+gmdoc.sty, gmdocc.cls and gmoldcomm.sty somewhere in the
+texmf/tex/latex branch on your own and also the gmiflink.sty,
+gmverb.sty and gmiflink.sty files (available on CTAN in separate
+packages).  (Creating a /texmf/tex/latex/gm directory may be advisable
+if you consider using other packages written by me.)
+
+Moreover, you should put the gmglo.ist file, a MakeIndex style for the
+changes' history, into some texmf/makeindex directory.
+
+Then you should refresh your TeX distribution's files'
+database most probably.
+
+
+4. Contents
+
+The distribution of this package consists of the following five files.
+
+gmdoc.sty
+gmdocc.cls
+gmglo.ist
+README
+gmdoc.pdf
+gmdoc-tds.zip
+
+5. Documentation
+
+The last of the above files (the .pdf) is a documentation compiled
+from the .sty file by running LaTeX on the gmdocDoc.tex file twice:
+xelatex gmdoc.sty
+ in the directory you wish the documentation to be in, 
+you don't have copy the .sty file  there---TeX will find it,
+then MakeIndex on the gmdoc.idx and gmdoc.glo files, and then LaTeX
+on gmdocDoc.tex twice again.
+
+MakeIndex shell commands:
+  makeindex -r gmdocDoc
+  makeindex -r -s gmglo.ist -o gmdocDoc.gls gmdocDoc.glo 
+The -r switch is to forbid MakeIndex make implicit ranges since the
+(code line) numbers will be hyperlinks.
+The -s switch makes MakeIndex use the style file instead of the
+default settings and the -o switch declares the not-default name of
+the output file
+
+Compiling of the documentation requires the packages gmdoc.sty (with
+the gmdocc.cls class), gmiflink.sty, gmverb.sty, gmutils.sty and also
+some standard packages: hyperref.sty, xcolor.sty, geometry.sty,
+multicol.sty, lmodern.sty, fontenc.sty that should be installed on
+your computer by default.
+
+The gmglo.ist file, a MakeIndex style for the changes' history, is
+provided on CTAN in the gmdoc .zip archive and should 
+be put into some texmf/makeindex directory.
+
+If you have not installed the mwcls classes (available on CTAN and
+present in TeX Lives e.g.), the result of your compilation may differ
+a bit from the .pdf provided in this .zip archive in formattings: If
+you have not installed mwcls, the standard article.cls will be
+used.
+
+
+DEPENDS ON (only non-standard files listed):
+
+gmiflink.sty
+gmutils.sty
+gmverb.sty
+gmglo.ist
+
+*if you typeset The LaTeX 2e Source
+
+BONUS: Base drivers
+
+As a bonus and example of doc-compatibility 
+there are driver files included
+(cf. Palestrina, Missa papae Marcelli ;-):
+
+source2e_gmdoc.tex
+docstrip_gmdoc.tex
+doc_gmdoc.tex
+
+(gmsource2e.ist is generated from source2e_gmdoc.tex)
+gmoldcomm.sty
+
+These drivers typeset the respective files from the
+.../texmf-dist/source/latex/base
+directory of TeXLive2005 distribution.
+Probably you should redefine the \BasePath macro in them
+so that it points that directory on your computer.
+
diff --git a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/doc_gmdoc.tex b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/doc_gmdoc.tex
index ac83c0917e8..1a0b8906a9f 100644
--- a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/doc_gmdoc.tex
+++ b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/doc_gmdoc.tex
@@ -1,67 +1,14 @@
-%% 
-% \skiplines
-%<*master>
-%% \iffalse ^^A we skip the debug setting
-\IfFileExists{\string~/bin/gen_and_xela}{\errorcontextlines=1000 }{}
-%% \fi
-%% ^^A $Id: TheUltimateMaster.gmd,v 0.250 2010/10/24 14:42:35 natror Exp natror $
-% \endskiplines
-%
-%% \BundleInfoFromName{doc_gmdoc}
-%% \title{\doc_gmdocTitle }
-%% \author{Grzegorz Murzynowski}
-%% \maketitle
-%%
-%% \let\ty\emph \let\df\dekfracc
-%%
-%% \begin{copyrnote}
-%%
-%% 
-%% Copyright ©\, 
-%% by Grzegorz ‘Natror’ Murzynowski
-%% natror (at) o2 (dot) pl
-%% 
-%% This program is subject to the \LaTeX\ Project Public License.
-%% See ^^A
-%% \url{http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html} ^^A
-%% for the details of that license.\rrthis
-%%
-%% \acro{LPPL} status: "author-maintained". \par
-%%
-%% 
-%% 
-%% 
-%% 
-%% For the documentation please refer to the file(s)
-%% \file{doc_gmdoc.{gmd,pdf}}.
-%%
-%% \end{copyrnote}
-%% 
-%
-%
-% \skiplines
-%</master>
-% \endskiplines
-%
-%
-%% 
-%% 
-\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{doc_gmdoc}
-    [2010/09/25 v0.993  (GM)]
-
-
-%%
 \PassOptionsToPackage{hyperindex=false}{hyperref}% Because FM writes some almost
+% explicit indexing commands where he uses `encapsulating' i.e.,
+% a~command to encapsulate the page number, which would interfere with
+% \pk{hyperref}'s default \verb+|hyperpage+.
 
-\documentclass[countalllines,
-codespacesblank, outeroff, pagella, cronos, cursor,
-fontspec=quiet]{gmdocc}
+\documentclass[outeroff,minion]{gmdocc}
 \usepackage{array}
 
-\VisSpacesGrey
+\def\BasePath{/mnt/middle/TeXLive2005/texmf-dist/source/latex/base/}% Of course, 
+% you should change it to the respective path on your computer.
 
-\def\BasePath{/home/natror/texmf/source/latex/base/}% Of course,
 
 \ltxLookSetup
 \gmdoccMargins
@@ -74,38 +21,33 @@ fontspec=quiet]{gmdocc}
 
 \makeatletter
 
-\edef\gmd@wykrzykniki{\xiihash\space\xiihash\space}
-\edef\gmd@wykrzykniki{\gmd@wykrzykniki\gmd@wykrzykniki}
-\edef\gmd@wykrzykniki{\gmd@wykrzykniki\gmd@wykrzykniki}
-\edef\gmd@wykrzykniki{\gmd@wykrzykniki\gmd@wykrzykniki}
-
 \author{Frank Mittelbach \and David Carlisle}
 \title{The \pk{doc} and \pk{shortvrb} Packages\\ and\\
   the \pk{ltxdoc} Class}
-\date{Typeset with the \pk{gmdoc} package by Natror\\\today}
+\date{Typeset with the \pk{gmdoc} package by Natror\\\today} 
 
-\errorcontextlines=1000
-\fooatletter{%
-  \typeout{@@@@@ \meaning\@begindocumenthook}}
 \begin{document}
 
 \smartunder
 
-\typeout{@@@@ in document}
+\maketitle 
 
-\maketitle
-\typeout{@@@@ after title}
 
 \addtocontents{toc}{% to discard |\begin{multicols}{2}| of one
   % included document. (Table of contents is declared twocolumn with
   % |\twocoltoc| above.)
     \let\protect\begin\protect\@gobbletwo
-      \protect\Store@Macro\protect\end
-      \def\protect\end{\protect\Restore@Macro\protect\end\protect\@gobble}%
+      \protect\StoreMacro\protect\end
+      \def\protect\end{\protect\RestoreMacro\protect\end\protect\@gobble}%
 }% Because one document has a~\env{multicols} twocolumn table of
+% contents and the other has usual one column, this will put entire
+% toc in(to) \env{multicols}.
+
 
 \tableofcontents
 
+%^^A TODO Old comments i.e. authomatic verbatimization of all the cs's
+%^^A met in the comment layer.
 
 \makeatletter
 \AfterMacrocode{161}{% it's for a~tiny little typo in line 3299: They
@@ -121,6 +63,7 @@ fontspec=quiet]{gmdocc}
   % \label{explicit fileinfo}
   \let\GetFileInfo\relax
   \addtomacro\IndexParms{\arraybackslash}}% because |\IndexParms| use
+% |\raggedright| and FM executes |\IndexParms| inside a~\env{tabular}.
 
 \DocInclude[\BasePath]{doc}
 
@@ -128,7 +71,7 @@ fontspec=quiet]{gmdocc}
   \chschange{v2.0u}{2006/10/20}{410}%
   \let\CheckSum\gobble
   \def\filedate{1999/08/08} \def\fileversion{v2.0u}% see line
-  % \ref{explicit fileinfo}.
+  % \ref{explicit fileinfo}. 
   \let\GetFileInfo\relax
   % The rest of this |\AtBegInputOnce|'s contents is necessary since
   % DC wrote it not commented out, which with \pk{doc} results with
@@ -136,7 +79,7 @@ fontspec=quiet]{gmdocc}
   % with \pk{gmdoc} it puts this stuff in the code layer that'll be
   % only printed verbatim.
   \providecommand\dst{\expandafter{\normalfont\scshape docstrip}}
-  \title{The file \texttt{ltxdoc.dtx} for use with
+  \title{The file \texttt{ltxdoc.dtx} for use with 
     \LaTeXe.\thanks{This file has version
       number \fileversion, dated \filedate.}\\[2pt]
     It contains the code for \texttt{ltxdoc.cls}}
@@ -148,39 +91,39 @@ fontspec=quiet]{gmdocc}
 
 \gmdocIncludes
 
-\AtBegInputOnce{%
+\SelfInclude{%
   \title{\pk{doc_by_gmdoc.tex} The Driver\thanks{As mentioned in the
       title, I~typeset these package and class with the \pk{gmdoc}
       package, for which are they a~great inspiration and the base.
       The typesetting needed only a~few tricks, so here i~give the
+%^^A(
       code of the `driver': a~snake eats its tail ;-) .}}
     \author{Grzegorz `Natror' Murzynowski}%
     \date{\today}%
     \maketitle}
-\SelfInclude
 
 \typeout{%
   Produce change log with^^J%
-  makeindex -r -s gmglo.ist -o \jobname.gls \jobname.glo^^J
+  makeindex -r -s gmglo.ist -o \jobnamewoe.gls \jobnamewoe.glo^^J
   (gmglo.ist should be put into some texmf/makeindex directory.)^^J}
 \PrintChanges
 \typeout{%
   Produce index with^^J%
-  makeindex -r \jobname^^J}
+  makeindex -r \jobnamewoe^^J}
  \PrintIndex
 
 \end{document}
 
+% MakeIndex shell commands:
 
 makeindex -r doc_gmdoc
 makeindex -r -s gmglo.ist -o doc_gmdoc.gls doc_gmdoc.glo
 
+% \NoEOF
+% \_ {\bf bf: \_} {\bfseries bfseries \_} 
+
 
-%%% (For my GNU Emacs:)
-%%% Local Variables:
-%%% mode: doctex
-%%% coding: utf-8
-%%% End:
-\endinput
-%%
-%% End of file `doc_gmdoc.tex'.
+%%% Local Variables: 
+%%% mode: latex
+%%% TeX-master: t
+%%% End: 
\ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/docstrip_gmdoc.tex b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/docstrip_gmdoc.tex
index 9f7d8cddbdf..6a724ef87fc 100644
--- a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/docstrip_gmdoc.tex
+++ b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/docstrip_gmdoc.tex
@@ -1,65 +1,17 @@
-%% 
-% \skiplines
-%<*master>
-%% \iffalse ^^A we skip the debug setting
-\IfFileExists{\string~/bin/gen_and_xela}{\errorcontextlines=1000 }{}
-%% \fi
-%% ^^A $Id: TheUltimateMaster.gmd,v 0.250 2010/10/24 14:42:35 natror Exp natror $
-% \endskiplines
 %
-%% \BundleInfoFromName{docstrip_gmdoc}
-%% \title{\docstrip_gmdocTitle }
-%% \author{Grzegorz Murzynowski}
-%% \maketitle
-%%
-%% \let\ty\emph \let\df\dekfracc
-%%
-%% \begin{copyrnote}
-%%
-%% 
-%% Copyright ©\, 
-%% by Grzegorz ‘Natror’ Murzynowski
-%% natror (at) o2 (dot) pl
-%% 
-%% This program is subject to the \LaTeX\ Project Public License.
-%% See ^^A
-%% \url{http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html} ^^A
-%% for the details of that license.\rrthis
-%%
-%% \acro{LPPL} status: "author-maintained". \par
-%%
-%% 
-%% 
-%% 
-%% 
-%% For the documentation please refer to the file(s)
-%% \file{docstrip_gmdoc.{gmd,pdf}}.
-%%
-%% \end{copyrnote}
-%% 
+% A~driver file to typeset \pk{dostrip.dtx} with the \pk{gmdoc}
+% package.
 %
+% GM 2006/12/1
 %
-% \skiplines
-%</master>
-% \endskiplines
-%
-%
-%% 
-%% 
-\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{docstrip_gmdoc}
-    [2010/09/25 v0.993  (GM)]
-
-
-%%
 
-\PassOptionsToPackage{countalllines,codespacesgrey,indexallmacros}{gmdoc}
+\PassOptionsToPackage{indexallmacros}{gmdoc}
 
-\if11
-  \documentclass[debug, pagella, fontspec=quiet]{gmdocc}%
+\if1 1
+  \documentclass[debug]{gmdocc}% 
   \mcdiagOn
 \else
-  \documentclass[pagella]{gmdocc}%
+  \documentclass[minion]{gmdocc}%
 \fi
 
 \ltxLookSetup
@@ -68,6 +20,8 @@
 
 \DeleteShortVerb\|
 \OldMakeShortVerb*\|% To define shortverb \verb+|+ such that it
+% remains shortverb in math mode (by default I~define it to be $\vert$ in
+% math mode.
 
 \relaxen\ds
 \emptify\EOFMark
@@ -89,31 +43,23 @@
 
 \begin{document}
 
-\def\BasePath{/home/natror/texmf/source/latex/base/}
+\def\BasePath{/mnt/middle/TeXLive2005/texmf-dist/source/latex/base/}
+%^^A  \tableofcontents
   \addtomacro\endabstract{\aftergroup\tableofcontents}
   \AtBegInputOnce{\date{Printed \today\\ with \pk{gmdoc} package by
       Natror}\let\date\gobble
     \let\renewenvironment\gobbletwo}% the only renewed env.\ in
   % \file{docstrip.dtx} is \env{theglossary}. I~prefer it to be twocolumn.
 
-
   \OldDocInput{\BasePath docstrip.dtx}
 
   \typeout{%
     ^^JProduce change log with^^J%
-    makeindex -r -s gmglo.ist -o \jobname.gls \jobname.glo^^J}
+    makeindex -r -s gmglo.ist -o \jobnamewoe.gls \jobnamewoe.glo^^J}
 
   \typeout{%
     ^^JProduce index with^^J%
-    makeindex -r \jobname.idx^^J}
-
+    makeindex -r \jobnamewoe.idx^^J}
+ 
 \end{document}
-
-%%% (For my GNU Emacs:)
-%%% Local Variables:
-%%% mode: doctex
-%%% coding: utf-8
-%%% End:
-\endinput
-%%
-%% End of file `docstrip_gmdoc.tex'.
+%\NoEOF
diff --git a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/source2e_gmdoc.tex b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/source2e_gmdoc.tex
index bbe5e70afd2..cdfcd7b0626 100644
--- a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/source2e_gmdoc.tex
+++ b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/source2e_gmdoc.tex
@@ -105,16 +105,13 @@ page_precedence "rnaA"
 \end{filecontents}
 
 
-\PassOptionsToPackage{codespacesgrey, indexallmacros}{gmdoc}
+\PassOptionsToPackage{indexallmacros}{gmdoc}
 
-\if11
-  \documentclass[debug, minion, cronos, cursor, fontspec=quiet]{gmdocc}% 
-
-  % ^^A[FakeBold=2, FakeStretch=0.87]{Nimbus Mono L}
+\if1 1
+  \documentclass[debug,minion]{gmdocc}% 
   \mcdiagOn
-  
 \else
-  \documentclass[fontspec=quiet]{gmdocc}%
+  \documentclass[sysfonts]{gmdocc}%
 \fi
 
 \foone{\catcode`_=12 }
@@ -216,9 +213,6 @@ page_precedence "rnaA"
 %^^A  \else\typeout{****** \cs{"} with argument }\show#1\fi
     }}{}}
 
-\foone{\makeatletter\catcode`\#=12 }{%
-  \def\gmd@wykrzykniki{# # # # # # # # #}}
-
 \begin{document}
 
 
@@ -234,7 +228,7 @@ page_precedence "rnaA"
   Rainer Sch\"opf}
 
 
-\def\BasePath{/home/natror/texmf/source/latex/base/}
+\def\BasePath{/mnt/middle/TeXLive2005/texmf-dist/source/latex/base/}
 
 
 % This command will be used to input the patch file
@@ -279,11 +273,7 @@ page_precedence "rnaA"
 
 \pagenumbering{roman}
 \thispagestyle{empty}
-
-%^^A\traceon
 \maketitle
-\relax
-%^^A \traceoff
 \emptify\maketitle
 
 \tableofcontents
@@ -424,7 +414,7 @@ page_precedence "rnaA"
 
 \typeout{%
   ^^JProduce change log with^^J%
-  makeindex -r -s gmglo.ist -o \jobname.gls \jobname.glo^^J}
+  makeindex -r -s gmglo.ist -o \jobnamewoe.gls \jobnamewoe.glo^^J}
 
 {%^^A\def\.{\cs{.}}% 'cause there's |\cs {\.}| in change log on l.4314
   % The next step of debug of \file{ltmiscen.dtx}'s
@@ -448,7 +438,7 @@ page_precedence "rnaA"
 
 \typeout{%
   ^^JProduce index with^^J%
-  makeindex -r -s gmsource2e.ist \jobname.idx^^J}
+  makeindex -r -s gmsource2e.ist \jobnamewoe.idx^^J}
 
 % ``Makeindex needs a symbol between the parts of composite page numbers
 % but we dont want one, so:''---I~skip that.