diff options
30 files changed, 0 insertions, 21634 deletions
diff --git a/Master/texmf-doc/doc/english/tex-refs/tex-refs-source.tar.gz b/Master/texmf-doc/doc/english/tex-refs/tex-refs-source.tar.gz Binary files differnew file mode 100644 index 00000000000..85f7e85cad8 --- /dev/null +++ b/Master/texmf-doc/doc/english/tex-refs/tex-refs-source.tar.gz diff --git a/Master/texmf-doc/source/english/tex-refs/AUTHORS b/Master/texmf-doc/source/english/tex-refs/AUTHORS deleted file mode 100644 index 626accbf6c4..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/AUTHORS +++ /dev/null @@ -1,7 +0,0 @@ -AUTHORS file for tex-refs -========================= - -Michael Wiedmann <mw@miwie.in-berlin.de> - --- -$Id: AUTHORS 123 2004-03-26 20:25:26Z mw $ diff --git a/Master/texmf-doc/source/english/tex-refs/Makefile b/Master/texmf-doc/source/english/tex-refs/Makefile deleted file mode 100644 index 61a4dcf2b41..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/Makefile +++ /dev/null @@ -1,190 +0,0 @@ -# Makefile for tex-refs -# -# $Id: Makefile 146 2005-05-14 15:34:22Z mw $ - -PROJECT=tex-refs -VERSION = 0.3.9 -TITLE="Ref. for TeX and Friends" - -DISTDIR = $(PROJECT)-$(VERSION) - -SRC_FILES=$(PROJECT)-xinclude.xml $(PROJECT)-chapter*.xml \ - $(PROJECT).ent $(PROJECT)-local.mapping.xml - -MOD_XSL_FILES = db2latex-mw-table.xsl \ - db2latex-mw-variablelist.xsl \ - db2latex-mw-itemizedlist.xsl - -DIST_FILES=$(SRC_FILES) GFDL README AUTHORS TODO RELEASE-NEWS THANKS \ - $(PROJECT).css $(PROJECT)*.xsl $(MOD_XSL_FILES) \ - catalog.xml $(PROJECT).ist Makefile - -OUT_FILES = $(PROJECT).html html $(PROJECT).css $(PROJECT).txt \ - $(PROJECT)-plucker.pdb $(PROJECT).pdf - -CLEAN_FILES = $(PROJECT).html $(PROJECT).txt $(PROJECT).pdf \ - $(PROJECT).chm $(PROJECT)-plucker.pdb html/* \ - $(PROJECT)-plucker-input.html \ - $(PROJECT).tex $(PROJECT).ind $(PROJECT).ilg \ - $(PROJECT).glo $(PROJECT).toc $(PROJECT).out \ - $(PROJECT).idx $(PROJECT).aux $(PROJECT).log - -TAR = tar -GZIP = --best - -# name and options to 'xsltproc' -XSLTPROC=xsltproc -XSLTPROC_OPTS=--nonet #--verbose - -CHUNKDIR = html - -TIDY=tidy -TIDY_OPTS=-mq --show-warnings false - -# XSL file to generate non-chunked HTML -XSLFILE=$(PROJECT).xsl - -# XSL file to generate HTML for plucker -XSLPLUCKERFILE=$(PROJECT)-plucker.xsl - -# XSL file to generate chunked HTML -XSLCHUNKFILE=$(PROJECT)-chunk.xsl - -# XSL file with commoin customizations -XSLCOMMONFILE=$(PROJECT)-common.xsl - -PDFLATEX=pdflatex -PDFLATEX_OPTS=-interaction=nonstopmode - -PDFOPT=pdfopt-afpl - -MAKEINDEX=makeindex - -# XSL file for DB2LateX -XSLPDFFILE=$(PROJECT)-pdf.xsl - -##### - -%.txt : %.html - @# w3m wraps words like '\something' at the '\' - @# w3m -dump -cols 72 $< > $@ - lynx -nolist -dump -width=72 $< > $@ - @# discard 'Index', it makes no sense in TXT output - sed -e '/^Index/,$$d' \ - $@ > x.tmp && mv x.tmp $@ - -##### - -# default target -all: $(PROJECT).html chunk-html $(PROJECT).pdf $(PROJECT).txt \ - $(PROJECT)-plucker.pdb - -# make master document -$(PROJECT).xml: $(SRC_FILES) Makefile $(PROJECT)-local.mapping.xml - xmllint --nonet --output $@ --xinclude $(PROJECT)-xinclude.xml - -# HTML related targets -$(PROJECT).html: $(PROJECT).xml $(XSLFILE) $(XSLCOMMONFILE) - $(XSLTPROC) $(XSLTPROC_OPTS) --output $@ $(XSLFILE) $< - -$(TIDY) $(TIDY_OPTS) $@ - -chunk-html: $(CHUNKDIR)/index.html - -$(CHUNKDIR)/index.html : $(PROJECT).xml $(XSLCHUNKFILE) $(XSLCOMMONFILE) - test -d $(CHUNKDIR) || mkdir $(CHUNKDIR) || exit 1 - $(RM) $(CHUNKDIR)/* - $(XSLTPROC) -o $(CHUNKDIR)/ $(XSLCHUNKFILE) $< - -(cd $(CHUNKDIR) && $(TIDY) $(TIDY_OPTS) *.html ) - -# ASCII -$(PROJECT).txt: $(PROJECT).html - -# PDF related targets -$(PROJECT).tex: $(PROJECT).xml $(XSLPDFFILE) $(MOD_XSL_FILES) - $(XSLTPROC) $(XSLTPROC_OPTS) --output $@ $(XSLPDFFILE) $< - -$(PROJECT).pdf: $(PROJECT).tex $(PROJECT).ist - $(RM) $(PROJECT).aux $(PROJECT).toc $(PROJECT).ind - $(PDFLATEX) $(PDFLATEX_OPTS) $< && \ - $(PDFLATEX) $(PDFLATEX_OPTS) $< && \ - ( test -s $(PROJECT).idx && \ - $(MAKEINDEX) -s $(PROJECT).ist $(PROJECT) || true ) && \ - $(PDFLATEX) $(PDFLATEX_OPTS) $< && \ - $(PDFOPT) $(PROJECT).pdf out.pdf && $(RM) $(PROJECT).pdf && \ - mv out.pdf $(PROJECT).pdf && \ - ls -l $(PROJECT).pdf - -# PDB related targets -# generate PDB file for Palm reader 'plucker' -# we generate a separate HTML file for plucker first, because -# we cannot use the xhtml stylesheets and so have to provide a -# separate XSL stylesheet file -$(PROJECT)-plucker-input.html: $(PROJECT).xml $(XSLPLUCKERFILE) $(XSLCOMMONFILE) - $(XSLTPROC) -o $@ $(XSLPLUCKERFILE) $< - -$(PROJECT)-plucker.pdb: $(PROJECT)-plucker-input.html - plucker-build \ - --stayonhost \ - --zlib-compression \ - --doc-file=$(PWD)/$(PROJECT)-plucker \ - --doc-name=$(TITLE) \ - --exclusion-list=$(PROJECT)-plucker-exclude.txt \ - --noimages $(PROJECT)-plucker-input.html - - -# local "enhancements" -ifeq "$(wildcard Makefile.miwie)" "Makefile.miwie" -include Makefile.miwie -endif - -targets: - @echo "Most important targets:" - @echo - @echo "all generate all available output formats" - @echo - @echo "$(PROJECT).html generate $(PROJECT).html" - @echo "chunk-html generate chunked HTML output" - @echo "$(PROJECT).pdf generate $(PROJECT).pdf" - @echo "$(PROJECT).txt generate $(PROJECT).txt" - @echo - @echo "clean remove generated files" - @echo "dist create tarball with source files" - - -outfiles: - -rm -fr $(PROJECT)-out-$(VERSION).tar.gz - -rm -fr $(PROJECT)-out-$(VERSION).tar.bz2 - GZIP=$(GZIP) $(TAR) chozf $(PROJECT)-out-$(VERSION).tar.gz $(OUT_FILES) - $(TAR) chojf $(PROJECT)-out-$(VERSION).tar.bz2 $(OUT_FILES) - ls -l $(PROJECT)-out-$(VERSION).tar.gz - ls -l $(PROJECT)-out-$(VERSION).tar.bz2 - -install: - @echo "Nothing to install..." - -uninstall: - @echo "Nothing to uninstall..." - -clean: - $(RM) $(CLEAN_FILES) - -distclean: clean - -dist: distdir - @-chmod -R a+r $(DISTDIR) - @GZIP=$(GZIP) $(TAR) chozf $(DISTDIR).tar.gz $(DISTDIR) - @$(TAR) chojf $(DISTDIR).tar.bz2 $(DISTDIR) - ls -l $(DISTDIR).tar.gz - ls -l $(DISTDIR).tar.bz2 - ls -l $(PROJECT)-src.zip - @-rm -rf $(DISTDIR) - -distdir: $(DIST_FILES) - @-rm -rf $(DISTDIR) - @mkdir $(DISTDIR) - @-chmod 777 $(DISTDIR) - @for file in $(DIST_FILES); do \ - test -f $(DISTDIR)/$$file \ - || ln ./$$file $(DISTDIR)/$$file 2> /dev/null \ - || cp -p ./$$file $(DISTDIR)/$$file; \ - done diff --git a/Master/texmf-doc/source/english/tex-refs/README b/Master/texmf-doc/source/english/tex-refs/README deleted file mode 100644 index 90313b718a6..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/README +++ /dev/null @@ -1,61 +0,0 @@ -README file for tex-refs -======================== - -$Id: README 146 2005-05-14 15:34:22Z mw $ - -This file contains very brief instructions on how to build the -various output formats (in case you want to do this yourself for -some reason or just want to see how we handle all the 'magic'). - - -Where to find -------------- - -You'll find the latest version of 'tex-refs' at -http://www.miwie.org/tex-refs/ - - -Requirements ------------- - -- DocBook XML V4.3 - Your Linux distribution should provide an up-to-date package for this. - -- DocBook XSL Stylesheets (V1.68.1 as of this writing) - Your Linux distribution should provide a package for this. - If you only find an older version, try it or get the tarball - from »http://sourceforge.net/projects/docbook/«, install it - at some place and adjust some pathnames in Makefile.cfg.in - -- XSLT processor - At least »xsltproc« from libxslt/libxml2, and »Saxon« should work. - -- make - Should already be installed on your system - -- db2latex (http://db2latex.sourceforge.net) - If you want to generate PDF output you'll need this - - -Usage ------ -- Use the "catalog.xml" file as a hint how to setup your own - XML catalog or edit the XSL files to use absolute pathnames. - -- Run 'make targets' - This lists the most important targets of the Makefile - -- Run 'make' - This will generate all currently supported output files - -- Read over 'Makefile' if you want to know more details - - -Contact -------- - -Contact the authors if you have any suggestions, enhancements, -corrections, etc. Your contribution is very welcome. - --- -Michael Wiedmann <mw@miwie.in-berlin.de> diff --git a/Master/texmf-doc/source/english/tex-refs/RELEASE-NEWS b/Master/texmf-doc/source/english/tex-refs/RELEASE-NEWS deleted file mode 100644 index 53ad3a27536..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/RELEASE-NEWS +++ /dev/null @@ -1,120 +0,0 @@ -$Id: RELEASE-NEWS 146 2005-05-14 15:34:22Z mw $ - -V0.3.9 050514: -- Consistent naming scheme of IDs to ease the use of - this reference for other projects -- Added new section "float" in chapter "LaTeX" - -V0.3.8 041029: -- Minor changes in "\maketitle" - -V0.3.7 040826: -- Corrected typos and markup errors in chapter "BibTeX" -- Switched to DocBook XML V4.3 -- Added new section "Options" in chapter "LaTeX" - -V0.3.6 040621: -- Added a note in chapter "LaTeX" with the copyright - and permission notice of the original file "latex2.texi" -- Corrected typos and added missing hyperlinks - in chapter xindy -- PDF file optimized/linearized and some finetuning - -V0.3.5 040501: -- Added content to chapters Metapost and pdfTeX -- Enhanced index for chapter MakeIndex - -V0.3.4 040424: -- Added missing entries to chapter MakeIndex -- Version control system changed from CVS to SVN - -V0.3.3 040126: -- Corrected again section "Output Style Specifiers" and - "Input Style Specifiers" of chapter "MakeIndex" -- Corrected some symbols in the index - -V0.3.2 040116: -- corrected sections "Output Style Specifiers" and - "Input Style Specifiers" of chapter "MakeIndex" -- enhanced index in PDF - -V0.3.1 040105: -- more work on PDF -- modularized XSL stylesheet files - -V0.3.0 031225: -- document root changed to book -- more work on PDF - -V0.2.6 031027: -- rearranged appendix -- work on PDF version - -V0.2.5 031017: -- added GNU FDL in appendix -- using new XSL stylesheets V1.62.4 -- switched to xsltproc as XSLT-processor -- reedited some deeply nested sections - -V0.2.4 030906: -- added subsection dcolumn -- subsection fontenc translated into english -- corrected typo in \sbox - -V0.2.3 030412: -- provide PDF output file -- reedited (beautified) sections LaTeX / Commands / - Counters | Cross References | Definitions | Layout | - Environments | Footnotes - -V0.2.2 030126: -- add bzip2 compressed version of source and outfiles tarball -- new XSL stylesheets V1.60.1 -- eliminated morespurious &Circ; characters - -V0.2.1 030118: -- new XSL stylesheets V1.59.2 -- eliminated spurious &Circ; characters - -V0.2.0 030111: -- license changed to GNU FDL -- reworked subsection 'inputenc' -- added subscetion 'Commands and Parameters' to section 'PSTricks' - -V0.1.3 021017: -- start rework on 'KOMA-Script' section -- added subsection 'List of Additional PSTricks packages' -- using new XSL stylesheets V1.56.1 - -V0.1.2 021001: -- reworked 'hyperref' section - -V0.1.1 020919: -- added template sections for 'PiCTeX' and 'Texinfo' -- using new XSL stylesheets V1.55.0 -- added missing CSS file to outfiles tarball -- corrected wrong FPI - -V0.1.0 020820: -- eliminated trailing '.' in numbered sections -- minor markup errors corrected -- reworked CSS file - -V0.0.5 020810: -- Switched to DocBook XML 4.2 -- Sections 'Bibindex' and 'xindy' finished - -V0.0.4 020725: -- Section 'Makeindex' finished - -V0.0.3 020713: -- New XSL stylesheets solve bug in creating index (no other changes) - -V0.0.2 020705: -- New (template) sections 'fontinst', 'Bibtex', 'Makeindex', and 'xindy' -- New section 'Special Symbols' -- Added information for 'german' package -- Registered as a new project (tex-refs) on freshmeat.net - -V0.0.1 020621: -- first official announcement diff --git a/Master/texmf-doc/source/english/tex-refs/THANKS b/Master/texmf-doc/source/english/tex-refs/THANKS deleted file mode 100644 index 639a870c295..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/THANKS +++ /dev/null @@ -1,21 +0,0 @@ -THANKS file for tex-refs -======================== - -$Id: THANKS 142 2004-10-24 15:13:24Z mw $ - -The following people have contributed substantial parts to -this documentation project or helped in some other way: - -Karl Berry -Wolfgang Borgert -Ramon Casellas -James Devenish -Peter Karp -Werner Lemberg -Rolf Niepraschk -Simon Pepping -Bob Stayton -Herbert Voss - --- -Michael Wiedmann <mw@miwie.in-berlin.de> diff --git a/Master/texmf-doc/source/english/tex-refs/TODO b/Master/texmf-doc/source/english/tex-refs/TODO deleted file mode 100644 index e4b15490e1f..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/TODO +++ /dev/null @@ -1,35 +0,0 @@ -TODO file for tex-refs -====================== - -$Id: TODO 142 2004-10-24 15:13:24Z mw $ - -- Add more content - There are still a lot of sections without content. - Any input will be appreciated. - -- Provide conversion to vim-help - Information about the - very simple format - is available. - Contact Michael Wiedmann <mw@miwie.in-berlin.de> for more - information on this topic. - It will be necessary to generate multiple output files, - maybe on the first section level. At least »Saxon« and - »xsltproc« can do this. Look at 'html/chunk.xsl' of the - DocBook XSL Stylesheets to find a starting point. - -- Provide conversion to Texinfo - There is a Perl script package (docbook2X-0.8.2) at sourceforge - which should do the job. Unfortunately the available package for - Debian/GNU Linux is rather old (0.5.1) and fails with our document. - My first tests using the actual version from source were _not_ - successful. I contacted the author Steve Cheng and he promised - to have a look at my reported problems. Unfortunately I didn't - hear anything from him again since then. - -- Proofread content - -- Enhance CSS file --- -Michael Wiedmann <mw@miwie.in-berlin.de> - - - diff --git a/Master/texmf-doc/source/english/tex-refs/catalog.xml b/Master/texmf-doc/source/english/tex-refs/catalog.xml deleted file mode 100644 index c3daf329206..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/catalog.xml +++ /dev/null @@ -1,27 +0,0 @@ -<!-- - Use this as an example how to setup an XML catalog for DocBook XML, - DocBook XSL, and DB2LaTeX XSL. Don't forget to tell your XSLT - processor to use XML catalogs. - - $Id: catalog.xml 120 2004-03-26 20:19:43Z mw $ ---> - -<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> - - <public publicId="-//OASIS//DTD DocBook XML V4.2//EN" - uri="file:///var/share/xml/docbook/schema/dtd/4.2/docbookx.dtd"/> - - <system systemId="db2latex.xsl" - uri="file:///usr/share/sgml/docbook/stylesheet/xsl/db2latex/latex/docbook.xsl"/> - - <system systemId="docbook-xhtml.xsl" - uri="file:///usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl"/> - - <system systemId="docbook-html.xsl" - uri="file:///usr/share/xml/docbook/stylesheet/nwalsh/html/docbook.xsl"/> - - <system systemId="docbook-html-chunk.xsl" - uri="file:///usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl"/> - -</catalog> - diff --git a/Master/texmf-doc/source/english/tex-refs/db2latex-mw-itemizedlist.xsl b/Master/texmf-doc/source/english/tex-refs/db2latex-mw-itemizedlist.xsl deleted file mode 100644 index 8e12fd8946a..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/db2latex-mw-itemizedlist.xsl +++ /dev/null @@ -1,71 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<!--#################################################################### - | $Id: db2latex-mw-itemizedlist.xsl 125 2004-04-06 19:55:32Z mw $ - | $Author: mw $ - + ################################################################# --> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" - exclude-result-prefixes="doc" version="1.0"> - - <!-- DOCUMENTATION --> - <doc:reference id="itemizedlists" xmlns=""> - <referenceinfo> - <releaseinfo role="meta"> - $Id: db2latex-mw-itemizedlist.xsl 125 2004-04-06 19:55:32Z mw $ - </releaseinfo> - <authorgroup> - <author><firstname>Michael</firstname> <surname>Wiedmann</surname></author> - </authorgroup> - <copyright> - <year>2004</year> - <holder>Michael Wiedmann</holder> - </copyright> - </referenceinfo> - - <title>Lists <filename>db2latex-mw-itemizedlist.xsl</filename></title> - <partintro> - <section> - <title>Introduction</title> - <para>Especially for itemizedlist which contain only short lines - of text LaTeX's default vertical space between items is IMHO - too excessive. <filename>mdwlist.sty</filename> provides - "compacted itemize environments" with less vertical space - between items. - </para> - <para> - If the "spacing" attribute of the "itemizedlist" element - contains "compact" we use these modified itemize - environments instead of the standard LaTeX ones. - </para> - <para>Ensure that "\usepackage{mdwlist}" is output - somewhere in your stylesheets. - </para> - </section> - </partintro> - </doc:reference> - - <xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> - - <xsl:template match="itemizedlist"> - <xsl:if test="title"><xsl:apply-templates select="title"/></xsl:if> - <xsl:choose> - <xsl:when test="@spacing='compact'"> - <xsl:text> \begin{itemize*}</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text> \begin{itemize}</xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:apply-templates select="listitem"/> - <xsl:choose> - <xsl:when test="@spacing='compact'"> - <xsl:text> \end{itemize*}</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text> \end{itemize}</xsl:text> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/db2latex-mw-table.xsl b/Master/texmf-doc/source/english/tex-refs/db2latex-mw-table.xsl deleted file mode 100644 index a76f7886e6c..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/db2latex-mw-table.xsl +++ /dev/null @@ -1,288 +0,0 @@ -<?xml version='1.0'?> -<!--#################################################################### - | $Id: db2latex-mw-table.xsl 120 2004-03-26 20:19:43Z mw $ - | $Author: mw $ - + ################################################################# --> - - -<xsl:stylesheet - xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" - exclude-result-prefixes="doc" version='1.0'> - - <xsl:template name="table.format.tabularx"> - <xsl:param name="cols" select="1"/> - <xsl:param name="i" select="1"/> - <xsl:param name="colsep" select="1"/> - <!-- sum of numeric portions in 1*-like colwidths --> - <xsl:param name="starfactor" select="0"/> - <xsl:choose> - <!-- Out of the recursive iteration --> - <xsl:when test="$i > $cols"></xsl:when> - <!-- There are still columns to count --> - <xsl:otherwise> - <xsl:variable name="userwidth"> - <xsl:choose> - <xsl:when test="./colspec[@colnum=$i]"> - <xsl:value-of select="./colspec[@colnum=$i]/@colwidth"/> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="./colspec[position()=$i]/@colwidth"/> - </xsl:otherwise> - </xsl:choose> - </xsl:variable> - <xsl:variable name="useralign"> - <xsl:choose> - <xsl:when test="./colspec[@colnum=$i]"> - <xsl:value-of select="./colspec[@colnum=$i]/@align"/> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="./colspec[position()=$i]/@align"/> - </xsl:otherwise> - </xsl:choose> - </xsl:variable> - <xsl:variable name="width"> - <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> - <xsl:choose> - <xsl:when test="string-length($userwidth)=0 and count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)>0"> - <!-- In these specific circumstances, we MUST use a line-wrapped column - and yet the user hasn't specified one. --> - <xsl:value-of select="'1*'"/> - </xsl:when> - <xsl:otherwise> - <!-- In the general case, we just do what the user wants (may even - have no pre-specified width). --> - <xsl:value-of select="$userwidth"/> - </xsl:otherwise> - </xsl:choose> -</xsl:variable> -<!-- Try to take heed of colspecs --> -<xsl:choose> - <xsl:when test="$width!=''"> - <xsl:text>>{</xsl:text> - <xsl:if test="contains($width,'*')"> - <!-- see tabularx documentation --> - <xsl:text>\hsize=</xsl:text> - <xsl:value-of select="substring-before($width,'*') * $starfactor" /> - <xsl:text>\hsize</xsl:text> - </xsl:if> - <xsl:choose> - <xsl:when test="$useralign='left'"><xsl:text>\RaggedRight</xsl:text></xsl:when> - <xsl:when test="$useralign='right'"><xsl:text>\RaggedLeft</xsl:text></xsl:when> - <xsl:when test="$useralign='center'"><xsl:text>\Centering</xsl:text></xsl:when> - <xsl:when test="$useralign='char' and $latex.use.dcolumn='1'"> - <xsl:variable name="char" select="(./colspec[@colnum=$i]/@char|./colspec[position()=$i]/@char)[1]"/> - <xsl:choose> - <xsl:when test="$char=''"><xsl:text>d</xsl:text></xsl:when> - <xsl:otherwise>D{<xsl:value-of select="$char"/>}{<xsl:value-of select="$char"/>}{-1}</xsl:otherwise> - </xsl:choose> - </xsl:when> - <xsl:when test="$useralign!=''"><xsl:message>Table column '<xsl:value-of select="$useralign"/>' alignment is not supported.</xsl:message></xsl:when> - </xsl:choose> - <xsl:text>}</xsl:text> - <xsl:choose> - <xsl:when test="contains($width,'*')"> - <xsl:text>X</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text>p{</xsl:text><xsl:value-of select="$width" /><xsl:text>}</xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:if test="$i<$cols and $colsep='1'"> - <xsl:text>|</xsl:text> - </xsl:if> - </xsl:when> - <xsl:otherwise> - <xsl:choose> - <xsl:when test="$useralign='left'"><xsl:text>l</xsl:text></xsl:when> - <xsl:when test="$useralign='right'"><xsl:text>r</xsl:text></xsl:when> - <xsl:when test="$useralign='center'"><xsl:text>c</xsl:text></xsl:when> - <xsl:when test="$useralign='justify'"><xsl:text>X</xsl:text></xsl:when> - <xsl:when test="$useralign='char' and $latex.use.dcolumn='1'"> - <xsl:variable name="char" select="(./colspec[@colnum=$i]/@char|./colspec[position()=$i]/@char)[1]"/> - <xsl:choose> - <xsl:when test="$char=''"><xsl:text>d</xsl:text></xsl:when> - <xsl:otherwise>D{<xsl:value-of select="$char"/>}{<xsl:value-of select="$char"/>}{-1}</xsl:otherwise> - </xsl:choose> - </xsl:when> - <xsl:otherwise> - <xsl:text>c</xsl:text> - <xsl:if test="$useralign!=''"> - <xsl:message>Table column '<xsl:value-of select="$useralign"/>' alignment is not supported.</xsl:message> - </xsl:if> - </xsl:otherwise> - </xsl:choose> - <xsl:if test="$i<$cols and $colsep='1'"> - <xsl:text>|</xsl:text> - </xsl:if> - </xsl:otherwise> -</xsl:choose> -<!-- Recursive for next column --> -<xsl:call-template name="table.format.tabularx"> - <xsl:with-param name="i" select="$i+1"/> - <!-- Added by MW, 2003-10-19 --> - <xsl:with-param name="colsep" select="$colsep"/> - <xsl:with-param name="cols" select="$cols"/> - <xsl:with-param name="starfactor" select="$starfactor"/> -</xsl:call-template> -</xsl:otherwise> -</xsl:choose> -</xsl:template> - - - -<xsl:template match="tgroup"> - <xsl:variable name="align" select="@align"/> - -<!-- Changed by MW, 2003-10-19 --> -<xsl:variable name="colsep"> - <xsl:choose> - <xsl:when test="string-length(@colsep)<1">0</xsl:when> - <xsl:otherwise> - <xsl:value-of select="@colsep"/> - </xsl:otherwise> - </xsl:choose> -</xsl:variable> - -<xsl:variable name="frame"> - <xsl:choose> - <xsl:when test="string-length(../@frame)<1">all</xsl:when> - <xsl:otherwise> - <xsl:value-of select="../@frame"/> - </xsl:otherwise> - </xsl:choose> -</xsl:variable> -<xsl:variable name="colspecs" select="./colspec"/> -<xsl:variable name="usex"> - <xsl:choose> - <xsl:when test="$latex.use.ltxtable='1'"> - <xsl:text>0</xsl:text> - </xsl:when> - <!-- if there are lists within cells, we need tabularx --> - <xsl:when test="$latex.use.tabularx=1 and (descendant::itemizedlist|descendant::orderedlist|descendant::variablelist)"> - <xsl:text>1</xsl:text> - </xsl:when> -<!-- if there are instances of 1*-style colwidths, we need tabularx --> -<xsl:when test="$latex.use.tabularx=1 and contains(colspec/@colwidth,'*')"> - <xsl:text>1</xsl:text> -</xsl:when> -<!-- if there are colspecs with 'justify' alignment and no explicit width, we need tabularx --> -<xsl:when test="$latex.use.tabularx=1 and count(colspec[@align='justify'])>0"> - <xsl:text>1</xsl:text> -</xsl:when> -<xsl:otherwise> - <xsl:text>0</xsl:text> -</xsl:otherwise> -</xsl:choose> -</xsl:variable> -<xsl:variable name="useminipage"> -<!-- Hack to get around LaTeX issue with tabular (not necessary with tabularx). - This is NOT a good solution, and has problems of its own, but at least the footnotes - do not actually disappear (which is what would otherwise happen). --> -<xsl:if test="count(.//footnote)!=0">1</xsl:if> -</xsl:variable> -<xsl:choose> - <xsl:when test="$usex='1'"> - <xsl:text>\begin{tabularx}{\linewidth}{</xsl:text> - </xsl:when> - <xsl:when test="$latex.use.ltxtable='1'"> - <xsl:text>\begin{longtable}{</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:if test="$useminipage='1'"><xsl:text>\begin{minipage}{\linewidth} </xsl:text></xsl:if> - <xsl:text>\begin{tabular}{</xsl:text> - </xsl:otherwise> -</xsl:choose> -<xsl:if test="$frame='all' or $frame='sides'"> - <xsl:text>|</xsl:text> -</xsl:if> -<xsl:variable name="cols"> - <xsl:choose> - <xsl:when test="@cols"> - <xsl:value-of select="@cols"/> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="count(tbody/row[1]/entry)"/> - <xsl:message>Warning: table lacks cols attribute. Assuming <xsl:value-of select="count(tbody/row[1]/entry)"/>.</xsl:message> - </xsl:otherwise> - </xsl:choose> -</xsl:variable> -<xsl:choose> - <xsl:when test="$usex=1"> - <xsl:call-template name="table.format.tabularx"> - <xsl:with-param name="cols" select="$cols"/> - <!-- Changed by MW, 2003-10-19 --> - <xsl:with-param name="colsep" select="$colsep"/> - <xsl:with-param name="starfactor"> - <xsl:call-template name="generate.starfactor"> - <xsl:with-param name="cols" select="$cols"/> - </xsl:call-template> - </xsl:with-param> - </xsl:call-template> -</xsl:when> -<xsl:otherwise> - <xsl:call-template name="table.format.tabular"> - <xsl:with-param name="cols" select="$cols"/> - </xsl:call-template> -</xsl:otherwise> -</xsl:choose> -<xsl:if test="$frame='all' or $frame='sides'"> - <xsl:text>|</xsl:text> -</xsl:if> -<xsl:text>} </xsl:text> -<xsl:if test="$frame!='sides' and $frame!='none' and $frame!='bottom'"> - <xsl:text>\hline </xsl:text> -</xsl:if> -<!-- APPLY TEMPLATES --> -<xsl:choose> - <xsl:when test="$latex.use.ltxtable='1'"> - <xsl:apply-templates select="thead"/> - <xsl:apply-templates select="tfoot"/> - <xsl:apply-templates select="tbody"/> - </xsl:when> - <xsl:otherwise> - <xsl:apply-templates select="thead"/> - <xsl:apply-templates select="tbody"/> - <xsl:apply-templates select="tfoot"/> - </xsl:otherwise> -</xsl:choose> -<!-- --> -<xsl:if test="$frame!='sides' and $frame!='none' and $frame!='top'"> - <xsl:text>\hline </xsl:text> -</xsl:if> -<xsl:choose> - <xsl:when test="$usex=1"> - <xsl:text>\end{tabularx} </xsl:text> - </xsl:when> - <xsl:when test="$latex.use.ltxtable='1'"> - <xsl:text>\end{longtable} </xsl:text> - <!-- catcode touchup ARGH --> - <xsl:call-template name="generate.latex.cell.separator"> - <xsl:with-param name="which" select="'post'"/> - </xsl:call-template> -</xsl:when> -<xsl:otherwise> - <xsl:text>\end{tabular} </xsl:text> - <xsl:if test="$useminipage='1'"><xsl:text>\end{minipage} </xsl:text></xsl:if> -</xsl:otherwise> -</xsl:choose> -</xsl:template> - -<!-- this lets us specify vertical space between rows --> -<xsl:template match="tbody/row"> - <xsl:apply-templates/> - <xsl:text> \tabularnewline</xsl:text> - <xsl:if test="contains(@role,'db2latex:rowvspace')"> - <!-- FIXME: let user specify amount of vert. spcace --> - <xsl:text>[1ex]</xsl:text> - </xsl:if> - <xsl:text> </xsl:text> - <xsl:call-template name="generate.table.row.separator"/> -</xsl:template> - -<xsl:template name="table.row.separator"> - <xsl:text> </xsl:text> -</xsl:template> - - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/db2latex-mw-variablelist.xsl b/Master/texmf-doc/source/english/tex-refs/db2latex-mw-variablelist.xsl deleted file mode 100644 index f81e32eef78..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/db2latex-mw-variablelist.xsl +++ /dev/null @@ -1,155 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<!--#################################################################### - | $Id: db2latex-mw-variablelist.xsl 146 2005-05-14 15:34:22Z mw $ - | $Author: mw $ - + ################################################################# --> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" - exclude-result-prefixes="doc" version="1.0"> - - <!-- DOCUMENTATION --> - <doc:reference id="variablelists" xmlns=""> - <referenceinfo> - <releaseinfo role="meta"> - $Id: db2latex-mw-variablelist.xsl 146 2005-05-14 15:34:22Z mw $ - </releaseinfo> - <authorgroup> - <author><firstname>Michael</firstname> <surname>Wiedmann</surname></author> - </authorgroup> - <copyright> - <year>2004</year> - <holder>Michael Wiedmann</holder> - </copyright> - </referenceinfo> - - <title>Lists <filename>db2latex-mw-variablelist.xsl</filename></title> - <partintro> - <section> - <title>Introduction</title> - <para>This customization of "variablelist" depends on the usage - of one of KOMA document classes (scrbook, scrartcl, etc.). - You have to ensure that your stylesheets outputs a - corresponding line, like "\documentclass{scrXXXX}". - </para> - <itemizedlist> - <listitem> - <simpara>If the attribute 'role' contains - 'db2latex:multiterm' we use a 'parbox' for every - 'item'. Otherwise the item's could be too long to - fit on one line. - Use this if your list contains many 'term's. - </simpara> - </listitem> - <listitem> - <simpara>If the attribute 'role' contains - 'db2latex:nonoindent' we don't output '\noindent' - before the environment. - </simpara> - </listitem> - <listitem> - <simpara>If the 'role' attribute contains - 'db2latex:labeling' as value we use KOMA's - 'labeling' environment. - </simpara> - </listitem> - <listitem> - <simpara>If the attribute 'termlength' is - non-empty we use this numeric value as a hint - for 'labeling' for the width of the 'item's - (defaults to 5). - </simpara> - </listitem> - </itemizedlist> - </section> - </partintro> - </doc:reference> - - <xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> - - <xsl:template match="variablelist"> - - <xsl:text>% MW: variablelist </xsl:text> - - <xsl:variable name="helpstring">123456789012345</xsl:variable> - <xsl:if test="title"> - <xsl:apply-templates select="title"/> - </xsl:if> - <xsl:text> </xsl:text> - <xsl:choose> - <xsl:when test="contains(@role,'db2latex:nonoindent')"> - <!-- noop --> - </xsl:when> - <xsl:otherwise> - <xsl:text>\noindent </xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:choose> - <xsl:when test="contains(@role,'db2latex:labeling')"> - <xsl:text>\begin{labeling}{</xsl:text> - <xsl:choose> - <xsl:when test="@termlength!=''"> - <xsl:value-of select="substring($helpstring,1,number(@termlength))"/> - </xsl:when> - <xsl:otherwise> - <xsl:text>12345</xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:text>} </xsl:text> - <xsl:apply-templates select="varlistentry"/> - <xsl:text>\end{labeling} </xsl:text> - </xsl:when> - <xsl:when test="contains(@role,'db2latex:compact')"> - <xsl:text>\begin{description*}</xsl:text> - <xsl:apply-templates select="varlistentry"/> - <xsl:text>\end{description*} </xsl:text> - </xsl:when> - <xsl:when test="contains(@role,'db2latex:multiterm')"> - <xsl:text>\begin{description}</xsl:text> - <xsl:apply-templates select="varlistentry"> - <xsl:with-param name="multiterm" select="1"/> - </xsl:apply-templates> - <xsl:text>\end{description} </xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text>\begin{description} </xsl:text> - <xsl:apply-templates select="varlistentry"/> - <xsl:text>\end{description} </xsl:text> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - - <xsl:template match="varlistentry"> - <xsl:text> % MW: varlistentry </xsl:text> - <!-- <xsl:variable name="id"> --> - <xsl:call-template name="label.id" /> - <!-- </xsl:variable> --> - <xsl:param name="multiterm" select="0" /> - <xsl:text> % MW: varlistentry after label.id </xsl:text> - <xsl:text>% \null is a trick </xsl:text> - <xsl:choose> - <xsl:when test="$multiterm > 0"> - <xsl:text>\item[{\parbox[b]{0.5\linewidth}{</xsl:text> - <xsl:for-each select="term"> - <xsl:apply-templates/> - <xsl:if test="position()!=last()"> - <xsl:text>, </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>}}]\null{}</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text>\item[{</xsl:text> - <xsl:for-each select="term"> - <xsl:apply-templates/> - <xsl:if test="position()!=last()"> - <xsl:text>, </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>}]\null{}</xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:apply-templates select="listitem"/> - </xsl:template> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-appendices.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-appendices.xml deleted file mode 100644 index c4312567875..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-appendices.xml +++ /dev/null @@ -1,1011 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-appendices.xml 146 2005-05-14 15:34:22Z mw $ --> - -<appendix id="appendices" lang="en"> - <title id="appendices-title">Appendices</title> - - <section id="issues"> - <title id="known-issues-title">Bugs / Known Issues / Missing Features</title> - <indexterm> - <primary>Known Issues</primary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term>PDF</term> - <listitem> - <para> - The PDF file is an experimental version generated using - <ulink url="http://dblatex.sf.net">DB2&latex;</ulink>. - There is much room for improvements and we will work on - this. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Texinfo</term> - <listitem> - <para> - Currently we don't know any working solution to convert - DocBook XML to Texinfo (at least not for a complex - document). Anyone who wants to work on this issue is - highly welcome. A starting point could be the - <emphasis>docbook2X</emphasis> project at - <ulink url="http://docbook2x.sourceforge.net">http://docbook2x.sourceforge.net</ulink>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>vim-help</term> - <listitem> - <para> - Quite a few poeple are asking for a version in vim-help format. - <ulink url="mailto:srinath@eecs.berkeley.edu">Srinath Avadhanula</ulink> - has already done some work on this. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="about"> - <title id="about-title">About this Document</title> - <indexterm> - <primary>About this Document</primary> - </indexterm> - <para>The source format of this document is - <ulink - url="http://www.oasis-open.org/committees/docbook/">&docbookxml;</ulink>. - </para> - <para>The various output formats were generated using: - <itemizedlist> - <listitem> - <simpara> - <ulink url="http://xmlsoft.org/XSLT/">&xsltp;</ulink> - as XSLT processor - </simpara> - </listitem> - <listitem> - <simpara> - <ulink - url="http://sourceforge.net/projects/docbook">&docbookxsl;</ulink> - for HTML - </simpara> - </listitem> - <listitem> - <simpara> - <ulink url="http://db2latex.sf.net/">&db2latex;</ulink> - for &latex;/PDF - </simpara> - </listitem> - <listitem> - <simpara> - <literal>&komabook;</literal> of - <ulink url="ftp://dante.ctan.org/tex-archive/macros/latex/contrib/koma-script/">&komascript;</ulink> - </simpara> - </listitem> - <listitem> - <simpara><ulink url="ftp://ftp.dante.de/tex-archive/fonts/ps-type1/lm/tex/latex/lm/">&lmodern;</ulink></simpara> - </listitem> - <listitem> - <simpara>&pdflatex; (3.14159-1.10b) for generating PDF output</simpara> - </listitem> - </itemizedlist> - </para> - <para>You'll always find the newest version of this document at - <ulink url="http://www.miwie.org/tex-refs/"> - http://www.miwie.org/tex-refs/</ulink>. - </para> - </section> - - <section id="release-news"> - <title>Release News</title> - - <variablelist role="db2latex:nonoindent;db2latex:labeling" - termlength="15"> - - <varlistentry> - <term>V&rev; &abbrdate;</term> - <listitem>tbd.</listitem> - </varlistentry> - - <varlistentry> - <term>V0.3.9 05-05-14</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem>Consistent naming scheme of IDs to ease the use - of this reference for other projects - </listitem> - <listitem>Added new section <link linkend="float">float</link> - in chapter <link linkend="latex">&latex;</link> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.3.8 04-10-28</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem>Minor changes in - <link linkend="page-styles">\maketitle</link></listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.3.7 04-08-26</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Corrected typos and markup errors in chapter - <link linkend="bibtex">&bibtex;</link></simpara> - </listitem> - <listitem> - <simpara>Switched to DocBook XML V4.3</simpara> - </listitem> - <listitem> - <simpara>Added new section - <link linkend="opt-latex">Options</link> in - chapter <link linkend="latex">&latex;</link></simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.3.6 04-06-21</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Added a note in chapter - <link linkend="latex">&latex;</link> with the - copyright and permission notice of the original file - <filename>latex2.texi</filename> - </simpara> - </listitem> - <listitem> - <simpara>Corrected typos and added missing hyperlinks - in chapter <link linkend="xindy">&xindy;</link></simpara> - </listitem> - <listitem> - <simpara>PDF file optimized/linearized and some - finetuning</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.3.5 04-05-01</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Added content to chapters - <link linkend="metapost">&metapost;</link> and - <link linkend="pdftex">&pdftex;</link> - </simpara> - </listitem> - <listitem> - <simpara>Enhanced index for chapter - <link linkend="metapost">&makeindex;</link> - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.3.4 04-04-24</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara> - Version control system changed from CVS to SVN - </simpara> - </listitem> - <listitem> - <simpara> - Added missing entries to chapter - <link linkend="makeindex">&makeindex;</link> - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.3.3 04-01-26</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Corrected again section - <link linkend="makeindex-output-style-specs">Output Style - Specifiers</link> and - <link linkend="makeindex-style">Input Style Specifiers</link> - of chapter - <link linkend="makeindex">&makeindex;</link> - </simpara> - </listitem> - <listitem> - <simpara>Corrected some symbols in the index - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.3.2 04-01-16</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Corrected sections - <link linkend="makeindex-output-style-specs">Output Style - Specifiers</link> and - <link linkend="makeindex-style">Input Style Specifiers</link> - of chapter - <link linkend="makeindex">&makeindex;</link> - </simpara> - </listitem> - <listitem> - <simpara>Enhanced index in PDF - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.3.1 04-01-06</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>More work on PDF</simpara> - </listitem> - <listitem> - <simpara>Modularized XSL stylesheet files</simpara> - </listitem> - <listitem> - <simpara>Corrected some typos</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.3.0 03-12-25</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Changed document root to - <emphasis>book</emphasis></simpara> - </listitem> - <listitem> - <simpara>More work on PDF version</simpara> - </listitem> - <listitem> - <simpara>Using new XSL stylesheets V1.64.1</simpara> - </listitem> - <listitem> - <simpara>Minor fixes</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.2.6 03-10-27</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Rearranged appendix</simpara> - </listitem> - <listitem> - <simpara>Work on PDF version</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.2.5 03-10-17</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Added contents of - <link linkend="gfdl">GNU FDL</link> in appendix - </simpara> - </listitem> - <listitem> - <simpara>Using new XSL stylesheets V1.62.4</simpara> - </listitem> - <listitem> - <simpara>Switched to - <ulink url="http://xmlsoft.org/XSLT/"><literal>xsltproc</literal></ulink> - as XSLT-processor - </simpara> - </listitem> - <listitem> - <simpara>Reedited some deeply nested sections</simpara> - </listitem> - <listitem> - <simpara>Changed colors in CSS</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.2.4 03-09-06</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Added subsection - <link linkend="dcolumn"><literal>dcolumn</literal></link> - </simpara> - </listitem> - <listitem> - <simpara>Subsection - <link linkend="fontenc"><literal>fontenc</literal></link> - translated into english - </simpara> - </listitem> - <listitem> - <simpara>Corrected typo in - <link linkend="cmd-sbox"><filename role="nohyphenation">\sbox</filename></link> - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.2.3 03-04-12</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Provide PDF output using <ulink url="http://www.pragma-ade.com/">&context;</ulink> and <ulink url="http://www.hobby.nl/~scaprea/context/index.html">&dic;</ulink> (still experimental) - </simpara> - </listitem> - <listitem> - <simpara>Reedited (beautified) sections LaTeX / Commands / <link linkend="counters">Counters</link> | <link linkend="cross-references">Cross References</link> | <link linkend="definitions">Definitions</link> | <link linkend="layout">Layout</link> | <link linkend="env-latex">Environments</link> | <link linkend="footnotes">Footnotes</link> - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.2.2 03-01-26</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Added bzip2 compressed version of source and - outfiles tarball - </simpara> - </listitem> - <listitem> - <simpara>Using new XSL stylesheets V1.60.1 - </simpara> - </listitem> - <listitem> - <simpara>Eliminated more spurious &Acirc; - characters in HTML output - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.2.1 03-01-18</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Using new XSL stylesheets V1.59.2</simpara> - </listitem> - <listitem> - <simpara>Eliminated spurious &Acirc; characters</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.2.0 03-01-11</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Using new XSL stylesheets V1.58.1</simpara> - </listitem> - <listitem> - <simpara>Minor changes to CSS file - </simpara> - </listitem> - <listitem> - <simpara>License changed to - <ulink url="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</ulink> - </simpara> - </listitem> - <listitem> - <simpara>Added subsection - <link linkend="pstricks-commands">Commands and Parameters</link> - to section - <link linkend="pstricks">&pstricks;</link> - </simpara> - </listitem> - <listitem> - <simpara>Reworked <link - linkend="inputenc">inputenc</link> section - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.1.3 02-10-17</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara> - Started rework of - <link linkend="komascript">&komascript;</link> - section - </simpara> - </listitem> - <listitem> - <simpara>Added subsection - <link linkend="pstricks-add-packages"> - Additional &pstricks; Packages</link></simpara> - </listitem> - <listitem> - <simpara>Using new XSL stylesheets V1.56.1</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term>V0.1.2 02-10-01</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Reworked - <link linkend="hyperref">hyperref</link> - section - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.1.1 02-09-19</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Added template sections for - <link linkend="pictex">&pictex;</link> - and <link linkend="texinfo">&texinfo;</link> - </simpara> - </listitem> - <listitem> - <simpara>Added subsection - <link linkend="release-news">Release News</link> - in appendix - <link linkend="about">About this Document</link> - </simpara> - </listitem> - <listitem> - <simpara>Using new XSL stylesheets V1.55.0</simpara> - </listitem> - <listitem> - <simpara>Added missing CSS file to outfiles tarball</simpara> - </listitem> - <listitem> - <simpara>Corrected wrong FPI</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.1.0 02-08-20</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Eliminated trailing '.' in numbered sections</simpara> - </listitem> - <listitem> - <simpara>Minor markup errors corrected</simpara> - </listitem> - <listitem> - <simpara>Reworked CSS file</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.0.5 02-08-10</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Switched to DocBook XML 4.2</simpara> - </listitem> - <listitem> - <simpara>Sections 'Bibindex' and 'xindy' completed</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.0.4 02-07-25</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Section 'Makeindex' completed</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.0.3 02-07-13</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>New XSL stylesheets solve bug in creating - index (no other changes) - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.0.2 02-07-05</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>New (template) sections 'fontinst', 'Bibtex', - 'Makeindex', and 'xindy' - </simpara> - </listitem> - <listitem> - <simpara>New section 'Special Symbols'</simpara> - </listitem> - <listitem> - <simpara>Added information for 'german' package</simpara> - </listitem> - <listitem> - <simpara>Registered as a new project (tex-refs) - on freshmeat.net - </simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>V0.0.1 02-06-21</term> - <listitem> - <itemizedlist spacing="compact"> - <listitem> - <simpara>First official announcement</simpara> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - </variablelist> - - </section> - - <section id="gfdl"> - <title>GNU Free Documentation License</title> - <bridgehead>Version 1.2, November 2002</bridgehead> - -<programlisting role="normal"> - Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - -0. PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document "free" in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - - -1. APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The "Document", below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as "you". You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall subject -(or to related matters) and contains nothing that could fall directly -within that overall subject. (Thus, if the Document is in part a -textbook of mathematics, a Secondary Section may not explain any -mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML -or XML using a publicly available DTD, and standard-conforming simple -HTML, PostScript or PDF designed for human modification. Examples of -transparent image formats include PNG, XCF and JPG. Opaque formats -include proprietary formats that can be read and edited only by -proprietary word processors, SGML or XML for which the DTD and/or -processing tools are not generally available, and the -machine-generated HTML, PostScript or PDF produced by some word -processors for output purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -A section "Entitled XYZ" means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as "Acknowledgements", -"Dedications", "Endorsements", or "History".) To "Preserve the Title" -of such a section when you modify the Document means that it remains a -section "Entitled XYZ" according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has fewer than five), - unless they release you from this requirement. -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. Preserve the section Entitled "History", Preserve its Title, and add - to it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section Entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions - it was based on. These may be placed in the "History" section. - You may omit a network location for a work that was published at - least four years before the Document itself, or if the original - publisher of the version it refers to gives permission. -K. For any section Entitled "Acknowledgements" or "Dedications", - Preserve the Title of the section, and preserve in the section all - the substance and tone of each of the contributor acknowledgements - and/or dedications given therein. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section Entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section to be Entitled "Endorsements" - or to conflict in title with any Invariant Section. -O. Preserve any Warranty Disclaimers. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled "History" -in the various original documents, forming one section Entitled -"History"; likewise combine any sections Entitled "Acknowledgements", -and any sections Entitled "Dedications". You must delete all sections -Entitled "Endorsements". - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. - -You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an "aggregate" if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled "Acknowledgements", -"Dedications", or "History", the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document except -as expressly provided for under this License. Any other attempt to -copy, modify, sublicense or distribute the Document is void, and will -automatically terminate your rights under this License. However, -parties who have received copies, or rights, from you under this -License will not have their licenses terminated so long as such -parties remain in full compliance. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. See -http://www.gnu.org/copyleft/. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. - - -ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.2 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the "with...Texts." line with this: - - with the Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. -</programlisting> - - </section> - - <index id="tex-refs-idx"> - </index> - -</appendix> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-bibtex.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-bibtex.xml deleted file mode 100644 index cb397dd336e..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-bibtex.xml +++ /dev/null @@ -1,1345 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-bibtex.xml 139 2004-08-26 16:58:10Z mw $ --> - -<chapter id="bibtex" lang="en"> - <title id="bibtex-title">&bibtex;</title> - <indexterm><primary>BibTeX</primary></indexterm> - - <note><para>The contents of this section was taken from the HTML - helppages for &bibtex; of Norman Walsh (Version 1.0, 12 Apr 94). - </para></note> - - <para>Invokes the &bibtex; utility to compile a bibliography file - for &latex;. Full details can be found in - "&latex;: A Document Preparation System" by Leslie Lamport. - </para> - - <section id="bibtex-parameters"> - <title>Parameters</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Parameters</secondary> - </indexterm> - <para><literal>bibliography-file-spec</literal></para> - <para>Specifies the name of the bibliography database file - to be compiled by &bibtex;. If the file specification does - not include a file type, &bibtex; assumes a default type of BIB. - </para> - </section> - - <section id="bibtex-command-qualifiers"> - <title>Command Qualifiers</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Command Qualifiers</secondary> - </indexterm> - <para><literal>/BIBINPUTS /BIBINPUTS=(name,...)</literal></para> - <para>Specify directories containing input files, and the order - in which they will be searched to locate each input file. - A null value in the list indicates the current directory. - The search procedure &tex; uses to locate input files is to - first search your default directory and then search each of - the directories specified by the <literal>/BIBINPUTS</literal> - option. - </para> - <para>Default is <literal>/BIBINPUTS=(TEX_BIB:)</literal>; - &tex; looks in the directory associated with the logical name - <literal>TEX_BIB.</literal> - </para> - <para><literal>/STATS /STATS /NOSTATS [D]</literal></para> - <para>This qualifier is used while debugging - <literal>.BST</literal> files to determine BIBTEX memory usage. - </para> - <para><literal>/TEXINPUTS /TEXINPUTS=(name,...)</literal></para> - <para>Specify directories containing input files, and the order - in which they will be searched to locate each input file. - A null value in the list indicates the current directory. - The search procedure &tex; uses to locate input files is to - first search your default directory and then search each of - the directories specified by the - <literal>/TEXINPUTS</literal> option. - </para> - <para>Default is <literal>/TEXINPUTS=(TEX_INPUTS)</literal>; - &tex; looks in the directory associated with the logical name - <literal>TEX_INPUTS</literal>. - </para> - <para><literal>/TRACE /TRACE /NOTRACE [D]</literal></para> - <para>This qualifier is used while debugging - <literal>.BST</literal> files to follow program flow. - </para> - </section> - - <section id="bibtex-bib-files"> - <title>bib files</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bib files</secondary> - </indexterm> - - <para>This help entry contains the same information as - Appendix B of the &latex; manual. It describes the format - of a bibliography database (<literal>.BIB</literal>) file. - </para> - <para>A bibliography database file may contains two types - of entry - an abbreviation definition or a reference entry - for citation. - </para> - - <section id="bibtex-string-command"> - <title><filename role="nohyphenation">@STRING</filename> command</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bib files</secondary> - <tertiary>@STRING command</tertiary> - </indexterm> - - <para>The <literal>@STRING</literal> command is used to define - abbreviations for use by &bibtex; within the bibliography - database file. The command - <programlisting> @string{jgg1 = "Journal of Gnats and Gnus, Series~1"}</programlisting> - defines 'jgg1' to be the abbreviation for the string - "Journal of Gnats and Gnus, Series~1". Parentheses can be used - in place of the outermost braces in the @string command, - and braces can be used instead of the quotation marks. - The text must have matching braces. - </para> - <para>The case of letters is ignored in an abbreviation as well - as in the command name @string, so the command above could - have been written: - <programlisting> @STRING{JgG1 = "Journal of Gnats and Gnus, Series~1"} </programlisting> - </para> - <para>A <literal>@string</literal> command can appear anywhere - before or between entries in a bibliography database file. - However, it must come before any use of the abbreviation, - so a sensible place for <literal>@string</literal> commands - is at the beginning of the file. A <literal>@string</literal> - command in the bibliography database file takes precedence - over a definition made by the bibliography style, so it can - be used to change the definition of an abbreviation such as - 'Feb'. - </para> - - </section> - - <section id="bibtex-entry-format"> - <title>Entry Format</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bib files</secondary> - <tertiary>Entry Format</tertiary> - </indexterm> - - <para>A bibliography database file contains a series of - reference entries like the following: - <programlisting> @BOOK{kn:gnus, - AUTHOR = "Donald E. Knudson", - TITLE = "1966 World Gnus Almanac", - PUBLISHER = {Permafrost Press}, - ADDRESS = {Novisibirsk} }</programlisting> - </para> - <para>The <literal>@BOOK</literal> states that this is an - entry of type book. various entry types are described below. - The 'kn:gnus' is the citation key, as it appears in the - argument of a <literal>\cite</literal> command referring - to the entry. - </para> - <para>This entry has four fields, named - <literal>AUTHOR</literal>, <literal>TITLE</literal>, - <literal>PUBLISHER</literal> and <literal>ADDRESS</literal>. - The meanings of these and other fields are described below. - A field consists of the name, an '=' character with optional - space around it, followed by its text. The text of a field - is a string of characters, with no unmatched braces, - surrounded by either a pair of braces or a pair of '"' - characters. Entry fields are separated from one another, - and from the citation key, by commas. A comma may have - optional space around it. - </para> - <para>The outermost braces that surround the entire entry - may be replaced by parentheses. As in &tex; input files, - an end-of-line character counts as a space and one space - is equivalent to many spaces. Unlike &tex;, &bibtex; ignores - the case of letters in the entry type, citation key and - field names. The above entry could have been typed as follows: - <programlisting>@BOOK(kn:gnus, author = {Donald E. Knudson}, - TITLE = "1966 World Gnus Almanac", - PUBLISHER = {Permafrost Press}, - ADDRESS = {Novisibirsk} )</programlisting> - </para> - <para>However, the case of letters does matter to &latex;, - so the citation key ("kn:gnus" in the example above) - should appear exactly the same in all <literal>\cite</literal> - commands in the &latex; input file. - </para> - <para>The quotes or braces can be omitted around text consisting - entirely of numerals. The following two fields are equivalent: - <programlisting>Volume = "27" Volume = 27</programlisting> - </para> - </section> - - <section id="bibtex-entry-types"> - <title>Entry Types</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bib files</secondary> - <tertiary>Entry Types</tertiary> - </indexterm> - <para>When entering a reference in the bibliography database, - the first thing to decide is what type of entry it is. No - fixed classification scheme can be complete, but &bibtex; - provides enough entry types to handle almost any reference - reasonably well. - </para> - <para>References to different types of publications contain - different information; a reference to a journal might - include the volume and number of the journal, which is - usually not meaningful for a book. Therefore, database - entries of different types have different fields for each - entry type, the fields are divided into three classes: - <variablelist role="db2latex:compact"> - <varlistentry> - <term>Required</term> - <listitem> - <para>omitting the field will produce an error - message and may result in a badly formatted - bibliography entry. If the required information - is not meaningful, you are using the wrong entry type. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Optional</term> - <listitem> - <para>the field's information will be used if present, - but can be omitted without causing any formatting - problems. A reference should contain any available - information that might help the reader, so you should - include the optional field if it is applicable. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Ignored</term> - <listitem> - <para>the field is ignored. &bibtex; ignores any field - that is not required or optional, so you can include - any fields you want in a bibliography entry. It's - often a good idea to put all relevant information - about a reference in its bibliography entry - even - information that may never appear in the bibliography. - For example, if you want to keep an abstract of a - paper in a computer file, put it in an 'abstract' - field in the paper's bibliography entry. The - bibliography database file is likely to be as good - a place as any for the abstract, and it is possible - to design a bibliography style for printing - selected abstracts. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - <para>&bibtex; ignores the case of letters in the entry - type.</para> - - <section id="bibtex-entry-types-article"> - <title>article entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>article entry</tertiary> - </indexterm> - <para>An article from a journal or magazine.</para> - <para>Format: - <programlisting>@ARTICLE{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-journal">journal</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-volume">volume</link>, - <link linkend="bibtex-field-types-number">number</link>, - <link linkend="bibtex-field-types-pages">pages</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-book"> - <title>book entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>book entry</tertiary> - </indexterm> - <para>A book with an explicit publisher.</para> - <para>Format: - <programlisting>@BOOK{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link> or - <link linkend="bibtex-field-types-editor">editor</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-publisher">publisher</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-volume">volume</link>, - <link linkend="bibtex-field-types-series">series</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-edition">edition</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-booklet"> - <title>booklet entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>booklet entry</tertiary> - </indexterm> - <para>A work that is printed and bound, but without a - named publisher or sponsoring institution. - </para> - <para>Format: - <programlisting>@BOOKLET{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-title">title</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-howpublished">howpublished</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-year">year</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-conference"> - <title>conference entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>conference entry</tertiary> - </indexterm> - <para>An article in the proceedings of a conference. - This entry is identical to the 'inproceedings' entry - and is included for compatibility with another text - formatting system. - </para> - <para>Format: - <programlisting>@CONFERENCE{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-booktitle">booktitle</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-editor">editor</link>, - <link linkend="bibtex-field-types-pages">pages</link>, - <link linkend="bibtex-field-types-organization">organization</link>, - <link linkend="bibtex-field-types-publisher">publisher</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-inbook"> - <title>inbook entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>inbook entry</tertiary> - </indexterm> - <para>A part of a book, which may be a chapter and/or - a range of pages. - </para> - <para>Format: - <programlisting>@INBOOK{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link> - or - <link linkend="bibtex-field-types-editor">editor</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-chapter">chapter</link> - and/or - <link linkend="bibtex-field-types-pages">pages</link>, - <link linkend="bibtex-field-types-publisher">publisher</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-volume">volume</link>, - <link linkend="bibtex-field-types-series">series</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-edition">edition</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-incollection"> - <title>incollection entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>incollection entry</tertiary> - </indexterm> - <para>A part of a book with its own title.</para> - <para>Format: - <programlisting>@INCOLLECTION{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-booktitle">booktitle</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-editor">editor</link>, - <link linkend="bibtex-field-types-pages">pages</link>, - <link linkend="bibtex-field-types-organization">organization</link>, - <link linkend="bibtex-field-types-publisher">publisher</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-inproceedings"> - <title>inproceedings entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>inproceedings entry</tertiary> - </indexterm> - <para>An article in the proceedings of a conference.</para> - <para>Format: - <programlisting>@INPROCEEDINGS{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-booktitle">booktitle</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-editor">editor</link>, - <link linkend="bibtex-field-types-pages">pages</link>, - <link linkend="bibtex-field-types-organization">organization</link>, - <link linkend="bibtex-field-types-publisher">publisher</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-manual"> - <title>manual entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>manual entry</tertiary> - </indexterm> - <para>Technical documentation.</para> - <para>Format: - <programlisting>@MANUAL{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-title">title</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-organization">organization</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-edition">edition</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-year">year</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-mastersthesis"> - <title>mastersthesis entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>mastersthesis entry</tertiary> - </indexterm> - <para>A Master's thesis.</para> - <para>Format: - <programlisting>@MASTERSTHESIS{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-school">school</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-misc"> - <title>misc entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>misc entry</tertiary> - </indexterm> - <para>Use this type when nothing else seems - appropriate.</para> - <para>Format: - <programlisting>@MISC{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: none - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-howpublished">howpublished</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-year">year</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-phdthesis"> - <title>phdthesis entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>phdthesis entry</tertiary> - </indexterm> - <para>A PhD thesis. - </para> - <para>Format: - <programlisting>@PHDTHESIS{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-school">school</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-proceedings"> - <title>proceedings entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>proceedings entry</tertiary> - </indexterm> - <para>The proceedings of a conference. - </para> - <para>Format: - <programlisting>@PROCEEDINGS{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-editor">editor</link>, - <link linkend="bibtex-field-types-publisher">publisher</link>, - <link linkend="bibtex-field-types-organization">organization</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-techreport"> - <title>techreport entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>techreport entry</tertiary> - </indexterm> - <para>A report published by a school or other institution, - usually numbered within a series. - </para> - <para>Format: - <programlisting>@TECHREPORT{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-institution">institution</link>, - <link linkend="bibtex-field-types-year">year</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-type">type</link>, - <link linkend="bibtex-field-types-number">number</link>, - <link linkend="bibtex-field-types-address">address</link>, - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-note">note</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - <section id="bibtex-entry-types-unpublished"> - <title>unpublished entry</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Entry Types</secondary> - <tertiary>unpublished entry</tertiary> - </indexterm> - <para> A document with an author and title, but not - formally published. - </para> - <para>Format: - <programlisting>@UNPUBLISHED{citation_key, - required_fields [, optional_fields] }</programlisting> - </para> - <para>Required fields: - <link linkend="bibtex-field-types-author">author</link>, - <link linkend="bibtex-field-types-title">title</link>, - <link linkend="bibtex-field-types-note">note</link> - </para> - <para>Optional fields: - <link linkend="bibtex-field-types-month">month</link>, - <link linkend="bibtex-field-types-year">year</link>, - <link linkend="bibtex-field-types-key">key</link> - </para> - </section> - - </section> - - <section id="bibtex-field-text"> - <title>Field Text</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bib files</secondary> - <tertiary>Field Text</tertiary> - </indexterm> - <para>The text of the field is enclosed in braces or double - quote characters. A part of the text is said to be enclosed - in braces if it lies inside a matching pair of braces other - than the ones enclosing the entire entry or the entire field text. - </para> - <para>&bibtex; manipulates the case of letters in the field text - as described in the subtopics below. - </para> - - <section id="bibtex-field-text-names"> - <title>Names</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Text</secondary> - <tertiary>Names</tertiary> - </indexterm> - <para>The text of an author or editor field represents a - list of names. The bibliography style determines the format - in which the name is printed: whether the first name or - last name appears first, if the full first name or just - the first initial is used, etc. The bibliography file entry - simply tells &bibtex; what the name is. - </para> - <para>You should type an author's complete name and let the - bibliography style decide what to abbreviate. (But an - author's complete name may be "Donald~E. Knuth" or - even "J.~P.~Morgan"; you should type it the way the - author would like it to appear, if that's known.) - </para> - <para>Most names can be entered in the obvious way, either - with or without a comma, as in the following examples: - </para> - <para>"John Paul Jones" "Jones, John Paul" - "Ludwig von Beethoven" "von Beethoven, Ludwig" - </para> - <para>Some people have multiple last names - for example, - Per Brinch Hansen's last name is Brinch~Hansen. - His name should be typed with a comma: - </para> - <para> "Brinch Hansen, Per" - </para> - <para>To understand why, you must understand how &bibtex; - handles names (for what follows, a "name" corresponds - to a person). - </para> - <para>Each name consists of four parts: First, von, Last, - and~Jr; each part consists of a (possibly empty) list - of name-tokens. For example the First part of - Per Brinch~Hansen's name has the single token "Per"; - the Last part has two, "Brinch" and "Hansen"; and the - von and Jr parts are empty. If you had typed - </para> - <para>"Per Brinch Hansen"</para> - <para>instead, &bibtex; would erroneously think "Brinch" - were a First-part token, just as "Paul" is a First-part - token in "John~Paul Jones". - </para> - <para>Here's another example:</para> - <para>"Charles Louis Xavier Joseph de la Vallee - Poussin" - </para> - <para>This name has four tokens in the First part, two - in the von, and two in the Last. Here &bibtex; knows - where one part ends and the other begins because the - tokens in the von part begin with lower-case letters. - </para> - <para>If you want &bibtex; to consider something a single - token, enclose it in braces. You should do this, - for example, if a comma is part of a name: - </para> - <para>"{Barnes and Noble, Inc.}" "{Barnes and} {Noble, Inc.}" - "{Barnes} {and} {Noble,} {Inc.}" - </para> - <para>The braces surrounding the comma keep "Inc." from - being interpreted as a First token; this name has only - a Last part, with either one, two, or four tokens - (there must be a space separating the tokens in the - second and third forms). Probably the second form is - slightly more meaningful, but don't lose sleep over this - since only rarely will an institution be an author or - editor. - </para> - <para>So the two names</para> - <para>"von Beethoven, Ludwig" "{von Beethoven}, Ludwig" - </para> - <para>are considered by &bibtex; to be different names. - In the first, "Beethoven" is the Last part and "von" - is the von part; in the second, which in this case - happens to be incorrect, the Last part has a single - token and there's no von part. The bibliography style - will probably print both the same, but it may alphabetize - and label them differently. - </para> - <para>"Juniors" pose a special problem. Most people having - "Jr." in their name precede it with a comma. Such a name - should be entered as follows: - </para> - <para>"Ford, Jr., Henry"</para> - <para>However, a few people do not use a comma. They are - handled by considering the "Jr." to be part of the last - Last token: - </para> - <para>"{Steele Jr.}, Guy L." "Guy L. {Steele Jr.}"</para> - <para>This name has no Jr part.</para> - <para>To summarize, you may type a name in one of - three forms: - </para> - <para>"First von Last" "von Last, First" - "von Last, Jr, First" - </para> - <para>You may almost always use the first form; you shouldn't - if either there's a Jr part or the Last part has multiple - tokens but there's no von part. - </para> - <para>If there are multiple authors or editors, their - names must be separated by the word "and", surrounded - by spaces, not enclosed in braces: - </para> - <para>AUTHOR = "Ralph Alpher and Bethe, Hans and George Gamow" - </para> - <para>Since &bibtex; interprets commas as separating parts - of a name and "and" as separating names themselves, - this example has three coauthors: Ralph Alpher, - Hans Bethe, and George Gamow. If the word "and" appears - as part of a name, it must be enclosed in braces, as in - the example of "Barnes and Noble,~Inc." given above. - If you have too many names to list in a field, you can - end the list with "and others"; the standard styles - appropriately append an "et al." - </para> - <para>&bibtex;'s rules are actually a bit more complicated - than indicated here, but this description will - suffice for most names. - </para> - </section> - - <section id="bibtex-field-text-titles"> - <title>Titles</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Text</secondary> - <tertiary>Titles</tertiary> - </indexterm> - <para>The bibliography style determines whether or not a - title is capitalized; the titles of books usually are, - the title of articles usually are not. You type a title - the way it should appear if it is capitalized (you - should capitalize everything but articles and unstressed - conjunctions and prepositions, and even these should - be capitalized as the first word or - the first after a colon): - </para> - <para>TITLE = "The Agony and the Ecstasy"</para> - <para>&bibtex; will change uppercase letters to lowercase - if appropriate. Uppercase letters that should not be - changed are enclosed in braces. The following two - titles are equivalent; the "A" of "Africa" will not - be made lowercase. - </para> - <para>"The Gnats and Gnus of {Africa}" - "The Gnats and Gnus of {A}frica" - </para> - </section> - - <section id="bibtex-field-text-abbr"> - <title>Abbreviations</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Text</secondary> - <tertiary>Abbreviations</tertiary> - </indexterm> - <para>Instead of an ordinary text string, the text of a - field can be replaced by an abbreviation for it. An - abbreviation is a string of characters that starts - with a letter and does not contain a space or any - of the following ten characters: - </para> - <para><literal>" # % ' ( ) , = { }</literal></para> - <para>The abbreviation is typed in place of the text - field, with no braces or quotation marks. If 'jgg1' - is an abbreviation for - </para> - <para>Journal of Gnats and Gnus, Series~1</para> - <para>then the following are equivalent:</para> - <para>JOURNAL = jgg1 JOURNAL = "Journal of Gnats and - Gnus, Series~1"</para> - <para>Some abbreviations are predefined by the bibliography - style. These always include the usual 3 letter - abbreviations for the month: jan, feb, mar etc. - </para> - <para>Bibliography styles usually contain abbreviations - for the names of commonly referenced journals. Consult - the Local Guide for a list of the predefined abbreviations - for the bibliography styles available. - </para> - <para>You can define your own abbreviations by using - &bibtex;'s <literal>@STRING</literal> command. - </para> - </section> - - </section> - - <section id="bibtex-field-types"> - <title>Field Types</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bib files</secondary> - <tertiary>Field Types</tertiary> - </indexterm> - <para>Below is a list of all fields recognized by the - standard bibliography styles. An entry can also contain - other fields, which are ignored by those styles. - </para> - <para>&bibtex; ignores the case of letters in the - field names. - </para> - - <section id="bibtex-field-types-address"> - <title>address field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>address field</tertiary> - </indexterm> - <para>Publisher's address. For major publishing houses, - just the city is given. For small publishers, you can - help the reader by giving the complete address. - </para> - <para>Format: - <programlisting>ADDRESS = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-annote"> - <title>annote field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>annote field</tertiary> - </indexterm> - <para>An annotation, used only for annotated bibliography - styles (which are not among the standard ones). - </para> - <para>Format: - <programlisting>ANNOTE = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-author"> - <title>author field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>author field</tertiary> - </indexterm> - <para>The name(s) of the author(s). - </para> - <para>Format: - <programlisting>AUTHOR = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-booktitle"> - <title>booktitle field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>booktitle field</tertiary> - </indexterm> - <para>Title of a book, part of which is being cited.</para> - <para>Format: - <programlisting>BOOKTITLE = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-chapter"> - <title>chapter field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>chapter field</tertiary> - </indexterm> - <para>A chapter number.</para> - <para>Format: - <programlisting>CHAPTER = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-edition"> - <title>edition field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>edition field</tertiary> - </indexterm> - <para>The edition of a book - for example, "second".</para> - <para>Format: - <programlisting>EDITION = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-editor"> - <title>editor field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>editor field</tertiary> - </indexterm> - <para>Name(s) of editor(s). If there is also an "author" - field, then the "editor" field gives the editor of - the book or collection in which the reference appears. - </para> - <para>Format: - <programlisting>EDITOR = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-howpublished"> - <title>howpublished field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>howpublished field</tertiary> - </indexterm> - <para>How something strange has been published.</para> - <para>Format: - <programlisting>HOWPUBLISHED = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-institution"> - <title>institution field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>institution field</tertiary> - </indexterm> - <para>The institution that published the work.</para> - <para>Format: - <programlisting>INSTITUTION = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-journal"> - <title>journal field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>journal field</tertiary> - </indexterm> - <para>A journal name. Abbreviations are provided for many - journals; see the Local Guide. - </para> - <para>Format: - <programlisting>JOURNAL = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-key"> - <title>key field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>key field</tertiary> - </indexterm> - <para> Used for alphabetizing and creating a label - when the "author" and "editor" fields are missing. - This field should not be confused with the citation - key that appears in the <literal>\cite</literal> - command and at the beginning of the entry. - </para> - <para>Format: - <programlisting>KEY = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-month"> - <title>month field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>month field</tertiary> - </indexterm> - <para>The month in which the work was published or, - for an unpublished work, in which it was written. - </para> - <para>Format: - <programlisting>MONTH = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-note"> - <title>note field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>note field</tertiary> - </indexterm> - <para>Any additional information that can help the reader. - </para> - <para>Format: - <programlisting>NOTE = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-number"> - <title>number field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>number field</tertiary> - </indexterm> - <para>The number of a journal, magazine, or technical - report. An issue of a journal or magazine is usually - identified by its volume and number; the organization - that issues a technical report usually gives it a number. - </para> - <para>Format: - <programlisting>NUMBER = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-organization"> - <title>organization field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>organization field</tertiary> - </indexterm> - <para>The organization sponsoring a conference. - </para> - <para>Format: - <programlisting>ORGANIZATION = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-pages"> - <title>pages field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>pages field</tertiary> - </indexterm> - <para>A page number or range of numbers such as "42--111"; - you may also have several of these, separating them with - commas: "7,41,73--97". The standard styles convert a - single dash to a double. > - </para> - <para>Format: - <programlisting>PAGES = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-publisher"> - <title>publisher field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>publisher field</tertiary> - </indexterm> - <para>The publisher's name. - </para> - <para>Format: - <programlisting>PUBLISHER = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-school"> - <title>school field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>school field</tertiary> - </indexterm> - <para>The name of the school where a thesis was written. - </para> - <para>Format: - <programlisting>SCHOOL = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-series"> - <title>series field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>series field</tertiary> - </indexterm> - <para>The name of a series or set of books. When citing - an entire book, the the "title" field gives its title - and an optional "series" field gives the name of a series - in which the book is published. - </para> - <para>Format: - <programlisting>SERIES = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-title"> - <title>title field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>title field</tertiary> - </indexterm> - <para>The work's title. - </para> - <para>Format: - <programlisting>TITLE = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-type"> - <title>type field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>type field</tertiary> - </indexterm> - <para>The type of a technical report - for example, - "Research Note". - </para> - <para>Format: - <programlisting>TYPE = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-volume"> - <title>volume field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>volume field</tertiary> - </indexterm> - <para>The volume of a journal or multivolume book work. - </para> - <para>Format: - <programlisting>VOLUME = field_text</programlisting> - </para> - </section> - - <section id="bibtex-field-types-year"> - <title>year field</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>Field Types</secondary> - <tertiary>year field</tertiary> - </indexterm> - <para>The year of publication or, for an unpublished - work, the year it was written. This field's text - should contain only numerals. - </para> - <para>Format: - <programlisting>YEAR = field_text</programlisting> - </para> - </section> - - </section> - - </section> - - <section id="bibtex-bst-files"> - <title>bst files</title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bst files</secondary> - </indexterm> - <para>Bibliography style files define the style of a - bibliography source list.</para> - <para>The standard bibliography style files are - <link linkend="bibtex-bst-plain"><filename role="nohyphenation">PLAIN</filename></link>, - <link linkend="bibtex-bst-unsrt"><filename role="nohyphenation">UNSRT</filename></link>, - <link linkend="bibtex-bst-alpha"><filename role="nohyphenation">ALPHA</filename></link> - and - <link linkend="bibtex-bst-abbr"><filename role="nohyphenation">ABBRV</filename></link>. - </para> - <para>If you want to make a bibliography style of your own, - look at <link linkend="bibtex-bst-sample"><filename role="nohyphenation">SAMPLE.BST</filename></link>. - </para> - - <section id="bibtex-bst-abbr"> - <title><filename role="nohyphenation">ABBRV.BST</filename></title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bst files</secondary> - <tertiary>ABBRV.BST</tertiary> - </indexterm> - <para>This style is the same as the style defined in - <filename>PLAIN.BST</filename>, except that entries are - more compact because first names, month names and journal - names are abbreviated. - </para> - </section> - - <section id="bibtex-bst-alpha"> - <title><filename role="nohyphenation">ALPHA.BST</filename></title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bst files</secondary> - <tertiary>ALPHA.BST</tertiary> - </indexterm> - <para>This style is the same as the style defined in - <filename>PLAIN.BST</filename> except that entry labels - like "Knu66", formed from the author's name and the year - of publication, are used. - </para> - </section> - - <section id="bibtex-bst-plain"> - <title><filename role="nohyphenation">PLAIN.BST</filename></title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bst files</secondary> - <tertiary>PLAIN.BST</tertiary> - </indexterm> - <para>This style is formatted more or less as suggested - by Mary-Claire van Leunen in "A Handbook for Scholars" - (Alfred A. Knopf, New York, 1979). Entries are sorted - alphabetically and are labelled with numbers. - </para> - </section> - - <section id="bibtex-bst-sample"> - <title><filename role="nohyphenation">SAMPLE.BST</filename></title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bst files</secondary> - <tertiary>SAMPLE.BST</tertiary> - </indexterm> - <para>This is a sample bibliography style file meant to - help you construct a new style. It creates a bibliography - in which entries appear as follows: - </para> - <para>[Jones79] Jones, R. L. and Richards, P. Q. The Birds - and the Bees. {\it Journal of Irreproducible Results 4}, - 2 (Jan. 1979), 27-33. - </para> - <para>[Jones82a] Jones, P. G. The Bees and the - Trees ... (1982). - </para> - <para>[Jones82b] Jones, R. L. The Trees and the - Peas ... (1982). - </para> - <para>[Krist74] Kristofferson, R. P. Peopl and - Places ... (1974) - </para> - <para>It should illustrate how you write a style file. - The functions are described in an informal Pascal-like - style in comments. Because of the way while loops and - if-then-else statements must use functions, the following - convention is used. If a while loop is labeled 'foo' - in the informal description, then its test and body - are the functions named 'foo.test' and 'foo.body'. - If an if statement is labeled 'foo', then its two clauses - are the functions named 'foo.then' and 'foo.else'. - (Null clauses just use the 'skip$' function.) Note that - because functions have to be defined in terms of - already-defined functions, the actual function definitions - are given in a 'bottom-up' order. - </para> - </section> - - <section id="bibtex-bst-unsrt"> - <title><filename role="nohyphenation">UNSRT.BST</filename></title> - <indexterm> - <primary>BibTeX</primary> - <secondary>bst files</secondary> - <tertiary>UNSRT.BST</tertiary> - </indexterm> - <para>This style is that same as <filename>PLAIN.BST</filename> - except that entries appear in the order of their - first citation. - </para> - </section> - - </section> - -</chapter> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-makeindex.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-makeindex.xml deleted file mode 100644 index 170738f622f..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-makeindex.xml +++ /dev/null @@ -1,1158 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-makeindex.xml 139 2004-08-26 16:58:10Z mw $ --> - -<chapter id="makeindex" lang="en"> - <title id="makeindex-title">&makeindex;</title> - <indexterm><primary>Make-Index</primary></indexterm> - - <note> - <para>The contents of this section was taken from - the HTML helppages for &makeindex; - of Norman Walsh (Version 1.0, 12 Apr 94). - </para> - <para>Some obvious errors in this documentation have been corrected - according to <filename>makeindex(1L)</filename>. - </para> - <para>Additional information was taken from - <filename>makeindex(1L)</filename> and the program source - files as found in te&tex; 2.0.2.</para> - </note> - - <para>&makeindex; is a general purpose index processor. - It takes one or more raw index files (normally generated - by a formatter), sorts the entries, and produces the actual - index file. It is not dependent on any particular format of - raw index file, although the <literal>.idx</literal> file - generated by &latex; is - the default. Up to three levels (0, 1, and 2) of subitem nesting - within the same entry is supported. The input format may be - redefined in a style file so that raw index or glossary output - from other formatters may be processed. The style file also - defines the style of output index file. Unless specified - otherwise, the file name base of the first input file - (<literal>idx0</literal>) - is used to determine other related input/output files. - The default input file type is <literal>.idx</literal>. - </para> - - <section id="makeindex-options"> - <title id="makeindex-options-title">Options</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - </indexterm> - <para>&makeindex; is a Unix program, and therefore has a - Unix-style command line. Instead of qualifiers delimited with - a slash (<literal>/</literal>), &makeindex; options are delimited - with a hyphen (<literal>-</literal>). - </para> - - <section id="makeindex-option-c"> - <title><filename role="nohyphenation">-c</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-c</tertiary> - </indexterm> - <para>Enable blank compression. By default every blank counts - in the index key. The <literal>-c</literal> option ignores - leading and trailing blanks and tabs and compresses - intermediate ones to a single space. - </para> - </section> - - <section id="makeindex-option-g"> - <title><filename role="nohyphenation">-g</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-g</tertiary> - </indexterm> - <para>Employ German word ordering in the index, - in accord with rules set forth in DIN 5007. The - quote character must be redefined in a style file - (for example, redefine quote as <literal>'+'</literal>). - If the quote character is not redefined, &makeindex; - will produce an error message and abort. - </para> - </section> - - <section id="makeindex-option-i"> - <title><filename role="nohyphenation">-i</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-i</tertiary> - </indexterm> - <para> Use <literal>stdin</literal> as the input file. - When this option is specified and the <literal>-o</literal> - is not, output is written to <literal>stdout</literal>. - </para> - </section> - - <section id="makeindex-option-l"> - <title><filename role="nohyphenation">-l</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-l</tertiary> - </indexterm> - <para>Use letter ordering. Default is word ordering - (explained in the - <link linkend="makeindex-ordering">Ordering</link> - section). - </para> - </section> - - <section id="makeindex-option-q"> - <title><filename role="nohyphenation">-q</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-q</tertiary> - </indexterm> - <para>Quiet mode, send no messages to <literal>stderr</literal>. - By default progress and error messages are sent to - <literal>stderr</literal> as well as the transcript file. - The <literal>-q</literal> option disables the - <literal>stderr</literal> messages. - </para> - </section> - - <section id="makeindex-option-r"> - <title><filename role="nohyphenation">-r</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-r</tertiary> - </indexterm> - <para>Disable implicit page range formation. By default - three or more successive pages will be automatically - abbreviated as a range (e.g. 1--5). The <literal>-r</literal> - option disables it, making the explicit range operators - the only way to create page ranges (see the - <link linkend="makeindex-special-effects">Special Effects</link> - section below). - </para> - </section> - - <section id="makeindex-option-s-sty"> - <title><filename role="nohyphenation">-s sty</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-s sty</tertiary> - </indexterm> - <para> Take <literal>sty</literal> as the style file. - There is no default for the style file name. The - environment variable INDEXSTYLE defines the path where - the style file should be found. - </para> - </section> - - <section id="makeindex-option-o-ind"> - <title><filename role="nohyphenation">-o ind</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-o ind</tertiary> - </indexterm> - <para>Take <literal>ind</literal> as the output index file. - By default the file name base of the first input file - <literal>idx0</literal> concatenated with the extension - <literal>.ind</literal> is used as the output file name. - </para> - </section> - - <section id="makeindex-option-t-log"> - <title><filename role="nohyphenation">-t log</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-t log</tertiary> - </indexterm> - <para>Take <literal>log</literal> as the transcript file. - By default the file name base of the first input file - <literal>idx0</literal> concatenated with the extension - <literal>.ilg</literal> is used as the transcript file name. - </para> - </section> - - <section id="makeindex-option-p-no"> - <title><filename role="nohyphenation">-p no</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-p no</tertiary> - </indexterm> - <para>Set the starting page number of the output index file - to be <literal>no</literal>. This is useful when the index - file is to be formatted separately. Other than pure numbers, - three special cases are allowed for no: - <literal>any</literal>, - <literal>odd</literal>, and <literal>even</literal>. - In these special cases, the starting page number is determined - by retrieving the last page number from the source log file. - The source log file name is determined by concatenating the - file name base of the first raw index file - (<literal>idx0</literal>) with the extension - <literal>.log</literal>. The last source page is obtained - by searching backward in the log file for the first instance - of a number included in <literal>[...]</literal>. If a page - number is missing or the log file is not found, no attempt - will be made to set the starting page number. The meaning of - each of these cases follows: - <variablelist role="db2latex:compact"> - <varlistentry> - <term>any</term> - <listitem> - <para>The starting page is the last source page - number plus 1. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>odd</term> - <listitem> - <para>The starting page is the first odd page - following the last source page number. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>even</term> - <listitem> - <para>The starting page is the first even page following - the last source page number. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="makeindex-option-L"> - <title><filename role="nohyphenation">-L</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-L</tertiary> - </indexterm> - <para>Sort based on locale settings. String comparisons for - sorting are done using <command>strcoll(3)</command>, - which compares strings according to the current locale - category <literal>LC_COLLATE</literal>.</para> - <para>Not available on all systems (depends on compile - time settings).</para> - </section> - - <section id="makeindex-option-T"> - <title><filename role="nohyphenation">-T</filename></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Options</secondary> - <tertiary>-T</tertiary> - </indexterm> - <para>Special support for Thai documents.</para> - <para> Not available on all systems (depends on compile - time settings).</para> - </section> - - </section> - - <section id="makeindex-style-file"> - <title>Style File</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Style File</secondary> - </indexterm> - <para>The style file format is very simple. It is a list of - <literal><specifier, attribute></literal> pairs. - There are two types of - specifiers (input and output). The pairs don't have to obey - any particular order in the file. A line lead by - `<literal>%</literal>' is a - comment. The following is a list of all the specifiers and - their respective arguments where - <literal><string></literal> is an arbitrary - string delimited by double quotes (<literal>"..."</literal>), - <literal><char></literal> is a single letter embraced by - single quotes - (<literal>'...'</literal>), and - <literal><number></literal> - is a nonnegative - integer. The maximum length of a - <literal><string></literal> is 144. - Notice that a backslash must be escaped (by an extra backslash) - in the string quotation. Anything not specified in the style - file will be assigned a default value, which is shown on a - separate line. This file can reside anywhere in the path - defined by the environment variable <envar>INDEXSTYLE</envar>. - </para> - - <section id="makeindex-style"> - <title>Input Style Specifiers</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - </indexterm> - - <section id="makeindex-actual-char"> - <title>actual <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>actual</tertiary> - </indexterm> - <para>&Default; <literal>@</literal></para> - <para>The symbol which indicates that the next entry is - to appear in the actual index file. - </para> - </section> - - <section id="makeindex-arg-close"> - <title>arg_close <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>arg_close</tertiary> - </indexterm> - <para>&Default; <literal>}</literal></para> - <para> This is the closing delimiter for the index - entry argument. - </para> - </section> - - <section id="makeindex-style-arg-open"> - <title>arg_open <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>arg_open</tertiary> - </indexterm> - <para>&Default; <literal>{</literal></para> - <para> This is the opening delimiter for the index entry - argument. - </para> - </section> - - <section id="makeindex-encap-char"> - <title>encap <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>encap</tertiary> - </indexterm> - <para>&Default; <literal>|</literal></para> - <para>The symbol which indicates that the rest of the - argument list is to be used as the encapsulating command - for the page number. - </para> - </section> - - <section id="makeindex-escape-char"> - <title>escape <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>escape</tertiary> - </indexterm> - <para>&Default; <literal>\\</literal></para> - <para>The symbol which escapes the next letter, unless - its preceding letter is escape. In other words, quote - is used to escape the letter which immediately follows it. - But if it is preceded by escape, it does not escape anything. - </para> - <para> Notice that the two symbols must be distinct.</para> - </section> - - <section id="makeindex-style-string"> - <title>keyword <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>keyword</tertiary> - </indexterm> - <para>&Default; <literal>"\\indexentry"</literal></para> - <para> This is the command which tells &makeindex; that its - argument is an index entry. - </para> - </section> - - <section id="makeindex-level-char"> - <title>level <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>level</tertiary> - </indexterm> - <para>&Default; <literal>!</literal></para> - <para>The delimiter which denotes a new level of subitem.</para> - </section> - - <section id="makeindex-quote-char"> - <title>quote <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>quote</tertiary> - </indexterm> - <para>&Default; <literal>"</literal></para> - <para><literal>quote</literal> is used to escape - the letter which immediately follows it, but - if it is preceded by escape, it is treated as a - ordinary character. These two symbols must be - distinct. - </para> - </section> - - <section id="makeindex-range-close"> - <title>range_close <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>range_close</tertiary> - </indexterm> - <para>&Default; <literal>)</literal></para> - <para>The closing delimiter indicating the end of an - explicit page range. - </para> - </section> - - <section id="makeindex-range-open"> - <title>range_open <char></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Input Style Specifiers</secondary> - <tertiary>range_open</tertiary> - </indexterm> - <para>&Default; <literal>(</literal></para> - <para>The opening delimiter indicating the beginning of - an explicit page range. - </para> - </section> - - </section> - - <section id="makeindex-output-style-specs"> - <title>Output Style Specifiers</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - </indexterm> - - <section id="makeindex-page-compositor"> - <title>page_compositor <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>page_compositor</tertiary> - </indexterm> - <para>&Default; <literal>"-"</literal></para> - <para>This specifier is used to separate a range - of page numbers.</para> - <para>Officially undocumented!</para> - </section> - - <section id="makeindex-output-preamble-string"> - <title>preamble <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>preamble</tertiary> - </indexterm> - <para>&Default; <literal>"\\begin{theindex}\n"</literal></para> - <para>The preamble of actual index file.</para> - </section> - - <section id="makeindex-output-postamble-string"> - <title>postamble <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>postamble</tertiary> - </indexterm> - <para>&Default; <literal>"\n\n\\end{theindex}\n"</literal></para> - <para>The postamble of actual index file.</para> - </section> - - <section id="makeindex-output-setpage-prefix"> - <title>setpage_prefix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>setpage_prefix</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\setcounter{page}{"</literal></para> - <para>The prefix of the command which sets the - starting page number. - </para> - </section> - - <section id="makeindex-output-setpage-suffix"> - <title>setpage_suffix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>setpage_suffix</tertiary> - </indexterm> - <para>&Default; <literal>"}\n"</literal></para> - <para>The suffix of the command which sets the - starting page number. - </para> - </section> - - <section id="makeindex-output-group-skip"> - <title>group_skip <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>group_skip</tertiary> - </indexterm> - <para>&Default; <literal>"\n\n \\indexspace\n"</literal></para> - <para>The vertical space to be inserted before a - new group begins. - </para> - </section> - - <section id="makeindex-output-heading-prefix-string"> - <title>heading_prefix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>heading_prefix</tertiary> - </indexterm> - <para>&Default; <literal>""</literal></para> - <para>The header prefix to be inserted before a new - letter begins. - </para> - </section> - - <section id="makeindex-output-heading-suffix-string"> - <title>heading_suffix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>heading_suffix</tertiary> - </indexterm> - <para>&Default; <literal>""</literal></para> - <para>The header suffix to be inserted before - a new letter begins. - </para> - </section> - - <section id="makeindex-output-headings-flag"> - <title>headings_flag <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>headings_flag</tertiary> - </indexterm> - <para>&Default; <literal>0</literal></para> - <para>The flag indicating the condition of inserting new - letter header. Default is 0, which means no header. - Positive means insert an uppercase letter between prefix - and suffix. Negative means insert a lowercase letter. - </para> - </section> - - <section id="makeindex-output-symhead-positive"> - <title>symhead_positive <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>symhead_positive</tertiary> - </indexterm> - <para>&Default; <literal>"Symbols"</literal></para> - <para>Heading for symbols to be inserted - if <literal>headings_flag</literal> is positive. - </para> - </section> - - <section id="makeindex-output-symhead-negative"> - <title>symhead_negative <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>symhead_negative</tertiary> - </indexterm> - <para>&Default; <literal>"symbols"</literal></para> - <para>Heading for symbols to be inserted - if <literal>headings_flag</literal> is negative. - </para> - </section> - - <section id="makeindex-output-numhead-positive"> - <title>numhead_positive <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>numhead_positive</tertiary> - </indexterm> - <para>&Default; <literal>"Numbers"</literal></para> - <para>Heading for numbers to be inserted - if <literal>headings_flag</literal> is positive. - </para> - </section> - - <section id="makeindex-output-numhead-negative"> - <title>numhead_negative <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>numhead_negative</tertiary> - </indexterm> - <para>&Default; <literal>"numbers"</literal></para> - <para>Heading for numbers to be inserted - if <literal>headings_flag</literal> is negative. - </para> - </section> - - <section id="makeindex-output-item-0"> - <title>item_0 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_0</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\item "</literal></para> - <para>The command to be inserted between two primary - (level 0) items. - </para> - </section> - - <section id="makeindex-output-item-1"> - <title>item_1 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_1</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\subitem "</literal></para> - <para>The command to be inserted between two secondary - (level 1) items. - </para> - </section> - - <section id="makeindex-output-item-2"> - <title>item_2 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_2</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\subsubitem "</literal></para> - <para>The command to be inserted between two level 2 items.</para> - </section> - - <section id="makeindex-output-item-01"> - <title>item_01 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_01</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\subitem "</literal></para> - <para>The command to be inserted between a level 0 item - and a level 1 item. - </para> - </section> - - <section id="makeindex-output-item-x1"> - <title>item_x1 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_x1</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\subitem "</literal></para> - <para>The command to be inserted between a level 0 item - and a level 1 item. The difference between this and - previous is that in this case the level 0 item doesn't - have any page numbers. - </para> - </section> - - <section id="makeindex-output-item-12"> - <title>item_12 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_12</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\subsubitem "</literal></para> - <para>The command to be inserted between a level 1 item - and a level 2 item. - </para> - </section> - - <section id="makeindex-output-item-x2"> - <title>item_x2 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>item_x2</tertiary> - </indexterm> - <para>&Default; <literal>"\n \\subsubitem "</literal></para> - <para>The command to be inserted between a level 1 item - and a level 2 item. The difference between this and - previous is that in this case the level 1 item doesn't - have any page numbers. - </para> - </section> - - <section id="makeindex-output-delim-0"> - <title>delim_0 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>delim_0</tertiary> - </indexterm> - <para>&Default; <literal>", "</literal></para> - <para>The delimiter to be inserted between a level 0 key - and its first page number. Default is a comma followed - by a blank. - </para> - </section> - - <section id="makeindex-output-delim-1"> - <title>delim_1 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>delim_1</tertiary> - </indexterm> - <para>&Default; <literal>", "</literal></para> - <para>The delimiter to be inserted between a level 1 key - and its first page number. Default is a comma followed - by a blank. - </para> - </section> - - <section id="makeindex-output-delim-2"> - <title>delim_2 <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>delim_2</tertiary> - </indexterm> - <para>&Default; <literal>", "</literal></para> - <para>The delimiter to be inserted between a level 2 key - and its first page number. Default is a comma followed - by a blank. - </para> - </section> - - <section id="makeindex-output-delim-n"> - <title>delim_n <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>delim_n</tertiary> - </indexterm> - <para>&Default; <literal>", "</literal></para> - <para>The delimiter to be inserted between two page numbers - for the same key in any level. Default is a comma followed - by a blank. - </para> - </section> - - <section id="makeindex-output-delim-r"> - <title>delim_r <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>delim_r</tertiary> - </indexterm> - <para>&Default; <literal>"--"</literal></para> - <para>The delimiter to be inserted between the starting and - ending page numbers of a range. - </para> - </section> - - <section id="makeindex-output-delim-t"> - <title>delim_t <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>delim_t</tertiary> - </indexterm> - <para>&Default; <literal>""</literal></para> - <para>The delimiter to be inserted at the end of a page list. - This delimiter has no effect on entries which have no - associated page list. - </para> - </section> - - <section id="makeindex-output-encap-prefix"> - <title>encap_prefix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>encap_prefix</tertiary> - </indexterm> - <para>&Default; <literal>"\\"</literal></para> - <para>The prefix for the command which encapsulates - the page number. - </para> - </section> - - <section id="makeindex-output-encap-infox"> - <title>encap_infix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>encap_infix</tertiary> - </indexterm> - <para>&Default; <literal>"{"</literal></para> - <para>The prefix for the command which encapsulates - the page number. - </para> - </section> - - <section id="makeindex-output-encap-suffix"> - <title>encap_suffix <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>encap_suffix</tertiary> - </indexterm> - <para>&Default; <literal>"}"</literal></para> - <para>The suffix for the command which encapsulates - the page number. - </para> - </section> - - <section id="makeindex-output-line-max"> - <title>line_max <number></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>line_max</tertiary> - </indexterm> - <para>&Default; <literal>72</literal></para> - <para>The maximum length of a line in the output - beyond which a line wraps around. - </para> - </section> - - <section id="makeindex-output-indent-space"> - <title>indent_space <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>indent_space</tertiary> - </indexterm> - <para>&Default; <literal>"\t\t"</literal></para> - <para>The space to be inserted in front of a wrapped - line. Default is two tabs. - </para> - </section> - - <section id="makeindex-output-indent-length"> - <title>indent_length <number></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>indent_length</tertiary> - </indexterm> - <para>&Default; <literal>16</literal></para> - <para>The length of indent_space. In the default case - this is 16 (for 2 tabs). - </para> - </section> - - <section id="makeindex-output-suffix-2p"> - <title>suffix_2p <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>suffix_2p</tertiary> - </indexterm> - <para>&Default; <literal>""</literal></para> - <para>Delimiter to replace the range delimiter and - the second page number of a two page list. - When present, it overrides <literal>delim_r</literal>. - </para> - </section> - - <section id="makeindex-output-suffix-3p"> - <title>suffix_3p <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>suffix_3p</tertiary> - </indexterm> - <para>&Default; <literal>""</literal></para> - <para>Delimiter to replace the range delimiter and - the second page number of a three page list. - When present, it overrides <literal>delim_r</literal> - and <literal>suffix_mp</literal>. - </para> - </section> - - <section id="makeindex-output-suffix-mp"> - <title>suffix_mp <string></title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Output Style Specifiers</secondary> - <tertiary>suffix_mp</tertiary> - </indexterm> - <para>&Default; <literal>""</literal></para> - <para>Delimiter to replace the range delimiter and - the second page number of a multiple page list - (three or more pages). When present, it overrides - <literal>delim_r</literal>. - </para> - </section> - - </section> - - </section> - - <section id="makeindex-example"> - <title>Example</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Example</secondary> - </indexterm> - <para>The following example shows a style file called - <literal>book.isty</literal> which defines a stand-alone - index for a book. By stand-alone, we mean it can be formatted - independent of the main source. - </para> - <para><programlisting>preamble -"\\documentstyle[12pt]{book} -\\begin{document} -\\begin{theindex} -{\\small\n" - -postamble -"\n\n} -\\end{theindex} -\\end{document}\n"</programlisting> - </para> - <para>Suppose a particular book style requires the index - (as well as any chapters) to start from an odd page number. - Given <literal>foo.idx</literal> as the raw index file, the - following command line produces an index in file - <literal>foo-.ind</literal>. - </para> - <para><programlisting>makeindex -s book.isty -o foo-.ind -p odd foo -</programlisting> - </para> - <para>The reason to use a non-default output file name is - to avoid clobbering the source output (presumably - <literal>foo.dvi</literal>) because if the index is in file - <literal>foo.ind</literal>, its output will also be in - <literal>foo.dvi</literal> as a result of separate formatting - using . In the example the index is in - <literal>foo-.ind</literal>, its output will be in - <literal>foo-.dvi</literal> and thus introduces no confusion. - </para> - </section> - - <section id="makeindex-ordering"> - <title>Ordering</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Ordering</secondary> - </indexterm> - <para>By default <literal>makeindex</literal> assumes word - ordering. The <literal>-l</literal> option turns it into letter - ordering. The only difference is whether a blank is treated as - an effective letter or not. In word ordering, a blank precedes - any letter in the alphabet, whereas in letter ordering, it - doesn't count at all. This is best illustrated by the following - example: - </para> - - <para> - <informaltable frame="none"> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <thead> - <row rowsep="0"> - <entry><emphasis>word order</emphasis></entry> - <entry><emphasis>letter order</emphasis></entry> - </row> - </thead> - <tbody> - <row rowsep="0"> - <entry>sea lion</entry> - <entry>seal</entry> - </row> - <row rowsep="0"> - <entry>seal</entry> - <entry>seal lion</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para>Numbers are sorted in numeric order. For instance,</para> - <para> - <informaltable frame="none"> - <tgroup cols="1"> - <colspec colsep="0" align="left"/> - <tbody> - <row rowsep="0"> - <entry>9 (nine), 123</entry> - </row> - <row rowsep="0"> - <entry>123 10 (ten), see Derek, Bo</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para>Letters are first sorted with uppercase and lowercase - considered identical; then, within identical words the uppercase - letter precedes its lowercase counterpart. - </para> - <para>Patterns lead by a special symbol precede numbers, which - precede patterns lead by a letter. The symbol here refers to - anything not in the union of digits and English alphabet. This - includes those which follow 'z' in the ASCII chart. As a special - case, anything started with a digit but mixed with non-digits - is considered a symbol-leading pattern instead of a number. - </para> - </section> - - <section id="makeindex-special-effects"> - <title>Special Effects</title> - <indexterm> - <primary>Make-Index</primary> - <secondary>Special Effects</secondary> - </indexterm> - <para> In the normal case entries such as - <programlisting>\indexentry{alpha}{1} -\indexentry{alpha!beta}{3} -\indexentry{alpha!beta!gamma}{10}</programlisting> - in the raw index file will be converted to - <programlisting>\item alpha, 1 - \subitem beta, 3 - \subsubitem gamma, 10</programlisting> - in the output index file by &makeindex;. Notice that the level - symbol (<literal>!</literal>) is used to delimit levels of nesting. - </para> - <para>It is possible to make an item appear in a designated form - by using the actual (<literal>@</literal>) operator. - For instance, - <programlisting>\indexentry{alpha@{\it alpha\/}}{1} </programlisting> - will become - <programlisting>\item {\it alpha\/} 1</programlisting> - after the conversion. The idea is that the pattern preceding - <literal>@</literal> is used as sort key, whereas the one - following it is put in the actual result. However, the same key - with and without the actual part are regarded as distinct entries. - </para> - <para>It is also possible to encapsulate a page number with a - designated command using the encap (<literal>|</literal>) - operator. For example, in the default case, - <programlisting>\indexentry{alpha|bold}{1}</programlisting> - will be converted to - <programlisting>\item alpha \bold{1}</programlisting> - where <literal>\bold{n}</literal> will expand to - <literal>{\bf n}</literal>. This allows the encap operator to - be used to set pages in different fonts, thereby conveying more - information about whatever being indexed. For instance, given - the same key the page where its definition appears can be in - one font while where its primary example is given can be in - another, with other ordinary appearances in a third. Notice that - in this example, the three output attributes associated with - page encapsulation <literal>encap_prefix</literal>, - <literal>encap_infix</literal>, and - <literal>encap_suffix</literal> - correspond respectively to backslash, left brace, and right brace. - If this is to be formatted by languages other than , they would - be defined differently. - </para> - <para>By the same token, the <literal>encap</literal> operator - can be used to make cross references in the index. For instance, - <programlisting>\indexentry{alpha|see{beta}}{1}</programlisting> - will become - <programlisting>\item alpha \see{beta}{1}</programlisting> - in the output index file after the conversion, where - <programlisting>\see{beta}{1}</programlisting> - will expand to - <programlisting>{\it see\/} beta</programlisting> - </para> - <para>Notice that in a cross reference like this the page - number disappears. Therefore, where to insert such a command - in the source is immaterial. - </para> - <para>A pair of encap concatenated with - <literal>range_open</literal> (<literal>|(</literal>) and - with <literal>range_close</literal> (<literal>|)</literal>) - creates an explicit page range. That is, - <programlisting>\indexentry{alpha|(}{1} -\indexentry{alpha|)}{5}</programlisting> - will become - <programlisting>\item alpha, 1--5</programlisting> - </para> - <para>Intermediate pages indexed by the same key will be merged - into the range implicitly. This is especially useful when an - entire section about a particular subject is to be indexed, - in which case only the range opening and closing operators need - to be inserted at the beginning and end of the section, respectively. - </para> - <para>This explicit page range formation can also include an - extra command to set the page range in a designated font. Thus - <programlisting>\indexentry{alpha|(bold}{1} -\indexentry{alpha|)}{5}</programlisting> - will become - <programlisting>\item alpha, \bold{1--5}</programlisting> - </para> - <para>A couple of special cases are worth mentioning here. - First, entries like - <programlisting>\indexentry{alpha|(}{1} -\indexentry{alpha|bold}{3} -\indexentry{alpha|)}{5} </programlisting> - will be interpreted as - <programlisting>\item alpha, \bold{3}, 1--5</programlisting> - but with a warning message in the transcript about the - encounter of an inconsistent page encapsulator. Secondly, an - explicit range beginning in a Roman page number and ending in - Arabic is considered an error. In a case like this the range - is broken into two subranges, if possible, one in Roman, - the other in Arabic. For instance, - <programlisting>\indexentry{alpha|(}{i} -\indexentry{alpha}{iv} -\indexentry{alpha}{3} -\indexentry{alpha|)}{7}</programlisting> - will be turned into - <programlisting>\item alpha, 1--iv, 3--7</programlisting> - with a warning message in the transcript complaining about - the illegal range formation. - </para> - <para>Finally, every special symbol mentioned in this section - may be escaped by the quote operator (<literal>"</literal>). - Thus - <programlisting>\indexentry{alpha"@beta}{1} </programlisting> - will actually become - <programlisting>\item alpha@beta, 1</programlisting> - as a result of executing &makeindex;. However, if quote is - preceded by escape (<literal>\</literal>), its following - letter is not escaped. That is, - <programlisting>\indexentry{f\"ur}{1} </programlisting> - means - <programlisting>\item f\"ur, 1</programlisting> - which represents umlaut accented <literal>u</literal> to - the family of processors. - </para> - </section> - -</chapter> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-metafont.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-metafont.xml deleted file mode 100644 index be33a35809b..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-metafont.xml +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-metafont.xml 139 2004-08-26 16:58:10Z mw $ --> - -<chapter id="metafont" lang="en"> - <title id="metafont-title">&metafont; (&tbd;)</title> - <indexterm><primary>Metafont</primary></indexterm> - <para>&tbd;</para> -</chapter> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-metapost.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-metapost.xml deleted file mode 100644 index 0da3cea20b8..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-metapost.xml +++ /dev/null @@ -1,340 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-metapost.xml 139 2004-08-26 16:58:10Z mw $ --> - -<chapter id="metapost" lang="en"> - <title id="metapost-title">&metapost;</title> - <indexterm><primary>&metapost;</primary></indexterm> - - <note> - <para>The contents of this section was taken from - <filename>mpost(1)</filename>. - </para> - </note> - - <para>&metapost; is a programming language much like Knuth's &metafont; - except that it outputs PostScript programs instead of bitmaps. - Borrowed from &metafont; are the basic tools for creating and - manipulating pictures. These include numbers, coordinate pairs, - cubic splines, affine transformations, text strings, and boolean - quantities. Additional features facilitate integrating text and - graphics and accessing special features of PostScript such as clipping, - shading, and dashed lines. Another feature borrowed from &metafont; - is the ability to solve linear equations that are given implicitly, - thus allowing many programs to be written in a largely declarative - style. By building complex operations from simpler ones, &metapost; - achieves both power and exibility. - </para> - - <section id="metapost-options"> - <title id="metapost-options-title">Options</title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - </indexterm> - - <para>&metapost; understands the following command line options.</para> - - <section id="metapost-option-file-line-error-style"> - <title><filename role="nohyphenation">--file-line-error-style</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--file-line-error-style</tertiary> - </indexterm> - <para>Print error messages in the form - <literal>file:line:error</literal> - which is similar to the way many compilers format them. - </para> - </section> - - <section id="metapost-option-help"> - <title><filename role="nohyphenation">--help</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--help</tertiary> - </indexterm> - <para>Print help message and exit.</para> - </section> - - <section id="metapost-option-ini"> - <title><filename role="nohyphenation">--ini</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--ini</tertiary> - </indexterm> - <para>Be <command>inimpost</command>, for dumping bases; this - is implicitly true if the program is called as - <command>inimpost</command>.</para> - </section> - - <section id="metapost-option-intercation"> - <title><filename role="nohyphenation">--interaction mode</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--interaction mode</tertiary> - </indexterm> - <para>Sets the interaction mode. The mode can be one of - <literal>batchmode</literal>, <literal>nonstopmode</literal>, - <literal>scrollmode</literal>, and - <literal>errorstopmode</literal>. - The meaning of these modes is the same as that of the - corresponding commands.</para> - </section> - - <section id="metapost-option-jobname"> - <title><filename role="nohyphenation">--jobname name</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--jobname name</tertiary> - </indexterm> - <para>Use <literal>name</literal> for the job name, instead - of deriving it from the name of the input file.</para> - </section> - - <section id="metapost-option-kpathsea-debug"> - <title><filename role="nohyphenation">--kpathsea-debug bitmask</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--kpathsea-debug bitmask</tertiary> - </indexterm> - <para>Sets path searching debugging flags according to the - <literal>bitmask</literal>. See the Kpathsea manual for details.</para> - </section> - - <section id="metapost-option-mem"> - <title><filename role="nohyphenation">--mem mem</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--mem mem</tertiary> - </indexterm> - <para>Use <literal>mem</literal> as the name of the mem to be - used, instead of the name by which &metapost; was called or a - <literal>%&</literal> line.</para> - </section> - - <section id="metapost-option-parse-first-line"> - <title><filename role="nohyphenation">--parse-first-line</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--parse-first-line</tertiary> - </indexterm> - <para>If the first line of the main input file begins with - <literal>%&</literal> parse it to look for a dump name or a - <literal>--translate-file</literal> option.</para> - </section> - - <section id="metapost-option-progname"> - <title><filename role="nohyphenation">--progname name</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--progname name</tertiary> - </indexterm> - <para>Pretend to be program <literal>name</literal>. - This affects both the format used and the search paths.</para> - </section> - - <section id="metapost-option-recorder"> - <title><filename role="nohyphenation">--recorder</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--recorder</tertiary> - </indexterm> - <para>Enable the filename recorder. This leaves a trace of the files - opened for input and output in a file with extension - <literal>.fls.</literal></para> - </section> - - <section id="metapost-option-T"> - <title><filename role="nohyphenation">-T</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>-T</tertiary> - </indexterm> - <para>Produce TROFF output.</para> - </section> - - <section id="metapost-option-translate-file"> - <title><filename role="nohyphenation">--translate-file tcxname</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--translate-file tcxname</tertiary> - </indexterm> - <para>Use the <literal>tcxname</literal> translation table.</para> - </section> - - <section id="metapost-option-troff"> - <title><filename role="nohyphenation">--troff</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--troff</tertiary> - </indexterm> - <para>As -T.</para> - </section> - - <section id="metapost-option-version"> - <title><filename role="nohyphenation">--version</filename></title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Options</secondary> - <tertiary>--version</tertiary> - </indexterm> - <para>Print version information and exit.</para> - </section> - - </section> - - <section id="metapost-environment"> - <title>Environment</title> - <indexterm> - <primary>MetaPost</primary> - <secondary>Environment</secondary> - </indexterm> - - <para>See the Kpathsearch library documentation (the `Path specifications' - node) for the details of how the environment variables are use when - searching. The <command>kpsewhich</command> utility can be used to - query the values of the variables. - </para> - <para>If the environment variable <literal>TEXMFOUTPUT</literal> - is set, &metapost; attempts to put its output files in it, if - they cannot be put in the current directory. - </para> - <para>Here is a list of the environment variables which affect the - behavior of &metapost;: - <variablelist> - <varlistentry> - <term><literal>MPINPUTS</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>MPINPUTS</tertiary> - </indexterm> - <simpara>Search path for input files.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>MFINPUTS</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>MFINPUTS</tertiary> - </indexterm> - <simpara>Auxiliary search path for input files with - <literal>.mf</literal> extensions.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>MPSUPPORT</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>MPSUPPORT</tertiary> - </indexterm> - <simpara>Directory for various tables for handling - included &tex; and troff.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>MPXCOMMAND</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>MPXCOMMAND</tertiary> - </indexterm> - <simpara>The name of a shell script that converts - embedded typesetting commands to a form that - &metapost; understands. Defaults: - <literal>makempx</literal> for &tex; and - <literal>troffmpx</literal> for troff.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TEX</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>TEX</tertiary> - </indexterm> - <simpara>The version of &tex; - or &latex; - to use when - processing <command>btex</command> and - <command>verbatimtex</command> commands. - Default &tex;. This version of &metapost; allows you - to use a <literal>`%&format'</literal> line - instead.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TROFF</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>TROFF</tertiary> - </indexterm> - <simpara>The troff pipeline for <command>btex</command> - and <command>verbatimtex</command> commands. - Default <literal>eqn -d\$\$ | troff</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>MPEDIT</literal></term> - <listitem> - <indexterm> - <primary>&metapost;</primary> - <secondary>Environment</secondary> - <tertiary>MPEDIT</tertiary> - </indexterm> - <simpara>A command template for invoking an editor.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para>A <literal>.mem</literal> file is a binary file that permits - fast loading of macro packages. &metapost; reads the default - <literal>plain.mem</literal> unless another <literal>.mem</literal> - file is specified at the start of the first line with an - <literal>&</literal> just before it. There is also an - <literal>mfplain.mem</literal> that simulates plain - &metafont; so that &metapost; can read <literal>.mf</literal> - fonts. (Plain Metafont is described in - <emphasis>The Metafontbook</emphasis>). - </para> - <para>Experts can create <literal>.mem</literal> files by - invoking <command>inimpost</command> and giving - macro definitions followed by a dump command. - </para> - <para>The &metapost; language is similar to &metafont;, - but the manual <emphasis>A User's Manual for MetaPost</emphasis> - assumes no knowledge of &metafont;. - &metapost; does not have bitmap output commands or - &metafont;'s online display mechanism.</para> - </section> - -</chapter> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-pdftex.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-pdftex.xml deleted file mode 100644 index 75ea40cfcbd..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-pdftex.xml +++ /dev/null @@ -1,373 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-pdftex.xml 139 2004-08-26 16:58:10Z mw $ --> - -<chapter id="pdftex" lang="en"> - <title id="pdftex-title">&pdftex;</title> - <indexterm><primary>pdfTeX</primary></indexterm> - - <note> - <para>The contents of this section was taken from - <filename>pdftex(1)</filename>. - </para> - </note> - - <section id="pdftex-options"> - <title id="pdftex-options-title">Options</title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - </indexterm> - - <para>&pdftex; understands the following command line options.</para> - - <section id="pdftex-option-file-line-error-style"> - <title><filename role="nohyphenation">--file-line-error-style</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--file-line-error-style</tertiary> - </indexterm> - <para>Print error messages in the form - <literal>file:line:error</literal> - which is similar to the way many compilers format them. - </para> - </section> - - <section id="pdftex-option-fmt"> - <title><filename role="nohyphenation">--fmt format</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--fmt format</tertiary> - </indexterm> - <para>Use <literal>format</literal> as the name of the format - to be used, instead of the name by which &pdftex; was called - or a <literal>%&</literal> line. - </para> - </section> - - <section id="pdftex-option-help"> - <title><filename role="nohyphenation">--help</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--help</tertiary> - </indexterm> - <para>Print help message and exit.</para> - </section> - - <section id="pdftex-option-ini"> - <title><filename role="nohyphenation">--ini</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--ini</tertiary> - </indexterm> - <para>Be <command>pdfinitex</command>, for dumping formats; this - is implicitly true if the program is called as - <command>pdfinitex</command>. - </para> - </section> - - <section id="pdftex-option-interaction mode"> - <title><filename role="nohyphenation">--interaction mode</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--interaction mode</tertiary> - </indexterm> - <para>Sets the interaction mode. The mode can be one of - <literal>batchmode</literal>, <literal>nonstopmode</literal>, - <literal>scrollmode</literal>, and - <literal>errorstopmode</literal>. - The meaning of these modes is the same as that of the - corresponding <literal>\commands</literal>. - </para> - </section> - - <section id="pdftex-option-ipc"> - <title><filename role="nohyphenation">--ipc</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--ipc</tertiary> - </indexterm> - <para>Send DVI or PDF output to a socket as well as the usual output - file. Whether this option is available is the choice of the - installer. - </para> - </section> - - <section id="pdftex-option-ipc-start"> - <title><filename role="nohyphenation">--ipc-start</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--ipc-start</tertiary> - </indexterm> - <para>As <literal>--ipc</literal>, and starts the server at the - other end as well. Whether this option is available is the - choice of the installer. - </para> - </section> - - <section id="pdftex-option-jobname-name"> - <title><filename role="nohyphenation">--jobname name</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--jobname name</tertiary> - </indexterm> - <para>Use <literal>name</literal> for the job name, instead of - deriving it from the name of the input file. - </para> - </section> - - <section id="pdftex-option-kpathsea-debug"> - <title><filename role="nohyphenation">--kpathsea-debug bitmask</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--kpathsea-debug bitmask</tertiary> - </indexterm> - <para>Sets path searching debugging flags according to the - <literal>bitmask</literal>. See the Kpathsea manual for details. - </para> - </section> - - <section id="pdftex-option-maketex"> - <title><filename role="nohyphenation">--maketex fmt</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--maketex fmt</tertiary> - </indexterm> - <para>Enable <command>mktexfmt</command>, where - <literal>fmt</literal> - must be one of <literal>tex</literal> or <literal>tfm</literal>. - </para> - </section> - - <section id="pdftex-option-no-maketex"> - <title><filename role="nohyphenation">--no-maketex fmt</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--no-maketex fmt</tertiary> - </indexterm> - <para>Disable <command>mktexfmt</command>, where - <literal>fmt</literal> must be one of <literal>tex</literal> - or <literal>tfm</literal>. - </para> - </section> - - <section id="pdftex-option-output-comment"> - <title><filename role="nohyphenation">--output-comment string</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--output-comment string</tertiary> - </indexterm> - <para>Use <literal>string</literal> for the DVI file comment - instead of the date. - </para> - </section> - - <section id="pdftex-option-parse-first-line"> - <title><filename role="nohyphenation">--parse-first-line</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--parse-first-line</tertiary> - </indexterm> - <para>If the first line of the main input file begins with - <literal>%&</literal> parse it - to look for a dump name or a <literal>--translate-file</literal> option. - </para> - </section> - - <section id="pdftex-option-progname"> - <title><filename role="nohyphenation">--progname name</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--progname name</tertiary> - </indexterm> - <para>Pretend to be program <literal>name</literal>. This - affects both the format used and the search paths. - </para> - </section> - - <section id="pdftex-option-recorder"> - <title><filename role="nohyphenation">--recorder</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--recorder</tertiary> - </indexterm> - <para>Enable the filename recorder. This leaves a trace of the files - opened for input and output in a file with extension - <literal>.fls</literal>. - </para> - </section> - - <section id="pdftex-option-shell-escape"> - <title><filename role="nohyphenation">--shell-escape</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--shell-escape</tertiary> - </indexterm> - <para>Enable the <literal>\write18{command}</literal> construct. - The command can be any Bourne shell command. This construct - is normally disallowed for security reasons. - </para> - </section> - - <section id="pdftex-option-translate-file"> - <title><filename role="nohyphenation">--translate-file tcxname</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--translate-file tcxname</tertiary> - </indexterm> - <para>Use the <literal>tcxname</literal> translation table. - </para> - </section> - - <section id="pdftex-option-version"> - <title><filename role="nohyphenation">--version</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>--version</tertiary> - </indexterm> - <para>Print version information and exit.</para> - </section> - - </section> - - <section id="pdftex-environment"> - <title>Environment</title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Environment</secondary> - </indexterm> - <para>See the Kpathsearch library documentation (the `Path specifications' - node) for the details of how the environment variables are used when - searching. The <command>kpsewhich</command> utility can be used to - query the values of the variables. - </para> - <para>One caveat: In most &pdftex; formats, you cannot use ~ in a filename you - give directly to &pdftex;, because ~ is an active character, and hence is - expanded, not taken as part of the filename. Other programs, such as - &metafont;, do not have this problem. - </para> - - <para> - <variablelist> - <varlistentry> - <term><literal>TEXMFOUTPUT</literal></term> - <listitem> - <indexterm> - <primary>&pdftex;</primary> - <secondary>Environment</secondary> - <tertiary>TEXMFOUTPUT</tertiary> - </indexterm> - <simpara>Normally, &pdftex; puts its output files in - the current directory. - If any output file cannot be opened there, it tries to open it - in the directory specified in the environment variable - <literal>TEXMFOUTPUT</literal>. There is no default value - for that variable. For example, - if you say <command>pdftex paper</command> and the - current directory is not writable, if - <literal>TEXMFOUTPUT</literal> has the value - <literal>/tmp</literal>, &pdftex; attempts to - create <literal>/tmp/paper.log</literal> (and - <literal>/tmp/paper.pdf</literal>, if any output is - produced.)</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TEXINPUTS</literal></term> - <listitem> - <indexterm> - <primary>&pdftex;</primary> - <secondary>Environment</secondary> - <tertiary>TEXINPUTS</tertiary> - </indexterm> - <simpara>Search path for <literal>\input</literal> and - <literal>\openin</literal> files. This should probably - start with ``.'', so that user files are found before system - files. An empty path component will be replaced with the paths - defined in the <filename>texmf.cnf</filename> file. - For example, set <literal>TEXINPUTS</literal> to - <literal>".:/home/usr/tex:"</literal> to prepend the - current direcory and <literal>``/home/user/tex''</literal> - to the standard search path.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TEXFONTS</literal></term> - <listitem> - <indexterm> - <primary>&pdftex;</primary> - <secondary>Environment</secondary> - <tertiary>TEXFONTS</tertiary> - </indexterm> - <simpara>earch path for font metric - (<literal>.tfm</literal>) - files.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TEXFORMATS</literal></term> - <listitem> - <indexterm> - <primary>&pdftex;</primary> - <secondary>Environment</secondary> - <tertiary>TEXFORMATS</tertiary> - </indexterm> - <simpara>Search path for format files.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TEXPOOL</literal></term> - <listitem> - <indexterm> - <primary>&pdftex;</primary> - <secondary>Environment</secondary> - <tertiary>TEXPOOL</tertiary> - </indexterm> - <simpara>Search path for <command>pdfinitex</command> - internal strings.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>TEXEDIT</literal></term> - <listitem> - <indexterm> - <primary>&pdftex;</primary> - <secondary>Environment</secondary> - <tertiary>TEXEDIT</tertiary> - </indexterm> - <simpara>Command template for switching to editor. - The default, usually <command>vi</command>, is set when - &pdftex; is compiled.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - -</chapter> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml deleted file mode 100644 index 71d4c8cf3b5..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml +++ /dev/null @@ -1,13614 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-tex.xml 146 2005-05-14 15:34:22Z mw $ --> - -<chapter id="tex" lang="en"> - <title id="tex-title">&tex;</title> - - <section id="plaintex"> - <title id="plaintex-title">&plaintex;</title> - <indexterm><primary>PlainTeX</primary></indexterm> - - <section id="plaintex-ovw"> - - <title id="plaintex-ovw-title">&overview;</title> - <para>For a really excellent reference of all &tex; primitive - control sequences see David Bausum's<indexterm><primary>People</primary><secondary>Bausum, David</secondary></indexterm> - <ulink url="http://www.tug.org/utilities/plain/cseq.html"> - <emphasis>&tex; Primitive Control Sequences</emphasis></ulink>. - </para> - </section> - </section> - - - <section id="latex"><title>&latex;</title> - - <note> - <para>The original file <filename>latex2e.texi</filename> contains - the following copyright and permission notice: - </para> - <para> - <quote>Permission is granted to make and distribute - verbatim copies of this manual provided the copyright - notice and this permission notice are preserved on all - copies.</quote> - </para> - <para> - <quote>Permission is granted to copy and distribute modified - versions of this manual under the conditions for verbatim - copying, provided that the entire resulting derived work is - distributed under the terms of a permission notice identical - to this one.</quote> - </para> - </note> - - <section id="opt-latex"> - <title id="opt-latex-title">Options</title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - </indexterm> - - <para>&latex; understands the following command line options.</para> - - <section id="opt-latex-file-line-error-style"> - <title><filename role="nohyphenation">-file-line-error-style</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-file-line-error-style</tertiary> - </indexterm> - <para>Print error messages in the form - <literal>file:line:error</literal>. - </para> - </section> - - <section id="opt-latex-fmt"> - <title><filename role="nohyphenation">-fmt=FMTNAME</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-fmt=FMTNAME</tertiary> - </indexterm> - <para>Use <literal>FMTMAME</literal> instead of program name - or a %& line. - </para> - </section> - - <section id="opt-latex-ini"> - <title><filename role="nohyphenation">-ini</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-ini</tertiary> - </indexterm> - <para>Be <command>initex</command>, for dumping formats; this - is implicitly true if the program is called as - <command>initex</command>. - </para> - </section> - - <section id="opt-latex-interaction mode"> - <title><filename role="nohyphenation">-interaction=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-interaction=STRING</tertiary> - </indexterm> - <para>Set interaction mode - (<literal>STRING=batchmode/nonstopmode/scrollmode/errorstopmode</literal>). - </para> - </section> - - <section id="opt-latex-ipc"> - <title><filename role="nohyphenation">-ipc</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-ipc</tertiary> - </indexterm> - <para>Send DVI output to a socket as well as the usual output file. - </para> - <para>Note: not available on all systems.</para> - </section> - - <section id="opt-latex-ipc-start"> - <title><filename role="nohyphenation">-ipc-start</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-ipc-start</tertiary> - </indexterm> - <para>As <literal>-ipc</literal>, and also start the server at the - other end. - </para> - <para>Note: not available on all systems.</para> - </section> - - <section id="opt-latex-jobname-name"> - <title><filename role="nohyphenation">-jobname=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-jobname=STRING</tertiary> - </indexterm> - <para>Set the job name to <literal>STRING</literal>. - </para> - </section> - - <section id="opt-latex-kpathsea-debug"> - <title><filename role="nohyphenation">-kpathsea-debug=NUMBER</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-kpathsea-debug=NUMBER</tertiary> - </indexterm> - <para>Sets path searching debugging flags according to the - bits of <literal>NUMBER</literal>. - </para> - </section> - - <section id="opt-latex-no-maketex"> - <title><filename role="nohyphenation">[-no]-maketex=FMT</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>[-no]-maketex=FMT</tertiary> - </indexterm> - <para>Disable/enable <command>mktexFMT</command> generation - (FMT=tex/tfm). - </para> - </section> - - <section id="opt-latex-mltex"> - <title><filename role="nohyphenation">-mltex</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-mltex</tertiary> - </indexterm> - <para>Enable MLTeX extensions such as <literal>\charsubdef</literal>. - </para> - </section> - - <section id="opt-latex-output-comment"> - <title><filename role="nohyphenation">-output-comment=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-output-comment=STRING</tertiary> - </indexterm> - <para> use <literal>STRING</literal> for DVI file comment instead of date. - </para> - </section> - - <section id="opt-latex-parse-first-line"> - <title><filename role="nohyphenation">-parse-first-line</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-parse-first-line</tertiary> - </indexterm> - <para>Parse of the first line of the input file. - </para> - </section> - - <section id="opt-latex-progname"> - <title><filename role="nohyphenation">-progname=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-progname=STRING</tertiary> - </indexterm> - <para>Set program (and fmt) name to <literal>STRING</literal>. - </para> - </section> - - <section id="opt-latex-recorder"> - <title><filename role="nohyphenation">-recorder</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-recorder</tertiary> - </indexterm> - <para>Enable filename recorder. - </para> - </section> - - <section id="opt-latex-shell-escape"> - <title><filename role="nohyphenation">-shell-escape</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-shell-escape</tertiary> - </indexterm> - <para>Enable <literal>\write18{SHELL COMMAND}</literal>. - </para> - </section> - - <section id="opt-latex-src-specials"> - <title><filename role="nohyphenation">-src-specials</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-src-specials</tertiary> - </indexterm> - <para>Insert source specials into the DVI file. - </para> - </section> - - <section id="opt-latex-src-specials-where"> - <title><filename role="nohyphenation">-src-specials=WHERE</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-src-specials=WHERE</tertiary> - </indexterm> - <para>Insert source specials in certain places of - the DVI file. <literal>WHERE</literal> is a comma-separated - value list: <literal>cr display hbox math par parend vbox</literal>. - </para> - </section> - - <section id="opt-latex-translate-file-tcxname"> - <title><filename role="nohyphenation">-translate-file=TCXNAME</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-translate-file=TCXNAME</tertiary> - </indexterm> - <para>Use the <literal>TCX</literal> file <literal>TCXNAME</literal>. - </para> - </section> - - <section id="opt-latex-help"> - <title><filename role="nohyphenation">-help</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-help</tertiary> - </indexterm> - <para>Display this help and exit. - </para> - </section> - - <section id="opt-latex-version"> - <title><filename role="nohyphenation">-version</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-version</tertiary> - </indexterm> - <para>Output version information and exit. - </para> - </section> - - </section> - - - <section id="overview"> - <title id="overview-title">&overview; of &latex; and - Local Guide - </title> - <indexterm><primary>&overview; of LaTeX</primary></indexterm> - <indexterm><primary>LaTeX overview</primary></indexterm> - - <para>The &latex; command typesets a file of text using the &tex; - program and the &latex; Macro package for &tex;. To be more - specific, it processes an input file containing the text - of a document with interspersed commands that - describe how the text should be formatted. It produces at - least three files as output: - </para> - <orderedlist> - <listitem> - <para>A <emphasis>Device Independent</emphasis>, or - <filename>.dvi</filename> file. This contains - commands that can be translated into - commands for a variety of output devices. You - can view the output of &latex; by using a program such as - <literal>xdvi</literal>, - which actually uses the <filename>.dvi</filename> file. - </para> - </listitem> - <listitem> - <para>A <emphasis>transcript</emphasis> or - <filename>.log</filename> file - that contains summary information and - diagnostic messages for any errors discovered in the input file. - </para> - </listitem> - <listitem> - <para>An <emphasis>auxiliary</emphasis> or - <filename>.aux</filename> file. This is used by &latex; itself, for things such as sectioning. - </para> - </listitem> - </orderedlist> - - <para>For a description of what goes on inside &tex;, you should consult - <citetitle>The TeXbook</citetitle> by Donald E. Knuth, - ISBN 0-201-13448-9, published jointly by the American - Mathematical Society and Addison-Wesley Publishing Company. - </para> - <para>For a description of &latex;, you should consult: - </para> - <para><citetitle>&latex;: A Document Preparation System</citetitle>, - by Leslie Lamport,<indexterm><primary>People</primary><secondary>Lamport, Leslie</secondary></indexterm> Addison-Wesley Publishing Company, 2nd edition, 1994. - </para> - <para><citetitle>The &latex; Companion</citetitle>, - by Michel - Goossens,<indexterm><primary>People</primary><secondary>Goossens, Michel</secondary></indexterm> Frank Mittelbach, <indexterm><primary>People</primary><secondary>Mittelbach, Frank</secondary></indexterm> and Alexander Samarin,<indexterm><primary>People</primary><secondary>Samarin, Alexander</secondary></indexterm> Addison-Wesley, 1994. - </para> - - </section> - - - <section id="commands"> - <title id="commands-title">Commands</title> - - <para>A &latex; command begins with the command name, - which consists of a <literal>\</literal> followed by - either (a) a string of letters or (b) a single non-letter. - Arguments contained in square brackets, - <literal>[]</literal>, - are optional while arguments - contained in braces, <literal>{}</literal>, are required. - </para> - <para>NOTE: &latex; is case sensitive. Enter all commands - in lower case unless explicitly directed to do otherwise. - </para> - - - <section id="counters"> - <title id="counters-title">Counters</title> - <indexterm><primary>Counters, a list of</primary></indexterm> - <indexterm><primary>Variables, a list of</primary></indexterm> - - <para>Everything &latex; numbers for you has a counter associated - with it. The name of the counter is the same as the name of - the environment or command that produces the number, except - with no <literal>\</literal> (<literal>enumi</literal> - - <literal>enumiv</literal> are used for - the nested enumerate environment). Below is a list - of the counters used in &latex;'s standard document - classes to control numbering. - </para> - <programlisting> -part paragraph figure enumi -chapter subparagraph table enumii -section page footnote enumiii -subsection equation mpfootnote enumiv -subsubsection</programlisting> - - <bridgehead renderas="sect5" id="cmd-addtocounter"><literal>\addtocounter</literal></bridgehead> - <indexterm><primary>\addtocounter{counter}{value}</primary></indexterm> - - <para>The <literal>\addtocounter</literal> command increments - the <literal>counter</literal> by the - amount specified by the <literal>value</literal> argument. - The <literal>value</literal> argument can be negative. - </para> - - <bridgehead renderas="sect5" id="cmd-alph-title"><literal>\alph{counter}</literal></bridgehead> - <indexterm><primary>\alph</primary></indexterm> - <indexterm><primary>\Alph</primary></indexterm> - - <para>This command causes the value of the - <literal>counter</literal> to be printed in - alphabetic characters. The <literal>\alph</literal> command - uses lower case alphabetic alphabetic characters, i.e., - <literal>a, b, c...</literal> while the - <literal>\Alph</literal> command uses upper case alphabetic - characters, i.e., - <literal>A, B, C...</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-arabic-title"><literal>\arabic{counter}</literal></bridgehead> - <indexterm><primary>\arabic</primary></indexterm> - - <para>The <literal>\arabic</literal> command causes the - value of the <literal>counter</literal> to be - printed in Arabic numbers, i.e., <literal>3</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-fnsymbol-title"><literal>\fnsymbol{counter}</literal></bridgehead> - <indexterm><primary>\fnsymbol</primary></indexterm> - - <para>The <literal>\fnsymbol</literal> command causes the - value of the <literal>counter</literal> to - be printed in a specific sequence of nine symbols that - can be used for numbering footnotes. - </para> - - <para>NB. <literal>counter</literal> must have a value - between 1 and 9 inclusive. - </para> - - <bridgehead renderas="sect5" id="cmd-newcounter-title"><literal>\newcounter{foo}[counter]</literal></bridgehead> - <indexterm><primary>\newcounter</primary></indexterm> - <indexterm><primary>Counters, creating</primary></indexterm> - - <para>The <literal>\newcounter</literal> command defines a new - counter named <literal>foo</literal>. - The counter is initialized to zero. - </para> - <para>The optional argument <literal>[counter]</literal> - causes the counter <literal>foo</literal> to be reset - whenever the counter named in the optional argument is - incremented. - </para> - - <bridgehead renderas="sect5" id="cmd-refstepcounter-title"><literal>\refstepcounter{counter}</literal></bridgehead> - <indexterm><primary>\refstepcounter</primary></indexterm> - - <para>The <literal>\refstepcounter</literal> command works - like <literal>\stepcounter</literal>. - See <link linkend="cmd-stepcounter-title">\stepcounter</link>, - except it also defines the current <literal>\ref</literal> - value to be the result of <literal>\thecounter</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-roman-title"><literal>\roman{counter}</literal></bridgehead> - <indexterm><primary>\roman</primary></indexterm> - <indexterm><primary>\Roman</primary></indexterm> - - <para>This command causes the value of the - <literal>counter</literal> to be printed in - Roman numerals. The <literal>\roman</literal> command - uses lower case Roman - numerals, i.e., <literal>i, ii, iii...</literal>, while - the <literal>\Roman</literal> command - uses upper case Roman numerals, i.e., - <literal>I, II, III...</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-stepcounter-title"><literal>\stepcounter{counter}</literal></bridgehead> - <indexterm><primary>\stepcounter</primary></indexterm> - - <para>The <literal>\stepcounter</literal> command adds - one to the <literal>counter</literal> and - resets all subsidiary counters. - </para> - - <bridgehead renderas="sect5" id="cmd-setcounter-title"><literal>\setcounter{counter}{value}</literal></bridgehead> - <indexterm><primary>\setcounter</primary></indexterm> - <indexterm><primary>Counters, setting</primary></indexterm> - - <para>The <literal>\setcounter</literal> command sets the - value of the <literal>counter</literal> to - that specified by the <literal>value</literal> argument. - </para> - - <bridgehead renderas="sect5" id="cmd-usecounter-title"><literal>\usecounter{counter}</literal></bridgehead> - <indexterm><primary>\usecounter</primary></indexterm> - - <para>The <literal>\usecounter</literal> command is used in - the second argument of the - <literal>list</literal> environment to allow the counter - specified to be used to number the list items. - </para> - - <bridgehead renderas="sect5" id="cmd-value-title"><literal>\value{counter}</literal></bridgehead> - <indexterm><primary>\value</primary></indexterm> - <indexterm><primary>Counters, getting the value of</primary></indexterm> - - <para>The <literal>\value</literal> command produces the - value of the <literal>counter</literal> named - in the mandatory argument. It can be used where &latex; - expects an integer or number, such as the second - argument of a <literal>\setcounter</literal> - or <literal>\addtocounter</literal> command, or in: - </para> -<programlisting> -\hspace{\value{foo}\parindent}</programlisting> - - <para>It is useful for doing arithmetic with counters.</para> - - </section> - - <section id="cross-references"> - <title id="cross-references-title">Cross References</title> - <indexterm><primary>Cross referencing</primary></indexterm> - - <para>One reason for numbering things like figures and - equations is to refer the reader to them, as in - <emphasis>See Figure 3 for more details.</emphasis> - A smarter version of the cross reference commands - is available in the package - <link linkend="varioref"><literal>varioref</literal></link>. - </para> - - <bridgehead renderas="sect5" id="cmd-label-title"><literal>\label{key}</literal></bridgehead> - <indexterm><primary>\label</primary></indexterm> - - <para>A <literal>\label</literal> command appearing in - ordinary text assigns to the - <literal>key</literal> the number of the current sectional - unit; one appearing - inside a numbered environment assigns that number to the - <literal>key</literal>. - </para> - <para>A <literal>key</literal> can consist of any sequence - of letters, digits, or punctuation characters. - Upper and lowercase letters are different. - </para> - <para>To avoid accidentally creating two labels with the same - name, it is common to use labels consisting of a prefix and - a suffix separated by a colon. The prefixes - conventionally used are - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>cha</literal> for chapters</simpara> - </listitem> - <listitem> - <simpara><literal>sec</literal> - for lower-level sectioning commands - </simpara> - </listitem> - <listitem> - <simpara><literal>fig</literal> for figures - </simpara> - </listitem> - <listitem> - <simpara><literal>tab</literal> for tables - </simpara> - </listitem> - <listitem> - <simpara><literal>eq</literal> for equations - </simpara> - </listitem> - </itemizedlist> - - <para>Thus, a label for a figure would look like - <literal>fig:bandersnatch</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-pageref"><literal>\pageref{key}</literal></bridgehead> - <indexterm><primary>\pageref</primary></indexterm> - <indexterm><primary>Cross referencing using page number</primary></indexterm> - - <para>The <literal>\pageref</literal> command produces the - page number of the place in the - text where the corresponding <literal>\label</literal> - command appears. ie. where - <literal>\label{key}</literal> appears. - For a smart version see - <link linkend="cmd-vpageref"><literal>\vpageref</literal></link>. - </para> - - - <bridgehead renderas="sect5" id="cmd-ref-title"><literal>\ref{key}</literal></bridgehead> - <indexterm><primary>\ref</primary></indexterm> - <indexterm><primary>Cross referencing using section number</primary></indexterm> - - <para>The <literal>\ref</literal> command produces the - number of the sectional unit, - equation number, ... of the corresponding - <literal>\label</literal> command. For a smart - version see <link linkend="cmd-vref">\vref</link>. - </para> - - </section> - - <section id="definitions"> - <title id="definitions-title">Definitions</title> - - <!-- FIXME: workaround for following bridgehead--> - - <bridgehead renderas="sect5" id="cmd-newcommand-title"><literal>\newcommand</literal></bridgehead> - <indexterm><primary>\newcommand</primary></indexterm> - <indexterm><primary>Commands, defining new ones</primary></indexterm> - <indexterm><primary>Defining a new command</primary></indexterm> - -<programlisting> -\newcommand{cmd}[args]{definition} -\newcommand{cmd}[args][default]{definition} -\renewcommand{cmd}[args]{definition} -\renewcommand{cmd}[args][default]{definition}</programlisting> - - <para>These commands define (or redefine) a command.</para> - <table frame="none"> - <title>Options for <literal>\newcommand</literal></title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>cmd</entry> - <entry>A command name beginning with a - <literal>\</literal>. For - <literal>\newcommand</literal> it - must not be already defined and must not begin - with <literal>\end</literal>; for - <literal>\renewcommand</literal> it must already - be defined. - </entry> - </row> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>args</entry> - <entry>An integer from 1 to 9 denoting the number of - arguments of the command being defined. - The default is for the command to have no arguments. - </entry> - </row> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>def</entry> - <entry>If this optional parameter is present, it - means that the command's first argument is - optional. The default value of the optional - argument is <literal>def</literal>. - </entry> - </row> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>definition</entry> - <entry>The text to be substituted for every - occurrence of <literal>cmd</literal>; a - parameter of the form <literal>#n</literal> in - <literal>cmd</literal> is replaced by the text of - the nth argument when this substitution takes place. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <bridgehead renderas="sect5" id="cmd-newenvironment-title"><literal>\newenvironment</literal></bridgehead> - <indexterm><primary>\newenvironment</primary></indexterm> - <indexterm><primary>Environments, defining</primary></indexterm> - <indexterm><primary>Defining new environments</primary></indexterm> - -<programlisting> -\newenvironment{nam}[args]{begdef}{enddef} -\newenvironment{nam}[args][default]{begdef}{enddef} -\renewenvironment{nam}[args]{begdef}{enddef}</programlisting> - - <para>These commands define or redefine an environment.</para> - <table frame="none"> - <title>Options for <literal>\newenvironment</literal></title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry>nam</entry> - <entry>The name of the environment. For - <literal>\newenvironment</literal> there must be - no currently defined environment by that name, - and the command - <literal>\nam</literal> must be undefined. - For <literal>\renewenvironment</literal> the - environment must already be defined. - </entry> - </row> - <row rowsep="0"> - <entry>args</entry> - <entry>An integer from 1 to 9 denoting the number - of arguments of the newly-defined environment. - The default is no arguments. Arguments can only - be used in te <literal>{begdef}</literal> part. - </entry> - </row> - <row rowsep="0"> - <entry>default</entry> - <entry>If this is specified, the first argument is - optional, and <literal>default</literal> - gives the default value for that argument. - </entry> - </row> - <row rowsep="0"> - <entry>begdef</entry> - <entry>The text substituted for every occurrence of - <literal>\begin{nam}</literal>; a - parameter of the form <literal>#n</literal> in - <literal>cmd</literal> is replaced by the text of - the nth argument when this substitution takes place. - </entry> - </row> - <row rowsep="0"> - <entry>enddef</entry> - <entry>The text substituted for every occurrence - of <literal>\end{nam}</literal>. It may - not contain any argument parameters. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <bridgehead renderas="sect5" id="cmd-newtheorem-title"><literal>\newtheorem</literal></bridgehead> - <indexterm><primary>\newtheorem</primary></indexterm> - <indexterm><primary>Theorems, defining</primary></indexterm> - <indexterm><primary>Defining new theorems</primary></indexterm> - - <programlisting>\newtheorem{env_name}{caption}[within] -\newtheorem{env_name}[numbered_like]{caption}</programlisting> - - <para>This command defines a theorem-like environment.</para> - <table frame="none"> - <title>Options for <literal>\newtheorem</literal></title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry>env_name</entry> - <entry>The name of the environment to be defined. - A string of letters. It must - not be the name of an existing environment or counter. - </entry> - </row> - <row rowsep="0"> - <entry>caption</entry> - <entry>The text printed at the beginning of the - environment, right before the - number. This may simply say - <emphasis>Theorem</emphasis>, for example. - </entry> - </row> - <row rowsep="0"> - <entry>within</entry> - <entry>The name of an already defined counter, usually - of a sectional unit. Provides a means of - resetting the new theorem counter - <emphasis role="bold">within</emphasis> - the sectional unit. - </entry> - </row> - <row rowsep="0"> - <entry>numbered_like</entry> - <entry>The name of an already defined theorem-like environment. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>The <literal>\newtheorem</literal> command may have at - most one optional argument. - </para> - - <bridgehead renderas="sect5" id="cmd-newfont-title"><literal>\newfont</literal></bridgehead> - <indexterm><primary>\newfont</primary></indexterm> - <indexterm><primary>Fonts, new commands for</primary></indexterm> - <indexterm><primary>Defining new fonts</primary></indexterm> - - <para><literal>\newfont{cmd}{font_name}</literal> - </para> - <para>Defines the command name <literal>cmd</literal>, which - must not be currently - defined, to be a declaration that selects the font named - <literal>font_name</literal> to be the current font. - </para> - - </section> - - <section id="document-classes"> - <title id="document-classes-title">Document Classes</title> - <indexterm><primary>Document Classes</primary></indexterm> - <indexterm><primary>Classes of document</primary></indexterm> - <indexterm><primary>article class</primary></indexterm> - <indexterm><primary>report class</primary></indexterm> - <indexterm><primary>book class</primary></indexterm> - <indexterm><primary>letter class</primary></indexterm> - <indexterm><primary>\documentclass</primary></indexterm> - - <para>Valid &latex; document classes include: - </para> - <itemizedlist spacing="compact"> - <listitem><simpara>article</simpara> - </listitem> - <listitem><simpara>report</simpara> - </listitem> - <listitem><simpara>letter</simpara> - </listitem> - <listitem><simpara>book</simpara> - </listitem> - <listitem><simpara>slides</simpara> - </listitem> - </itemizedlist> - - <para>Other document classes are often available. - See <link linkend="overview">&overview;</link>, for details. - They are selected with the following command: - </para> - <para><literal>\documentclass [options] {class}</literal> - </para> - <para>All the standard classes (except slides) accept the - following options - for selecting the typeface size - (<literal>10pt</literal> is default): - </para> - <para><literal>10pt, 11pt, 12pt</literal></para> - <para>All classes accept these options for selecting the - paper size (default is letter): - </para> - <para>a4paper, a5paper, b5paper, letterpaper, legalpaper, - executivepaper - </para> - <para>Miscellaneous options: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>landscape --- selects landscape format. - Default is portrait. - </simpara> - </listitem> - <listitem> - <simpara>titlepage, notitlepage --- selects if there should - be a separate title page. - </simpara> - </listitem> - <listitem> - <simpara>leqno --- equation number on left side of equations. - Default is right side. - </simpara> - </listitem> - <listitem> - <simpara>fleqn --- displayed formulas flush left. - Default is centered. - </simpara> - </listitem> - <listitem> - <simpara>openbib --- use <emphasis>open</emphasis> - bibliography format. - </simpara> - </listitem> - <listitem> - <simpara>draft, final --- mark/do not mark overfull - boxes with a rule. Default is final. - </simpara> - </listitem> - </itemizedlist> - - <para>These options are not available with the slides class: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>oneside, twoside --- selects one- or twosided - layout. Default is - oneside, except for the book class. - </simpara> - </listitem> - <listitem> - <simpara>openright, openany --- determines if a chapter - should start on a - right-hand page. Default is openright for book. - </simpara> - </listitem> - <listitem> - <simpara>onecolumn, twocolumn --- one or two columns. - Defaults to one column. - </simpara> - </listitem> - </itemizedlist> - - <para>The slides class offers the option - <literal>clock</literal> for printing the time at - the bottom of each note. - </para> - <para>If you specify more than one option, they must be - separated by a comma. - </para> - <para>Additional packages are loaded by a - </para> - <para id="usepackage-linkend"> - <literal>\usepackage[options]{pkg}</literal> - <indexterm><primary>\usepackage</primary></indexterm> - </para> - <para>command. If you specify more than one package, they - must be separated by a comma. - <indexterm><primary>Packages, loading</primary></indexterm> - <indexterm><primary>Loading additional packages</primary></indexterm> - </para> - <para>Any options given in the <literal>\documentclass</literal> - command that are unknown - by the selected document class are passed on to the packages - loaded with <literal>\usepackage</literal>. - <indexterm><primary>Global options</primary></indexterm> - <indexterm><primary>Options, global</primary></indexterm> - </para> - - <indexterm><primary>Layout commands</primary></indexterm> - - </section> - - <section id="layout"> - <title id="layout-title">Layout</title> - - <para>Miscellaneous commands for controlling the general - layout of the page. - </para> - - <bridgehead renderas="sect5" id="cmd-flushbottom-title"><literal>\flushbottom</literal></bridgehead> - <indexterm><primary>\flushbottom</primary></indexterm> - - <para>The <literal>\flushbottom</literal> declaration makes - all text pages the same - height, adding extra vertical space when necessary to fill - out the page. - </para> - <para>This is the standard if twocolumn mode is selected. - </para> - - <bridgehead renderas="sect5" id="cmd-onecolumn-title"><literal>\onecolumn</literal></bridgehead> - <indexterm><primary>\onecolumn</primary></indexterm> - - <para>The <literal>\onecolumn</literal> declaration starts - a new page and produces single-column output. - </para> - - <bridgehead renderas="sect5" id="cmd-raggedbottom-title"><literal>\raggedbottom</literal></bridgehead> - <indexterm><primary>\raggedbottom</primary></indexterm> - - <para>The <literal>\raggedbottom</literal> declaration - makes all pages the height of the - text on that page. No extra vertical space is added. - </para> - - <bridgehead renderas="sect5" id="cmd-twocolumn-title"><literal>\twocolumn</literal></bridgehead> - <indexterm><primary>\twocolumn</primary></indexterm> - <indexterm><primary>Multicolumn text</primary></indexterm> - - <para><literal>\twocolumn[text]</literal> - </para> - <para>The <literal>\twocolumn</literal> declaration starts - a new page and produces - two-column output. If the optional <literal>text</literal> - argument is present, it - is typeset in one-column mode. - </para> - - </section> - - <!-- FIXME --> - - <section id="env-latex"> - <title id="env-latex-title">Environments</title> - <indexterm><primary>Environments</primary></indexterm> - <indexterm><primary>\begin</primary></indexterm> - <indexterm><primary>\end</primary></indexterm> - - <para>&latex; provides a number of different paragraph-making - environments. - Each environment begins and ends in the same manner. - </para> - <programlisting> -\begin{environment-name} - . - . - . -\end{environment-name}</programlisting> - - <bridgehead renderas="sect5" id="env-array">array</bridgehead> - <indexterm><primary>Arrays, math</primary></indexterm> - <indexterm><primary>array</primary></indexterm> - - <programlisting> -\begin{array}{col1col2...coln} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{array}</programlisting> - - <para>Math arrays are produced with the array environment. - It has a single - mandatory argument describing the number of columns and - the alignment within them. Each column, - <literal>coln</literal>, is specified by a single letter - that tells how items in that row should be formatted. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>c</literal> --- for centered - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> --- for flush left - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> --- for flush right - </simpara> - </listitem> - </itemizedlist> - - <para>Column entries must be separated by an - <literal>&</literal>. Column entries may - include other &latex; commands. Each row of the array - must be terminated - with the string <literal>\\</literal>. - </para> - <para>Note that the <literal>array</literal> environment - can only be used in math mode, so - normally it is used inside an <literal>equation</literal> - environment. - </para> - - <bridgehead renderas="sect5" id="env-center"><literal>center</literal></bridgehead> - <indexterm><primary>center</primary></indexterm> - <indexterm><primary>Centering text, environment for</primary></indexterm> - - <programlisting> -\begin{center} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{center}</programlisting> - - <para>The <literal>center</literal> environment allows you to - create a paragraph consisting of lines that are - centered within the left and right margins on - the current page. Each line must be terminated with the string - <literal>\\</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-centering"><literal>\centering</literal></bridgehead> - <indexterm><primary>\centering</primary></indexterm> - <indexterm><primary>Centering text</primary></indexterm> - <indexterm><primary>Formatting Text</primary></indexterm> - - <para>This declaration corresponds to the - <literal>center</literal> environment. This - declaration can be used inside an environment such as - <literal>quote</literal> or in - a <literal>parbox</literal>. The text of a figure or - table can be centered on the - page by putting a <literal>\centering</literal> command - at the beginning of the - figure or table environment. - </para> - <para>Unlike the <literal>center</literal> environment, - the <literal>\centering</literal> command does - not start a new paragraph; it simply changes how &latex; - formats paragraph - units. To affect a paragraph unit's format, the scope of the - declaration must contain the blank line or - <literal>\end</literal> command (of an - environment like quote) that ends the paragraph unit. - </para> - - - <bridgehead renderas="sect5" id="env-description"><literal>description</literal></bridgehead> - <indexterm><primary>description</primary></indexterm> - <indexterm><primary>Labelled lists, creating</primary></indexterm> - - <programlisting> -\begin{description} -\item [label] First item -\item [label] Second item - . - . - . -\end{description}</programlisting> - - <para>The <literal>description</literal> environment is - used to make labelled lists. The - <literal>label</literal> is bold face and flushed right. - </para> - - <bridgehead renderas="sect5" id="env-enumerate"><literal>enumerate</literal></bridgehead> - <indexterm><primary>enumerate</primary></indexterm> - <indexterm><primary>Lists of items, numbered</primary></indexterm> - - <programlisting> -\begin{enumerate} -\item First item -\item Second item - . - . - . -\end{enumerate}</programlisting> - - <para>The <literal>enumerate</literal> environment produces - a numbered list. Enumerations can be nested within - one another, up to four levels deep. They can also be - nested within other paragraph-making environments. - </para> - <para>Each item of an enumerated list begins with an - <literal>\item</literal> command. - There must be at least one <literal>\item</literal> - command within the environment. - </para> - <para>The <literal>enumerate</literal> environment uses the - <literal>enumi</literal> through - <literal>enumiv</literal> counters - (see <link linkend="counters">Counters</link>). - The type of numbering can be - changed by redefining <literal>\theenumi</literal> etc. - </para> - - <bridgehead renderas="sect5" id="env-eqnarray"><literal>eqnarray</literal></bridgehead> - <indexterm><primary>eqnarray</primary></indexterm> - <indexterm><primary>Equations, aligning</primary></indexterm> - <indexterm><primary>Aligning Equations</primary></indexterm> - - <programlisting> -\begin{eqnarray} -math formula 1 \\ -math formula 2 \\ - . - . - . -\end{eqnarray}</programlisting> - - <para>The <literal>eqnarray</literal> environment is used - to display a sequence of - equations or inequalities. It is very much like a three-column - <literal>array</literal> environment, with consecutive - rows separated by <literal>\\</literal> - and consecutive items within a row separated by an - <literal>&</literal>. - </para> - <para>An equation number is placed on every line unless that - line has a <literal>\nonumber</literal> command. - </para> - <indexterm><primary>\lefteqn</primary></indexterm> - - <para>The command <literal>\lefteqn</literal> is used for - splitting long formulas across - lines. It typesets its argument in display style flush - left in a box of zero width. - </para> - - <bridgehead renderas="sect5" id="env-equation"><literal>equation</literal></bridgehead> - <indexterm><primary>equation</primary></indexterm> - <indexterm><primary>Equations, environment for</primary></indexterm> - <indexterm><primary>Formulae, environment for</primary></indexterm> - - <programlisting> -\begin{equation} - math formula -\end{equation}</programlisting> - - <para>The <literal>equation</literal> environment centers - your equation on the page and places - the equation number in the right margin. - </para> - - <bridgehead renderas="sect5" id="env-figure"><literal>figure</literal></bridgehead> - <indexterm><primary>figure</primary></indexterm> - <indexterm><primary>Inserting figures</primary></indexterm> - - <programlisting> -\begin{figure}[placement] - - body of the figure - -\caption{figure title} -\end{figure}</programlisting> - - <indexterm><primary>\caption</primary></indexterm> - <para>Figures are objects that are not part of the - normal text, and are - usually <emphasis>floated</emphasis> to a convenient - place, like the top of a page. - Figures will not be split between two pages. - </para> - <para>The optional argument <literal>[placement]</literal> - determines where &latex; will try - to place your figure. There are four places where - &latex; can possibly put a float: - </para> - <orderedlist> - <listitem> - <para><literal>h</literal> (Here) - at the position - in the text where the figure - environment appears. - </para> - </listitem> - <listitem> - <para><literal>t</literal> (Top) - at the top of a text page. - </para> - </listitem> - <listitem> - <para><literal>b</literal> (Bottom) - at the bottom - of a text page. - </para> - </listitem> - <listitem> - <para><literal>p</literal> (Page of floats) - on a - separate float page, which is a page - containing no text, only floats. - </para> - </listitem> - </orderedlist> - - <para>The standard report and article classes use the - default placement <literal>tbp</literal>. - </para> - <para>The body of the figure is made up of whatever text, - &latex; commands, etc. - you wish. The <literal>\caption</literal> command - allows you to title your figure. - </para> - - <bridgehead renderas="sect5" id="env-flushleft"><literal>flushleft</literal></bridgehead> - <indexterm><primary>flushleft</primary></indexterm> - <indexterm><primary>Left-justifying text, environment for</primary></indexterm> - <indexterm><primary>Ragged right text, environment for</primary></indexterm> - - <programlisting> -\begin{flushleft} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushleft}</programlisting> - - <para>The <literal>flushleft</literal> environment allows - you to create a paragraph - consisting of lines that are flushed left, to the - left-hand margin. - Each line must be terminated with the string - <literal>\\</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-raggedright"><literal>\raggedright</literal></bridgehead> - <indexterm><primary>\raggedright</primary></indexterm> - <indexterm><primary>Ragged right text</primary></indexterm> - <indexterm><primary>Left-justifying text</primary></indexterm> - <indexterm><primary>Justification, ragged right</primary></indexterm> - - <para>This declaration corresponds to the - <literal>flushleft</literal> environment. This - declaration can be used inside an environment such - as <literal>quote</literal> or in - a <literal>parbox</literal>. - </para> - <para>Unlike the <literal>flushleft</literal> - environment, the <literal>\raggedright</literal> command - does not start a new paragraph; it simply changes - how &latex; formats - paragraph units. To affect a paragraph unit's format, - the scope of the - declaration must contain the blank line or - <literal>\end</literal> command (of an - environment like quote) that ends the paragraph unit. - </para> - - <bridgehead renderas="sect5" id="env-flushright"><literal>flushright</literal></bridgehead> - <indexterm><primary>flushright</primary></indexterm> - <indexterm><primary>Ragged left text, environment for</primary></indexterm> - <indexterm><primary>Right-justifying text, environment for</primary></indexterm> - - <programlisting> -\begin{flushright} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushright}</programlisting> - - <para>The <literal>flushright</literal> environment allows - you to create a paragraph - consisting of lines that are flushed right, to the - right-hand margin. Each line must be terminated with - the string <literal>\\</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-raggedleft"><literal>\raggedleft</literal></bridgehead> - <indexterm><primary>\raggedleft</primary></indexterm> - <indexterm><primary>Ragged left text</primary></indexterm> - <indexterm><primary>Justification, ragged left</primary></indexterm> - <indexterm><primary>Right-justifying text</primary></indexterm> - - <para>This declaration corresponds to the - <literal>flushright</literal> environment. This - declaration can be used inside an environment such as - <literal>quote</literal> or in - a <literal>parbox</literal>. - </para> - <para>Unlike the <literal>flushright</literal> - environment, the <literal>\raggedleft</literal> command - does not start a new paragraph; it simply changes - how &latex; formats - paragraph units. To affect a paragraph unit's format, - the scope of the - declaration must contain the blank line or - <literal>\end</literal> command (of an - environment like quote) that ends the paragraph unit. - </para> - - <bridgehead renderas="sect5" id="env-itemize"><literal>itemize</literal></bridgehead> - <indexterm><primary>itemize</primary></indexterm> - <indexterm><primary>\item</primary></indexterm> - <indexterm><primary>Lists of items</primary></indexterm> - - <programlisting> -\begin{itemize} -\item First item -\item Second item - . - . - . -\end{itemize}</programlisting> - - <para>The <literal>itemize</literal> environment produces - a <emphasis>bulleted</emphasis> list. Itemizations - can be nested within one another, up to four levels deep. - They can also - be nested within other paragraph-making environments. - </para> - <para>Each item of an <literal>itemized</literal> list - begins with an <literal>\item</literal> command. - There must be at least one <literal>\item</literal> - command within the environment. - </para> - <para>The <literal>itemize</literal> environment uses the - <literal>itemi</literal> through - <literal>itemiv</literal> counters (see - <link linkend="counters">Counters</link>). The type of - numbering can be - changed by redefining <literal>\theitemi</literal> etc. - </para> - - <bridgehead renderas="sect5" id="env-letter"><literal>letter</literal></bridgehead> - <indexterm><primary>letter</primary></indexterm> - - <para>This environment is used for creating letters. - See <link linkend="letters">Letters</link>. - </para> - - <bridgehead renderas="sect5" id="env-list"><literal>list</literal></bridgehead> - <indexterm><primary>list</primary></indexterm> - <indexterm><primary>Lists of items, generic</primary></indexterm> - - <para>The <literal>list</literal> environment is a generic - environment which is used for - defining many of the more specific environments. It is - seldom used in documents, but often in macros. - </para> - <programlisting> -\begin{list}{label}{spacing} -\item First item -\item Second item - . - . - . -\end{list}</programlisting> - - <para>The <literal>{label}</literal> argument specifies how - items should be labelled. - This argument is a piece of text that is inserted in a box - to form the label. This argument can and usually does - contain other &latex; commands. - </para> - <para>The <literal>{spacing}</literal> argument contains - commands to change the spacing - parameters for the list. This argument will most often - be null, i.e., - <literal>{}</literal>. This will select all default - spacing which should suffice - for most cases. - </para> - - <bridgehead renderas="sect5" id="env-minipage"><literal>minipage</literal></bridgehead> - <indexterm><primary>minipage</primary></indexterm> - <indexterm><primary>Footnotes in figures</primary></indexterm> - <indexterm><primary>Figures, footnotes in</primary></indexterm> - <indexterm><primary>Minipage, creating a</primary></indexterm> - - <programlisting> -\begin{minipage}[position][height][inner-pos]{width} - text -\end{minipage}</programlisting> - - <para>The <literal>minipage</literal> environment is similar - to a <literal>\parbox</literal> command. - It takes the same optional <literal>position</literal> - argument and mandatory - <literal>width</literal> argument. You may use other - paragraph-making environments - inside a minipage. - </para> - <para>Footnotes in a <literal>minipage</literal> environment - are handled in a way that is - particularly useful for putting footnotes in figures or - tables. - A <literal>\footnote</literal> or - <literal>\footnotetext</literal> command puts the footnote at - the bottom of the minipage instead of at the bottom of the - page, and it - uses the <literal>mpfootnote</literal> counter instead of - the ordinary - <literal>footnote</literal> counter See - <link linkend="counters">Counters</link>. - </para> - <para>NOTE: Don't put one minipage inside another if you are - using footnotes; - they may wind up at the bottom of the wrong minipage. - </para> - - <bridgehead renderas="sect5" id="env-picture"><literal>picture</literal></bridgehead> - <indexterm><primary>picture</primary></indexterm> - <indexterm><primary>Creating pictures</primary></indexterm> - <indexterm><primary>Pictures, creating</primary></indexterm> - - <programlisting> -\begin{picture}(width,height)(x offset,y offset) - . - . - picture commands - . - . -\end{picture}</programlisting> - - <para>The <literal>picture</literal> environment allows you - to create just about any kind - of picture you want containing text, lines, arrows and - circles. You tell &latex; where to put things in the picture - by specifying their coordinates. A coordinate is a number - that may have a decimal point and a minus sign --- a number - like <literal>5</literal>, <literal>2.3</literal> or - <literal>-3.1416</literal>. A coordinate specifies a length - in multiples of the unit length - <literal>\unitlength</literal>, so if - <literal>\unitlength</literal> has been set to - <literal>1cm</literal>, - then the coordinate 2.54 specifies a length of - 2.54 centimetres. You can change the value of - <literal>\unitlength</literal> anywhere you want, using the - <literal>\setlength</literal> command, but strange things - will happen if you try - changing it inside the picture environment. - </para> - <para>A position is a pair of coordinates, such as - <literal>(2.4,-5)</literal>, specifying - the point with x-coordinate <literal>2.4</literal> - and y-coordinate <literal>-5</literal>. - Coordinates are specified in the usual way with - respect to an origin, which is normally at the - lower-left corner of the picture. Note that - when a position appears as an argument, it is - not enclosed in braces; - the parentheses serve to delimit the argument. - </para> - <para>The <literal>picture</literal> environment has one - mandatory argument, which is a - <literal>position</literal>. It specifies the size of - the picture. The environment - produces a rectangular box with width and height determined - by this argument's x- and y-coordinates. - </para> - <para>The <literal>picture</literal> environment also has - an optional <literal>position</literal> - argument, following the <literal>size</literal> argument, - that can change the - origin. (Unlike ordinary optional arguments, this argument - is not contained in square brackets.) The optional - argument gives the coordinates of the point at the - lower-left corner of the picture (thereby determining - the origin). For example, if <literal>\unitlength</literal> - has been set to <literal>1mm</literal>, the command - <programlisting> -\begin{picture}(100,200)(10,20)</programlisting> - produces a picture of width 100 millimetres and height 200 - millimetres, whose lower-left corner is the point (10,20) - and whose upper-right corner is therefore the point - (110,220). When you first draw a picture, you will - omit the optional argument, leaving the origin - at the lower-left corner. If you then want to modify - your picture by shifting everything, you just add the - appropriate optional argument. - </para> - <para>The environment's mandatory argument determines the - nominal size of the picture. This need bear no relation - to how large the picture really is; - &latex; will happily allow you to put things outside the - picture, or even off the page. The picture's nominal - size is used by &latex; in determining - how much room to leave for it. - </para> - <para>Everything that appears in a picture is drawn by - the <literal>\put</literal> - command. The command - <programlisting> -\put (11.3,-.3){...}</programlisting> - puts the object specified by <literal>...</literal> - in the picture, with its - reference point at coordinates (11.3,-.3). - The reference points for - various objects will be described below. - </para> - <para>The <literal>\put</literal> command creates an - <emphasis role="bold">LR box</emphasis>. You can put anything - in the text argument of the <literal>\put</literal> - command that you'd put into the - argument of an <literal>\mbox</literal> and related - commands. When you do this, the - reference point will be the lower left corner of the box. - </para> - <para>Picture commands: - </para> - - <bridgehead renderas="sect5" id="cmd-circle"><literal>\circle{diameter}, \circle*{diameter}</literal></bridgehead> - <indexterm><primary>\circle</primary></indexterm> - - <para>The <literal>\circle</literal> command produces a - circle with a diameter as close to - the specified one as possible. If the - <literal>*</literal>-form of the command is - used, &latex; draws a solid circle. - </para> - <para>Note that only circles up to 40 pt can be drawn. - </para> - - <bridgehead renderas="sect5" id="cmd-dashbox"><literal>\dashbox</literal></bridgehead> - <indexterm><primary>\dashbox</primary></indexterm> - - <para>Draws a box with a dashed line. - </para> - <para><literal>\dashbox{dash_length}(width,height){...}</literal> - </para> - <para>The <literal>\dashbox</literal> has an extra - argument which specifies the width of - each dash. A dashed box looks best when the - <literal>width</literal> and - <literal>height</literal> are multiples of the - <literal>dash_length</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-frame"><literal>\frame{...}</literal></bridgehead> - <indexterm><primary>\frame</primary></indexterm> - - <para>The <literal>\frame</literal> command puts a - rectangular frame around the object - specified in the argument. The reference point - is the bottom left corner of the frame. No extra - space is put between the frame and the object. - </para> - - <bridgehead renderas="sect5" id="cmd-framebox-op-picture-cp"><literal>\framebox(width,height)[position]{...}</literal></bridgehead> - <indexterm><primary>\framebox</primary></indexterm> - - <para>The <literal>\framebox</literal> command is exactly - the same as the <literal>\makebox</literal> - command, except that it puts a frame around the - outside of the box that it creates. - </para> - <para>The <literal>framebox</literal> command produces - a rule of thickness - <literal>\fboxrule</literal>, and leaves a space - <literal>\fboxsep</literal> between the rule - and the contents of the box. - </para> - - <bridgehead renderas="sect5" id="cmd-line"><literal>\line(x slope,y slope){length}</literal></bridgehead> - <indexterm><primary>\line</primary></indexterm> - - <para>The <literal>\line</literal> command draws a - line of the specified <literal>length</literal> and - <literal>slope</literal>. - </para> - <para>Note that &latex; can only draw lines with - slope = x/y, where x and y - have integer values from -6 through 6. - </para> - - <bridgehead renderas="sect5" id="cmd-linethickness"><literal>\linethickness{dimension}</literal></bridgehead> - <indexterm><primary>\linethickness</primary></indexterm> - - <para>Declares the thickness of horizontal and vertical - lines in a picture - environment to be <literal>dimension</literal>, - which must be a positive length. It - does not affect the thickness of slanted lines - and circles, or the quarter circles drawn by - <literal>\oval</literal> to form the corners of an oval. - </para> - - <bridgehead renderas="sect5" id="cmd-makebox-op-picture-cp"><literal>\makebox(width,height)[position]{...}</literal></bridgehead> - <indexterm><primary>\makebox (picture)</primary></indexterm> - - <para>The <literal>\makebox</literal> command for the - picture environment is similar to - the normal <literal>\makebox</literal> command except - that you must specify a - <literal>width</literal> and <literal>height</literal> - in multiples of <literal>\unitlength</literal>. - </para> - <para>The optional argument, <literal>[position]</literal>, - specifies the quadrant that your text appears in. - You may select up to two of the following: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> - Moves the item to the - top of the rectangle - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> - Moves the item to the bottom - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> - Moves the item to the left - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> - Moves the item to the right - </simpara> - </listitem> - </itemizedlist> - - <para>See <link linkend="cmd-makebox">\makebox</link>. - </para> - - <bridgehead renderas="sect5" id="cmd-multiput"><literal>\multiput(x coord,y coord)(delta x,delta y){number of copies}{object}</literal></bridgehead> - <indexterm><primary>\multiput</primary></indexterm> - - <para>The <literal>\multiput</literal> command can be - used when you are putting the same - object in a regular pattern across a picture. - </para> - - <bridgehead renderas="sect5" id="cmd-oval"><literal>\oval(width,height)[portion]</literal></bridgehead> - <indexterm><primary>\oval</primary></indexterm> - - <para>The <literal>\oval</literal> command produces - a rectangle with rounded corners. The - optional argument, <literal>[portion]</literal>, - allows you to select part of the - oval. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> - Selects the top portion - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> - Selects the bottom portion - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> - Selects the right portion - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> - Selects the left portion - </simpara> - </listitem> - </itemizedlist> - - <para>Note that the <emphasis>corners</emphasis> of - the oval are made - with quarter circles with - a maximum radius of 20 pt, so large - <emphasis>ovals</emphasis> will - look more like boxes with rounded corners. - </para> - - <bridgehead renderas="sect5" id="cmd-put"><literal>\put(x coord,y coord){ ... }</literal></bridgehead> - <indexterm><primary>\put</primary></indexterm> - - <para>The <literal>\put</literal> command places the - item specified by the mandatory - argument at the given coordinates. - </para> - - <bridgehead renderas="sect5" id="cmd-shortstack"><literal>\shortstack[position]{... \\ ... \\ ...}</literal></bridgehead> - <indexterm><primary>\shortstack</primary></indexterm> - - <para>The <literal>\shortstack</literal> command produces - a stack of objects. The valid - positions are: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>r</literal> - Moves the objects to the - right of the stack - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> - Moves the objects to - the left of the stack - </simpara> - </listitem> - <listitem> - <simpara><literal>c</literal> - Moves the objects to - the centre of the stack (default) - </simpara> - </listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-vector"><literal>\vector(x slope,y slope){length}</literal></bridgehead> - <indexterm><primary>\vector</primary></indexterm> - - <para>The <literal>\vector</literal> command draws a - line with an arrow of the specified - length and slope. The <literal>x</literal> and - <literal>y</literal> values must lie between -4 - and +4, inclusive. - </para> - - <bridgehead renderas="sect5" id="env-quotation"><literal>quotation</literal></bridgehead> - <indexterm><primary>quotation</primary></indexterm> - <indexterm><primary>Quoted text with paragraph indentation, displaying</primary></indexterm> - <indexterm><primary>Displaying quoted text with paragraph indentation</primary></indexterm> - - <programlisting> -\begin{quotation} - text -\end{quotation}</programlisting> - - <para>The margins of the <literal>quotation</literal> - environment are indented on the left - and the right. The text is justified at both margins - and there is paragraph indentation. Leaving a blank - line between text produces a new paragraph. - </para> - - <bridgehead renderas="sect5" id="env-quote"><literal>quote</literal></bridgehead> - <indexterm><primary>quote</primary></indexterm> - <indexterm><primary>Quoted text, displaying</primary></indexterm> - <indexterm><primary>Displaying quoted text</primary></indexterm> - - <programlisting> -\begin{quote} - text -\end{quote}</programlisting> - - <para>The margins of the <literal>quote</literal> - environment are indented on the left and - the right. The text is justified at both margins. - Leaving a blank line between text produces a new paragraph. - </para> - - <bridgehead renderas="sect5" id="env-tabbing"><literal>tabbing</literal></bridgehead> - <indexterm><primary>tabbing</primary></indexterm> - <indexterm><primary>Tab stops, using</primary></indexterm> - <indexterm><primary>Lining text up in columns using tab stops</primary></indexterm> - - <programlisting>\begin{tabbing} -text \= more text \= still more text \= last text \\ -second row \> \> more \\ - . - . - . -\end{tabbing}</programlisting> - - <para>The <literal>tabbing</literal> environment provides - a way to align text in columns. - It works by setting tab stops and tabbing to them much - the way you do - with an ordinary typewriter. - </para> - <para>It is best suited for cases where the width of each - column is constant and known in advance. - </para> - <para>This environment can be broken across pages, - unlike the <literal>tabular</literal> - environment. - </para> - <para>The following commands can be used inside a - <literal>tabbing</literal> environment: - </para> - <table frame="none"> - <title>Commands in a <literal>tabbing</literal> environment</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>\= - <indexterm><primary>\=</primary></indexterm> - </entry> - <entry> - Sets a tab stop at the current position. - </entry> - </row> - <row rowsep="0"><entry>\> - <indexterm><primary>\></primary></indexterm> - </entry> - <entry> - Advances to the next tab stop. - </entry> - </row> - <row rowsep="0"><entry>\< - <indexterm><primary>\< </primary></indexterm> - </entry> - <entry> - This command allows you to put something to the - left of the - local margin without changing the margin. - Can only be used at the start of the line. - </entry> - </row> - <row rowsep="0"><entry>\+ - <indexterm><primary>\+</primary></indexterm> - </entry> - <entry> - Moves the left margin of the next and all the - following commands one tab stop to the right. - </entry> - </row> - <row rowsep="0"><entry>\- - <indexterm><primary>\- (tabbing) </primary></indexterm> - </entry> - <entry> - Moves the left margin of the next and all the - following commands one tab stop to the left. - </entry> - </row> - <row rowsep="0"><entry>\' - <indexterm><primary>\' (tabbing)</primary></indexterm> - </entry> - <entry> - Moves everything that you have typed so far in the - current column, i.e. everything from the most recent - <literal>\></literal>, - <literal>\<</literal>, <literal>\'</literal>, - <literal>\\</literal>, or <literal>\kill</literal> - command, to the right - of the previous column, flush against the current - column's tab stop. - </entry> - </row> - <row rowsep="0"><entry>\` - <indexterm><primary>\` (tabbing)</primary></indexterm> - </entry> - <entry> - Allows you to put text flush right against any - tab stop, including tab - stop 0. However, it can't move text to the right - of the last column - because there's no tab stop there. - The <literal>\`</literal> command moves all the - text that follows it, up to the - <literal>\\</literal> or <literal>\end{tabbing}</literal> - command that ends the line, to the right - margin of the tabbing environment. - There must be no <literal>\></literal> or - <literal>\'</literal> command between - the <literal>\`</literal> and the command that - ends the line. - </entry> - </row> - <row rowsep="0"><entry>\kill - <indexterm><primary>\kill</primary></indexterm> - </entry> - <entry> - Sets tab stops without producing - text. Works just like <literal>\\</literal> - except that it throws away the - current line instead of producing output for it. - The effect of any - <literal>\=</literal>, <literal>\+</literal> or - <literal>\-</literal> commands in that line remain in - effect. - </entry> - </row> - <row rowsep="0"><entry>\pushtabs - <indexterm><primary>\pushtabs</primary></indexterm> - </entry> - <entry> - Saves all current tab stop positions. Useful for - temporarily changing tab stop positions in the - middle of a - <literal>tabbing</literal> environment. - </entry> - </row> - <row rowsep="0"><entry>\poptabs - <indexterm><primary>\poptabs</primary></indexterm> - </entry> - <entry> - Restores the tab stop positions saved by the - last <literal>\pushtabs</literal>. - </entry> - </row> - <row rowsep="0"><entry>\a - <indexterm><primary>\a</primary></indexterm> - </entry> - <entry> - In a <literal>tabbing</literal> environment, - the commands <literal>\=</literal>, - <literal>\'</literal> and - <literal>\`</literal> do not produce accents as - normal. Instead, the commands - <literal>\a=</literal>, <literal>\a'</literal> - and <literal>\a`</literal> are used. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>This example typesets a Pascal function in a - traditional format: - </para> - <programlisting>\begin{tabbing} -function \= fact(n : integer) : integer;\\ - \> begin \= \+ \\ - \> if \= n $>$ 1 then \+ \\ - fact := n * fact(n-1) \- \\ - else \+ \\ - fact := 1; \-\- \\ - end;\\ -\end{tabbing}</programlisting> - - <bridgehead renderas="sect5" id="env-table"><literal>table</literal></bridgehead> - <indexterm><primary>table</primary></indexterm> - <indexterm><primary>Tables, creating</primary></indexterm> - <indexterm><primary>Creating tables</primary></indexterm> - - <programlisting> -\begin{table}[placement] - - body of the table - -\caption{table title} -\end{table}</programlisting> - - <para>Tables are objects that are not part of the - normal text, and are - usually <emphasis>floated</emphasis> to a - convenient place, - like the top of a page. - Tables will not be split between two pages. - </para> - <para>The optional argument <literal>[placement]</literal> - determines where &latex; will try - to place your table. There are four places where - &latex; can possibly put a float: - </para> - - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>h</literal> : Here - at the position - in the text where the table environment appears. - </simpara> - </listitem> - <listitem> - <simpara><literal>t</literal> : Top - at the top of a text page. - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> : Bottom - at the bottom of - a text page. - </simpara> - </listitem> - <listitem> - <simpara><literal>p</literal> : Page of floats - on - a separate float page, which is a page - containing no text, only floats. - </simpara> - </listitem> - </itemizedlist> - - <para>The standard <literal>report</literal> and - <literal>article</literal> classes use the default - placement <literal>[tbp]</literal>. - </para> - <para>The body of the table is made up of whatever - text, &latex; commands, etc., - you wish. The <literal>\caption</literal> command - allows you to title your table. - </para> - - <bridgehead renderas="sect5" id="env-tabular"><literal>tabular</literal></bridgehead> - <indexterm><primary>tabular</primary></indexterm> - <indexterm><primary>Lines in tables</primary></indexterm> - <indexterm><primary>Lining text up in tables</primary></indexterm> - - <programlisting> -\begin{tabular}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{tabular}</programlisting> - - <para> or - </para> - <programlisting> -\begin{tabular*}{width}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{tabular*}</programlisting> - - <para>These environments produce a box consisting of a - sequence of rows of - items, aligned vertically in columns. The mandatory and optional - arguments consist of: - </para> - <table frame="none"> - <title>Commands used inside a <literal>tabular</literal> environment</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>width - </entry> - <entry>Specifies the width of the - <literal>tabular*</literal> environment. There must be - rubber space between columns that can stretch - to fill out the specified width. - </entry> - </row> - <row rowsep="0"><entry>pos - </entry> - <entry>Specifies the vertical position; default - is alignment on the centre of the environment. - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> - align on top row - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> - align on bottom row - </simpara> - </listitem> - </itemizedlist> - </entry> - </row> - <row rowsep="0"><entry>cols - </entry> - <entry>Specifies the column formatting. - It consists of a sequence of the - following specifiers, corresponding to the - sequence of columns and intercolumn material. - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>l</literal> - A column of - left-aligned items. - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> - A column of - right-aligned items. - </simpara> - </listitem> - <listitem> - <simpara><literal>c</literal> - A column of - centred items. - </simpara> - </listitem> - <listitem> - <simpara><literal>|</literal> - A vertical line - the full height and depth of the environment. - </simpara> - </listitem> - <listitem> - <simpara><literal>@{text}</literal> - This inserts - <literal>text</literal> in every row. - An @-expression suppresses the intercolumn - space normally inserted between columns; any - desired space between the inserted text and - the adjacent items must be included in text. - An <literal>\extracolsep{wd}</literal> - command in an - @-expression causes an extra space of width - <literal>wd</literal> to appear to the - left of all subsequent columns, until - countermanded by another - <literal>\extracolsep</literal> command. - Unlike ordinary intercolumn space, this - extra space is not suppressed by an - @-expression. An - <literal>\extracolsep</literal> - command can be used only in an @-expression in the - <literal>cols</literal> argument. - </simpara> - </listitem> - <listitem> - <simpara><literal>p{wd}</literal> - Produces a - column with each item typeset in a parbox of - width <literal>wd</literal>, as if it were - the argument of a <literal>\parbox[t]{wd}</literal> - command. However, a <literal>\\</literal> - may not appear in the item, except in the - following situations: - </simpara> - <orderedlist> - <listitem> - <simpara>inside an environment like - <literal>minipage</literal>, - <literal>array</literal>, or - <literal>tabular</literal>. - </simpara> - </listitem> - <listitem> - <simpara>inside an explicit - <literal>\parbox</literal>. - </simpara> - </listitem> - <listitem> - <simpara>in the scope of a - <literal>\centering</literal>, - <literal>\raggedright</literal>, or - <literal>\raggedleft</literal> - declaration. The latter declarations - must appear inside braces or an - environment when used in a - <literal>p</literal>-column element. - </simpara> - </listitem> - </orderedlist> - </listitem> - <listitem> - <simpara><literal>*{num}{cols}</literal> - - Equivalent to <literal>num</literal> copies of - <literal>cols</literal>, where - <literal>num</literal> is any positive - integer and <literal>cols</literal> is - any list of column-specifiers, which may - contain another - <literal>*-expression</literal>. - </simpara> - </listitem> - </itemizedlist> - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>These commands can be used inside a - <literal>tabular</literal> environment: - </para> - - <bridgehead renderas="sect5" id="cmd-cline"><literal>\cline{i-j}</literal></bridgehead> - <indexterm><primary>\cline</primary></indexterm> - - <para>The <literal>\cline</literal> command draws horizontal - lines across the columns - specified, beginning in column <literal>i</literal> - and ending in column <literal>j</literal>, - which are identified in the mandatory argument. - </para> - - <bridgehead renderas="sect5" id="cmd-hline"><literal>\hline</literal></bridgehead> - <indexterm><primary>\hline</primary></indexterm> - - <para>The <literal>\hline</literal> command will draw - a horizontal line the width of the - table. It's most commonly used to draw a line at - the top, bottom, and - between the rows of the table. - </para> - - <bridgehead renderas="sect5" id="cmd-multicolumn"><literal>\multicolumn</literal></bridgehead> - <indexterm><primary>\multicolumn</primary></indexterm> - - <para><literal>\multicolumn{cols}{pos}{text}</literal> - </para> - - <para>The <literal>\multicolumn</literal> is used to - make an entry that spans several - columns. The first mandatory argument, - <literal>cols</literal>, specifies the - number of columns to span. The second mandatory - argument, <literal>pos</literal>, - specifies the formatting of the entry; - <literal>c</literal> for centred, <literal>l</literal> - for flushleft, <literal>r</literal> for flushright. - The third mandatory argument, - <literal>text</literal>, specifies what text is to make - up the entry. - </para> - - <bridgehead renderas="sect5" id="cmd-vline"><literal>\vline</literal></bridgehead> - <indexterm><primary>\vline</primary></indexterm> - - <para>The <literal>\vline</literal> command will draw - a vertical line extending the full - height and depth of its row. An <literal>\hfill</literal> - command can be used to - move the line to the edge of the column. - It can also be used in an @-expression. - </para> - - <bridgehead renderas="sect5" id="env-thebibliography"><literal>thebibliography</literal></bridgehead> - <indexterm><primary>thebibliography</primary></indexterm> - <indexterm><primary>Bibliography, creating (manually)</primary></indexterm> - - <programlisting> -\begin{thebibliography}{widest-label} -\bibitem[label]{cite_key} - . - . - . -\end{thebibliography}</programlisting> - - <para>The <literal>thebibliography</literal> environment - produces a bibliography or reference list. - In the <literal>article</literal> class, this reference - list is labelled <emphasis>References</emphasis>; - in the - <literal>report</literal> class, it is labelled - <emphasis>Bibliography</emphasis>. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>widest-label</literal>: Text that, - when printed, is approximately as wide - as the widest item label produces by the - <literal>\bibitem</literal> commands. - </simpara> - </listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-bibitem"><literal>\bibitem[label]{cite_key}</literal></bridgehead> - <indexterm><primary>\bibitem</primary></indexterm> - - <para>The <literal>\bibitem</literal> command generates - an entry labelled by <literal>label</literal>. - If the <literal>label</literal> argument is - missing, a number is generated as the - <literal>label</literal>, using the - <literal>enumi</literal> counter. - The <literal>cite_key</literal> is - any sequence of letters, numbers, and punctuation - symbols not containing a comma. - This command writes an entry on the - <filename>.aux</filename> file containing - <literal>cite_key</literal> and the item's - <literal>label</literal>. When this - <filename>.aux</filename> file is read by the - <literal>\begin{document}</literal> command, the - item's <literal>label</literal> is associated - with <literal>cite_key</literal>, causing the - reference to <literal>cite_key</literal> by a - <literal>\cite</literal> command to produce the - associated <literal>label</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-cite"><literal>\cite[text]{key_list}</literal></bridgehead> - <indexterm><primary>\cite</primary></indexterm> - - <para>The <literal>key_list</literal> argument - is a list of citation keys. This command - generates an in-text citation to the references - associated with the keys - in <literal>key_list</literal> by entries on - the <filename>.aux</filename> file read by the - <literal>\begin{document}</literal> command. - </para> - <para>The optional <literal>text</literal> argument - will appear after the citation, - i.e. <literal>\cite[p.~2f.]{knuth}</literal> might - produce `[Knuth, p. 2]'. - </para> - <para> - <indexterm> - <primary>cite.sty</primary> - </indexterm> - The package <literal>cite.sty</literal> - allows a line break in the <literal>\cite</literal> - reference and can sort numerical entries. - </para> - <para> - <indexterm> - <primary>overcite.sty</primary> - </indexterm> - <literal>overcite.sty</literal> makes - citations like footnotes. - </para> - - <bridgehead renderas="sect5" id="cmd-nocite"><literal>\nocite{key_list}</literal></bridgehead> - <indexterm><primary>\nocite</primary></indexterm> - - <para>The <literal>\nocite</literal> command produces - no text, but writes <literal>key_list</literal>, - which is a list of one or more citation keys, on - the <filename>.aux</filename> file. - <literal>\nocite{*}</literal> uses all entries from - the &bibtex; database. - </para> - - <bridgehead renderas="sect5" id="using-bibtex">Using BibTeX</bridgehead> - <indexterm><primary>Using BibTeX</primary></indexterm> - <indexterm> - <primary>BibTeX</primary> - <secondary>using</secondary> - </indexterm> - <indexterm><primary>Bibliography, creating (automatically)</primary></indexterm> - <indexterm><primary>\bibliographystyle</primary></indexterm> - <indexterm><primary>\bibliography</primary></indexterm> - - <para>If you use the BibTeX program by Oren Patashnik - (highly recommended if you need a bibliography of - more than a couple of titles) to maintain - your bibliography, you don't use the - <literal>thebibliography</literal> - environment. Instead, you include the lines - </para> - <programlisting> -\bibliographystyle{style} -\bibliography{bibfile}</programlisting> - - <para>where <literal>style</literal> refers to a - file <literal>style.bst</literal>, which defines how - your citations will look. - </para> - <table frame="none"> - <title>Standard styles distributed with BibTeX</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>alpha - </entry> - <entry>Sorted alphabetically. Labels are - formed from name of author and year of publication. - </entry> - </row> - <row rowsep="0"><entry>plain - </entry> - <entry>Sorted alphabetically. Labels are numeric. - </entry> - </row> - <row rowsep="0"><entry>unsrt - </entry> - <entry>Like <literal>plain</literal>, but entries - are in order of citation. - </entry> - </row> - <row rowsep="0"><entry>abbrv - </entry> - <entry>Like <literal>plain</literal>, but more - compact labels. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>In addition, numerous other BibTeX style - files exist tailored to the - demands of various publications. - </para> - <para>The argument to <literal>\bibliography</literal> - refers to the file - <literal>bibfile.bib</literal>, which should contain - your database in BibTeX - format. Only the entries referred to via - <literal>\cite</literal> and <literal>\nocite</literal> - will be listed in the bibliography. - </para> - - <bridgehead renderas="sect5" id="env-theorem"><literal>theorem</literal></bridgehead> - <indexterm><primary>theorem</primary></indexterm> - <indexterm><primary>Theorems, typesetting</primary></indexterm> - - <programlisting> -\begin{theorem} - theorem text -\end{theorem}</programlisting> - - <para>The <literal>theorem</literal> environment - produces <emphasis>Theorem x</emphasis> in - boldface followed by your theorem text. - </para> - - <bridgehead renderas="sect5" id="env-titlepage"><literal>titlepage</literal></bridgehead> - <indexterm><primary>titlepage</primary></indexterm> - <indexterm><primary>Making a title page</primary></indexterm> - <indexterm><primary>Title pages, creating</primary></indexterm> - - <programlisting> -\begin{titlepage} - text -\end{titlepage}</programlisting> - - <para>The <literal>titlepage</literal> environment creates - a title page, i.e. a page with no - printed page number or heading. It also causes the following - page to be numbered page one. Formatting the title page - is left to you. The - <literal>\today</literal> command comes in handy for title pages. - <indexterm><primary>\today</primary></indexterm> - </para> - <para>Note that you can use the - <literal>\maketitle</literal> (see - <link linkend="cmd-maketitle">\maketitle</link>) command to - produce a standard title page. - </para> - - <bridgehead renderas="sect5" id="env-verbatim"><literal>verbatim</literal></bridgehead> - <indexterm><primary>verbatim</primary></indexterm> - <indexterm><primary>Simulating typed text</primary></indexterm> - <indexterm><primary>Typed text, simulating</primary></indexterm> - <indexterm><primary>Programs, typesetting</primary></indexterm> - <indexterm><primary>Computer programs, typesetting</primary></indexterm> - - <programlisting> -\begin{verbatim} - text -\end{verbatim}</programlisting> - - <para>The <literal>verbatim</literal> environment is a - paragraph-making environment that - gets &latex; to print exactly what you type in. - It turns &latex; into a - typewriter with carriage returns and blanks having the - same effect that - they would on a typewriter. - </para> - - <bridgehead renderas="sect5" id="cmd-verb"><literal>\verb char literal_text char</literal> <literal>\verb*char literal_text char</literal></bridgehead> - <indexterm><primary>\verb</primary></indexterm> - <indexterm><primary>Verbatim text</primary></indexterm> - - <para>Typesets <literal>literal_text</literal> - exactly as typed, including special - characters and spaces, using a typewriter - (<literal>\tt</literal>) type style. - There may be no space between - <literal>\verb</literal> or <literal>\verb*</literal> and - <literal>char</literal> (space is shown here only - for clarity). The <literal>*-form</literal> - differs only in that spaces are printed - </para> - - <bridgehead renderas="sect5" id="env-verse"><literal>verse</literal></bridgehead> - <indexterm><primary>verse</primary></indexterm> - <indexterm><primary>Poetry, an environment for</primary></indexterm> - - <programlisting> -\begin{verse} - text -\end{verse}</programlisting> - - <para>The <literal>verse</literal> environment is designed - for poetry, though you may find - other uses for it. - </para> - <para>The margins are indented on the left and the right. - Separate the lines - of each stanza with <literal>\\</literal>, and use one or - more blank lines to - separate the stanzas. - </para> - - </section> - - <!-- FIXME --> - - <section id="footnotes"> - <title id="footnotes-title">Footnotes</title> - <indexterm><primary>Footnotes, creating</primary></indexterm> - - <para>Footnotes can be produced in one of two ways. They can be - produced with one command, the <literal>\footnote</literal> - command. They can also - be produced with two commands, the - <literal>\footnotemark</literal> and the - <literal>\footnotetext</literal> commands. - See the specific command for information - on why you would use one over the other. - </para> - - <bridgehead renderas="sect5" id="cmd-cmd-footnote"><literal>\footnote[number]{text}</literal></bridgehead> - <indexterm><primary>\footnote</primary></indexterm> - - <para>The <literal>\footnote</literal> command places - the numbered footnote <literal>text</literal> at - the bottom of the current page. The optional argument, - <literal>number</literal>, - is used to change the default footnote number. - This command can only be - used in outer paragraph mode; i.e., you cannot use - it in sectioning - commands like <literal>\chapter</literal>, in figures, - tables or in a <literal>tabular</literal> environment. - </para> - - <bridgehead renderas="sect5" id="cmd-footnotemark"><literal>\footnotemark</literal></bridgehead> - <indexterm><primary>\footnotemark</primary></indexterm> - - <para>The <literal>\footnotemark</literal> command puts - the footnote <literal>number</literal> in the - text. This command can be used in inner paragraph mode. - The text of the footnote is supplied by the - <literal>\footnotetext</literal> command. - </para> - <para>This command can be used to produce several - consecutive footnote markers - referring to the same footnote by using - </para> - <para><literal>\footnotemark[\value{footnote}]</literal> - </para> - <para>after the first <literal>\footnote</literal> command. - </para> - - <bridgehead renderas="sect5" id="cmd-footnotetext"><literal>\footnotetext[number]{text}</literal></bridgehead> - <indexterm><primary>\footnotetext</primary></indexterm> - - <para>The <literal>\footnotetext</literal> command - produces the <literal>text</literal> to be placed - at the bottom of the page. This command can come - anywhere after the - <literal>\footnotemark</literal> command. - The <literal>\footnotetext</literal> command must - appear in outer paragraph mode. - </para> - <para>The optional argument, <literal>number</literal>, - is used to change the default - footnote number. - </para> - - </section> - - - <section id="lengths"> - <title id="lengths-title">Lengths</title> - <indexterm><primary>Lengths, defining and using</primary></indexterm> - - <para>A <literal>length</literal> is a measure of distance. Many - &latex; commands take a length as an argument. - </para> - - - <bridgehead renderas="sect5" id="cmd-newlength"><literal>\newlength</literal></bridgehead> - <indexterm><primary>\newlength</primary></indexterm> - <indexterm><primary>Lengths, defining a new</primary></indexterm> - - <para><literal>\newlength{\gnat}</literal> - </para> - <para>The <literal>\newlength</literal> command defines the - mandatory argument, <literal>\gnat</literal>, as a - <literal>length</literal> command with a value of - <literal>0in</literal>. An error occurs if a - <literal>\gnat</literal> command already exists. - </para> - - <bridgehead renderas="sect5" id="cmd-setlength"><literal>\setlength</literal></bridgehead> - <indexterm><primary>\setlength</primary></indexterm> - <indexterm><primary>Lengths, setting value of</primary></indexterm> - - <para><literal>\setlength{\gnat}{length}</literal></para> - <para>The <literal>\setlength</literal> command is used to set - the value of a <literal>length</literal> command. The - <literal>length</literal> argument can be expressed in any - terms of length &latex; understands, i.e., inches - (<literal>in</literal>), millimetres - (<literal>mm</literal>), points (<literal>pt</literal>), - etc. - </para> - - <bridgehead renderas="sect5" id="cmd-addtolength"><literal>\addtolength</literal></bridgehead> - <indexterm><primary>\addtolength</primary></indexterm> - <indexterm><primary>Lengths, adding to</primary></indexterm> - - <para><literal>\addtolength{\gnat}{length}</literal></para> - <para>The <literal>\addtolength</literal> command increments - <emphasis>length command</emphasis> by the amount - specified in the - <literal>length</literal> argument. - It can be a negative amount. - </para> - - <bridgehead renderas="sect5" id="cmd-settodepth"><literal>\settodepth</literal></bridgehead> - <indexterm><primary>\settodepth</primary></indexterm> - - <para><literal>\settodepth{\gnat}{text}</literal></para> - <para>The <literal>\settodepth</literal> command sets the - value of a <literal>length</literal> command equal to the - depth of the <literal>text</literal> argument. - </para> - - <bridgehead renderas="sect5" id="cmd-settoheight"><literal>\settoheight</literal></bridgehead> - <indexterm><primary>\settoheight</primary></indexterm> - - <para><literal>\settoheight{\gnat}{text}</literal></para> - <para>The <literal>\settoheight</literal> command sets the - value of a <literal>length</literal> command equal to the - height of the <literal>text</literal> argument. - </para> - - <bridgehead renderas="sect5" id="cmd-settowidth"><literal>\settowidth</literal></bridgehead> - <indexterm><primary>\settowidth</primary></indexterm> - - <para><literal>\settowidth{\gnat}{text}</literal></para> - <para>The <literal>\settowidth</literal> command sets the - value of a <literal>length</literal> command equal to the - width of the <literal>text</literal> argument. - </para> - - <bridgehead renderas="sect5" id="predefined-lengths-title"><literal>Predefined lengths</literal></bridgehead> - <indexterm><primary>Lengths, predefined</primary></indexterm> - <indexterm><primary>Predefined lengths</primary></indexterm> - - <para id="cmd-length-pre-width"><literal>\width</literal> - <indexterm><primary>\width</primary></indexterm> - </para> - <para id="cmd-length-pre-height"><literal>\height</literal> - <indexterm><primary>\height</primary></indexterm> - </para> - <para id="cmd-length-pre-depth"><literal>\depth</literal> - <indexterm><primary>\depth</primary></indexterm> - </para> - <para id="cmd-length-pre-totalheight"><literal>\totalheight</literal> - <indexterm><primary>\totalheight</primary></indexterm> - </para> - <para>These length parameters can be used in the arguments of - the box-making commands See - <link linkend="spaces-and-boxes">Spaces & - Boxes</link>. - They - specify the natural width etc. of the text in the box. - <literal>\totalheight</literal> equals - <literal>\height</literal> + <literal>\depth</literal>. To - make a box with the text stretched to double the natural - size, e.g., say - </para> - <para><literal>\makebox[2\width]{Get a stretcher}</literal> - </para> - - </section> - - <section id="letters"> - <title id="letters-title">Letters</title> - <indexterm><primary>Letters</primary></indexterm> - <indexterm><primary>Creating letters</primary></indexterm> - - <para>You can use &latex; to typeset letters, both personal and - business. The <literal>letter</literal> document class is - designed to make a number of letters at once, although you can - make just one if you so desire. - </para> - <para>Your <filename>.tex</filename> source file has the same - minimum commands as the other document classes, i.e., you must - have the following commands as a minimum: - </para> - <programlisting> -\documentclass{letter} -\begin{document} - ... letters ... -\end{document}</programlisting> - - <para>Each letter is a <literal>letter</literal> environment, - whose argument is the name and address of the recipient. For - example, you might have: - </para> - <programlisting> -\begin{letter}{Mr. Joe Smith\\ 2345 Princess St.\\ Edinburgh, EH1 1AA} - ... -\end{letter}</programlisting> - - <para>The letter itself begins with the - <literal>\opening</literal> command. The text of the letter - follows. It is typed as ordinary &latex; input. Commands that - make no sense in a letter, like <literal>\chapter</literal>, - do not work. The letter closes with a - <literal>\closing</literal> command. - </para> - <para>After the <literal>closing</literal>, you can have - additional material. The <literal>\cc</literal> command - produces the usual <emphasis>cc: ...</emphasis>. - There's also a similar - <literal>\encl</literal> command for a list of enclosures. - With both these commands, use <literal>\\</literal> to - separate the items. - </para> - <para>These commands are used with the - <literal>letter</literal> class: - </para> - - <bridgehead renderas="sect5" id="cmd-address">\address</bridgehead> - <indexterm><primary>\address</primary></indexterm> - - <para><literal>\address{Return address}</literal> - </para> - <para>The return address, as it should appear on the letter - and the envelope. Separate lines of the address should be - separated by <literal>\\</literal> commands. If you do not - make an <literal>\address</literal> declaration, then the - letter will be formatted for copying onto your - organisation's standard letterhead. (See - <link linkend="overview">&overview;</link>, for details on your - local implementation). If you give an - <literal>\address</literal> declaration, then the letter - will be formatted as a personal letter. - </para> - - <bridgehead renderas="sect5" id="cmd-cc">\cc</bridgehead> - <indexterm><primary>\cc</primary></indexterm> - <indexterm><primary>Cc list</primary></indexterm> - - <para><literal>\cc{Kate Schechter\\Rob McKenna}</literal> - </para> - <para>Generate a list of other persons the letter was sent to. - Each name is printed on a separate line. - </para> - - <bridgehead renderas="sect5" id="cmd-closing">\closing</bridgehead> - <indexterm><primary>\closing</primary></indexterm> - <indexterm><primary>Letters, ending</primary></indexterm> - - <para><literal>\closing{text}</literal> - </para> - <para>The letter closes with a <literal>\closing</literal> - command, i.e., - <programlisting>\closing{Best Regards,}</programlisting> - </para> - - <bridgehead renderas="sect5" id="cmd-encl">\encl</bridgehead> - <indexterm><primary>\encl</primary></indexterm> - <indexterm><primary>Enclosed material</primary></indexterm> - - <para><literal>\encl{CV\\Certificates}</literal> - </para> - <para>Generate a list of enclosed material. - </para> - - <bridgehead renderas="sect5" id="cmd-location">\location</bridgehead> - <indexterm><primary>\location</primary></indexterm> - - <para><literal>\location{address}</literal> - </para> - <para>This modifies your organisation's standard address. - This only appears if the <literal>firstpage</literal> - pagestyle is selected. - </para> - - <bridgehead renderas="sect5" id="cmd-makelabels">\makelabels</bridgehead> - <indexterm><primary>\makelabels</primary></indexterm> - - <para><literal>\makelabels{number}</literal> - </para> - <para>If you issue this command in the preamble, &latex; will - create a sheet of address labels. This sheet will be output - before the letters. - </para> - - <bridgehead renderas="sect5" id="cmd-name">\name</bridgehead> - <indexterm><primary>\name</primary></indexterm> - - <para><literal>\name{June Davenport}</literal> - </para> - <para>Your name, used for printing on the envelope together - with the return address. - </para> - - <bridgehead renderas="sect5" id="cmd-opening">\opening</bridgehead> - <indexterm><primary>\opening</primary></indexterm> - <indexterm><primary>Letters, starting</primary></indexterm> - - <para><literal>\opening{text}</literal> - </para> - <para>The letter begins with the <literal>\opening</literal> - command. The mandatory argument, <literal>text</literal>, - is whatever text you wish to start your letter, i.e., - <programlisting>\opening{Dear Joe,} </programlisting> - </para> - - <bridgehead renderas="sect5" id="cmd-ps">\ps</bridgehead> - <indexterm><primary>\ps</primary></indexterm> - - <para><literal>\ps</literal> - </para> - <para>Use this command before a postscript. - </para> - - <bridgehead renderas="sect5" id="cmd-signature">\signature</bridgehead> - <indexterm><primary>\signature</primary></indexterm> - - <para><literal>\signature{Harvey Swick}</literal> - </para> - <para>Your name, as it should appear at the end of the letter - underneath the space for your signature. Items that should - go on separate lines should be separated by - <literal>\\</literal> commands. - </para> - - <bridgehead renderas="sect5" id="cmd-startbreaks">\startbreaks</bridgehead> - <indexterm><primary>\startbreaks</primary></indexterm> - - <para><literal>\startbreaks</literal> - </para> - <para>Used after a <literal>\stopbreaks</literal> command to - allow page breaks again. - </para> - - <bridgehead renderas="sect5" id="cmd-stopbreaks">\stopbreaks</bridgehead> - <indexterm><primary>\stopbreaks</primary></indexterm> - - <para><literal>\stopbreaks</literal> - </para> - <para>Inhibit page breaks until a - <literal>\startbreaks</literal> command occurs. - </para> - - <bridgehead renderas="sect5" id="cmd-telephone">\telephone</bridgehead> - <indexterm><primary>\telephone</primary></indexterm> - - <para><literal>\telephone{number}</literal> - </para> - <para>This is your telephone number. This only appears if the - <literal>firstpage</literal> pagestyle is selected. - </para> - - </section> - - <section id="line-and-page-breaking"> - <title id="line-and-page-breaking-title">Line & Page Breaking</title> - <indexterm><primary>Page Breaking</primary></indexterm> - <indexterm><primary>Line Breaking</primary></indexterm> - <indexterm><primary>Page Formatting</primary></indexterm> - - <para>The first thing &latex; does when processing ordinary text - is to translate your input file into a string of glyphs and - spaces. To produce a printed document, this string must be - broken into lines, and these lines must be broken into pages. - In some environments, you do the line breaking yourself with - the <literal>\\</literal> command, but &latex; usually does it - for you. - </para> - - <bridgehead renderas="sect5" id="cmd-bslash">\\</bridgehead> - <indexterm><primary>\\</primary></indexterm> - <indexterm><primary>New line, starting</primary></indexterm> - - <para><literal>\\[extra-space], \\*[extra-space]</literal> - </para> - <para>The <literal>\\</literal> command tells &latex; to start a - new line. It has an optional argument, - <literal>extra-space</literal>, that specifies how much - extra vertical space is to be inserted before the next line. - This can be a negative amount. - </para> - <para>The <literal>\\*</literal> command is the same as the - ordinary <literal>\\</literal> command except that it tells - &latex; not to start a new page after the line. - </para> - - <bridgehead renderas="sect5" id="cmd-dash-op-hyphenation-cp">\-</bridgehead> - <indexterm><primary>\- (hyphenation)</primary></indexterm> - <indexterm><primary>Hyphenation, forcing</primary></indexterm> - - <para>The <literal>\-</literal> command tells &latex; that it - may hyphenate the word at that point. &latex; is very good at - hyphenating, and it will usually find all correct - hyphenation points. The <literal>\-</literal> command is - used for the exceptional cases. - </para> - <para>Note that when you insert <literal>\-</literal> commands - in a word, the word will only be hyphenated at those points - and not at any of the hyphenation points that &latex; might - otherwise have chosen. - </para> - - <bridgehead renderas="sect5" id="cmd-cleardoublepage">\cleardoublepage</bridgehead> - <indexterm><primary>\cleardoublepage</primary></indexterm> - <indexterm><primary>Starting on a right-hand page</primary></indexterm> - - <para>The <literal>\cleardoublepage</literal> command ends the - current page and causes all figures and tables that have so - far appeared in the input to be printed. In a two-sided - printing style, it also makes the next page a right-hand - (odd-numbered) page, producing a blank page if necessary. - </para> - - <bridgehead renderas="sect5" id="cmd-clearpage">\clearpage</bridgehead> - <indexterm><primary>\clearpage</primary></indexterm> - <indexterm><primary>Flushing a page</primary></indexterm> - - <para>The <literal>\clearpage</literal> command ends the - current page and causes all figures and tables that have so - far appeared in the input to be printed. - </para> - - <bridgehead renderas="sect5" id="cmd-enlargethispage">\enlargethispage</bridgehead> - <indexterm><primary>\enlargethispage</primary></indexterm> - <indexterm><primary>Enlarge current page</primary></indexterm> - - <para><literal>\enlargethispage{size}</literal> - </para> - <para><literal>\enlargethispage*{size}</literal> - </para> - <para>Enlarge the <literal>\textheight</literal> for the - current page by the specified amount; e.g. - <literal>\enlargethispage{\baselineskip}</literal> will - allow one additional line. - </para> - <para>The starred form tries to squeeze the material together - on the page as much as possible. This is normally used - together with an explicit <literal>\pagebreak</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-samepage">\samepage</bridgehead> - <indexterm><primary>\samepage</primary></indexterm> - - <para><literal>\samepage</literal> - </para> - <para>The object in the argument <literal>{}</literal> - should be on the current page. - </para> - - <bridgehead renderas="sect5" id="cmd-fussy">\fussy</bridgehead> - <indexterm><primary>\fussy</primary></indexterm> - - <para><literal>\fussy</literal> - </para> - <para>This declaration (which is the default) makes &tex; more - fussy about line breaking. This can avoids too much space - between words, but may produce overfull boxes. - </para> - <para>This command cancels the effect of a previous - <literal>\sloppy</literal> command. - <link linkend="cmd-sloppy">\sloppy</link> - </para> - - <bridgehead renderas="sect5" id="cmd-hyphenation">\hyphenation</bridgehead> - <indexterm><primary>\hyphenation</primary></indexterm> - <indexterm><primary>Hyphenation, defining</primary></indexterm> - - <para><literal>\hyphenation{words}</literal> - </para> - <para>The <literal>\hyphenation</literal> command declares - allowed hyphenation points, where <literal>words</literal> - is a list of words, separated by spaces, in which each - hyphenation point is indicated by a <literal>-</literal> - character. - </para> - - <bridgehead renderas="sect5" id="cmd-linebreak">\linebreak</bridgehead> - <indexterm><primary>\linebreak</primary></indexterm> - <indexterm><primary>Line breaks</primary></indexterm> - - <para><literal>\linebreak[number]</literal> - </para> - <para>The <literal>\linebreak</literal> command tells &latex; to - break the current line at the point of the command. With - the optional argument, <literal>number</literal>, you can - convert the <literal>\linebreak</literal> command from a - demand to a request. The number must be a number from 0 to - 4. The higher the number, the more insistent the request is. - </para> - <para>The <literal>\linebreak</literal> command causes &latex; - to stretch the line so it extends to the right margin. - </para> - - <bridgehead renderas="sect5" id="cmd-newline">\newline</bridgehead> - <indexterm><primary>\newline</primary></indexterm> - <indexterm><primary>New line, starting (paragraph mode)</primary></indexterm> - - <para>The <literal>\newline</literal> command breaks the line - right where it is. It can only be used in paragraph mode. - </para> - - <bridgehead renderas="sect5" id="cmd-newpage">\newpage</bridgehead> - <indexterm><primary>\newpage</primary></indexterm> - <indexterm><primary>New Page</primary></indexterm> - - <para>The <literal>\newpage</literal> command ends the - current page. In contrast to - <link linkend="cmd-pagebreak">\pagebreak</link> - it can produce a partly empty page, even when - <link linkend="cmd-flushbottom-title">\flushbottom</link> - is active. - </para> - - <bridgehead renderas="sect5" id="cmd-nolinebreak">\nolinebreak</bridgehead> - <indexterm><primary>\nolinebreak</primary></indexterm> - - <para><literal>\nolinebreak[number]</literal> - </para> - <para>The <literal>\nolinebreak</literal> command prevents - &latex; from breaking the current line at the point of the - command. With the optional argument, - <literal>number</literal>, you can convert the - <literal>\nolinebreak</literal> command from a demand to a - request. The number must be a number from 0 to 4. The - higher the number, the more insistent the request is. - </para> - - <bridgehead renderas="sect5" id="cmd-nopagebreak">\nopagebreak</bridgehead> - <indexterm><primary>\nopagebreak</primary></indexterm> - - <para><literal>\nopagebreak[number]</literal> - </para> - <para>The <literal>\nopagebreak</literal> command prevents - &latex; from breaking the current page at the point of the - command. With the optional argument, - <literal>number</literal>, you can convert the - <literal>\nopagebreak</literal> command from a demand to a - request. The number must be a number from 0 to 4. The - higher the number, the more insistent the request is. - </para> - - <bridgehead renderas="sect5" id="cmd-pagebreak">\pagebreak</bridgehead> - <indexterm><primary>\pagebreak</primary></indexterm> - <indexterm><primary>Page break, forcing</primary></indexterm> - - <para><literal>\pagebreak[number]</literal> - </para> - <para>The <literal>\pagebreak</literal> command tells &latex; to - break the current page at the point of the command. With - the optional argument, <literal>number</literal>, you can - convert the <literal>\pagebreak</literal> command from a - demand to a request. The number must be a number from 0 to - 4. The higher the number, the more insistent the request - is. - </para> - - <bridgehead renderas="sect5" id="cmd-sloppy">\sloppy</bridgehead> - <indexterm><primary>\sloppy</primary></indexterm> - - <para><literal>\sloppy</literal> - </para> - <para>This declaration makes &tex; less fussy about line - breaking. This can prevent overfull boxes, but may leave too - much space between words. - </para> - <para>Lasts until a <literal>\fussy</literal> command is - issued. <link linkend="cmd-fussy">\fussy</link>. - </para> - - </section> - - - <section id="making-paragraphs"> - <title id="making-paragraphs-title">Making Paragraphs</title> - <indexterm><primary>Making paragraphs</primary></indexterm> - <indexterm><primary>Paragraphs</primary></indexterm> - - <para>A paragraph is ended by one or more completely blank lines - --- lines not containing even a <literal>%</literal>. A blank - line should not appear where a new paragraph cannot be - started, such as in math mode or in the argument of a - sectioning command. - </para> - - <bridgehead renderas="sect5" id="cmd-indent">\indent</bridgehead> - <indexterm><primary>\indent</primary></indexterm> - <indexterm><primary>Indent, forcing</primary></indexterm> - - <para><literal>\indent</literal> - </para> - <para>This produces a horizontal space whose width equals the - width of the paragraph indentation. It is used to add - paragraph indentation where it would otherwise be - suppressed. - </para> - - <bridgehead renderas="sect5" id="cmd-noindent">\noindent</bridgehead> - <indexterm><primary>\noindent</primary></indexterm> - <indexterm><primary>Indent, suppressing</primary></indexterm> - - <para><literal>\noindent</literal> - </para> - <para>When used at the beginning of the paragraph, it - suppresses the paragraph indentation. It has no effect when - used in the middle of a paragraph. - </para> - - <bridgehead renderas="sect5" id="cmd-par">\par</bridgehead> - <indexterm><primary>\par</primary></indexterm> - <indexterm><primary>Paragraph, starting a new</primary></indexterm> - - <para>Equivalent to a blank line; often used to make command - or environment definitions easier to read. - </para> - - </section> - - - <section id="margin-notes"> - <title id="margin-notes-title">Margin Notes</title> - <indexterm><primary>Margin Notes</primary></indexterm> - <indexterm><primary>Notes in the margin</primary></indexterm> - <indexterm><primary>Remarks in the margin</primary></indexterm> - - <para>The command <literal>\marginpar[left]{right}</literal> - creates a note in the margin. The first line will be at the - same height as the line in the text where the - <literal>\marginpar</literal> occurs. - </para> - <para>When you only specify the mandatory argument - <literal>right</literal>, the text will be placed - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>in the right margin for one-sided layout - </simpara></listitem> - <listitem> - <simpara>in the outside margin for two-sided layout - </simpara></listitem> - <listitem> - <simpara>in the nearest margin for two-column layout. - </simpara></listitem> - </itemizedlist> - - <para>By issuing the command - <literal>\reversemarginpar</literal>, you can force the - marginal notes to go into the opposite (inside) margin. - </para> - <para>When you specify both arguments, <literal>left</literal> - is used for the left margin, and <literal>right</literal> is - used for the right margin. - </para> - <para>The first word will normally not be hyphenated; you can - enable hyphenation by prefixing the first word with a - <literal>\hspace{0pt}</literal> command. - </para> - - </section> - - - <section id="math-formulae"> - <title id="math-formulae-title">Math Formulae</title> - <indexterm><primary>Math Formulae</primary></indexterm> - <indexterm><primary>Formulae, maths</primary></indexterm> - <indexterm><primary>Math mode, entering</primary></indexterm> - <indexterm><primary>\(</primary></indexterm> - <indexterm><primary>\)</primary></indexterm> - <indexterm><primary>\[</primary></indexterm> - <indexterm><primary>\]</primary></indexterm> - <indexterm><primary>$</primary></indexterm> - - <table frame="none"> - <title>Three environments that put &latex; in math mode</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>math - </entry> - <entry>For Formulae that appear right in the text. - </entry> - </row> - <row rowsep="0"><entry>displaymath - </entry> - <entry>For Formulae that appear on their own line. - </entry> - </row> - <row rowsep="0"><entry>equation - </entry> - <entry>The same as the displaymath environment except - that it adds an equation number in the right margin. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>The <literal>math</literal> environment can be used in - both paragraph and LR mode, but the - <literal>displaymath</literal> and <literal>equation</literal> - environments can be used only in paragraph mode. The - <literal>math</literal> and <literal>displaymath</literal> - environments are used so often that they have the following - short forms: - </para> - <programlisting> -\(...\) instead of \begin{math}...\end{math} - -\[...\] instead of \begin{displaymath}...\end{displaymath}</programlisting> - - <para>In fact, the <literal>math</literal> environment is so - common that it has an even shorter form: - </para> - <programlisting> -$ ... $ instead of \(...\)</programlisting> - - <indexterm><primary>exponent</primary></indexterm> - - <bridgehead renderas="sect5" id="subscripts-and-superscripts-title">Subscripts & Superscripts</bridgehead> - <indexterm><primary>Superscript</primary></indexterm> - <indexterm><primary>Subscript</primary></indexterm> - <indexterm><primary>_</primary></indexterm> - <indexterm><primary>^</primary></indexterm> - - <para>To get an expression <emphasis>exp</emphasis> to appear - as a subscript, you just type - <literal>_{</literal><emphasis>exp</emphasis><literal>} - </literal>. - To get <emphasis>exp</emphasis> to appear as a superscript, - you type - <literal>^{</literal><emphasis>exp</emphasis> - <literal>}</literal>. - &latex; handles superscripted superscripts and all of that - stuff in the natural way. It even does the right thing when - something has both a subscript and a superscript. - </para> - - <bridgehead renderas="sect5" id="math-symbols-title">Math Symbols</bridgehead> - <indexterm><primary>Maths symbols</primary></indexterm> - <indexterm><primary>Symbols</primary></indexterm> - <indexterm><primary>Greek letters</primary></indexterm> - - <bridgehead renderas="sect5" id="spacing-in-math-mode-title">Spacing in Math Mode</bridgehead> - <indexterm><primary>Spacing, within Math mode</primary></indexterm> - <indexterm><primary>Math mode, spacing</primary></indexterm> - - <para>In a <literal>math</literal> environment, &latex; ignores - the spaces you type and puts in the spacing that it thinks - is best. &latex; formats mathematics the way it's done in - mathematics texts. If you want different spacing, &latex; - provides the following four commands for use in math mode: - </para> - <indexterm><primary>\;</primary></indexterm> - <indexterm><primary>\COLON</primary></indexterm> - <indexterm><primary>\,</primary></indexterm> - <indexterm><primary>\!</primary></indexterm> - - <orderedlist><listitem> - <para><literal>\;</literal> - a thick space - </para></listitem> - <listitem> - <para><literal>\:</literal> - a medium space - </para></listitem> - <listitem> - <para><literal>\,</literal> - a thin space - </para></listitem> - <listitem> - <para><literal>\!</literal> - a negative thin space - </para></listitem> - </orderedlist> - - <bridgehead renderas="sect5" id="math-miscellany-title">Math Miscellany</bridgehead> - <indexterm><primary>Math Miscellany</primary></indexterm> - - <table frame="none"> - <title>Math Miscellany</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry id="cmd-math-misc-cdots">\cdots<indexterm> - <primary>\cdots</primary> - </indexterm> - </entry> - <entry>Produces a horizontal ellipsis where the dots - are raised to the centre of the line. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-ddots">\ddots - <indexterm><primary>\ddots</primary></indexterm> - </entry> - <entry>Produces a diagonal ellipsis. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-frac">\frac{num}{den} - <indexterm><primary>\frac</primary></indexterm> - </entry> - <entry>Produces the fraction <literal>num</literal> - divided by <literal>den</literal>. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-ldots">\ldots - <indexterm><primary>\ldots</primary></indexterm> - </entry> - <entry>Produces an ellipsis. This command works in - any mode, not just math mode. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-overbrace">\overbrace{text} - <indexterm><primary>\overbrace</primary></indexterm> - </entry> - <entry>Generates a brace over text. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-overline">\overline{text} - <indexterm><primary>\overline</primary></indexterm> - </entry> - <entry>Causes the argument text to be overlined. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-sqrt">\sqrt[root]{arg} - <indexterm><primary>\sqrt</primary></indexterm> - </entry> - <entry>Produces the square root of its argument. The - optional argument, <literal>root</literal>, - determines what root to produce, i.e., the cube root - of <literal>x+y</literal> would be typed as - <literal>$\sqrt[3]{x+y}$</literal>. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-underbrace">\underbrace{text} - <indexterm><primary>\underbrace</primary></indexterm> - </entry> - <entry>Generates text with a brace underneath. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-underline">\underline{text} - <indexterm><primary>\underline</primary></indexterm> - </entry> - <entry>Causes the argument text to be underlined. This - command can also be used in paragraph and LR modes. - </entry> - </row> - <row rowsep="0"> - <entry id="cmd-math-misc-vdots">\vdots - <indexterm><primary>\vdots</primary></indexterm> - </entry> - <entry>Produces a vertical ellipsis. - </entry> - </row> - <row rowsep="0"> - <entry id="cmd-math-misc-ensuremath">\ensuremath{} - <indexterm><primary>\ensuremath{}</primary></indexterm> - </entry> - <entry>It's argument is set in math mode. This - is needed for own definitions. - </entry> - </row> - </tbody> - </tgroup> - </table> - - </section> - - <section id="modes"> - <title id="modes-title">Modes</title> - <indexterm><primary>Modes</primary></indexterm> - <indexterm><primary>Paragraph mode</primary></indexterm> - <indexterm><primary>Math mode</primary></indexterm> - <indexterm><primary>Left-to-right mode</primary></indexterm> - <indexterm><primary>LR mode</primary></indexterm> - - <para>When &latex; is processing your input text, it is always in - one of three modes: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>paragraph mode - </simpara></listitem> - <listitem> - <simpara>Math mode - </simpara></listitem> - <listitem> - <simpara>Left-to-right mode, called LR mode for short - </simpara></listitem> - </itemizedlist> - - <para>&latex; changes mode only when it goes up or down a - staircase to a different level, though not all level changes - produce mode changes. Mode changes occur only when entering or - leaving an environment, or when &latex; is processing the - argument of certain text-producing commands. - </para> - <para><emphasis>Paragraph mode</emphasis> is the most - common; it's the one &latex; - is in when processing ordinary text. In that mode, &latex; - breaks your text into lines and breaks the lines into pages. - &latex; is in <emphasis>math mode</emphasis> when it's - generating a mathematical - formula. In <emphasis>LR mode</emphasis>, as in - paragraph mode, &latex; - considers the output that it produces to be a string of words - with spaces between them. However, unlike paragraph mode, - &latex; keeps going from left to right; it never starts a new - line in LR mode. Even if you put a hundred words into an - <literal>\mbox</literal>, &latex; would keep typesetting them - from left to right inside a single box, and then complain - because the resulting box was too wide to fit on the line. - </para> - <para>&latex; is in LR mode when it starts making a box with an - <literal>\mbox</literal> command. You can get it to enter a - different mode inside the box - for example, you can make it - enter math mode to put a formula in the box. There are also - several text-producing commands and environments for making a - box that put &latex; in paragraph mode. The box make by one of - these commands or environments will be called a - <literal>parbox</literal>. When &latex; is in paragraph mode - while making a box, it is said to be in <emphasis>inner paragraph - mode</emphasis>. Its normal paragraph mode, which it - starts out in, is - called <emphasis>outer paragraph mode</emphasis>. - </para> - - </section> - - - <section id="page-styles"> - <title id="page-styles-title">Page Styles</title> - <indexterm><primary>Styles, page</primary></indexterm> - <indexterm><primary>Page styles</primary></indexterm> - - <para>The <literal>\documentclass</literal> command determines - the size and position of the page's head and foot. The page - style determines what goes in them. - </para> - - <bridgehead renderas="sect5" id="cmd-maketitle">\maketitle</bridgehead> - <indexterm><primary>Title making</primary></indexterm> - <indexterm><primary>\maketitle</primary></indexterm> - - <para><literal>\maketitle</literal> - </para> - <para>The <literal>\maketitle</literal> command generates a - title on a separate title page. In the - <literal>article</literal> class, - <literal>\maketitle</literal> - will also switch to pagestyle <literal>plain</literal>. - See <link linkend="page-styles">Page Styles</link> for - commands to change page numbering. - </para> - <para> - Information used to produce the title is obtained from - the following declarations: - </para> - <para>See <link linkend="page-styles">Page Styles</link> for - the commands to give the information. - </para> - - <bridgehead renderas="sect5" id="cmd-author">\author</bridgehead> - <indexterm><primary>\author</primary></indexterm> - <indexterm><primary>Author, for titlepage</primary></indexterm> - - <para><literal>\author{names}</literal> - </para> - <para>The <literal>\author</literal> command declares the - author(s), where <literal>names</literal> is a list of - authors separated by <literal>\and</literal> commands. Use - <literal>\\</literal> to separate lines within a single - author's entry -- for example, to give the author's - institution or address. - </para> - - <bridgehead renderas="sect5" id="cmd-date">\date</bridgehead> - <indexterm><primary>\date</primary></indexterm> - <indexterm><primary>Date, for titlepage</primary></indexterm> - - <para><literal>\date{text}</literal> - </para> - <para>The <literal>\date</literal> command declares - <emphasis>text</emphasis> to be the document's date. With - no <literal>\date</literal> command, the current date is - used. - </para> - - <bridgehead renderas="sect5" id="cmd-thanks">\thanks</bridgehead> - <indexterm><primary>\thanks</primary></indexterm> - <indexterm><primary>Thanks, for titlepage</primary></indexterm> - - <para><literal>\thanks{text}</literal> - </para> - <para>The <literal>\thanks</literal> command produces a - <literal>\footnote</literal> to the title. - </para> - - <bridgehead renderas="sect5" id="cmd-title">\title</bridgehead> - <indexterm><primary>\title</primary></indexterm> - <indexterm><primary>Title, for titlepage</primary></indexterm> - - <para><literal>\title{text}</literal> - </para> - - <para>The <literal>\title</literal> command declares - <literal>text</literal> to be the title. Use - <literal>\\</literal> to tell &latex; where to start a new - line in a long title. - </para> - - <bridgehead renderas="sect5" id="cmd-pagenumbering">\pagenumbering</bridgehead> - <indexterm><primary>\pagenumbering</primary></indexterm> - <indexterm><primary>Page numbering</primary></indexterm> - - <para><literal>\pagenumbering{num_style}</literal> - </para> - <para>Specifies the style of page numbers. Possible values of - <literal>num_style</literal> are: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>arabic</literal> - Arabic numerals - </simpara></listitem> - <listitem> - <simpara><literal>roman</literal> - Lowercase Roman numerals - </simpara></listitem> - <listitem> - <simpara><literal>Roman</literal> - Uppercase Roman numerals - </simpara></listitem> - <listitem> - <simpara><literal>alph</literal> - Lowercase letters - </simpara></listitem> - <listitem> - <simpara><literal>Alph</literal> - Uppercase letters - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-pagestyle">\pagestyle</bridgehead> - <indexterm><primary>\pagestyle</primary></indexterm> - - <para><literal>\pagestyle{option}</literal> - </para> - <para>The <literal>\pagestyle</literal> command changes the - style from the current page on throughout the remainder of - your document. - </para> - <para>The valid options are: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>plain</literal> - Just a plain page number. - </simpara></listitem> - <listitem> - <simpara><literal>empty</literal> - Produces empty heads and - feet - no page numbers. - </simpara></listitem> - <listitem> - <simpara><literal>headings</literal> - Puts running headings - on each page. The document style specifies what goes in - the headings. - </simpara></listitem> - <listitem> - <simpara><literal>myheadings</literal> - You specify what is - to go in the heading with the - <literal>\markboth</literal> or the - <literal>\markright</literal> commands. - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-markboth">\markboth</bridgehead> - <indexterm><primary>\markboth</primary></indexterm> - - <programlisting> -\markboth{left head}{right head}</programlisting> - - <para>The <literal>\markboth</literal> command is used in - conjunction with the page style - <literal>myheadings</literal> for setting both the left and - the right heading. You should note that a <emphasis>left-hand - heading</emphasis> is generated by the last - <literal>\markboth</literal> command before the end of the - page, while a <emphasis>right-hand heading</emphasis> - is generated by the - first <literal>\markboth</literal> or - <literal>\markright</literal> that comes on the page if - there is one, otherwise by the last one before the page. - </para> - - <bridgehead renderas="sect5" id="cmd-markright">\markright</bridgehead> - <indexterm><primary>\markright</primary></indexterm> - - <programlisting> -\markright{right head}</programlisting> - - <para>The <literal>\markright</literal> command is used in - conjunction with the page style - <literal>myheadings</literal> for setting the right heading, - leaving the left heading unchanged. You should note that a - <emphasis>left-hand heading</emphasis> - is generated by the last - <literal>\markboth</literal> command before the end of the - page, while a <emphasis>right-hand heading</emphasis> - is generated by the - first <literal>\markboth</literal> or - <literal>\markright</literal> that comes on the page if - there is one, otherwise by the last one before the page. - </para> - - <bridgehead renderas="sect5" id="cmd-thispagestyle">\thispagestyle</bridgehead> - <indexterm><primary>\thispagestyle</primary></indexterm> - - <para><literal>\thispagestyle{option}</literal> - </para> - <para>The <literal>\thispagestyle</literal> command works in - the same manner as the <literal>\pagestyle</literal> command - except that it changes the style for the current page only. - </para> - - </section> - - <section id="sectioning"> - <title id="sectioning-title">Sectioning</title> - <indexterm><primary>Sectioning</primary></indexterm> - <indexterm><primary>\chapter</primary></indexterm> - <indexterm><primary>\subsubsection</primary></indexterm> - <indexterm><primary>\subsection</primary></indexterm> - <indexterm><primary>\paragraph</primary></indexterm> - <indexterm><primary>\subparagraph</primary></indexterm> - - <para>Sectioning commands provide the means to structure your - text into units. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-sectioning-part"><literal>\part</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-chapter"><literal>\chapter</literal> (report and book class - only) - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-section"><literal>\section</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-subsection"><literal>\subsection</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-subsubsection"><literal>\subsubsection</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-paragraph"><literal>\paragraph</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-subparagraph"><literal>\subparagraph</literal> - </simpara></listitem> - </itemizedlist> - - <para>All sectioning commands take the same general form, i.e., - </para> - <para><literal>\chapter[optional]{title}</literal> - </para> - <para>In addition to providing the heading in the text, the - mandatory argument of the sectioning command can appear in two - other places: - </para> - <orderedlist><listitem> - <para>The table of contents - </para></listitem> - <listitem> - <para>The running head at the top of the page - </para></listitem> - </orderedlist> - - <para>You may not want the same thing to appear in these other - two places as appears in the text heading. To handle this - situation, the sectioning commands have an - <literal>optional</literal> argument that provides the text - for these other two purposes. - </para> - <para>All sectioning commands have <literal>*</literal>-forms - that print a <emphasis>title</emphasis>, but do not include a - number and do not make an entry in the table of contents. - </para> - <indexterm><primary>\appendix</primary></indexterm> - <indexterm><primary>Appendix, creating</primary></indexterm> - - <para id="cmd-sectioning-appendix"><literal>\appendix</literal> - </para> - <para>The <literal>\appendix</literal> command changes the way - sectional units are numbered. The - <literal>\appendix</literal> command generates no text and - does not affect the numbering of parts. The normal use of this - command is something like - </para> - <programlisting> -\chapter{The First Chapter} - ... -\appendix -\chapter{The First Appendix}</programlisting> - - </section> - - - <section id="spaces-and-boxes"> - <title id="spaces-and-boxes-title">Spaces & Boxes</title> - <indexterm><primary>Spaces</primary></indexterm> - <indexterm><primary>Boxes</primary></indexterm> - - <para>All the predefined length parameters See - <link linkend="predefined-lengths-title">Predefined lengths</link> can - be used in the arguments of the box-making commands. - </para> - - - <bridgehead renderas="sect5" id="cmd-dotfill">\dotfill</bridgehead> - <indexterm><primary>\dotfill</primary></indexterm> - - <para>The <literal>\dotfill</literal> command produces a - <emphasis>rubber length</emphasis> that produces dots - instead of just spaces. - </para> - - <bridgehead renderas="sect5" id="cmd-hfill">\hfill</bridgehead> - <indexterm><primary>\hfill</primary></indexterm> - - <para>The <literal>\hfill</literal> fill command produces a - <emphasis>rubber length</emphasis> which can stretch - or shrink horizontally. It will be filled with spaces. - </para> - - <bridgehead renderas="sect5" id="cmd-hrulefill">\hrulefill</bridgehead> - <indexterm><primary>\hrulefill</primary></indexterm> - - <para>The <literal>\hrulefill</literal> fill command produces - a <emphasis>rubber length</emphasis> which can stretch - or shrink horizontally. It will be filled with a horizontal rule. - </para> - - <bridgehead renderas="sect5" id="cmd-hspace">\hspace</bridgehead> - <indexterm><primary>\hspace</primary></indexterm> - - <para><literal>\hspace{length}, \hspace*{length}</literal> - </para> - - <para>The <literal>\hspace</literal> command adds horizontal - space. The length of the space can be expressed in any - terms that &latex; understands, i.e., points, inches, etc. - You can add negative as well as positive space with an - <literal>\hspace</literal> command. Adding negative space - is like backspacing. - </para> - <para>&latex; removes horizontal space that comes at the end of - a line. If you don't want &latex; to remove this space, - include the optional <literal>*</literal> argument. Then - the space is never removed. - </para> - - <bridgehead renderas="sect5" id="cmd-addvspace">\addvspace</bridgehead> - <indexterm><primary>\addvspace</primary></indexterm> - <indexterm><primary>Vertical space, inserting</primary></indexterm> - <indexterm><primary>Space, inserting vertical</primary></indexterm> - - <para><literal>\addvspace{length}</literal> - </para> - <para>The <literal>\addvspace</literal> command normally adds - a vertical space of height length. However, if vertical - space has already been added to the same point in the - output by a previous <literal>\addvspace</literal> - command, then this command will not add more space than - needed to make the natural length of the total vertical - space equal to <literal>length</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-bigskip">\bigskip</bridgehead> - <indexterm><primary>\bigskip</primary></indexterm> - - <para>The <literal>\bigskip</literal> command is equivalent to - <literal>\vspace{bigskipamount}</literal> where - <literal>bigskipamount</literal> is determined by the - document class. - </para> - - <bridgehead renderas="sect5" id="cmd-medskip">\medskip</bridgehead> - <indexterm><primary>\medskip</primary></indexterm> - - <para>The <literal>\medskip</literal> command is - equivalent to <literal>\vspace{medskipamount}</literal> - where <literal>medskipamount</literal> is determined by - the document class. - </para> - - <bridgehead renderas="sect5" id="cmd-smallskip">\smallskip</bridgehead> - <indexterm><primary>\smallskip</primary></indexterm> - - <para><literal>\smallskip</literal> - </para> - <para>The <literal>\smallskip</literal> command is equivalent - to <literal>\vspace{smallskipamount}</literal> where - <literal>smallskipamount</literal> is determined by the - document class. - </para> - - <bridgehead renderas="sect5" id="cmd-vfill">\vfill</bridgehead> - <indexterm><primary>\vfill</primary></indexterm> - - <para>The <literal>\vfill</literal> fill command produces a - rubber length which can stretch or shrink vertically. - </para> - - <bridgehead renderas="sect5" id="cmd-vspace">\vspace</bridgehead> - <indexterm><primary>\vspace</primary></indexterm> - - <para><literal>\vspace{length}, \vspace*{length}</literal> - </para> - <para>The <literal>\vspace</literal> command adds vertical - space. The length of the space can be expressed in any - terms that &latex; understands, i.e., points, inches, - etc. You can add negative as well as positive space with - an <literal>\vspace</literal> command. - </para> - <para>&latex; removes vertical space that comes at the end - of a page. If you don't want &latex; to remove this - space, include the optional <literal>*</literal> - argument. Then the space is never removed. - </para> - - <bridgehead renderas="sect5" id="cmd-fbox">\fbox</bridgehead> - <indexterm><primary>\fbox</primary></indexterm> - - <para><literal>\fbox{text}</literal> - </para> - <para>The <literal>\fbox</literal> command is exactly the - same as the <literal>\mbox</literal> command, except - that it puts a frame around the outside of the box that - it creates. - </para> - - <bridgehead id="cmd-framebox">\framebox</bridgehead> - <indexterm><primary>\framebox</primary></indexterm> - - <para><literal>\framebox[width][position]{text}</literal> - </para> - <para>The <literal>\framebox</literal> command is exactly the - same as the <literal>\makebox</literal> command, except - that it puts a frame around the outside of the box that - it creates. - </para> - <para>The framebox command produces a rule of thickness - <literal>\fboxrule</literal>, and leaves a space - <literal>\fboxsep</literal> between the rule and the - contents of the box. - </para> - - <bridgehead renderas="sect5" id="env-lrbox">lrbox</bridgehead> - <indexterm><primary>lrbox</primary></indexterm> - - <para><literal>\begin{lrbox}{cmd} text \end{lrbox}</literal> - </para> - <para>This is the environment form of <literal>\sbox</literal>. - </para> - <para>The text inside the environment is saved in the box - <literal>cmd</literal>, which must have been declared with - <literal>\newsavebox</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-makebox">\makebox</bridgehead> - <indexterm><primary>\makebox</primary></indexterm> - - <para><literal>\makebox[width][position]{text}</literal> - </para> - <para>The <literal>\makebox</literal> command creates a - box just wide enough to contain the - <literal>text</literal> specified. The width of the box - is specified by the optional <literal>width</literal> - argument. The position of the text within the box is - determined by the optional <literal>position</literal> - argument. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>c</literal> --- centred (default) - </simpara></listitem> - <listitem> - <simpara><literal>l</literal> --- flushleft - </simpara></listitem> - <listitem> - <simpara><literal>r</literal> --- flushright - </simpara></listitem> - <listitem> - <simpara><literal>s</literal> --- stretch from left to right - margin. The text must contain stretchable space for this - to work. - </simpara></listitem> - </itemizedlist> - - <para>See <link linkend="cmd-makebox-op-picture-cp">\makebox - (picture)</link>. - </para> - - <bridgehead renderas="sect5" id="cmd-mbox">\mbox</bridgehead> - <indexterm><primary>\mbox</primary></indexterm> - - <para><literal>\mbox{text}</literal> - </para> - <para>The <literal>\mbox</literal> command creates a box just - wide enough to hold the text created by its argument. - </para> - <para>Use this command to prevent text from being split - across lines. - </para> - - <bridgehead renderas="sect5" id="cmd-newsavebox">\newsavebox</bridgehead> - <indexterm><primary>\newsavebox</primary></indexterm> - - <para><literal>\newsavebox{cmd}</literal> - </para> - <para>Declares <literal>cmd</literal>, which must be a command - name that is not already defined, to be a bin for saving - boxes. - </para> - - <bridgehead renderas="sect5" id="cmd-parbox">\parbox</bridgehead> - <indexterm><primary>\parbox</primary></indexterm> - - <para><literal>\parbox[position][height][inner-pos]{width}{text}</literal> - </para> - <para>A <literal>parbox</literal> is a box whose contents are - created in <literal>paragraph</literal> mode. The - <literal>\parbox</literal> has two mandatory arguments: - </para> - <itemizedlist spacing="compact" - ><listitem> - <simpara><literal>width</literal> - specifies the width of - the parbox, and - </simpara></listitem> - <listitem> - <simpara><literal>text</literal> - the text that goes inside - the parbox. - </simpara></listitem> - </itemizedlist> - - <para>&latex; will position a <literal>parbox</literal> so - its centre lines up with the centre of the text line. - The optional <emphasis>position</emphasis> argument - allows you to line up either the top or bottom line in - the parbox (default is top). - </para> - <para>If the <emphasis>height</emphasis> argument is not - given, the box will have the natural height of the text. - </para> - <para>The <emphasis>inner-pos</emphasis> argument controls the - placement of the text inside the box. If it is not - specified, <emphasis>position</emphasis> is used. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> --- text is placed at the top - of the box. - </simpara></listitem> - <listitem> - <simpara><literal>c</literal> --- text is centred in the box. - </simpara></listitem> - <listitem> - <simpara><literal>b</literal> --- text is placed at the - bottom of the box. - </simpara></listitem> - <listitem> - <simpara><literal>s</literal> --- stretch vertically. The - text must contain vertically stretchable space for this - to work. - </simpara></listitem> - </itemizedlist> - - <para>A <literal>\parbox</literal> command is used for a - parbox containing a small piece of text, with nothing - fancy inside. In particular, you shouldn't use any of - the paragraph-making environments inside a - <literal>\parbox</literal> argument. For larger pieces - of text, including ones containing a paragraph-making - environment, you should use a - <literal>minipage</literal> environment See - <link linkend="env-minipage">minipage</link>. - </para> - - <bridgehead renderas="sect5" id="cmd-raisebox">\raisebox</bridgehead> - <indexterm><primary>\raisebox</primary></indexterm> - - <para><literal>\raisebox{distance}[extend-above][extend-below]{text}</literal> - </para> - <para>The <literal>\raisebox</literal> command is used to - raise or lower text. The first mandatory argument - specifies how high the text is to be raised (or lowered - if it is a negative amount). The text itself is - processed in <literal>LR mode</literal>. - </para> - - <para>Sometimes it's useful to make &latex; think - something has a different size than it really does - or - a different size than &latex; would normally think it - has. The <literal>\raisebox</literal> command lets you - tell &latex; how tall it is. - </para> - <para>The first optional argument, - <literal>extend-above</literal>, makes &latex; think - that the text extends above the line by the amount - specified. The second optional argument, - <literal>extend-below</literal>, makes &latex; think - that the text extends below the line by the amount - specified. - </para> - - <bridgehead renderas="sect5" id="cmd-rule">\rule</bridgehead> - <indexterm><primary>\rule</primary></indexterm> - - <para><literal>\rule[raise-height]{width}{thickness}</literal> - </para> - <para>The <literal>\rule</literal> command is used to produce - horizontal lines. The arguments are defined as follows: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>raise-height</literal> - specifies how high - to raise the rule (optional) - </simpara></listitem> - <listitem> - <simpara><literal>width</literal> - specifies the length of - the rule (mandatory) - </simpara></listitem> - <listitem> - <simpara><literal>thickness</literal> - specifies the - thickness of the rule (mandatory) - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-savebox">\savebox</bridgehead> - <indexterm><primary>\savebox</primary></indexterm> - - <para><literal>\savebox{cmd}[width][pos]{text}</literal></para> - - <para>This command typeset <literal>text</literal> in a box just as - for <literal>\makebox</literal>. However, instead of - printing the resulting box, it saves it in bin - <literal>cmd</literal>, which must have been declared with - <literal>\newsavebox</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-sbox">\sbox</bridgehead> - <indexterm><primary>\sbox</primary></indexterm> - - <para><literal>\sbox{cmd}\{text}</literal> - </para> - <para>This commands typesets <literal>text</literal> in a box - just as for <literal>\mbox</literal>. However, instead of - printing the resulting box, it saves it in - <literal>cmd</literal>, which must have been declared with - <literal>\newsavebox</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-usebox">\usebox</bridgehead> - <indexterm><primary>\usebox</primary></indexterm> - - <para><literal>\usebox{cmd}</literal> - </para> - <para>Prints the box most recently saved in bin - <literal>cmd</literal> by a <literal>\savebox</literal> - command. - </para> - - </section> - - - <section id="special-characters"> - <title id="special-characters-title">Special Characters</title> - <indexterm><primary>Special Characters</primary></indexterm> - <indexterm><primary>Characters, special</primary></indexterm> - <indexterm><primary>Reserved Characters</primary></indexterm> - <indexterm><primary>Characters, reserved</primary></indexterm> - - <para>The following characters play a special role in &latex; and - are called - <emphasis>special printing characters</emphasis>, or simply - <emphasis>special characters</emphasis>. - </para> - <programlisting> -# $ % & ~ _ ^ \ { }</programlisting> - - <para>Whenever you put one of these special characters into - your file, you are doing something special. If you simply - want the character to be printed just as any other letter, - include a <literal>\</literal> in front of the character. - For example, <literal>\$</literal> will produce - <literal>$</literal> in your output. - </para> - <para>One exception to this rule is the <literal>\</literal> - itself because <literal>\\</literal> has its own special - meaning. A <literal>\</literal> is produced by typing - <literal>$\backslash$</literal> in your file. - </para> - <para>Also, <literal>\~</literal> means `place a tilde - accent over the following letter', so you will probably - want to use <literal>\verb</literal> instead. - </para> - <indexterm><primary>\backslash</primary></indexterm> - <indexterm><primary>\symbol</primary></indexterm> - <indexterm><primary>Accessing any character of a font</primary></indexterm> - - <para>In addition, you can access any character of a font - once you know its number by using the - <literal>\symbol</literal> command. For example, the - character used for displaying spaces in the - <literal>\verb*</literal> command has the code decimal 32, - so it can be typed as <literal>\symbol{32}</literal>. - </para> - <para>You can also specify octal numbers with - <literal>'</literal> or hexadecimal numbers with - <literal>"</literal>, so the previous example could also - be written as <literal>\symbol{'40}</literal> or - <literal>\symbol{"20}</literal>. - </para> - - </section> - - <section id="special-symbols"> - <title id="special-symbols-title">Special Symbols</title> - <indexterm> - <primary>Symbols</primary> - <secondary>Special</secondary> - </indexterm> - <para></para> - - <bridgehead renderas="sect5" id="accents-on-chars-title">Accents on Characters</bridgehead> - <indexterm> - <primary>Accents</primary> - </indexterm> - <para>The rules differ somewhat depending whether you are - in <link linkend="modes">text mode</link>, - <link linkend="modes">math modes</link>, or the - <link linkend="env-tabbing">tabbing environment</link>. - </para> - - <bridgehead renderas="sect5">Text Mode</bridgehead> - <para>The following accents may be placed on letters. - Although <emphasis>o</emphasis> is used in - most of the example, the accents may be placed on - any letter. Accents may even be placed above a - <emphasis>missing</emphasis> letter; for example, - <literal>\~{}</literal> produces a tilde over a - blank space. - </para> - <para>The following commands may be used only in - paragraph or LR mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\`{o}</literal> - produces a grave accent, - <emphasis>ò</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\'{o}</literal> - produces an acute accent, - <emphasis>ó</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\^{o}</literal> - produces a circumflex, - <emphasis>ô</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\"{o}</literal> - produces an umlaut or dieresis, - <emphasis>ö</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\H{o}</literal> - produces a long Hungarian umlaut - </simpara> - </listitem> - <listitem> - <simpara><literal>\~{o}</literal> - produces a tilde, - <emphasis>õ</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\c{c}</literal> - produces a cedilla, - <emphasis> ç</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\={o}</literal> - produces a macron accent (a bar over the letter) - </simpara> - </listitem> - <listitem> - <simpara><literal>\b{o}</literal> - produces a bar under the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\.{o}</literal> - produces a dot over the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\d{o}</literal> - produces a dot under the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\u{o}</literal> - produces a breve over the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\v{o}</literal> - produces a <emphasis>v</emphasis> over - the letter</simpara> - </listitem> - <listitem> - <simpara><literal>\t{oo}</literal> - produces a <emphasis>tie</emphasis> - (inverted u) over the two letters - </simpara> - </listitem> - </itemizedlist> - </para> - <para>Note that the letters <emphasis>i</emphasis> - and <emphasis>j</emphasis> require special - treatment when they are given accents because - it is often desirable to replace the - dot with the accent. For this purpose, the commands - <literal>\i</literal> and <literal>\j</literal> - can be used to produce dotless letters. - </para> - <para>For example, - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\^{\i}</literal> - should be used for i, circumflex, î - </simpara> - </listitem> - <listitem> - <simpara><literal>\"{\i}</literal> - should be used for i, umlaut, ï</simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="accents-chars-math">Math Mode</bridgehead> - <para>Several of the above and some similar accents - can also be produced in math mode. The following - commands may be used <emphasis>only</emphasis> - in math mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\hat{o}</literal> - is similar to the circumflex - (cf. <literal>\^</literal>)</simpara> - </listitem> - <listitem> - <simpara><literal>\widehat{oo}</literal> - is a wide version of - <emphasis>\hat</emphasis> - over several letters - </simpara> - </listitem> - <listitem> - <simpara><literal>\check{o}</literal> - is a vee or check (cf. <literal>\v</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\tilde{o}</literal> - is a tilde (cf. <literal>\~</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\widetilde{oo}</literal> - is a wide version of - <literal>\tilde</literal> - over several letters - </simpara> - </listitem> - <listitem> - <simpara><literal>\acute{o}</literal> - is an acute accent (cf. <literal>\`</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\grave{o}</literal> - is a grave accent (cf. <literal>>\'</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\dot{o}</literal> - is a dot over the letter - (cf. <literal>\.</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\ddot{o}</literal> - is a double dot over the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\breve{o}</literal> - is a breve (cf. <literal>\u</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\bar{o}</literal> - is a macron (cf. <literal>\=</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\vec{o}</literal> - is a vector (arrow) over the letter - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="accents-chars-tabbing">Tabbing Environment</bridgehead> - <para>Some of the accent marks used in running - text have other uses in the - <link linkend="env-tabbing">Tabbing Environment</link>. - In that case they can be created with the - following command: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>>\a'</literal> - for an acute accent</simpara> - </listitem> - <listitem> - <simpara><literal>\a`</literal> - for a grave accent</simpara> - </listitem> - <listitem> - <simpara><literal>\a=</literal> - for a macron accent</simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="arrows-title">Arrows</bridgehead> - <indexterm> - <primary>Arrows</primary> - </indexterm> - <para>&latex; provides commands for all sorts of arrows. - The following commands are used only in math mode. - </para> - <para>In general the command names are created from - <literal>left</literal>, <literal>right</literal>, - <literal>up</literal>, or <literal>down</literal>. - <literal>leftright</literal> gives a double headed - arrow. Prefacing with <literal>long</literal> gives - a longer arrow. Capitalizing the - first letter gives a double-shanked arrow. - </para> - <para>Examples are: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\leftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Leftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\longleftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Longleftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\rightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Rightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\longrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Longrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\leftrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Leftrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\longleftrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\uparrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\downarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Uparrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>>\nearrow</literal> points from - southwest to northeast</simpara> - </listitem> - <listitem> - <simpara><literal>\searrow</literal> points from - northwest to southeast</simpara> - </listitem> - <listitem> - <simpara><literal>\swarrow</literal> points from - northeast to southwest</simpara> - </listitem> - <listitem> - <simpara><literal>\nwarrow</literal> points from - southeast to northwest</simpara> - </listitem> - </itemizedlist> - </para> - <para>The <literal>\stackrel</literal> command is - useful for putting things over or under your arrow. - </para> - <para>See also: - <itemizedlist spacing="compact"> - <listitem> - <simpara><link linkend="math-symbols-title">Math Symbols</link></simpara> - </listitem> - <listitem> - <simpara> - <link linkend="binary-and-relational-ops-title"> - Binary and Relational Operators</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="greek-letters-title">Greek Letters</link> - </simpara> - </listitem> - <listitem> - <simpara><link linkend="misc-symbols-title"> - Miscellaneous Symbols</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="variable-math-size-symbols-title"> - Variable Size Math Symbols</link> - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="binary-and-relational-ops-title">Binary and Relational Operators</bridgehead> - <indexterm> - <primary>Binary Operators</primary> - </indexterm> - <indexterm> - <primary>Relational Operators</primary> - </indexterm> - <indexterm> - <primary>Operators</primary> - <secondary>Binary</secondary> - </indexterm> - <indexterm> - <primary>Operators</primary> - <secondary>Relational</secondary> - </indexterm> - <para>Some <emphasis>math</emphasis> symbols are - obtained by typing the corresponding keyboard - character. Examples include - <programlisting>+ - = < > </programlisting> - <note> - <para>plus, minus, and equal sign may be used in - either text or math mode, but < and > are - math mode only (they produce inverted exclamation - and question marks, respectively, - in text mode). - </para> - </note> - </para> - <para>The following commands may be used only in math mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\pm</literal> - plus or minus sign</simpara> - </listitem> - <listitem> - <simpara><literal>\mp</literal> - minus or plus sign</simpara> - </listitem> - <listitem> - <simpara><literal>\times</literal> - times (an "x")</simpara> - </listitem> - <listitem> - <simpara><literal>\div</literal> - divided by sign</simpara> - </listitem> - <listitem> - <simpara><literal>\ast</literal> - an asterisk (centered)</simpara> - </listitem> - <listitem> - <simpara><literal>\star</literal> - a five-point star (centered)</simpara> - </listitem> - <listitem> - <simpara><literal>\bullet</literal> - a bullet</simpara> - </listitem> - <listitem> - <simpara><literal>\circ</literal> - an open bullet</simpara> - </listitem> - <listitem> - <simpara><literal>\cdot</literal> - a centered dot</simpara> - </listitem> - <listitem> - <simpara><literal>\leq</literal> - less than or equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\ll</literal> - much less than</simpara> - </listitem> - <listitem> - <simpara><literal>\subset</literal> - is a subset of</simpara> - </listitem> - <listitem> - <simpara><literal>\geq</literal> - greater than or equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\gg</literal> - much greater than</simpara> - </listitem> - <listitem> - <simpara><literal>\equiv</literal> - equivalence symbol</simpara> - </listitem> - <listitem> - <simpara><literal>\sim</literal> - similar to</simpara> - </listitem> - <listitem> - <simpara><literal>\simeq</literal> - similar or equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\approx</literal> - approximately equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\neq</literal> - not equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\per</literal> - "perpendicular to" symbols</simpara> - </listitem> - <listitem> - <simpara><literal>\propto</literal> - proportional to</simpara> - </listitem> - </itemizedlist> - </para> - <para>Note that <emphasis>greater than</emphasis> - and <emphasis>less than</emphasis> are obtained - simply by entering <literal>></literal> and - <literal><</literal>. - </para> - <para>A slash, indicating <emphasis>not</emphasis> - can be placed through a symbol (or a letter) with the - <literal>\not</literal> command. For example, - not less than is <literal>\not<</literal> - and not less than or equal to is - <literal>\not\leq</literal>. - If the slash isn't properly positioned it can be - moved by putting a math mode spacing command - between the <literal>\not</literal>and the symbol. - </para> - - <bridgehead renderas="sect5" id="delimiters-title">Delimiters</bridgehead> - <indexterm> - <primary>Delimiters</primary> - </indexterm> - <para>Delimiters are objects which act logically like - parentheses. These can be used only in math mode. - </para> - <para>The delimiters recognized by &latex; include: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>(</literal> - (left parenthesis) - </simpara> - </listitem> - <listitem> - <simpara><literal>)</literal> - (right parenthesis) - </simpara> - </listitem> - <listitem> - <simpara><literal>[</literal> - (left bracket) - </simpara> - </listitem> - <listitem> - <simpara><literal>]</literal> - (right bracket)</simpara> - </listitem> - <listitem> - <simpara><literal>\{</literal> - (left brace) - </simpara> - </listitem> - <listitem> - <simpara><literal>\}</literal> - (right brace) - </simpara> - </listitem> - <listitem> - <simpara><literal>|</literal> - (vertical line) - </simpara> - </listitem> - <listitem> - <simpara><literal>\vert</literal> - (vertical line) - </simpara> - </listitem> - <listitem> - <simpara><literal>\|</literal> - (double vertical lines) - </simpara> - </listitem> - <listitem> - <simpara><literal>\Vert</literal> - (double vertical lines) - </simpara> - </listitem> - <listitem> - <simpara><literal>/</literal> - (slash) - </simpara> - </listitem> - <listitem> - <simpara><literal>\backslash</literal> - (backslash) - </simpara> - </listitem> - <listitem> - <simpara><literal>\langle</literal> - (left angle bracket) - </simpara> - </listitem> - <listitem> - <simpara><literal>\rangle</literal> - (right angle bracket) - </simpara> - </listitem> - <listitem> - <simpara><literal>\uparrow</literal> - (uparrow) - </simpara> - </listitem> - <listitem> - <simpara><literal>\downarrow</literal> - (down arrow) - </simpara> - </listitem> - <listitem> - <simpara><literal>\updownarrow</literal> - (up/down arrow) - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5">Making Delimiters the Right Size</bridgehead> - <para>Delimiters in formulas should be big enough - to <emphasis>fit</emphasis> around the formulas - they delimit (for example arround arrays). - To obtain <emphasis>stretchable</emphasis> - delimiters (&latex; makes them the appropriate size) - type a <literal>\left</literal> or - <literal>\right</literal> command before - the delimiter. <literal>\left</literal> and - <literal>\right</literal> commands must come in - matching pairs, although the delimiters themselves - need not be the same. Thus, - <literal> \left \{ ... \right \[ </literal> - produces a legal pair. - In cases where only one delimiter is desired, it - is possible to make the matching delimiter - <emphasis>invisible</emphasis> by typing a - period (<literal>.</literal>) after the command, - i.e., <literal>\left.</literal> or - <literal>\right.</literal> - </para> - <para>In an <link linkend="env-eqnarray">eqnarray</link> - environment the matching - <literal>\left</literal> and <literal>\right</literal> - cannot be split between lines and it may be necessary - to use an <emphasis>invisible</emphasis> - <literal>\right.</literal> and <literal>\left.</literal> - to terminate and begin parts on different lines. - In this case a second problem may arise, since the - size of the delimiters will be chosen only for the - <emphasis>local part</emphasis>, so that the size of - the <emphasis>visible</emphasis> - <emphasis>left</emphasis> - and <emphasis>right</emphasis> delimiters might - not match. The solution is to trick &latex; into thinking - that both parts have the same vertical height. This - can be done by placing a strut, that is a zero-width - <literal>\rule</literal>. It can also be accomplished - with the <literal>\vphantom</literal> command, which - I have not found documented, but which appears to work. - </para> - <para><literal>\vphantom{construct}</literal> - creates a zero-width object with the height of - <literal>construct</literal>. - The argument can contain things such as - <literal>\frac</literal> or the - <emphasis>variable size math symbols</emphasis> - and should be chosen according to what is in the - section with the delimiter you want to match. - </para> - - <bridgehead renderas="sect5">Some Examples</bridgehead> - - <bridgehead renderas="sect5">A six-j symbol</bridgehead> - <para> - <programlisting> -\[ \left\{ -\begin{array}{ccc} -a & b & c \\ -d & e & f \end{array} -\right>\} \]</programlisting> - This should be displayed something like - (insofar as it can be rendered in - "ascii art"): - <programlisting> -( a b c ) -- - -( d e f ) -</programlisting> - Note that the <literal>\[ ... \]</literal> - set this off as <emphasis>Display Math</emphasis>, - and that the <emphasis>Array Environment</emphasis> - is used to generate the three centered columns - inside the braces. - </para> - - <bridgehead renderas="sect5">A "multiple choice" equation</bridgehead> - <para> - <programlisting> -\[ f(x) = - \left\{ \begin{array}{l} - 0, x < 0 \\ 1, x = 0 \\ - 2, x > 0 \end{array} \right. \]</programlisting> - will be displayed as - <programlisting> - ( 0, x < 0 -f(x) = - 1, x = 0 - ( 2, x > 0</programlisting> - Note that the <emphasis>invisible</emphasis> - <literal>\right</literal> delimiter is specified - using a <emphasis>period</emphasis>. - </para> - - <bridgehead renderas="sect5" id="ellipsis-title">Ellipsis</bridgehead> - <indexterm> - <primary>Ellipsis</primary> - </indexterm> - <para>Ellipses (three dots) can be produced by the - following commands - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\ldots</literal> - horizontally at bottom of line - </simpara> - </listitem> - <listitem> - <simpara><literal>\cdots</literal> - horizontally center of line - (math mode only) - </simpara> - </listitem> - <listitem> - <simpara><literal>\ddots</literal> - diagonal (math mode only) - </simpara> - </listitem> - <listitem> - <simpara><literal>\vdots</literal> - vertical (math mode only) - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="greek-letters-title">Greek Letters</bridgehead> - <indexterm> - <primary>Greek Letters</primary> - </indexterm> - <para>These commands may be used only in math mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\alpha</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\beta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\gamma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\delta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\epsilon</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varepsilon</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\zeta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\eta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\theta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\vartheta</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\iota</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\kappa</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\lambda</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\mu</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\nu</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\xi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\pi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varpi</literal> (variation)</simpara> - </listitem> - <listitem> - <simpara><literal>\rho</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varrho</literal> (variation, - with the tail)</simpara> - </listitem> - <listitem> - <simpara><literal>\sigma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varsigma</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\tau</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\upsilon</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\phi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varphi</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\chi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\psi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\omega</literal></simpara> - </listitem> - </itemizedlist> - </para> - <para> - Capital letters: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\Gamma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Delta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Theta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Lambda</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Xi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Pi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Sigma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Upsilon</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Phi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Psi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Omega</literal></simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also: - <itemizedlist spacing="compact"> - <listitem> - <simpara><link linkend="math-symbols-title">Math Symbols</link> - </simpara> - </listitem> - <listitem> - <simpara><link linkend="accents-on-chars-title">Accents</link> - </simpara> - </listitem> - <listitem> - <simpara><link linkend="misc-symbols-title">Miscellaneous Symbols</link> - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="misc-symbols-title">Miscellaneous Symbols</bridgehead> - <indexterm> - <primary>Symbols</primary> - <secondary>Miscellaneous</secondary> - </indexterm> - - <bridgehead renderas="sect5">Some symbols for math</bridgehead> - <para>The following symbols are also used only in math mode - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-misc-symbol-aleph"><literal>\aleph</literal> - Hebrew aleph</simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-hbar"><literal>\hbar</literal> - h-bar, Planck's constant</simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-imath"><literal>\imath</literal> - variation on <emphasis>i</emphasis>; no dot - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-jmath"><literal>\jmath</literal> - variation on <emphasis>j</emphasis>; no dot - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-ell"><literal>\ell</literal> - script (loop) <emphasis>l</emphasis> - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-wp"><literal>\wp</literal> - fancy script lowercase <emphasis>P</emphasis> - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-re"><literal>\Re</literal> - script capital <emphasis>R</emphasis> - (<emphasis>Real</emphasis>) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-im"><literal>\Im</literal> - script capital <emphasis>I</emphasis> - (<emphasis>Imaginary</emphasis>) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-prime"><literal>\prime</literal> - prime (also obtained by typing - <literal>'</literal>) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-nabla"><literal>\nabla</literal> - inverted capital Delta - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-surd"><literal>\surd</literal> - radical (square root) symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-angle"><literal>\angle</literal> - angle symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-forall"><literal>\forall</literal> - <emphasis>for all</emphasis> (inverted A) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-exists"><literal>\exists</literal> - <emphasis>exists</emphasis> (left-facing E) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-partial"><literal>\partial</literal> - partial derivative symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-infty"><literal>\infty</literal> - infinity symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-triangle"><literal>\triangle</literal> - open triangle symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-box"><literal>\Box</literal> - open square - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-diamond"><literal>\Diamond</literal> - open diamond - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-flat"><literal>\flat</literal> - music: flat symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-natural"><literal>\natural</literal> - music: natural symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-clubsuit"><literal>\clubsuit</literal> - playing cards: club suit symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-diamondsuit"><literal>\diamondsuit</literal> - playing cards: diamond suit symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-heartsuit"><literal>\heartsuit</literal> - playing cards: heart suit symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-spadsuit"><literal>\spadesuit</literal> - playing cards: space suit symbol - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5">Some Other Symbols</bridgehead> - <para>The following symbols can be used in any mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-other-symbol-dag"><literal>\dag</literal> - dagger - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-ddag">><literal>\ddag</literal> - double dagger - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-s">><literal>\S</literal> - section symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-p">><literal>\P</literal> - paragraph symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-copyright">><literal>\copyright</literal> - copyright symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-pounds">><literal>\pounds</literal> - British pound sterling symbol - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5">Calligraphic Style Letters</bridgehead> - <para>Twenty-six calligraphic letters are - provided (the upper case alphabet). These - can only be used in math mode. - </para> - <para>In &latex; 2.09 they are produced with the - <literal>\cal</literal> declaration: - <programlisting>${\cal A}$</programlisting> - In &latex2e; they are obtained with the - <literal>\mathcal</literal> command: - <programlisting>$\mathcal{CAL}$</programlisting> - </para> - - <bridgehead renderas="sect5" id="math-functions-title">Math Functions</bridgehead> - <indexterm> - <primary>Math Functions</primary> - </indexterm> - <para>Functions like <emphasis>log</emphasis> or - <emphasis>cos</emphasis> are normally used in - math mode. However, inmath mode strings of letters - are treated as a product of variables, which - would normally be displayed in math italics rather - than a text font which would be appropriate for - these functions. To get proper display of such functions - they are generated with &latex; commands. - </para> - <para>Some of these commands are: - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-math-func-arccos"><literal>\arccos</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-arcsin"><literal>\arcsin</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-arctan"><literal>\arctan</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-cos"><literal>\cos</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-cosh"><literal>\cosh</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-cot"><literal>\cot</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-coth"><literal>\coth</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-csc"><literal>\csc</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-deg"><literal>\deg</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-det"><literal>\det</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-dim"><literal>\dim</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-exp"><literal>\exp</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-gcd"><literal>\gcd</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-hom"><literal>\hom</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-inf"><literal>\inf</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-ker"><literal>\ker</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-lg"><literal>\lg</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-lim"><literal>\lim</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-liminf"><literal>\liminf</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-limsup"><literal>\limsup</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-ln"><literal>\ln</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-log"><literal>\log</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-max"><literal>\max</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-min"><literal>\min</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sec"><literal>\sec</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sin"><literal>\sin</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sinh"><literal>\sinh</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sup"><literal>\sup</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-tan"><literal>\tan</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-tanh"><literal>\tanh</literal></simpara> - </listitem> - </itemizedlist> - </para> - <para>Two commands are provided for the "modulus" function - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-math-func-bmod"><literal>\bmod</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-pmod"><literal>\pmod{}</literal></simpara> - </listitem> - </itemizedlist> - The former would be used to write "a mod b" as - <literal>a \bmod b</literal> - and the latter, which requires an argument that is - displayed in parentheses, would be used to write - "n = i (mod j)" as <literal>n = i \pmod{j}</literal> - </para> - - <bridgehead renderas="sect5" id="variable-math-size-symbols-title">Variable Size Math Symbols</bridgehead> - <indexterm> - <primary>Math Symbols, Variable Size</primary> - </indexterm> - <para>The size of some mathematical symbols, notably - summation signs, product signs, and - integral signs, depends on the environment in which they - appear (i.e., <literal>displaymath</literal> - as opposed to <literal>math</literal> environments. - </para> - <para>These include: - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-math-symbol-sum"><literal>\sum</literal> - a summation sign (capital sigma)</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-prod"><literal>\prod</literal> - a product (capital pi)</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-coprod"><literal>\coprod</literal> - a coproduct (inverted capital pi)</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-int"><literal>\int</literal> - an integral sign</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-oint"><literal>\oint</literal> - a surface (circular) integral sign</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigcup"><literal>\bigcup</literal> - big "U"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigcap"><literal>\bigcap</literal> - big inverted "U"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigvee"><literal>\bigvee</literal> - big "V"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigwedge"><literal>\bigwedge</literal> - big inverted "V"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigodot"><literal>\bigodot</literal> - big "O" with dot at center</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigotimes"><literal>\bigotimes</literal> - big "O" with cross inside</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigoplus"><literal>\bigoplus</literal> - big "O" with a + inside</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-biguplus"><literal>\biguplus</literal> - big "U" with a + inside</simpara> - </listitem> - </itemizedlist> - </para> - <para>The <literal>\sqrt</literal> command also - produces a variable size symbol appropriate for - the size of hte radicand argument. - </para> - <para>The "limits" associated with these symbols are entered - as <emphasis>subscripts</emphasis> for entries appearing - below the symbol and as <emphasis>superscripts</emphasis> - for entries appearing above the symbol. - For example the sum from n=0 to infinity of - x<superscript>n</superscript> would be entered as - <programlisting>\sum_{n=0}^{\infty} x_{n}</programlisting> - The actual placement of the limits depends on whether - this is in <literal>displaymath</literal> mode in which - case they are placed below/above - or in <emphasis>math</emphasis> mode in running text - in which case they are placed as regular - subscripts and superscripts. - </para> - <para>Note that it is possible to treat several of - these symbols (a common example would be a double sum) - as a single symbol for placing limits above and/or - below by using the <literal>\mathop</literal> command. - </para> - <para><emphasis>Hats</emphasis> and - <emphasis>tildes</emphasis> over symbols which stretch - (as best they can) to the correct size for their - arguments are produced by <literal>\widehat</literal> - and <literal>\widetilde</literal> - </para> - - </section> - - - <section id="splitting-the-input"> - <title id="splitting-the-input-title">Splitting the Input</title> - <indexterm><primary>Splitting the input file</primary></indexterm> - <indexterm><primary>Input file, splitting</primary></indexterm> - - <para>A large document requires a lot of input. Rather than - putting the whole input in a single large file, it's more - efficient to split it into several smaller ones. - Regardless of how many separate files you use, there is - one that is the root file; it is the one whose name you - type when you run &latex;. - </para> - - <bridgehead renderas="sect5" id="cmd-include-title">\include</bridgehead> - <indexterm><primary>\include</primary></indexterm> - - <para><literal>\include{file}</literal> - </para> - <para>The <literal>\include</literal> command is used in - conjunction with the <literal>\includeonly</literal> - command for selective inclusion of files. The - <literal>file</literal> argument is the first name of a - file, denoting <filename>file.tex</filename>. If - <literal>file</literal> is one the file names in the - file list of the <literal>\includeonly</literal> command - or if there is no <literal>\includeonly</literal> - command, the <literal>\include</literal> command is - equivalent to - </para> - <programlisting> -\clearpage \input{file} \clearpage</programlisting> - - <para>except that if the file - <filename>file.tex</filename> does not exist, then a - warning message rather than an error is produced. If - the file is not in the file list, the - <literal>\include</literal> command is equivalent to - <literal>\clearpage</literal>. - </para> - <para>The <literal>\include</literal> command may not appear - in the preamble or in a file read by another - <literal>\include</literal> command. - </para> - - <bridgehead renderas="sect5" id="cmd-includeonly-title">\includeonly</bridgehead> - <indexterm><primary>\includeonly</primary></indexterm> - - <para><literal>\includeonly{</literal><emphasis>file_list</emphasis><literal>}</literal> - </para> - <para>The <literal>\includeonly</literal> command controls - which files will be read in by an - <literal>\include</literal> command. - <emphasis>file_list</emphasis> should be a - comma-separated list of filenames. Each filename must - match exactly a filename specified in a - <literal>\include</literal> command. This command can - only appear in the preamble. - </para> - - <bridgehead renderas="sect5" id="cmd-input-title">\input</bridgehead> - <indexterm><primary>\input</primary></indexterm> - - <para><literal>\input{file}</literal> - </para> - <para>The <literal>\input</literal> command causes the - indicated <literal>file</literal> to be read and processed, - exactly as if its contents had been inserted in the current - file at that point. The file name may be a complete file - name with extension or just a first name, in which case the - file <filename>file.tex</filename> is used. - </para> - - </section> - - - <section id="starting-and-ending"> - <title id="starting-and-ending-title">Starting & Ending</title> - <indexterm><primary>Starting & Ending</primary></indexterm> - <indexterm><primary>Ending & Starting</primary></indexterm> - - <para>Your input file must contain the following commands as a minimum: - </para> - <programlisting> -\documentclass{class} -\begin{document} - ... your text goes here ... -\end{document}</programlisting> - - <para>where the <literal>class</literal> selected is one of the - valid classes for &latex;. See <link linkend="document-classes">Document Classes</link> (and see - <link linkend="overview">&overview;</link>), for details of the - various document classes available locally. - </para> - <para>You may include other &latex; commands between the - <literal>\documentclass</literal> and the - <literal>\begin{document}</literal> commands (i.e., in the - `preamble'). - </para> - - </section> - - - <section id="table-of-contents"> - <title id="table-of-contents-title">Table of Contents</title> - <indexterm><primary>Table of Contents, creating</primary></indexterm> - - <para>A table of contents is produced with the - <literal>\tableofcontents</literal> - <indexterm><primary>\tableofcontents</primary></indexterm> - command. You put the command right where you want the table of - contents to go; &latex; does the rest for you. It produces a - heading, but it does not automatically start a new page. If - you want a new page after the table of contents, include a - <literal>\newpage</literal> command after the - <literal>\tableofcontents</literal> command. - </para> - <para>There are similar commands - <literal>\listoffigures</literal> - <indexterm><primary>\listoffigures</primary></indexterm> and - <literal>\listoftables</literal> - <indexterm><primary>\listoftables</primary></indexterm> for - producing a list of figures and a list of tables, - respectively. Everything works exactly the same as for the - table of contents. </para> - <para>NOTE: If you want any of - these items to be generated, you cannot have the - <literal>\nofiles</literal> - <indexterm><primary>\nofiles</primary></indexterm> command in - your document. - </para> - - <bridgehead renderas="sect5" id="cmd-addcontentsline-title">\addcontentsline</bridgehead> - <indexterm><primary>\addcontentsline</primary></indexterm> - - <para><literal>\addcontentsline{file}{sec_unit}{entry}</literal> - </para> - <para>The <literal>\addcontentsline</literal> command adds an - entry to the specified list or table where: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>file</literal> is the extension of the file - on which information is to be written: - <literal>toc</literal> (table of contents), - <literal>lof</literal> (list of figures), or - <literal>lot</literal> (list of tables). - </simpara></listitem> - <listitem> - <simpara><literal>sec_unit</literal> controls the formatting - of the entry. It should be one of the following, - depending upon the value of the file argument: - </simpara><orderedlist><listitem> - <simpara><literal>toc</literal> --- the name of the - sectional unit, such as part or subsection. - </simpara></listitem> - <listitem> - <simpara><literal>lof</literal> --- figure - </simpara></listitem> - <listitem> - <simpara><literal>lot</literal> --- table - </simpara></listitem> - </orderedlist> - </listitem> - <listitem> - <simpara><literal>entry</literal> is the text of the entry. - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-addtocontents-title">\addtocontents</bridgehead> - <indexterm><primary>\addtocontents</primary></indexterm> - - <para><literal>\addtocontents{file}{text}</literal> - </para> - <para>The <literal>\addtocontents</literal> command adds text - (or formatting commands) directly to the file that generates - the table of contents or list of figures or tables. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>file</literal> is the extension of the file - on which information is to be written: - <literal>toc</literal> (table of contents), - <literal>lof</literal> (list of figures), or - <literal>lot</literal> (list of tables). - </simpara></listitem> - <listitem> - <simpara><literal>text</literal> is the information to be - written. - </simpara></listitem> - </itemizedlist> - - </section> - - <section id="terminal-input-slash-output"> - <title id="terminal-input-slash-output-title">Terminal Input/Output</title> - <indexterm><primary>Input/Output</primary></indexterm> - <indexterm><primary>Terminal Input/Output</primary></indexterm> - - <bridgehead renderas="sect5" id="cmd-typein-title">\typein</bridgehead> - <indexterm><primary>\typein</primary></indexterm> - - <para><literal>\typein[cmd]{msg}</literal> - </para> - - <para>Prints <literal>msg</literal> on the terminal and - causes &latex; to stop and wait for you to type a line - of input, ending with return. If the - <literal>cmd</literal> argument is missing, the typed - input is processed as if it had been included in the - input file in place of the <literal>\typein</literal> - command. If the <literal>cmd</literal> argument is - present, it must be a command name. This command name - is then defined or redefined to be the typed input. - </para> - - <bridgehead renderas="sect5" id="cmd-typeout-title">\typeout</bridgehead> - <indexterm><primary>\typeout</primary></indexterm> - - <para><literal>\typeout{msg}</literal> - </para> - <para>Prints <literal>msg</literal> on the terminal and in the - <literal>log</literal> file. Commands in - <literal>msg</literal> that are defined with - <literal>\newcommand</literal> or - <literal>\renewcommand</literal> are replaced by their - definitions before being printed. - </para> - - <para>&latex;'s usual rules for treating multiple spaces - as a single space and ignoring spaces after a command - name apply to <literal>msg</literal>. A - <literal>\space</literal> command in - <literal>msg</literal> causes a single space to be - printed. A <literal>^^J</literal> in - <literal>msg</literal> prints a newline. - </para> - - </section> - - <section id="typefaces"> - <title id="typefaces-title">Typefaces</title> - <indexterm><primary>Typefaces</primary></indexterm> - <indexterm><primary>Fonts</primary></indexterm> - - <para>The <literal>typeface</literal> is specified by giving the - <emphasis>size</emphasis> and <emphasis>style</emphasis>. - A typeface is also called a <emphasis>font</emphasis>. - </para> - - <bridgehead renderas="sect5" id="styles-title">\Styles</bridgehead> - <indexterm><primary>Font Styles</primary></indexterm> - <indexterm><primary>Typeface Styles</primary></indexterm> - <indexterm><primary>Styles of text</primary></indexterm> - - <para>The following type style commands are supported by - &latex;. - </para> - <para>These commands are used like <literal>\textit{italics - text}</literal>. The corresponding command in parenthesis - is the <emphasis>declaration form</emphasis>, which - takes no arguments. The - scope of the declaration form lasts until the next type - style command or the end of the current group. - </para> - <para>The declaration forms are cumulative; i.e., you can say - <literal>\sffamily\bfseries</literal> to get sans serif - boldface. - </para> - <para>You can also use the environment form of the declaration - forms; e.g. - <literal>\begin{ttfamily}...\end{ttfamily}</literal>. - </para> - <table frame="none"> - <title>Typefaces</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>\textrm (\rmfamily) - <indexterm><primary>\textrm</primary></indexterm> - <indexterm><primary>\rmfamily</primary></indexterm> - </entry> - <entry>Roman. - </entry> - </row> - <row rowsep="0"><entry>\textit (\itshape) - <indexterm><primary>\textit</primary></indexterm> - <indexterm><primary>\itshape</primary></indexterm>, - \emph - <indexterm><primary>\emph</primary></indexterm> - </entry> - <entry>Emphasis (toggles between \textit and \textrm). - </entry> - </row> - <row rowsep="0"><entry>\textmd (\mdseries) - <indexterm><primary>\textmd</primary></indexterm> - <indexterm><primary>\mdseries</primary></indexterm> - </entry> - <entry>Medium weight (default). The opposite of - boldface. - </entry> - </row> - <row rowsep="0"><entry>\textbf (\bfseries) - <indexterm><primary>\textbf</primary></indexterm> - <indexterm><primary>\bfseries</primary></indexterm> - </entry> - <entry>Boldface. - </entry> - </row> - <row rowsep="0"><entry>\textup (\upshape) - <indexterm><primary>\textup</primary></indexterm> - <indexterm><primary>\upshape</primary></indexterm> - </entry> - <entry>Upright (default). The opposite of slanted. - </entry> - </row> - <row rowsep="0"><entry>\textsl (\slshape) - <indexterm><primary>\textsl</primary></indexterm> - <indexterm><primary>\slshape</primary></indexterm> - </entry> - <entry>Slanted. - </entry> - </row> - <row rowsep="0"><entry>\textsf (\sffamily) - <indexterm><primary>\textsf</primary></indexterm> - <indexterm><primary>\sffamily</primary></indexterm> - </entry> - <entry>Sans serif. - </entry> - </row> - <row rowsep="0"><entry>\textsc (\scshape) - <indexterm><primary>\textsc</primary></indexterm> - <indexterm><primary>\scshape</primary></indexterm> - </entry> - <entry>Small caps. - </entry> - </row> - <row rowsep="0"><entry>\texttt (\ttfamily) - <indexterm><primary>\texttt</primary></indexterm> - <indexterm><primary>\ttfamily</primary></indexterm> - </entry> - <entry>Typewriter. - </entry> - </row> - <row rowsep="0"><entry>\textnormal (\normalfont) - <indexterm><primary>\textnormal</primary></indexterm> - <indexterm><primary>\normalfont</primary></indexterm> - </entry> - <entry>Main document font. - </entry> - </row> - <row rowsep="0"><entry>\mathrm - <indexterm><primary>\mathrm</primary></indexterm> - </entry> - <entry>Roman, for use in math mode. - </entry> - </row> - <row rowsep="0"><entry>\mathbf - <indexterm><primary>\mathbf</primary></indexterm> - </entry> - <entry>Boldface, for use in math mode. - For bold symbols or complete equations take a look at - <link linkend="boldsymbol-linkend"><literal>\boldsymbol</literal></link> - and <link linkend="cmd-bm"><literal>\bm</literal></link>. - </entry> - </row> - <row rowsep="0"><entry>\mathsf - <indexterm><primary>\mathsf</primary></indexterm> - </entry> - <entry>Sans serif, for use in math mode. - </entry> - </row> - <row rowsep="0"><entry>\mathtt - <indexterm><primary>\mathtt</primary></indexterm> - </entry> - <entry>Typewriter, for use in math mode. - </entry> - </row> - <row rowsep="0"><entry>\mathit - <indexterm><primary>\mathit</primary></indexterm> - </entry> - <entry>Italics, for use in math mode, e.g. variable - names with several letters. - </entry> - </row> - <row rowsep="0"><entry>\mathnormal - <indexterm><primary>\mathnormal</primary></indexterm> - </entry> - <entry>For use in math mode, e.g. inside another type - style declaration. - </entry> - </row> - <row rowsep="0"><entry>\mathcal - <indexterm><primary>\mathcal</primary></indexterm> - </entry> - <entry>`Calligraphic' letters, for use in math mode. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>In addition, the command - <literal>\mathversion{bold}</literal> - <indexterm><primary>\mathversion</primary></indexterm> can - be used for switching to bold letters and symbols in - formulas. <literal>\mathversion{normal}</literal> restores - the default. - </para> - - <bridgehead renderas="sect5" id="sizes-title">Sizes</bridgehead> - <indexterm><primary>Font Sizes</primary></indexterm> - <indexterm><primary>Typeface Sizes</primary></indexterm> - <indexterm><primary>Sizes of text</primary></indexterm> - - <para>The following standard type size commands are supported - by &latex;. - </para> - <para>The commands as listed here are "declaration forms". The - scope of the declaration form lasts until the next type - style command or the end of the current group. - </para> - <para>You can also use the environment form of these commands; - e.g. <literal>\begin{tiny}...\end{tiny}</literal>. - </para> - <table frame="none"> - <title>Standard type size commands</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry>\tiny<indexterm> - <primary>\tiny</primary> - </indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\scriptsize - <indexterm><primary>\scriptsize</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\footnotesize - <indexterm><primary>\footnotesize</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\small - <indexterm><primary>\small</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\normalsize - <indexterm><primary>\normalsize</primary></indexterm> - </entry> - <entry>(default)</entry> - </row> - <row rowsep="0"> - <entry>\large - <indexterm><primary>\large</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\Large - <indexterm><primary>\Large</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\LARGE - <indexterm><primary>\LARGE</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\huge - <indexterm><primary>\huge</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\Huge - <indexterm><primary>\Huge</primary></indexterm> - </entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - - <bridgehead renderas="sect5" id="low-dash-level-font-commands-title">Low-level font commands</bridgehead> - <indexterm><primary>Low-level font commands</primary></indexterm> - <indexterm><primary>Font commands, low-level</primary></indexterm> - - <para>These commands are primarily intended for writers of - macros and packages. The commands listed here are only a - subset of the available ones. For full details, you - should consult Chapter 7 of <citetitle>The &latex; - Companion</citetitle>. - </para> - - <table frame="none"> - <title>Low-level font commands</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>\fontencoding{enc} - <indexterm><primary>\fontencoding</primary></indexterm> - </entry> - <entry>Select font encoding. Valid encodings include - <literal>OT1</literal> and <literal>T1</literal>. - </entry> - </row> - <row rowsep="0"><entry>\fontfamily{family} - <indexterm><primary>\fontfamily</primary></indexterm> - </entry> - <entry>Select font family. Valid families include: - <itemizedlist spacing="compact"> - <listitem><simpara><literal>cmr</literal> for - Computer Modern Roman - </simpara> - </listitem> - <listitem><simpara><literal>cmss</literal> for - Computer Modern Sans Serif - </simpara> - </listitem> - <listitem><simpara><literal>cmtt</literal> for - Computer Modern Typewriter - </simpara> - </listitem> - </itemizedlist> and numerous others. - </entry> - </row> - <row rowsep="0"><entry>\fontseries{series} - <indexterm><primary>\fontseries</primary></indexterm> - </entry> - <entry>Select font series. Valid series include: - - <itemizedlist spacing="compact"> - <listitem><simpara><literal>m</literal> Medium - (normal) - </simpara> - </listitem> - <listitem><simpara><literal>b</literal> Bold - </simpara> - </listitem> - <listitem><simpara><literal>c</literal> Condensed - </simpara> - </listitem> - <listitem><simpara><literal>bc</literal> Bold - condensed - </simpara> - </listitem> - <listitem><simpara><literal>bx</literal> Bold - extended - </simpara> - </listitem> - </itemizedlist> and various other combinations. - </entry> - </row> - <row rowsep="0"><entry>\fontshape{shape} - <indexterm><primary>\fontshape</primary></indexterm> - </entry> - <entry>Select font shape. Valid shapes are: - <itemizedlist spacing="compact"> - <listitem><simpara><literal>n</literal> Upright - (normal) - </simpara> - </listitem> - <listitem><simpara><literal>it</literal> Italic - </simpara> - </listitem> - <listitem><simpara><literal>sl</literal> Slanted - (oblique) - </simpara> - </listitem> - <listitem><simpara><literal>sc</literal> Small caps - </simpara> - </listitem> - <listitem><simpara><literal>ui</literal> Upright - italics - </simpara> - </listitem> - <listitem><simpara><literal>ol</literal> Outline - </simpara> - </listitem> - </itemizedlist> The two last shapes are not - available for most font families. - </entry> - </row> - <row rowsep="0"><entry>\fontsize{size}{skip} - <indexterm><primary>\fontsize</primary></indexterm> - </entry> - <entry>Set font size. The first parameter is the font - size to switch to; the second is the - <literal>\baselineskip</literal> to use. The unit of - both parameters defaults to pt. A rule of thumb is - that the baselineskip should be 1.2 times the font - size. - </entry> - </row> - <row rowsep="0"><entry>\selectfont - <indexterm><primary>\selectfont</primary></indexterm> - </entry> - <entry>The changes made by calling the four font - commands described above do not come into effect - until <literal>\selectfont</literal> is called. - </entry> - </row> - <row rowsep="0"><entry>\usefont{enc}{family}{series}{shape} - <indexterm><primary>\usefont</primary></indexterm> - </entry> - <entry>Equivalent to calling - <literal>\fontencoding</literal>, - <literal>\fontfamily</literal>, - <literal>\fontseries</literal> and - <literal>\fontshape</literal> with the given - parameters, followed by - <literal>\selectfont</literal>. - </entry> - </row> - </tbody> - </tgroup> - </table> - - </section> - - </section> - - <section id="parameters"> - <title id="parameters-title">Parameters</title> - <indexterm><primary>Parameters</primary></indexterm> - - <para>The input file specification indicates the file to be - formatted; &tex; uses <filename>.tex</filename> as a default file - extension. If you omit the input file entirely, &tex; accepts - input from the terminal. You specify command options by - supplying a string as a parameter to the command; e.g. - </para> - <para><literal>latex \scrollmode\input foo.tex</literal> - </para> - <para>will process <filename>foo.tex</filename> without pausing - after every error. - </para> - <para>Output files are always created in the current directory. - When you fail to specify an input file name, &tex; bases the - output names on the file specification associated with the - logical name TEX_OUTPUT, typically - <literal>texput.log</literal>. - </para> - - </section> - - </section> - - - <section id="latex-packages"> - <title id="latex-packages-title">&latex; Packages</title> - <indexterm><primary>LaTeX Packages</primary></indexterm> - - <section id="amsmath"> - <title id="amsmath-title"><filename role="nohyphenation">amsmath</filename></title> - <indexterm><primary>amsmath</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>amsmath</secondary> - </indexterm> - <para><literal>amsmath</literal> consists of several packages - to aid in typesetting math. - </para> - <para> - <variablelist id="boldsymbol-linkend" role="db2latex:compact"> - <varlistentry> - <term><literal>\boldsymbol</literal></term> - <listitem> - <indexterm> - <primary>\boldsymbol</primary> - </indexterm> - <para>Produces a bold math symbol. When not only - a single symbol, but a complete equation has to - be bold you might consider using the superior - <link linkend="cmd-bm"><literal>\bm</literal></link> - command which takes - better care of spacing.</para> - </listitem> - </varlistentry> - <varlistentry id="pmb-linkend"> - <term><literal>\pmb</literal></term> - <listitem> - <indexterm> - <primary>\pmb</primary> - </indexterm> - <para>Can be used for mathematic symbols, when no - bold version is available. It prints the standard - symbol several times slightly shifted and is - inferior to a real bold font! - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="dcolumn"> - <title id="dcolumn-title"><filename role="nohyphenation">dcolumn</filename></title> - <indexterm><primary>dcolumn</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>dcolumn</secondary> - </indexterm> - <para><literal>\usepackage{dcolumn}</literal></para> - <para>Defines a system for defining columns of entries in an - <literal>array</literal> or <literal>tabular</literal> - which are to be aligned on a - <emphasis>decimal point</emphasis>. - </para> - <para> - This package defines <literal>D</literal> to be a column - specifier with three arguments: - <programlisting>D{sep.tex}{sep.dvi}{decimal places}</programlisting> - </para> - <para><literal>sep.tex</literal> should be a single character, - this is used as the separator in the <literal>.tex</literal> - file. It will usually be '<literal>.</literal>' or - '<literal>,</literal>'. - </para> - <para><literal>sep.dvi</literal> is used as the separator in the - output. - </para> - <para><literal>decimal places</literal> should be the maximum - number of decimal places in the column. - </para> - <para><literal>\newcolumntype</literal> can be used to define - own column types. - </para> - </section> - - - - <section id="float"> - <title id="float-title"><filename role="nohyphenation">float</filename></title> - <indexterm><primary>float</primary></indexterm> - <note> - <para>The contents of this section was taken from - the documentation of <filename>float</filename> v1.3d of 2001/11/08. - </para> - </note> - - <para><quote>This style option improves the interface for defining - objects such as figures and tabels in &latex;. It adds the - notion of a <emphasis>float style</emphasis> that governs the - appearance of floats.</quote> - </para> - - <variablelist role="db2latex:compact"> - - <varlistentry> - <term><literal>\newfloat{<placement>}{<ext>}[<within>]</literal></term> - <listitem> - <indexterm><primary>\newfloat</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\newfloat</secondary> - </indexterm> - <para>Add a new class of floats.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\floatstyle{<style>}</literal></term> - <listitem> - <indexterm><primary>\floatstyle</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\floatstyle</secondary> - </indexterm> - <para>Sets a default float style.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\floatname{<style>}{<name>}</literal></term> - <listitem> - <indexterm><primary>\floatname</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\floatname</secondary> - </indexterm> - <para>Define the <emphasis>float name</emphasis> used - in the caption of a float.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\floatplacement{<>}{<placement>}</literal></term> - <listitem> - <indexterm><primary>\floatplacement</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\floatplacement</secondary> - </indexterm> - <para>Resets the default placement specifier of a class of floats.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\restylefloat<style></literal></term> - <listitem> - <indexterm><primary>\restylefloat</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\restylefloat</secondary> - </indexterm> - <para>Change styles for the standard float types - <literal>figure</literal> and <literal>table</literal>.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\listof{<type>}{<title>}</literal></term> - <listitem> - <indexterm><primary>\listof</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\listof</secondary> - </indexterm> - <para>Produces a list of all floats of a given class.</para> - </listitem> - </varlistentry> - </variablelist> - - </section> - - - <section id="fontenc"> - <title id="fontenc-title"><filename role="nohyphenation">fontenc</filename></title> - <indexterm><primary>fontenc</primary></indexterm> - - <para><literal>\usepackage[T1]{fontenc}</literal> - </para> - <para> - chooses T1-fonts and allows correct automatic hyphenation. - </para> - </section> - - <section id="german"> - <title id="german-title"><filename role="nohyphenation">german</filename></title> - <indexterm><primary>german</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>german</secondary> - </indexterm> - <para>Das <literal>german</literal> Paket muß geladen sein:</para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>"a</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"a</secondary> - </indexterm> - <para>erzeugt ein <emphasis>ä</emphasis></para> - <para>entsprechend <literal>"o</literal>, - <literal>"u</literal>, <literal>"A</literal>, - <literal>"O</literal>, <literal>"U</literal>, - <literal>"s (ß)</literal></para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"ck</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"ck</secondary> - </indexterm> - <para>wird bei Trennung zu <literal>k-k</literal></para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"ff</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"ff</secondary> - </indexterm> - <para>wird bei Trennung zu <literal>ff-f</literal> - </para> - <para>entsprechend <literal>"ll</literal>, - <literal>"mm</literal>, <literal>"pp</literal>, - <literal>"rr</literal>, <literal>"tt</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\glqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\glqq</secondary> - </indexterm> - <para>oder <literal>"`</literal> - erzeugt untere doppelte Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry id="cmd-grqq"> - <term><literal>\grqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\grqq</secondary> - </indexterm> - <para>oder <literal>"'</literal> - erzeugt obere doppelte Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\glq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\glq</secondary> - </indexterm> - <para>erzeugt untere einfache Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\flqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\flqq</secondary> - </indexterm> - <para>oder <literal>"<</literal> - doppelte linke französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\frqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\frqq</secondary> - </indexterm> - <para>oder <literal>"></literal> - doppelte rechte französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\flq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\flq</secondary> - </indexterm> - <para>einfache linke französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\frq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\frq</secondary> - </indexterm> - <para>einfache rechte französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"|</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"|</secondary> - </indexterm> - <para>verhindert eine Ligatur an der Stelle</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\-</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\-</secondary> - </indexterm> - <para>markiert mögliche Trennstelle, im restlichen - Wort ist keine Trennung mehr möglich - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"-</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>!-</secondary> - </indexterm> - <para>Trennvorschlag, der Rest des Wortes kann - noch automatisch getrennt werden - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>""</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>""</secondary> - </indexterm> - <para>Trennvorschlag, bei dem bei einer Trennung - kein Bindestrich eingefügt wird - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"~</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"~</secondary> - </indexterm> - <para>Bindestrich, an dem nicht getrennt werden darf</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"=</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"=</secondary> - </indexterm> - <para>Bindestrich, an dem getrennt werden darf</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\dq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\dq</secondary> - </indexterm> - <para>erzeugt ein nicht-typographisches gerades - Anführungszeichen - </para> - <programlisting>\texttt{\dq}</programlisting> - </listitem> - </varlistentry> - <varlistentry> - <term><literal><</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary><</secondary> - </indexterm> - <para>oder <literal>\dq</literal> ergibt das - Zoll-Zeichen - </para> - </listitem> - </varlistentry> - </variablelist> - - </para> - </section> - - <section id="graphics"> - <title id="graphics-title"><filename role="nohyphenation">graphics</filename></title> - <indexterm><primary>graphics</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>graphics</secondary> - </indexterm> - <para>Look up details in <filename>grfguide</filename>.</para> - - <section id="includegraphics"> - <title id="includegraphics-title">\includegraphics</title> - <indexterm><primary>\includegraphics</primary></indexterm> - <para><literal>\includegraphics[]{picture-name}</literal> - </para> - <para> - File extensions of the graphics should be omitted, so it's - easier to change the format (for example for pdf or ps - output). - </para> - </section> - - <section id="graphicspath"> - <title id="graphicspath-title">\graphicspath</title> - <indexterm><primary>\graphicspath</primary></indexterm> - <para><literal>\graphicspath{dir-list}</literal> - </para> - <para><literal>dir-list</literal> is a list of absolute or - relative paths, where the command - <link linkend="includegraphics"><literal>\includegraphics{}</literal></link> - searches for the graphic files: - </para> - <para><literal>\graphicspath{{eps/}{tiff/}}</literal> would - cause the system to look in the subdirectories - <literal>eps</literal> and <literal>tiff</literal> of the - current directory. This is unix syntax, on a Mac it would - be: - </para> - <para><literal>\graphicspath{{:eps:}{:tiff:}}</literal> - </para> - <para>Under Windows/DOS use also the slash - <literal>/</literal> to separate directories. Not all tex - installations can handle filenames with spaces. So it's - better to avoid them. - </para> - </section> - - </section> - - <section id="hyperref"> - <title id="hyperref-title"><filename role="nohyphenation">hyperref</filename></title> - <indexterm> - <primary>hyperref</primary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>hyperref</secondary> - </indexterm> - <para>For more infos read in the book - <emphasis>&latex; Web Companion</emphasis> - or <emphasis>Mit &latex; ins Web</emphasis>. - </para> - - <section id="hyperref-options"> - <title id="hyperref-options-title">Options</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term>4</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>4</tertiary> - </indexterm> - <para> - use Acrobat 4 features (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>a4paper, a5paper, b5paper, legalpaper, letterpaper, - executivepaper - </term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>a4paper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>a5paper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>b5paper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>legalpaper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>letterpaper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>executivepaper</tertiary> - </indexterm> - <para> - use the specified paper size. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>anchorcolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>anchorcolor</tertiary> - </indexterm> - <para> - set color of anchors (default: <literal>black</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>backref</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>backref</tertiary> - </indexterm> - <para> - do bibliographical back references (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>baseurl</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>baseurl</tertiary> - </indexterm> - <para> - set base URL for document - (default: <literal>empty</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarks</tertiary> - </indexterm> - <para> - make bookmarks (default: <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarksnumbered</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarksnumbered</tertiary> - </indexterm> - <para> - put section numbers in bookmarks (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarksopen</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarksopen</tertiary> - </indexterm> - <para> - open up bookmark tree (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarksopenlevel</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarksopenlevel</tertiary> - </indexterm> - <para> - level to which bookmarks are open - (default: <literal>\maxdimen</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarkstype</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarkstype</tertiary> - </indexterm> - <para> - to specify which `toc' file to mimic toc. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>breaklinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>breaklinks</tertiary> - </indexterm> - <para> - allow links to break over lines (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>citebordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>citebordercolor</tertiary> - </indexterm> - <para> - color of border around cites (default: - <literal>0 1 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>citecolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>citecolor</tertiary> - </indexterm> - <para> - color of citation links (default: <literal>green</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>colorlinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>colorlinks</tertiary> - </indexterm> - <para> - color links (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>debug</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>debug</tertiary> - </indexterm> - <para> - provide details of anchors defined - (same as verbose, default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>draft</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>draft</tertiary> - </indexterm> - <para> - do not do any hyper linking (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>dvipdf, dvipdfm, dvips, dvipsone, dviwindo, hypertex</term> - <term>latex2html, pdftex, tex4ht, textures, ps2pdf, vtex</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvipdf</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvipdfm</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvips</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvipsone</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dviwindo</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hypertex</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>latex2html</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdftex</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>tex4ht</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>vtex</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>textures</tertiary> - </indexterm> - <para> - use the specified backend. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>extension</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>extension</tertiary> - </indexterm> - <para> - suffix of linked files (default: <literal>dvi</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>filebordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>filebordercolor</tertiary> - </indexterm> - <para> - color of border around file links (default: - <literal>0 .5 .5</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>filecolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>filecolor</tertiary> - </indexterm> - <para> - color of file links (default: <literal>cyan</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>frenchlinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>frenchlinks</tertiary> - </indexterm> - <para> - use small caps instead of color for links (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyperfigures</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hyperfigures</tertiary> - </indexterm> - <para> - make figures hyper links (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyperindex</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hyperindex</tertiary> - </indexterm> - <para> - set up hyperlinked indices (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hypertexnames</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hypertexnames</tertiary> - </indexterm> - <para> - use guessable names for links (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>implicit</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>implicit</tertiary> - </indexterm> - <para> - redefine &latex; internals (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linkbordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>linkbordercolor</tertiary> - </indexterm> - <para> - color of border around links (default: - <literal>1 0 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linkcolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>linkcolor</tertiary> - </indexterm> - <para> - color of links (default: <literal>red</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linktocpage</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>linktocpage</tertiary> - </indexterm> - <para> - make page number, not text, be link on TOC, LOF and LOT - (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>menubordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>menubordercolor</tertiary> - </indexterm> - <para> - color of border around menu links (default: - <literal>1 0 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>menucolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>menucolor</tertiary> - </indexterm> - <para> - color for menu links (default: <literal>red</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>naturalnames</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>naturalnames</tertiary> - </indexterm> - <para> - use &latex;-computed names for links (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>nesting</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>nesting</tertiary> - </indexterm> - <para> - allow nesting of links (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pageanchor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pageanchor</tertiary> - </indexterm> - <para> - put an anchor on every page (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pagebackref</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pagebackref</tertiary> - </indexterm> - <para> - backreference by page number (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pagebordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pagebordercolor</tertiary> - </indexterm> - <para> - color of border around page links (default: - <literal>1 1 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pagecolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pagecolor</tertiary> - </indexterm> - <para> - color of page links (default: <literal>red</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfauthor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfauthor</tertiary> - </indexterm> - <para> - text for PDF Author field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfborder</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfborder</tertiary> - </indexterm> - <para> - width of PDF link border - (default: <literal>0 0 1</literal>; - <literal>0 0 0</literal> for <literal>colorlinks</literal>) - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfcenterwindow</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfcenterwindow</tertiary> - </indexterm> - <para> - position the document window center of the screen - (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfcreator</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfcreator</tertiary> - </indexterm> - <para> - text for PDF Creator field - (default: &latex; with hyperref package). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdffitwindow</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdffitwindow</tertiary> - </indexterm> - <para> - resize document window to fit document size (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfhighlight</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfhighlight</tertiary> - </indexterm> - <para> - set highlighting of PDF links (default: - <literal>/I</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfkeywords</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfkeywords</tertiary> - </indexterm> - <para> - text for PDF Keywords field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfmenubar</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfmenubar</tertiary> - </indexterm> - <para> - make PDF viewer's menu bar visible (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfnewwindow</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfnewwindow</tertiary> - </indexterm> - <para> - make links that open another PDF file start a new window - (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagelayout</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagelayout</tertiary> - </indexterm> - <para> - set layout of PDF pages (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagemode</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagemode</tertiary> - </indexterm> - <para> - set default mode of PDF display (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagescrop</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagescrop</tertiary> - </indexterm> - <para> - set crop size of PDF document (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagetransition</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagetransition</tertiary> - </indexterm> - <para> - set PDF page transition style (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfproducer</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfproducer</tertiary> - </indexterm> - <para> - text for PDF Producer field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfstartpage</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfstartpage</tertiary> - </indexterm> - <para> - page at which PDF document opens (default: - <literal>1</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfstartview</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfstartview</tertiary> - </indexterm> - <para> - starting view of PDF document (default: - <literal>/Fit</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfsubject</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfsubject</tertiary> - </indexterm> - <para> - text for PDF Subject field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdftitle</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdftitle</tertiary> - </indexterm> - <para> - text for PDF Title field(default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdftoolbar</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdftoolbar</tertiary> - </indexterm> - <para> - make PDF toolbar visible (default: <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfview</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfview</tertiary> - </indexterm> - <para> - PDF `view' when on link traversal (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfwindowui</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfwindowui</tertiary> - </indexterm> - <para> - make PDF user interface elements visible (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>plainpages</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>plainpages</tertiary> - </indexterm> - <para> - do page number anchors as plain arabic (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>raiselinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>raiselinks</tertiary> - </indexterm> - <para> - raise up links (for HyperTeX backend; default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>runbordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>runbordercolor</tertiary> - </indexterm> - <para> - color of border around run links (default: - <literal>0 .7 .7</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>unicode</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>unicode</tertiary> - </indexterm> - <para> - Unicode encoded pdf strings (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>urlbordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>urlbordercolor</tertiary> - </indexterm> - <para> - color of border around URL links (default: - <literal>0 1 1</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>urlcolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>urlcolor</tertiary> - </indexterm> - <para> - color of URL links (default: <literal>magenta</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>verbose</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>verbose</tertiary> - </indexterm> - <para> - be chatty (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="hyperref-commands"> - <title id="hyperref-commands-title">Commands</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\texorpdfstring{TeX-string}{pdf-string}</literal> - </term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\texorpdfstring</tertiary> - </indexterm> - <para>allows different texts for PDF or &tex; creation. - <programlisting>\section{The role of \texorpdfstring{H$_2$O}{water}}</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry id="href"> - <term><literal>\href{URL}{Text}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\href</tertiary> - </indexterm> - <para>the text will be resolved into a URL. - The URL must be complete, according to a - base-url which might be defined in a - <link linkend="cmd-hyperbaseurl"><literal>\hyperbaseurl</literal></link>. - <programlisting> -\href{http://www.karpfenteich.net/pit/}{Peter's input tips}</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term id="cmd-hyperbaseurl"><literal>\hyperbaseurl{URL}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperbaseurl</tertiary> - </indexterm> - <para>defines a base URL, which is preset to a given URL. - This helps to make portable documents. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\hyperimage{image-URL}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperimage</tertiary> - </indexterm> - <para>includes the picture of the URL reference. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\hyperref{URL}{category}{name}{text}</literal></term> - <term><literal>\hyperref[mark]{text}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperref</tertiary> - </indexterm> - <para><literal>text</literal> is activated as a - hyperlink to the point which is defined with a - <link linkend="cmd-label-title"><filename role="nohyphenation">\label</filename></link> - command with the symbolic name <literal>mark</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\hyperlink{name}{text}</literal></term> - <term><literal>\hyertarget{name}{text}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperlink</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hypertarget</tertiary> - </indexterm> - <para><literal>\hyperlink</literal> creates an internal - link to an object which is somewhere defined with - a <literal>\hypertarget</literal> command. - </para> - <para>For HTML the command <literal>\hyperlink</literal> - inserts a <literal>#</literal> character in - front of each link. Thus it'll refer to the - topical document, - while <literal>\href</literal> will expect a complete URL. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\autoref{marker}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\autoref</tertiary> - </indexterm> - <para><literal>\autoref</literal> is a substitution - for the standard <literal>\ref</literal> command. - It inserts a context sensitive phrase. - <programlisting>see \autoref{foo}</programlisting> - </para> - <para>for a <literal>\label</literal> in a section - will output <emphasis>see section 3</emphasis> for an example. - </para> - <para>There are macros to change the default output - with the help of the <literal>\renewcommand</literal>: - <programlisting> -\figurename *\figurename* -\tablename *\tablename* -\partname *\partname* -\appendixname *\appendixname* -\equationname *\equationname* -\Itemname *\Itemname* -\chaptername *\chaptername* -\sectionname *\sectionname* -\subsectionname *\subsesctionname* -\subsubsectionname *\subsubsectionname* -\paragraphname *\paragraphname* -\Hfootnotename *\Hfootnotename* -\AMSname *\AMSname* -\theoremname *\theoremname*</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term id="cmd-nolinkurl"><literal>\nolinkurl</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\nolinkurl</tertiary> - </indexterm> - <para>Allows line breaks in a verbatim like - environment like <literal>\url</literal>, but - without the hyperlink function. This is - useful to define own commands like this example: - <programlisting> -\newcommand*{\urlw}[1]{\href{http://www.#1}% - {\nolinkurl{www.#1}}}</programlisting> - </para> - <para>This new defined command <literal>\urlw</literal> - allows the user to typeset a linkable (this - function is offered by - <literal>\href</literal>) - <literal>www.example.org</literal> address in the - latex source like this: - <programlisting> -\urlw{example.org}</programlisting> - </para> - <para>This will produce the string - <literal>www.example.org</literal> which - is hyperlinked and breakable (when the driver like - &pdftex; allows line breaks in links). - </para> - </listitem> - </varlistentry> - </variablelist> - - </section> - </section> - - <section id="inputenc"> - <title id="inputenc-title"><filename role="nohyphenation">inputenc</filename></title> - <indexterm><primary>inputenc</primary></indexterm> - - <para><literal>\usepackage[encoding name]{inputenc}</literal> - </para> - <para>Allows to specify an input encoding for direct input of - character codes > 127, e.g. accented characters. - </para> - <para>Important encodings are: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>latin9, latin1</literal></term> - <listitem> - <simpara>Linux, Unix, VMS</simpara> - <indexterm><primary>latin1</primary></indexterm> - <indexterm><primary>latin9</primary></indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>ansinew</literal></term> - <listitem> - <simpara>Windows (codepage 1252)</simpara> - <indexterm><primary>ansinew</primary></indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>cp850</literal></term> - <listitem> - <simpara>OS/2, MSDOS (codpage 850)</simpara> - <indexterm><primary>cp850</primary></indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>applemac</literal></term> - <listitem> - <simpara>Apple Macintosh</simpara> - <indexterm><primary>applemac</primary></indexterm> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="komascript"> - <title id="komascript-title"><filename role="nohyphenation">&komascript;</filename></title> - <indexterm><primary>&komascript;</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>&komascript;</secondary> - </indexterm> - <para>The <literal>&komascript;</literal> package has a - very detailed and well written documentation. - Read the <literal>scrguide</literal> for further information! :-) - </para> - - <!-- --> - <section id="komascript-page-layout"> - <title id="komascript-page-layout-title">Page-Layout</title> - <para><literal>\typearea[BCOR]{DIV}</literal></para> - <indexterm> - <primary>\typearea</primary> - </indexterm> - <para><literal>\areaset[BCOR]{Breite}{Höhe}</literal></para> - <indexterm> - <primary>\areaset</primary> - </indexterm> - </section> - - <section id="komascript-options"> - <title id="komascript-options-title">Options</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term>headinclude, headexclude</term> - <term>footinclude, footexclude</term> - <listitem> - <indexterm> - <primary>headinclude</primary> - </indexterm> - <indexterm> - <primary>headexclude</primary> - </indexterm> - <indexterm> - <primary>footinclude</primary> - </indexterm> - <indexterm> - <primary>footexclude</primary> - </indexterm> - <para>will determine if headers and footers are used in the - calculation of the page size. Default is exclude. - Include will make the text area smaller. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>DIV</term> - <listitem> - <indexterm> - <primary>DIV</primary> - </indexterm> - <para>is a factor which determins how large the used page - size is. This method takes care of good - typography. - </para> - <para>Try values between 10 and 15. Higher values - will cause smaller margins. An example would be: - <literal>DIV12</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>BCOR</term> - <listitem> - <indexterm> - <primary>BCOR</primary> - </indexterm> - <para>Binding correction. Takes care of the loss of the - visible paper size when the paper is cut and a book is - bound. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="komascript-scrlttr2"> - <title id="komascript-scrlttr2-title">Letter Class <literal>scrlttr2</literal></title> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - </indexterm> - - <para>This reference is based on the excellent - <literal>scrguien.pdf</literal> from 2002-09-06. - </para> - - <bridgehead renderas="sect5">Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>options</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Defining Options Later</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\KOMAoptions{}</tertiary> - </indexterm> - <para> - <variablelist> - <varlistentry> - <term><literal>\KOMAoptions{options list}</literal></term> - <listitem> - <simpara>Use this to change options after loading the - class. List single or multiple options, - separated by commas. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Page Layout Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>page layout</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>paper=format</literal></term> - <listitem> - <simpara>Defines the paper format.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>BCOR=length</literal></term> - <term><literal>DIV=value</literal></term> - <term><literal>headlines=count</literal></term> - <listitem> - <simpara>Divisor, binding correction, and number - of headlines.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>enlargefirstpage</literal></term> - <listitem> - <simpara>If <emphasis>true</emphasis> some more - text would fit on the first page - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Other Layout Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>other layout</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>other layout</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>twoside</literal></term> - <listitem> - <simpara>Activate possibilities of a double-sided - document, but stay with with the one-sided - layout as far as possible.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>cleardoublepage=style</literal></term> - <listitem> - <simpara>Inserted pages by - <literal>\cleardoublepage</literal> get one of - these page styles: - </simpara> - <para> - <itemizedlist> - <listitem> - <simpara><literal>empty</literal></simpara> - </listitem> - <listitem> - <simpara><literal>plain</literal></simpara> - </listitem> - <listitem> - <simpara><literal>standard</literal></simpara> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headsepline</literal></term> - <term><literal>footsepline</literal></term> - <listitem> - <simpara>Insert a separator line below the head or - above the foot.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>mpinclude</literal></term> - <term><literal>mpexclude</literal></term> - <listitem> - <simpara>These two options of the - <literal>typearea</literal> package should not - be used with <literal>scrlttr2</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagenumber=position</literal></term> - <listitem> - <simpara>This option defines if and where a page - number will be placed. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>bot</literal></term> - <term><literal>foot</literal></term> - <listitem> - <simpara>Page number in foot, horizontal - position not changed</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>botcenter</literal></term> - <term><literal>botcentered</literal></term> - <term><literal>botmiddle</literal></term> - <term><literal>footcenter</literal></term> - <term><literal>footcentered</literal></term> - <term><literal>footmiddle</literal></term> - <listitem> - <simpara>Page number infoot,centered</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>botleft</literal></term> - <term><literal>footleft</literal></term> - <listitem> - <simpara>Page number in foot, left - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>botrigth</literal></term> - <term><literal>footright</literal></term> - <listitem> - <simpara>Page number in foot, right - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>center</literal></term> - <term><literal>centered</literal></term> - <term><literal>middle</literal></term> - <listitem> - <simpara>Page number centered - horizontally, vertical position not - changed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>no</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>No page number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>head</literal></term> - <term><literal>top</literal></term> - <listitem> - <simpara>Page number in head, horizontal - position not changed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headcenter</literal></term> - <term><literal>headcentered</literal></term> - <term><literal>headmiddle</literal></term> - <term><literal>topcenter</literal></term> - <term><literal>topcentered</literal></term> - <term><literal>topmiddle</literal></term> - <listitem> - <simpara>Page number in head, centered</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headleft</literal></term> - <term><literal>topleft</literal></term> - <listitem> - <simpara>Page number in head, left - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headright</literal></term> - <term><literal>topright</literal></term> - <listitem> - <simpara>Page number in head, right - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>left</literal></term> - <listitem> - <simpara>Page number left, vertical - position not changed</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>right</literal></term> - <listitem> - <simpara>Page number right, vertical - position not changed - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>botcenter</literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>parskip=value</literal></term> - <listitem> - <simpara>Mark paragraphs alternatively by vertical - skip. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>Paragraph indentation instead of - verticalk space</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full</literal></term> - <term><literal>on</literal></term> - <term><literal>true</literal></term> - <listitem> - <simpara>One line vertical space between - paragraphs; at least 1 em free space in - the last line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full*</literal></term> - <listitem> - <simpara>One line vertical space betwen - paragraphs; at least a quarter of a line - free space at the end of a paragraph. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full+</literal></term> - <listitem> - <simpara>One line vertical space betwen - paragraphs; at least a third of aline free - space at the end of a paragraph.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full-</literal></term> - <listitem> - <simpara>One line vertical space betwen - paragraphs; last line of a paragraph may - be arbitrarily filled.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half</literal></term> - <listitem> - <simpara>Half a line vertical space - between paragraphs; at least 1 em free - space in the last line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half*</literal></term> - <listitem> - <simpara>Half a line vertical space - between paragraphs; at least a quarter of - a line free space at the end of a - paragraph. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half+</literal></term> - <listitem> - <simpara>Half a line vertical space - between paragraphs; at least a third of - a line free space at the end of a - paragraph. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half-</literal></term> - <listitem> - <simpara>One line vertical space between - paragraphs; last line may be arbitrarily - filled.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>false</literal>.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Font Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>font options</tertiary> - </indexterm> - <para> - <variablelist> - <varlistentry> - <term><literal>fontsize=size</literal></term> - <listitem> - <simpara>Font size of the document. Defaults - to <literal>12pt</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Options for Letterhead and Address</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>options for letterhead and address</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>fromalign</literal></term> - <listitem> - <simpara>Defines the placement of the from address - in the letterhead. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>center</literal></term> - <term><literal>centered</literal></term> - <term><literal>middle</literal></term> - <listitem> - <simpara>Return address centered.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>no</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>Standard design for return - address. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>left</literal></term> - <listitem> - <simpara>Left justified return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>rigth</literal></term> - <listitem> - <simpara>Right justified return address. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>left</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromrule</literal></term> - <listitem> - <simpara>Allows to place a horizontal rule within - return address. Possible values are: - </simpara> - <para><variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>afteraddress</literal></term> - <term><literal>below</literal></term> - <term><literal>true</literal></term> - <term><literal>yes</literal></term> - <listitem> - <simpara>Line below return address</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>aftername</literal></term> - <listitem> - <simpara>Line right below sender's name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>no</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>No line.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>false</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromphone</literal></term> - <listitem> - <simpara>Defines whether the phone number will be - part of the return address. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromfax</literal></term> - <listitem> - <simpara>Defines whether the facsimile number will - be part of the return address. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromemail</literal></term> - <listitem> - <simpara>Defines whether the email address will - be part of the return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromurl</literal></term> - <listitem> - <simpara>Defines whether the URL will - be part of the return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromlogo</literal></term> - <listitem> - <simpara>Defines whether the logo will - be part of the return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>addrfield</literal></term> - <listitem> - <simpara>Defines whether a return address field - will be set. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>backaddress</literal></term> - <listitem> - <simpara>Defines whether a return address for - window envelopes will be set. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <listitem> - <simpara>Choose of your subject should have a - title and if the subject should be set before or - after the opening. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>afteropening</literal></term> - <listitem> - <simpara>Set subject after opening.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>beforeopening</literal></term> - <listitem> - <simpara>Set subject before opening.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>titled</literal></term> - <listitem> - <simpara>Add title to subject.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>untitled</literal></term> - <listitem> - <simpara>Do not add title to subject.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Defaults are - <literal>beforeopening</literal> and - <literal>untitled</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>locfield</literal></term> - <listitem> - <simpara>Toggle between presets for the field - width of additionbal sender attributes. - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>narrow</literal></term> - <listitem> - <simpara>Small sender supplement field. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>wide</literal></term> - <listitem> - <simpara>Wide sender supplement field. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>narrow</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>foldmarks</literal></term> - <listitem> - <simpara>Activates fold marks.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>numericaldate</literal></term> - <listitem> - <simpara>Toggles between standard, - language-dependent date presentation and a - short, numerical one.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>refline</literal></term> - <listitem> - <simpara>Defines that the reference line may - extend beyond the normal type area. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Format Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>format options</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>draft</literal></term> - <listitem> - <simpara>Toggles between the final and the draft - version. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Letter Class Option Files</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>letter class option files</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\LoadLetterOption{name}</literal></term> - <listitem> - <simpara>Load a <literal>lco</literal> - file. <literal>name</literal> is the filename - without suffix. - </simpara> - <para> - Predefined <literal>lco</literal> files: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>DIN</literal></term> - <listitem> - <simpara>For A4 size paper, complying with - DIN 676. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>DINmtext</literal></term> - <listitem> - <simpara>For A4 size paper, complying with - DIN 676, but using an alternate layout - with more text on the first page. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>KOMAold</literal></term> - <listitem> - <simpara>Fo AQ4 paper size using a layout - close to the obsolete - <literal>scrlettr</literal> class. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>SN</literal></term> - <listitem> - <simpara>For Swiss letters with address - field on the right side, according to - SN 010 130 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>SNleft</literal></term> - <listitem> - <simpara>For Swiss letters with address - field on the left side. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\LetterOptionNeedsPaperSize{option - name}{paper size}</literal></term> - <listitem> - <simpara>Useful to be abel to emit warnings if the - user selects a different paper size from the one - the <literal>lco</literal> file is based on. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <!-- FIXME: bridgehead --> - <bridgehead renderas="sect5">General Document Properties</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>general document properties</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Font Selection</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>font selection</tertiary> - </indexterm> - <para>See also the section for - <emphasis>Changing Fonts</emphasis> in &komascript; - (still to be written). - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>backaddress</literal></term> - <listitem> - <simpara>Back address for a window envelope</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>descriptionlabel</literal></term> - <listitem> - <simpara>Label in a - <literal>description</literal> environment - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromaddress</literal></term> - <listitem> - <simpara>Sender's address in letterhead</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromname</literal></term> - <listitem> - <simpara>Sender's address in letterhead - if different from <literal>fromaddress</literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagefoot</literal></term> - <listitem> - <simpara>Footer, sometimes header of a page</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagehead</literal></term> - <listitem> - <simpara>Header, sometimes footer of a page</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagenumber</literal></term> - <listitem> - <simpara>Page number in footer or header</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <listitem> - <simpara>Subject in the opening</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>title</literal></term> - <listitem> - <simpara>Headline in the opening</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Page Style</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>page style</tertiary> - </indexterm> - <para>See also the section for - <emphasis>Page Style</emphasis> in &komascript; - (still to be written). - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>empty</literal></term> - <listitem> - <simpara>Entirely empty headers and footers</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>plain</literal></term> - <listitem> - <simpara>Empty head and and only page number - in header or footer - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headings</literal></term> - <listitem> - <simpara>Automatic page headings</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>myheadings</literal></term> - <listitem> - <simpara>Manual page headings - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Variables</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>variables</tertiary> - </indexterm> - <para>The main difference between a - <emphasis>command</emphasis> and a - <emphasis>variable</emphasis> is that a - command usually triggers an action whereas a variable - only consists of plain text. Furthermore a variable - can have an additional description. - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\newkomavar[description]{name}</literal></term> - <term><literal>\newkomavar*[description]{name}</literal></term> - <term><literal>\addtoreffields{name}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\newkomavar</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\addtoreffields</tertiary> - </indexterm> - <simpara><literal>\newkomavar</literal> defines - a new variable, addressed with - <literal>name</literal>. - </simpara> - <simpara>The command - <literal>\addtoreffields</literal> adds the - variable <literal>name</literal> to the - reference fields. See section - <link linkend="scrlttr-business-line">Business Line</link>. - </simpara> - <simpara>The command <literal>\newkomavar*</literal> - works like <literal>\newkomavar</literal> with an - additional call of the command - <literal>\addtoreffields</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - Overview of all variables: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>backaddress</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>backaddress</tertiary> - </indexterm> - <simpara>Back address for window envelopes</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>backaddressseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>backaddressseparator</tertiary> - </indexterm> - <simpara>Separator within the back address</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>ccseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>ccseparator</tertiary> - </indexterm> - <simpara>Separator between title of additional - recipients and additional recipients - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>customer</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>customer</tertiary> - </indexterm> - <simpara>Customer number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>date</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>date</tertiary> - </indexterm> - <simpara>Date</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>emailseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>emailseparator</tertiary> - </indexterm> - <simpara>Separator between e-mail name and e-mail - address - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>enclseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>enclseparator</tertiary> - </indexterm> - <simpara>Separator between title of enclosure and - and enclosures</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>faxseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>faxseparator</tertiary> - </indexterm> - <simpara>Separator between title of fax and fax - number - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromaddress</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromaddress</tertiary> - </indexterm> - <simpara>Sender's address without its name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>frombank</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>frombank</tertiary> - </indexterm> - <simpara>Sender's bank account</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromemail</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromemail</tertiary> - </indexterm> - <simpara>Sender's e-mail</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromfax</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromfax</tertiary> - </indexterm> - <simpara>Sender's fax number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromlogo</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromlogo</tertiary> - </indexterm> - <simpara>Commands for inserting the sender's logo - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromname</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromname</tertiary> - </indexterm> - <simpara>Complete name of the sender</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromphone</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromphone</tertiary> - </indexterm> - <simpara>Sender's telephone number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromurl</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromurl</tertiary> - </indexterm> - <simpara>URL of the sender</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>invoice</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>invoice</tertiary> - </indexterm> - <simpara>Invoice number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>location</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>location</tertiary> - </indexterm> - <simpara>More details of the sender</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>myref</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>myref</tertiary> - </indexterm> - <simpara>Sender's reference</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>place</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>place</tertiary> - </indexterm> - <simpara>Place</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>placeseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>placeseparator</tertiary> - </indexterm> - <simpara>Separator between place and date</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>phoneseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>phoneseparator</tertiary> - </indexterm> - <simpara>Separator between title of telephone and - telephone number - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>signature</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>signature</tertiary> - </indexterm> - <simpara>Signature beneath the ending of the - letter - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>specialmail</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>specialmail</tertiary> - </indexterm> - <simpara>Special mail</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>subject</tertiary> - </indexterm> - <simpara>Subject</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subjectseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>subjectseparator</tertiary> - </indexterm> - <simpara>Separator between title of subject and - subject - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>title</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>title</tertiary> - </indexterm> - <simpara>Letter title</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toname</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>toname</tertiary> - </indexterm> - <simpara>Complete name of recipient</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toaddress</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>toaddress</tertiary> - </indexterm> - <simpara>Address of recipient without its name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>yourmail</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>yourmail</tertiary> - </indexterm> - <simpara>Date of recipient's mail</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>yourref</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>yourref</tertiary> - </indexterm> - <simpara>Recipient's reference</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\setkomavar{name}[description]{content}</literal></term> - <term><literal>\setkomavar*{name}{description}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\setkomavar</tertiary> - </indexterm> - - <simpara><literal>\setkomavar</literal> sets the - content of the variable <literal>name</literal>. - The optional argument sets the - <literal>description</literal> of the variable. - </simpara> - <simpara><literal>\setkomavar*</literal> - only sets the <literal>description</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\usekomavar[command]{name}</literal></term> - <term><literal>\usekomavar*[command]{name}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\usekomavar</tertiary> - </indexterm> - <simpara><literal>\usekomavar</literal> gives you - access to the content of the variable - <literal>name</literal>. - </simpara> - <simpara><literal>\usekomavar*</literal> gives you - access to the <literal>description</literal> - of the variable <literal>name</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\ifkomavarempty{name}{true}{false}</literal></term> - <term><literal>\ifkomavarempty*{name}{true}{false}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\ifkomavarempty</tertiary> - </indexterm> - <simpara>The <literal>true</literal> argument will - be executed if the content or description is - empty. Otherwise the <literal>false</literal> - argument will be executed. - </simpara> - <simpara>The starred version handles the - description of a variable, the variant without - star the content. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Pseudo Lengths</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>pseudo lengths</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\@newplength{name}</literal></term> - <listitem> - <simpara>Defines a new pseudo length</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\useplength{name}</literal></term> - <listitem> - <simpara>Access value of pseudo length - <literal>name</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\setlengthtoplength[factor]{length}{pseudo - length}</literal> - </term> - <term><literal>\addtolengthplength[factor]{length}{pseudo - length}</literal> - </term> - <listitem> - <simpara>Assign a multiple of - <literal>pseudo length</literal> to a real - <literal>length</literal>. Adds a multiple of - <literal>pseudo length</literal> to - <literal>length</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\@setplength[factor]{pseudo - length}{value}</literal> - </term> - <term> - <literal>\@addtoplength[factor]{pseudo - length}{value} - </literal></term> - <listitem> - <simpara>Assign a multiple of a - <literal>value</literal> to a - <literal>pseudo length</literal>. - Adds <literal>value</literal> to - <literal>pseudo length</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <!-- - <bridgehead renderas="sect5">General Structure of a Letter Document</bridgehead> - <para>&tbd;</para> - --> - - <bridgehead renderas="sect5">Letter Declaration</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>letter declaration</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Letterhead</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>letterhead</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>firstheadvpos</literal></term> - <listitem> - <simpara>Distance between the top of the sheet and - the letterhead. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>firstheadwidth</literal></term> - <listitem> - <simpara>Width of the letterhead.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromname</literal></term> - <term><literal>fromaddress</literal></term> - <term><literal>fromphone</literal></term> - <term><literal>fromfax</literal></term> - <term><literal>fromemail</literal></term> - <term><literal>fromurl</literal></term> - <term><literal>fromlogo</literal></term> - <listitem> - <simpara>This variables give all statements - concerning the sender necessary to create the - letterhead. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>phoneseparator</literal></term> - <term><literal>faxseparator</literal></term> - <term><literal>emailseparator</literal></term> - <term><literal>urlseparator</literal></term> - <listitem> - <simpara>Separators for variables in letterhead. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\firsthead{construction}</literal></term> - <listitem> - <simpara>Create letterhead freely.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Footer</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>footer</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>firstfootvpos</literal></term> - <listitem> - <simpara>Distance between footer and upper border - of the sheet.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>firstfootwidth</literal></term> - <listitem> - <simpara>Width of letter's firstpage footer.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\firstfoot{Construction}</literal></term> - <listitem> - <simpara>Set definition for first page's footer</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Address</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>address</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>toaddrvpos</literal></term> - <term><literal>toaddrhpos</literal></term> - <listitem> - <simpara>Distance between address window of a - window envelope and the upper and left border of - the sheet. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toaddrwidth</literal></term> - <listitem> - <simpara>Width of the address window.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toaddrindent</literal></term> - <listitem> - <simpara>Value of indentation for the address from - the left border. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>backaddress</literal></term> - <term><literal>backaddressseparator</literal></term> - <term><literal>backaddrheight</literal></term> - <listitem> - <simpara>Double backslashes within return address - will be exchanged with - <literal>backaddressseparator</literal>. - Height of the return address field. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>specialmail</literal></term> - <term><literal>specialmailindent</literal></term> - <term><literal>specialmailrightindent</literal></term> - <listitem> - <simpara>Optionally set between return address and - addressee. <literal>specialmailindent</literal> - and <literal>specialmailrightindent</literal> - determine left and right indentation. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toname</literal></term> - <term><literal>toaddress</literal></term> - <listitem> - <simpara>Usually not set directly by the user. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\begin{letter}[options]{address}</literal></term> - <listitem> - <simpara>Major point of the letter class. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\AtBeginLetter{command}</literal></term> - <listitem> - <simpara>Hook for commands run at begin of a - letter. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Sender's Extension</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>sender's extension</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>locwidth</literal></term> - <listitem> - <simpara>Declares width of sender's extensions.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>location</literal></term> - <listitem> - <simpara>Content of sender's extension.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead id ="scrlttr-business-line" renderas="sect5">Business Line</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>business line</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>refvpos</literal></term> - <listitem> - <simpara>Distance between upper border of sheet - and business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>refwidth</literal></term> - <listitem> - <simpara>Available width for the business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>refaftervskip</literal></term> - <listitem> - <simpara>Vertical space to be inserted beneath - business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>place</literal></term> - <term><literal>placeseparator</literal></term> - <listitem> - <simpara>If all variables for business line - are empty, the content of - <literal>place</literal> and - <literal>placeseparator</literal> will be set, - followed by content of <literal>date</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>yourref</literal></term> - <term><literal>yourmail</literal></term> - <term><literal>myref</literal></term> - <term><literal>customer</literal></term> - <term><literal>invoice</literal></term> - <term><literal>date</literal></term> - <listitem> - <simpara>Typical fields for business lines. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Title and Subject Line</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>title line</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>subject line</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>title</literal></term> - <listitem> - <simpara>Additional tile. Set centered beneath the - business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <term><literal>subjectseparator</literal></term> - <listitem> - <simpara>Set the subject of the letter, optional - prefixed by a label.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Further Issues</bridgehead> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>tfoldmarkvpos</literal></term> - <term><literal>bfoldmarkvpos</literal></term> - <listitem> - <simpara>Position of upper and lower fold mark.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>foldmarkhpos</literal></term> - <listitem> - <simpara>Distance between fold marks and the - sheet's left border.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>frombank</literal></term> - <listitem> - <simpara>Internally not used yet.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\nexthead{construction}</literal></term> - <term><literal>\nextfoot{construction}</literal></term> - <listitem> - <simpara>Create letter head or foot for the - following pages freely.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">The Text</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>text</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Opening</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>Opening</tertiary> - </indexterm> - <para> - <variablelist> - <varlistentry> - <term><literal>\opening{opening}</literal></term> - <listitem> - <simpara>Set the opening of the letter.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Footnotes</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>footnotes</tertiary> - </indexterm> - - <para>See section <emphasis>Footnotes</emphasis> in - &komascript; (still to be written).</para> - - <bridgehead renderas="sect5">Lists</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>lists</tertiary> - </indexterm> - <para>See section <emphasis>Lists</emphasis> in - &komascript; (still to be written).</para> - - <bridgehead renderas="sect5">Margin Notes</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>margin notes</tertiary> - </indexterm> - <para>See section <emphasis>Margin Notes</emphasis> in - &komascript; (still to be written).</para> - - <bridgehead renderas="sect5">Text Emphasis</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>text emphasis</tertiary> - </indexterm> - <para>See section <emphasis>Logical Markup of Text</emphasis> - in &komascript; (still to be written). - </para> - - <bridgehead renderas="sect5">Closing Part</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>Closing Part</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Closing</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>Closing</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>signature</literal></term> - <listitem> - <simpara>Inlcudes an explanation for the - inscription. Defaults to - <literal>\usekomavar{fromname}</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\closing{closing phrase}</literal></term> - <listitem> - <simpara>Typesets the colsing phrase follwoed by a - vertical space and the contents fo variable - <literal>signature</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>sigindent</literal></term> - <term><literal>sigbeforevskip</literal></term> - <term><literal>\raggedsignature</literal></term> - <listitem> - <simpara>Indentation of the box for closing - phrase, inscription and signature (defaults to 0mm). - Vertical space between closing phrase - and signature (defaults to two lines). - Alignment inside the box.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Postscript, Carbon Copy, and Enclosures</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>postscript</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>carbon copy</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>enclosure</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\ps</literal></term> - <listitem> - <simpara>Set a postscript.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\cc{distribution list}</literal></term> - <term><literal>ccseparator</literal></term> - <listitem> - <simpara>Set a ddistribution list. If the contents - of <literal>ccseparator</literal> isn't empty then - the name and the content of the variable is - inserted prior to distribution list.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\encl{enclosures}</literal></term> - <term><literal>enclseparator</literal></term> - <listitem> - <simpara>Same structur as the distribution list. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Language Support</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>language support</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Language Selection</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>language selection</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\captionenglish</literal></term> - <term><literal>\captionUSenglish</literal></term> - <term><literal>\captionamerican</literal></term> - <term><literal>\captionbritish</literal></term> - <term><literal>\captionUKenglish</literal></term> - <?db2latex \newline?> - <term><literal>\captiongerman</literal></term> - <term><literal>\captionngerman</literal></term> - <term><literal>\captionaustrian</literal></term> - <term><literal>\captionfrench</literal></term> - <term><literal>\captionitalian</literal></term> - <?db2latex \newline?> - <term><literal>\captionspanish</literal></term> - <term><literal>\captiondutch</literal></term> - <term><literal>\captioncroatian</literal></term> - <listitem> - <simpara>If the used language selection scheme - does not support switching the language the above - commands can be used directly.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\dateenglish</literal></term> - <term><literal>\dateUSenglish</literal></term> - <term><literal>\dateamerican</literal></term> - <term><literal>\datebritish</literal></term> - <term><literal>\dateUKenglish</literal></term> - <term><literal>\dategerman</literal></term> - <term><literal>\datengerman</literal></term> - <term><literal>\dateaustrian</literal></term> - <term><literal>\datefrench</literal></term> - <term><literal>\dateitalian</literal></term> - <term><literal>\datespanish</literal></term> - <term><literal>\datedutch</literal></term> - <term><literal>\datecrotian</literal></term> - <listitem> - <simpara>Numerical date representation.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Language-Dependent Terms</bridgehead> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\yourrefname</literal></term> - <term><literal>\youremailname</literal></term> - <term><literal>\myrefname</literal></term> - <term><literal>\customername</literal></term> - <term><literal>\invoicename</literal></term> - <term><literal>\subjectname</literal></term> - <term><literal>\ccname</literal></term> - <term><literal>\enclname</literal></term> - <term><literal>\headtoname</literal></term> - <term><literal>\headfromname</literal></term> - <term><literal>\datename</literal></term> - <term><literal>\pagename</literal></term> - <term><literal>\phonename</literal></term> - <term><literal>\faxname</literal></term> - <term><literal>\emailname</literal></term> - <term><literal>\wwwname</literal></term> - <term><literal>\bankname</literal></term> - <listitem> - <simpara>These defintions can be modified to - support a new language of for private - customization. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Defining Language Terms</bridgehead> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\providecaptioname{language}{term}{definition}</literal></term> - <term><literal>\newcaptioname{language}{term}{defintion}</literal></term> - <term><literal>\renewcaptionname{language}{term}{definition}</literal></term> - <listitem> - <simpara>Assign a <emphasis>definition</emphasis> - for a <emphasis>language</emphasis> to a - <emphasis>term</emphasis>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Address Files and Circular Letters</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>address files</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>circular letters</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:nonoindent;db2latex:compact"> - <varlistentry> - <term><literal>\adrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{Comment}{Key}</literal></term> - <listitem> - <simpara>Address entry for address files. The file - extension has to be <literal>.adr</literal>!</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\addrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{F3}{F4}{Key}</literal></term> - <listitem> - <simpara>This command supports four freely definable - parameters for an address entry.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\adrchar{initial letter}</literal></term> - <term><literal>\addrchar{initial letter}</literal></term> - <listitem> - <simpara>Separator for address entries. Ignored by - <literal>scrlttr2</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - </section> - - <section id="komascript-scraddr"> - <title id="komascript-scraddr-title">Address Files with <literal>scraddr</literal></title> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - </indexterm> - - <para> - <variablelist role="db2latex:multiterm"> - <varlistentry> - <term><literal>\InputAddressFile{file name}</literal></term> - <listitem> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\InputAddressFile</tertiary> - </indexterm> - <simpara>Read the contents of the given address file. - Filename extension has to be <literal>.adr</literal> - and has to be omitted in the argument. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\Name{Key}</literal></term> - <term><literal>\FirstName{Key}</literal></term> - <term><literal>\LastName{Key}</literal></term> - <term><literal>\Address{Key}</literal></term> - <term><literal>\Telephone{Key}</literal></term> - <term><literal>\FreeI{Key}</literal></term> - <term><literal>\FreeII{Key}</literal></term> - <term><literal>\Comment{Key}</literal></term> - <term><literal>\FreeIII{Key}</literal></term> - <term><literal>\FreeIV{Key}</literal></term> - <listitem> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Name{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FirstName{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\LastName{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Address{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Telephone{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeI{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeII{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Comment{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeIII{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeIV{}</tertiary> - </indexterm> - <simpara>Access to the data in address file. - <literal>\Name</literal> is a concatenation of - <literal>\FirstName</literal> and <literal>\LastName</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>AdrFreeIVempty</literal></term> - <term><literal>AdrFreeIVshow</literal></term> - <term><literal>AdrFreeIVwarn</literal></term> - <term><literal>AdrFreeIVstop</literal></term> - <listitem> - <simpara>Package warning options. Defaults to - <literal>AdrFreeIVshow</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - </section> - - <section id="mathpazo"> - <title id="mathpazo-title"><filename role="nohyphenation">mathpazo</filename></title> - <indexterm><primary>mathpazo</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>mathpazo</secondary> - </indexterm> - <para>Math fonts for the use with the Palatino font.</para> - - <section id="upDelta-upOmega"> - <title id="upDelta-upOmega-title">\upDelta / \upOmega</title> - <indexterm><primary>\upDelta</primary></indexterm> - <indexterm><primary>\upOmega</primary></indexterm> - - <para>Math fonts for the use with the Palatino font.</para> - - <para>Package options are: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>[slantedGreek]</literal></term> - <listitem> - <para>Uppercase Greek will be typeset slanted.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>[noBBpl]</literal></term> - <listitem> - <para>Do not use PazoMathBlackboardBold as - (partial) blackboard bold - font (e.g with <literal>\mathbb{R}</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>[osf]</literal></term> - <listitem> - <para>Make the font family <literal>pplj</literal> - (Palatino with old style numerals) the default - roman font, and use an - alternative version of the virtual math italic fonts - (<literal>zplmrj7m</literal> and - <literal>zplmbj7m</literal>) with upright Palatino old - style numerals for use with the - <literal>\oldstylenums</literal> command. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>[osfeqnnum]</literal></term> - <listitem> - <para>Use old style numerals for equation numbering.</para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - </section> - - <section id="varioref"> - <title id="varioref-title"><filename role="nohyphenation">varioref</filename></title> - <indexterm><primary>varioref</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>varioref</secondary> - </indexterm> - <para>Smarter version of the original latex2e - <link linkend="cross-references">cross reference commands</link>. - Generated strings are customizable, Babel options are recognized - (further info in the package documentation). - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term id="cmd-vref"><literal>\vref</literal></term> - <term id="cmd-vpageref"><literal>\vpageref</literal></term> - <listitem> - <indexterm> - <primary>\vref</primary> - </indexterm> - <indexterm> - <primary>\vpageref</primary> - </indexterm> - <para><literal>\vref</literal> is similar to - <literal>\ref</literal> but adds an additional page - reference, like <emphasis>on the facing page</emphasis> - or - <emphasis>on page 27</emphasis> whenever the corresponding - <link linkend="cmd-label-title"><filename role="nohyphenation">\label</filename></link> - is not on the same page. - </para> - <para><literal>\vpageref</literal> is a variation - of <literal>\pageref</literal> with similar - functionality. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\vrefrange</literal></term> - <term><literal>\vpagerefrange</literal></term> - <listitem> - <indexterm> - <primary>\vrefrange</primary> - </indexterm> - <indexterm> - <primary>\vpagerefrange</primary> - </indexterm> - <para>The <literal>\v...range</literal> commands - take two labels as arguments and - produce strings which depend on wether or not these labels - fall onto a single page or on different pages. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\vref*</literal></term> - <term><literal>\vpageref*</literal></term> - <term><literal>\vpagerefrange*</literal></term> - <listitem> - <para>Star * variants do not add any space before - the generated text for situations like: - <programlisting> -(\vref{foo} ...)</programlisting> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="small-packages"> - <title id="small-packages-title">Several Small Packages</title> - <indexterm><primary>Several Small Packages</primary></indexterm> - <indexterm><primary>Small Packages</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>Several Small Packages</secondary> - </indexterm> - <para>Must be loaded with the usual - <link linkend="usepackage-linkend"><literal>\usepackage</literal></link> - command. Further info for a package to be found in the - documentation (dvi, pdf, ps) or in the - <literal>sty</literal>-file itself. - </para> - - <section id="bm-package"> - <title id="bm-package-title"><filename role="nohyphenation">bm</filename></title> - <indexterm> - <primary>bm</primary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>bm</secondary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>bm.sty</secondary> - </indexterm> - <para>Bold math symbols or equations with better spacing - then the <literal>\boldsymbold</literal> command. - <indexterm> - <primary>\boldsymbold</primary> - </indexterm> - If possible load after other packages - which redefine the fonts. When no bold font - is available for a certain char <literal>bm</literal> - will use <emphasis>poor man's bold</emphasis> - <link linkend="pmb-linkend"><literal>\pmb</literal></link>. - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term id="cmd-bm"><literal>\bm</literal></term> - <listitem> - <indexterm> - <primary>\bm</primary> - </indexterm> - <para>Produces bold math symbol or equation.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\unboldmath</literal></term> - <listitem> - <indexterm> - <primary>\unboldmath</primary> - </indexterm> - <para>Can be used to set parts of an equation unbold.</para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="url-package"> - <title id="url-package-title"><filename role="nohyphenation">url</filename></title> - <indexterm> - <primary>url</primary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>url</secondary> - </indexterm> - <para>Defines line breakable hyperlinked - (uses <link linkend="hyperref">hyperref</link> package) - verbatim input for urls and e-mail addresses. - </para> - <para>Example: <literal>\url{http://example.org}</literal> - outputs <literal>http://example.org</literal>. - </para> - <para>Related commands are - <link linkend="href"><literal>\href</literal></link> - and <link linkend="cmd-nolinkurl"><literal>\nolinkurl</literal></link>. - </para> - </section> - - </section> - - </section> - - - <section id="generic-packages"> - <title id="generic-packages-title">Generic Packages</title> - - <section id="pictex"> - <title id="pictex-title">&pictex; (&tbd;)</title> - <indexterm><primary>PiCTeX</primary></indexterm> - <para>&tbd;</para> - </section> - - <section id="pstricks"> - <title id="pstricks-title">&pstricks;</title> - <indexterm><primary>&pstricks;</primary></indexterm> - - <section id="pstricks-ovw"> - <title id="pstricks-ovw-title">&overview;</title> - <para>The idea behind the &pstricks; package of - Timothy van Zandt - <indexterm> - <primary>People</primary> - <secondary>van Zandt, Timothy</secondary> - </indexterm> - is to provide most of the PostScript language in - &latex; and &tex; syntax. - </para> - </section> - - <section id="pstricks-commands"> - <title id="pstricks-commands-title">Commands and Parameters</title> - - <section id="pstricks-color"> - <title id="pstricks-color-title">Color</title> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newgray</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newrgbcolor</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newhsbcolor</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newcmykcolor</tertiary> - </indexterm> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\newgray{color}{num}</literal> - </term> - <term> - <literal>\newrgbcolor{color}{num1 num2 num3}</literal> - </term> - <term> - <literal>\newhsbcolor{color}{num1 num2 num3}</literal> - </term> - <term> - <literal>\newcmykcolor{color}{num1 num2 num3 num4}</literal> - </term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - </variablelist> - <para> - Note that these commands are obsolete for &latex;. Load - &pstricks; with <literal>\usepackage{pstcol}</literal> - and use the standard &latex; color commands instead. - </para> - </section> - - <section id="pstricks-setting"> - <title id="pstricks-setting-title"> - Setting graphics parameters</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psset{par1=value1,par2=value2,...}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psset</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-dimensions"> - <title id="pstricks-dimensions-title"> - Dimensions, coordinates and angles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pssetlength{cmd}{dim}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pssetlength</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>unit=dim, xunit=dim, yunit=dim, yunit=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>unit</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>xunit</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>yunit</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>runit</tertiary> - </indexterm> - <para> - Default: <literal>1cm</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\degrees[num]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\degrees</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\radians</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\radians</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-basic"> - <title id="pstricks-basic-title"> - Basic graphics parameters</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linewidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linewidth</tertiary> - </indexterm> - <para> - Default: <literal>.8pt</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>linecolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linecolor</tertiary> - </indexterm> - <para> - Default: <literal>black</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>showpoints=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>showpoints</tertiary> - </indexterm> - <para> - Default: <literal>false</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-lines"> - <title id="pstricks-lines-title">Lines and polygons</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linearc=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linearc</tertiary> - </indexterm> - <para> - Default: <literal>0pt</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>framearc=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>framearc</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>cornersize=relative/absolute</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>cornersize</tertiary> - </indexterm> - <para> - Default: <literal>relative</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psline*[par]{arrows}(x0,y0)(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psline</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\qline(coor0)(coor1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\qline</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pspolygon*[par](x0,y0)(x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pspolygon</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psframe*[par](x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psframe</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-arcs"> - <title id="pstricks-arcs-title"> - Arcs, circles and ellipses</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pscircle*[par](x0,y0){radius}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscircle</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\qdisk(coor){radius}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscircle</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pswedge*[par](x0,y0){radius}{angle1}{angle2}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pswedge</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psellipse*[par](x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psellipse</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psarc*[par]{arrows}(x,y){radius}{angleA}{angleB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psarc</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psarcn*[par]{arrows}(x,y){radius}{angleA}{angleB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psarcn</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arcsep=dim, arcsepA=dim, arcsepB=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcsep</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcsepA</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcsepB</tertiary> - </indexterm> - <para> - Default: <literal>0pt</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-curves"> - <title id="pstricks-curves-title">Curves</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psbezier*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)(x3,y3)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psbezier</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\parabola*[par]{arrows}(x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\parabola</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pscurve*[par]{arrows}(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psecurve*[par]{arrows}(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psecurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psccurve*[par]{arrows}(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psccurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>curvature=num1 num2 num3</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>curvature</tertiary> - </indexterm> - <para> - Default: <literal>1 .1 0</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-dots"> - <title id="pstricks-dots-title">Dots</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psdots*[par](x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psdots</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotstyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotstyle</tertiary> - </indexterm> - <simpara> Default: <literal>*</literal></simpara> - <simpara> Dots: - <literal> - *, o, +, triangle, triangle*, square, square*, - pentagon, pentagon*, | - </literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotscale=num1 num2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotscale</tertiary> - </indexterm> - <para> - Default: <literal>1</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotangle</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-grids"> - <title id="pstricks-grids-title">Grids</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psgrid(x0,y0)(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psgrid</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridwidth</tertiary> - </indexterm> - <simpara> Default: <literal>.8pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridcolor</tertiary> - </indexterm> - <simpara> Default: <literal>black</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>griddots=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>griddots</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridlabels=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabels</tertiary> - </indexterm> - <simpara> Default: <literal>10pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridlabelcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabelcolor</tertiary> - </indexterm> - <simpara> Default: <literal>black</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgriddiv=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabelcolor</tertiary> - </indexterm> - <simpara> Default: <literal>5</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgridwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>subgridwidth</tertiary> - </indexterm> - <simpara> Default: <literal>.4pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgridcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabelcolor</tertiary> - </indexterm> - <simpara> Default: <literal>gray</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgriddots=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>subgriddots</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-plots"> - <title id="pstricks-plots-title">Plots</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\fileplot*[par]{file}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\fileplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\dataplot*[par]{commands}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\dataplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\savedata{command}[data]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\savedata</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\readdata{command}{file}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\readdata</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\listplot*[par]{list}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\listplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psplot*[par]{xmin}{xmax}{function}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\parametricplot*[par]{tmin}{tmax}{function}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\parametricplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>plotstyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>plotstyle</tertiary> - </indexterm> - <simpara> Default: <literal>line</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>plotpoints=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>plotpoints</tertiary> - </indexterm> - <simpara> Default: <literal>50</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-coordinate"> - <title id="pstricks-coordinate-title">Coordinate systems</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>origin={coor}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>origin</tertiary> - </indexterm> - <simpara> Default: <literal>0pt,0pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>swapaxes=true</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>swapaxes</tertiary> - </indexterm> - <simpara> Default: <literal>false</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-line-styles"> - <title id="pstricks-line-styles-title">Line styles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linestyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linestyle</tertiary> - </indexterm> - <simpara> Default: <literal>solid</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dash=dim1 dim2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dash</tertiary> - </indexterm> - <simpara> Default: <literal>5pt 3pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotsep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotsep</tertiary> - </indexterm> - <simpara> Default: <literal>3pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>border=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>border</tertiary> - </indexterm> - <simpara> Default: <literal>0pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>bordercolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bordercolor</tertiary> - </indexterm> - <simpara> Default: <literal>white</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>doubleline=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>doubleline</tertiary> - </indexterm> - <simpara> Default: <literal>false</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>doublesep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>doublesep</tertiary> - </indexterm> - <simpara> Default: <literal>1.25\pslinewidth</literal></simpara> </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>doublecolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>doublecolor</tertiary> - </indexterm> - <simpara> Default: <literal>white</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadow=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadow</tertiary> - </indexterm> - <simpara> Default: <literal>false</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadowsize=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadowsize</tertiary> - </indexterm> - <simpara> Default: <literal>3pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadowangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadowangle</tertiary> - </indexterm> - <simpara> Default: <literal>-45</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadowcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadowcolor</tertiary> - </indexterm> - <simpara> Default: <literal>darkgray</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dimen=outer/inner/middle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dimen</tertiary> - </indexterm> - <simpara> Default: <literal>outer</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-fill-styles"> - <title id="pstricks-fill-styles-title">Fill styles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>fillstyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>fillstyle</tertiary> - </indexterm> - <simpara> Default: <literal>none</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>fillcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>fillcolor</tertiary> - </indexterm> - <simpara> Default: <literal>white</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchwidth</tertiary> - </indexterm> - <simpara> Default: <literal>.8pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchsep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchsep</tertiary> - </indexterm> - <simpara> Default: <literal>4pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchcolor</tertiary> - </indexterm> - <simpara> Default: <literal>black</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchangle=rot</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchangle</tertiary> - </indexterm> - <simpara> Default: <literal>45</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-arrowheads"> - <title id="pstricks-arrowheads-title">Arrowheads and such</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>arrows=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrows</tertiary> - </indexterm> - <simpara> Default: <literal>-</literal></simpara> - <simpara> Arrows: - <literal> - -, <->, >-<, <<->>, - >>-<<, |-|, |*-|*, [-], - (-), o-o, *-*, oo-oo, **-**, c-c, cc-cc, C-C - </literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowsize=dim num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowsize</tertiary> - </indexterm> - <simpara> Default: <literal>2pt 3</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowlength=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowlength</tertiary> - </indexterm> - <simpara> Default: <literal>1.4</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowinset=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowinset</tertiary> - </indexterm> - <simpara>Default: <literal>.4</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>tbarsize=dim num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>tbarsize</tertiary> - </indexterm> - <simpara> Default: <literal>2pt 5</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>bracketlength=num, rbracketlength=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bracketlength</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>rbracketlength</tertiary> - </indexterm> - <simpara> Default: <literal>.15</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotsize=dim num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotsize</tertiary> - </indexterm> - <simpara> Default: <literal>.5pt 2.5</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowscale=num1 num2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowscale</tertiary> - </indexterm> - <simpara> Default: <literal>1</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-custom"> - <title id="pstricks-custom-title">Custom styles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\newpsobject{name}{object}{par1=value1,...}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newpsobject</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\newpsstyle{name}{par1=value1,...}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newpsstyle</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-basics"> - <title id="pstricks-basics-title">The basics</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pscustom*[par]{commands}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscustom</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-parameters"> - <title id="pstricks-parameters-title">Parameters</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linetype=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linetype</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-graphics-objects"> - <title id="pstricks-graphics-objects-title">Graphics objects</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>liftpen=0/1/2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>liftpen</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="safe-tricks"> - <title id="pstricks-safe-tricks-title">Safe tricks</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\newpath</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newpath</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\moveto(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\moveto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\closepath</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\closepath</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\stroke[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\stroke</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\fill[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\fill</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\gsave</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\gsave</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\grestore</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\grestore</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\translate(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\translate</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\scale{num1 num2}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\scale</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rotate{angle}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotate</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\swapaxes</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\swapaxes</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\msave</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\msave</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\mrestore</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\mrestore</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\openshadow[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\openshadow</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\closedshadow[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\closedshadow</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\movepath(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\movepath</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pretty-safe-tricks"> - <title id="pstricks-pretty-safe-tricks-title"> - Pretty safe tricks</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\lineto(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\lineto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rlineto(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rlineto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\curveto(x1,y1)(x2,y2)(x3,y3)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\curveto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rcurveto(x1,y1)(x2,y2)(x3,y3)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rcurveto</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="hackers"> - <title id="pstricks-hackers-title">For hackers only</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\code{code}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\code</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\dim{dim}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\dim</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\coor(x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\coor</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rcoor(x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rcoor</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\file{file}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\file</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\arrows{arrows}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\arrows</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\setcolor{color}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\setcolor</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pictures"> - <title id="pstricks-pictures-title">Pictures</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pspicture*[baseline](x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pspicture</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\endpspicture</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\endpspicture</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="placing"> - <title id="pstricks-placing-title">Placing and rotating whatever</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\rput*[refpoint]{rotation}(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rput</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\uput*{labelsep}[refangle]{rotation}(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\uput</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pslabelsep</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pslabelsep</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>labelsep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>labelsep</tertiary> - </indexterm> - <para> - Default: <literal>5pt</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-repetition"> - <title id="pstricks-repetition-title">Repetition</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal> - \multirput*[refpoint]{angle}(x0,y0)(x1,y1){int}{stuff} - </literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\multirput</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\multips{angle}(x0,y0)(x1,y1){int}{graphics}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\multips</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-axes"> - <title id="pstricks-axes-title">Axes</title> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psaxes</tertiary> - </indexterm> - - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\psaxes*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)</literal></term> - <listitem> - <informaltable frame="none"> - <!-- <title>Axes label parameters</title> --> - <tgroup cols="4"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry><emphasis>Horizontal</emphasis></entry> - <entry><emphasis>Vertical</emphasis></entry> - <entry><emphasis>Dflt</emphasis></entry> - <entry><emphasis>Description</emphasis></entry> - </row> - <row rowsep="0"> - <entry>Ox=num</entry> - <entry>Oy=num</entry> - <entry>0</entry> - <entry>Label at origin.</entry> - </row> - <row rowsep="0"> - <entry>Dx=num</entry> - <entry>Dy=num</entry> - <entry>1</entry> - <entry>Label increment.</entry> - </row> - <row rowsep="0"> - <entry>dx=dim</entry> - <entry>oy=dim</entry> - <entry>0pt</entry> - <entry>Dist btwn labels.</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>labels=all/x/y/none</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>labels</tertiary> - </indexterm> - <para> - Default: <literal>all</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>showorigin=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>showorigin</tertiary> - </indexterm> - <para> - Default: <literal>true</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>ticks=all/x/y/none</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>ticks</tertiary> - </indexterm> - <para> - Default: <literal>all</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>tickstyle=full/top/bottom</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>tickstyle</tertiary> - </indexterm> - <para> - Default: <literal>full</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>ticksize=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>ticksize</tertiary> - </indexterm> - <para> - Default: <literal>3pt</literal> - </para> - - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psxlabel, \psylabel</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psxlabel</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psylabel</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>axesstyle=axes/frame/none</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>axesstyle</tertiary> - </indexterm> - <para> - Default: <literal>axes</literal> - </para> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-framed"> - <title id="pstricks-framed-title">Framed boxes</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>framesep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>framesep</tertiary> - </indexterm> - <para> - Default: <literal>3pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>boxsep=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>boxsep</tertiary> - </indexterm> - <para> - Default: <literal>true</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psframebox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psframebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psdblframebox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psdblframebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psshadowbox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psshadowbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pscirclebox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscirclebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\cput*[par]{angle}(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\cput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psovalbox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psovalbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-clipping"> - <title id="pstricks-clipping-title">Clipping</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\clipbox[dim]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\clipbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psclip{graphics} ... \endpsclip</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psclip</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-rotation"> - <title id="pstricks-rotation-title">Rotation and scaling boxes</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\rotateleft{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotateleft</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\rotateright{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotateright</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\rotatedown{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotatedown</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\scalebox{num1 num2}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\scalebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\scaleboxto(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\scaleboxto</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-nodes"> - <title id="pstricks-nodes-title">Nodes</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\rnode[refpoint]{name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\Rnode(x,y){name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\Rnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\RnodeRef</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\RnodeRef</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pnode(x,y){name}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\cnode*[par](x,y){radius}{name}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\cnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\circlenode*[par]{name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\circlenode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\cnodeput*[par]{angle}(x,y){name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\cnodeput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ovalnode*[par]{name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ovalnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-connections"> - <title id="pstricks-connections-title">Node connections</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>nodesep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>nodesep</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>offset=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>offset</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>arm=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arm</tertiary> - </indexterm> - <para> - Default: <literal>10pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>angle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>angle</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>arcangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcangle</tertiary> - </indexterm> - <para> - Default: <literal>8</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>ncurv=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>ncurv</tertiary> - </indexterm> - <para> - Default: <literal>.67</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>loopsize=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>loopsize</tertiary> - </indexterm> - <para> - Default: <literal>1cm</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncline*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncline</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncLine*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncLine</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nccurve*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nccurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncarc*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncarc</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncbar*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncbar</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncdiag*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncdiag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncdiagg*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncdiagg</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncangle*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncangle</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncangles*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncangles</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncloop*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncloop</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nccircle*[par]{arrows}{node}{radius}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nccircle</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcline*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcline</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pccurve*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pccurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcarc*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcarc</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcbar*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcbar</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcdiag*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcdiag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcangle*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcangle</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcloop*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcloop</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-attaching"> - <title id="pstricks-attaching-title">Attaching labels to node connections</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\lput*[refpoint]{rotation}(pos){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\lput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\aput*[labelsep]{angle}(pos){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\aput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\bput*[labelsep]{angle}(pos){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\bput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\mput*[refpoint]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\mput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\Aput*[labelsep]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\Aput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\Bput*[labelsep]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\Bput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-coils"> - <title id="pstricks-coils-title">Coils and zigzags</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pscoil*[par]{arrows}(x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psCoil*[par]{angle1}{angle2}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psCoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pszigzag*[par]{arrows}(x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pszigzag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilwidth</tertiary> - </indexterm> - <para> - Default: <literal>1cm</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilheight=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilheight</tertiary> - </indexterm> - <para> - Default: <literal>1</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilarm=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilwidth</tertiary> - </indexterm> - <para> - Default: <literal>.5cm</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilaspect=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilwidth</tertiary> - </indexterm> - <para> - Default: <literal>45</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilinc=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilinc</tertiary> - </indexterm> - <para> - Default: <literal>10</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nccoil*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nccoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nczigzag*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nczigzag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pccoil*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pccoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pczigzag*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pczigzag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-coordinates"> - <title id="pstricks-coordinates-title">Special coordinates</title> - - <para><literal>\SpecialCoor</literal></para> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\SpecialCoor</tertiary> - </indexterm> - - <table frame="none"> - <title>Special coordinates and angles</title> - <tgroup cols="3"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry><emphasis>Coordinate</emphasis></entry> - <entry><emphasis>Example</emphasis></entry> - <entry><emphasis>Description</emphasis></entry> - </row> - <row rowsep="0"> - <entry>(x,y)</entry> - <entry>(3,4)</entry> - <entry>Cartesian coordinate.</entry> - </row> - <row rowsep="0"> - <entry>(r;a)</entry> - <entry>(3;110)</entry> - <entry>Polar coordinate.</entry> - </row> - <row rowsep="0"> - <entry>(node)</entry> - <entry>(A)</entry> - <entry>Center of node.</entry> - </row> - <row rowsep="0"> - <entry>([par]node)</entry> - <entry>([angle=45]A)</entry> - <entry>Relative to node.</entry> - </row> - <row rowsep="0"> - <entry>(!ps)</entry> - <entry>(!5 3.3 2 exp)</entry> - <entry>Raw PostScript.</entry> - </row> - <row rowsep="0"> - <entry>(coor1|coor2)</entry> - <entry>(A|1in;30)</entry> - <entry>Combination.</entry> - </row> - </tbody> - </tgroup> - - <tgroup cols="3"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <spanspec namest="1" nameend="3" spanname="3"/> - <tbody> - - <row rowsep="0"> - <entry spanname="3"/> - </row> - - <row rowsep="0"> - <entry><emphasis>Angle</emphasis></entry> - <entry><emphasis>Example</emphasis></entry> - <entry><emphasis>Description</emphasis></entry> - </row> - <row rowsep="0"> - <entry>num</entry> - <entry>45</entry> - <entry>Angle.</entry> - </row> - <row rowsep="0"> - <entry>(coor)</entry> - <entry>(-1,1)</entry> - <entry>Coordinate (vector).</entry> - </row> - <row rowsep="0"> - <entry>!ps</entry> - <entry>!33 sqrt</entry> - <entry>Raw PostScript.</entry> - </row> - </tbody> - </tgroup> - </table> - - <para><literal>\NormalCoor</literal></para> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\NormalCoor</tertiary> - </indexterm> - - </section> - - <section id="pstricks-overlays"> - <title id="pstricks-overlays-title">Overlays</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\overlaybox stuff\endoverlaybox</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\overlaybox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psoverlay{string}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psoverlay</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\putoverlaybox{string}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\putoverlaybox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradbegin=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradbegin</tertiary> - </indexterm> - <para> - Default: <literal>gradbegin</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradend=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradend</tertiary> - </indexterm> - <para> - Default: <literal>gradend</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradlines=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradlines</tertiary> - </indexterm> - <para> - Default: <literal>500</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradmidpoint=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradmidpoint</tertiary> - </indexterm> - <para> - Default: <literal>.9</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradangle</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-path"> - <title id="pstricks-path-title">Typesetting text along a path</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pstextpath[pos](x,y){graphics object}{text}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pstextpath</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-stroking"> - <title id="pstricks-stroking-title">Stroking and filling character paths</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pscharpath*[par]{text}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscharpath</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pscharclip*[par]{text} ... \endpscharclip</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscharclip</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-exporting"> - <title id="pstricks-exporting-title">Exporting EPS files</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\TeXtoEPS ... \endTeXtoEPS</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\TeXtoEPS</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\PSTtoEPS[par]{file}{graphics objects}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\PSTtoEPS</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bbllx=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bbllx</tertiary> - </indexterm> - <para> - Default: <literal>-1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bblly=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bblly</tertiary> - </indexterm> - <para> - Default: <literal>-1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bburx=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bburx</tertiary> - </indexterm> - <para> - Default: <literal>1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bbury=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bbury</tertiary> - </indexterm> - <para> - Default: <literal>1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>headerfile=file</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>headerfile</tertiary> - </indexterm> - <para> - Default: <literal>s</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>headers=none/all/user</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>headers</tertiary> - </indexterm> - <para> - Default: <literal>none</literal> - </para> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-boxes"> - <title id="pstricks-boxes-title">Boxes</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\psmathboxtrue, \psmathboxfalse</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psmathboxtrue</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psmathboxfalse</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\everypsbox{commands}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\everypsbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pslongbox{name}{cmd}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pslongbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psverbboxtrue, \psverbboxfalse</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psverbboxtrue</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psverbboxfalse</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-tricks"> - <title id="pstricks-tricks-title">Tips and More Tricks</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pslbrace, \psrbrace</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pslbrace</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psrbrace</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - </section> - - <section id="pstricks-add-packages"> - <title id="pstricks-add-packages-title"> - List of Additional &pstricks; Packages</title> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/psgo/"><literal>psgo</literal></ulink></term> - <listitem> - <simpara>Draw Go diagrams</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-blur/"><literal>pst-blur</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for "blurred" shadows</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://dominique.rodriguez.9online.fr/pst-eucl/"><literal>pst-euc</literal></ulink></term> - <listitem> - <simpara>Géométrie en &latex; et &pstricks;</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.tug.org/applications/PSTricks/More/pst-fr3d.tar.gz"><literal>pst-fr3d</literal></ulink></term> - <listitem> - <simpara>Three dimensional framed Boxes</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-ghsb/"><literal>pst-ghsb</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for HSB Gradients</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-gr3d/"><literal>pst-gr3d</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for 3D grids</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://members.aol.com/ManuelLuque2/optique.htm"><literal>pst-lens</literal></ulink></term> - <listitem> - <simpara>Optique géométrique</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/"><literal>pst-node</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for nodes</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://members.aol.com/Mluque5130/pst-ob3d.tar.gz"><literal>pst-ob3d</literal></ulink></term> - <listitem> - <simpara>A &pstricks; package for three dimensional - basic objects - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.tug.org/applications/PSTricks/Physics/Oscilloscopes/"><literal>pst-osci</literal></ulink></term> - <listitem> - <simpara>Oscilloscopes with &pstricks;</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-poly/"><literal>pst-poly</literal></ulink></term> - <listitem> - <simpara>Polygons with &pstricks;</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/"><literal>pst-tree</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for trees</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.ensta.fr/~diam/latex/pst-uml/"><literal>pst-uml</literal></ulink></term> - <listitem> - <simpara>Draw easily diagrams with UML notation</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://perso.enst.fr/~lombardy/Vauc/"><literal>vaucansom.sty</literal></ulink></term> - <listitem> - <simpara>Drawing automata</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - </section> - </section> - - <section id="fontinst"> - <title id="fontinst-title"> - <filename role="nohyphenation">fontinst</filename> (&tbd;)</title> - <indexterm> - <primary>fontinst</primary> - </indexterm> - <para>&tbd;</para> - </section> - - <section id="context"> - <title id="context-title">&context; (&tbd;)</title> - <indexterm><primary>&context;</primary></indexterm> - <indexterm> - <primary>People</primary> - <secondary>Hagen, Hans</secondary> - </indexterm> - <section id="context-ovw"> - <title id="context-ovw-title">&overview;</title> - <para>&context; is based on &plaintex; and &metapost; and gets - controlled with some Perl scripts. It's mainly targeted towards - layout oriented users and especially useful for presentations. - It's extensible by the use of modules and has in it's base - distribution already a large amount of functionality. - The preferred output format is PDF, but DVI is possible too. - </para> - <para>Some of the unique features of &context; are: - <itemizedlist spacing="compact"> - <listitem> - <simpara>Inline XML (including MathML, ChemML, and PhysML)</simpara> - </listitem> - <listitem> - <simpara>really good XML support in general</simpara> - </listitem> - <listitem> - <simpara>inline &metapost;</simpara> - </listitem> - </itemizedlist> - </para> - </section> - </section> - - <section id="texinfo"> - <title id="texinfo-title">&texinfo; (&tbd;)</title> - <indexterm><primary>&texinfo;</primary></indexterm> - <para>&tbd;</para> - </section> - -</chapter> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-xindy.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-xindy.xml deleted file mode 100644 index ce1a4c2c1aa..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-xindy.xml +++ /dev/null @@ -1,1434 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-xindy.xml 139 2004-08-26 16:58:10Z mw $ --> - - <chapter id="xindy" lang="en"> - <title id="xindy-title">&xindy;</title> - <indexterm><primary>&xindy;</primary></indexterm> - - <note><para>The content of this section was taken from the original - documentation of &xindy; V2.1 - (<filename>Doc/manual*.html</filename>). - </para></note> - - <para><emphasis>xindy</emphasis> means - fle<emphasis>x</emphasis>ible <emphasis>ind</emphasis>exing - s<emphasis>y</emphasis>stem. - It is an indexing system that can be used to generate - book-like indexes for arbitrary document - preparation systems. This term includes systems such as - &tex; and &latex;, the Nroff-family or SGML-based systems - (e.g. HTML) that process some kind of text and generate - indexing information. It is not fixed to any specific system, - but can be configured for a wide variety of purposes. - </para> - - <section id="xindy-command-list"> - <title>Command List</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Command List</secondary> - </indexterm> - <para>Here is the complete list of xindy's commands that may - be used in the index style. The symbol <literal>name</literal> - always refers to a string. We separate the commands into - the processing and markup commands. The commands are listed - in alphabetical order. - </para> - <para>The parenthesis <literal>[</literal> and - <literal>]</literal> denote optional parts of the syntax - and <literal>{</literal> and <literal>}</literal> denote - the grouping of elements. A vertical bar indicates - alternatives. However, the enclosing round braces - <emphasis>are</emphasis> part of the syntax and - must be supplied. - </para> - - <section id="xindy-command-list-processing"> - <title>Processing Commands</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - </indexterm> - - <section id="xindy-command-list-processing-define-alphabet"> - <title><literal>define-alphabet</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-alphabet</tertiary> - </indexterm> - <para><programlisting>(define-alphabet name string-list)</programlisting></para> - <para>Defines <literal>name</literal> to be the alphabet - consisting of all elements of the - <literal>string-list</literal>. - Examples: - <programlisting>(define-alphabet "example-alphabet" ("An" "Example" "Alphabet"))</programlisting> - defines an alphabet consisting of exactly three symbols. - For the successor relationship holds: - <literal>succ("An")="Example"</literal> and - <literal>succ("Example")="Alphabet"</literal>. The built-in - alphabet <literal>digits</literal> is defined as follows: - <programlisting>(define-alphabet "digits" - ("0" "1" "2" "3" "4" "5" "6" "7" "8" "9"))</programlisting> - </para> - </section> - - <section id="xindy-command-list-processing-define-attributes"> - <title><literal>define-attributes</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-attributes</tertiary> - </indexterm> - - <para><programlisting>(define-attributes attribute-list)</programlisting></para> - <para>Defines all attributes the raw index may contain. - Parameter <literal>attribute-list</literal> is a list of - list of strings. The nesting level must not be more than 2. - So <literal>(..(..)..)</literal> is allowed, whereas - <literal>(..(..(..)..)..)</literal> is not. - </para> - <para>The list has two kinds of elements: strings and list - of strings. A single string is treated as if it were a - single element list. So the lists - <literal>("definition")</literal> and - <literal>( ("definition") )</literal> are equivalent. - All elements forming a list are a so-called - <emphasis>attribute group</emphasis>. The members of a group - are written to the output file before any member of the - following groups are written. - </para> - <para>Examples of valid attributes lists are:</para> - <para><literal>("definition" "usage")</literal> defines two - attribute groups. The first one contains all references - with the attribute <literal>definition</literal> and the - second one all with the attribute <literal>usage</literal>. - </para> - <para><literal>(("definition" "important") "usage")</literal> - defines two attribute groups. The first one contains all - references with the attributes <literal>definition</literal> - or <literal>important</literal> and the second one all with - the attribute <literal>usage</literal>. In the attribute - group <literal>("definition" "important")</literal> the - attribute <literal>definition</literal> overrides - <literal>important</literal>. - </para> - </section> - - <section id="xindy-command-list-processing-define-crossref-class"> - <title><literal>define-crossref-class</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-crossref-class</tertiary> - </indexterm> - - <para><programlisting>(define-crossref-class name [:unverified])</programlisting></para> - <para>Defines <literal>name</literal> to be a class of - cross references. We distinguish two types of cross - reference classes. <emphasis>Verified</emphasis> cross - reference classes can be checked for dangling references. - If for instance a cross reference points to the - non-existent keyword `foo' a warning is issued and the user - is advised to correct the invalid cross reference. This is - the default. If for some reasons this mechanism must be - deactivated the switch <literal>:unverified</literal> can - be used to suppress this behaviour. - </para> - </section> - - <section id="xindy-command-list-processing-define-letter-group"> - <title><literal>define-letter-group</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-letter-group</tertiary> - </indexterm> - - <para><programlisting>(define-letter-group name [:before lgname] [:after lgname] - [:prefixes list-of-prefixes])</programlisting></para> - <para><programlisting>(define-letter-groups list-of-letter-groups)</programlisting></para> - <para>This command defines a letter group with name - <literal>name</literal>, which must be a string value, - grouping all index entries that have a - <emphasis>sort key</emphasis> beginning with the prefix - <literal>name</literal>. The command - <programlisting>(define-letter-group "a")</programlisting> - is equivalent to the command - <programlisting>(define-letter-group "a" :prefixes ("a"))</programlisting> - </para> - <para>Using the latter form one can associate more than one - prefix with a given letter group. Also further prefixes - can be added to an already existing letter group by simply - defining the same letter group again. This results not in - a redefinition but in adding more prefixes to the currently - defined prefixes. - </para> - <para>Example: - <programlisting>(define-letter-group "a")</programlisting> - defines a letter group containing all index entries - beginning with the string <literal>"a"</literal>. - </para> - <para><programlisting>(define-letter-group "c" :after "a")</programlisting> - defines a letter group containing all index entries beginning - with the string <literal>"c"</literal>. The letter group - appears behind the letter group <literal>"a"</literal> - </para> - <para><programlisting>(define-letter-group "b" :after "a" :before "c")</programlisting> - inserts letter group <literal>"b"</literal> between letter - group <literal>"a"</literal> and <literal>"c"</literal>. - This allows incremental definition of letter groups by - extending already defined ones. - </para> - <para>The arguments <literal>:after</literal> and - <literal>:before</literal> define a partial order on the - letter groups. &xindy; tries to convert this partial order - into a total one. If this is impossible due to circular - definitions, an error is reported. If more than one - possible total ordering can result, it is left open - which one is used, so one should always define a complete - total order. - </para> - <para>The command <literal>define-letter-groups</literal> - (with an `s' at the end) is simply an abbreviation for - a sequence of <literal>define-letter-group</literal> - definitions where the elements are ordered in the - ordering given by the list. Example: - <programlisting>(define-letter-groups ("a" "b" "c")</programlisting> - equals the definitions - <programlisting>(define-letter-group "a") -(define-letter-group "b" :after "a") -(define-letter-group "c" :after "b")</programlisting> - </para> - <para>See also commands - <literal>markup-letter-group-list</literal> - and <literal>markup-letter-group</literal> for further - information. - </para> - </section> - - <section id="xindy-command-list-processing-define-location-class"> - <title><literal>define-location-class</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-location-class</tertiary> - </indexterm> - - <programlisting>(define-location-class name layer-list - [:min-range-length num] - [:hierdepth depth] - [:var])</programlisting> - - <para>Defines <literal>name</literal> to be a location - class consisting of the given list of layers. A list of - layers consists of names of basetypes and/or strings - representing separators. Separators must follow the - keyword argument <literal>:sep</literal>. If the keyword - <literal>:min-range-length</literal> is specified we - define the <emphasis>minimum range length</emphasis> - to be used when building ranges. The argument - <literal>num</literal> must be a positive integer number - or the keyword <literal>none</literal> in which case - the building of ranges is disallowed. If the switch - <literal>:var</literal> is specified the declared class - is of type <emphasis>variable</emphasis>, i.e. it is a - <emphasis>var-location-class</emphasis>. Since building - of ranges is currently only allowed for standard classes - <literal>:var</literal> and - <literal>:min-range-length</literal> - must not be used together. The keyword argument - <literal>:hierdepth</literal> can be used to declare that - the location references have to be tagged in a - hierarchical form. Its argument <literal>depth</literal> - must be an integer number indicating the number of layers - the hierarchy does contain. See command - <literal>markup-locref-list</literal> for more information. - Examples: - <programlisting>(define-location-class "page-numbers" ("arabic-numbers") - :minimum-range-length 3)</programlisting> - Defines the location class <literal>page-numbers</literal> - consisting of one layer which is the alphabet - <literal>arabic-numbers</literal>. Since the minimum range - length is set to 3 the location references 2, 3 and 4 don't - form a range because the range length is only 2. But the - references 6, 7, 8, and 9 are enough to form a range. Some - example instances of this class are - <literal>0, 1, ... 2313</literal>, etc. - <programlisting>(define-location-class "sections" :var - ("arabic-numbers" :sep "." - "arabic-numbers" :sep "." - "arabic-numbers"))</programlisting> - defines a variable location class. Valid instances are - <literal>1, 1.1, 1.2, 2, 2.4.5</literal>, but none of - <literal>2-3</literal> (wrong separator), - <literal>1.2.3.4</literal> (more than 3 layers), - <literal>2.3.iv</literal> (roman number instead of arabic one). - </para> - </section> - - <section id="xindy-command-list-processing-define-location-class-order"> - <title><literal>define-location-class-order</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-location-class-order</tertiary> - </indexterm> - - <para><programlisting>(define-location-class-order list)</programlisting></para> - <para>Defines the order in which the location classes are - written to the output file. The parameter - <literal>list</literal> is a list of names of location - classes. Examples: - <programlisting>(define-location-class-order - ("page-numbers" "sections" "xrefs"))</programlisting> - tells the system that the page numbers should appear before - the section numbers and that the cross references should - appear at the end. If this command is omitted, the - declaration order of the location classes in the index - style is implicitly used as the output order. In the case - that a location class does not appear in the list, the - output may behave unexpectedly, so one should always - enumerate all used location classes when using this command. - </para> - </section> - - <section id="xindy-command-list-processing-define-rule-set"> - <title><literal>define-rule-set</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-rule-set</tertiary> - </indexterm> - - <para><programlisting>(define-rule-set name - [ :inherit-from ("rule-set" "rule-set-2") ] - :rules (<rule>...) )</programlisting></para> - <para>A complete specification of a multi-phase sorting process - for a language requires that some rules have to appear - in several subsequent sorting phases. Rule sets can be - used to define a set of rules that can be instantiated in - an arbitrary sorting phase. Basically, they offer means to - separate the definition of sorting rules from their - instantiation, hence, acting as a wrapper for calls - to <literal>sort-rule</literal>. They do not add new - functionality that is not already present with - <literal>sort-rule</literal>. - </para> - <para>A rule can be of the form: - <programlisting><rule> ::= ("pattern" "replacement" - [:string|:bregexp|:egegexp] [:again])</programlisting> - </para> - <para>The following incomplete example defines a new rule - set of name <literal>isolatin1-tolower</literal> that - inherits definitions from rule set - <literal>latin-tolower</literal>, overriding or adding - the sort rules in the list of <literal>:rules</literal>. - <programlisting>(define-rule-set "isolatin1-tolower" - - :inherit-from ("latin-tolower") - - :rules (("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ... - ) -...)</programlisting> - Rule sets can be instantiated with the command - <literal>use-rule-set</literal>. For further descriptions - on the sorting model refer to the command - <literal>sort-rule</literal>. - </para> - </section> - - <section id="xindy-command-list-processing-define-sort-rule-orientations"> - <title><literal>define-sort-rule-orientations</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>define-sort-rule-orientations</tertiary> - </indexterm> - - <para><programlisting>(define-sort-rule-orientations (orientations...))</programlisting></para> - <para>Defines the order for the different sorting phases. - The currently implemented <emphasis>orientations</emphasis> - are <literal>forward</literal> and - <literal>backward</literal>. - This command must precede all <literal>sort-rule</literal> - commands in an index style. It defines the orientations - and implicitly sets the maximum number of sorting - phases performed. - </para> - <para>For further descriptions on the sorting model refer - to the command <literal>sort-rule</literal>. - </para> - </section> - - <section id="xindy-command-list-processing-merge-rule"> - <title><literal>merge-rule</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>merge-rule</tertiary> - </indexterm> - <para><programlisting>(merge-rule pattern replacement [:again] - [:bregexp | :eregexp | :string])</programlisting></para> - <para>Defines a keyword mapping rule that can be used to - generate the <emphasis>merge key</emphasis> from the - <emphasis>main key</emphasis> of an index entry. This - mapping is necessary to map all keywords that are - differently written but belong to the same keyword - to the same canonical keyword. - </para> - <para>The parameter <literal>pattern</literal> can be a - POSIX-compliant regular expression or an ordinary string. - The implementation uses the GNU Rx regular expression - library which implements the POSIX regular expressions. - Regular expressions (REs) can be specified as - <emphasis>basic regular expressions</emphasis> (BREs) or - <emphasis>extended regular expressions</emphasis> (EREs). - You can use the switch <literal>:bregexp</literal> to - force the interpretation of the pattern as a BRE, or - <literal>:eregexp</literal> to interpret it as an ERE. - If you want xindy to interpret the pattern literally, use - the switch <literal>:string</literal>. If none of these - switches is selected, xindy uses an auto-detection - mechanism to decide, if the pattern is a regular - expression or not. If it recognizes the pattern as - a RE, it interprets it as an ERE by default. - </para> - <para>The parameter <literal>replacement</literal> must be - a string possibly containing the special characters - <literal>&</literal> (substitutes for the complete - match) and <literal>\1 ,..., \9</literal> (substituting - for the <emphasis>n</emphasis>-th submatch. Examples: - <programlisting>(merge-rule "A" "a")</programlisting> - replaces each occurrence of the uppercase letter - <literal>`A'</literal> with its lowercase counterpart. - <programlisting>(merge-rule "\~"([AEOUaeou])" "\1")</programlisting> - transforms the &tex; umlaut-letters into their stripped - counterparts, such that <literal>`\"A '</literal> is - treated as an <literal>`A'</literal> afterwards. - </para> - <para>The following sequences have a special meaning: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>` ~n '</literal></term> - <listitem> - <para>End of line symbol - (<emphasis>linefeed</emphasis>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>` ~b '</literal></term> - <listitem> - <para>The ISO-Latin character with the lowest - ordinal number. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>` ~e ' </literal></term> - <listitem> - <para>The ISO-Latin character with the highest ordinal - number. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>` ~~ ' </literal></term> - <listitem> - <para>The tilde character.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>` ~" '</literal></term> - <listitem> - <para>The double quote character.</para> - </listitem> - </varlistentry> - </variablelist> - </para> - <para>Tilde characters and double quotes have to be quoted - themselves with a tilde character. The special characters - <literal>` ~b '</literal> and <literal>` ~e '</literal> - allow the definition of arbitrary sorting orders by rules. - In connection with an additional character every position - in the alphabet can be described. E.g. - <literal>` m~e '</literal> is lexicographically placed - between <literal>`m'</literal> and <literal>`n'</literal>. - </para> - <para>Due to efficiency, rules that just exchange characters - or substitute constant character sequences are not treated - as regular expressions. Therefore, instead of using the rule - <programlisting>(merge-rule "[A-Z]" "&")</programlisting> - it is more efficient (though less comfortable) to use - <programlisting>(merge-rule "A" "Ax") -(merge-rule "B" "Bx") -... -(merge-rule "Z" "Zx")</programlisting> - </para> - <para>Usually rules are applied in order of their definition. - Rules with a special prefix precede those that begin with - a class of characters, so that the search pattern - <literal>`alpha'</literal> is checked before - <literal>`.*'</literal>, but <literal>`auto'</literal> and - <literal>`a.*'</literal> are checked in order of their - definition. - </para> - <para>The first rule from a style file that matches the - input is applied and the process restarts behind the - substituted text. If no rule could be applied, the - actual character is copied from the input and the - process continues with the next character. - </para> - <para>Sometimes it is necessary to apply rules anew to the - result of a transformation. By specifying the keyword - argument <literal>:again</literal> in the merge rule the - rule is marked as mutable, which means that after using - this rule the transformation process shall restart - at the same place. E.g. the rule - <programlisting>(merge-rule "\$(.*)\$" "\1" :again)</programlisting> - deletes <emphasis>all</emphasis> surrounding - <literal>`$ '</literal> symbols from the input. - </para> - <para>See also command <literal>sort-rule</literal>.</para> - </section> - - <section id="xindy-command-list-processing-merge-to"> - <title><literal>merge-to</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>merge-to</tertiary> - </indexterm> - - <para><programlisting>(merge-to attr-from attr-to [:drop])</programlisting></para> - <para>A merge rule says that the attribute - <literal>attr-from</literal> can be used to build ranges in - <literal>attr-to</literal>. Both attributes must name valid - attribute names. The switch <literal>:drop</literal> - indicates, that the original location reference with - attribute <literal>attr-from</literal> has to be dropped - (removed), if a successful range was built with location - references in attribute <literal>attr-to</literal>. - A detailed description is given in the section about - processing phases. - </para> - </section> - - <section id="xindy-command-list-processing-require"> - <title><literal>require</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>require</tertiary> - </indexterm> - - <para><programlisting>(require filename)</programlisting></para> - <para>This command allows to load more index style modules. - The module is searched in the directories defined in the - search path. The file is read in and processing of the - current file continues. The argument - <literal>filename</literal> must be a string. This allows - to decompose the index style into several modules that - can be included into the topmost index style file. - Example: - <programlisting>(require "french/alphabet.xdy") -(require "french/sort-rules.xdy") -(require "tex/locations.xdy") -(require "tex/markup.xdy")</programlisting> - Submodules can load other submodules as well. If a file is - required that was already loaded, the - <literal>require</literal> command is simply ignored and - processing continues without including this file twice. - See also command searchpath. - </para> - </section> - - <section id="xindy-command-list-processing-searchpath"> - <title><literal>searchpath</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>searchpath</tertiary> - </indexterm> - - <para><programlisting>(searchpath {path-string | path-list})</programlisting></para> - <para>This command adds the given paths to the list of paths, - xindy searches for index style files. The argument - <literal>path-string</literal> must be a colon-separated - string of directory names. If this path ends with a colon - the default search path is added to the end of the path - list. Example: - <programlisting>(searchpath ".:/usr/local/lib/xindy:/usr/local/lib/xindy/english:")</programlisting> - adds the specified directories to the search path. Since the - last path ends with a colon, the built-in search path is - added at the end. Specifying - <programlisting>(searchpath ("." - "/usr/local/lib/xindy" - "/usr/local/lib/xindy/english" - :default))</programlisting> - yields exactly the same result as the example above. Here - <literal>path-list</literal> must be a list of strings and/or - the keyword(s) <literal>:default</literal> and - <literal>:last</literal>. The keyword - <literal>:default</literal> signifies that the default pathnames - are to be inserted at the specified position in the list. - The keyword <literal>:last</literal> allows to insert the - currently active paths at the indicated position. Since - this allows to insert the built-in paths at any position - and incrementally adding new paths to the search path, - this version of the command ist more flexible than - the first version. - </para> - </section> - - <section id="xindy-command-list-processing-sort-rule"> - <title><literal>sort-rule</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>sort-rule</tertiary> - </indexterm> - - <para><programlisting>(sort-rule pattern replacement [:run level] [:again])</programlisting></para> - <para>Defines a keyword mapping rule that can be used to - generate the <emphasis>sort key</emphasis> of an index entry - from the <emphasis>merge key</emphasis>. This key is used - to sort the index entries lexicographically after they - have been merged using the merge key. - </para> - <para>The argument <literal>:run</literal> indicates that this - rule is only in effect a the specified - <emphasis>level</emphasis> (default is level 0). For a - detailed discussion on the definition of sort rules for - different layers refer to the documentation about the new - sorting scheme (<literal>new-sort-rules</literal>) that - comes with this distribution. - </para> - <para>See command <literal>merge-rule</literal> for more - information about keyword rules. - </para> - </section> - - <section id="xindy-command-list-processing-use-rule-set"> - <title><literal>use-rule-set</literal></title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Processing Commands</secondary> - <tertiary>use-rule-set</tertiary> - </indexterm> - - <para><programlisting>(use-rule-set [:run phase] - [:rule-set ( <rule-set>... ))</programlisting> - </para> - <para>This command instantiates the gives rule sets to be - in effect at sorting phase <literal>phase</literal>. - The order of the rule sets given with argument - <literal>:rule-set</literal> is significant. Rule set - entries of rule set appearing at the beginning of the - list override entries in rule sets at the end - of the list. - </para> - <para>The following example declares that in phase 0 the - rule sets <literal>din5007</literal> and - <literal>isolatin1-tolower</literal> should be active, - whereas in phase 2 the other rule sets have to be applied. - <programlisting>(use-rule-set :run 0 - :rule-set ("din5007" "isolatin1-tolower")) - -(use-rule-set :run 1 - :rule-set ("resolve-umlauts" - "resolve-sharp-s" - "isolatin1-tolower" - ))</programlisting> - </para> - <para>For a discussion on rule sets refer to command - <literal>define-rule-set</literal>. - </para> - </section> - </section> - - <section id="xindy-command-list-markup"> - <title>Markup Commands</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Command List</secondary> - <tertiary>Markup Commands</tertiary> - </indexterm> - - <para>The following commands can be used to define the - markup of the index. They don't have any influence - on the indexing process. Since the markup scheme is - characterized by the concept of - <emphasis>environments</emphasis>, the syntax and naming - scheme of all commands follows a simple structure. - </para> - <para>The commands can be separated into - <emphasis>environment</emphasis> and - <emphasis>list-environment</emphasis> commands. All - commands of the first group support the keyword arguments - <literal>:open</literal> and <literal>:close</literal>, - whereas the second group additionally supports the keyword - argument <literal>:sep</literal>. If one of these keyword - arguments is missing, the default markup tag is always - the empty tag. The <literal>:open</literal> tag is always - printed before the object itself and the - <literal>:close</literal> tag is always printed after the - object has been printed. If a list is printed the - <literal>:sep</literal> tag is printed between two elements - of the list but not before the first element, or after the - last one. All commands dealing with a list have the suffix - <literal>`-list'</literal> as part of their command name. - </para> - <para>Since the number of commands and the heavy usage of - <emphasis>default</emphasis> and - <emphasis>specialized</emphasis> tags makes the markup - somehow complex (but very powerful) we have added a - mechanism to trace the markup tags xindy omits during - its markup phase with the command - <literal>markup-trace</literal>. - </para> - <para>Here follows the list of markup commands in alphabetical - order with some of the commands grouped together. - </para> - - <section> - <title><literal>markup-attribute-group-list</literal></title> - <para><programlisting>(markup-attribute-group-list [:open string] [:close string] - [:sep string]) - -(markup-attribute-group [:open string] [:close string] - [:group group-num])</programlisting> - </para> - <para>Location class groups consist of lists of attribute - groups. The markup of this list can be defined with the - command <literal>markup-attribute-group-list</literal>. - </para> - <para>To allow different markup for different attribute - groups the command <literal>markup-attribute-group</literal> - can be specialized on the group number with the keyword - argument <literal>:group</literal> which must be an integer - number. E.g., given are the groups - <literal>("definition" "theorem")</literal> and - <literal>("default")</literal> with group numbers 0 and 1, - then - <programlisting>(markup-attribute-group :open "<group0>" :close </group0>" - :group 0) - -(markup-attribute-group :open "<group1>" :close "</group1>" - :group 1)</programlisting> - can be used to assign different markup for both groups - in a SGML-based language. - </para> - </section> - - <section> - <title><literal>markup-crossref-list</literal></title> - <para><programlisting>(markup-crossref-list [:open string] [:close string] - [:sep string] - [:class crossref-class]) - -(markup-crossref-layer-list [:open string] [:close string] - [:sep string] - [:class crossref-class]) - -(markup-crossref-layer [:open string] [:close string] - [:class crossref-class])</programlisting> - </para> - <para>A crossref class group contains cross references of the - same class. The separator between the classes is defined with - the <literal>(markup-locclass-list :sep)</literal>-parameter. - A list of cross references can be tagged with the - <literal>command markup-crossref-list</literal> that - specializes on the <literal>:class</literal> argument. - </para> - <para>Each cross reference is determined by a list of layers - indicating the target of the cross reference. To define a - suitable markup for such a list the - <literal>command markup-crossref-layer-list</literal> - can be used. - </para> - <para>Each layer of a cross reference can be assigned two tags - that specialize on the class of the reference, like all - other commands. - </para> - <para>A suitable markup for a cross reference class - <literal>see</literal> within &latex2e; could look like that: - <programlisting>(markup-crossref-list :class "see" :open "\emph{see} " - :sep "; ") -(markup-crossref-layer-list :class "see" :sep ",") -(markup-crossref-layer :class "see" - :open "\textbf{" :close "}")</programlisting> - An example output could look like - <literal>... see house; garden,winter; greenhouse</literal> - </para> - </section> - - <section> - <title><literal>markup-index</literal></title> - <para><programlisting>(markup-index [:open string] [:close string] - [ :flat | :tree | :hierdepth depth ])</programlisting> - </para> - <para>Defines the markup tags that enclose the whole index - via the <literal>:open</literal> and - <literal>:close</literal> parameters. Examples: - <programlisting>(markup-index :open "Here comes the index~n" - :close "That's all folks!~n")</programlisting> - defines that the <literal>:open</literal> string is printed - before the rest of the index and the <literal>:close</literal> - string appears after the index is printed. - </para> - <para>Additionally one can specify the form of the generated - index. It is possible to produce flat indexes by specifying - the switch <literal>:flat</literal>, to generate a tree with - the <literal>:tree</literal> switch or any kind of mixture - between both by specifying the depth up to which trees shall - be built with the parameter <literal>:hierdepth</literal>. - Its argument depth is the number of layers that can be formed - into a tree. Therefore <literal>:flat</literal> is an - abbrevation of <literal>:hierdepth 0</literal> and - <literal>:tree</literal> is an abbrevation of - <literal>:hierdepth max-depth</literal>, with - <literal>max-depth</literal> being the maximum number of - layers a keyword has. An example: the keywords - <programlisting>("tree" "binary" "AVL") -("tree" "binary" "natural")</programlisting> - can be transformed in the following ways: - </para> - <para>A flat index (<literal>:flat</literal> or - <literal>:hierdepth 0</literal>) - <programlisting>tree binary AVL -tree binary natural</programlisting> - with <literal>:hierdepth 1</literal> - <programlisting>tree - binary AVL - binary natural</programlisting> - and a tree (<literal>:tree</literal> or - <literal>:hierdepth > 1</literal>) - <programlisting>tree - binary - AVL - natural</programlisting> - Most often one will create tree-like indexes or - ones that are flat. - </para> - </section> - - <section> - <title><literal>markup-indexentry-list</literal></title> - <para><programlisting>(markup-indexentry-list [:open string] [:close string] - [:sep string] [:depth integer]) - -(markup-indexentry [:open string] [:close string] - [:depth integer])</programlisting> - </para> - <para>Letter groups consists of a list of index entries. The - command <literal>markup-indexentry-list</literal> defines - the markup of these lists. The markup can be specialized - on the depth if the index is hierarchically organized. - The command - <programlisting>(markup-indexentry-list :open "\begin{IdxentList}" - :close "\end{IdxentList}" - :sep "~n")</programlisting> - defines that the index entries of all layers are wrapped - into the given markup tags. If additionally - <programlisting>(markup-indexentry-list :open "\begin{IdxentListII}" - :close "\end{IdxentListII}" - :sep "~n" - :depth 2)</programlisting> - is defined, all index entry lists of all layers (except - layer 2) are tagged according to the first specification, - and the index entry list within depth 2 are tagged - according to the second rule. - </para> - <para>The command <literal>markup-indexentry</literal> defines - the markup of an index entry at a given depth. Since - index entries may also contain subentries and the markup - for subentries may be different in different layers, - the optional keyword argument <literal>:depth</literal> - can be used to assign different markup for different layers. - If depth is ommited the default markup for all possible - depths is defined. The top-most index entries have depth 0. - </para> - <para><programlisting>(markup-indexentry :open "\begin{Indexentry}" - :close "\end{Indexentry}")</programlisting> - defines that the index entries of all layers are wrapped into - the given markup tags. If additionally - <programlisting>(markup-indexentry :open "\begin{IndexentryII}" - :close "\end{IndexentryII}" - :depth 2)</programlisting> - is defined, all index entries of all layers (except layer 2) - are tagged according to the first specification, and the - index entries with depth 2 are tagged according to the - second rule. - </para> - </section> - - <section> - <title><literal>markup-keyword-list</literal></title> - <para><programlisting>(markup-keyword-list [:open string] [:close string] - [:sep string] [:depth integer]) - -(markup-keyword [:open string] [:close string] - [:depth integer])</programlisting> - </para> - <para>The print key of an index entry consists of a list of - strings. The markup of this list can be defined with the - command <literal>markup-keyword-list</literal>. The keyword - argument <literal>:depth</literal> may be specified to - define the markup of the list at a particular depth. - </para> - <para>The keyword of an index entry consists of a list of - strings. Each of these components is tagged with the - strings defined with the command - <literal>markup-keyword</literal>. Since we maybe need - different markup for different layers, the optional - keyword argument can be used to specialize this - markup for some depth. - </para> - </section> - - <section> - <title><literal>markup-letter-group-list</literal></title> - <para><programlisting>(markup-letter-group-list [:open string] [:close string] - [:sep string]) - -(markup-letter-group [:open string] [:close string] [:group group-name] - [:open-head string] [:close-head string] - [:upcase | :downcase | :capitalize])</programlisting> - </para> - <para>The first command defines the markup of the letter - group with name <literal>group-name</literal>. Since the - markup of letter groups often contains the name of the - letter group as a part of it, the other keyword arguments - allow an additional markup for this group name. If one of - the parameters <literal>:open-head</literal> and - <literal>:close-head</literal> is specified additional markup - is added as can be described as follows: - <programlisting><OPEN> - IF (:open-head OR :close-head) - <OPEN-HEAD> - transformer-of(<GROUP-NAME>) - <CLOSE-HEAD> - FI - <INDEXENTRIES...> -<CLOSE></programlisting> - Here, <literal>transformer-of</literal> is a function that - possibly transforms the string representing the group - name into another string. The transformers we currently - support can be specified with the switches - <literal>:upcase</literal>, <literal>:downcase</literal> - and <literal>:capitalize</literal> which result in the - corresponding string conversions. If none of them is - specified no transformation is done at all. - </para> - <para>The command <literal>markup-letter-group</literal> - defines the markup of the list of letter groups. - </para> - </section> - - <section> - <title><literal>markup-locclass-list</literal></title> - <para><programlisting>(markup-locclass-list [:open string] [:close string] - [:sep string])</programlisting> - </para> - <para>Each index entry contains a list of location class groups. - This markup command can be used to define the markup of - this list. - </para> - </section> - - <section> - <title><literal>markup-locref</literal></title> - <para><programlisting>(markup-locref [:open string] [:close string] - [:class locref-class] - [:attr attribute] - [:depth integer])</programlisting> - </para> - <para>The markup tags of a location reference can be - specialized on the three arguments <literal>:class</literal>, - <literal>:attr</literal> and additionally, if - sub-references are used, <literal>:depth</literal>. - Most often one will only use a tag depending on the - attribute. For example, all location references with the - attribute <literal>definition</literal> should appear in - a font series like bold, emphasizing the importance of - this location reference; those with the attribute - <literal>default</literal> in font shape italic. The - markup in this case would not specialize on the depth - or any particular class. A valid definition, suitable - for a usage within HTML, could look like this. - <programlisting>(markup-locref :open "<B>" :close "</B>" :attr "definition") -(markup-locref :open "<I>" :close "</I>" :attr "default")</programlisting> - </para> - </section> - - <section> - <title><literal>markup-locref-class</literal></title> - <para><programlisting>(markup-locref-class [:open string] [:close string] - [:class locref-class])</programlisting> - </para> - <para>All location references of a particular location - reference class can be wrapped into the tags defined - by this command. It specializes on the keyword - argument <literal>:class</literal>. - </para> - </section> - - <section> - <title><literal>markup-locref-layer</literal></title> - <para><programlisting>(markup-locref-layer [:open string] [:close string] - [:depth integer] [:layer integer] - [:class locref-class]) - -(markup-locref-layer-list [:open string] [:close string] - [:sep string] - [:depth integer] - [:class locref-class])</programlisting> - </para> - <para>A location reference contains a list of location reference - layers. The second markup command can be used to markup this - list. It specializes on the class of the location references - and the depth (if sub-references are used). - </para> - <para>The first command allows to tag the elements of a layer - list differently. The first element of this list can is - specialisable with <literal>:layer 0</literal>, the next - element with <literal>:layer 1</literal>, etc. See the next - example for an example. - </para> - </section> - - <section> - <title><literal>markup-locref-list</literal></title> - <para><programlisting>(markup-locref-list [:open string] [:close string] [:sep string] - [:depth integer] [:class locref-class])</programlisting> - </para> - <para>An attribute group contains a list of location - references and/or ranges. Additionally a layered - location reference itself may contain sub-references - that are stored as a list of location references. We - specialize the markup for these lists on the location - class they belong to with the keyword argument - <literal>:class</literal>, and on <literal>:depth</literal> - that specializes on the different subentry levels when using - location references with sub-references. - </para> - <para>Given is a list of location references that have the - class description - <programlisting>(define-location-class "Appendix" - ("ALPHA" :sep "-" "arabic-numbers") - :hierdepth 2)</programlisting> - </para> - <para>This location class has instances like - <literal>A-1</literal>, <literal>B-5</literal>, etc. The - keyword argument <literal>:hierdepth 2</literal> informs - &xindy; to markup these location references in a - hierarchical form. With the commands - <programlisting>(markup-locref-list :sep "; " - :depth 0 :class "Appendix") -(markup-locref-list :open " " :sep "," - :depth 1 :class "Appendix") -(markup-locref-layer :open "{\bf " :close "}" :layer 0 - :depth 0 :class "Appendix")</programlisting> - we obtain a markup sequence for some example data that - could look like - <programlisting> \bf A} 1,2,5; {\bf B} 5,6,9; {\bf D} 1,5,8; ...</programlisting> - </para> - </section> - - <section> - <title><literal>markup-range</literal></title> - <programlisting>(markup-range [:open string] [:close string] [:sep string] - [:class locref-class] - [:length num] [:ignore-end])</programlisting> - - <para>A range consists of two location references. Markup - can be specified with the <literal>:open</literal> and - <literal>:close</literal> arguments and one separator given - by the argument <literal>:sep</literal>.</para> - <para>Since both location references are tagged with markup - defined by the command <literal>markup-locref</literal> a - specialization on attributes or depth is not necessary. - Specialization is allowed on the class they belong to, - because the separator between two location refences may be - different for each location class. Argument - <literal>:length</literal> can be used to define different - markup for different lengths. In conjunction with - <literal>:length</literal> is may be useful not to print - the second location reference at all. For example, one - wishes to markup ranges of length 1 in the form Xf. instead - of X--Y. This can be accomplished with the switch - <literal>:ignore-end</literal>.</para> - <para>The markup tags for a range (X,Y) can be described - as follows: - <programlisting><OPEN> - Markup of location reference X -<SEP> - IF (not :ignore-end) - Markup of location reference Y - FI -<CLOSE></programlisting> - </para> - <para>The following tags can be used to define a range of - page numbers (given in a location class - <literal>page-numbers</literal>) without considering the - open and close parameters: - <programlisting>(markup-range :sep "-" :class "page-numbers")</programlisting> - </para> - <para>Location ranges then appear separated by a hyphen in a - form like this: - <programlisting> ..., 5-8, 19-23, ...</programlisting> - </para> - </section> - - <section> - <title><literal>(markup-trace [:on] [:open string] [:close string])</literal></title> - <para>This command can be used to activate the tracing of - all markup commands xindy executes. The switch - <literal>:on</literal> activates the trace. If - <literal>:on</literal> is omitted, the command line - flag <literal>-t</literal> can be used as well. All tags - which are emitted but not yet defined explicitly by the - user are tagged with a symbolic notation indicating the - commands that must be used to define this tag. The defaults - for the keyword argument <literal>:open</literal> is - <literal>`<'</literal> and for <literal>:close</literal> - is <literal>`>'</literal>. The beginning of an example - output could look like: - <programlisting><INDEX:OPEN> - <LETTER-GROUP-LIST:OPEN> - <LETTER-GROUP:OPEN ["a"]> - <INDEXENTRY-LIST:OPEN [0]> - <INDEXENTRY:OPEN [0]> - <KEYWORD-LIST:OPEN [0]> - <KEYWORD:OPEN [0]> - ...</programlisting> - </para> - <para>We use a simple indentation scheme to make the structure - of the tags visible. The symbolic tag - <literal><LETTER-GROUP:OPEN ["a"]></literal> for - example indicates that the tag that can be specified with - the command - <programlisting>(markup-letter-group :open "XXX" :group "a" ... )</programlisting> - is emitted at this point in the markup process. By - incrementally adding markup commands to the index, more - and more tags can be defined until the whole markup is - defined. This general mechanism should allow everyone - understand the markup process. The best is to start with - a small index, define the complete markup and afterwards - process the whole index. Additionally one can enclose - the symbolic tags into an environment that is neutral - to the document preparation system, such as a comment. - For TeX this could be - <programlisting>(markup-trace :open "%%" :close "~n")</programlisting> - or a definition in the TeX document like - <programlisting>\def\ignore#1{}</programlisting> - combined with the command - <programlisting>(markup-trace :open "\ignore{" :close "}")</programlisting> - </para> - </section> - - </section> - - <section id="xindy-command-list-raw-index"> - <title>Raw Index Interface</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Command List</secondary> - <tertiary>Raw Index Interface</tertiary> - </indexterm> - <para>This section can be skipped if the reader is not - interested in adapting xindy to a new document - preparation system. - </para> - <para>The raw index is the file that represents the index - that is to be processed. Since many different document - preparation systems may use different forms of index - representations, their output must be transformed in a - form readable by xindy. We also could have written an - configurable parser performing this task, but usually - a tool written with some text processing tools such as - <command>perl</command>, <command>sed</command> or - <command>awk</command> can achieve the same task as well. - Therefore, adapting xindy to a completely different system - can mostly be done by writing an appropriate raw index filter. - </para> - <para>The format of the raw index interface of xindy is - defined as follows: - </para> - <programlisting>(indexentry { :key string-list [:print string-list] - | :tkey list-of-layers } - [:attr string] - { :locref string [:open-range | :close-range] - | :xref string-list } )</programlisting> - <para>The pseudo variable <emphasis>string</emphasis> is a - sequence of characters surrounded by double quotes, e.g. - <programlisting>"Hi, it's me" "one" "a string with two \"double quotes\""</programlisting> - are three examples of valid strings. If you need to include - a double quote as a literal character, you must quote it - itself with a backslash as shown in the third example. - A <emphasis>string list</emphasis> is simply a list of strings - separated by whitespaces and surrounded by round braces. - An example of a string list is - <programlisting>("This" "is" "a" "list" "of" "strings")</programlisting> - </para> - <para>So far about the syntax. The semantics of the - different elements are described here. - </para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>:key</literal></term> - <listitem> - <para>The argument <emphasis>string list</emphasis> - defines the keyword of the index entry. It must be - a list of strings, since the keyword may consist of - different layers such as - <literal>("heap" "fibonacci")</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>:print</literal></term> - <listitem> - <para>The optional <emphasis>print key</emphasis> defines - the way the keyword has to be printed in the markup phase. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>:tkey</literal></term> - <listitem> - <para>Another possibility to define the keys of an index - entry is with the <literal>:tkey</literal> keyword - argument. It can be used instead of the - <literal>:key</literal> and <literal>:print</literal> - arguments. Instead of specifying separately the key - and the corresponding print key, we define the keyword - by its layers. Each layer consist of a list of one or - two strings. The first string will be interpreted as the - main key, whereas the second one will become the print - key. If the print key is ommited, the main key is taken - instead. So the definition - <programlisting>:tkey (("This") ("is") ("a") ("bang" "BANG !!!"))</programlisting> - is equivalent to - <programlisting>:key ("This" "is" "a" "bang") -:print ("This" "is" "a" "BANG !!!")</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>:locref</literal></term> - <listitem> - <para>The reference an index entry describes can be a - <emphasis>location reference</emphasis> or a - <emphasis>cross reference</emphasis>. The switch - <literal>:locref</literal> describes a location - reference. Its optional arguments are - <literal>:open-range</literal> and - <literal>:close-range</literal>. The - <emphasis>string</emphasis> that must be supplied must - somehow encode the location reference. It might look - like the string <literal>"25"</literal> representing - the page number 25, or <literal>"Appendix-I"</literal> - representing the first appendix numbered in - uppercase roman numerals. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>:open-range,:close-range</literal></term> - <listitem> - <para>These are switches that do not take any arguments. - They describe the beginning and ending of a - <emphasis>range</emphasis>, starting or ending from - the location reference that is given by the argument - <literal>:locref</literal>. If they are supplied, - the location reference may have influence on the - way ranges are build. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>:xref</literal></term> - <listitem> - <para>These arguments choose the second alternative. - The argument <emphasis>string list</emphasis> of - parameter <literal>:xref</literal> describes where - the index entry should point to. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>:attr</literal></term> - <listitem> - <para>This parameter may be used to tag a location - reference with a certain attribute or it names the - class of a cross reference. It may also used to - associate different markup for different attributes - in the markup phase. If this parameter is omitted - or is the empty string, the indexentry is declared - to have the attribute <literal>default</literal>. - </para> - </listitem> - </varlistentry> - </variablelist> - <para>Some examples: - <programlisting>(indexentry :key ("airplane") :locref "25" :attr "default")</programlisting> - defines an index entry with the key - <emphasis>airplane'</emphasis> indexed on page - <emphasis>25'</emphasis>. This index entry has the - attribute <literal>default</literal>. - </para> - <para><programlisting>(indexentry :key ("house") :xref("building") :attr "see")</programlisting> - defines a cross reference with the key - <literal>house</literal> pointing to the term - <literal>building</literal>. This cross reference belongs to - the cross reference class <literal>see</literal>. - </para> - <para><programlisting>(indexentry :key ("house") :xref("building") :open-range)</programlisting> - is an invalid specification, since - <literal>:open-range</literal> - mustn't be used together with cross references. - </para> - </section> - - </section> - - <section id="xindy-invoking"> - <title>Invoking xindy</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Invoking</secondary> - </indexterm> - - <section id="xindy-invoking-cmdline"> - <title>Command Line Options</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Invoking</secondary> - <tertiary>Command Line Options</tertiary> - </indexterm> - <para>The following command line options are accepted:</para> - <programlisting>xindy [-h] [-t] [-v] [-l logfile] [-o outfile] - [-L n] [-f filterprog] - indexstyle raw-index</programlisting> - <para>The argument <literal>indexstyle</literal> names a file, - containing the index style description. The argument - <literal>raw-index</literal> names a file, containing - the raw index. Both arguments are mandatory. - </para> - - <para><variablelist role="db2latex:compact"> - <varlistentry> - <term>-h</term> - <listitem> - <para>Gives a short summary of all command line options. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>-l</term> - <listitem> - <para>Writes helpful information into the - specified <literal>logfile</literal>. For example, - the keyword mappings are written into this file, - so one can check if the intended mappings were - actually performed this way. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>-o</term> - <listitem> - <para>Explicitly defines the name of the - <literal>output</literal> file. - If not given, the name of the - <literal>raw-index</literal> is used with - its extension changed to <literal>.ind</literal> - (or added, if it had no extension at all). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>-t</term> - <listitem> - <para>Enters tracing mode of the symbolic markup tags. - The format of the emitted tags can be defined with - the command <literal>markup-trace</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>-L</term> - <listitem> - <para>Set the xindy logging-level to <literal>n</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>-f</term> - <listitem> - <para>Run <literal>filterprog</literal> on - <literal>raw-index</literal> before reading. - The program must act as a filter reading from - <literal>stdin</literal> and writing to - <literal>stdout</literal>. The most obvious use - of this option in conjunction with TeX is to run - <literal>-f tex2xindy</literal> on the index file - prior to reading the entries into xindy. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>-v</term> - <listitem> - <para>Shows the version number of xindy. - </para> - </listitem> - </varlistentry> - </variablelist> - Errors and warnings are reported to <literal>stdout</literal> - and additionally to the logfile if <literal>-l</literal> - was specified. - </para> - </section> - - <section id="xindy-search-path"> - <title>Search Path</title> - <indexterm> - <primary>&xindy;</primary> - <secondary>Invoking</secondary> - <tertiary>Search Path</tertiary> - </indexterm> - <para>The system uses the concept of a search path for - finding the index style files and modules. The searchpath - can be set with the environment variable - <envar>XINDY_SEARCHPATH</envar> which must contain a - list of colon-separated directories. If it ends with a - colon, the built-in searchpath is added to the entire - searchpath. See the command - <link linkend="xindy-command-list-processing-searchpath">searchpath</link> - for further details. - </para> - </section> - - </section> - -</chapter> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chunk.xsl b/Master/texmf-doc/source/english/tex-refs/tex-refs-chunk.xsl deleted file mode 100644 index d55d0c48c13..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chunk.xsl +++ /dev/null @@ -1,151 +0,0 @@ -<?xml version="1.0"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version="1.0" - xmlns="http://www.w3.org/TR/xhtml1/transitional" - exclude-result-prefixes="#default"> - - <!-- $Id: tex-refs-chunk.xsl 142 2004-10-24 15:13:24Z mw $ --> - - <!-- FIXME: XHTML --> - <!-- <xsl:import href="file:///home/mw/docbook-xsl/html/chunk.xsl"/> --> - <!-- we use an XML catalog to resolve this file --> - <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/> - - <!-- import common customizations --> - <xsl:import href="tex-refs-common.xsl"/> - - <!-- insert customization here --> - - <xsl:param name="default.encoding" select="'ISO-8859-1'"/> - - <xsl:param name="use.id.as.filename" select="'1'"/> - <xsl:param name="section.autolabel" select="1"/> - <xsl:param name="html.stylesheet" select="'../tex-refs.css'"/> - - <!-- chunking options --> - <xsl:param name="chunk.fast" select="1"/> - - <!-- Chunk the first top-level section? --> - <xsl:param name="chunk.first.sections" select="0"/> - - <!-- Depth to which sections should be chunked --> - <xsl:param name="chunk.section.depth" select="1"/> - - <xsl:param name="process.source.toc">1</xsl:param> - - <!-- How deep should recursive sections appear in the TOC? --> - <xsl:param name="toc.section.depth">2</xsl:param> - - <!-- Control depth of TOC generation in sections --> - <xsl:param name="generate.section.toc.level" select="2"/> - - <xsl:param name="section.label.includes.component.label" select="1"/> - - <xsl:param name="chunker.output.method" select="'html'"/> - - <!-- no titles in headers and footers --> - <!--<xsl:param name="navig.showtitles" select="0"/> --> - - <!-- exchange header --> - <xsl:template name="header.navigation"> - <xsl:param name="prev" select="/foo"/> - <xsl:param name="next" select="/foo"/> - <xsl:param name="nav.context"/> - - <xsl:variable name="home" select="/*[1]"/> - <xsl:variable name="up" select="parent::*"/> - - <xsl:variable name="row1" select="$navig.showtitles != 0"/> - <xsl:variable name="row2" select="count($prev) > 0 - or (count($up) > 0 - and generate-id($up) != generate-id($home) - and $navig.showtitles != 0) - or count($next) > 0"/> - - <xsl:if test="$suppress.navigation = '0' and $suppress.header.navigation = '0'"> - <div class="navheader"> - <xsl:if test="$row1 or $row2"> - <table width="100%" summary="Navigation header"> - <xsl:if test="$row1"> - <tr> - <th colspan="3" align="center"> - <xsl:choose> - <xsl:when test="count($up) > 0 - and generate-id($up) != generate-id($home) and $navig.showtitles != 0"> - <xsl:apply-templates select="$up" mode="object.title.markup"/> - </xsl:when> - <xsl:otherwise> </xsl:otherwise> - </xsl:choose> - </th> - </tr> - </xsl:if> - - <xsl:if test="$row2"> - <tr> - <td width="20%" align="left"> - <xsl:if test="count($prev)>0"> - <a accesskey="p"> - <xsl:attribute name="href"> - <xsl:call-template name="href.target"> - <xsl:with-param name="object" select="$prev"/> - </xsl:call-template> - </xsl:attribute> - <xsl:call-template name="navig.content"> - <xsl:with-param name="direction" select="'prev'"/> - </xsl:call-template> - </a> - </xsl:if> - <xsl:text> </xsl:text> - </td> - <th width="60%" align="center"> - <xsl:apply-templates select="." mode="object.title.markup"/> - </th> - <td width="20%" align="right"> - <xsl:text> </xsl:text> - <xsl:if test="count($next)>0"> - <a accesskey="n"> - <xsl:attribute name="href"> - <xsl:call-template name="href.target"> - <xsl:with-param name="object" select="$next"/> - </xsl:call-template> - </xsl:attribute> - <xsl:call-template name="navig.content"> - <xsl:with-param name="direction" select="'next'"/> - </xsl:call-template> - </a> - </xsl:if> - </td> - </tr> - </xsl:if> - </table> - </xsl:if> - <xsl:if test="$header.rule != 0"> - <hr/> - </xsl:if> - </div> - </xsl:if> - </xsl:template> - - <!-- FIXME: XHTML - <xsl:param name="chunker.output.doctype-public" - select="'-//W3C//DTD XHTML 4.01 Transitional//EN'"/> - <xsl:param name="chunker.output.doctype-system" - select="'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'"/> - --> - - <!-- this enables generation of TOC in appendix - <xsl:param name="generate.toc"> -appendix toc -article/appendix toc -article toc -book toc,title,figure,table,example,equation -sect1 toc -sect2 toc -sect3 toc -sect4 toc -sect5 toc -section toc - </xsl:param> - --> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-common.xsl b/Master/texmf-doc/source/english/tex-refs/tex-refs-common.xsl deleted file mode 100644 index edb8623bb5f..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-common.xsl +++ /dev/null @@ -1,68 +0,0 @@ -<?xml version="1.0"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version="1.0" - xmlns="http://www.w3.org/TR/xhtml1/transitional" - exclude-result-prefixes="#default"> - - <!-- $Id: tex-refs-common.xsl 137 2004-06-21 09:45:54Z mw $ --> - - <!-- Common customizations for all stylesheets --> - - <xsl:template match="toc"/> - - <!-- this omits the trailing '.' in numbered sections --> - <xsl:param name="autotoc.label.separator" select="' '"/> - <xsl:param name="local.l10n.xml" select="document('')"/> - - <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> - <l:l10n language="en"> - <l:context name="title-numbered"> - <l:template name="section" text="%n %t"/> - </l:context> - </l:l10n> - </l:i18n> - - <!-- override template for revhistory table --> - <xsl:template match="revhistory" mode="titlepage.mode"> - <xsl:variable name="numcols"> - <xsl:choose> - <xsl:when test="//authorinitials">3</xsl:when> - <xsl:otherwise>2</xsl:otherwise> - </xsl:choose> - </xsl:variable> - - <div xmlns="http://www.w3.org/1999/xhtml" class="{name(.)}"> - <table border="2" cellspacing="4" width="100%" summary="Revision history"> - <tr> - <th align="left" valign="top" colspan="{$numcols}"> - <b> - <xsl:call-template name="gentext"> - <xsl:with-param name="key" select="'RevHistory'"/> - </xsl:call-template> - </b> - </th> - </tr> - <xsl:apply-templates mode="titlepage.mode"> - <xsl:with-param name="numcols" select="$numcols"/> - </xsl:apply-templates> - </table> - </div> - </xsl:template> - - <xsl:template match="symbol"> - <xsl:param name="entity"><xsl:value-of select="." /></xsl:param> - <xsl:choose> - <xsl:when test="$entity='--'"><xsl:text>-</xsl:text></xsl:when> - <xsl:when test="$entity='BibTeX'"><xsl:text>BibTeX</xsl:text></xsl:when> - <xsl:when test="$entity='LaTeX'"><xsl:text>LaTeX</xsl:text></xsl:when> - <xsl:when test="$entity='LaTeX2e'"><xsl:text>LaTeX2e</xsl:text></xsl:when> - <xsl:when test="$entity='Makeindex'"><xsl:text>Make-Index</xsl:text></xsl:when> - <xsl:when test="$entity='PiCTeX'"><xsl:text>PiCTeX</xsl:text></xsl:when> - <xsl:when test="$entity='TeX'"><xsl:text>TeX</xsl:text></xsl:when> - <xsl:otherwise> - <xsl:call-template name="inline.charseq"/> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-htmlhelp.xsl b/Master/texmf-doc/source/english/tex-refs/tex-refs-htmlhelp.xsl deleted file mode 100644 index cda38a96cb8..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-htmlhelp.xsl +++ /dev/null @@ -1,15 +0,0 @@ -<?xml version="1.0"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version="1.0" - xmlns="http://www.w3.org/TR/xhtml1/transitional" - exclude-result-prefixes="#default"> - - <!-- $Id: tex-refs-htmlhelp.xsl 120 2004-03-26 20:19:43Z mw $ --> - - <xsl:import href="file:///home/mw/docbook-xsl-1.62.4/htmlhelp/htmlhelp.xsl"/> - - <!-- insert customization here --> - <xsl:param name="use.id.as.filename" select="'1'"/> - <xsl:param name="htmlhelp.chm" select="'tex-refs.chm'"/> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-local.mapping.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-local.mapping.xml deleted file mode 100644 index 7a00d019d20..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-local.mapping.xml +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> - -<!-- $Id: tex-refs-local.mapping.xml 137 2004-06-21 09:45:54Z mw $ --> - -<latexbindings> - - <!-- LaTeX mapping, role, BEGIN --> - <latexmapping role="begin"> - <mapping key="revhistory" text=""> - <line> </line> - <line>\pagebreak </line> - <line>\chapter*{%title%} </line> - <line>\label{%id%}\hypertarget{%id%}{}% </line> - <line>\begin{tabular}{@{}lll@{}} </line> - </mapping> - </latexmapping> - - <!-- LaTeX mapping, role, END --> - <latexmapping role="end"> - <mapping key="revhistory" text=""> - <line>\end{tabular} </line> - </mapping> - </latexmapping> - - -</latexbindings> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-pdf.xsl b/Master/texmf-doc/source/english/tex-refs/tex-refs-pdf.xsl deleted file mode 100644 index e3508e53d5d..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-pdf.xsl +++ /dev/null @@ -1,584 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> - - <!-- $Id: tex-refs-pdf.xsl 146 2005-05-14 15:34:22Z mw $ --> - - <!-- we use an XML catalog to resolve this file --> - <xsl:import href="http://db2latex.sourceforge.net/xsl/docbook.xsl"/> - - <xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> - - <xsl:param name="latex.documentclass">scrbook</xsl:param> - <xsl:param name="latex.documentclass.book">twoside,openright,tocleft,listsleft,smallheadings,10pt,halfparskip</xsl:param> - - <xsl:param name="latex.hyperref.param.common">bookmarksnumbered,backref,breaklinks,linktocpage</xsl:param> - - <xsl:variable name="latex.math.support">1</xsl:variable> - - <!-- we use the Latin Modern fonts --> - <xsl:variable name="latex.document.font">lmodern</xsl:variable> - - <xsl:variable name="latex.documentclass.common"></xsl:variable> - <xsl:variable name="latex.babel.language">english</xsl:variable> - - <xsl:variable name="latex.hyphenation.tttricks">1</xsl:variable> - - <xsl:param name="latex.inline.monoseq.style">\texttt</xsl:param> - - <xsl:variable name="latex.admonition.environment"> - <xsl:text>% ---------------------------------------------- </xsl:text> - <xsl:text>% Define a new LaTeX environment (adminipage) </xsl:text> - <xsl:text>% Modified for DAHB, M. Wiedmann, 2003.07.25 </xsl:text> - <xsl:text>% ---------------------------------------------- </xsl:text> - <xsl:text>\newenvironment{admminipage}% </xsl:text> - <xsl:text>{ % this code corresponds to the \begin{adminipage} command </xsl:text> - <xsl:text> \begin{Sbox}% </xsl:text> - <xsl:text> \begin{minipage}% </xsl:text> - <xsl:text>} %done </xsl:text> - <xsl:text>{ % this code corresponds to the \end{adminipage} command </xsl:text> - <xsl:text> \end{minipage} </xsl:text> - <xsl:text> \end{Sbox} </xsl:text> - <xsl:text> \fbox{\TheSbox} </xsl:text> - <xsl:text>} %done </xsl:text> - <xsl:text>% ---------------------------------------------- </xsl:text> - <xsl:text>% Define a new LaTeX length (admlength) </xsl:text> - <xsl:text>% ---------------------------------------------- </xsl:text> - <xsl:text>\newlength{\admlength} </xsl:text> - <xsl:text>% ---------------------------------------------- </xsl:text> - <xsl:text>% Define a new LaTeX environment (admonition) </xsl:text> - <xsl:text>% With 2 parameters: </xsl:text> - <xsl:text>% #1 The file (e.g. note.pdf) </xsl:text> - <xsl:text>% #2 The caption </xsl:text> - <xsl:text>% ---------------------------------------------- </xsl:text> - <xsl:text>\newenvironment{admonition}[2] </xsl:text> - <xsl:text>{ % this code corresponds to the \begin{admonition} command </xsl:text> - <xsl:text> \begin{center}% Added MW </xsl:text> - <xsl:text> %\hspace{0mm}\newline\hspace*\fill\newline </xsl:text> - <xsl:text> \noindent </xsl:text> - <xsl:text> \setlength{\fboxsep}{5pt} </xsl:text> - <xsl:text> \setlength{\admlength}{\linewidth} </xsl:text> - <xsl:text> \addtolength{\admlength}{-10\fboxsep} </xsl:text> - <xsl:text> \addtolength{\admlength}{-10\fboxrule} </xsl:text> - <xsl:text> \admminipage{\admlength} </xsl:text> - <xsl:text> {\bfseries \sc\normalsize{#2}}</xsl:text> - <xsl:text> \newline </xsl:text> - <xsl:text> \\[0.3ex] </xsl:text> - <xsl:text> \sffamily </xsl:text> - <!-- - If we cannot find the latex.admonition.path; - Comment out the next line (\includegraphics). - This tactic is to avoid deleting the \includegraphics - altogether, as that could confuse a person trying to - find the use of parameter #1 in the environment. - --> - <xsl:if test="$latex.admonition.path=''"> - <xsl:text>%</xsl:text> - </xsl:if> - <xsl:text> \includegraphics[</xsl:text> <xsl:value-of select="$latex.admonition.imagesize" /> <xsl:text>]{#1} </xsl:text> - <xsl:text> \addtolength{\admlength}{-1cm} </xsl:text> - <xsl:text> \addtolength{\admlength}{10pt} </xsl:text> - <xsl:text> \begin{minipage}[lt]{\admlength} </xsl:text> - <xsl:text> \parskip=0.5\baselineskip \advance\parskip by 0pt plus 2pt </xsl:text> - <xsl:text> \small% Added MW </xsl:text> - <xsl:text>} %done </xsl:text> - <xsl:text>{ % this code corresponds to the \end{admonition} command </xsl:text> - <xsl:text> \vspace{1mm}% Changed MW: from 5 to 1mm </xsl:text> - <xsl:text> \end{minipage} </xsl:text> - <xsl:text> \endadmminipage </xsl:text> - <xsl:text> \vspace{.5em} </xsl:text> - <xsl:text> \par </xsl:text> - <xsl:text> \end{center}% Added MW </xsl:text> - <xsl:text>} </xsl:text> -</xsl:variable> - - <!-- path to admonition figure graphic files --> - <!-- <xsl:param name="latex.admonition.path">/usr/share/sgml/docbook/stylesheet/xsl/db2latex/latex/figures</xsl:param> --> - <xsl:param name="latex.admonition.path"></xsl:param> - - <!-- we use scrbook which provides headers - but they do not work yet! - --> - <xsl:param name="latex.use.fancyhdr">1</xsl:param> - - <xsl:param name="latex.use.tabularx">1</xsl:param> - - <xsl:variable name="latex.hyperref.param.pdftex"> - pdfauthor={Michael Wiedmann}, - pdfpagemode=UseNone, - pdfstartview=FitH, - pdftitle={References for TeX and Friends}, - pdfcreator={DocBook/XML db2latex-xsl}, - pdfsubject={}, - pdfkeywords={TeX, LaTeX}, - pdfpagelabels - </xsl:variable> - - <xsl:param name="latex.use.parskip">1</xsl:param> - <xsl:param name="latex.use.makeidx">1</xsl:param> - <xsl:param name="toc.section.depth">2</xsl:param> - - <xsl:param name="latex.entities"></xsl:param> - - <xsl:param name="latex.use.subfigure">0</xsl:param> - <xsl:param name="latex.caption.swapskip">0</xsl:param> - - <!-- for customizing LaTeX mapping --> - <!-- we need this e.g. for 'revhistory' --> - <xsl:variable name="latex.mapping.xml" select="document('tex-refs-local.mapping.xml')"/> - - <xsl:variable name="latex.book.varsets"> - <xsl:text>%% headings </xsl:text> - <xsl:text>%\usepackage[automark]{scrpage2} </xsl:text> - <xsl:text>%\pagestyle{scrheadings} </xsl:text> - <xsl:text>%% T1 encoding </xsl:text> - <xsl:text>\usepackage[T1]{fontenc} </xsl:text> - <xsl:text>%% character protruding for pdftex </xsl:text> - <xsl:text>\usepackage[activate]{pdfcprot} </xsl:text> - <xsl:text>%% load geometry package for setting margins </xsl:text> - <xsl:text>\usepackage{geometry} </xsl:text> - <xsl:text>\geometry{lmargin=2.5cm,rmargin=2.0cm,tmargin=2.0cm,bmargin=2.0cm,headsep=1.0cm,footskip=1.5cm} </xsl:text> - <xsl:text>%% title </xsl:text> - <xsl:text>%FIXME </xsl:text> - <xsl:text>\pagestyle{plain} </xsl:text> - <xsl:text>\titlehead{} </xsl:text> - <xsl:text>\uppertitleback{} </xsl:text> - <xsl:text>\lowertitleback{} </xsl:text> - <xsl:text>\dedication{} </xsl:text> - <xsl:text>\subject{} </xsl:text> - <xsl:text>\publishers{} </xsl:text> - <xsl:text>\date{</xsl:text><xsl:value-of select="/book/bookinfo/date"/><xsl:text>} </xsl:text> - <xsl:text>%% support for landscape pages </xsl:text> - <xsl:text>\usepackage{lscape} </xsl:text> - <xsl:text>%% used by multicolumn! </xsl:text> - <xsl:text>\usepackage{calc} </xsl:text> - <!-- - <xsl:text>%% end up with even pages </xsl:text> - <xsl:text>\AtEndDocument{% </xsl:text> - <xsl:text> \newcommand\QuadPages{% </xsl:text> - <xsl:text> \setcounter{subparagraph}{\value{page}}% </xsl:text> - <xsl:text> \divide\value{subparagraph} by 2\relax% </xsl:text> - <xsl:text> \multiply\value{subparagraph} by 2\relax% </xsl:text> - <xsl:text> \ifnum\value{subparagraph}=\value{page}\let\QuadPages=\relax </xsl:text> - <xsl:text> \null\thispagestyle{empty}\clearpage </xsl:text> - <xsl:text> \else\null\newpage\fi </xsl:text> - <xsl:text> \QuadPages} </xsl:text> - <xsl:text> \clearpage </xsl:text> - <xsl:text> \markboth{Notes}{Notes}\QuadPages </xsl:text> - <xsl:text>} </xsl:text> - --> - </xsl:variable> - - <!-- outputs per default \makeglossary which we don't use --> - <xsl:param name="latex.book.afterauthor"/> - - <xsl:variable name="latex.book.preamble.post"> - <xsl:text>%% get rid of fancyhdr's rulers </xsl:text> - <xsl:text>\renewcommand{\headrulewidth}{0pt} </xsl:text> - <xsl:text>\renewcommand{\footrulewidth}{0pt} </xsl:text> - <xsl:text>\fancyhead[LE,RO]{\nouppercase{\rightmark}} </xsl:text> - <xsl:text>\fancyhead[LO,RE]{\nouppercase{\leftmark}} </xsl:text> - <xsl:text>\cfoot{} </xsl:text> - <xsl:text>\fancyfoot[LE,RO]{\thepage} </xsl:text> - <xsl:text>%% </xsl:text> - <xsl:text>%% hyphenation settings </xsl:text> - <xsl:text>\setlength\emergencystretch{3em} </xsl:text> - <xsl:text>\hyphenpenalty=1000 </xsl:text> - <xsl:text>\AtBeginDocument{\lefthyphenmin=3\righthyphenmin=3} </xsl:text> - <xsl:text>%% more space for floats </xsl:text> - <xsl:text>\renewcommand{\textfraction}{0.05}% </xsl:text> - <xsl:text>\renewcommand{\topfraction}{0.95}% </xsl:text> - <xsl:text>\renewcommand{\bottomfraction}{0.95}% </xsl:text> - <xsl:text>\renewcommand{\floatpagefraction}{0.35}% </xsl:text> - <xsl:text>%% some special lists </xsl:text> - <xsl:text>\usepackage{mdwlist} </xsl:text> - <xsl:text>% </xsl:text> - <xsl:text>%some special symbols </xsl:text> - <xsl:text>\providecommand\BibTeX{\textsc{Bib}\kern-0.08em\TeX} </xsl:text> - <xsl:text>\providecommand\Makeindex{\textit{Make\-Index}} </xsl:text> - <xsl:text>\providecommand\PiCTeX{P\kern-.12em\lower.5ex\hbox{I}\kern-.075emC\kern-.11em\TeX} </xsl:text> - <xsl:text>% Taken from "dtklogos.sty" </xsl:text> - <xsl:text><![CDATA[% tbd. for MP/MF]]> </xsl:text> - <xsl:text>\usepackage{shorttoc} </xsl:text> - <xsl:text>% </xsl:text> - <xsl:text>% Code to handle the revhistory, copyright, </xsl:text> - <xsl:text>% and legalnotice tags like we want </xsl:text> - <xsl:text><![CDATA[\newcommand*\mystartvskip{} -\newcommand*\myendvskip{} -\makeatletter -\begingroup -\def\vspace*#1{#1} -\@tempskipa=\chapterheadstartvskip\relax -\@tempskipa=-\@tempskipa -\xdef\mystartvskip{\the\@tempskipa} -\def\vspace#1{#1} -\@tempskipa=\chapterheadendvskip\relax -%\@tempskipa=-\@tempskipa -\xdef\myendvskip{\the\@tempskipa} -\endgroup - -\newcommand\originalsection{} -\let\originalsection=\section -\newcommand*\fakechapter{\@startsection{chapter}{0}{\z@}% - {\mystartvskip}% - {\myendvskip}% - {\raggedsection\normalfont\sectfont\nobreak\size@chapter\nobreak}} -\makeatother -]]> </xsl:text> - <xsl:text>% end of special code </xsl:text> - </xsl:variable> - - <!-- template overrides --> - - <xsl:template match="toc"> - <xsl:text> \def\dbtolatex@@contentsname{</xsl:text> - <xsl:variable name="title"> - <xsl:call-template name="extract.object.title"> - <xsl:with-param name="object" select="."/> - </xsl:call-template> - </xsl:variable> - <xsl:choose> - <xsl:when test="$title=''"> - <xsl:text>\dbtolatex@@contentsname</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="$title"/> - </xsl:otherwise> - </xsl:choose> - <xsl:text>} </xsl:text> - <xsl:choose> - <xsl:when test="starts-with(@condition,'db2latex:')"> - <xsl:text>\shorttoc{\dbtolatex@@contentsname}{</xsl:text> - <xsl:value-of select="substring-after(@condition,'db2latex:')"/> - <xsl:text>}</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:apply-imports/> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - - <!-- override 'revision' --> - <!-- use a more pleasant (IMHO) table layout for the 'revhistory' --> - <xsl:template match="revhistory/revision"> - <xsl:variable name="revnumber" select=".//revnumber"/> - <xsl:variable name="revdate" select=".//date"/> - <xsl:variable name="revauthor" select=".//authorinitials"/> - <xsl:variable name="revremark" select=".//revremark|.//revdescription"/> - - <xsl:if test="$revnumber"> - <xsl:call-template name="gentext.element.name"/> - <xsl:text> </xsl:text> - <xsl:apply-templates select="$revnumber"/> - </xsl:if> - <xsl:text> & </xsl:text> - <xsl:apply-templates select="$revdate"/> - <xsl:text> & </xsl:text> - <xsl:choose> - <xsl:when test="count($revauthor)=0"> - <xsl:call-template name="dingbat"> - <xsl:with-param name="dingbat">nbsp</xsl:with-param> - </xsl:call-template> - </xsl:when> - <xsl:otherwise> - <xsl:apply-templates select="$revauthor"/> - </xsl:otherwise> - </xsl:choose> - <xsl:text> \\ </xsl:text> - <xsl:if test="$revremark"> - <xsl:text>\multicolumn{3}{@{}l@{}}{\parbox{\linewidth-4\tabcolsep}{</xsl:text> - <xsl:apply-templates select="$revremark"/> - <xsl:choose> - <xsl:when test="position()!=last()"> - <xsl:text>\\[.2em]~}}\\</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text>\\~}}\\</xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:text> </xsl:text> - </xsl:if> - </xsl:template> - - - <!-- override maketile of db2latex --> - <xsl:variable name="latex.maketitle"> - <xsl:text>\maketitle </xsl:text> - </xsl:variable> - - <!-- override "verbatim.apply.templates": - we support attribute 'role' with different values - for 'fontsize', 'samepage', and 'lines' - (see 'fancyvrb' for details) - additionally we support 'landscape': places content on - separate pages in landscape mode - --> - <xsl:template name="verbatim.apply.templates"> - <xsl:if test="contains(@role,'landscape')"> - <xsl:text>\begin{landscape} </xsl:text> - </xsl:if> - <xsl:choose> - <xsl:when test="$latex.use.fancyvrb='1'"> - <xsl:variable name="not_monospaced" select="local-name(.)='literallayout' and @format!='monospaced'"/> - <xsl:text> \begin{Verbatim}[</xsl:text> - <xsl:if test="@linenumbering='numbered'"> - <xsl:text>,numbers=left</xsl:text> - </xsl:if> - <xsl:if test="$not_monospaced"> - <xsl:text>,fontfamily=default</xsl:text> - </xsl:if> - <!-- extensions by MW --> - <xsl:if test="@role"> - <xsl:if test="contains(@role,'small')"> - <xsl:text>,fontsize=\small</xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'footnotesize')"> - <xsl:text>,fontsize=\footnotesize</xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'scriptsize')"> - <xsl:text>,fontsize=\scriptsize</xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'large')"> - <xsl:text>,fontsize=\large</xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'Large')"> - <xsl:text>,fontsize=\Large</xsl:text> - </xsl:if> - <xsl:if test="contains(@role, 'samepage')"> - <xsl:text>,samepage=true</xsl:text> - </xsl:if> - <xsl:if test="contains(@role, 'lines')"> - <xsl:text>,frame=lines</xsl:text> - </xsl:if> - </xsl:if> - <xsl:text>] </xsl:text> - <xsl:choose> - <xsl:when test="$not_monospaced"> - <!-- Needs to be changed to cope with regular characterset! --> - <xsl:apply-templates mode="latex.verbatim"/> - </xsl:when> - <xsl:otherwise> - <xsl:apply-templates mode="latex.verbatim"/> - </xsl:otherwise> - </xsl:choose> - <xsl:text> \end{Verbatim} </xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text> \begin{verbatim} </xsl:text> - <xsl:apply-templates mode="latex.verbatim"/> - <xsl:text> \end{verbatim} </xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:if test="contains(@role,'landscape')"> - <xsl:text>\end{landscape} </xsl:text> - </xsl:if> - </xsl:template> - - <!-- override: use 'role="nohyphenation"' to avoid hyphenation in title's --> - <xsl:template match="filename"> - <xsl:choose> - <xsl:when test="contains(@role,'nohyphenation')"> - <xsl:call-template name="inline.monoseq"><xsl:with-param name="hyphenation"></xsl:with-param></xsl:call-template> - </xsl:when> - <xsl:otherwise> - <xsl:call-template name="inline.monoseq"><xsl:with-param name="hyphenation">\docbookhyphenatefilename</xsl:with-param></xsl:call-template> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - - <!-- override floatstyles for figures and tables --> - <!-- we use 'floatstyle=plain' for figures and tables --> - <xsl:template name="latex.float.preamble"> - <xsl:text>% -------------------------------------------- </xsl:text> - <xsl:text>% Commands to manage/style/create floats </xsl:text> - <xsl:text>% figures, tables, algorithms, examples, eqn </xsl:text> - <xsl:text>% Customized for DAHB by mw, 20030506 </xsl:text> - <xsl:text>% -------------------------------------------- </xsl:text> - <xsl:text> \floatstyle{plain} </xsl:text> - <xsl:text> \restylefloat{figure} </xsl:text> - <xsl:text> \floatstyle{plain} </xsl:text> - <xsl:text> \restylefloat{table} </xsl:text> - <xsl:text> \floatstyle{ruled} </xsl:text> - <xsl:text> \newfloat{program}{ht}{lop}[section] </xsl:text> - <xsl:text> \floatstyle{ruled} </xsl:text> - <xsl:text> \newfloat{example}{ht}{loe}[section] </xsl:text> - <xsl:text> \floatname{example}{</xsl:text> - <xsl:call-template name="gentext.element.name"> - <xsl:with-param name="element.name">example</xsl:with-param> - </xsl:call-template> - <xsl:text>} </xsl:text> - <xsl:text> \floatstyle{ruled} </xsl:text> - <xsl:text> \newfloat{dbequation}{ht}{loe}[section] </xsl:text> - <xsl:text> \floatname{dbequation}{</xsl:text> - <xsl:call-template name="gentext.element.name"> - <xsl:with-param name="element.name">equation</xsl:with-param> - </xsl:call-template> - <xsl:text>} </xsl:text> - <xsl:text> \floatstyle{boxed} </xsl:text> - <xsl:text> \newfloat{algorithm}{ht}{loa}[section] </xsl:text> - <xsl:text> \floatname{algorithm}{Algorithm} </xsl:text> - </xsl:template> - - <!-- override informaltable: we want a smaller font --> - <xsl:template match="informaltable"> - <xsl:if test="contains(@role,'Large')"> - <xsl:text>\Large </xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'large')"> - <xsl:text>\large </xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'small')"> - <xsl:text>\small </xsl:text> - </xsl:if> - <xsl:if test="contains(@role,'footnotesize')"> - <xsl:text>\footnotesize </xsl:text> - </xsl:if> - - <xsl:call-template name="map.begin"/> - <xsl:apply-templates/> - <xsl:call-template name="map.end"/> - - <xsl:text>\normalsize </xsl:text> - </xsl:template> - - <!-- we want "\noindent" in some cases --> - <xsl:template match="para|simpara"> - <xsl:choose> - <xsl:when test="contains(@role,'db2latex:noindent')"> - <xsl:text>\noindent </xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text> </xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:apply-templates/> - <xsl:choose> - <xsl:when test="contains(@role,'db2latex:noindent')"> - <xsl:text>\vspace{1ex}\par</xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text> </xsl:text> - </xsl:otherwise> - </xsl:choose> - <xsl:text> </xsl:text> - </xsl:template> - - <!-- include modified table templates. - Snapshot up to 2003-10-01 is buggy. - --> - <xsl:include href="db2latex-mw-table.xsl"/> - - <!-- include modified (enhanced) variablelist template --> - <xsl:include href="db2latex-mw-variablelist.xsl"/> - - <!-- include modified (enhanced) itemizedlist template --> - <xsl:include href="db2latex-mw-itemizedlist.xsl"/> - - <xsl:template match="bridgehead" name="bridgehead"> - <xsl:param name="renderas" select="@renderas"/> - <xsl:param name="content"><xsl:apply-templates/></xsl:param> - <xsl:choose> - <xsl:when test="$renderas='sect1' or $renderas='sect2' or $renderas='sect3'"> - <xsl:text> \</xsl:text> - <xsl:if test="$renderas='sect2'"><xsl:text>sub</xsl:text></xsl:if> - <xsl:if test="$renderas='sect3'"><xsl:text>subsub</xsl:text></xsl:if> - <xsl:text>section*{</xsl:text> - <xsl:copy-of select="$content"/> - <xsl:text>}</xsl:text> - <xsl:call-template name="label.id"/> - <xsl:text> </xsl:text> - </xsl:when> - <xsl:otherwise> - <xsl:text> </xsl:text> - <!-- <xsl:text>\vspace{1em}\noindent{\bfseries </xsl:text><xsl:copy-of select="$content"/><xsl:text>}</xsl:text> --> - <xsl:text>\noindent\subparagraph*{</xsl:text><xsl:copy-of select="$content"/><xsl:text>}</xsl:text> - <xsl:call-template name="label.id"/> - <!-- changed, original was: \par\noindent --> - <xsl:text>\par </xsl:text> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - - <xsl:template name="generate.bookinfo.copyright"> - <xsl:apply-templates select="copyright" /> - </xsl:template> - - <xsl:template match="copyright"> - <xsl:if test="count(preceding-sibling::copyright)=0"> - <xsl:text>% switch to fake section </xsl:text> - <xsl:text>\let\section=\fakechapter </xsl:text> - <xsl:text>\section*{</xsl:text> - <xsl:call-template name="gentext.element.name"/> - <xsl:text>} </xsl:text> - </xsl:if> - <xsl:call-template name="gentext.element.name"/> - <xsl:call-template name='gentext.space'/> - <xsl:call-template name="dingbat"> - <xsl:with-param name="dingbat">copyright</xsl:with-param> - </xsl:call-template> - <xsl:call-template name='gentext.space'/> - <xsl:apply-templates select="year"/> - <xsl:call-template name='gentext.space'/> - <xsl:apply-templates select="holder"/> - <xsl:if test="count(following-sibling::copyright)>0"> - <xsl:text>\newline</xsl:text> - </xsl:if> - <xsl:text> </xsl:text> - </xsl:template> - - <xsl:template match="legalnotice"> - <xsl:text>\section*{</xsl:text> - <xsl:call-template name="legalnotice.title"/> - <xsl:text>} </xsl:text> - <xsl:text>\small </xsl:text> - <xsl:apply-templates select="node()[not(self::title)]"/> - <xsl:text>%\vspace{0.6em}\par </xsl:text> - <xsl:text>\normalsize\rmfamily </xsl:text> - <xsl:text>% switch back to normal section </xsl:text> - <xsl:text>\let\section=\originalsection </xsl:text> - </xsl:template> - - <xsl:template match="symbol"> - <xsl:param name="entity"><xsl:value-of select="." /></xsl:param> - <xsl:choose> - <xsl:when test="$entity='--'"><xsl:text>--</xsl:text></xsl:when> - <xsl:when test="$entity='BibTeX'"><xsl:text>{\BibTeX{}}</xsl:text></xsl:when> - <xsl:when test="$entity='LaTeX'"><xsl:text>{\LaTeX{}}</xsl:text></xsl:when> - <xsl:when test="$entity='LaTeX2e'"><xsl:text>{\LaTeXe{}}</xsl:text></xsl:when> - <xsl:when test="$entity='Makeindex'"><xsl:text>{\Makeindex{}}</xsl:text></xsl:when> - <xsl:when test="$entity='PiCTeX'"><xsl:text>{\PiCTeX{}}</xsl:text></xsl:when> - <xsl:when test="$entity='TeX'"><xsl:text>{\TeX{}}</xsl:text></xsl:when> - <xsl:otherwise> - <xsl:call-template name="inline.charseq"/> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - - - <!-- testing --> - - <xsl:template name="label.id"> - <xsl:text> % MW: label.id </xsl:text> - <xsl:param name="object" select="."/> - <xsl:text>\label{</xsl:text> - <xsl:call-template name="generate.label.id"> - <xsl:with-param name="object" select="$object"/> - </xsl:call-template> - <xsl:text>}</xsl:text> - </xsl:template> - - <xsl:template name="generate.label.id"> - <xsl:param name="object" select="."/> - <xsl:variable name="id"> - <xsl:choose> - <xsl:when test="$object/@id"> - <xsl:value-of select="$object/@id"/> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="generate-id($object)"/> - </xsl:otherwise> - </xsl:choose> - </xsl:variable> - <xsl:value-of select="normalize-space($id)"/> - </xsl:template> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-plucker.xsl b/Master/texmf-doc/source/english/tex-refs/tex-refs-plucker.xsl deleted file mode 100644 index 76c85da75ae..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-plucker.xsl +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version="1.0"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version="1.0" - xmlns="http://www.w3.org/TR/xhtml1/transitional" - exclude-result-prefixes="#default"> - - <!-- $Id: tex-refs-plucker.xsl 125 2004-04-06 19:55:32Z mw $ --> - - <!-- we use an XML catalog to resolve this file --> - <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.64.1/html/docbook.xsl"/> - - <!-- import common customizations --> - <xsl:import href="tex-refs-common.xsl"/> - - <!-- insert customization here --> - <!-- up to now we don't need any special customizations for plucker --> - -</xsl:stylesheet> diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-xinclude.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-xinclude.xml deleted file mode 100644 index 0a3ac121209..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-xinclude.xml +++ /dev/null @@ -1,274 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> -<!-- <?xml-stylesheet href="docbook-css/driver.css" type="text/css"?> --> - -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-xinclude.xml 148 2005-05-14 15:43:12Z mw $ --> - -<book lang="en"> - - <bookinfo id="bookinfo"> - - <title id="bookinfo-title">References for &tex; and Friends</title> - - <author> - <firstname>Michael</firstname> - <surname>Wiedmann</surname> - <affiliation> - <address><email>mw at miwie dot in-berlin dot de</email></address> - </affiliation> - </author> - - <date>V&rev; &date;</date> - - <revhistory> - - <revision> - <revnumber>&rev;</revnumber> - <date>&date;</date> - <revremark>tbd. - </revremark> - </revision> - - <revision> - <revnumber>0.2.0</revnumber> - <date>2003-01-11</date> - <revremark>License changed to - <ulink url="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License</ulink>. - </revremark> - </revision> - - <revision> - <revnumber>0.0.1</revnumber> - <date>2002-06-21</date> - <revremark>This version was adapted from the edition 1.6 - of the &latex2e; documentation, converted to &docbook; XML - using - <ulink url="http://www.tldp.org/downloads/">texi2db</ulink>, - and further edited manually. - </revremark> - </revision> - </revhistory> - - <copyright> - <year>?</year> - <holder>Stephen Gilmore</holder> - </copyright> - <copyright> - <year>?</year> - <holder>Torsten Martinsen</holder> - </copyright> - <copyright> - <year>1988, 1994</year> - <holder>Free Software Foundation, Inc.</holder> - </copyright> - <copyright> - <year>1994 ‐ 1996</year> - <holder>Torsten Martinsen</holder> - </copyright> - <copyright> - <year>2002, 2003</year> - <holder>Peter Karp, Michael Wiedmann</holder> - </copyright> - <copyright> - <year>2004, 2005</year> - <holder>Michael Wiedmann</holder> - </copyright> - - <legalnotice> - <title>License</title> - <para>Permission is granted to copy, distribute and/or modify - this document under the terms of the - GNU Free Documentation License, Version 1.2 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no - Back-Cover Texts. - </para> - </legalnotice> - - </bookinfo> - - - <preface id="preface"> - <title>Preface</title> - <para role="db2latex:noindent">&latex2e; is a document preparation - system implemented as a macro package for Donald E. Knuth's - &tex; typesetting program. - </para> - <para role="db2latex:noindent">&latex; was originally conceived by - Leslie Lamport. - </para> - <para role="db2latex:noindent">This updated &latex; reference - is by no means complete, - but it's a first step towards a more complete &latex; reference! - We welcome if we'll get pointed to missing commands or even - better when you make additions and further improvements and - send them to the authors. - </para> - <para role="db2latex:noindent"> - <ulink url="http://www.tug.org">TUG (&tex; User Group)</ulink> - and - <ulink url="http://www.dante.de">DANTE (German &tex; User Group)</ulink> - both have excellent FAQ's which answer many questions or - give great pointers to additional resources both on the - internet or in books. Most if not all missing packages - can also be found on the CTAN servers. - </para> - <para role="db2latex:noindent">This reference is not meant to - replace the package documentation or the standard literature - like the &latex; handbook and the &latex; companion. - Look there for detailed - descriptions of the commands and even mostly more options and - examples. - </para> - <para role="db2latex:noindent">The authors intend to extend - this documentation to other - &tex; related packages (e.g. ConTeXt, &metapost;, &metafont;, - etc.). Contributions are very welcome! - </para> - </preface> - - <preface id ="credits"> - <title>Credits</title> - <indexterm> - <primary>Credits</primary> - </indexterm> - <para>The following people have contributed substantial parts - to this documentation project or helped in some other way - (listed alphabetically): - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>Karl Berry</simpara> - <indexterm> - <primary>People</primary> - <secondary>Berry, Karl</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Wolfgang Borgert</simpara> - <indexterm> - <primary>People</primary> - <secondary>Borgert, Wolfgang</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Ramon Casellas</simpara> - <indexterm> - <primary>People</primary> - <secondary>Casellas, Ramon</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Holger Danielsson</simpara> - <indexterm> - <primary>People</primary> - <secondary>Danielsson, Holger</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>James Devenish</simpara> - <indexterm> - <primary>People</primary> - <secondary>Devenish, James</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Hubert Gaesslein</simpara> - <indexterm> - <primary>People</primary> - <secondary>Gaesslein, Hubert</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Peter Karp</simpara> - <indexterm> - <primary>People</primary> - <secondary>Karp, Peter</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Rolf Niepraschk</simpara> - <indexterm> - <primary>People</primary> - <secondary>Niepraschk, Rolf</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Hans Fredrik Nordhaug</simpara> - <indexterm> - <primary>People</primary> - <secondary>Nordhaug, Hans Fredrik</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Simon Pepping</simpara> - <indexterm> - <primary>People</primary> - <secondary>Pepping, Simon</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Bob Stayton</simpara> - <indexterm> - <primary>People</primary> - <secondary>Stayton, Bob</secondary> - </indexterm> - </listitem> - <listitem> - <simpara>Herbert Voss</simpara> - <indexterm> - <primary>People</primary> - <secondary>Voss, Herbert</secondary> - </indexterm> - </listitem> - </itemizedlist> - </preface> - - <!-- was proof of concept - <toc condition="db2latex:0"> - <title>Short Contents</title> - </toc> - --> - - <toc> - <title>Table of Contents</title> - </toc> - - <!-- FIXME - <lot label="tables"> - </lot> - --> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-tex.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-pdftex.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-metafont.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-metapost.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-bibtex.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-makeindex.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-xindy.xml" /> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" - href="tex-refs-chapter-appendices.xml" /> - - -</book> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs.css b/Master/texmf-doc/source/english/tex-refs/tex-refs.css deleted file mode 100644 index c4d1e1bdc53..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs.css +++ /dev/null @@ -1,124 +0,0 @@ -/* $Id: tex-refs.css 120 2004-03-26 20:19:43Z mw $ */ - -body { background-color: whitesmoke; - } - -h1.title { background-color: gainsboro; - text-align: center; - font-family: sans-serif; - color: black; - } - -h2.title { background-color: gainsboro; - font-family: sans-serif; - color: black; - } - -h3.title { background-color: gainsboro; - font-family: sans-serif; - color: black; - } - -h4.title { background-color: gainsboro; - font-family: sans-serif; - color: black; - } -h5.title { background-color: gainsboro; - font-family: sans-serif; -/* font-size: small; */ - color: black; - } -h6.title { background-color: gainsboro; - font-family: sans-serif; -/* font-size: x-small; */ - font-size: small; - color: black; - } -span.title { background-color: gainsboro; - font-family: sans-serif; -/* font-size: x-small; */ - font-size: small; - color: black; - } - -.title { background-color: gainsboro; - font-family: sans-serif; - } - -.authorgroup { - background-color: #EEEEEE - } - -.copyright { - } - -.legalnotice { - } - -.revhistory { - } - -.abstract { - margin-top: 1em - } - -.toc { - } - -.itemizedlist { - } - -.orderedlist { - } - -.variablelist { - } - -.term { background-color: #EFEFEF - } - -pre.programlisting -{ - background-color: #E0E0E0; - border: thin solid gray; - margin-top: 1.33ex; - margin-bottom: 1.33ex; -} - - -.footer-date { font-size: xx-small; - font-family: monospace; - } - - -#customheader, #customfooter -{ - /* list of fonts provides fallbacks if a font is not present */ - font-family: Verdana, Arial, Helvetica, Sans-Serif; - /* font size, relative to body font size */ - font-size: 80%; - - /* line height, relative to body font size */ - line-height: 200%; - - text-align: center; - vertical-align: middle; - color: #fff; - background-color: #009; -} - -/* leave more space between last paragraph and footer */ -/* some browser do not add up the bottom margin of the prior element */ -/* and the top margin of the footer */ -#customfooter { - margin-top: 15px; -} - -/* define special font for logo */ -/* list of fonts provides fallbacks in case selected fonts are not present -*/ -.logo -{ - font-family: Lucida Console, Verdana, Arial, Sans-Serif; -} - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs.ent b/Master/texmf-doc/source/english/tex-refs/tex-refs.ent deleted file mode 100644 index e0a001751a1..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs.ent +++ /dev/null @@ -1,40 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1" ?> - -<!-- $Id: tex-refs.ent 146 2005-05-14 15:34:22Z mw $ --> - -<!ENTITY date "2005-0X-YY"> -<!ENTITY abbrdate "05-0X-YY"> -<!ENTITY rev "0.3.10"> - -<!ENTITY bibtex "<symbol>BibTeX</symbol>"> -<!ENTITY context "ConTeXt"> -<!ENTITY dash "<symbol>--</symbol>"> -<!ENTITY dic "DocBook In ConTeXt"> -<!ENTITY komascript "KOMA-Script"> -<!ENTITY latex2e "<symbol>LaTeX2e</symbol>"> -<!ENTITY latex "<symbol>LaTeX</symbol>"> -<!ENTITY makeindex "<symbol>Makeindex</symbol>"> -<!ENTITY metafont "Metafont"> -<!ENTITY metapost "MetaPost"> -<!ENTITY pdftex "pdf<symbol>TeX</symbol>"> -<!ENTITY pdflatex "pdf<symbol>LaTeX</symbol>"> -<!ENTITY pictex "<symbol>PiCTeX</symbol>"> -<!ENTITY plaintex "Plain<symbol>TeX</symbol>"> -<!ENTITY pstricks "PSTricks"> -<!ENTITY tex "<symbol>TeX</symbol>"> -<!ENTITY texinfo "Texinfo"> -<!ENTITY xindy "xindy"> - -<!ENTITY Default "Default:"> -<!ENTITY tbd "tbd."> -<!ENTITY overview "Overview"> - -<!ENTITY db2latex "DB2<symbol>LaTeX</symbol> XSL Stylesheets (V0.8pre1+20050330"> -<!ENTITY docbook "DocBook"> -<!ENTITY docbookxml "DocBook XML (V4.3)"> -<!ENTITY docbookxsl "DocBook XSL Stylesheets (V1.68.1)"> -<!ENTITY komascript "KOMA-Script"> -<!ENTITY lmodern "Latin Modern Type 1 Fonts (V0.92)"> -<!ENTITY komabook "scrbook [2004/09/16 v2.9t LaTeX2e KOMA document class]"> -<!ENTITY xsltp "xsltproc (libxml2-2.6.16/libxslt-1.1.12)"> - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs.ist b/Master/texmf-doc/source/english/tex-refs/tex-refs.ist deleted file mode 100644 index 798909a0ce0..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs.ist +++ /dev/null @@ -1,18 +0,0 @@ -% Index-Style for tex-refs, taken from: -% Index-Style fuer DE-TeX-FAQ; aehnlich `scrguide.ist'; 2000/01/22; RN - -% $Id: tex-refs.ist 120 2004-03-26 20:19:43Z mw $ - -preamble "\\begin{theindex}\\small\\raggedright\n" -postamble "\n\\indexspace\\end{theindex}\n" - -delim_0 "~\\dotfill~" -delim_1 "~\\dotfill~" -delim_2 "~\\dotfill~" - -heading_prefix "\\textbf{\\sectfont " -heading_suffix "}\\nopagebreak\n" -headings_flag 1 - -%% End of file `tex-refs.ist'. - diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs.xsl b/Master/texmf-doc/source/english/tex-refs/tex-refs.xsl deleted file mode 100644 index 7a77ee198e5..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs.xsl +++ /dev/null @@ -1,48 +0,0 @@ -<?xml version="1.0"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version="1.0" - xmlns="http://www.w3.org/TR/xhtml1/transitional" - exclude-result-prefixes="#default"> - - <!-- $Id: tex-refs.xsl 142 2004-10-24 15:13:24Z mw $ --> - - <!-- <xsl:import href="file:///home/mw/docbook-xsl/xhtml/docbook.xsl"/> --> - <!-- we use an XML catalog to resolve this file --> - <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"/> - - <!-- import common customizations --> - <xsl:import href="tex-refs-common.xsl"/> - - <xsl:output method="html" - encoding="ISO-8859-1" - indent="no"/> - - <!-- insert customization here --> - - <xsl:param name="section.autolabel" select="1"/> - <xsl:param name="html.stylesheet" select="'tex-refs.css'"/> - - <!-- override bridgehead to pass down a class "attribute" --> - <xsl:template match="bridgehead"> - <xsl:variable name="hlevel"> - <xsl:choose> - <xsl:when test="@renderas = 'sect1'">1</xsl:when> - <xsl:when test="@renderas = 'sect2'">2</xsl:when> - <xsl:when test="@renderas = 'sect3'">3</xsl:when> - <xsl:when test="@renderas = 'sect4'">4</xsl:when> - <xsl:when test="@renderas = 'sect5'">5</xsl:when> - <xsl:otherwise> - <xsl:value-of select="5"/> - </xsl:otherwise> - </xsl:choose> - </xsl:variable> - <xsl:element name="h{$hlevel}" namespace="http://www.w3.org/1999/xhtml"> - <xsl:attribute name="class"><xsl:text>title</xsl:text></xsl:attribute> - <xsl:call-template name="anchor"> - <xsl:with-param name="conditional" select="0"/> - </xsl:call-template> - <xsl:apply-templates/> - </xsl:element> - </xsl:template> - -</xsl:stylesheet> |