diff options
author | Dr. Clea F. Rees <cfrees@imapmail.org> | 2009-05-25 23:47:12 +0000 |
---|---|---|
committer | Dr. Clea F. Rees <cfrees@imapmail.org> | 2009-05-25 23:47:12 +0000 |
commit | b2a20256a56c4e13d3bdf4aa786e4d5734a73290 (patch) | |
tree | e37590df82edabf8cff254ffdb432f4cb5de6b64 | |
parent | a8af7bde8cf472e2ca3801d8d62c8538b176c295 (diff) |
gmdoc newversion
git-svn-id: svn://tug.org/texlive/trunk@13474 c570f23f-e606-0410-a88d-b1316a301751
4 files changed, 143 insertions, 156 deletions
diff --git a/Master/texmf-dist/doc/latex/gmdoc/README b/Master/texmf-dist/doc/latex/gmdoc/README index 2bb2f0308b0..60b94fe7397 100644 --- a/Master/texmf-dist/doc/latex/gmdoc/README +++ b/Master/texmf-dist/doc/latex/gmdoc/README @@ -1,125 +1,125 @@ -The gmdoc.zip package
-is a work of Grzegorz Murzynowski,
-<natror at o2 dot pl>
-
-
-1. Copyright 2006, 2007, 2008 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
-
-The base drivers depend on the `gmeometric.sty'
-package by Grzegorz Murzynowski, available on CTAN.
-
-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.
-
-These drivers use one more package of mine, `gmeometric.sty'.
+The gmdoc.zip package +is a work of Grzegorz Murzynowski, +<natror at o2 dot pl> + + +1. Copyright 2006, 2007, 2008 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 + +The base drivers depend on the `gmeometric.sty' +package by Grzegorz Murzynowski, available on CTAN. + +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. + +These drivers use one more package of mine, `gmeometric.sty'. 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 f2d77dac2b0..1a0b8906a9f 100644 --- a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/doc_gmdoc.tex +++ b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/doc_gmdoc.tex @@ -3,14 +3,10 @@ % a~command to encapsulate the page number, which would interfere with % \pk{hyperref}'s default \verb+|hyperpage+. -\documentclass[countalllines, -codespacesblank, outeroff, pagella, fontspec=quiet]{gmdocc} +\documentclass[outeroff,minion]{gmdocc} \usepackage{array} - -\VisSpacesGrey - -\def\BasePath{/home/natror/texmf/source/latex/base/}% Of course, +\def\BasePath{/mnt/middle/TeXLive2005/texmf-dist/source/latex/base/}% Of course, % you should change it to the respective path on your computer. @@ -95,7 +91,7 @@ codespacesblank, outeroff, pagella, 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. @@ -105,16 +101,15 @@ codespacesblank, outeroff, pagella, fontspec=quiet]{gmdocc} \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} 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 724a8630482..6a724ef87fc 100644 --- a/Master/texmf-dist/doc/latex/gmdoc/basedrivers/docstrip_gmdoc.tex +++ b/Master/texmf-dist/doc/latex/gmdoc/basedrivers/docstrip_gmdoc.tex @@ -5,14 +5,13 @@ % GM 2006/12/1 % -\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}% -%^^A \mcdiagOn + \documentclass[minion]{gmdocc}% \fi \ltxLookSetup @@ -44,7 +43,7 @@ \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 @@ -52,22 +51,15 @@ \let\renewenvironment\gobbletwo}% the only renewed env.\ in % \file{docstrip.dtx} is \env{theglossary}. I~prefer it to be twocolumn. -%^^A \AfterMacrocode4{\showboxbreadth=1000 -%^^A \showboxdepth=1000 \showlists -%^^A \tracingoutput1 \tracingpages1} -%^^A -%^^A \AfterMacrocode5{\csname gmd@mchook4\endcsname} - - \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} %\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 b641e5d1ad9..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,13 +105,13 @@ page_precedence "rnaA" \end{filecontents} -\PassOptionsToPackage{codespacesgrey, indexallmacros}{gmdoc} +\PassOptionsToPackage{indexallmacros}{gmdoc} \if1 1 - \documentclass[debug, minion, fontspec=quiet]{gmdocc}% + \documentclass[debug,minion]{gmdocc}% \mcdiagOn \else - \documentclass[fontspec=quiet]{gmdocc}% + \documentclass[sysfonts]{gmdocc}% \fi \foone{\catcode`_=12 } @@ -228,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 @@ -414,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 @@ -438,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. |