diff options
author | Reinhard Kotucha <reinhard.kotucha@web.de> | 2006-11-27 00:18:34 +0000 |
---|---|---|
committer | Reinhard Kotucha <reinhard.kotucha@web.de> | 2006-11-27 00:18:34 +0000 |
commit | 6925c2312bf64d643e674ffb79bd5d7f842f6d76 (patch) | |
tree | 0ec7270d17a631fba856b492225d46af93aaa83a /Master/texmf-dist/doc/generic | |
parent | c588c9533b6b61c3234451e8c1bc2dd7aa69b00b (diff) |
update pstricks.
git-svn-id: svn://tug.org/texlive/trunk@2547 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/generic')
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/Changes.doc | 1 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.pdf | bin | 1481930 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.tex | 1362 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/voss/CHANGES | 79 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/voss/README | 45 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/voss/bsp323.tex | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/voss/bsp342.tex | 24 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/pstricks/voss/manual.html | 2871 |
8 files changed, 19 insertions, 4375 deletions
diff --git a/Master/texmf-dist/doc/generic/pstricks/Changes.doc b/Master/texmf-dist/doc/generic/pstricks/Changes.doc new file mode 100644 index 00000000000..6dc949ade76 --- /dev/null +++ b/Master/texmf-dist/doc/generic/pstricks/Changes.doc @@ -0,0 +1 @@ +2005-12-22 new files pstnews1-14.tex|pdf diff --git a/Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.pdf b/Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.pdf Binary files differdeleted file mode 100644 index b4d2007b391..00000000000 --- a/Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.tex b/Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.tex deleted file mode 100644 index dbface7370c..00000000000 --- a/Master/texmf-dist/doc/generic/pstricks/pst-fill-doc.tex +++ /dev/null @@ -1,1362 +0,0 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -*- Mode: Latex -*- %%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% doc-fill.tex --- Documentation for `pst-fill PSTricks package -%% -%% Author : Denis GIROU (CNRS/IDRIS - France) <Denis.Girou@idris.fr> -%% Created the : Wed Oct 29 18:39:29 1997 -%% Last mod. by : Herbert Voss <voss _at_ pstricks.de> -%% Last mod. the : Aug 17 2004 -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% If there is not `ctandir' installed (from `ltugboat' package) -\begin{filecontents}{ctandir.sty} -%% LaTeX2e file `ctandir.sty' -%% generated by the `filecontents' environment -%% from source `ltubguid' on 1997/06/12. -%% -% -% Experimental CTAN location information macros for use with Donald -% Arseneau's |url.sty| -% -% we need url.sty; we can rely on it to demand anything it needs of -% LaTeX -\IfFileExists{url.sty}% - {\RequirePackage{url}}% - {\PackageWarning{ctandir}{You should acquire a copy of url.sty}% - \newcommand\urldef[3]{\def#1{\texttt{#3}}}% - \let\url\texttt - } -% -\newcommand\CTANdirectory[1]{\expandafter\urldef - \csname CTAN@#1\endcsname\path} -\newcommand\CTANfile[1]{\expandafter\urldef - \csname CTAN@#1\endcsname\path} -% -% Use the standard label-referencing mechanism to get the warning for -% an undefined label -\newcommand\CTANref[1]{\expandafter\@setref\csname CTAN@#1\endcsname - \relax{#1}} -\end{filecontents} - -\documentclass{article} -\usepackage[T1]{fontenc} -\usepackage{geometry} -\usepackage[hang]{caption} % Improved captions -\usepackage{ctandir} % For CTAN references -\usepackage{fancyvrb} % Fancy verbatims -\usepackage{graphicx} % `graphicx' LaTeX standard package -\usepackage{mflogo} % For the MetaFont and MetaPost logos -\input{random.tex} % Random macros from Donald Arseneau -\usepackage{url} % URLs convenient typesetting -\usepackage{multido} % General loop macro -\usepackage{pstricks} % PSTricks with the `color' extension -\usepackage{pst-char} % PSTricks package for character path -\usepackage[tiling]{pst-fill} % PSTricks package for filling/tiling -\usepackage{pst-grad} % PSTricks package for gradient filling -\usepackage{pst-node} % PSTricks package for nodes - -% To extend the height used for the text -%\setlength{\textheight}{25cm} -%\setlength{\topmargin}{-1.5cm} - -% Aligned labels in a description environment -\newenvironment{Description}[1]{% -\begin{list}{nothing}{\setlength{\leftmargin}{#1} -\setlength{\labelwidth}{\leftmargin}\setlength{\labelsep}{1mm}}} -{\end{list}} - -% For macro names -\DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}} - -% Define CTAN addresses using the commands of the |ctandir| package -\CTANdirectory{mpattern}{graphics/metapost/macros/mpattern} -\CTANdirectory{pstricks}{graphics/pstricks} -\CTANdirectory{pst-fill.sty}{graphics/pstricks/latex/pst-fill.sty} -\CTANdirectory{pst-fill}{graphics/pstricks/generic/pst-fill.tex} -\CTANdirectory{Roegel}{graphics/metapost/contrib/macros/truchet} -\CTANdirectory{xypic}{macros/generic/diagrams/xypic} - -% From ltugboat.cls -% For references -\makeatletter -\newcommand\acro[1]{\textsc{#1}\@} -\def\CTAN{\acro{CTAN}} -\let\texttub\textsl % redefined in other situations -\def\TUB{\texttub{TUGboat}} -\def\TUG{\TeX\ \UG} -\def\tug{\acro{TUG}} -\def\UG{Users Group} -% For the bibliography -\let\@internalcite\cite -\def\cite{\def\@citeseppen{-1000}% - \def\@cite##1##2{(##1\if@tempswa , ##2\fi)}% - \def\citeauthoryear##1##2##3{##1, ##3}\@internalcite} -\def\etal{et\,al.\@} -\makeatother - -% Personal macros (D.G.) -% ---------------------- - -% Some colors used -\definecolor{LemonChiffon}{rgb}{1.,0.98,0.8} -\definecolor{LightBlue} {rgb}{0.8,0.85,0.95} -\definecolor{PaleGreen} {rgb}{0.88,1,0.88} -\definecolor{PeachPuff} {rgb}{1.0,0.85,0.73} - -% To define a unique string for TeX and LaTeX -\newcommand{\AllTeX}{% -{\rm(L\kern-.36em\raise.3ex\hbox{\sc a}\kern-.15em)% -T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX}} - -% Bibliography style -\bibliographystyle{ltugbib} - -% Name macros -\newcommand{\FillPackage}{\textsf{`pst-fill'}} -\newcommand{\XYpic}{% -\leavevmode\hbox{\kern-.1em X\kern-.3em\lower.4ex\hbox{Y\kern-.15em}-pic}} - -\makeatletter - -% Example environments -% (do not use in them the four JXYZ characters, that we will use -% as escape characters!) - -% For highlighting some verbatim sequences (array names, macro names and comments) -\def\HLComment#1{\textit{#1}} -\def\HLEmph#1{\textit{#1}} -\def\HLTeletype#1{\texttt{#1}} -\def\HLReverse#1{{% -\setlength{\fboxsep}{1pt}% -\colorbox{black}{\textcolor{white}{\textbf{#1}}}}} - -\def\Example{\FV@Environment{}{Example}} -\def\endExample{% -\end{VerbatimOut} -\Below@Example{\input{\jobname.tmp}} -\endgroup} - -\def\CenterExample{\FV@Environment{}{Example}} -\def\endCenterExample{% -\end{VerbatimOut}% -\begin{center} -\Below@Example{\input{\jobname.tmp}} -\end{center} -\endgroup} - -\def\SideBySideExample{\FV@Environment{}{Example}} -\def\endSideBySideExample{% -\end{VerbatimOut}% -\SideBySide@Example{\input{\jobname.tmp}} -\endgroup} - -\def\FVB@Example{% -\begingroup -\FV@UseKeyValues -\parindent=0pt -\multiply\topsep by 2 -\VerbatimEnvironment -\begin{VerbatimOut}[codes={\catcode`\Z=12}]{\jobname.tmp}} - -\def\Below@Example#1{% -\VerbatimInput[gobble=0,commentchar=Z,commandchars=JXY,numbersep=3pt, - frame=single,numbers=left]% - {\jobname.tmp} -\catcode`\Z=9\relax% -% We suppress the effect of the highlighting macros -\catcode`\J=0\relax% -\catcode`\X=1\relax% -\catcode`\Y=2\relax% -\def\HLComment##1{##1}% -\def\HLEmph##1{##1}% -\def\HLTeletype##1{##1}% -\def\HLReverse##1{##1}% -#1\par} - -\def\SideBySide@Example#1{% -\@tempdimb=\FV@XRightMargin -\advance\@tempdimb -5mm -\begin{minipage}[c]{\@tempdimb} - \fvset{xrightmargin=0pt} - \catcode`\Z=9\relax% - % We suppress the effect of the highlighting macros - \catcode`\J=0\relax% - \catcode`\X=1\relax% - \catcode`\Y=2\relax% - \def\HLComment##1{##1}% - \def\HLEmph##1{##1}% - \def\HLTeletype##1{##1}% - \def\HLReverse##1{##1}% - #1 -\end{minipage}% -\@tempdimb=\textwidth -\advance\@tempdimb -\FV@XRightMargin -\advance\@tempdimb 5mm -\begin{minipage}[c]{\@tempdimb} - \VerbatimInput[gobble=0,commentchar=Z,commandchars=JXY, - numbersep=3pt,frame=single,numbers=left, - xleftmargin=5mm,xrightmargin=0pt]{\jobname.tmp} -\end{minipage}} - -\makeatother - -% Example environments are numbered, framed and indented by 2 spaces -\fvset{gobble=2,frame=single,fontfamily=tt,numbers=left,numbersep=3pt} - -% Default PSTricks parameters -\psset{dimen=middle} - -% Translation in PSTricks from the one drawn by Emmanuel Chailloux and -% Guy Cousineau for the MLgraph system -% (see /ftp.ens.fr:/pub/unix/lang/MLgraph/version-2.1/MLgraph-refman.ps.gz) -% The kangaroo itself is reproduce from an original picture from Raoul Raba -\newcommand{\DimX}{2.47} -\newcommand{\DimY}{4.8} -\newcommand{\DimXDivTwo}{1.235} - -\newcommand{\KangarooItself}[1]{% -% Body -\pspolygon[fillstyle=solid,fillcolor=#1]% - (52.5,68)(55,72.5)(55.8,76.5)(56.8,79.8)(58.2,83)(60,85.8)(61.5,86.5) - (64,87)(66,87.5)(67.8,87.3)(70,87)(71.5,87.3)(73,88)(74.7,88.5) - (76,90.3)(77,91.5)(72.8,93.8)(69,96)(64.5,99)(59.4,103)(56.2,106.3) - (53,110.5)(49.5,115.5)(47.2,119.9)(45.7,126)(43.2,123)(41.5,121)(37.5,125) - (37,122.5)(36.8,120)(37,117)(37.6,113.5)(38.6,110)(40,106.3)(42,102.3) - (43.5,99.5)(45,97)(46.2,94)(46.8,91.7)(47.2,88)(47,83.5)(46.3,80.8) - (45.3,78.5)(42.5,76.5)(39.5,75.8)(36,75.9)(33,75.9)(29,76.2)(26,77) - (22.3,77.5)(18,78.4)(12.8,79.3)(8.6,80)(5.5,80.3)(3,80.5)(0,80) - (-5.2,78.5)(-9,76.3)(-11.2,74.8)(-13,72.5)(-16.5,68)(-16.5,68)(-19.5,62.5) - (-22,58)(-25.5,53)(-29,48.5)(-32.5,45)(-36,42)(-39,39.5)(-44,37) - (-49,35)(-51,34)(-53.5,34.5)(-55.5,36)(-56.5,38)(-56.5,40.5)(-55,41.5) - (-53.5,41)(-51.5,41)(-50.5,43)(-50.5,44.5)(-51,47)(-51.5,47.2)(-56.5,47) - (-58.5,46.5)(-60,44.7)(-62,42.3)(-63,39.5)(-63.5,36.3)(-63.5,33)(-63.1,29.5) - (-61.5,26)(-58,23.6)(-54,22.2)(-50.7,22)(-47.5,22)(-44.5,22.3)(-41,23.5) - (-36.8,25.8)(-33,28)(-28.5,31)(-23.4,35)(-20.2,38.3)(-17,42.5)(-13.5,47.5) - (-11.2,51.9)(-9.7,58)(-7.2,55)(-5.5,53)(-1.5,57)(-1,54.5)(-0.8,52) - (-1,49)(-1.6,45.5)(-2.6,42)(-4,38.3)(-6,34.3)(-7.5,31.5)(-9,29) - (-10.2,26)(-10.8,23.7)(-11.2,20)(-11,15.5)(-10.3,12.8)(-9.3,10.5)(-6.5,8.5) - (-3.5,7.8)(0,7.9)(3,7.9)(7,8.2)(10,9)(13.7,9.5)(18,10.4) - (23.2,11.3)(27.4,12)(30.5,12.3)(33,12.5)(36,12)(41.2,10.5)(45,8.3) - (47.2,6.8)(49,4.5)(52.5,0)(50,4.5)(49.2,8.5)(48.2,11.8)(46.8,15) - (45,17.8)(43.5,18.5)(41,19)(39,19.5)(37.2,19.3)(35,19)(33.5,19.3) - (32,20)(30.3,20.5)(29,22.3)(28,23.5)(28,23.5)(24.5,22.3)(21.5,22) - (18.3,22)(15,22.2)(11,23.6)(7.5,26)(5.9,29.5)(5.5,33)(5.5,36.3) - (6,39.5)(7,42.3)(9,44.7)(10.5,46.5)(12.5,47)(17.5,47.2)(18,47) - (18.5,44.5)(18.5,43)(17.5,41)(15.5,41)(14,41.5)(12.5,40.5)(12.5,38) - (13.5,36)(15.5,34.5)(18,34)(20,35)(25,37)(30,39.5)(33,42) - (36.5,45)(40,48.5)(43.5,53)(47,58)(49.5,62.5)(52.5,68) -% Eye -\pscircle*[linecolor=white](58.2,98.3){2\psxunit} -\pscircle*(58.2,97.3){\psxunit} -% Mouth -\psline(71.5,88)(70,89.3)(68.5,90.3)(67,91.9) -% Tear -\psline(42,121)(45,118)(47,115.3)(48.5,112.7)(50,110)(51.8,106.5) - (52.5,103.7)(53,100.5) -\pspolygon(41.2,115.8)(43.2,114.7)(45,112.5)(47,109.8)(48,107)(49.5,104.2) - (50.5,101.6)(51,98.5)(47.7,100.6)(46,102.2)(44.8,104)(43.5,106) - (42.5,108)(41.7,110.5)(41,113.2) -} - -\newcommand{\Kangaroo}[1]{% -\begin{pspicture}(\DimX,\DimY) -\psset{unit=0.035278} -\KangarooItself{#1} -\end{pspicture}} - -\newcommand{\KangarooPstChart}[1]{{% -\psset{xunit=0.006784,yunit=0.00735,linewidth=0.01} -\begin{pspicture}(-65.5,0)(82,126) -\KangarooItself{#1} -\end{pspicture}}} - -\begin{document} - -\title{\FillPackage\\A PSTricks package for filling and tiling areas} -\author{Timothy van \textsc{Zandt}\thanks{INSEAD, -Economics and Political Science, Fontainebleau, France --- -\mbox{\texttt{<tvz@econ.insead.fr>}}.}\hspace{2mm}{\small (documentation by -Denis \textsc{Girou}\thanks{CNRS/IDRIS --- Centre National de la Recherche -Scientifique / Institut du D\'eveloppement et des Ressources en Informatique -Scientifique, Orsay , France --- \mbox{\texttt{<Denis.Girou@idris.fr>}}.}% -\hspace{1.5mm})}} - -\date{\shortstack{December 12, 1997 --- Version 97 patch 2\\ - {\small Documentation revised June 30, 2000}}} -\maketitle - -\begin{center} -\psframebox[framearc=0.3,framesep=5mm,linewidth=0.7mm]{% - \parbox{11cm}{% - {\Large\textbf{Abstract}}: - \FillPackage{} is a PSTricks \cite{vanZandt93}, \cite{Girou94}, - \cite{vanZandtGirou94}, \cite{Hoenig97}, \cite{LGC97} package to draw easily - various kinds of filling and tiling of areas. It is also a good example of - the great power and flexibility of PSTricks, as in fact it is a very short - program (it body is around 200~lines long) but nevertheless really powerful. - - \hspace{5mm} It was written in 1994 by Timothy \textsc{van Zandt} but - publicly available only in PSTricks 97 and without any documentation. - We describe here the version \emph{97 patch 2} of December 12, 1997, which - is the original one modified by myself to manage \emph{tilings} in the - so-called \emph{automatic} mode. This article would like to serve both of - reference manual and of user's guide. - - \hspace{5mm} This package is available on \CTAN{} in the - \texttt{graphics/pstricks} directory (files \texttt{latex/pst-fill.sty} and - \texttt{generic/pst-fill.tex}). -}} -\end{center} - -\section{Introduction} - - Here we will refer as \emph{filling} as the operation which consist to fill -a defined area by a pattern (or a composition of patterns). We will refer as -\emph{tiling} as the operation which consist to do the same thing, but with -the control of the starting point, which is here the upper left corner. -The pattern is positioned relatively to this point. This make an essential -difference between the two modes, as without control of the starting point we -can't draw \emph{tilings} (sometimes called \emph{tesselations}) as used in -many fields of Art and Science% -\footnote{For an extensive presentation of tilings, in their history and usage -in many fields, see the reference book \cite{GS87}. - - In the \TeX{} world, few work was done on tilings. You can look at the -\emph{tile} extension of the \XYpic{} package \cite{XYpic}, at the articles of -Kees \textsc{van der Laan} \cite[paragraph 7]{LAAN96} (the tiling was in -fact directly done in PostScript) and \cite{LAAN97}, at the \MP{} program -(available on \CTANref{Roegel}) by Denis \textsc{Roegel} for the -\textsc{Truchet} contest in 1995 \cite{EsperetGirou98} and at the \MP{} -package \cite{Bolek98} to draw patterns, which have a strong connection with -tilings.}. - - Nevertheless, as tilings are a wide and difficult field in mathematics, this -package is limited to simple ones, mainly \emph{monohedral} tilings with one -prototile (which can be composite, see section \ref{sec:KindTiles}). With some -experience and wiliness we can do more and obtained easily rather -sophisticated results, but obviously hyperbolic tilings like the famous -\textsc{Escher} ones or aperiodic tilings like the \textsc{Penrose} ones are -not in the capabilities of this package. For more complex needs, we must used -low level and more painfull technics, with the basic \cs{multido} -and \cs{multirput} macros. - -\section{Package history and description of it two different modes} - - As already said, this package was written in 1994 by Timothy \textsc{van -Zandt}. Two modes were defined, called respectively \emph{manual} and -\emph{automatic}. For both, the pattern is generated on contiguous positions in -a rather large area which include the region to fill, later cut to the -required dimensions by clipping mechanism. In the first mode, the pattern is -explicitely inserted in the PostScript file each time. In the second one, the -result is the same but with an unique explicit insertion of the pattern and a -repetition done by PostScript. Nevertheless, in this method, the control of -the starting point was loosed, so it allowed only to \emph{fill} a region and -not to \emph{tile} it. - - See the difference between the two modes, \emph{tiling}: -{\psset{unit=0.5} - \psboxfill{\begin{pspicture}(1,1)\psframe[dimen=middle](1,1)\end{pspicture}} - \begin{pspicture}(3,3.3) - \psframe[fillstyle=boxfill](3,3) - \end{pspicture} -} -and \emph{filling}: -{% - \makeatletter -\pst@def{BoxFill}<% - gsave - gsave \tx@STV CM grestore dtransform CM idtransform - abs /h ED abs /w ED - pathbbox - h div round 2 add cvi /y2 ED - w div round 2 add cvi /x2 ED - h div round 2 sub cvi /y1 ED - w div round 2 sub cvi /x1 ED - /y2 y2 y1 sub def - /x2 x2 x1 sub def - CP - y1 h mul sub neg /y1 ED - x1 w mul sub neg /x1 ED - clip - y2 { - /x x1 def - x2 { - save CP x y1 T moveto Box restore - /x x w add def - } repeat - /y1 y1 h add def - } repeat - currentpoint currentfont grestore setfont moveto> - \makeatother -% - \psset{unit=0.5} - \psboxfill{\begin{pspicture}(1,1)\psframe[dimen=middle](1,1)\end{pspicture}} - \begin{pspicture}(3,3.3) - \psframe[fillstyle=boxfill](3,3) - \end{pspicture} - or - \begin{pspicture}(3,3.3) - \psframe[fillstyle=boxfill](3,3) - \end{pspicture} -} -as we can see that initial position is arbitrary and dependent of -the current point. - - It's clear that usage of filling is very restrictive comparing to tiling, -as desired effects required very often the possibility to control the starting -point. So, this mode was of limited interest, but unfortunately the -\emph{manual} one has the very big disadvantage to require very huge amounts -of ressources, mainly in disk space and consequently in printing time. -A small tiling can require sometimes several megabytes in \emph{manual} mode! -So, it was very often not really usable in practice. - -It is why I modified the code, to allow tilings in \emph{automatic} mode, -controlling in this mode too the starting point. And most of the time, that is -to say if some special options are not used, the tiling is done exactly in the -region described, which make it faster. So there is no more reason to use the -\emph{manual} mode, apart very special cases where \emph{automatic} one cannot -work, as explained later -- currently, I know only one case. - - To load this modified \emph{automatic} mode, with \LaTeX{} use -simply:\newline -\verb+\usepackage[tiling]{pst-fill}+\newline -and in plain \TeX{} after:\newline -\verb+\input{pst-fill}+\newline -add the following definition:\newline -\verb+\def\PstTiling{true}+ - - To obtain the original behaviour, just don't use the \emph{tiling} optional -keyword at loading. - - Take care than in \emph{tiling} mode, I introduce also some other changes. -First I define aliases on some parameter names for consistancy (all specific -parameters will begin by the \texttt{fill} prefix in this case) and I change -some default values, which were not well adapted for tilings (\texttt{fillsep} -is set to 0 and as explained \texttt{fillsize} set to \texttt{auto}). I rename -\texttt{fillcycle} to \texttt{fillcyclex}. I also restore normal way so that -the frame of the area is drawn and all line (\texttt{linestyle}, -\texttt{linecolor}, \texttt{doubleline}, etc.) parameters are now active (but -there are not in non \emph{tiling} mode). And I also introduce new parameters -to control the tilings (see below). - - \textbf{In all the following examples, we will consider only the -\emph{tiling} mode.} - -{\fvset{commandchars=JXY} - To do a tiling, we have just to define the pattern with the -\Verb+JHLReverseX\psboxfillY+ macro and to use the new \texttt{fillstyle} -\Verb+JHLReverseXboxfillY+. - - Note that tilings are drawn from left to right and top to bottom, which can -have an importance in some circonstances. - - PostScript programmers can be also interested to know that, even in the -\emph{automatic} mode, the iterations of the pattern are managed directly by -the PostScript code of the package which used only PostScript Level 1 -operators. The special ones introduced in Level 2 for drawing of patterns -\cite[section 4.9]{PostScript95} are not used. - - And first, for conveniance, we define a simple \cs{Tiling} macro, which -will simplify our examples: - -\begin{Verbatim} - \newcommand{\Tiling}[JHLEmphX2Y][]{% - \edef\Temp{JHLEmphX#1Y}% - \begin{pspicture}JHLEmphX#2Y - \ifx\Temp\empty - \psframe[fillstyle=JHLEmphXboxfillY]JHLEmphX#2Y - \else - \psframe[fillstyle=JHLEmphXboxfillY,JHLEmphX#1Y]JHLEmphX#2Y - \fi - \end{pspicture}} -\end{Verbatim} -} - -\newcommand{\Tiling}[2][]{% - \edef\Temp{#1}% - \begin{pspicture}#2 - \ifx\Temp\empty - \psframe[fillstyle=boxfill]#2 - \else - \psframe[fillstyle=boxfill,#1]#2 - \fi - \end{pspicture}} - -\subsection{Parameters} - - There are \textbf{14} specific parameters available to change the way the -filling/tiling is defined, and one debugging option. - -\begin{Description}{2cm} - \item [\HLTeletype{fillangle} (real)\hfill :] the value of the rotation - applied to the patterns (\emph{Default:~0}). -\end{Description} - - In this case, we must force the tiling area to be notably larger than the -area to cover, to be sure that the defined area will be covered after rotation. - -\begin{CenterExample} - \newcommand{\Square}{% - \begin{pspicture}(1,1) - \psframe[dimen=middle](1,1) - \end{pspicture}} - - \psset{unit=0.5} - \psboxfill{\Square} - \Tiling[JHLEmphXfillangleY=JHLReverseX45Y]{(3,3)}\hspace{3cm} - \Tiling[JHLEmphXfillangleY=JHLReverseX-60Y]{(3,3)} -\end{CenterExample} - -\newcommand{\Square}{% -\begin{pspicture}(1,1)\psframe[dimen=middle](1,1)\end{pspicture}} - -\begin{Description}{2cm} - \setcounter{footnote}{1} - \item [\HLTeletype{fillsepx} (real$|$dim)\hfill :] value of the horizontal - separation between consecutive patterns (\emph{Default:~0 for - tilings\footnotemark, 2pt otherwise}). \footnotetext{This option was added - by me, is not part of the original package and is available only if the - \texttt{tiling} keyword is used when loading the package.} - \setcounter{footnote}{1} - \item [\HLTeletype{fillsepy} (real$|$dim)\hfill :] value of the vertical - separation between consecutive patterns (\emph{Default:~0 for - ti\-lings\footnotemark, 2pt otherwise}). - \setcounter{footnote}{1} - \item [\HLTeletype{fillsep} (real$|$dim)\hfill :] value of horizontal and - vertical separations between consecutive patterns (\emph{Default:~0 for - tilings\footnotemark, 2pt otherwise}). -\end{Description} - - These values can be negative, which allow the tiles to overlap. - -\fvset{xrightmargin=0cm} -\begin{CenterExample} - \psset{unit=0.5} - \psboxfill{\Square} - \Tiling[JHLEmphXfillsepxY=JHLReverseX2mmY]{(3,3)}\hfill - \Tiling[JHLEmphXfillsepyY=JHLReverseX1mmY]{(3,3)}\hfill - \Tiling[JHLEmphXfillsepY=JHLReverseX0.5Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillsepY=JHLReverseX-0.5Y]{(3,3)} -\end{CenterExample} - -\begin{Description}{2cm} - \item [\HLTeletype{fillcyclex}\footnotemark\ (integer)\hfill :] Shift - coefficient applied to each row (\emph{Default:~0}). - \footnotetext{It was \texttt{fillcycle} in the original version.} - \setcounter{footnote}{1} - \item [\HLTeletype{fillcycley}\footnotemark\ (integer)\hfill :] Same thing for - columns (\emph{Default:~0}). - \setcounter{footnote}{1} - \item [\HLTeletype{fillcycle}\footnotemark\ (integer)\hfill :] Allow to fix - both \texttt{fillcyclex} and \texttt{fillcycley} directly to the same value - (\emph{Default:~0}). -\end{Description} - - For instance, if \texttt{fillcyclex} is 2, the second row of patterns will -be horizontally shifted by a factor of $\frac{1}{2}=0.5$, and by a factor of -0.333 if \texttt{fillcyclex} is 3, etc.). These values can be negative. - -\begin{CenterExample} - \psset{unit=0.5} - \psboxfill{\Square} - \newcommand{\TilingA}[1]{\Tiling[JHLEmphXfillcyclexY=JHLReverseX#1Y]{(3,3)}} - - \TilingA{JHLReverseX0Y}\hfill\TilingA{JHLReverseX1Y}\hfill\TilingA{JHLReverseX2Y}\hfill\TilingA{JHLReverseX3Y} - - \vspace{3mm} - \TilingA{JHLReverseX4Y}\hfill\TilingA{JHLReverseX5Y}\hfill\TilingA{JHLReverseX6Y}\hfill\TilingA{JHLReverseX-3Y} - - \vspace{3mm} - \Tiling[JHLEmphXfillcycleyY=JHLReverseX2Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillcycleyY=JHLReverseX3Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillcycleyY=JHLReverseX-3Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillcycleY=JHLReverseX2Y]{(3,3)}\hfill -\end{CenterExample} - -\begin{Description}{2cm} - \setcounter{footnote}{1} - \item [\HLTeletype{fillmovex}\footnotemark\ (real$|$dim)\hfill :] value of the - horizontal moves between consecutive patterns (\emph{Default:~0}). - \setcounter{footnote}{1} - \item [\HLTeletype{fillmovey}\footnotemark\ (real$|$dim)\hfill :] value of the - vertical moves between consecutive patterns (\emph{Default:~0}). - \setcounter{footnote}{1} - \item [\HLTeletype{fillmove}\footnotemark\ (real$|$dim)\hfill :] value of - horizontal and vertical moves between consecutive patterns - (\emph{Default:~0}). -\end{Description} - - These parameters allow the patterns to overlap and to draw some special -kinds of tilings. They are implemented only for the \emph{automatic} and -\emph{tiling} modes and their values can be negative. - - In some cases, the effect of these parameters will be the same that with the -\texttt{fillcycle?} ones, but you can see that it is not true for some other -values. - -\begin{CenterExample} - \psset{unit=0.5} - \psboxfill{\Square} - \Tiling[JHLEmphXfillmovexY=JHLReverseX0.5Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillmoveyY=JHLReverseX0.5Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillmoveY=JHLReverseX0.5Y]{(3,3)}\hfill - \Tiling[JHLEmphXfillmoveY=JHLReverseX-0.5Y]{(3,3)} -\end{CenterExample} - -\begin{Description}{2cm} - \item [\HLTeletype{fillsize} - (auto$|$\{(real$|$dim,real$|$dim)(real$|$dim,real$|$dim)\}) :] The - choice of \emph{automatic} mode or the size of the area in \emph{manual} - mode. If first pair values are not given, (0,0) is used. (\emph{Default: - auto when \emph{tiling} mode is used, {(-15cm,-15cm)(15cm,15cm)} - otherwise}). -\end{Description} - - As explained in the introduction, the \emph{manual} mode can require very -huge amount of computer ressources. So, it usage is to discourage in front off -the \emph{automatic} mode. It seems only useful in special circonstances, in -fact when the \emph{automatic} mode failed, which is known only in one case, -for some kinds of EPS files, as the ones produce by dump of portions of -screens (see \ref{sec:GraphicFiles}). - -\begin{Description}{2cm} - \setcounter{footnote}{1} - \item [\HLTeletype{fillloopaddx}\footnotemark\ (integer)\hfill :] number of - times the pattern is added on left and right positions (\emph{Default:~0}). - \setcounter{footnote}{1} - \item [\HLTeletype{fillloopaddy}\footnotemark\ (integer)\hfill :] number of - times the pattern is added on top and bottom positions (\emph{Default:~0}). - \setcounter{footnote}{1} - \item [\HLTeletype{fillloopadd}\footnotemark\ (integer)\hfill :] number of - times the pattern is added on left, right, top and bottom positions - (\emph{Default:~0}). -\end{Description} - - These parameters are only useful in special circonstances, as for complex -patterns when the size of the rectangular box used to tile the area doesn't -correspond to the pattern itself (see an example in Figure~\ref{fig:Sheeps}) -and also sometimes when the size of the pattern is not a divisor of the size -of the area to fill and that the number of loop repeats is not properly -computed, which can occur. - - They are implemented only for the \emph{tiling} mode. - -\begin{Description}{2cm} - \setcounter{footnote}{1} - \item [\HLTeletype{PstDebug}\footnotemark\ (integer, 0 or 1)\hfill :] to - require to see the exact tiling done, without clipping (\emph{Default:~0}). -\end{Description} - - It's mainly useful for debugging or to understand better how the tilings -are done. It is implemented only for the \emph{tiling} mode. - -\begin{CenterExample} - \psset{unit=0.3,JHLEmphXPstDebugY=JHLReverseX1Y} - \psboxfill{\Square} - \psset{linewidth=1mm} - \vspace{0.8cm} - \Tiling{(2,2)}\hspace{3cm} - \Tiling[fillcyclex=JHLEmphX2Y]{(2,2)}\hspace{4cm} - \Tiling[fillmove=JHLEmphX0.5Y]{(2,2)} -\end{CenterExample} - -\vspace{1cm} -\section{Examples} - - In fact this unique \cs{psboxfill} macro allow a lot a variations and -different usages. We will try here to demonstrate this. - -\subsection{Kind of tiles} -\label{sec:KindTiles} - - Of course, we can access to all the power of PSTricks macros to define the -\emph{tiles} (\emph{patterns}) used. So, we can define complicated ones. - - Here we give four other Archimedian tilings (those built with only some -regular polygons) among the twelve existing, first discovered completely by -Johanes \textsc{Kepler} at the beginning of 17th century \cite{GS87}, the two -other \emph{regular} ones with the tiling by squares, formed by a unique -regular polygon, and two other formed by two different regular polygons. - -\begin{CenterExample} - \newcommand{\Triangle}{% - \begin{pspicture}(1,1) - \pstriangle[dimen=middle](0.5,0)(1,1) - \end{pspicture}} - \newcommand{\Hexagon}{% - % JHLCommentXsin(60)=0.866Y - \begin{pspicture}(0.866,0.75) - \SpecialCoor - % JHLCommentXHexagonY - \pspolygon[dimen=middle] - (0.5;30)(0.5;90)(0.5;150)(0.5;210)(0.5;270)(0.5;330) - \end{pspicture}} - - \psset{unit=0.5} - \psboxfill{JHLReverseX\TriangleY} - \Tiling{(4,4)}\hfill - % JHLCommentXThe two other regular tilingsY - \Tiling[fillcyclex=JHLEmphX2Y]{(4,4)}\hfill - \psboxfill{JHLReverseX\HexagonY} - \Tiling[fillcyclex=JHLEmphX2Y,fillloopaddy=JHLEmphX1Y]{(5,5)} -\end{CenterExample} - -\begin{CenterExample} - \newcommand{\ArchimedianA}{% - % JHLCommentXArchimedian tiling 3^2.4.3.4Y - \psset{dimen=middle} - % JHLCommentXsin(60)=0.866Y - \begin{pspicture}(1.866,1.866) - \psframe(1,1) - \psline(1,0)(1.866,0.5)(1,1)(0.5,1.866)(0,1)(-0.866,0.5) - \psline(0,0)(0.5,-0.866) - \end{pspicture}} - \newcommand{\ArchimedianB}{% - % JHLCommentXArchimedian tiling 4.8^2Y - \psset{dimen=middle,unit=1.5} - % JHLCommentXsin(22.5)=0.3827 ; cos(22.5)=0.9239Y - \begin{pspicture}(1.3066,0.6533) - \SpecialCoor - % JHLCommentXOctogonY - \pspolygon(0.5;22.5)(0.5;67.5)(0.5;112.5)(0.5;157.5) - (0.5;202.5)(0.5;247.5)(0.5;292.5)(0.5;337.5) - \end{pspicture}} - - \psset{unit=0.5} - \psboxfill{JHLReverseX\ArchimedianAY} - \Tiling[fillmove=JHLEmphX0.5Y]{(7,7)}\hfill - \psboxfill{JHLReverseX\ArchimedianBY} - \Tiling[fillcyclex=JHLEmphX2Y,fillloopaddy=JHLEmphX1Y]{(7,7)} -\end{CenterExample} - - \setcounter{footnote}{3} - We can of course tile an area arbitrarily defined. And with the -\texttt{addfillstyle} parameter\footnote{Introduced in PSTricks 97.}, we can -easily mix the \texttt{boxfill} style with another one. - -\begin{CenterExample} - \psset{unit=0.5,dimen=middle} - \psboxfill{% - \begin{pspicture}(1,1) - \psframe(1,1) - \pscircle(0.5,0.5){0.25} - \end{pspicture}} - \begin{pspicture}(4,6) - \pspolygon[fillstyle=JHLEmphXboxfillY,fillsep=JHLEmphX0.25Y] - (0,1)(1,4)(4,6)(4,0)(2,1) - \end{pspicture} - \hspace{2cm} - \begin{pspicture}(4,4) - \pscircle[linestyle=none,fillstyle=solid,fillcolor=yellow, - JHLReverseXaddfillstyleY=JHLEmphXboxfillY,fillsep=JHLEmphX0.5Y](2,2){2} - \end{pspicture} -\end{CenterExample} - - Various effects can be obtained, sometimes complicated ones very easily, as -in this example reproduced from one shown by Slavik \textsc{Jablan} in the -field of \emph{OpTiles}, inspired by the \emph{Op-art}: - -\begin{CenterExample} - \newcommand{\ProtoTile}{% - \begin{pspicture}(1,1) - % JHLCommentX1/12=0.08333Y - \psset{linestyle=none,linewidth=0, - hatchwidth=0.08333\psunit,hatchsep=0.08333\psunit} - \psframe[fillstyle=solid,fillcolor=black, - addfillstyle=hlines,hatchcolor=white](1,1) - \pswedge[fillstyle=solid,fillcolor=white, - addfillstyle=hlines]{1}{0}{90} - \end{pspicture}} - - \newcommand{\BasicTile}{% - \begin{pspicture}(2,1) - \rput[lb](0,0){\ProtoTile} - \rput[lb](1,0){\rotateleft{\ProtoTile}} - \end{pspicture}} - - \ProtoTile\hfill\BasicTile\hfill - \psboxfill{\BasicTile} - \Tiling[fillcyclex=JHLEmphX2Y]{(4,4)} -\end{CenterExample} - - It is also directly possible to surimpose several different tilings. Here is -the splendid visual proof of the \textsc{Pytha\-gore} theorem done by the arab -mathematician \textsc{Annairizi} around the year 900, given by superposition -of two tilings by squares of different sizes. - -\fvset{xrightmargin=0cm} -\begin{CenterExample} - \psset{unit=1.5,dimen=middle} - \begin{pspicture*}(3,3) - \psboxfill{\begin{pspicture}(1,1) - \psframe(1,1) - \end{pspicture}} - \psframe[fillstyle=boxfill](3,3) - \psboxfill{\begin{pspicture}(1,1) - \rput{-37}{\psframe[linecolor=red](0.8,0.8)} - \end{pspicture}} - \psframe[fillstyle=boxfill](3,4) - \pspolygon[fillstyle=hlines,hatchangle=90](1,2)(1.64,1.53)(2,2) - \end{pspicture*} -\end{CenterExample} - - In a same way, it is possible to build tilings based on figurative patterns, -in the style of the famous \textsc{Escher} ones. Following an example of -Andr\'e \textsc{Deledicq} \cite{Deledicq97}, we first show a simple tiling of -the \emph{p1} category (according to the international classification of the -17~symmetry groups of the plane first discovered by the russian -crystalographer Jevgraf \textsc{Fedorov} at the end of the 19th century): - -\begin{CenterExample} - \newcommand{\SheepHead}[1]{% - \begin{pspicture}(3,1.5) - \pscustom[liftpen=2,fillstyle=solid,fillcolor=#1]{% - \pscurve(0.5,-0.2)(0.6,0.5)(0.2,1.3)(0,1.5)(0,1.5) - (0.4,1.3)(0.8,1.5)(2.2,1.9)(3,1.5)(3,1.5)(3.2,1.3) - (3.6,0.5)(3.4,-0.3)(3,0)(2.2,0.4)(0.5,-0.2)} - \pscircle*(2.65,1.25){0.12\psunit} % JHLCommentXEyeY - \psccurve*(3.5,0.3)(3.35,0.45)(3.5,0.6)(3.6,0.4)% JHLCommentXMuzzleY - % JHLCommentXMouthY - \pscurve(3,0.35)(3.3,0.1)(3.6,0.05) - % JHLCommentXEarY - \pscurve(2.3,1.3)(2.1,1.5)(2.15,1.7) - \pscurve(2.1,1.7)(2.35,1.6)(2.45,1.4) - \end{pspicture}} - - \psboxfill{\psset{unit=0.5}\SheepHead{yellow}\SheepHead{cyan}} - \Tiling[fillcyclex=JHLEmphX2Y,fillloopadd=JHLEmphX1Y]{(10,5)} -\end{CenterExample} -\label{fig:Sheeps} - - Now a tiling of the \emph{pg} category (the code for the kangaroo itself is -too long to be shown here, but has no difficulties ; the kangaroo is reproduce -from an original picture from Raoul \textsc{Raba} and here is a translation in -PSTricks from the one drawn by Emmanuel \textsc{Chailloux} and Guy -\textsc{Cousineau} for their MLgraph system \cite{MLgraphTSI}): - -\begin{CenterExample} - \psboxfill{% - \psset{unit=0.4} - \Kangaroo{yellow}\Kangaroo{red}% - \Kangaroo{cyan}\Kangaroo{green}% - \psscalebox{-1 1}{% - \rput(1.235,4.8){% - \Kangaroo{green}\Kangaroo{cyan}% - \Kangaroo{red}\Kangaroo{yellow}}}} - \Tiling[fillloopadd=JHLEmphX1Y]{(10,6)} -\end{CenterExample} - - And here a \textsc{Wang} tiling \cite{Wang65}, \cite[chapter -11]{GS87}, based on very simple tiles of the form of a square and composed -of four colored triangles. Such tilings are built with only a matching color -constraint. Despite of it simplicity, it is an important kind of tilings, as -\textsc{Wang} and others used them to study the special class of -\emph{aperiodic} tilings, and also because it was shown that surprisingly this -tiling is similar to a \textsc{Turing} machine. - -\begin{CenterExample} - \newcommand{\WangTile}[4]{% - \begin{pspicture}(1,1) - \pspolygon*[linecolor=#1](0,0)(0,1)(0.5,0.5) - \pspolygon*[linecolor=#2](0,1)(1,1)(0.5,0.5) - \pspolygon*[linecolor=#3](1,1)(1,0)(0.5,0.5) - \pspolygon*[linecolor=#4](1,0)(0,0)(0.5,0.5) - \end{pspicture}} - - \newcommand{\WangTileA}{\WangTile{cyan}{yellow}{cyan}{cyan}} - \newcommand{\WangTileB}{% - \WangTile{yellow}{cyan}{cyan}{red}} - \newcommand{\WangTileC}{% - \WangTile{cyan}{red}{yellow}{yellow}} - - \newcommand{\WangTiles}[1][]{% - \begin{pspicture}(3,3) - \psset{ref=lb} - \rput(0,2){\WangTileB}% - \rput(1,2){\WangTileA}% - \rput(2,2){\WangTileC} - \rput(0,1){\WangTileC}% - \rput(1,1){\WangTileB}% - \rput(2,1){\WangTileA} - \rput(0,0){\WangTileA}% - \rput(1,0){\WangTileC}% - \rput(2,0){\WangTileB} - #1 - \end{pspicture}} - - \WangTileA\hfill\WangTileB\hfill\WangTileC\hfill - \WangTiles[{\psgrid[subgriddiv=0,gridlabels=0](3,3)}]\hfill - \psset{unit=0.4} - \psboxfill{JHLReverseX\WangTilesY} - \Tiling{(12,12)} -\end{CenterExample} - -\subsection{External graphic files} -\label{sec:GraphicFiles} - - We can also fill an arbitrary area with an external image. We have only, -as usual, to matter of the \emph{BoundingBox} definition if there is no one -provided or if it is not the accurate one, as for the well known -\texttt{tiger} picture part of the \texttt{ghostscript} distribution. - -\begin{CenterExample} - \psboxfill{% JHLCommentXStrangely require x1=x2...Y - \begin{pspicture}(0,1)(0,4.1) - \includegraphics[bb=17 176 560 74,width=3cm]{images/JHLReverseXtigerY} - \end{pspicture}} - \Tiling{(6,6.2)} -\end{CenterExample} - - Nevertheless, there are some special files for which the \emph{automatic} -mode doesn't work, specially for some files obtained by a screen dump, as in -the next example, where a picture was reduced before it conversion in the -\emph{Encapsulated PostScript} format by a screen dump utility. In this case, -usage of the \emph{manual} mode is the only alternative, at the price of the -real multiple inclusion of the EPS file. We must take care to specify the -correct \texttt{fillsize} parameter, because otherwise the default values are -large and will load the file many times, perhaps just really using few -occurrences as the other ones would be clipped... - -\begin{CenterExample} - \psboxfill{\includegraphics{images/JHLReverseXflowersY}} - \begin{pspicture}(8,4) - \psellipse[fillstyle=JHLEmphXboxfillY,fillsize={(8,4)}](4,2)(4,2) - \end{pspicture} -\end{CenterExample} - -\subsection{Tiling of characters} - - We can also use the \cs{psboxfill} macro to fill the interior of characters -for special effects like these ones: - -\begin{CenterExample} - \DeclareFixedFont{\bigsf}{T1}{phv}{b}{n}{4.5cm} - \DeclareFixedFont{\smallrm}{T1}{ptm}{m}{n}{3mm} - \psboxfill{\smallrm JHLReverseXSince 182 days...Y} - \begin{pspicture*}(8,4) - \centerline{% - \pscharpath[fillstyle=gradient,gradangle=-45, - gradmidpoint=0.5,addfillstyle=JHLEmphXboxfillY, - fillangle=JHLEmphX45Y,fillsep=JHLEmphX0.7mmY] - {\rput[b](0,0.1){\bigsf JHLReverseX2000Y}}} - \end{pspicture*} -\end{CenterExample} - -\begin{CenterExample} - \DeclareFixedFont{\mediumrm}{T1}{ptm}{m}{n}{2cm} - \psboxfill{% - \psset{unit=0.1,linewidth=0.2pt} - \Kangaroo{PeachPuff}\Kangaroo{PaleGreen}% - \Kangaroo{LightBlue}\Kangaroo{LemonChiffon}% - \psscalebox{-1 1}{% - \rput(1.235,4.8){% - \Kangaroo{LemonChiffon}\Kangaroo{LightBlue}% - \Kangaroo{PaleGreen}\Kangaroo{PeachPuff}}}} - % JHLCommentXA kangaroo of kangaroos...Y - \begin{pspicture}(8,2) - \pscharpath[linestyle=none,fillstyle=JHLEmphXboxfillY,fillloopadd=JHLEmphX1Y] - {\rput[b](4,0){\mediumrm JHLReverseXKangarooY}} - \end{pspicture} -\end{CenterExample} - -\subsection{Other kinds of usage} - - Other kinds of usage can be imagined. For instance, we can use tilings in a -sort of degenerated way to draw some special lines made by a unique or -multiple repeating patterns. But it can be only a special dashed line, as here -with three different dashes: - -\begin{CenterExample} - \newcommand{\Dashes}{% - \psset{dimen=middle} - \begin{pspicture}(0,-0.5\pslinewidth)(1,0.5\pslinewidth) - \rput(0,0){\psline(0.4,0)}% - \rput(0.5,0){\psline(0.2,0)}% - \rput(0.8,0){\psline(0.1,0)} - \end{pspicture}} - - \newcommand{\SpecialDashedLine}[3]{% - \psboxfill{#3} - \Tiling[linestyle=none] - {(#1,-0.5\pslinewidth)(#2,0.5\pslinewidth)}} - - \SpecialDashedLine{0}{7}{\Dashes} - - \psset{unit=0.5,linewidth=1mm,linecolor=red} - \SpecialDashedLine{0}{10}{\Dashes} -\end{CenterExample} - - It allow also to use special patterns in business graphics, as in the -following example generated by \texttt{PstChart}\footnote{A personal -development to draw business charts with PSTricks, not distributed.}. - -\vspace{3mm} -\begin{figure}[!ht] -\centering -\psset{unit=0.75} -% Generated by pstchart.sh version 0.21 (11/28/97) -{\psset{dimen=middle} -\psset{xunit=2,yunit=0.005} -\begin{pspicture}(-0.6,-200)(6.6,2300) - % Title - \rput(3,2200){\shortstack{Fantaisist repartition of kangaroos\\ - in the world (in thousands)}} - % Frame background - \psframe[fillstyle=solid,fillcolor=LemonChiffon](0,0)(6,2000) - % Graduations - \multido{\n=0+500}{5}{\rput[r](-0.12,\n){\psscalebox{0.8}{\n}}} - % Minor ticks - \multips(0,100)(0,100){19}{\psline[unit=4.8pt](1,0)} - \multips(6,100)(0,100){19}{\psline[unit=4.8pt](-1,0)} - % Major ticks - \multips(0,500)(0,500){3}{\psline[unit=9.6pt](1,0)} - \multips(6,500)(0,500){3}{\psline[unit=9.6pt](-1,0)} - % Lines from major ticks marks - \multips(0,500)(0,500){3}{\psline[linestyle=dotted,linewidth=0.6pt](6,0)} - % Drawing for the data - \psboxfill{\psset{unit=0.78\psxunit}\KangarooPstChart{red}} - \psframe[linestyle=none,fillstyle=boxfill,fillloopaddy=1](0.61,0)(1.39,1800) - \psboxfill{\psset{unit=0.78\psxunit}\KangarooPstChart{yellow}} - \psframe[linestyle=none,fillstyle=boxfill,fillloopaddy=1](1.61,0)(2.39,800) - \psboxfill{\psset{unit=0.78\psxunit}\KangarooPstChart{cyan}} - \psframe[linestyle=none,fillstyle=boxfill,fillloopaddy=1](2.61,0)(3.39,550) - \psboxfill{\psset{unit=0.78\psxunit}\KangarooPstChart{magenta}} - \psframe[linestyle=none,fillstyle=boxfill,fillloopaddy=1](3.61,0)(4.39,500) - \psboxfill{\psset{unit=0.78\psxunit}\KangarooPstChart{green}} - \psframe[linestyle=none,fillstyle=boxfill,fillloopaddy=1](4.61,0)(5.39,200) - % Bottom labels - \uput{0.2}[270]{0}(1,0){\psscalebox{0.7}{Oceania}} - \uput{0.2}[270]{0}(2,0){\psscalebox{0.7}{Africa}} - \uput{0.2}[270]{0}(3,0){\psscalebox{0.7}{Asia}} - \uput{0.2}[270]{0}(4,0){\psscalebox{0.7}{America}} - \uput{0.2}[270]{0}(5,0){\psscalebox{0.7}{Europe}} - % Frame box around the chart - \psframe[linestyle=solid](0,0)(6,2000) -\end{pspicture}} - \caption{Bar chart generated by PstChart, with bars filled by patterns} - \label{fig:PstChart} -\end{figure} - -\section{``Dynamic'' tilings} - - In some cases, tilings used non \emph{static} tiles, that is to say that the -\emph{prototile(s)}, even if unique, can have several forms, by instance -specified by different colors or rotations, not fixed before generation or -varying each time. - -\subsection{Lewthwaite-Pickover-Truchet tiling} - - We give here for example the so-called \emph{Truchet} tiling, which much be -in fact better called \emph{Lewthwaite-Pick\-over-Truchet (LPT)} tiling% -\footnote{For description of the context, history and references about -S\'ebastien \textsc{Truchet} and this tiling, see \cite{EsperetGirou98}.}. - - The unique prototile is only a square with two opposite circle arcs. -This tile has obviously two positions, if we rotate it from 90 degrees (see -the two tiles on the next figure). A \emph{LPT tiling} is a tiling with -randomly oriented LPT tiles. We can see that even if it is very simple in it -principle, it draw sophisticated curves with strange properties. - - Nevertheless, in the straightforward way \FillPackage{} does not work, -because the \cs{psboxfill} macro store the content of the tile used in a -\TeX{} box, which is static. So the calling to the random function is done -only one time, which explain that only one rotation of the tile is used for -all the tiling. It's only the one of the two rotations which could differ from -one drawing to the next one... - -% Truchet (Lewthwaite-Pickover-Truchet) tiling -% -------------------------------------------- - -\begin{CenterExample} - % JHLCommentXLPT prototileY - \newcommand{\ProtoTileLPT}{% - \psset{dimen=middle} - \begin{pspicture}(1,1) - \psframe(1,1) - \psarc(0,0){0.5}{0}{90} - \psarc(1,1){0.5}{-180}{-90} - \end{pspicture}} - - % JHLCommentXLPT tileY - \newcount\Boolean - \newcommand{\BasicTileLPT}{% - % JHLCommentXFrom random.tex by Donald ArseneauY - \setrannum{\Boolean}{0}{1}% - \ifnum\Boolean=0 - \ProtoTileLPT% - \else - \rotateleft{\ProtoTileLPT}% - \fi} - - \ProtoTileLPT\hfill\rotateleft{\ProtoTileLPT}\hfill - \psset{unit=0.5} - \psboxfill{JHLReverseX\BasicTileLPTY} - \Tiling{(5,5)} -\end{CenterExample} - - But, for simple cases, there is a solution to this problem using a mixture -of PSTricks and PostScript programming. Here the PSTricks -construction \verb+\pscustom{\code{...}}+ allow to insert PostScript code -inside the \LaTeX{} + PSTricks one. - - Programmation is less straightforward, but it has also the advantage to be -notably faster, as all the tilings operations are done in PostScript, and -mainly to not be limited by \TeX{} memory (the \TeX{} + PSTricks solution -I wrote in 1995 for the colored problem was limited to small sizes for this -reason). Just note also that \cs{pslbrace} and \cs{psrbrace} are two -PSTricks macros to define and be able to insert the \verb+{+ and \verb+}+ -characters. - -\begin{CenterExample} - % JHLCommentXLPT prototileY - \newcommand{\ProtoTileLPT}{% - \psset{dimen=middle} - \psframe(1,1) - \psarc(0,0){0.5}{0}{90} - \psarc(1,1){0.5}{-180}{-90}} - - % JHLCommentXCounter to change the random seedY - \newcount\InitCounter - - % JHLCommentXLPT tileY - \newcommand{\BasicTileLPT}{% - \InitCounter=\the\time - \pscustom{\code{% - rand \the\InitCounter\space sub 2 mod 0 eq \pslbrace}} - \begin{pspicture}(1,1) - \ProtoTileLPT - \end{pspicture}% - \pscustom{\code{\psrbrace \pslbrace}} - \rotateleft{\ProtoTileLPT}% - \pscustom{\code{\psrbrace ifelse}}} - - \psset{unit=0.4,linewidth=0.4pt} - \psboxfill{JHLReverseX\BasicTileLPTY} - \Tiling{(15,15)} -\end{CenterExample} - - Using the very surprising fact (see \cite{EsperetGirou98}) that -coloration of these tiles do not depend of their neighbors (even if it is -difficult to believe as the opposite seems obvious!) but only of the parity of -the value of row and column positions, we can directly program in the same way -a colored version of the LPT tiling. - -\setcounter{footnote}{1} - We have also introduce in the \FillPackage{} code for \emph{tiling} mode two -new accessible Post\-Script variables, \texttt{row} and -\texttt{column}\footnotemark, which can be useful in some circonstances, like -this one. - -\begin{CenterExample} - % JHLCommentXLPT prototileY - \newcommand{\ProtoTileLPT}[2]{% - \psset{dimen=middle,linestyle=none,fillstyle=solid} - \psframe[fillcolor=#1](1,1) - \psset{fillcolor=#2} - \pswedge(0,0){0.5}{0}{90} - \pswedge(1,1){0.5}{-180}{-90}} - - % JHLCommentXCounter to change the random seedY - \newcount\InitCounter - - % JHLCommentXLPT tileY - \newcommand{\BasicTileLPT}[2]{% - \InitCounter=\the\time - \pscustom{\code{% - rand \the\InitCounter\space sub 2 mod 0 eq \pslbrace - JHLReverseXrowY JHLReverseXcolumnY add 2 mod 0 eq \pslbrace}} - \begin{pspicture}(1,1) - \ProtoTileLPT{#1}{#2} - \end{pspicture}% - \pscustom{\code{\psrbrace \pslbrace}} - \ProtoTileLPT{#2}{#1}% - \pscustom{\code{% - \psrbrace ifelse \psrbrace \pslbrace JHLReverseXrowY JHLReverseXcolumnY add 2 mod - 0 eq \pslbrace}} - \rotateleft{\ProtoTileLPT{#2}{#1}}% - \pscustom{\code{\psrbrace \pslbrace}} - \rotateleft{\ProtoTileLPT{#1}{#2}}% - \pscustom{\code{\psrbrace ifelse \psrbrace ifelse}}} - - \psboxfill{JHLReverseX\BasicTileLPT{red}{yellow}Y} - \Tiling{(4,4)}\hfill - \psset{unit=0.4} - \psboxfill{JHLReverseX\BasicTileLPT{blue}{cyan}Y} - \Tiling{(15,15)} -\end{CenterExample} - - Another classic example is to generate coordinates and numerotation for a -grid. Of course, it is possible to do it directly in PSTricks using nested -\cs{multido} commands. It would be clearly easy to program, but, nevertheless, -for users who have a little knowledge of PostScript programming, this offer -an alternative which is useful for large cases, because on this way it will -be notably faster and less computer ressources consuming. - - Remember here that the tiling is drawn from left to right, and top to -bottom, and note that the PostScript variable \texttt{x2} give the total -number of columns. - -\begin{CenterExample} - % JHLCommentX\Escape will be the \ characterY - {\catcode`\!=0\catcode`\\=11!gdef!Escape{\}} - - \newcommand{\ProtoTile}{% - JHLReverseX\SquareY% - \pscustom{% - \moveto(-0.9,0.75) % In PSTricks units - \code{% - /Times-Italic findfont 8 scalefont setfont - (\Escape() show JHLReverseXrowY 3 string cvs show (,) show - JHLReverseXcolumnY 3 string cvs show (\Escape)) show} - \moveto(-0.5,0.25) % In PSTricks units - \code{% - /Times-Bold findfont 18 scalefont setfont - 1 0 0 setrgbcolor % Red color - /center {dup stringwidth pop 2 div neg 0 rmoveto} def - JHLReverseXrowY 1 sub x2 mul JHLReverseXcolumnY add 3 string cvs center show}}} - - \psboxfill{JHLReverseX\ProtoTileY} - \Tiling{(6,4)} -\end{CenterExample} - -\subsection{A complete example: the Poisson equation} - - To finish, we will show a complete real example, a drawing to explain the -method used to solve the \textsc{Poisson} equation by a domain -decomposition method, adapted to distributed memory computers. The -objective is to show the communications required between processes and the -position of the data to exchange. This code also show some useful and powerful -technics for PSTricks programming (look specially at the way some higher level -macros are defined, and how the same object is used to draw the four -neighbors). - -\begin{CenterExample} - \newcommand{\Pattern}[1]{% - \begin{pspicture}(-0.25,-0.25)(0.25,0.25) - \rput{*0}{\psdot[dotstyle=#1]} - \end{pspicture}} - - \newcommand{\West}{\Pattern{o}} - \newcommand{\South}{\Pattern{x}} - \newcommand{\Central}{\Pattern{+}} - \newcommand{\North}{\Pattern{square}} - \newcommand{\East}{\Pattern{triangle}} - - \newcommand{\Cross}{% - \pspolygon[unit=0.5,linewidth=0.2,linecolor=red] - (0,0)(0,1)(1,1)(1,2)(2,2)(2,1) - (3,1)(3,0)(2,0)(2,-1)(1,-1)(1,0)} - - \newcommand{\StylePosition}[1]{% - \LARGE\textcolor{red}{\textbf{#1}}} - - \newcommand{\SubDomain}[4]{% - \psboxfill{#4} - \begin{psclip}{\psframe[linestyle=none]#1} - \psframe[linestyle=#3](5,5) - \psframe[fillstyle=boxfill]#2 - \end{psclip}} - - \newcommand{\SendArea}[1]{% - \psframe[fillstyle=solid,fillcolor=cyan]#1} - - \newcommand{\ReceiveData}[2]{% - \psboxfill{#2} - \psframe[fillstyle=solid,fillcolor=yellow, - addfillstyle=boxfill]#1} - - \newcommand{\Neighbor}[2]{% - \begin{pspicture}(5,5) - \rput{*0}(2.5,2.5){\StylePosition{#1}} - \ReceiveData{(0.5,0)(4.5,0.5)}{\Central} - \SendArea{(0.5,0.5)(4.5,1)} - \SubDomain{(5,2)}{(0.5,0.5)(4.5,3)}{dashed}{#2}% - % JHLCommentXReceive and send arrowsY - \pcarc[arcangle=45,arrows=->](0.5,-1.25)(0.5,0.25) - \pcarc[arcangle=45,arrows=->,linestyle=dotted,dotsep=2pt] - (4.5,0.75)(4.5,-0.75) - \end{pspicture}} - - \psset{dimen=middle,dotscale=2,fillloopadd=JHLEmphX2Y} - \begin{pspicture}(-5.7,-5.7)(5.7,5.7) - % JHLCommentXCentral domainY - \rput(0,0){% - \begin{pspicture}(5,5) - % JHLCommentXReceive from West, East, North and SouthY - \ReceiveData{(0,0.5)(0.5,4.5)}{\West} - \ReceiveData{(4.5,0.5)(5,4.5)}{\East} - \ReceiveData{(0.5,4.5)(4.5,5)}{\North} - \ReceiveData{(0.5,0)(4.5,0.5)}{\South} - % JHLCommentXSend area for West, East, North and SouthY - \SendArea{(0.5,0.5)(1,4.5)} - \SendArea{(4,0.5)(4.5,4.5)} - \SendArea{(0.5,0.5)(4.5,1)} - \SendArea{(0.5,4)(4.5,4.5)} - % JHLCommentXCentral domainY - \SubDomain{(5,5)}{(0.5,0.5)(4.5,4.5)}{solid}{\Central} - % JHLCommentXRedraw overlapped linesY - \psline(1,0.5)(1,4.5) - \psline(4,0.5)(4,4.5) - % JHLCommentXTwo crossesY - \rput(1.5,4){\Cross} - \rput(2,2){\Cross} - \end{pspicture}} - % JHLCommentXThe four neighborsY - \rput(0,5.5){\Neighbor{N}{\North}} - \rput{-90}(5.5,0){\Neighbor{E}{\East}} - \rput{90}(-5.5,0){\Neighbor{W}{\West}} - \rput{180}(0,-5.5){\Neighbor{S}{\South}} - \end{pspicture} -\end{CenterExample} - -% Bibliography -\begin{thebibliography}{99} -\bibitem{PostScript95} Adobe, Systems~Incorporated, \emph{PostScript Language -Reference Manual}, Addison-Wesley, 2~edition, 1995. - -\bibitem{Bolek98} Piotr Bolek, \MP{} and patterns, \emph{\TUB}, Volume~19, -Number~3, pages 276--283, September 1998, \CTANref{mpattern}. - -\bibitem{MLgraphTSI} Emmanuel Chailloux, Guy Cousineau and Asc\'ander -Su\'arez, Programmation fonctionnelle de graphismes pour la production -d'illustrations techniques, \emph{Technique et science informatique}, -Volume~15, Number~7, pages 977--1007, 1996 (in french). - -\bibitem{Deledicq97} Andr\'e Deledicq, \emph{Le monde des pavages}, ACL -\'Editions, 1997 (in french). - -\bibitem{EsperetGirou98} Philippe Esperet and Denis Girou, -Coloriage du pavage dit de Truchet, Cahiers GUTenberg, Number~31, -pages 5--18, December~1998 (in french). - -\bibitem{Girou94} Denis Girou, Pr\'esentation de PSTricks, \emph{Cahiers -GUTenberg}, Number~16, pages 21--70, February~1994 (in french). - -\bibitem{LGC97} Michel Goossens, Sebastian Rahtz and Frank Mittelbach, -\emph{The \LaTeX{} Graphics Companion}, Addison-Wesley, 1997. - -\bibitem{GS87} Branko Gr\"unbaum and Geoffrey Shephard, \emph{Tilings and -Patterns}, Freeman and Company, 1987. - -\bibitem{Hoenig97} Alan Hoenig, \emph{\TeX{} Unbound: \LaTeX{} \& \TeX{} -Strategies, Fonts, Graphics, and More}, Oxford University Press, 1997. - -\bibitem{XYpic} Kristoffer~H. Rose and Ross Moore, \XYpic. Pattern and Tile -extension, available from \CTAN, 1991-1998, \CTANref{xypic}. - -\bibitem{LAAN96} Kees van der Laan, Paradigms: Just a little bit of PostScript, -\emph{MAPS}, Volume~17, pages 137--150, 1996. - -\bibitem{LAAN97} Kees van der Laan, Tiling in PostScript and \MF{} -- Escher's -wink, \emph{MAPS}, Volume~19, Number~2, pages 39--67, 1997. - -\bibitem{vanZandt93} Timothy van Zandt, PSTricks. PostScript macros for -Generic \TeX, available from \CTAN, 1993, \CTANref{pstricks}. - -\bibitem{vanZandtGirou94} Timothy van Zandt and Denis Girou, Inside PSTricks, -\emph{\TUB}, Volume~15, Number~3, pages 239--246, September 1994. - -\bibitem{Wang65} Hao Wang, Games, Logic and Computers, \emph{Scientific -American}, pages 98--106, November 1965. -\end{thebibliography} - -\end{document} diff --git a/Master/texmf-dist/doc/generic/pstricks/voss/CHANGES b/Master/texmf-dist/doc/generic/pstricks/voss/CHANGES deleted file mode 100644 index 123304833c0..00000000000 --- a/Master/texmf-dist/doc/generic/pstricks/voss/CHANGES +++ /dev/null @@ -1,79 +0,0 @@ -glossary.sty history: - - * Version 2.32: added \setacronymdescfmt. (Makes it - easier to align the list of acronyms with - acronym in one column and the long name in the - second column.) - - * Version 2.31: added global package option. Added - \unsetacronym and \unsetallacronyms. - - * Version 2.3: Made it easier to have multiple glossaries - with different styles within the same document. Added - facility for inserting text before and after the list of - page numbers. - - * Version 2.26: Fixed bug in \useacronym (optional argument - was ignored in certain situations). - - * Version 2.25: Minor bug fix (missing page delimiters). - - * Version 2.24: Added hypertoc option, and changed the - hyperlink targets in the glossary entries. - - * Version 2.23: Fixed bug in hyperlinks caused by \glsxspace. - - * Version 2.22: Added acronymfont. Added xspace support. - Changed makeglos.pl so that it reads information from - auxiliary file. Added makeglos.bat file - - * Version 2.21: Added \resetallacronyms - - * Version 2.2: \glossaryname is now defined using - \providecommand instead of \newcommand. Checks if - theglossary environment is already defined, and if so - redefines it and issues a warning. - - * Version 2.19: fixed bug in \storeglosentry. - - * Version 2.18: fixed bug in \useacronym. Added \gls. - - * Version 2.17: added acronym package option. Added - \storeglosentry (replacing old \saveglosentry command) - - * Version 2.16: fixed bug preventing changes to \glossaryname - and \shortglossary name from having an effect. - - * Version 2.15: added \shortglossaryname (for page header and - table of contents) - - * Version 2.14: added LaTeX2HTML support, added \xglossary - command (provides hyperlink to relevent entry in the - glossary), added -m switch to makeglos.pl (merges multiple - entries with the same name but different descriptions). - - * Version 2.13: added extra package option "hyperacronym". - - * Version 2.12: mostly bug fixes, also added extra package - option "section". - - * Version 2.11: starred form of acronym defined. Added - \useacronym. - - * Version 2.1: fixed conflict with array package. Fixed - problems which occured when using certain commands (such as - \cite) in the last argument of \newacronym. - - * Version 2.01: fixed conflict with datetime package. - - * Version 2.0: provides the command \newacronym to define - acronyms. Additional package options "toc" (add glossary to - table of contents) and "hyper" use hyperlinks in the - glossary. - - * Version 1.1: provides the additional package option - "number" which sets the associated glossary entry number to - the page number (default), the section number or no number. - Also provides the additional commands \glossarypreamble and - \glossarypostamble - diff --git a/Master/texmf-dist/doc/generic/pstricks/voss/README b/Master/texmf-dist/doc/generic/pstricks/voss/README deleted file mode 100644 index 02ace0f1aba..00000000000 --- a/Master/texmf-dist/doc/generic/pstricks/voss/README +++ /dev/null @@ -1,45 +0,0 @@ -LaTeX Package : glossary v 2.32
-
-Last Modified : 5th January 2006
-
-Author : Nicola Talbot
-
-Files : glossary.dtx - documented source file
- glossary.ins - installation script
-
-This package is provided to assist generating a glossary. It has
-a certain amount of flexibility allowing the user to customize the
-format of the glossary and define new glossary-style objects. It
-is also possible to define acronyms.
-
-To extract the code do:
-
-latex glossary.ins
-
-This will create the files glossary.sty, glossary.perl,
-makeglos.pl and some sample files. Move
-glossary.sty to a subdirectory of your local texmf tree
-(e.g. $LOCALTEXMF/tex/latex/contrib/) and glossary.perl
-to the LaTeX2HTML style files directory (e.g. latex2html/styles).
-The Perl script makeglos.pl provides an easy interface to
-makeindex for those who can't remember (or can't be bothered) all
-the required switches. See documentation for more details.
-
-To extract the documentation do:
-
-latex glossary.dtx
-makeindex -s gind.ist glossary
-makeindex -s gglo.ist -o glossary.gls glossary.glo
-latex glossary.dtx
-latex glossary.dtx
-
-Alternatively, if you use pdflatex instead of latex, the
-documentation will have hyperlinks. If you want documentation
-on the code, remove the line:
-\OnlyDescription
-
-This material 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.
-
-http://theoval.cmp.uea.ac.uk/~nlct/
-
diff --git a/Master/texmf-dist/doc/generic/pstricks/voss/bsp323.tex b/Master/texmf-dist/doc/generic/pstricks/voss/bsp323.tex index 2539a72a9e3..0ba1a4fe040 100644 --- a/Master/texmf-dist/doc/generic/pstricks/voss/bsp323.tex +++ b/Master/texmf-dist/doc/generic/pstricks/voss/bsp323.tex @@ -2,10 +2,10 @@ \usepackage{pstricks,pst-node,pst-grad,pst-math,multido} \SpecialCoor -\parindent0pt
-\pagestyle{empty}
-\begin{document}
-\centering
+\parindent0pt +\pagestyle{empty} +\begin{document} +\centering \psframebox[fillcolor=black!45,fillstyle=solid]{% \begin{pspicture*}(-6,0)(7,7.5) % dieser code wird irgendwann nach \pnode(0,0){O} % nach pst-optic wandern @@ -104,5 +104,5 @@ \psline[linecolor=white,linewidth=0.5mm](E1)(I1) \psline[linecolor=white,linewidth=0.5mm,arrowscale=2]{->}(E1)(!i1x E1x add 2 div i1y E1y add 2 div) \end{pspicture*}} -
-\end{document}
+ +\end{document} diff --git a/Master/texmf-dist/doc/generic/pstricks/voss/bsp342.tex b/Master/texmf-dist/doc/generic/pstricks/voss/bsp342.tex index ce4b8db0678..1b43f6f14e7 100644 --- a/Master/texmf-dist/doc/generic/pstricks/voss/bsp342.tex +++ b/Master/texmf-dist/doc/generic/pstricks/voss/bsp342.tex @@ -5,18 +5,18 @@ \pagestyle{empty} \begin{document} -\newcommand{\InitCond}{ 0 0 5 10}
-\newcommand{\OMEGA}{6.283185}
-\newcommand{\h}{0.1}
-\psset{unit=2}
-\begin{pspicture}[showgrid=true](0,-2)(3,1.2)
- \psset{method=rk4,algebraic=true,whichabs=0,whichord=1}
- \psplotDiffEqn[linecolor=red,linewidth=1pt,plotpoints=500]
- {0}{10}{\InitCond}{y[2]|y[3]|\OMEGA*y[3]-\h*(sqrt(y[2]^2+y[3]^2))*y[2]|-\OMEGA*y[2]-\h*(sqrt(y[2]^2+y[3]^2))*y[3]}
- \psline{->}(0.5,1)
- \uput[90](0.5,1){$\overrightarrow{v}_0$}
- \pscircle{0.1}\psdot(0,0)
- \uput{3mm}[180](0,0){$\overrightarrow{B}$}
+\newcommand{\InitCond}{ 0 0 5 10} +\newcommand{\OMEGA}{6.283185} +\newcommand{\h}{0.1} +\psset{unit=2} +\begin{pspicture}[showgrid=true](0,-2)(3,1.2) + \psset{method=rk4,algebraic=true,whichabs=0,whichord=1} + \psplotDiffEqn[linecolor=red,linewidth=1pt,plotpoints=500] + {0}{10}{\InitCond}{y[2]|y[3]|\OMEGA*y[3]-\h*(sqrt(y[2]^2+y[3]^2))*y[2]|-\OMEGA*y[2]-\h*(sqrt(y[2]^2+y[3]^2))*y[3]} + \psline{->}(0.5,1) + \uput[90](0.5,1){$\overrightarrow{v}_0$} + \pscircle{0.1}\psdot(0,0) + \uput{3mm}[180](0,0){$\overrightarrow{B}$} \end{pspicture} \end{document} diff --git a/Master/texmf-dist/doc/generic/pstricks/voss/manual.html b/Master/texmf-dist/doc/generic/pstricks/voss/manual.html deleted file mode 100644 index 6738db64ab0..00000000000 --- a/Master/texmf-dist/doc/generic/pstricks/voss/manual.html +++ /dev/null @@ -1,2871 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> - -<!--Converted with jLaTeX2HTML 2002-2-1 (1.70) JA patch-2.0 -patched version by: Kenshi Muto, Debian Project. -* modified by: Shige TAKENO -LaTeX2HTML 2002-2-1 (1.70), -original version by: Nikos Drakos, CBLU, University of Leeds -* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan -* with significant contributions from: - Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -<HTML> -<HEAD> -<TITLE>glossary.sty v 2.32: LaTeX2e Package to Assist Generating Glossaries</TITLE> -<META NAME="description" CONTENT="glossary.sty v 2.32: LaTeX2e Package to Assist Generating Glossaries"> -<META NAME="keywords" CONTENT="manual"> -<META NAME="resource-type" CONTENT="document"> -<META NAME="distribution" CONTENT="global"> - -<META NAME="Generator" CONTENT="jLaTeX2HTML v2002-2-1 JA patch-2.0"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> - - -</HEAD> - -<BODY > - -<P> - - <H1 ALIGN="CENTER">glossary.sty v 2.32: LaTeX2e Package to Assist Generating Glossaries</H1> -<DIV> - -<P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot</STRONG></P> -<P ALIGN="CENTER"><STRONG>5th January 2006</STRONG></P> -</DIV> -<BR> - -<H2><A NAME="SECTION00010000000000000000"> -Contents</A> -</H2> -<!--Table of Contents--> - -<UL> -<LI><A NAME="tex2html30" - HREF="manual.html#SECTION00020000000000000000">Introduction</A> -<LI><A NAME="tex2html31" - HREF="manual.html#SECTION00030000000000000000">Installation</A> -<LI><A NAME="tex2html32" - HREF="manual.html#SECTION00040000000000000000">Generating Glossary Information</A> -<UL> -<LI><A NAME="tex2html33" - HREF="manual.html#SECTION00041000000000000000">Storing Glossary Information</A> -</UL> -<BR> -<LI><A NAME="tex2html34" - HREF="manual.html#SECTION00050000000000000000">makeglos.pl</A> -<LI><A NAME="tex2html35" - HREF="manual.html#SECTION00060000000000000000">Displaying the Glossary</A> -<LI><A NAME="tex2html36" - HREF="manual.html#SECTION00070000000000000000">Package Options</A> -<UL> -<LI><A NAME="tex2html37" - HREF="manual.html#SECTION00071000000000000000">Examples</A> -</UL> -<BR> -<LI><A NAME="tex2html38" - HREF="manual.html#SECTION00080000000000000000">Defining New Glossary Types</A> -<LI><A NAME="tex2html39" - HREF="manual.html#SECTION00090000000000000000">Acronyms</A> -<UL> -<LI><A NAME="tex2html40" - HREF="manual.html#SECTION00091000000000000000">Examples</A> -</UL> -<BR> -<LI><A NAME="tex2html41" - HREF="manual.html#SECTION000100000000000000000">Customizing the Glossary</A> -<LI><A NAME="tex2html42" - HREF="manual.html#SECTION000110000000000000000">Sample Documents</A> -<LI><A NAME="tex2html43" - HREF="manual.html#SECTION000120000000000000000">LaTeX2HTML Style File</A> -<UL> -<LI><A NAME="tex2html44" - HREF="manual.html#SECTION000121000000000000000">Limitations</A> -</UL> -<BR> -<LI><A NAME="tex2html45" - HREF="manual.html#SECTION000130000000000000000">Troubleshooting</A> -<LI><A NAME="tex2html46" - HREF="manual.html#SECTION000140000000000000000">Obsolete Commands</A> -<LI><A NAME="tex2html47" - HREF="manual.html#SECTION000150000000000000000">Contact Details</A> -<LI><A NAME="tex2html48" - HREF="manual.html#SECTION000160000000000000000">Acknowledgements</A> -<LI><A NAME="tex2html49" - HREF="manual.html#SECTION000170000000000000000">Index</A> -</UL> -<!--End of Table of Contents--> -<P> - -<H1><A NAME="SECTION00020000000000000000"> -Introduction</A> -</H1> - - The <TT>glossary</TT><A NAME="1591"></A> package is provided to assist -generating a glossary. It has a certain amount of flexibility, -allowing the user to customize the format of the glossary, and -define new glossary-style objects. - -<P> - -<H1><A NAME="SECTION00030000000000000000"> -Installation</A> -</H1> - -<P> -You need to make sure you have downloaded the following three -files: -<PRE> -glossary.ins -glossary.dtx -README -</PRE> -To extract the code from the <TT>glossary.dtx</TT> file, you -will need to run the installation file through LaTeX: -<PRE> -latex glossary.ins -</PRE> -This will create the following files: -<PRE> -glossary.sty -glossary.perl -makeglos.pl -makeglos.bat -</PRE> -along with several sample files. The file <TT>glossary.sty</TT> -should be placed somewhere in the LaTeX path, e.g. -<TT>texmf/tex/latex/glossary/</TT>. The file -<TT>glossary.perl</TT> is a LaTeX2HTML style file, and should -be placed in the LaTeX2HTML style file directory (usually -<TT>latex2html/styles/</TT>). The file <TT>makeglos.pl</TT> -is a Perl script which calls <TT>makeindex</TT><A NAME="1594"></A>. If you are -using UNIX or Linux, you will need to set the permissions so -that you can execute the file: -<PRE> -chmod a+x makeglos.pl -</PRE> -You should then place this file somewhere on your path. -(You may also need to edit the first line of -this file, if <TT>perl</TT><A NAME="1597"></A> is located in a directory other than <code>/usr/bin/</code><A NAME="tex2html1" - HREF="#foot1470"><SUP>1</SUP></A>.) - -<P> -If you are not using UNIX or Linux, you may have to explicitly -load the file into Perl, so you would need to do -<TT>perl makeglos.pl</TT> instead of just <TT>makeglos.pl</TT>. -If you are using Windows, a batch file, <TT>makeglos.bat</TT> -is provided which will run Perl on <TT>makeglos.pl</TT>. -Both <TT>makeglos.pl</TT> and <TT>makeglos.bat</TT> should -be placed somewhere specified by the PATH environment -variable. (For example, put them both in the same -directory as <TT>makeindex</TT><A NAME="1600"></A>, which will probably -be in <code>\texmf\miktex\bin\</code>). - -<P> -If you don't have Perl installed on your system, you can just use -<TT>makeindex</TT><A NAME="1603"></A>, only you will have to remember all the -command line switches, and you won't be able to merge entries -that have the same name, but different descriptions. - -<P> -Note that if you are updating the glossary package, it is -a good idea to update <TT>makeglos.pl</TT> as it may also -have been modified. - -<P> - -<H1><A NAME="SECTION00040000000000000000"> -Generating Glossary Information</A> -</H1> - -<P> -The standard LaTeX command <TT>\makeglossary</TT> (analogous to <TT>\makeindex</TT>) - should be placed in the document preamble. If this command -is omitted, glossary information will be ignored. Glossary -entries are generated using the command -<TT>\glossary</TT><code>{</code><I>key-val list</I><code>}</code>. - This command is a slightly modified version of the standard -<TT>\glossary</TT> command, in order to separate out the -information into <I>entry-name</I> and <I>entry-description</I>. -The argument to <TT>\glossary</TT> must be a comma-separated -list of <I>key</I>=<I>value</I> pairs. The following keys are -available: -<DIV ALIGN="CENTER"> -<TABLE CELLPADDING=3> -<TR><TH ALIGN="LEFT"><B>Key </B></TH> -<TH ALIGN="LEFT"><B>Value</B></TH> -</TR> -<TR><TD ALIGN="LEFT"><TT><TT>name</TT><A NAME="1616"></A> </TT></TD> -<TD ALIGN="LEFT">The entry name</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT><TT>description</TT><A NAME="1620"></A> </TT></TD> -<TD ALIGN="LEFT">A description about the entry</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT><TT>sort</TT><A NAME="1624"></A> </TT></TD> -<TD ALIGN="LEFT">How to sort the entry. (Entry name used if sort omitted)</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT><TT>format</TT><A NAME="1628"></A> </TT></TD> -<TD ALIGN="LEFT">How to format the page number</TD> -</TR> -</TABLE> -</DIV> -For example: -<PRE> -\glossary{name={singular matrix}, - description={A matrix with zero determinant}} -</PRE> - The following example sorts on the text <TT>U</TT> instead of -<code>$\mathcal{U}$</code>: -<PRE> -\glossary{name={$\mathcal{U}$}, - description={The universal set}, - sort=U} -</PRE> -The page format for individual entries can be changed using the -<TT>format</TT><A NAME="1632"></A> key. This should be the name of a LaTeX -formatting command without the preceding <code>\</code> (as with the -<code>|</code> operator in <TT>\index</TT>.) For example: -<PRE> -\glossary{name={$\mathbb{R}$}, - description={The set of real numbers}, - sort=R, - format=textbf} -</PRE> -In addition, the following formats are also available: - -<DIV ALIGN="CENTER"> -<TABLE CELLPADDING=3> -<TR><TD ALIGN="LEFT"><TT>hyperrm</TT><A NAME="1638"></A><A NAME="1639"></A></TD> -<TD ALIGN="LEFT">The number is a hyper link in roman</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypersf</TT><A NAME="1643"></A><A NAME="1644"></A></TD> -<TD ALIGN="LEFT">The number is a hyper link in sans-serif</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hypertt</TT><A NAME="1648"></A><A NAME="1649"></A></TD> -<TD ALIGN="LEFT">The number is a hyper link in typewriter font</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hyperbf</TT><A NAME="1653"></A><A NAME="1654"></A></TD> -<TD ALIGN="LEFT">The number is a hyper link in bold</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>hyperit</TT><A NAME="1658"></A><A NAME="1659"></A></TD> -<TD ALIGN="LEFT">The number is a hyper link in italic</TD> -</TR> -</TABLE> -</DIV> -If the <TT>hyper</TT><A NAME="1668"></A> option has not been set, -<TT>hyperrm</TT><A NAME="1672"></A><A NAME="1673"></A> etc are equivalent to <TT>textrm</TT> etc. -You should use <TT>\hyperrm</TT><A NAME="1677"></A> instead of -<TT>\hyperpage</TT>, as <TT>\hyperpage</TT> won't -work on a list or range of numbers in the glossary<A NAME="tex2html2" - HREF="#foot1473"><SUP>2</SUP></A>. - -<P> -As with the <TT>\index</TT> command, care must be taken if you -want to use the special characters: <code>@</code> <code>|</code> <code>"</code> and -<code>!</code>. These characters should be preceded by the double quote -character. For example: -<PRE> -\glossary{name={$"|\mathcal{S}"|$, -description=The cardinality of the set \mathcal{S}}} -</PRE> -There is no provision for sub-entries, as these are -generally only applicable in an index, and not in a glossary. - -<P> -As from version 2.14, there is an additional command available: - -<P> - -<TT>\xglossary</TT><code>{</code><I>gls-entry</I><code>}{</code><I>text</I><code>}</code> - -<P> -This is equivalent to -<I>text</I><TT>\glossary</TT><A NAME="1694"></A><code>{</code><I>gls-entry</I><code>}</code>, -where <I>text</I> will be made a hyperlink to the -relevant entry in the glossary, if hyper -links are supported. - -<P> - -<H2><A NAME="SECTION00041000000000000000"> -Storing Glossary Information</A> -</H2> - -<P> -The following command: -<BR> -<BR><TT><TT>\storeglosentry</TT>[</TT> <I>gls-type</I><TT>]{</TT> <I>label</I><TT>}{</TT> <I>gls-entry</I><TT>} -</TT> -<BR> -<BR> -can be used to store glossary information. That information -can then be used later with any of the following commands: - -<BR> -<BR><TT><TT>\useglosentry</TT>[</TT> <I>opt</I><TT>]{</TT> <I>label</I><TT>} -<BR><TT>\useGlosentry</TT>[</TT> <I>opt</I><TT>]{</TT> <I>label</I><TT>}{</TT> <I>text</I><TT>} -<BR><TT>\gls</TT>[</TT> <I>opt</I><TT>]{</TT> <I>label</I><TT>} -</TT> -<BR> -<BR><TT>\useglosentry</TT> adds the stored glossary entry -<I>gls-entry</I> to the appropriate glossary, -<TT>\useGlosentry</TT> adds the stored glossary entry, and -makes <I>text</I> a hyperlink to that entry (if hyperlinks are -supported). The third command, <TT>\gls</TT>, is like -<TT>\useGlosentry</TT>, but forms <I>text</I> from the name -given in <I>gls-entry</I>. - -<P> -Returning to an earlier example, instead of typing: -<PRE> -\glossary{name={$\mathcal{U}$}, - description={The universal set}, - sort=U} -</PRE> -every time you want to add this entry to the glossary, you -can instead store the information: - -<PRE> -\storeglosentry{glos:U}{name={$\protect\mathcal{U}$}, - description={The universal set}, - sort=U} -</PRE> -(Note the use of <TT>\protect</TT>.) Now, instead of continually -copying and pasting the glossary command for this entry (which -can have quite a large <TT>description</TT><A NAME="1717"></A> field), you can use either: -<PRE> -\useglosentry{glos:U} -</PRE> -which is equivalent to: -<PRE> -\glossary{name={$\mathcal{U}$}, - description={The universal set}, - sort=U} -</PRE> -or you can use: -<PRE> -\useGlosentry{glos:U}{text} -</PRE> -which is equivalent to: -<PRE> -\xglossary{name={$\mathcal{U}$}, - description={The universal set}, - sort=U}{text} -</PRE> -or you can use: -<PRE> -\gls{glos:U} -</PRE> -which is equivalent to: -<PRE> -\xglossary{name={$\mathcal{U}$}, - description={The universal set}, - sort=U}{$\mathcal{U}$} -</PRE> -The optional argument <I>gls-type</I> indicates the glossary -type (see <A HREF="#sec:newglostype">later</A> to find out how to define new -glossary types). If omitted, the standard glossary is used. - -<P> -The optional argument <I>opt</I> allows you to add additional -information to the glossary entry, for example: -<PRE> -\useglosentry[format=textbf]{glos:U} -</PRE> -is equivalent to: -<PRE> -\glossary{name={$\mathcal{U}$}, - description={The universal set}, - sort=U, - format=textbf} -</PRE> -The identifying label, <I>label</I>, should not contain any -special characters, and since <TT>\storeglosentry</TT> is -fragile, care should be taken when using commands within its -argument. If in doubt, use <TT>\protect</TT>. - -<P> - -<H1><A NAME="SECTION00050000000000000000"> -makeglos.pl</A> -</H1> - -<P> -The glossary information (as given by the commands -<TT>\glossary</TT> and <TT>\xglossary</TT>) is saved in the file -with the extension <TT>glo</TT><A NAME="1729"></A> (unless the -<TT>\makeglossary</TT><A NAME="1731"></A> command is omitted, in which case the -glossary information is simply ignored.) A <TT>makeindex</TT><A NAME="1736"></A> -style file<A NAME="1488"></A> -(<TT>ist</TT><A NAME="1739"></A>) is also created, which is customized for the -document, and can be passed to <TT>makeindex</TT><A NAME="1741"></A>. - -<P> -For example, suppose your document is called <TT>mydoc.tex</TT>, -the glossary will be saved in the file -<TT>mydoc.glo</TT><A NAME="1744"></A>, and the <TT>makeindex</TT><A NAME="1746"></A> style -file <TT>mydoc.ist</TT><A NAME="1749"></A> will be created. - These files can then be passed to <TT>makeindex</TT><A NAME="1751"></A> as follows: -<PRE> -makeindex -s mydoc.ist -t mydoc.glg -o mydoc.gls mydoc.glo -</PRE> -which generates the output file <TT>mydoc.gls</TT><A NAME="1754"></A>, -with transcript written to -<TT>mydoc.glg</TT><A NAME="1756"></A>. - -<P> -The Perl script <TT>makeglos.pl</TT><A NAME="1758"></A> provided with this package -allows you to use <TT>makeindex</TT><A NAME="1761"></A> without having to remember -all the command line options. The command -<PRE> -makeglos.pl mydoc.glo -</PRE> -will perform the command: -<PRE> -makeindex -s mydoc.ist -t mydoc.glg -o mydoc.gls mydoc.glo -</PRE> -The <TT>glo</TT><A NAME="1764"></A> extension may be omitted. In addition, -<TT>makeglos.pl</TT><A NAME="1766"></A> also takes the option -<TT>-m</TT> which can be used to collate entries where the -same name has multiple descriptions. - -<P> -<TT>makeglos.pl</TT><A NAME="1769"></A> has the following syntax: -<PRE> -makeglos.pl [-ilqrgm] [-s sty] [-o gls] [-t log] [-p num] <filename> -</PRE> -where all switches, apart from <TT>-m</TT> are the same as -those for <TT>makeindex</TT><A NAME="1772"></A>. In addition, if the extension -to the input file name is omitted, <TT>glo</TT><A NAME="1775"></A> will be -assumed. If there are multiple glossary types (see -<A HREF="#sec:newglostype">later</A>) -and the file extension is omitted, <TT>makeglos.pl</TT><A NAME="1777"></A> will -iterate through each glossary type. - -<P> -The name of the <TT>ist</TT><A NAME="1780"></A> file can be changed by redefining -the command <TT>\istfilename</TT>. -For example: -<PRE> -\renewcommand{\istfilename}{foo.ist} -</PRE> -However, you will need to explicitly pass the name of this -file to <TT>makeglos.pl</TT><A NAME="1784"></A> using the <TT>-s</TT> switch. - -<P> -Creation of the <TT>ist</TT><A NAME="1787"></A> file can be suppressed by issuing -the command <TT>\noist</TT> before -<TT>\makeglossary</TT><A NAME="1791"></A>. It will also be suppressed when the -command <TT>\nofiles</TT><A NAME="1796"></A> is used, or if the command -<TT>\makeglossary</TT><A NAME="1801"></A> is omitted. - -<P> -It should be noted that there are a few packages that can -cause problems with the creation of the <TT>ist</TT><A NAME="1806"></A> file, -for example <TT>ngerman</TT><A NAME="1808"></A>. If you encounter problems -when LaTeX is processing the <TT>\makeglossary</TT><A NAME="1811"></A> command, -or if you get errors from <TT>makeindex</TT><A NAME="1816"></A> complaining about -the style file, this is the most probable cause. -See <A HREF="#itm:ngerman">later</A> for -information on how to fix this. - -<P> - -<H1><A NAME="SECTION00060000000000000000"> -Displaying the Glossary</A> -</H1> - -<P> -Once the <TT>gls</TT><A NAME="1819"></A> file has been created by -<TT>makeindex</TT><A NAME="1821"></A> (as described in the previous - section) the glossary can then be included in the document with -the command <TT>\printglossary</TT>. - If chapters are defined, the glossary will start -with<A NAME="1825"></A> -<PRE> -\chapter*{\glossaryname} -</PRE> -If not, it will start with -<PRE> -\section*{\glossaryname} -</PRE> -The format of the main body of the glossary depends on the -options passed to the package. - -<P> - -<H1><A NAME="SECTION00070000000000000000"></A> -<A NAME="sec:options"></A> -<BR> -Package Options -</H1> - -<P> -The package options must be specified as a comma-separated list -of <I>key</I>=<I>value</I> pairs. Available options are: -<DL> -<DT><STRONG><TT>style</TT><A NAME="1834"></A></STRONG></DT> -<DD>The glossary style. Values: -<A NAME="1493"></A> -<DL> -<DT><STRONG><TT>list</TT><A NAME="1838"></A></STRONG></DT> -<DD>use -<TT>description</TT> environment in the glossary -</DD> -<DT><STRONG><TT>altlist</TT><A NAME="1841"></A></STRONG></DT> -<DD>modified -version of <TT>style=list</TT><A NAME="1850"></A>. The description starts on the -line following the name of the term being defined. - -</DD> -<DT><STRONG><TT>super</TT><A NAME="1852"></A></STRONG></DT> -<DD>use -<TT>supertabular</TT> environment in the glossary -</DD> -<DT><STRONG><TT>long</TT><A NAME="1855"></A></STRONG></DT> -<DD>use -<TT>longtable</TT> environment in the glossary (Default) -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>header</TT><A NAME="1863"></A></STRONG></DT> -<DD><A NAME="1495"></A> Glossary -header. Values: -<DL> -<DT><STRONG><TT>none</TT><A NAME="1867"></A></STRONG></DT> -<DD>The glossary -doesn't have a heading (Default) -</DD> -<DT><STRONG><TT>plain</TT><A NAME="1869"></A></STRONG></DT> -<DD>The glossary -has a heading -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>border</TT><A NAME="1876"></A></STRONG></DT> -<DD><A NAME="1496"></A> Glossary -border. Values: -<DL> -<DT><STRONG><TT>none</TT><A NAME="1880"></A></STRONG></DT> -<DD>The glossary -doesn't have a border (Default) -</DD> -<DT><STRONG><TT>plain</TT><A NAME="1882"></A></STRONG></DT> -<DD>Border -around the main body of the glossary -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>cols</TT><A NAME="1889"></A></STRONG></DT> -<DD><A NAME="1497"></A> Number of -columns. Values: -<DL> -<DT><STRONG><TT>2</TT><A NAME="1893"></A></STRONG></DT> -<DD>The entry name and description are in two separate -columns with the associated page numbers in the same column as -the description. (Default) -</DD> -<DT><STRONG><TT>3</TT><A NAME="1895"></A></STRONG></DT> -<DD>The entry name, description and associated page numbers -are in three separate columns. -</DD> -</DL> - -<P> - -</DD> -<DT><STRONG><TT>number</TT><A NAME="1902"></A></STRONG></DT> -<DD>Associated number corresponding to each entry. Values: -<DL> -<DT><STRONG><TT>page</TT><A NAME="1906"></A></STRONG></DT> -<DD>Each entry has the corresponding page number(s) where the -entry is defined. (Default) -</DD> -<DT><STRONG><TT>section</TT><A NAME="1908"></A></STRONG></DT> -<DD>Each entry has the corresponding section number(s) where -the entry is defined. -</DD> -<DT><STRONG><TT>none</TT><A NAME="1910"></A></STRONG></DT> -<DD>The corresponding numbers are -suppressed. -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>toc</TT><A NAME="1917"></A></STRONG></DT> -<DD><A NAME="1499"></A> -Boolean variable: - -<DL> -<DT><STRONG><TT>true</TT><A NAME="1921"></A></STRONG></DT> -<DD>Add glossary to table of contents -</DD> -<DT><STRONG><TT>false</TT><A NAME="1923"></A></STRONG></DT> -<DD>Omit glossary from table of contents (Default) -</DD> -</DL> -Note that if you specify this option, you will need to run -LaTeX twice after generating the glossary. - -<P> -</DD> -<DT><STRONG><TT>hypertoc</TT><A NAME="1930"></A></STRONG></DT> -<DD>Boolean variable. This is similar to the package option -<TT>toc</TT><A NAME="1939"></A>, but if you are using the <TT>hyperref</TT><A NAME="1943"></A> -package, <TT>hypertoc</TT><A NAME="1951"></A> will generate a link to the -beginning of the page, whereas <TT>toc</TT><A NAME="1960"></A> will have -a hyperlink to jst after the glossary title. Note -that you can not use both <TT>toc=true</TT><A NAME="1971"></A> and -<TT>hypertoc=true</TT><A NAME="1980"></A>. Default value: -<TT>hypertoc=false</TT><A NAME="1989"></A>. - -<P> -</DD> -<DT><STRONG><TT>hyper</TT><A NAME="1996"></A></STRONG></DT> -<DD>Boolean -variable: - -<DL> -<DT><STRONG><TT>true</TT><A NAME="2000"></A></STRONG></DT> -<DD>Make associated numbers in the -glossary a hypertext link, and also make acronyms, and the text -given by <TT>\xglossary</TT><A NAME="2002"></A> have a hyperlink to their -corresponding entries in the glossary. -</DD> -<DT><STRONG><TT>false</TT><A NAME="2007"></A></STRONG></DT> -<DD>Don't make associated numbers a hypertext link -</DD> -</DL> -If the <TT>hyperref</TT><A NAME="2009"></A> or <TT>html</TT><A NAME="2012"></A> package has -been loaded prior to loading <TT>glossary.sty</TT>, -<TT>hyper=true</TT><A NAME="2022"></A> is set, otherwise -the default is <TT>hyper=false</TT><A NAME="2031"></A>. Note that this package -option now encompasses the old <TT>hyperacronym</TT><A NAME="2038"></A> option. - -<P> -</DD> -<DT><STRONG><TT>section</TT><A NAME="2047"></A></STRONG></DT> -<DD>Boolean variable: - -<DL> -<DT><STRONG><TT>true</TT><A NAME="2051"></A></STRONG></DT> -<DD>Make the glossary an unnumbered -section, even if chapters are defined -</DD> -<DT><STRONG><TT>false</TT><A NAME="2053"></A></STRONG></DT> -<DD>Only make glossary an -unnumbered section if chapters are not defined (default). -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>acronym</TT><A NAME="2060"></A></STRONG></DT> -<DD>Boolean variable: - -<DL> -<DT><STRONG><TT>true</TT><A NAME="2064"></A></STRONG></DT> -<DD>Make the list of acronyms -separate from the main glossary. - -<P> -</DD> -<DT><STRONG><TT>false</TT><A NAME="2066"></A></STRONG></DT> -<DD>The acronyms will all -be placed in the main glossary. (Default) -</DD> -</DL> - -<P> -</DD> -<DT><STRONG><TT>global</TT><A NAME="2073"></A></STRONG></DT> -<DD>Boolean variable: - -<DL> -<DT><STRONG><TT>false</TT><A NAME="2077"></A></STRONG></DT> -<DD>Acronym commands only have -a local effect. (Default) -</DD> -<DT><STRONG><TT>true</TT><A NAME="2079"></A></STRONG></DT> -<DD>Acronym commands have a global -effect. -</DD> -</DL> -</DD> -</DL> - The <TT>border</TT><A NAME="2086"></A>, <TT>header</TT><A NAME="2095"></A> and <TT>cols</TT><A NAME="2104"></A> options -should not be used in conjunction with <TT>style=list</TT><A NAME="2115"></A> -or <TT>style=altlist</TT><A NAME="2124"></A>, as they only make sense with one of -the tabular-style options. -The value for the boolean variables can be omitted if they are -to be set. For example - <TT>toc</TT><A NAME="2131"></A> is equivalent to <TT>toc=true</TT><A NAME="2142"></A>. Note that the -<TT>altlist</TT><A NAME="2144"></A> style is better suited to -glossaries with long entry names. - -<P> -You can set up your own preferred defaults in a configuration -file<A NAME="1506"></A>. -The file must be called <TT>glossary.cfg</TT><A NAME="2146"></A> and -should be placed somewhere on the T<SMALL>E</SMALL>X path. In this file you -can use the command -<TT>\glossarypackageoptions</TT><code>{</code><I>option-list</I><code>}</code> - -where <I>option-list</I> is a comma-separated list of -<I>key</I>=<I>value</I> pairs, as passed to the -<TT>glossary</TT><A NAME="2150"></A> -package. Note that this command may only be used in the -configuration file. - -<P> - -<H2><A NAME="SECTION00071000000000000000"> -Examples</A> -</H2> -See <TT><A NAME="tex2html3" - HREF="glossary.pdf">glossary.pdf</A></TT> (the PDF version of this manual) for -examples. - -<P> - -<H1><A NAME="SECTION00080000000000000000"></A> -<A NAME="sec:newglostype"></A> -<BR> -Defining New Glossary Types -</H1> - -<P> -A new type of glossary can be defined using the command: -<BR> -<BR><TT>\newglossarytype</TT><code>[</code><I>log-ext</I><code>]{</code><I>name</I><code>}{</code><I>out-ext</I><code>}{</code><I>in-ext</I><code>}[</code><I>style list</I><code>]</code> -<BR> -<BR> -For example, suppose you want your document to have a separate -index of terms and index of notation, -you could use <TT>\makeglossary</TT><A NAME="2328"></A>, <TT>\glossary</TT><A NAME="2333"></A>, -<TT>\xglossary</TT><A NAME="2338"></A> and <TT>\printglossary</TT><A NAME="2343"></A> for the first -glossary, and define a new type of glossary called say, -<TT>notation</TT>, using -<PRE> -\newglossarytype[nlg]{notation}{not}{ntn} -</PRE> -which will create the analogous commands: -<TT>\makenotation</TT>, <TT>\notation</TT>, <TT>\xnotation</TT> -and <TT>\printnotation</TT> which can be used for the second -glossary. - -<P> -As from version 2.3, <TT>\newglossarytype</TT> now has an -additional optional argument <I>style list</I>. This should -be a comma separated list of <I>key</I>=<I>value</I> pairs -that can be used to specify the style of the new glossary. -If omitted, the new glossary will have the same format -as the main glossary. The following options are available: -<TT>style</TT>, <TT>header</TT>, <TT>border</TT> and -<TT>cols</TT>. These can take the same values as those -given in the package options (described in section <A HREF="#sec:options">6</A>). - -<P> -The command <TT>\newglossarytype</TT> should only occur in the -preamble. The new commands - <TT>\make</TT><I>name</I>, <code>\</code><I>name</I>, -<code>\x</code><I>name</I> and <TT>\print</TT><I>name</I> all have the -same format as their ``glossary'' counter-parts. - -<P> -The glossary information will be saved to a file -with the extension given by <I>out-ext</I> (analogous to -<TT>glo</TT><A NAME="2364"></A>), which can then be passed to <TT>makeindex</TT><A NAME="2366"></A> -either directly or via <TT>makeglos.pl</TT><A NAME="2369"></A>, -and the file to be read in (i.e. the file created by -<TT>makeindex</TT><A NAME="2372"></A>) will have the extension <I>in-ext</I> -(analogous to <TT>gls</TT><A NAME="2375"></A>). - -<P> -The optional argument <I>log-ext</I> indicates -the extension for the <TT>makeindex</TT><A NAME="2377"></A> log file, if omitted the -extension <TT>glg</TT><A NAME="2380"></A> is used. This is not used by LaTeX, -however <TT>makeglos.pl</TT><A NAME="2382"></A> reads in this information from -the LaTeX auxiliary file and passes it to <TT>makeindex</TT><A NAME="2385"></A>. - -<P> -For the above <TT>notation</TT> -example, if your document is called, say, <TT>mydoc.tex</TT>, - you will need to do the following: -<PRE> -latex mydoc -makeglos.pl mydoc -latex mydoc -</PRE> -(You may need to do an extra <code>latex mydoc</code> to get -cross-references up-to-date.) Note that if you don't specify the -file extension when using <TT>makeglos.pl</TT><A NAME="2388"></A>, it will -check the transcript file from the LaTeX run to determine -all the glossary types, so, for this example, -<PRE> -makeglos.pl mydoc -</PRE> -is equivalent to: -<PRE> -makeglos.pl mydoc.glo -makeglos.pl mydoc.not -</PRE> -since <TT>makeglos.pl</TT><A NAME="2391"></A> has read in the information -for the <TT>notation</TT> glossary type from the file -<TT>mydoc.log</TT>. - -<P> -If you don't have Perl installed -on your system, or for any other reason are unable to use -<TT>makeglos.pl</TT><A NAME="2394"></A>, you can call <TT>makeindex</TT><A NAME="2397"></A> -explicitly: -<PRE> -latex mydoc -makeindex -s mydoc.ist -t mydoc.glg -o mydoc.gls mydoc.glo -makeindex -s mydoc.ist -t mydoc.nlg -o mydoc.ntn mydoc.not -latex mydoc -</PRE> - -<P> -Note that you can use the command -<TT>\printglossary</TT><A NAME="2400"></A><TT>[</TT><I>name</I><TT>]</TT> -instead of <code>\print</code><I>name</I>. -These two commands have the same effect when using LaTeX, -however, they have a slightly different effect when -using LaTeX2HTML (see <A HREF="#sec:l2h">later</A>). - -<P> -If the command <code>\</code><I>glossary-type</I><code>name</code> -is defined, (e.g. <code>\notationname</code> in the above example) -this will be used as the title for the specified -glossary. If this command is not defined, <TT>\glossaryname</TT><A NAME="2405"></A> -will be used instead. -If the command <code>\short</code><I>glossary-type</I><code>name</code> -is defined, (e.g. <TT>\shortnotationname</TT> in the above -example) this will be used for the table of contents -entry, otherwise <code>\</code><I>glossary-type</I><code>name</code> will -be used instead. -For example: -<PRE> -\newglossarytype[nlg]{notation}{not}{ntn} -\newcommand{\notationname}{Index of Notation} -\newcommand{\shortnotationname}{Notation} -</PRE> - -<P> - -<H1><A NAME="SECTION00090000000000000000"> -Acronyms</A> -</H1> - -<P> -The <TT>glossary</TT><A NAME="2412"></A> package provides the command: -<BR> -<BR><TT><TT>\newacronym</TT>[</TT> <I>cmd-name</I><TT>]{</TT> <I>acronym</I><TT>}{</TT> <I>long</I><TT>}{</TT> <I>glossary entry</I><TT>} -</TT> -<BR> -<BR> -which can be used to define acronyms. The argument <I>long</I> -is the full name, the argument <I>acronym</I> is the acronym for -<I>long</I> and <I>glossary entry</I> is the glossary information -in the form used by the <TT>\glossary</TT><A NAME="2417"></A> command. If the -optional argument <I>cmd-name</I> is missing, -<TT>\newacronym</TT> will create a command called -<code>\</code><I>acronym</I>, otherwise it will create a command -called <code>\</code><I>cmd-name</I> (henceforth denoted <TT>\</TT><I>acr-name</I>). -This command can then be used throughout the text. The first -instance of this command is equivalent to: -<BR> -<BR><I>long</I> <TT>(\xacronym</TT><A NAME="2426"></A><code>{</code><TT>name</TT><A NAME="2431"></A><TT>=</TT><I>long</I> <TT>(</TT><I>acronym</I><TT>),</TT><I>glossary entry</I><code>}{</code><I>acronym</I><code>}</code><TT>)</TT> -<BR> -<BR> -subsequent instances will be equivalent to: -<BR> -<BR><TT>\xacronym</TT><A NAME="2435"></A><code>{</code><TT>name</TT><A NAME="2440"></A><TT>=</TT><I>long</I> <TT>(</TT><I>acronym</I><TT>),</TT><I>glossary entry</I><code>}{</code><I>acronym</I><code>}</code> -<BR> -<BR> -The command <TT>\</TT><I>acr-name</I> also has a starred -version, which will make the first letter of <I>long</I> -uppercase (for use at the start of a sentence). - -<P> -Note that if you want to change the format of the acronym, -for example, if you want the acronym to appear in small caps, -you will need to not only use the optional argument, but you -will also need to use the <TT>sort</TT><A NAME="2446"></A> key, otherwise you -will get an error. For example: -<PRE> -\newacronym[SVM]{\textsc{svm}}{Support Vector Machine}% -{description=Statistical pattern recognition -technique,sort=svm} -</PRE> - -<P> -If the package option <TT>acronym</TT><A NAME="2455"></A> is not set (default) -<TT>\xacronym</TT><A NAME="2459"></A>, is a synonym for <TT>\xglossary</TT><A NAME="2464"></A>. -If the package option <TT>acronym=true</TT><A NAME="2476"></A> is specified, a -new glossary type called <TT>acronym</TT> will be defined as: -<PRE> -\newglossarytype[alg]{acronym}{acr}{acn} -\newcommand{\acronymname}{List of Acronyms} -</PRE> -You will then need to use the commands <TT>\makeacronym</TT><A NAME="2478"></A> -and <TT>\printacronym</TT><A NAME="2483"></A> to make the list of acronyms appear. -You will also need to run the <TT>acr</TT><A NAME="2488"></A> file through -<TT>makeindex</TT><A NAME="2490"></A> (or <TT>makeglos.pl</TT><A NAME="2493"></A>). For example: -<PRE> -makeindex -s mydoc.ist -t mydoc.alg -o mydoc.acn mydoc.acr -</PRE> -alternatively: -<PRE> -makeglos.pl mydoc -</PRE> -Note that the package option <TT>acronym=true</TT><A NAME="2503"></A> is only -appropriate if you want both a glossary and a separate list of -acronyms. - -<P> -The <TT>name</TT><A NAME="2505"></A> key is not used in <I>glossary -entry</I>, as it is constructed from <I>long</I> and -<I>acronym</I>. By default this will be in the form: -<I>long</I> (<I>acronym</I>), however the format can be -overridden using the -command: -<BR> -<BR><TT>\setacronymnamefmt</TT>{<I>format</I>} -<BR> -<BR> -Within <I>format</I> the following commands may -be used to represent <I>long</I> and <I>acronym</I>: -<TT>\glolong</TT><A NAME="2511"></A> and -<TT>\gloshort</TT><A NAME="2516"></A>. For example, -suppose you just want the acronym to appear in the glossary entry, -and not its full length name, then you would need to do: -<PRE> -\setacronymnamefmt{\gloshort} -</PRE> - -<P> -As from version 2.32, you can also modify the way the description -key is formatted for acronyms using: -<BR> -<BR><TT>\setacronymdescfmt</TT>{<I>format</I>} -<BR> -<BR> -Within <I>format</I> you may use the commands <TT>\glolong</TT><A NAME="2523"></A> -and <TT>\gloshort</TT><A NAME="2528"></A> (as above), and you can also use -the command <TT>\glodesc</TT><A NAME="2533"></A> which is the description as -specified by the <TT>description</TT><A NAME="2538"></A> key in -<TT>\newacronym</TT><A NAME="2542"></A>. This means that if you are using -a tabular style glossary, you can have the abbreviated -form in one column and the long form in the second column -with the description. For example, the following: -<PRE> -\setacronymnamefmt{\gloshort} -\setacronymdescfmt{\glolong: \glodesc} -\newacronym{svm}{support vector machine}{description=Statistical -pattern recognition technique} -</PRE> -will generate a glossary entry of the form: -<PRE> -\glossary{name=svm,description=support vector machine: Statistical -pattern recognition technique} -</PRE> -Note that if you omit <TT>\glodesc</TT><A NAME="2547"></A> from -<TT>\setacronymdescfmt</TT> the description specified -in <TT>\newacronym</TT> will be ignored. So -<PRE> -\setacronymnamefmt{\gloshort} -\setacronymdescfmt{\glolong} -\newacronym{svm}{support vector machine}{description=Statistical -pattern recognition technique} -</PRE> -will generate a glossary entry of the form: -<PRE> -\glossary{name=svm,description=support vector machine} -</PRE> - -<P> -Given an acronym named <I>acr-name</I> (the command name -associated with the acronym as defined in -<TT>\newacronym</TT> without the preceding backslash), -the following commands are also available: - -<P> -<BR> -<BR> - -<TT>\useacronym</TT><code>[</code><I>insert</I><code>]{</code><I>acr-name</I><code>}</code> -<BR> -<BR> -This command can be used instead of <TT>\</TT><I>acr-name</I>. -<TT>\useacronym</TT> also has a starred version equivalent to -<TT>\</TT><I>acr-name</I><TT>*</TT>. -The optional argument <I>insert</I> allows you to insert text -after <I>long</I>, if this is the first occurrence of the -acronym, or after the acronym on subsequent occurrences. - -<P> -<BR> -<BR> - -<TT>\resetacronym</TT><code>{</code><I>acr-name</I><code>}</code> -<BR> -<BR> -This command will cause the next use of <TT>\</TT><I>acr-name</I> -to produce the long version. To reset all acronyms -do <TT>\resetallacronyms</TT>. - -<P> -<BR> -<BR> - -<TT>\unsetacronym</TT><code>{</code><I>acr-name</I><code>}</code> -<BR> -<BR> -This command will cause all subsequent uses of -<TT>\</TT><I>acr-name</I> to produce the short version. -To unset all acronyms -do <TT>\unsetallacronyms</TT>. - -<P> -<BR> -<BR> - -<TT>\ifacronymfirstuse</TT><code>{</code><I>acr-name</I><code>}{</code><I>true text</I><code>}{</code><I>false text</I><code>}</code> -<BR> -<BR> -This will test if the acronym has been used yet. If it has been -used, <I>true text</I> will be implemented, otherwise -<I>false text</I> will be implemented. - -<P> -The long and short forms of an acronym can be produced explicitly -without a corresponding glossary entry, using the commands: -<BR> -<BR><TT>\acrln</TT><code>{</code><I>acr-name</I><code>}</code> -<BR><TT>\acrsh</TT><code>{</code><I>acr-name</I><code>}</code> -<BR> -<BR> -Or, alternatively: -<BR> -<BR><TT>\</TT><I>acr-name</I><TT>long</TT> -<BR><TT>\</TT><I>acr-name</I><TT>short</TT> -<BR> -<BR> -The first two commands (<TT>\acrln</TT> and <TT>\acrsh</TT>) -have a starred form that makes the first letter uppercase. -The other two commands, simply contain <I>long</I> and -<I>acronym</I>. - -<P> -Note that since these four commands do not generate glossary -entries they will therefore not contain any hyperlinks, even if -you have specified the <TT>hyper</TT><A NAME="2597"></A> package option. They are -provided for use in situations where the associated glossary -command may cause problems (e.g. in the table of contents entry.) - -<P> -Note that, as with all LaTeX commands, spaces following -command names are ignored so if, for example, you defined -a new acronym called, say, SVM, then the <code>\SVM</code> will -ignore any spaces following it. To force a space, you -can either place an empty set of braces after the command -name (e.g. <code>\SVM{}</code>) or use -<TT>\_</TT> i.e. a backslash followed by -a space (e.g. <code>\SVM\ </code>). Alternatively, as from -version 2.22, if you load the <TT>xspace</TT><A NAME="2603"></A> package -before loading the <TT>glossary</TT><A NAME="2606"></A> package, spaces will -be put in automatically using <TT>\xspace</TT><A NAME="2609"></A>. - -<P> -If you want the acronym to appear in a particular font, -for example, small caps, you can redefine the command -<TT>\acronymfont</TT>. For example: -<PRE> -\renewcommand{\acronymfont}[1]{\textsc{#1}} -</PRE> -The default definition of <TT>\acronymfont</TT> is: -<PRE> -\newcommand{\acronymfont}[1]{#1} -</PRE> - -<P> - -<H2><A NAME="SECTION00091000000000000000"> -Examples</A> -</H2> - -<P> -<PRE> -\newacronym{SVM}{Support Vector Machine}{description=Statistical -pattern recognition technique} -</PRE> -This will define the command <TT>\SVM</TT>. The first time this -command is used will display the text: Support Vector Machine -(SVM). Subsequent use will simply display: SVM. The next -example uses the optional argument <I>cmd-name</I> since the -acronym contains a non-alphabetical character: -<PRE> -\newacronym[KSVM]{K-SVM}{Kernel Support Vector -Machine}{description=Statistical pattern recognition -technique using the ``kernel trick''} -</PRE> -This will define the command <TT>\KSVM</TT>. The first time -this command is used will display the text: Kernel Support Vector -Machine (K-SVM). Subsequent use will simply display: K-SVM. - -<P> -To test whether or not an acronym has been used: -<PRE> -\ifacronymfirstuse{SVM}{a}{an} \SVM\ is \ldots -</PRE> -If the acronym has not been used, the following text will -be produced: -<BR> -<BR> -a Support Vector Machine is ... -<BR> -<BR> -otherwise it will produce: -<BR> -<BR> -an SVM is ... -<BR> -<BR> -To expand the acronym a second time: -<PRE> -\chapter{An overview of the \protect\SVM} -\resetacronym{SVM} -The \SVM\ \ldots -</PRE> -Note the use of <TT>\protect</TT> (see -note <A HREF="#itm:fragile">15</A>.) In fact, in this situation -it would be better to do: -<PRE> -\chapter[An overview of the \SVMlong]{An overview of the \protect\SVM} -\resetacronym{SVM} -The \SVM\ \ldots -</PRE> - -<P> -Now suppose you want the text: support vector machine, -instead of Support Vector Machine (i.e. you don't like the -uppercase letters). You can define the acronym as follows: -<PRE> -\newacronym{SVM}{support vector machine}{description=Statistical -pattern recognition technique} -</PRE> -however, if the command <TT>\SVM</TT> occurs at the start of the -sentence, you would clearly want the first letter as an -uppercase letter. This can be done using <TT>\SVM*</TT> instead -of <TT>\SVM</TT>. For example: -<PRE> -\SVM*\ techniques are widely used \ldots -</PRE> -This will then come out as: Support vector machine (SVM) -techniques are widely used ...(Assuming this is the first -use of either <TT>\SVM</TT> or <TT>\SVM*</TT>.) - -<P> -Alternatively, <TT>\useacronym</TT><A NAME="2634"></A><code>{SVM}</code> can be used instead of -<TT>\SVM</TT>. For example: -<PRE> -\useacronym*[s]{SVM} are widely used in the area of pattern -recognition. -</PRE> -If this is the first use of the acronym SVM, it will produce the -following text: -<BR> -<BR> -Support vector machines (SVM) are widely used in the area of -pattern recognition. -<BR> -<BR> -If this is not the first use of this acronym, it will produce the -following text: -<BR> -<BR> -SVMs are widely used in the area of pattern recognition. - -<P> - -<H1><A NAME="SECTION000100000000000000000"> -Customizing the Glossary</A> -</H1> -The <TT>glossary</TT><A NAME="2641"></A> package provides commands which can be redefined to customize the -glossary. The following name commands are defined by this package: -<DIV ALIGN="CENTER"> -<TABLE CELLPADDING=3> -<TR><TH ALIGN="LEFT"><B>Command </B></TH> -<TH ALIGN="LEFT"><B>Default Value</B></TH> -</TR> -<TR><TD ALIGN="LEFT"><TT>\glossaryname</TT></TD> -<TD ALIGN="LEFT">Glossary</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\shortglossaryname</TT></TD> -<TD ALIGN="LEFT"><TT>\glossaryname</TT></TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\entryname</TT></TD> -<TD ALIGN="LEFT">Notation</TD> -</TR> -<TR><TD ALIGN="LEFT"><TT>\descriptionname</TT></TD> -<TD ALIGN="LEFT">Description</TD> -</TR> -</TABLE> -</DIV> -The command <TT>\shortglossaryname</TT> is used for the -page headers and table of contents entry. - Any text required before or after the glossary can be added -by redefining the commands <TT>\glossarypreamble</TT> -and <TT>\glossarypostamble</TT>. -For example. -<PRE> -\renewcommand{\glossarypreamble}{Page numbers in -italic indicate the main definition\par} -</PRE> -By default, <TT>\glossarypreamble</TT> and <TT>\glossarypostamble</TT> do nothing. - -<P> -Any text required before or after the list of page numbers -are specified by the commands <TT>\glsbeforenum</TT> - -and <TT>\glsafternum</TT>. -By default, these commands do nothing, any redefinition -of these commands should come somewhere before the -relevant <TT>\printglossary</TT> command. For example: -<PRE> -\printglossary -\renewcommand{\glsbeforenum}{(} -\renewcommand{\glsafternum}{)} -\printnotation -</PRE> -This will put the page number list in brackets for the -second glossary, but not the first. - -<P> -Individual glossaries can have their styles changed either -by setting the style in the final optional argument -to <TT>\newglossarystyle</TT><A NAME="2670"></A> (see -<A HREF="#sec:newglostype">earlier</A>) -or using the command: -<BR> -<BR><TT>\setglossarystyle</TT>[<I>type</I>]{<I>style list</I>} -<BR> -<BR> -For example: -<PRE> -\setglossarystyle[acronym]{style=long,border=true,cols=2} -</PRE> -If <I>type</I> is omitted, the change is applied to the main -glossary. - -<P> -The command <TT>\setglossary</TT><code>{</code><I>key-val list</I><code>}</code> -can be used to modify some of the glossary settings. The argument -<I>key-val list</I> is a comma-separated list of -<I>key</I>=<I>value</I> pairs. Available keys are: -<DL> -<DT><STRONG><TT>type</TT><A NAME="2679"></A></STRONG></DT> -<DD>This is the glossary type. -If it is omitted, the standard glossary is assumed. - -<P> -</DD> -<DT><STRONG><TT>glsnumformat</TT><A NAME="2683"></A></STRONG></DT> -<DD>This is the name of the command, -<I>without</I> the preceding backslash<A NAME="tex2html4" - HREF="#foot1526"><SUP>3</SUP></A>, to format the -entry numbers. For example, to make all the entry numbers italic, -do: -<PRE> -\setglossary{glsnumformat=textit} -</PRE> -To suppress numbering altogether, you can do: -<PRE> -\setglossary{glsnumformat=ignore} -</PRE> - -<P> -</DD> -<DT><STRONG><TT>glodelim</TT><A NAME="2689"></A></STRONG></DT> -<DD>This -specifies what to do after the entry description and -before the page numbers. The default value is a comma, unless the <TT>cols=3</TT><A NAME="2700"></A> option is specified, -in which case it has the value <code>&</code>, or if -<TT>style=altlist</TT><A NAME="2709"></A>, -in which case it is simply a space<A NAME="tex2html5" - HREF="#foot1527"><SUP>4</SUP></A>. If the package option <TT>number=none</TT><A NAME="2718"></A> is -specified, <TT>glodelim</TT><A NAME="2720"></A> will have an empty value (unless -<TT>cols=3</TT><A NAME="2731"></A> is specified, -where, again, it will have the value <code>&</code>.) -This setting corresponds to the <TT>delim_0</TT><A NAME="2733"></A> key in the -<TT>makeindex</TT><A NAME="2735"></A> style file. - -<P> -Note that if you want a new line between the description -and the list of page numbers you will need to use -<TT>\noexpand</TT>. For example: -<PRE> -\setglossary{delim={\noexpand\newline}} -</PRE> - -<P> -</DD> -<DT><STRONG><TT>delimN</TT><A NAME="2740"></A></STRONG></DT> -<DD> -The delimiter to be inserted between two -page numbers for the same entry. (This corresponds to the -<TT>delim_n</TT><A NAME="2744"></A> key in the <TT>makeindex</TT><A NAME="2746"></A> style file.) -By default, this has the value -<TT>,_</TT> (comma followed by a space). If the -package option <TT>number=none</TT><A NAME="2756"></A> is chosen, the value is set -to empty. - -<P> -</DD> -<DT><STRONG><TT>delimR</TT><A NAME="2758"></A></STRONG></DT> -<DD> -The delimiter to be inserted between the starting and ending page -number range for the same entry. (This corresponds to the -<TT>delim_r</TT><A NAME="2762"></A> key in the <TT>makeindex</TT><A NAME="2764"></A> style file.) -By default, this has the value <code>--</code>. If the -package option <TT>number=none</TT><A NAME="2774"></A> is chosen, the value is set -to empty. - -<P> -</DD> -<DT><STRONG><TT>gloskip</TT><A NAME="2776"></A></STRONG></DT> -<DD> -This specifies what to do between groups. -If <TT>style=list</TT><A NAME="2787"></A> or <TT>style=altlist</TT><A NAME="2796"></A> this has the -value <TT>\indexspace</TT>, otherwise it creates a blank line - in the <TT>longtable</TT> or <TT>supertabular</TT> environment. -This command corresponds to the <TT>group_skip</TT><A NAME="2802"></A> key in -the <TT>makeindex</TT><A NAME="2804"></A> style file. -Note that as from version 2.3, you should no longer redefine -the command <TT>\gloskip</TT>. - -<P> -</DD> -<DT><STRONG><TT>delimT</TT><A NAME="2809"></A></STRONG></DT> -<DD> -The text to be inserted after the list of -page numbers for an entry. (This corresponds to the -<TT>delim_t</TT><A NAME="2813"></A> key in the <TT>makeindex</TT><A NAME="2815"></A> style file.) -The default value depends on the glossary style. It does -nothing for the list-type styles, and has the value -<code>\\</code> for the tabular-type styles. Note that -<TT>delimT</TT><A NAME="2818"></A> is separate from <TT>\glsafternum</TT>. - -<P> -For example, if you are using a 2 column tabular style, -and you want a blank line after every entry (not just -after every group) you can do the following: -<PRE> -\setglossary{delimT={\cr & \cr},gloskip={}} -</PRE> -Note the use of <TT>\cr</TT> instead of <code>\\</code>. -</DD> -</DL> -Note that: -<PRE> -\setglossary{glsnumformat=ignore} -</PRE> -is equivalent to -<PRE> -\setglossary{glsnumformat=ignore,delimN={},delimR={}} -</PRE> - -<P> -The number associated with each entry is, by default, the page number where - that entry was defined. If the package option -<TT>number=section</TT><A NAME="2833"></A> has been chosen, this - will be the section number instead. You can choose a different counter - by changing the value of the command <TT>\theglossarynum</TT>. -For example, suppose you have the following code: -<PRE> -\begin{equation} -\Gamma(z) = \int_{0}^{\infty}e^{-t}t^{z-1}\,dt -\end{equation} -\glossary{name=$\Gamma(z)$,description=Gamma function,sort=Gamma} -</PRE> -and you want the glossary to refer to the equation number, instead of the -page or section number, this can be done by redefining <TT>\theglossarynum</TT> -as follows: -<PRE> -\renewcommand{\theglossarynum}{\theequation} -</PRE> -If the equation number depends on another counter (such as -<TT>chapter</TT>) -you will need to specify that the number is in the form <I>NUM</I>.<I>num</I> - (e.g. 3.24). This can be done by redefining the <TT>\pagecompositor</TT> command: -<PRE> -\renewcommand{\pagecompositor}{.} -</PRE> -(By default this value is <TT>-</TT>, unless the package option -<TT>number=section</TT><A NAME="2848"></A> has -been chosen, in which case this command has the value <TT>.</TT> -(full stop), as in the example above). -The <TT>\pagecompositor</TT> command must be -redefined before <TT>\makeglossary</TT><A NAME="2852"></A> for it to have any effect. -If the package option <TT>number=none</TT><A NAME="2864"></A> is used, -the numbering will be suppressed, regardless -of the value of <TT>\theglossarynum</TT><A NAME="2866"></A>. -This command corresponds to the <TT>page_compositor</TT><A NAME="2871"></A> key -in the <TT>makeindex</TT><A NAME="2873"></A> style file. - -<P> -The start and end of the main body of the glossary is given by the commands: -<TT>\beforeglossary</TT> and -<TT>\afterglossary</TT>. -If the <TT>style=list</TT><A NAME="2887"></A> -or <TT>style=altlist</TT><A NAME="2896"></A> -package options are chosen these commands simply begin and end -the <TT>description</TT> -environment, otherwise these commands begin and end the -<TT>longtable</TT> or -<TT>supertabular</TT> -environment with argument specified by -<TT>\glossaryalignment</TT><A NAME="tex2html6" - HREF="#foot1086"><SUP>5</SUP></A>. - -<P> -The glossary package no longer conflicts with the <TT>array</TT><A NAME="2903"></A> -package. Changes can now be made to <TT>\glossaryalignment</TT> -regardless of whether or not the <TT>array</TT><A NAME="2908"></A> -package has been used. - -<P> -The command <TT>\gloitem</TT> indicates -what to do at the start of each glossary entry. -This command takes one argument, which will be the text specified by the <TT>name</TT><A NAME="2913"></A> key -in the <TT>\glossary</TT><A NAME="2917"></A> command. In the case of the -<TT>style=list</TT><A NAME="2929"></A> option, -<TT>\gloitem</TT><code>{</code><I>text</I><code>}</code> -will do -<BR> -<BR><code>\item[</code><I>text</I><code>]</code> -<BR> -<BR> -or if <TT>style=altlist</TT><A NAME="2940"></A>: -<BR> -<BR><code>\item[</code><I>text</I><code>]\mbox{}\par</code> -<BR> -<BR> -otherwise it will do -<BR> -<BR><I>text</I><code> &</code> -<BR> -<BR> -This command corresponds to the <TT>item_0</TT><A NAME="2942"></A> key in the -<TT>makeindex</TT><A NAME="2944"></A> style file. - -<P> -The command <TT>\glossaryheader</TT> (if <TT>style=long</TT><A NAME="2956"></A> or <TT>style=super</TT><A NAME="2965"></A> is selected) -indicates what to do at the start of the <TT>longtable</TT> or -<TT>supertabular</TT> environment. If <TT>border=none</TT><A NAME="2976"></A>, it -is defined as: -<PRE> -\bfseries\entryname & \bfseries \descriptionname\\ -</PRE> -So, if you want the <TT>\descriptionname</TT><A NAME="2978"></A> to be centred, you could do: -<PRE> -\renewcommand{\glossaryheader}{\bfseries\entryname & - \hfil\bfseries\descriptionname\\} -</PRE> -The command <TT>\glosstail</TT> indicates what to do at the end of -the <TT>longtable</TT> or <TT>supertabular</TT> environment. - -<P> -The width of the second column for the tabular-type styles is given by the length -<TT>\descriptionwidth</TT>. This value can be changed using -the <TT>\setlength</TT> command (the default value is <code>0.6\textwidth</code>). - -<P> - -<H1><A NAME="SECTION000110000000000000000"> -Sample Documents</A> -</H1> -This package comes with the following sample documents: - -<UL> -<LI><TT>sampleSec.tex</TT> -- This document uses the options: -<TT>style=altlist</TT><A NAME="2998"></A>, <TT>toc</TT><A NAME="3005"></A> and -<TT>number=section</TT><A NAME="3016"></A>. It also loads the -<TT>hyperref</TT><A NAME="3018"></A> package before loading the -<TT>glossary</TT><A NAME="3021"></A> package, so the glossary has hyperlinks -to the section numbers. Experimenting with different package -options, will illustrate the different glossary styles. -You will need to do: -<PRE> -pdflatex sampleSec -makeglos.pl sampleSec -pdflatex sampleSec -pdflatex sampleSec -</PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="3024"></A>, you will need -to do -<PRE> -makeindex -s sampleSec.ist -t sampleSec.glg -o sampleSec.gls sampleSec.glo -</PRE> - -<P> -</LI> -<LI><TT>sampleNtn.tex</TT> -- This has a glossary and defines -a new glossary type called <TT>notation</TT>. The glossary has -associated page numbers, but the new glossary type doesn't. -The two glossaries have different styles. -You will need to do: -<PRE> -latex sampleNtn -makeglos.pl sampleNtn -latex sampleNtn -latex sampleNtn -</PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="3027"></A>, you will need -to do -<PRE> -makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.ntn sampleNtn.not -</PRE> - -<P> -</LI> -<LI><TT>sampleNtn2.tex</TT> --This is similar to -<TT>sampleNtn.tex</TT>, but uses <TT>\storeglosentry</TT><A NAME="3030"></A>. - -<P> -</LI> -<LI><TT>sampleEq.tex</TT> -- This has a glossary where the -numbers in the glossary refer to the equation number rather than -the page number. The <TT>\pagecompositor</TT><A NAME="3035"></A>, -<TT>\theglossarynum</TT><A NAME="3040"></A>, <TT>\glossaryname</TT><A NAME="3045"></A> and -<TT>\glossaryheader</TT><A NAME="3050"></A> are all redefined to customize the -glossary. You will need to do: -<PRE> -latex sampleEq -makeglos.pl sampleEq -latex sampleEq -</PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="3055"></A>, you will need -to do -<PRE> -makeindex -s sampleEq.ist -t sampleEq.glg -o sampleEq.gls sampleEq.glo -</PRE> - -<P> -</LI> -<LI><TT>sampleEqPg.tex</TT> -- This is a modified version of -<TT>sampleEq.tex</TT>. This example has one glossary, where some -of the entry numbers refer to the corresponding page number, and -some of the entry numbers refer to the corresponding equation -number. You will need to do: -<PRE> -latex sampleEqPg -makeglos.pl sampleEqPg -latex sampleEqPg -</PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="3058"></A>, you will need -to do -<PRE> -makeindex -s sampleEqPg.ist -t sampleEqPg.glg -o sampleEqPg.gls sampleEqPg.glo -</PRE> - -<P> -</LI> -<LI><TT>sampleAcr.tex</TT> -- This has a glossary containing -acronyms. It uses the style <TT>altlist</TT><A NAME="3061"></A> as this is better -suited to glossaries with long names. It also uses the -<TT>hyperref</TT><A NAME="3063"></A> package, so the page numbers in the -glossary will automatically be hyperlinks, and the acronyms -within the text will have hyperlinks to their corresponding entry -in the glossary. You will need to do: -<PRE> -pdflatex sampleAcr -makeglos.pl sampleAcr -pdflatex sampleAcr -pdflatex sampleAcr -</PRE> -If you don't want to use <TT>makeglos.pl</TT><A NAME="3066"></A>, you will need -to do -<PRE> -makeindex -s sampleAcr.ist -t sampleAcr.glg -o sampleAcr.gls sampleAcr.glo -</PRE> - -<P> -</LI> -<LI><TT>sample.tex</TT> -- This has a glossary entry -with two different definitions of the same name. -If you just use <TT>makeindex</TT><A NAME="3069"></A>, the two entries -will be treated separately, however, if you want them -concatenated, you can use <TT>makeglos.pl</TT><A NAME="3072"></A> with -the <TT>-m</TT> switch. You will need to do: -<PRE> -pdflatex sample -makeglos.pl -m sample -pdflatex sample -pdflatex sample -</PRE> -(Depending on the configuration of your system, you -may have to do <TT>perl makeglos.pl</TT> instead of -just <TT>makeglos.pl</TT><A NAME="3075"></A>) - -<P> -If you don't want to use <TT>makeglos.pl</TT><A NAME="3078"></A>, you will need -to do -<PRE> -makeindex -s sample.ist -t sample.glg -o sample.gls sample.glo -</PRE> -however, the entries with the same name but multiple descriptions -will not be merged. - -<P> -</LI> -</UL> - -<P> - -<H1><A NAME="SECTION000120000000000000000"></A> -<A NAME="sec:l2h"></A> -<BR> -LaTeX2HTML Style File -</H1> - -<P> -A LaTeX2HTML Perl script, <TT>glossary.perl</TT><A NAME="3081"></A>, is -provided with this package for those wishing to use the -glossary package with the LaTeX2HTML translator. -The file <TT>glossary.perl</TT><A NAME="3083"></A> should be extracted -along with <TT>glossary.sty</TT> when you run the -installation script (<TT>glossary.ins</TT>) through LaTeX. - -<P> - -<H2><A NAME="SECTION000121000000000000000"> -Limitations</A> -</H2> - -<P> - -<UL> -<LI>The only package options supported are: -<TT>style=altlist</TT><A NAME="3092"></A>, <TT>hyper=true</TT><A NAME="3101"></A>, <TT>toc=true</TT><A NAME="3110"></A>, -<TT>acronym=true</TT><A NAME="3119"></A> and <TT>acronym=false</TT><A NAME="3128"></A>. - -<P> -</LI> -<LI>If you have more than one glossary type, the -secondary glossaries will occur in the same segment -as the primary glossary if you use the command -<code>\print</code><I>name</I> instead of -<code>\printglossary[</code><I>name</I><code>]</code>, where -<I>name</I> is the name of the glossary type. - -<P> -</LI> -<LI>The command <TT>\setglossary</TT><A NAME="3130"></A> must be -placed in the preamble to have an effect. - -<P> -</LI> -<LI>The <TT>\storeglosentry</TT><A NAME="3135"></A> commands must be in -the document environment to have an effect. (They don't -seem to work in the preamble, I don't know why.) - -<P> -</LI> -<LI>If you place a <TT>\glossary</TT><A NAME="3140"></A> command -inside an environment not translated by LaTeX2HTML -(for example, inside a mathematics environment), -it will not be entered into the glossary. - -<P> -</LI> -<LI>The combinations <code>""</code>, <code>"|</code>, <code>"!</code> -and <code>"@</code> will be correctly translated, unless they -occur within a maths environment. This is because -the maths environment is translated before being -passed to <TT>\glossary</TT><A NAME="3145"></A>. You can overcome this -by doing, e.g.: -<BR><TT>\begin</TT><code>{latexonly}</code> -<BR><code>\glossary{name=$"|\mathcal{S}"|$,description=cardinality of set</code> -<BR><code>$\mathcal{S}$,sort=cardinality}</code> -<BR><TT>\end</TT><code>{latexonly}</code> -<BR><TT>\begin</TT><code>{htmlonly}</code> -<BR><code>\glossary{name=$|\mathcal{S}|$,description=cardinality of set</code> -<BR><code>$\mathcal{S}$,sort=cardinality}</code> -<BR><TT>\end</TT><code>{htmlonly}</code> - -<P> -Alternative, you can use <TT>\mid</TT> instead: -<PRE> -\glossary{name=$\mid\mathcal{S}\mid$,description=cardinality of -set $\mathcal{S}$,sort=cardinality} -</PRE> - -<P> -</LI> -<LI>Glossary items with the same names but different -definitions will not be merged. - -<P> -</LI> -<LI>The command <TT>\theglossarynum</TT><A NAME="3160"></A> is ignored -by LaTeX2HTML, as page numbers have no meaning within -HTML files. - -<P> -</LI> -<LI>The configuration file <TT>glossary.cfg</TT> is ignored. - -<P> -</LI> -</UL> - -<P> - -<H1><A NAME="SECTION000130000000000000000"></A> -<A NAME="sec:trouble"></A> -<BR> -Troubleshooting -</H1> - -<OL> -<LI>My glossary hasn't appeared. - -<P> -Check the following: - -<UL> -<LI>Have you included the command <TT>\makeglossary</TT><A NAME="3165"></A> -in the preamble? - -<P> -</LI> -<LI>Have you put the command <TT>\printglossary</TT><A NAME="3170"></A> where -you want the glossary to appear? - -<P> -</LI> -<LI>Have you used <TT>makeglos.pl</TT><A NAME="3175"></A> or <TT>makeindex</TT><A NAME="3178"></A>, -and if you did, did it successfully create the <TT>gls</TT><A NAME="3181"></A> -file? (Check the transcript <TT>glg</TT><A NAME="3183"></A> file.) - -<P> - -<UL> -<LI>If you used <TT>makeindex</TT><A NAME="3185"></A> directly, did you specify -the <TT>ist</TT><A NAME="3188"></A> file created by <TT>\makeglossary</TT><A NAME="3190"></A>, -and did you remember to specify the output file with the extension -<TT>gls</TT><A NAME="3195"></A>? - -<P> -</LI> -<LI>When <TT>makeindex</TT><A NAME="3197"></A> scans the <TT>ist</TT><A NAME="3200"></A> file, -it should generate the message: -<PRE> -9 attributes redefined, 0 ignored -</PRE> -If you have a number other than 0 ignored, then there is something -wrong with the <TT>ist</TT><A NAME="3202"></A> file. Some packages can cause -problems with the creation of this file, see -item <A HREF="#itm:ngerman">16</A> below. -</LI> -</UL> - -<P> -</LI> -<LI>Have you remembered to LaTeX your document again -after using <TT>makeglos.pl</TT><A NAME="3204"></A> or <TT>makeindex</TT><A NAME="3207"></A>? - -<P> -</LI> -<LI>Have you used <TT>\glossary</TT><A NAME="3210"></A> or <TT>\xglossary</TT><A NAME="3215"></A>? - -<P> -</LI> -<LI>If you have used <TT>\storeglosentry</TT><A NAME="3220"></A>, have you also -used <TT>\useglosentry</TT><A NAME="3225"></A>, <TT>\useGlosentry</TT><A NAME="3230"></A> or -<TT>\gls</TT><A NAME="3235"></A>? -</LI> -</UL> - -<P> -If you have defined a new glossary type, have you checked -all the analogous commands to the above? - -<P> -</LI> -<LI>My list of acronyms hasn't appeared. - -<P> -Have you used the <TT>acronym=true</TT><A NAME="3247"></A> package option? If no, -check the answers to the previous item, if yes, make sure -you have used <TT>\makeacronym</TT><A NAME="3249"></A> and <TT>\printacronym</TT><A NAME="3254"></A>. -Have you used any of the acronyms you have defined? Remember -that <TT>\acrsh</TT>, <TT>\acrln</TT>, -<TT>\</TT><I>acr-name</I><TT>short</TT> and -<TT>\</TT><I>acr-name</I><TT>long</TT> don't generate entries -in the list of acronyms, where <TT>\</TT><I>acr-name</I> is the -name of an acronym command. - -<P> -</LI> -<LI>My acronym has been expanded twice. - -<P> -By default, if any of your acronym commands occur within a -group (this includes environments which form implicit grouping) -the effect will be local to that group. You can either unset -the acronym outside the group, or use the <TT>global</TT><A NAME="3274"></A> -package option. - -<P> -</LI> -<LI>I get an error when using the command -<TT>\saveglosentry</TT><A NAME="3278"></A>. - -<P> -Don't use this command it's obsolete, use -<TT>\storeglosentry</TT><A NAME="3283"></A> instead. - -<P> -</LI> -<LI>One of more of my glossary entries hasn't appeared. - -<P> -Check the following - -<UL> -<LI>If you defined the entry using <TT>\storeglosentry</TT><A NAME="3288"></A> -have you used either <TT>\useglosentry</TT><A NAME="3293"></A>, -<TT>\useGlosentry</TT><A NAME="3298"></A> or <TT>\gls</TT><A NAME="3303"></A>? - -<P> -</LI> -<LI>Have you remembered to <TT>\protect</TT><A NAME="3308"></A> commands -such as <TT>\mathcal</TT> within <TT>\storeglosentry</TT><A NAME="3315"></A>? - -<P> -</LI> -<LI>Have you used the characters <TT>@</TT> <TT>!</TT> -<TT>|</TT> <code>"</code>? If so, have you preceded them -with a double quote character? -</LI> -</UL> - -<P> -Check the <TT>makeindex</TT><A NAME="3320"></A> log file to see if there are -any error messages. - -<P> -</LI> -<LI>My glossary has duplicate entries on separate lines. - -<P> -LaTeX treats multiple spaces equivalent to a single space, but <TT>makeindex</TT><A NAME="3323"></A> -takes spaces into account when determining whether two entries are identical. -For example: -<PRE> -\glossary{name=Identity matrix, -description=diagonal matrix with 1's along the diagonal} -</PRE> -and -<PRE> -\glossary{name=Identity matrix, -description=diagonal matrix with 1's along the diagonal} -</PRE> -will be treated as different entries by <TT>makeindex</TT><A NAME="3326"></A>, -because the first has only one space -between `Identity' and `matrix' and the second has two. -The easiest way to ensure consistency is to use -<TT>\storeglosentry</TT><A NAME="3329"></A> together with <TT>\useglosentry</TT><A NAME="3334"></A>, -<TT>\useGlosentry</TT><A NAME="3339"></A> or <TT>\gls</TT><A NAME="3344"></A>. - -<P> -</LI> -<LI>I had an error, fixed it, but I keep getting the same error message. - -<P> -Suppose you've made an error in the <TT>\glossary</TT><A NAME="3349"></A> command. For example: -<PRE> -\glossary{name=Java,description=A programming language,format=texbf} -</PRE> -In this case <TT>textbf</TT> has been mis-spelt. This error will be copied to the <TT>glo</TT><A NAME="3354"></A> file, -which in turn will be copied to the <TT>gls</TT><A NAME="3356"></A> file by -<TT>makeindex</TT><A NAME="3358"></A>. A subsequent run of LaTeX will -read this error in. If you fix the error in your main document, the error will still be read in from -the <TT>gls</TT><A NAME="3361"></A> file. The best thing to do is to delete the -<TT>gls</TT><A NAME="3363"></A> file, and try again. - -<P> -</LI> -<LI>My glossary has ended up wider than my page. - -<P> -This may occur if you have long entry names, and you are using -either the <TT>style=long</TT><A NAME="3372"></A> or <TT>style=super</TT><A NAME="3381"></A> -options. The width of the description column is proportional to -the text width (in fact, it's <code>0.6\textwidth</code>) -but the first column is as wide as the widest entry name. You -can either redefine <TT>\glossaryalignment</TT><A NAME="3383"></A> to change the -column specifications, or use one of the list-type styles. - -<P> -</LI> -<LI>The page numbers in my glossary don't match up with the actual page numbers where the entry -was defined. - -<P> -You may need to LaTeX your document again (just as you have to do with <TT>\tableofcontents</TT>, <TT>\listoffigures</TT> etc). - -<P> -</LI> -<LI>I'm getting a <TT>keyval</TT><A NAME="3392"></A> error. - -<P> -The <TT>glossary</TT><A NAME="3395"></A> package uses the <TT>keyval</TT><A NAME="3398"></A> -package to extract the information from <I>key</I>=<I>value</I> -comma separated lists. You need to make sure the syntax is correct. If your <I>value</I> contains a -comma, you will need to enclose <I>value</I> in curly braces. See the <TT>keyval</TT><A NAME="3401"></A> documentation for -further information<A NAME="tex2html7" - HREF="#foot1529"><SUP>6</SUP></A>. - -<P> -</LI> -<LI>I've used the <TT>hyper</TT><A NAME="3409"></A> option, but nothing happens -when I click on the numbers in the glossary. - -<P> -Check the following: - -<OL> -<LI>Have you remembered to use PDFLaTeX instead of LaTeX, -or used a driver that understands hyperlinks? -</LI> -<LI>Have you remembered to use the <TT>hyperref</TT><A NAME="3413"></A> or -<TT>html</TT><A NAME="3416"></A> package? -</LI> -<LI>Have you remembered to use a formatting command which uses <TT>\hyperlink</TT>? (E.g. using <TT>hyperbf</TT><A NAME="3421"></A><A NAME="3422"></A> instead -of <TT>textbf</TT>)? Remember to check the <TT>format</TT><A NAME="3426"></A> key -in your <TT>\glossary</TT><A NAME="3430"></A> commands, and the -<TT>glsnumformat</TT><A NAME="3435"></A> key in the <TT>\setglossary</TT><A NAME="3439"></A> -command. -</LI> -<LI>What application are you using to view the PDF file? -Ghostview can display a PDF file, but ignores the links. If you are using Windows, try -using Adobe's Acrobat Reader, or if you are using UNIX or Linux, try using <TT>xpdf</TT><A NAME="3444"></A> or <TT>acroread</TT><A NAME="3447"></A>. -</LI> -</OL> - -<P> -</LI> -<LI>The <TT>glossary</TT><A NAME="3450"></A> package conflicts with the -<TT>datetime</TT><A NAME="3453"></A> package. - -<P> -This has been fixed in version 2.01. - -<P> -</LI> -<LI>I get an error when using certain commands, such as <TT>\cite</TT> or <code>~</code> in <TT>\newacronym</TT><A NAME="3458"></A>. - -<P> -This has been fixed in version 2.1. - -<P> -</LI> -<LI>I get the following error: -<PRE> -! Package array Error: Illegal pream-token (\glossaryalignment): `c' used. -</PRE> - -<P> -The <TT>glossary</TT><A NAME="3463"></A> package used to conflict with the -<TT>array</TT><A NAME="3466"></A> package. This was fixed in version 2.1. -As from version 2.3, it doesn't matter whether you load -the <TT>glossary</TT><A NAME="3469"></A> package before or after the -<TT>array</TT><A NAME="3472"></A> package. - -<P> -</LI> -<LI><A NAME="itm:fragile"></A> I get the following error: -<PRE> -Use of \@chapter doesn't match its definition -</PRE> -or -<PRE> -! Argument of \@sect has an extra } -</PRE> - -<P> -If you want to use an acronym command in a moving argument (such as a chapter heading) -you need to <TT>\protect</TT> it first. Note that if you do put an acronym in a chapter etc -heading, it will be expanded for the first time in the table of contents, not -in the chapter heading. The best way to get around this is to use the -optional argument, e.g. -<PRE> -\chapter[Introduction to Kernel Support Vector Machines]{Introduction -to \protect\KSVM} -</PRE> -You will also need to do this if you are using bookmarks in a PDF document. - -<P> -Alternatively, you can do: -<PRE> -\resetacronym{KSVM} -\chapter{Introduction to \protect\KSVM} -</PRE> -or if you are using PDFLaTeX: -<PRE> -\resetacronym{KSVM} -\chapter{Introduction to \texorpdfstring{\protect\KSVM}{KSVM}} -</PRE> - -<P> -</LI> -<LI><A NAME="itm:ngerman"></A> The <TT>glossary</TT><A NAME="3477"></A> package conflicts with -<TT>ngerman</TT><A NAME="3480"></A>. - -<P> -This problem is caused by the fact that <TT>ngerman</TT><A NAME="3483"></A> -redefines the effect of the double quote -character, but this character is used in the creation of the -<TT>ist</TT><A NAME="3486"></A> <TT>makeindex</TT><A NAME="3488"></A> style file. -Try one of the following methods: - -<OL> -<LI>Include the <TT>ngerman</TT><A NAME="3491"></A> package after the -<TT>\makeglossary</TT><A NAME="3494"></A> command: -<PRE> -\usepackage{glossary} -\makeglossary -\usepackage{ngerman} -</PRE> - -<P> -</LI> -<LI>First omit the <TT>ngerman</TT><A NAME="3499"></A> package and include -<TT>\makeglossary</TT><A NAME="3502"></A> then LaTeX your document. -This will create the <TT>ist</TT><A NAME="3507"></A> file. Then include the -<TT>ngerman</TT><A NAME="3509"></A> package, and insert <TT>\noist</TT><A NAME="3512"></A> before -the <TT>\makeglossary</TT><A NAME="3517"></A> command, this will prevent further attempts to generate the <TT>ist</TT><A NAME="3522"></A> file. -<PRE> -\usepackage{ngerman} -\usepackage{glossary} -\noist\makeglossary -</PRE> - -<P> -</LI> -<LI>Use <TT>\noist</TT><A NAME="3524"></A>, as above, and create the -<TT>ist</TT><A NAME="3529"></A> file -in an ordinary text editor. The file should contain the -following lines: -<PRE> -keyword "\\glossaryentry" -preamble "\\begin{theglossary}" -postamble "\n\\end{theglossary}\n" -group_skip "\\gloskip " -item_0 "\n\\gloitem " -delim_0 "\n\\glodelim " -page_compositor "-" -delim_n "\\delimN " -delim_r "\\delimR " -</PRE> -</LI> -</OL> -It is possible that there may be other packages which will -also cause a problem, if so, try any of the above. - -<P> -</LI> -<LI><TT>makeglos.pl</TT><A NAME="3531"></A> gives the following error message: -<PRE> -unable to extract name from glossary item: -</PRE> - -<P> -You are using an old version of <TT>makeglos.pl</TT><A NAME="3534"></A> with a -new version of the <TT>glossary</TT><A NAME="3537"></A> package. You will need -to update your version <TT>makeglos.pl</TT><A NAME="3540"></A>. -</LI> -</OL> -Let me know if you encounter any other problems or if you have any comments regarding this package. - -<P> - -<H1><A NAME="SECTION000140000000000000000"> -Obsolete Commands</A> -</H1> - -<P> -The commands described in this section are now obsolete, but -are currently still provided for backwards compatibility. Their -use is deprecated. - -<P> - -<TT>\saveglosentry</TT><A NAME="3543"></A>{ <I>name</I>}{<I>description</I>} -<BR> -This command has now been replaced by <TT>\storeglosentry</TT>. - -<P> -The command <TT>\glsprimaryfmt</TT> is no longer used in <TT>\newacronym</TT><A NAME="3552"></A> as you can end up with duplicate -page numbers, however the command is currently still defined (although it - may be removed in future versions.) - -<P> -The package option <TT>hyperacronym</TT><A NAME="3562"></A> is now superseded by the package option -<TT>hyper</TT><A NAME="3571"></A>. This option was implemented prior to the -introduction of the command <TT>\xglossary</TT><A NAME="3575"></A>. Since the -acronyms now use <TT>\xglossary</TT><A NAME="3580"></A>, there is no difference -between the <TT>hyperacronym</TT><A NAME="3590"></A> and <TT>hyper</TT><A NAME="3599"></A> options. -This option has a boolean value: - -<DL> -<DT><STRONG><TT>true</TT><A NAME="3603"></A></STRONG></DT> -<DD>Make acronyms link to their corresponding entry in the glossary -</DD> -<DT><STRONG><TT>false</TT><A NAME="3605"></A></STRONG></DT> -<DD>Acronyms don't have a hyperlink. -</DD> -</DL> -If the <TT>hyperref</TT><A NAME="3607"></A> package has been loaded prior to -loading <TT>glossary.sty</TT> or if <TT>hyper=true</TT><A NAME="3617"></A> is set, -<TT>hyperacronym=true</TT><A NAME="3626"></A> otherwise -<TT>hyperacronym=false</TT><A NAME="3635"></A>. -<P> - -<H1><A NAME="SECTION000150000000000000000"> -Contact Details</A> -</H1> - -Dr Nicola Talbot -<BR> -School of Computing Sciences -<BR> -University of East Anglia -<BR> -Norwich. Norfolk -<BR> -NR4 7TJ. United Kingdom. -<BR><TT><A NAME="tex2html8" - HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT> -<P> - -<H1><A NAME="SECTION000160000000000000000"> -Acknowledgements</A> -</H1> - -<P> -I would like to thank the following people for their -suggestions: -Jens Happe, -Dmitry Katsubo, -Markus Lazanowski, -Slava Pestov and -Dario Teixeira - -<P> - -<P> -<BR> - -<H2><A NAME="SECTION000170000000000000000"> -Index</A> -</H2><DL COMPACT> -<DT><STRONG><TT>acroread</TT></STRONG> -<DD><A HREF="manual.html#3447">Troubleshooting</A> -<DT><STRONG><TT>array</TT></STRONG> -<DD><A HREF="manual.html#2903">Customizing the Glossary</A> - | <A HREF="manual.html#2908">Customizing the Glossary</A> - | <A HREF="manual.html#3466">Troubleshooting</A> - | <A HREF="manual.html#3472">Troubleshooting</A> -<DT><STRONG><TT>datetime</TT></STRONG> -<DD><A HREF="manual.html#3453">Troubleshooting</A> -<DT><STRONG><TT>\descriptionname</TT></STRONG> -<DD><A HREF="manual.html#2978">Customizing the Glossary</A> -<DT><STRONG>file types</STRONG> -<DD><DL COMPACT> -<DT><STRONG>acr</STRONG> -<DD><A HREF="manual.html#2488">Acronyms</A> -<DT><STRONG>cfg</STRONG> -<DD><A HREF="manual.html#2146">Package Options</A> -<DT><STRONG>glg</STRONG> -<DD><A HREF="manual.html#1756">makeglos.pl</A> - | <A HREF="manual.html#2380">Defining New Glossary Types</A> - | <A HREF="manual.html#3183">Troubleshooting</A> -<DT><STRONG>glo</STRONG> -<DD><A HREF="manual.html#1729">makeglos.pl</A> - | <A HREF="manual.html#1744">makeglos.pl</A> - | <A HREF="manual.html#1764">makeglos.pl</A> - | <A HREF="manual.html#1775">makeglos.pl</A> - | <A HREF="manual.html#2364">Defining New Glossary Types</A> - | <A HREF="manual.html#3354">Troubleshooting</A> -<DT><STRONG>gls</STRONG> -<DD><A HREF="manual.html#1754">makeglos.pl</A> - | <A HREF="manual.html#1819">Displaying the Glossary</A> - | <A HREF="manual.html#2375">Defining New Glossary Types</A> - | <A HREF="manual.html#3181">Troubleshooting</A> - | <A HREF="manual.html#3195">Troubleshooting</A> - | <A HREF="manual.html#3356">Troubleshooting</A> - | <A HREF="manual.html#3361">Troubleshooting</A> - | <A HREF="manual.html#3363">Troubleshooting</A> -<DT><STRONG>ist</STRONG> -<DD><A HREF="manual.html#1739">makeglos.pl</A> - | <A HREF="manual.html#1749">makeglos.pl</A> - | <A HREF="manual.html#1780">makeglos.pl</A> - | <A HREF="manual.html#1787">makeglos.pl</A> - | <A HREF="manual.html#1806">makeglos.pl</A> - | <A HREF="manual.html#3188">Troubleshooting</A> - | <A HREF="manual.html#3200">Troubleshooting</A> - | <A HREF="manual.html#3202">Troubleshooting</A> - | <A HREF="manual.html#3486">Troubleshooting</A> - | <A HREF="manual.html#3507">Troubleshooting</A> - | <A HREF="manual.html#3522">Troubleshooting</A> - | <A HREF="manual.html#3529">Troubleshooting</A> -<DT><STRONG>perl</STRONG> -<DD><A HREF="manual.html#3081">LaTeX2HTML Style File</A> - | <A HREF="manual.html#3083">LaTeX2HTML Style File</A> -</DL> -<DT><STRONG><TT>\glodesc</TT></STRONG> -<DD><A HREF="manual.html#2533">Acronyms</A> - | <A HREF="manual.html#2547">Acronyms</A> -<DT><STRONG><TT>\glolong</TT></STRONG> -<DD><A HREF="manual.html#2511">Acronyms</A> - | <A HREF="manual.html#2523">Acronyms</A> -<DT><STRONG><TT>\gloshort</TT></STRONG> -<DD><A HREF="manual.html#2516">Acronyms</A> - | <A HREF="manual.html#2528">Acronyms</A> -<DT><STRONG><TT>glossary</TT></STRONG> -<DD><A HREF="manual.html#1591">Introduction</A> - | <A HREF="manual.html#1694">Generating Glossary Information</A> - | <A HREF="manual.html#2150">Package Options</A> - | <A HREF="manual.html#2153">Examples</A> - | <A HREF="manual.html#2333">Defining New Glossary Types</A> - | <A HREF="manual.html#2412">Acronyms</A> - | <A HREF="manual.html#2417">Acronyms</A> - | <A HREF="manual.html#2606">Acronyms</A> - | <A HREF="manual.html#2641">Customizing the Glossary</A> - | <A HREF="manual.html#2917">Customizing the Glossary</A> - | <A HREF="manual.html#3021">Sample Documents</A> - | <A HREF="manual.html#3140">Limitations</A> - | <A HREF="manual.html#3145">Limitations</A> - | <A HREF="manual.html#3210">Troubleshooting</A> - | <A HREF="manual.html#3349">Troubleshooting</A> - | <A HREF="manual.html#3395">Troubleshooting</A> - | <A HREF="manual.html#3430">Troubleshooting</A> - | <A HREF="manual.html#3450">Troubleshooting</A> - | <A HREF="manual.html#3463">Troubleshooting</A> - | <A HREF="manual.html#3469">Troubleshooting</A> - | <A HREF="manual.html#3477">Troubleshooting</A> - | <A HREF="manual.html#3537">Troubleshooting</A> -<DT><STRONG>glossary border</STRONG> -<DD><i>see </i> package options, border -<DT><STRONG>glossary columns</STRONG> -<DD><i>see </i> package options, cols -<DT><STRONG>glossary header</STRONG> -<DD><i>see </i> package options, header -<DT><STRONG><TT>\glossary</TT> keys</STRONG> -<DD><DL COMPACT> -<DT><STRONG>description</STRONG> -<DD><A HREF="manual.html#1620">Generating Glossary Information</A> - | <A HREF="manual.html#1717">Storing Glossary Information</A> - | <A HREF="manual.html#2538">Acronyms</A> -<DT><STRONG>format</STRONG> -<DD><A HREF="manual.html#1628">Generating Glossary Information</A> - | <A HREF="manual.html#1632">Generating Glossary Information</A> - | <A HREF="manual.html#3426">Troubleshooting</A> -<DD><DL COMPACT> -<DT><STRONG>hyperbf</STRONG> -<DD><A HREF="manual.html#1654">Generating Glossary Information</A> - | <A HREF="manual.html#3422">Troubleshooting</A> -<DT><STRONG>hyperit</STRONG> -<DD><A HREF="manual.html#1659">Generating Glossary Information</A> -<DT><STRONG>hyperrm</STRONG> -<DD><A HREF="manual.html#1639">Generating Glossary Information</A> - | <A HREF="manual.html#1673">Generating Glossary Information</A> -<DT><STRONG>hypersf</STRONG> -<DD><A HREF="manual.html#1644">Generating Glossary Information</A> -<DT><STRONG>hypertt</STRONG> -<DD><A HREF="manual.html#1649">Generating Glossary Information</A> -</DL> -<DT><STRONG>name</STRONG> -<DD><A HREF="manual.html#1616">Generating Glossary Information</A> - | <A HREF="manual.html#2431">Acronyms</A> - | <A HREF="manual.html#2440">Acronyms</A> - | <A HREF="manual.html#2505">Acronyms</A> - | <A HREF="manual.html#2913">Customizing the Glossary</A> -<DT><STRONG>sort</STRONG> -<DD><A HREF="manual.html#1624">Generating Glossary Information</A> - | <A HREF="manual.html#2446">Acronyms</A> -</DL> -<DT><STRONG>glossary style</STRONG> -<DD><i>see </i> package options, style -<DT><STRONG>glossary.cfg</STRONG> -<DD><i>see </i> file type, cfg -<DT><STRONG><TT>\glossaryalignment</TT></STRONG> -<DD><A HREF="manual.html#3383">Troubleshooting</A> -<DT><STRONG><TT>\glossaryheader</TT></STRONG> -<DD><A HREF="manual.html#3050">Sample Documents</A> -<DT><STRONG><TT>\glossaryname</TT></STRONG> -<DD><A HREF="manual.html#1825">Displaying the Glossary</A> - | <A HREF="manual.html#2405">Defining New Glossary Types</A> - | <A HREF="manual.html#3045">Sample Documents</A> -<DT><STRONG><TT>\gls</TT></STRONG> -<DD><A HREF="manual.html#3235">Troubleshooting</A> - | <A HREF="manual.html#3303">Troubleshooting</A> - | <A HREF="manual.html#3344">Troubleshooting</A> -<DT><STRONG><TT>html</TT></STRONG> -<DD><A HREF="manual.html#2012">Package Options</A> - | <A HREF="manual.html#3416">Troubleshooting</A> -<DT><STRONG><TT>hyperref</TT></STRONG> -<DD><A HREF="manual.html#1943">Package Options</A> - | <A HREF="manual.html#2009">Package Options</A> - | <A HREF="manual.html#3018">Sample Documents</A> - | <A HREF="manual.html#3063">Sample Documents</A> - | <A HREF="manual.html#3413">Troubleshooting</A> - | <A HREF="manual.html#3607">Obsolete Commands</A> -<DT><STRONG><TT>\hyperrm</TT></STRONG> -<DD><A HREF="manual.html#1677">Generating Glossary Information</A> -<DT><STRONG><TT>keyval</TT></STRONG> -<DD><A HREF="manual.html#3392">Troubleshooting</A> - | <A HREF="manual.html#3398">Troubleshooting</A> - | <A HREF="manual.html#3401">Troubleshooting</A> -<DT><STRONG><TT>\makeacronym</TT></STRONG> -<DD><A HREF="manual.html#2478">Acronyms</A> - | <A HREF="manual.html#3249">Troubleshooting</A> -<DT><STRONG><TT>makeglos.pl</TT></STRONG> -<DD><A HREF="manual.html#1758">makeglos.pl</A> - | <A HREF="manual.html#1766">makeglos.pl</A> - | <A HREF="manual.html#1769">makeglos.pl</A> - | <A HREF="manual.html#1777">makeglos.pl</A> - | <A HREF="manual.html#1784">makeglos.pl</A> - | <A HREF="manual.html#2369">Defining New Glossary Types</A> - | <A HREF="manual.html#2382">Defining New Glossary Types</A> - | <A HREF="manual.html#2388">Defining New Glossary Types</A> - | <A HREF="manual.html#2391">Defining New Glossary Types</A> - | <A HREF="manual.html#2394">Defining New Glossary Types</A> - | <A HREF="manual.html#2493">Acronyms</A> - | <A HREF="manual.html#3024">Sample Documents</A> - | <A HREF="manual.html#3027">Sample Documents</A> - | <A HREF="manual.html#3055">Sample Documents</A> - | <A HREF="manual.html#3058">Sample Documents</A> - | <A HREF="manual.html#3066">Sample Documents</A> - | <A HREF="manual.html#3072">Sample Documents</A> - | <A HREF="manual.html#3075">Sample Documents</A> - | <A HREF="manual.html#3078">Sample Documents</A> - | <A HREF="manual.html#3175">Troubleshooting</A> - | <A HREF="manual.html#3204">Troubleshooting</A> - | <A HREF="manual.html#3531">Troubleshooting</A> - | <A HREF="manual.html#3534">Troubleshooting</A> - | <A HREF="manual.html#3540">Troubleshooting</A> -<DT><STRONG><TT>\makeglossary</TT></STRONG> -<DD><A HREF="manual.html#1731">makeglos.pl</A> - | <A HREF="manual.html#1791">makeglos.pl</A> - | <A HREF="manual.html#1801">makeglos.pl</A> - | <A HREF="manual.html#1811">makeglos.pl</A> - | <A HREF="manual.html#2328">Defining New Glossary Types</A> - | <A HREF="manual.html#2852">Customizing the Glossary</A> - | <A HREF="manual.html#3165">Troubleshooting</A> - | <A HREF="manual.html#3190">Troubleshooting</A> - | <A HREF="manual.html#3494">Troubleshooting</A> - | <A HREF="manual.html#3502">Troubleshooting</A> - | <A HREF="manual.html#3517">Troubleshooting</A> -<DT><STRONG><TT>makeindex</TT></STRONG> -<DD><A HREF="manual.html#1594">Installation</A> - | <A HREF="manual.html#1600">Installation</A> - | <A HREF="manual.html#1603">Installation</A> - | <A HREF="manual.html#1736">makeglos.pl</A> - | <A HREF="manual.html#1741">makeglos.pl</A> - | <A HREF="manual.html#1746">makeglos.pl</A> - | <A HREF="manual.html#1751">makeglos.pl</A> - | <A HREF="manual.html#1761">makeglos.pl</A> - | <A HREF="manual.html#1772">makeglos.pl</A> - | <A HREF="manual.html#1816">makeglos.pl</A> - | <A HREF="manual.html#1821">Displaying the Glossary</A> - | <A HREF="manual.html#2366">Defining New Glossary Types</A> - | <A HREF="manual.html#2372">Defining New Glossary Types</A> - | <A HREF="manual.html#2377">Defining New Glossary Types</A> - | <A HREF="manual.html#2385">Defining New Glossary Types</A> - | <A HREF="manual.html#2397">Defining New Glossary Types</A> - | <A HREF="manual.html#2490">Acronyms</A> - | <A HREF="manual.html#2735">Customizing the Glossary</A> - | <A HREF="manual.html#2746">Customizing the Glossary</A> - | <A HREF="manual.html#2764">Customizing the Glossary</A> - | <A HREF="manual.html#2804">Customizing the Glossary</A> - | <A HREF="manual.html#2815">Customizing the Glossary</A> - | <A HREF="manual.html#2873">Customizing the Glossary</A> - | <A HREF="manual.html#2944">Customizing the Glossary</A> - | <A HREF="manual.html#3069">Sample Documents</A> - | <A HREF="manual.html#3178">Troubleshooting</A> - | <A HREF="manual.html#3185">Troubleshooting</A> - | <A HREF="manual.html#3197">Troubleshooting</A> - | <A HREF="manual.html#3207">Troubleshooting</A> - | <A HREF="manual.html#3320">Troubleshooting</A> - | <A HREF="manual.html#3323">Troubleshooting</A> - | <A HREF="manual.html#3326">Troubleshooting</A> - | <A HREF="manual.html#3358">Troubleshooting</A> - | <A HREF="manual.html#3488">Troubleshooting</A> -<DT><STRONG>makeindex key</STRONG> -<DD><DL COMPACT> -<DT><STRONG>delim_0</STRONG> -<DD><A HREF="manual.html#2733">Customizing the Glossary</A> -<DT><STRONG>delim_n</STRONG> -<DD><A HREF="manual.html#2744">Customizing the Glossary</A> -<DT><STRONG>delim_r</STRONG> -<DD><A HREF="manual.html#2762">Customizing the Glossary</A> -<DT><STRONG>delim_t</STRONG> -<DD><A HREF="manual.html#2813">Customizing the Glossary</A> -<DT><STRONG>group_skip</STRONG> -<DD><A HREF="manual.html#2802">Customizing the Glossary</A> -<DT><STRONG>item_0</STRONG> -<DD><A HREF="manual.html#2942">Customizing the Glossary</A> -<DT><STRONG>page_compositor</STRONG> -<DD><A HREF="manual.html#2871">Customizing the Glossary</A> -</DL> -<DT><STRONG>makeindex style file (.ist)</STRONG> -<DD><i>see </i> file types, ist -<DT><STRONG><TT>\newacronym</TT></STRONG> -<DD><A HREF="manual.html#2542">Acronyms</A> - | <A HREF="manual.html#3458">Troubleshooting</A> - | <A HREF="manual.html#3552">Obsolete Commands</A> -<DT><STRONG><TT>\newglossarystyle</TT></STRONG> -<DD><A HREF="manual.html#2670">Customizing the Glossary</A> -<DT><STRONG><TT>ngerman</TT></STRONG> -<DD><A HREF="manual.html#1808">makeglos.pl</A> - | <A HREF="manual.html#3480">Troubleshooting</A> - | <A HREF="manual.html#3483">Troubleshooting</A> - | <A HREF="manual.html#3491">Troubleshooting</A> - | <A HREF="manual.html#3499">Troubleshooting</A> - | <A HREF="manual.html#3509">Troubleshooting</A> -<DT><STRONG><TT>\nofiles</TT></STRONG> -<DD><A HREF="manual.html#1796">makeglos.pl</A> -<DT><STRONG><TT>\noist</TT></STRONG> -<DD><A HREF="manual.html#3512">Troubleshooting</A> - | <A HREF="manual.html#3524">Troubleshooting</A> -<DT><STRONG>package options</STRONG> -<DD><DL COMPACT> -<DT><STRONG>acronym</STRONG> -<DD><A HREF="manual.html#2060">Package Options</A> - | <A HREF="manual.html#2062">Package Options</A> - | <A HREF="manual.html#2455">Acronyms</A> - | <A HREF="manual.html#2457">Acronyms</A> - | <A HREF="manual.html#2474">Acronyms</A> - | <A HREF="manual.html#2501">Acronyms</A> - | <A HREF="manual.html#3117">Limitations</A> - | <A HREF="manual.html#3126">Limitations</A> - | <A HREF="manual.html#3245">Troubleshooting</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#2066">Package Options</A> - | <A HREF="manual.html#3128">Limitations</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#2064">Package Options</A> - | <A HREF="manual.html#2476">Acronyms</A> - | <A HREF="manual.html#2503">Acronyms</A> - | <A HREF="manual.html#3119">Limitations</A> - | <A HREF="manual.html#3247">Troubleshooting</A> -</DL> -<DT><STRONG>border</STRONG> -<DD><A HREF="manual.html#1876">Package Options</A> - | <A HREF="manual.html#1878">Package Options</A> - | <A HREF="manual.html#2086">Package Options</A> - | <A HREF="manual.html#2088">Package Options</A> - | <A HREF="manual.html#2214">Examples</A> - | <A HREF="manual.html#2250">Examples</A> - | <A HREF="manual.html#2277">Examples</A> - | <A HREF="manual.html#2304">Examples</A> - | <A HREF="manual.html#2974">Customizing the Glossary</A> -<DD><DL COMPACT> -<DT><STRONG>none</STRONG> -<DD><A HREF="manual.html#1880">Package Options</A> - | <A HREF="manual.html#2216">Examples</A> - | <A HREF="manual.html#2306">Examples</A> - | <A HREF="manual.html#2976">Customizing the Glossary</A> -<DT><STRONG>plain</STRONG> -<DD><A HREF="manual.html#1882">Package Options</A> - | <A HREF="manual.html#2252">Examples</A> - | <A HREF="manual.html#2279">Examples</A> -</DL> -<DT><STRONG>cols</STRONG> -<DD><A HREF="manual.html#1889">Package Options</A> - | <A HREF="manual.html#1891">Package Options</A> - | <A HREF="manual.html#2104">Package Options</A> - | <A HREF="manual.html#2106">Package Options</A> - | <A HREF="manual.html#2322">Examples</A> - | <A HREF="manual.html#2698">Customizing the Glossary</A> - | <A HREF="manual.html#2729">Customizing the Glossary</A> -<DD><DL COMPACT> -<DT><STRONG>2</STRONG> -<DD><A HREF="manual.html#1893">Package Options</A> -<DT><STRONG>3</STRONG> -<DD><A HREF="manual.html#1895">Package Options</A> - | <A HREF="manual.html#2324">Examples</A> - | <A HREF="manual.html#2700">Customizing the Glossary</A> - | <A HREF="manual.html#2731">Customizing the Glossary</A> -</DL> -<DT><STRONG>global</STRONG> -<DD><A HREF="manual.html#2073">Package Options</A> - | <A HREF="manual.html#2075">Package Options</A> - | <A HREF="manual.html#3274">Troubleshooting</A> - | <A HREF="manual.html#3276">Troubleshooting</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#2077">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#2079">Package Options</A> -</DL> -<DT><STRONG>header</STRONG> -<DD><A HREF="manual.html#1863">Package Options</A> - | <A HREF="manual.html#1865">Package Options</A> - | <A HREF="manual.html#2095">Package Options</A> - | <A HREF="manual.html#2097">Package Options</A> - | <A HREF="manual.html#2223">Examples</A> - | <A HREF="manual.html#2259">Examples</A> - | <A HREF="manual.html#2286">Examples</A> - | <A HREF="manual.html#2313">Examples</A> -<DD><DL COMPACT> -<DT><STRONG>none</STRONG> -<DD><A HREF="manual.html#1867">Package Options</A> - | <A HREF="manual.html#2225">Examples</A> - | <A HREF="manual.html#2261">Examples</A> -<DT><STRONG>plain</STRONG> -<DD><A HREF="manual.html#1869">Package Options</A> - | <A HREF="manual.html#2288">Examples</A> - | <A HREF="manual.html#2315">Examples</A> -</DL> -<DT><STRONG>hyper</STRONG> -<DD><A HREF="manual.html#1668">Generating Glossary Information</A> - | <A HREF="manual.html#1670">Generating Glossary Information</A> - | <A HREF="manual.html#1996">Package Options</A> - | <A HREF="manual.html#1998">Package Options</A> - | <A HREF="manual.html#2020">Package Options</A> - | <A HREF="manual.html#2029">Package Options</A> - | <A HREF="manual.html#2597">Acronyms</A> - | <A HREF="manual.html#2599">Acronyms</A> - | <A HREF="manual.html#3099">Limitations</A> - | <A HREF="manual.html#3409">Troubleshooting</A> - | <A HREF="manual.html#3411">Troubleshooting</A> - | <A HREF="manual.html#3571">Obsolete Commands</A> - | <A HREF="manual.html#3573">Obsolete Commands</A> - | <A HREF="manual.html#3599">Obsolete Commands</A> - | <A HREF="manual.html#3601">Obsolete Commands</A> - | <A HREF="manual.html#3615">Obsolete Commands</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#2007">Package Options</A> - | <A HREF="manual.html#2031">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#2000">Package Options</A> - | <A HREF="manual.html#2022">Package Options</A> - | <A HREF="manual.html#3101">Limitations</A> - | <A HREF="manual.html#3617">Obsolete Commands</A> -</DL> -<DT><STRONG>hyperacronym</STRONG> -<DD><A HREF="manual.html#2038">Package Options</A> - | <A HREF="manual.html#2040">Package Options</A> - | <A HREF="manual.html#3562">Obsolete Commands</A> - | <A HREF="manual.html#3564">Obsolete Commands</A> - | <A HREF="manual.html#3590">Obsolete Commands</A> - | <A HREF="manual.html#3592">Obsolete Commands</A> - | <A HREF="manual.html#3624">Obsolete Commands</A> - | <A HREF="manual.html#3633">Obsolete Commands</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#3605">Obsolete Commands</A> - | <A HREF="manual.html#3635">Obsolete Commands</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#3603">Obsolete Commands</A> - | <A HREF="manual.html#3626">Obsolete Commands</A> -</DL> -<DT><STRONG>hypertoc</STRONG> -<DD><A HREF="manual.html#1930">Package Options</A> - | <A HREF="manual.html#1932">Package Options</A> - | <A HREF="manual.html#1951">Package Options</A> - | <A HREF="manual.html#1953">Package Options</A> - | <A HREF="manual.html#1978">Package Options</A> - | <A HREF="manual.html#1987">Package Options</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1989">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1980">Package Options</A> -</DL> -<DT><STRONG>number</STRONG> -<DD><A HREF="manual.html#1902">Package Options</A> - | <A HREF="manual.html#1904">Package Options</A> - | <A HREF="manual.html#2196">Examples</A> - | <A HREF="manual.html#2232">Examples</A> - | <A HREF="manual.html#2716">Customizing the Glossary</A> - | <A HREF="manual.html#2754">Customizing the Glossary</A> - | <A HREF="manual.html#2772">Customizing the Glossary</A> - | <A HREF="manual.html#2831">Customizing the Glossary</A> - | <A HREF="manual.html#2846">Customizing the Glossary</A> - | <A HREF="manual.html#2862">Customizing the Glossary</A> - | <A HREF="manual.html#3014">Sample Documents</A> -<DD><DL COMPACT> -<DT><STRONG>none</STRONG> -<DD><A HREF="manual.html#1910">Package Options</A> - | <A HREF="manual.html#2198">Examples</A> - | <A HREF="manual.html#2718">Customizing the Glossary</A> - | <A HREF="manual.html#2756">Customizing the Glossary</A> - | <A HREF="manual.html#2774">Customizing the Glossary</A> - | <A HREF="manual.html#2864">Customizing the Glossary</A> -<DT><STRONG>page</STRONG> -<DD><A HREF="manual.html#1906">Package Options</A> - | <A HREF="manual.html#2234">Examples</A> -<DT><STRONG>section</STRONG> -<DD><A HREF="manual.html#1908">Package Options</A> - | <A HREF="manual.html#2833">Customizing the Glossary</A> - | <A HREF="manual.html#2848">Customizing the Glossary</A> - | <A HREF="manual.html#3016">Sample Documents</A> -</DL> -<DT><STRONG>section</STRONG> -<DD><A HREF="manual.html#2047">Package Options</A> - | <A HREF="manual.html#2049">Package Options</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#2053">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#2051">Package Options</A> -</DL> -<DT><STRONG>style</STRONG> -<DD><A HREF="manual.html#1834">Package Options</A> - | <A HREF="manual.html#1836">Package Options</A> - | <A HREF="manual.html#1848">Package Options</A> - | <A HREF="manual.html#2113">Package Options</A> - | <A HREF="manual.html#2122">Package Options</A> - | <A HREF="manual.html#2169">Examples</A> - | <A HREF="manual.html#2178">Examples</A> - | <A HREF="manual.html#2187">Examples</A> - | <A HREF="manual.html#2205">Examples</A> - | <A HREF="manual.html#2241">Examples</A> - | <A HREF="manual.html#2268">Examples</A> - | <A HREF="manual.html#2295">Examples</A> - | <A HREF="manual.html#2707">Customizing the Glossary</A> - | <A HREF="manual.html#2785">Customizing the Glossary</A> - | <A HREF="manual.html#2794">Customizing the Glossary</A> - | <A HREF="manual.html#2885">Customizing the Glossary</A> - | <A HREF="manual.html#2894">Customizing the Glossary</A> - | <A HREF="manual.html#2927">Customizing the Glossary</A> - | <A HREF="manual.html#2938">Customizing the Glossary</A> - | <A HREF="manual.html#2954">Customizing the Glossary</A> - | <A HREF="manual.html#2963">Customizing the Glossary</A> - | <A HREF="manual.html#2996">Sample Documents</A> - | <A HREF="manual.html#3090">Limitations</A> - | <A HREF="manual.html#3370">Troubleshooting</A> - | <A HREF="manual.html#3379">Troubleshooting</A> -<DD><DL COMPACT> -<DT><STRONG>altlist</STRONG> -<DD><A HREF="manual.html#1841">Package Options</A> - | <A HREF="manual.html#2124">Package Options</A> - | <A HREF="manual.html#2144">Package Options</A> - | <A HREF="manual.html#2180">Examples</A> - | <A HREF="manual.html#2709">Customizing the Glossary</A> - | <A HREF="manual.html#2796">Customizing the Glossary</A> - | <A HREF="manual.html#2896">Customizing the Glossary</A> - | <A HREF="manual.html#2940">Customizing the Glossary</A> - | <A HREF="manual.html#2998">Sample Documents</A> - | <A HREF="manual.html#3061">Sample Documents</A> - | <A HREF="manual.html#3092">Limitations</A> -<DT><STRONG>list</STRONG> -<DD><A HREF="manual.html#1838">Package Options</A> - | <A HREF="manual.html#1850">Package Options</A> - | <A HREF="manual.html#2115">Package Options</A> - | <A HREF="manual.html#2171">Examples</A> - | <A HREF="manual.html#2189">Examples</A> - | <A HREF="manual.html#2787">Customizing the Glossary</A> - | <A HREF="manual.html#2887">Customizing the Glossary</A> - | <A HREF="manual.html#2929">Customizing the Glossary</A> -<DT><STRONG>long</STRONG> -<DD><A HREF="manual.html#1855">Package Options</A> - | <A HREF="manual.html#2207">Examples</A> - | <A HREF="manual.html#2243">Examples</A> - | <A HREF="manual.html#2270">Examples</A> - | <A HREF="manual.html#2297">Examples</A> - | <A HREF="manual.html#2956">Customizing the Glossary</A> - | <A HREF="manual.html#3372">Troubleshooting</A> -<DT><STRONG>super</STRONG> -<DD><A HREF="manual.html#1852">Package Options</A> - | <A HREF="manual.html#2965">Customizing the Glossary</A> - | <A HREF="manual.html#3381">Troubleshooting</A> -</DL> -<DT><STRONG>toc</STRONG> -<DD><A HREF="manual.html#1917">Package Options</A> - | <A HREF="manual.html#1919">Package Options</A> - | <A HREF="manual.html#1939">Package Options</A> - | <A HREF="manual.html#1941">Package Options</A> - | <A HREF="manual.html#1960">Package Options</A> - | <A HREF="manual.html#1962">Package Options</A> - | <A HREF="manual.html#1969">Package Options</A> - | <A HREF="manual.html#2131">Package Options</A> - | <A HREF="manual.html#2133">Package Options</A> - | <A HREF="manual.html#2140">Package Options</A> - | <A HREF="manual.html#3005">Sample Documents</A> - | <A HREF="manual.html#3007">Sample Documents</A> - | <A HREF="manual.html#3108">Limitations</A> -<DD><DL COMPACT> -<DT><STRONG>false</STRONG> -<DD><A HREF="manual.html#1923">Package Options</A> -<DT><STRONG>true</STRONG> -<DD><A HREF="manual.html#1921">Package Options</A> - | <A HREF="manual.html#1971">Package Options</A> - | <A HREF="manual.html#2142">Package Options</A> - | <A HREF="manual.html#3110">Limitations</A> -</DL> -</DL> -<DT><STRONG>page number formats</STRONG> -<DD><DL COMPACT> -<DT><STRONG>hyperbf</STRONG> -<DD><A HREF="manual.html#1653">Generating Glossary Information</A> - | <A HREF="manual.html#3421">Troubleshooting</A> -<DT><STRONG>hyperit</STRONG> -<DD><A HREF="manual.html#1658">Generating Glossary Information</A> -<DT><STRONG>hyperrm</STRONG> -<DD><A HREF="manual.html#1638">Generating Glossary Information</A> - | <A HREF="manual.html#1672">Generating Glossary Information</A> -<DT><STRONG>hypersf</STRONG> -<DD><A HREF="manual.html#1643">Generating Glossary Information</A> -<DT><STRONG>hypertt</STRONG> -<DD><A HREF="manual.html#1648">Generating Glossary Information</A> -</DL> -<DT><STRONG><TT>\pagecompositor</TT></STRONG> -<DD><A HREF="manual.html#3035">Sample Documents</A> -<DT><STRONG><TT>perl</TT></STRONG> -<DD><A HREF="manual.html#1597">Installation</A> -<DT><STRONG><TT>\printacronym</TT></STRONG> -<DD><A HREF="manual.html#2483">Acronyms</A> - | <A HREF="manual.html#3254">Troubleshooting</A> -<DT><STRONG><TT>\printglossary</TT></STRONG> -<DD><A HREF="manual.html#2343">Defining New Glossary Types</A> - | <A HREF="manual.html#2400">Defining New Glossary Types</A> - | <A HREF="manual.html#3170">Troubleshooting</A> -<DT><STRONG><TT>\protect</TT></STRONG> -<DD><A HREF="manual.html#3308">Troubleshooting</A> -<DT><STRONG><TT>\saveglosentry</TT></STRONG> -<DD><A HREF="manual.html#3278">Troubleshooting</A> - | <A HREF="manual.html#3543">Obsolete Commands</A> -<DT><STRONG><TT>\setglossary</TT></STRONG> -<DD><A HREF="manual.html#3130">Limitations</A> - | <A HREF="manual.html#3439">Troubleshooting</A> -<DT><STRONG><TT>\setglossary</TT> keys</STRONG> -<DD><DL COMPACT> -<DT><STRONG>delimN</STRONG> -<DD><A HREF="manual.html#2740">Customizing the Glossary</A> -<DT><STRONG>delimR</STRONG> -<DD><A HREF="manual.html#2758">Customizing the Glossary</A> -<DT><STRONG>delimT</STRONG> -<DD><A HREF="manual.html#2809">Customizing the Glossary</A> - | <A HREF="manual.html#2818">Customizing the Glossary</A> -<DT><STRONG>glodelim</STRONG> -<DD><A HREF="manual.html#2689">Customizing the Glossary</A> - | <A HREF="manual.html#2720">Customizing the Glossary</A> -<DT><STRONG>gloskip</STRONG> -<DD><A HREF="manual.html#2776">Customizing the Glossary</A> -<DT><STRONG>glsnumformat</STRONG> -<DD><A HREF="manual.html#2683">Customizing the Glossary</A> - | <A HREF="manual.html#3435">Troubleshooting</A> -<DT><STRONG>type</STRONG> -<DD><A HREF="manual.html#2679">Customizing the Glossary</A> -</DL> -<DT><STRONG><TT>\storeglosentry</TT></STRONG> -<DD><A HREF="manual.html#3030">Sample Documents</A> - | <A HREF="manual.html#3135">Limitations</A> - | <A HREF="manual.html#3220">Troubleshooting</A> - | <A HREF="manual.html#3283">Troubleshooting</A> - | <A HREF="manual.html#3288">Troubleshooting</A> - | <A HREF="manual.html#3315">Troubleshooting</A> - | <A HREF="manual.html#3329">Troubleshooting</A> -<DT><STRONG>table of contents, adding to</STRONG> -<DD><i>see </i> package options, toc -<DT><STRONG><TT>\theglossarynum</TT></STRONG> -<DD><A HREF="manual.html#2866">Customizing the Glossary</A> - | <A HREF="manual.html#3040">Sample Documents</A> - | <A HREF="manual.html#3160">Limitations</A> -<DT><STRONG><TT>\useacronym</TT></STRONG> -<DD><A HREF="manual.html#2634">Examples</A> -<DT><STRONG><TT>\useGlosentry</TT></STRONG> -<DD><A HREF="manual.html#3225">Troubleshooting</A> - | <A HREF="manual.html#3230">Troubleshooting</A> - | <A HREF="manual.html#3293">Troubleshooting</A> - | <A HREF="manual.html#3298">Troubleshooting</A> - | <A HREF="manual.html#3334">Troubleshooting</A> - | <A HREF="manual.html#3339">Troubleshooting</A> -<DT><STRONG><TT>\xacronym</TT></STRONG> -<DD><A HREF="manual.html#2426">Acronyms</A> - | <A HREF="manual.html#2435">Acronyms</A> - | <A HREF="manual.html#2459">Acronyms</A> -<DT><STRONG><TT>\xglossary</TT></STRONG> -<DD><A HREF="manual.html#2002">Package Options</A> - | <A HREF="manual.html#2338">Defining New Glossary Types</A> - | <A HREF="manual.html#2464">Acronyms</A> - | <A HREF="manual.html#3215">Troubleshooting</A> - | <A HREF="manual.html#3575">Obsolete Commands</A> - | <A HREF="manual.html#3580">Obsolete Commands</A> -<DT><STRONG><TT>xpdf</TT></STRONG> -<DD><A HREF="manual.html#3444">Troubleshooting</A> -<DT><STRONG><TT>\xspace</TT></STRONG> -<DD><A HREF="manual.html#2603">Acronyms</A> - | <A HREF="manual.html#2609">Acronyms</A> - -</DL> - -<P> -<BR><HR><H4>Footnotes</H4> -<DL> -<DT><A NAME="foot1470">... <code>/usr/bin/</code></A><A - HREF="manual.html#tex2html1"><SUP>1</SUP></A></DT> -<DD>and you can also remove the <TT>.pl</TT> -extension which isn't to everyone's liking. - -</DD> -<DT><A NAME="foot1473">... glossary</A><A - HREF="manual.html#tex2html2"><SUP>2</SUP></A></DT> -<DD>This is because the list and number ranges are -delimited using <TT>\delimR</TT> and <TT>\delimN</TT> instead of -explicitly using a comma or en-dash. - -</DD> -<DT><A NAME="foot1526">... backslash</A><A - HREF="manual.html#tex2html4"><SUP>3</SUP></A></DT> -<DD>Note, you should -no longer try redefining the command <TT>\glsnumformat</TT>, as -this now takes an optional argument, allowing for different -glossary types - -</DD> -<DT><A NAME="foot1527">... space</A><A - HREF="manual.html#tex2html5"><SUP>4</SUP></A></DT> -<DD>This -is because the <TT>altlist</TT> style is intended for use with long descriptions that will look better ending with a - full stop which the user can add if desired. - -</DD> -<DT><A NAME="foot1086">...\glossaryalignment</A><A - HREF="manual.html#tex2html6"><SUP>5</SUP></A></DT> -<DD>This isn't quite true -anymore, see the documented code for clarification - -</DD> -<DT><A NAME="foot1529">... information</A><A - HREF="manual.html#tex2html7"><SUP>6</SUP></A></DT> -<DD>This should be in the directory -<TT>texmf/doc/latex/graphics/</TT> - -</DD> -</DL> -<BR><HR> -<ADDRESS> -<a href=http://theoval.cmp.uea.ac.uk/~nlct/>Nicola L. C. Talbot</a>. <a href=http://www.cmp.uea.ac.uk/>School of Computing Sciences</a>. <a href=http://www.uea.ac.uk/>University of East Anglia.</a> Last Modified: 2006-01-12 -</ADDRESS> -</BODY> -</HTML> |