diff options
| author | Karl Berry <karl@freefriends.org> | 2009-05-23 00:17:44 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2009-05-23 00:17:44 +0000 |
| commit | cfd5aee575d84f09834ffcf92e5ad51c7cac38ca (patch) | |
| tree | 9bb827d3c2a6f3d57148a6b4c9312a9f559acaaa /Master/texmf-dist/doc/generic/tex-refs | |
| parent | ac7c62d7555a6cebca926dc51ebc39cb235982db (diff) | |
move tex-refs and knuth out of texmf-doc
git-svn-id: svn://tug.org/texlive/trunk@13409 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/generic/tex-refs')
| -rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/README | 61 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/tex-refs-source.tar.gz | bin | 0 -> 130491 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/tex-refs.css | 124 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/tex-refs.html | 14590 |
4 files changed, 14775 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/generic/tex-refs/README b/Master/texmf-dist/doc/generic/tex-refs/README new file mode 100644 index 00000000000..90313b718a6 --- /dev/null +++ b/Master/texmf-dist/doc/generic/tex-refs/README @@ -0,0 +1,61 @@ +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-dist/doc/generic/tex-refs/tex-refs-source.tar.gz b/Master/texmf-dist/doc/generic/tex-refs/tex-refs-source.tar.gz Binary files differnew file mode 100644 index 00000000000..85f7e85cad8 --- /dev/null +++ b/Master/texmf-dist/doc/generic/tex-refs/tex-refs-source.tar.gz diff --git a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.css b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.css new file mode 100644 index 00000000000..c4d1e1bdc53 --- /dev/null +++ b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.css @@ -0,0 +1,124 @@ +/* $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-dist/doc/generic/tex-refs/tex-refs.html b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.html new file mode 100644 index 00000000000..34dfbf0e52c --- /dev/null +++ b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.html @@ -0,0 +1,14590 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta content="HTML Tidy for Linux/x86 (vers 1st February 2003), see www.w3.org" + name="generator" /> +<meta http-equiv="Content-Type" +content="text/html; charset=us-ascii" /> +<title>References for TeX and Friends</title> +<link rel="stylesheet" href="tex-refs.css" type="text/css" /> +<meta name="generator" content="DocBook XSL Stylesheets V1.66.1" /> +</head> +<body> +<div class="book" lang="en"> +<div class="titlepage"> +<div> +<div> +<h1 class="title"><a id="id2405204"></a>References for TeX and +Friends</h1></div> +<div> +<div class="author"> +<h3 class="author"><span class="firstname">Michael</span> +<span class="surname">Wiedmann</span></h3> +<div class="affiliation"> +<div class="address"> +<p> +<tt class="email"><<a href="mailto:mw%20at%20miwie%20dot%20in-berlin%20dot%20de"> +mw at miwie dot in-berlin dot de</a>></tt></p></div></div></div></div> +<div> +<p class="copyright">Copyright © ? Stephen Gilmore</p></div> +<div> +<p class="copyright">Copyright © ? Torsten Martinsen</p></div> +<div> +<p class="copyright">Copyright © 1988, 1994 Free Software +Foundation, Inc.</p></div> +<div> +<p class="copyright">Copyright © 1994 - 1996 Torsten +Martinsen</p></div> +<div> +<p class="copyright">Copyright © 2002, 2003 Peter Karp, +Michael Wiedmann</p></div> +<div> +<p class="copyright">Copyright © 2004, 2005 Michael +Wiedmann</p></div> +<div> +<div class="legalnotice"><a id="id2451479"></a> +<p class="legalnotice-title"><b>License</b></p> +<p>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.</p></div></div> +<div> +<div class="revhistory"> +<table border="2" cellspacing="4" width="100%" +summary="Revision history"> +<tr> +<th align="left" valign="top" colspan="2"><b>Revision +History</b></th></tr> +<tr> +<td align="left">Revision 0.3.9</td> +<td align="left">2005-05-14</td></tr> +<tr> +<td align="left" colspan="2">Consistent naming scheme of IDs to +ease the use of this reference for other projects; added new +section <a href="#float" title="3.3 float">float</a> in chapter +<a href="#latex" title="2 LaTeX">LaTeX</a>.</td></tr> +<tr> +<td align="left">Revision 0.2.0</td> +<td align="left">2003-01-11</td></tr> +<tr> +<td align="left" colspan="2">License changed to +<a href="http://www.gnu.org/licenses/fdl.html" target="_top">GNU +Free Documentation License</a>.</td></tr> +<tr> +<td align="left">Revision 0.0.1</td> +<td align="left">2002-06-21</td></tr> +<tr> +<td align="left" colspan="2">This version was adapted from the +edition 1.6 of the LaTeX2e documentation, converted to DocBook XML +using <a href="http://www.tldp.org/downloads/" +target="_top">texi2db</a>, and further edited +manually.</td></tr></table></div></div></div> +<hr /></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt> +<span class="preface"><a href="#preface">Preface</a></span></dt> +<dt> +<span class="preface"><a href="#credits">Credits</a></span></dt> +<dt><span class="chapter"><a href="#tex">1 TeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#plaintex">1 +PlainTeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#plaintex-ovw">1.1 +Overview</a></span></dt></dl></dd> +<dt><span class="section"><a href="#latex">2 LaTeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#opt-latex">2.1 +Options</a></span></dt> +<dt><span class="section"><a href="#overview">2.2 Overview of LaTeX +and Local Guide</a></span></dt> +<dt><span class="section"><a href="#commands">2.3 +Commands</a></span></dt> +<dt><span class="section"><a href="#parameters">2.4 +Parameters</a></span></dt></dl></dd> +<dt><span class="section"><a href="#latex-packages">3 LaTeX +Packages</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#amsmath">3.1 +<tt class="filename">amsmath</tt></a></span></dt> +<dt><span class="section"><a href="#dcolumn">3.2 +<tt class="filename">dcolumn</tt></a></span></dt> +<dt><span class="section"><a href="#float">3.3 +<tt class="filename">float</tt></a></span></dt> +<dt><span class="section"><a href="#fontenc">3.4 +<tt class="filename">fontenc</tt></a></span></dt> +<dt><span class="section"><a href="#german">3.5 +<tt class="filename">german</tt></a></span></dt> +<dt><span class="section"><a href="#graphics">3.6 +<tt class="filename">graphics</tt></a></span></dt> +<dt><span class="section"><a href="#hyperref">3.7 +<tt class="filename">hyperref</tt></a></span></dt> +<dt><span class="section"><a href="#inputenc">3.8 +<tt class="filename">inputenc</tt></a></span></dt> +<dt><span class="section"><a href="#komascript">3.9 +<tt class="filename">KOMA-Script</tt></a></span></dt> +<dt><span class="section"><a href="#mathpazo">3.10 +<tt class="filename">mathpazo</tt></a></span></dt> +<dt><span class="section"><a href="#varioref">3.11 +<tt class="filename">varioref</tt></a></span></dt> +<dt><span class="section"><a href="#small-packages">3.12 Several +Small Packages</a></span></dt></dl></dd> +<dt><span class="section"><a href="#generic-packages">4 Generic +Packages</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#pictex">4.1 PiCTeX +(tbd.)</a></span></dt> +<dt><span class="section"><a href="#pstricks">4.2 +PSTricks</a></span></dt></dl></dd> +<dt><span class="section"><a href="#fontinst">5 +<tt class="filename">fontinst</tt> (tbd.)</a></span></dt> +<dt><span class="section"><a href="#context">6 ConTeXt +(tbd.)</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#context-ovw">6.1 +Overview</a></span></dt></dl></dd> +<dt><span class="section"><a href="#texinfo">7 Texinfo +(tbd.)</a></span></dt></dl></dd> +<dt><span class="chapter"><a href="#pdftex">2 +pdfTeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#pdftex-options">1 +Options</a></span></dt> +<dd> +<dl> +<dt> +<span class="section"><a href="#pdftex-option-file-line-error-style"> +1.1 +<tt class="filename">--file-line-error-style</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-fmt">1.2 +<tt class="filename">--fmt format</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-help">1.3 +<tt class="filename">--help</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-ini">1.4 +<tt class="filename">--ini</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-interaction%20mode">1.5 +<tt class="filename">--interaction mode</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-ipc">1.6 +<tt class="filename">--ipc</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-ipc-start">1.7 +<tt class="filename">--ipc-start</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-jobname-name">1.8 +<tt class="filename">--jobname name</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-kpathsea-debug">1.9 +<tt class="filename">--kpathsea-debug bitmask</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-maketex">1.10 +<tt class="filename">--maketex fmt</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-no-maketex">1.11 +<tt class="filename">--no-maketex fmt</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-output-comment">1.12 +<tt class="filename">--output-comment string</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-parse-first-line">1.13 +<tt class="filename">--parse-first-line</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-progname">1.14 +<tt class="filename">--progname name</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-recorder">1.15 +<tt class="filename">--recorder</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-shell-escape">1.16 +<tt class="filename">--shell-escape</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-translate-file">1.17 +<tt class="filename">--translate-file tcxname</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-version">1.18 +<tt class="filename">--version</tt></a></span></dt></dl></dd> +<dt><span class="section"><a href="#pdftex-environment">2 +Environment</a></span></dt></dl></dd> +<dt><span class="chapter"><a href="#metafont">3 Metafont +(tbd.)</a></span></dt> +<dt><span class="chapter"><a href="#metapost">4 +MetaPost</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#metapost-options">1 +Options</a></span></dt> +<dd> +<dl> +<dt> +<span class="section"><a href="#metapost-option-file-line-error-style"> +1.1 +<tt class="filename">--file-line-error-style</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-help">1.2 +<tt class="filename">--help</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-ini">1.3 +<tt class="filename">--ini</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-intercation">1.4 +<tt class="filename">--interaction mode</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-jobname">1.5 +<tt class="filename">--jobname name</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-kpathsea-debug">1.6 +<tt class="filename">--kpathsea-debug bitmask</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-mem">1.7 +<tt class="filename">--mem mem</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-parse-first-line">1.8 +<tt class="filename">--parse-first-line</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-progname">1.9 +<tt class="filename">--progname name</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-recorder">1.10 +<tt class="filename">--recorder</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-T">1.11 +<tt class="filename">-T</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-translate-file">1.12 +<tt class="filename">--translate-file tcxname</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-troff">1.13 +<tt class="filename">--troff</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-version">1.14 +<tt class="filename">--version</tt></a></span></dt></dl></dd> +<dt><span class="section"><a href="#metapost-environment">2 +Environment</a></span></dt></dl></dd> +<dt><span class="chapter"><a href="#bibtex">5 +BibTeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#bibtex-parameters">1 +Parameters</a></span></dt> +<dt><span class="section"><a href="#bibtex-command-qualifiers">2 +Command Qualifiers</a></span></dt> +<dt><span class="section"><a href="#bibtex-bib-files">3 bib +files</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#bibtex-string-command">3.1 +<tt class="filename">@STRING</tt> command</a></span></dt> +<dt><span class="section"><a href="#bibtex-entry-format">3.2 Entry +Format</a></span></dt> +<dt><span class="section"><a href="#bibtex-entry-types">3.3 Entry +Types</a></span></dt> +<dt><span class="section"><a href="#bibtex-field-text">3.4 Field +Text</a></span></dt> +<dt><span class="section"><a href="#bibtex-field-types">3.5 Field +Types</a></span></dt></dl></dd> +<dt><span class="section"><a href="#bibtex-bst-files">4 bst +files</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#bibtex-bst-abbr">4.1 +<tt class="filename">ABBRV.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-alpha">4.2 +<tt class="filename">ALPHA.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-plain">4.3 +<tt class="filename">PLAIN.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-sample">4.4 +<tt class="filename">SAMPLE.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-unsrt">4.5 +<tt class="filename">UNSRT.BST</tt></a></span></dt></dl></dd></dl></dd> +<dt><span class="chapter"><a href="#makeindex">6 +Make-Index</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#makeindex-options">1 +Options</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#makeindex-option-c">1.1 +<tt class="filename">-c</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-g">1.2 +<tt class="filename">-g</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-i">1.3 +<tt class="filename">-i</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-l">1.4 +<tt class="filename">-l</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-q">1.5 +<tt class="filename">-q</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-r">1.6 +<tt class="filename">-r</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-s-sty">1.7 +<tt class="filename">-s sty</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-o-ind">1.8 +<tt class="filename">-o ind</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-t-log">1.9 +<tt class="filename">-t log</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-p-no">1.10 +<tt class="filename">-p no</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-L">1.11 +<tt class="filename">-L</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-T">1.12 +<tt class="filename">-T</tt></a></span></dt></dl></dd> +<dt><span class="section"><a href="#makeindex-style-file">2 Style +File</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#makeindex-style">2.1 Input +Style Specifiers</a></span></dt> +<dt> +<span class="section"><a href="#makeindex-output-style-specs">2.2 +Output Style Specifiers</a></span></dt></dl></dd> +<dt><span class="section"><a href="#makeindex-example">3 +Example</a></span></dt> +<dt><span class="section"><a href="#makeindex-ordering">4 +Ordering</a></span></dt> +<dt><span class="section"><a href="#makeindex-special-effects">5 +Special Effects</a></span></dt></dl></dd> +<dt><span class="chapter"><a href="#xindy">7 xindy</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#xindy-command-list">1 Command +List</a></span></dt> +<dd> +<dl> +<dt> +<span class="section"><a href="#xindy-command-list-processing">1.1 +Processing Commands</a></span></dt> +<dt><span class="section"><a href="#xindy-command-list-markup">1.2 +Markup Commands</a></span></dt> +<dt> +<span class="section"><a href="#xindy-command-list-raw-index">1.3 +Raw Index Interface</a></span></dt></dl></dd> +<dt><span class="section"><a href="#xindy-invoking">2 Invoking +xindy</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#xindy-invoking-cmdline">2.1 +Command Line Options</a></span></dt> +<dt><span class="section"><a href="#xindy-search-path">2.2 Search +Path</a></span></dt></dl></dd></dl></dd> +<dt><span class="appendix"><a href="#appendices">A +Appendices</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#issues">1 Bugs / Known Issues / +Missing Features</a></span></dt> +<dt><span class="section"><a href="#about">2 About this +Document</a></span></dt> +<dt><span class="section"><a href="#release-news">3 Release +News</a></span></dt> +<dt><span class="section"><a href="#gfdl">4 GNU Free Documentation +License</a></span></dt> +<dt> +<span class="index"><a href="#tex-refs-idx">Index</a></span></dt></dl></dd></dl></div> +<div class="list-of-tables"> +<p><b>List of Tables</b></p> +<dl> +<dt>1.1 <a href="#id2521491">Options for +<tt class="literal">\newcommand</tt></a></dt> +<dt>1.2 <a href="#id2521690">Options for +<tt class="literal">\newenvironment</tt></a></dt> +<dt>1.3 <a href="#id2521896">Options for +<tt class="literal">\newtheorem</tt></a></dt> +<dt>1.4 <a href="#id2525205">Commands in a +<tt class="literal">tabbing</tt> environment</a></dt> +<dt>1.5 <a href="#id2525850">Commands used inside a +<tt class="literal">tabular</tt> environment</a></dt> +<dt>1.6 <a href="#id2526898">Standard styles distributed with +BibTeX</a></dt> +<dt>1.7 <a href="#id2529997">Three environments that put LaTeX in +math mode</a></dt> +<dt>1.8 <a href="#id2530391">Math Miscellany</a></dt> +<dt>1.9 <a href="#id2538486">Typefaces</a></dt> +<dt>1.10 <a href="#id2539011">Standard type size commands</a></dt> +<dt>1.11 <a href="#id2539271">Low-level font commands</a></dt> +<dt>1.12 <a href="#id2559775">Special coordinates and +angles</a></dt></dl></div> +<div class="preface" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="preface"></a>Preface</h2></div></div></div> +<p class="db2latex:noindent">LaTeX2e is a document preparation +system implemented as a macro package for Donald E. Knuth's TeX +typesetting program.</p> +<p class="db2latex:noindent">LaTeX was originally conceived by +Leslie Lamport.</p> +<p class="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.</p> +<p class="db2latex:noindent"><a href="http://www.tug.org" +target="_top">TUG (TeX User Group)</a> and +<a href="http://www.dante.de" target="_top">DANTE (German TeX User +Group)</a> 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.</p> +<p class="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.</p> +<p class="db2latex:noindent">The authors intend to extend this +documentation to other TeX related packages (e.g. ConTeXt, +MetaPost, Metafont, etc.). Contributions are very +welcome!</p></div> +<div class="preface" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="credits"></a>Credits</h2></div></div></div> +<a id="id2450500" class="indexterm"></a> +<p>The following people have contributed substantial parts to this +documentation project or helped in some other way (listed +alphabetically):</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li> +<p>Karl Berry</p> +<a id="id2450525" class="indexterm"></a></li> +<li> +<p>Wolfgang Borgert</p> +<a id="id2450544" class="indexterm"></a></li> +<li> +<p>Ramon Casellas</p> +<a id="id2450563" class="indexterm"></a></li> +<li> +<p>Holger Danielsson</p> +<a id="id2450582" class="indexterm"></a></li> +<li> +<p>James Devenish</p> +<a id="id2450602" class="indexterm"></a></li> +<li> +<p>Hubert Gaesslein</p> +<a id="id2450621" class="indexterm"></a></li> +<li> +<p>Peter Karp</p> +<a id="id2450640" class="indexterm"></a></li> +<li> +<p>Rolf Niepraschk</p> +<a id="id2450659" class="indexterm"></a></li> +<li> +<p>Hans Fredrik Nordhaug</p> +<a id="id2450681" class="indexterm"></a></li> +<li> +<p>Simon Pepping</p> +<a id="id2450700" class="indexterm"></a></li> +<li> +<p>Bob Stayton</p> +<a id="id2450719" class="indexterm"></a></li> +<li> +<p>Herbert Voss</p> +<a id="id2450739" class="indexterm"></a></li></ul></div></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="tex"></a>Chapter 1. TeX</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#plaintex">1 +PlainTeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#plaintex-ovw">1.1 +Overview</a></span></dt></dl></dd> +<dt><span class="section"><a href="#latex">2 LaTeX</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#opt-latex">2.1 +Options</a></span></dt> +<dt><span class="section"><a href="#overview">2.2 Overview of LaTeX +and Local Guide</a></span></dt> +<dt><span class="section"><a href="#commands">2.3 +Commands</a></span></dt> +<dt><span class="section"><a href="#parameters">2.4 +Parameters</a></span></dt></dl></dd> +<dt><span class="section"><a href="#latex-packages">3 LaTeX +Packages</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#amsmath">3.1 +<tt class="filename">amsmath</tt></a></span></dt> +<dt><span class="section"><a href="#dcolumn">3.2 +<tt class="filename">dcolumn</tt></a></span></dt> +<dt><span class="section"><a href="#float">3.3 +<tt class="filename">float</tt></a></span></dt> +<dt><span class="section"><a href="#fontenc">3.4 +<tt class="filename">fontenc</tt></a></span></dt> +<dt><span class="section"><a href="#german">3.5 +<tt class="filename">german</tt></a></span></dt> +<dt><span class="section"><a href="#graphics">3.6 +<tt class="filename">graphics</tt></a></span></dt> +<dt><span class="section"><a href="#hyperref">3.7 +<tt class="filename">hyperref</tt></a></span></dt> +<dt><span class="section"><a href="#inputenc">3.8 +<tt class="filename">inputenc</tt></a></span></dt> +<dt><span class="section"><a href="#komascript">3.9 +<tt class="filename">KOMA-Script</tt></a></span></dt> +<dt><span class="section"><a href="#mathpazo">3.10 +<tt class="filename">mathpazo</tt></a></span></dt> +<dt><span class="section"><a href="#varioref">3.11 +<tt class="filename">varioref</tt></a></span></dt> +<dt><span class="section"><a href="#small-packages">3.12 Several +Small Packages</a></span></dt></dl></dd> +<dt><span class="section"><a href="#generic-packages">4 Generic +Packages</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#pictex">4.1 PiCTeX +(tbd.)</a></span></dt> +<dt><span class="section"><a href="#pstricks">4.2 +PSTricks</a></span></dt></dl></dd> +<dt><span class="section"><a href="#fontinst">5 +<tt class="filename">fontinst</tt> (tbd.)</a></span></dt> +<dt><span class="section"><a href="#context">6 ConTeXt +(tbd.)</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#context-ovw">6.1 +Overview</a></span></dt></dl></dd> +<dt><span class="section"><a href="#texinfo">7 Texinfo +(tbd.)</a></span></dt></dl></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="plaintex"></a>1 +PlainTeX</h2></div></div></div> +<a id="id2450802" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="plaintex-ovw"></a>1.1 +Overview</h3></div></div></div> +<p>For a really excellent reference of all TeX primitive control +sequences see David Bausum's<a id="id2450821" +class="indexterm"></a> +<a href="http://www.tug.org/utilities/plain/cseq.html" +target="_top"><span class="emphasis"><em>TeX Primitive Control +Sequences</em></span></a>.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="latex"></a>2 +LaTeX</h2></div></div></div> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The original file <tt class="filename">latex2e.texi</tt> +contains the following copyright and permission notice:</p> +<p>“<span class="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.</span>”</p> +<p>“<span class="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.</span>”</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="opt-latex"></a>2.1 +Options</h3></div></div></div> +<a id="id2450904" class="indexterm"></a> +<p>LaTeX understands the following command line options.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-file-line-error-style"></a>2.1.1 +<tt class="filename">-file-line-error-style</tt></h4></div></div></div> +<a id="id2450936" class="indexterm"></a> +<p>Print error messages in the form +<tt class="literal">file:line:error</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-fmt"></a>2.1.2 +<tt class="filename">-fmt=FMTNAME</tt></h4></div></div></div> +<a id="id2450977" class="indexterm"></a> +<p>Use <tt class="literal">FMTMAME</tt> instead of program name or +a %& line.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-ini"></a>2.1.3 +<tt class="filename">-ini</tt></h4></div></div></div> +<a id="id2451019" class="indexterm"></a> +<p>Be <span><b class="command">initex</b></span>, for dumping +formats; this is implicitly true if the program is called as +<span><b class="command">initex</b></span>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-interaction mode"></a>2.1.4 +<tt class="filename">-interaction=STRING</tt></h4></div></div></div> +<a id="id2519533" class="indexterm"></a> +<p>Set interaction mode +(<tt class="literal">STRING=batchmode/nonstopmode/scrollmode/errorstopmode</tt>).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-ipc"></a>2.1.5 +<tt class="filename">-ipc</tt></h4></div></div></div> +<a id="id2519571" class="indexterm"></a> +<p>Send DVI output to a socket as well as the usual output +file.</p> +<p>Note: not available on all systems.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-ipc-start"></a>2.1.6 +<tt class="filename">-ipc-start</tt></h4></div></div></div> +<a id="id2519609" class="indexterm"></a> +<p>As <tt class="literal">-ipc</tt>, and also start the server at +the other end.</p> +<p>Note: not available on all systems.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-jobname-name"></a>2.1.7 +<tt class="filename">-jobname=STRING</tt></h4></div></div></div> +<a id="id2519656" class="indexterm"></a> +<p>Set the job name to <tt class="literal">STRING</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-kpathsea-debug"></a>2.1.8 +<tt class="filename">-kpathsea-debug=NUMBER</tt></h4></div></div></div> +<a id="id2519697" class="indexterm"></a> +<p>Sets path searching debugging flags according to the bits of +<tt class="literal">NUMBER</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-no-maketex"></a>2.1.9 +<tt class="filename">[-no]-maketex=FMT</tt></h4></div></div></div> +<a id="id2519741" class="indexterm"></a> +<p>Disable/enable <span><b class="command">mktexFMT</b></span> +generation (FMT=tex/tfm).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-mltex"></a>2.1.10 +<tt class="filename">-mltex</tt></h4></div></div></div> +<a id="id2519782" class="indexterm"></a> +<p>Enable MLTeX extensions such as +<tt class="literal">\charsubdef</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-output-comment"></a>2.1.11 +<tt class="filename">-output-comment=STRING</tt></h4></div></div></div> +<a id="id2519825" class="indexterm"></a> +<p>use <tt class="literal">STRING</tt> for DVI file comment instead +of date.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-parse-first-line"></a>2.1.12 +<tt class="filename">-parse-first-line</tt></h4></div></div></div> +<a id="id2519867" class="indexterm"></a> +<p>Parse of the first line of the input file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-progname"></a>2.1.13 +<tt class="filename">-progname=STRING</tt></h4></div></div></div> +<a id="id2519903" class="indexterm"></a> +<p>Set program (and fmt) name to +<tt class="literal">STRING</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-recorder"></a>2.1.14 +<tt class="filename">-recorder</tt></h4></div></div></div> +<a id="id2519945" class="indexterm"></a> +<p>Enable filename recorder.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-shell-escape"></a>2.1.15 +<tt class="filename">-shell-escape</tt></h4></div></div></div> +<a id="id2519982" class="indexterm"></a> +<p>Enable <tt class="literal">\write18{SHELL +COMMAND}</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-src-specials"></a>2.1.16 +<tt class="filename">-src-specials</tt></h4></div></div></div> +<a id="id2520024" class="indexterm"></a> +<p>Insert source specials into the DVI file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-src-specials-where"></a>2.1.17 +<tt class="filename">-src-specials=WHERE</tt></h4></div></div></div> +<a id="id2520061" class="indexterm"></a> +<p>Insert source specials in certain places of the DVI file. +<tt class="literal">WHERE</tt> is a comma-separated value list: +<tt class="literal">cr display hbox math par parend +vbox</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="opt-latex-translate-file-tcxname"></a>2.1.18 +<tt class="filename">-translate-file=TCXNAME</tt></h4></div></div></div> +<a id="id2520111" class="indexterm"></a> +<p>Use the <tt class="literal">TCX</tt> file +<tt class="literal">TCXNAME</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-help"></a>2.1.19 +<tt class="filename">-help</tt></h4></div></div></div> +<a id="id2520158" class="indexterm"></a> +<p>Display this help and exit.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="opt-latex-version"></a>2.1.20 +<tt class="filename">-version</tt></h4></div></div></div> +<a id="id2520194" class="indexterm"></a> +<p>Output version information and exit.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="overview"></a>2.2 Overview of LaTeX and +Local Guide</h3></div></div></div> +<a id="id2520232" class="indexterm"></a><a id="id2520240" +class="indexterm"></a> +<p>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:</p> +<div class="orderedlist"> +<ol type="1"> +<li> +<p>A <span class="emphasis"><em>Device Independent</em></span>, or +<tt class="filename">.dvi</tt> 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 +<tt class="literal">xdvi</tt>, which actually uses the +<tt class="filename">.dvi</tt> file.</p></li> +<li> +<p>A <span class="emphasis"><em>transcript</em></span> or +<tt class="filename">.log</tt> file that contains summary +information and diagnostic messages for any errors discovered in +the input file.</p></li> +<li> +<p>An <span class="emphasis"><em>auxiliary</em></span> or +<tt class="filename">.aux</tt> file. This is used by LaTeX itself, +for things such as sectioning.</p></li></ol></div> +<p>For a description of what goes on inside TeX, you should consult +<i class="citetitle">The TeXbook</i> by Donald E. Knuth, ISBN +0-201-13448-9, published jointly by the American Mathematical +Society and Addison-Wesley Publishing Company.</p> +<p>For a description of LaTeX, you should consult:</p> +<p><i class="citetitle">LaTeX: A Document Preparation System</i>, +by Leslie Lamport,<a id="id2520380" class="indexterm"></a> +Addison-Wesley Publishing Company, 2nd edition, 1994.</p> +<p><i class="citetitle">The LaTeX Companion</i>, by Michel +Goossens,<a id="id2520401" class="indexterm"></a> Frank Mittelbach, +<a id="id2520410" class="indexterm"></a> and Alexander +Samarin,<a id="id2520420" class="indexterm"></a> Addison-Wesley, +1994.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="commands"></a>2.3 +Commands</h3></div></div></div> +<p>A LaTeX command begins with the command name, which consists of +a <tt class="literal">\</tt> followed by either (a) a string of +letters or (b) a single non-letter. Arguments contained in square +brackets, <tt class="literal">[]</tt>, are optional while arguments +contained in braces, <tt class="literal">{}</tt>, are required.</p> +<p>NOTE: LaTeX is case sensitive. Enter all commands in lower case +unless explicitly directed to do otherwise.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="counters"></a>2.3.1 +Counters</h4></div></div></div> +<a id="id2520496" class="indexterm"></a><a id="id2520502" +class="indexterm"></a> +<p>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 +<tt class="literal">\</tt> (<tt class="literal">enumi</tt> - +<tt class="literal">enumiv</tt> are used for the nested enumerate +environment). Below is a list of the counters used in LaTeX's +standard document classes to control numbering.</p> +<pre class="programlisting"> +part paragraph figure enumi +chapter subparagraph table enumii +section page footnote enumiii +subsection equation mpfootnote enumiv +subsubsection +</pre> +<h5 class="title"> +<a id="cmd-addtocounter"></a><tt class="literal">\addtocounter</tt></h5> +<a id="id2520566" class="indexterm"></a> +<p>The <tt class="literal">\addtocounter</tt> command increments +the <tt class="literal">counter</tt> by the amount specified by the +<tt class="literal">value</tt> argument. The +<tt class="literal">value</tt> argument can be negative.</p> +<h5 class="title"> +<a id="cmd-alph-title"></a><tt class="literal">\alph{counter}</tt></h5> +<a id="id2520615" class="indexterm"></a><a id="id2520622" +class="indexterm"></a> +<p>This command causes the value of the +<tt class="literal">counter</tt> to be printed in alphabetic +characters. The <tt class="literal">\alph</tt> command uses lower +case alphabetic alphabetic characters, i.e., <tt class="literal">a, +b, c...</tt> while the <tt class="literal">\Alph</tt> command uses +upper case alphabetic characters, i.e., <tt class="literal">A, B, +C...</tt>.</p> +<h5 class="title"> +<a id="cmd-arabic-title"></a><tt class="literal">\arabic{counter}</tt></h5> +<a id="id2520679" class="indexterm"></a> +<p>The <tt class="literal">\arabic</tt> command causes the value of +the <tt class="literal">counter</tt> to be printed in Arabic +numbers, i.e., <tt class="literal">3</tt>.</p> +<h5 class="title"> +<a id="cmd-fnsymbol-title"></a><tt class="literal">\fnsymbol{counter}</tt></h5> +<a id="id2520721" class="indexterm"></a> +<p>The <tt class="literal">\fnsymbol</tt> command causes the value +of the <tt class="literal">counter</tt> to be printed in a specific +sequence of nine symbols that can be used for numbering +footnotes.</p> +<p>NB. <tt class="literal">counter</tt> must have a value between 1 +and 9 inclusive.</p> +<h5 class="title"> +<a id="cmd-newcounter-title"></a><tt class="literal">\newcounter{foo}[counter]</tt></h5> +<a id="id2520769" class="indexterm"></a><a id="id2520776" +class="indexterm"></a> +<p>The <tt class="literal">\newcounter</tt> command defines a new +counter named <tt class="literal">foo</tt>. The counter is +initialized to zero.</p> +<p>The optional argument <tt class="literal">[counter]</tt> causes +the counter <tt class="literal">foo</tt> to be reset whenever the +counter named in the optional argument is incremented.</p> +<h5 class="title"> +<a id="cmd-refstepcounter-title"></a><tt class="literal">\refstepcounter{counter}</tt></h5> +<a id="id2520830" class="indexterm"></a> +<p>The <tt class="literal">\refstepcounter</tt> command works like +<tt class="literal">\stepcounter</tt>. See +<a href="#cmd-stepcounter-title">\stepcounter</a>, except it also +defines the current <tt class="literal">\ref</tt> value to be the +result of <tt class="literal">\thecounter</tt>.</p> +<h5 class="title"> +<a id="cmd-roman-title"></a><tt class="literal">\roman{counter}</tt></h5> +<a id="id2520888" class="indexterm"></a><a id="id2520894" +class="indexterm"></a> +<p>This command causes the value of the +<tt class="literal">counter</tt> to be printed in Roman numerals. +The <tt class="literal">\roman</tt> command uses lower case Roman +numerals, i.e., <tt class="literal">i, ii, iii...</tt>, while the +<tt class="literal">\Roman</tt> command uses upper case Roman +numerals, i.e., <tt class="literal">I, II, III...</tt>.</p> +<h5 class="title"> +<a id="cmd-stepcounter-title"></a><tt class="literal">\stepcounter{counter}</tt></h5> +<a id="id2520951" class="indexterm"></a> +<p>The <tt class="literal">\stepcounter</tt> command adds one to +the <tt class="literal">counter</tt> and resets all subsidiary +counters.</p> +<h5 class="title"> +<a id="cmd-setcounter-title"></a><tt class="literal">\setcounter{counter}{value}</tt></h5> +<a id="id2520988" class="indexterm"></a><a id="id2520995" +class="indexterm"></a> +<p>The <tt class="literal">\setcounter</tt> command sets the value +of the <tt class="literal">counter</tt> to that specified by the +<tt class="literal">value</tt> argument.</p> +<h5 class="title"> +<a id="cmd-usecounter-title"></a><tt class="literal">\usecounter{counter}</tt></h5> +<a id="id2521038" class="indexterm"></a> +<p>The <tt class="literal">\usecounter</tt> command is used in the +second argument of the <tt class="literal">list</tt> environment to +allow the counter specified to be used to number the list +items.</p> +<h5 class="title"> +<a id="cmd-value-title"></a><tt class="literal">\value{counter}</tt></h5> +<a id="id2521076" class="indexterm"></a><a id="id2521083" +class="indexterm"></a> +<p>The <tt class="literal">\value</tt> command produces the value +of the <tt class="literal">counter</tt> named in the mandatory +argument. It can be used where LaTeX expects an integer or number, +such as the second argument of a +<tt class="literal">\setcounter</tt> or +<tt class="literal">\addtocounter</tt> command, or in:</p> +<pre class="programlisting"> +\hspace{\value{foo}\parindent} +</pre> +<p>It is useful for doing arithmetic with counters.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="cross-references"></a>2.3.2 Cross +References</h4></div></div></div> +<a id="id2521150" class="indexterm"></a> +<p>One reason for numbering things like figures and equations is to +refer the reader to them, as in <span class="emphasis"><em>See +Figure 3 for more details.</em></span> A smarter version of the +cross reference commands is available in the package +<a href="#varioref" +title="3.11 varioref"><tt class="literal">varioref</tt></a>.</p> +<h5 class="title"> +<a id="cmd-label-title"></a><tt class="literal">\label{key}</tt></h5> +<a id="id2521192" class="indexterm"></a> +<p>A <tt class="literal">\label</tt> command appearing in ordinary +text assigns to the <tt class="literal">key</tt> the number of the +current sectional unit; one appearing inside a numbered environment +assigns that number to the <tt class="literal">key</tt>.</p> +<p>A <tt class="literal">key</tt> can consist of any sequence of +letters, digits, or punctuation characters. Upper and lowercase +letters are different.</p> +<p>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</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">cha</tt> for chapters</li> +<li><tt class="literal">sec</tt> for lower-level sectioning +commands</li> +<li><tt class="literal">fig</tt> for figures</li> +<li><tt class="literal">tab</tt> for tables</li> +<li><tt class="literal">eq</tt> for equations</li></ul></div> +<p>Thus, a label for a figure would look like +<tt class="literal">fig:bandersnatch</tt>.</p> +<h5 class="title"> +<a id="cmd-pageref"></a><tt class="literal">\pageref{key}</tt></h5> +<a id="id2521325" class="indexterm"></a><a id="id2521332" +class="indexterm"></a> +<p>The <tt class="literal">\pageref</tt> command produces the page +number of the place in the text where the corresponding +<tt class="literal">\label</tt> command appears. ie. where +<tt class="literal">\label{key}</tt> appears. For a smart version +see +<a href="#cmd-vpageref"><tt class="literal">\vpageref</tt></a>.</p> +<h5 class="title"> +<a id="cmd-ref-title"></a><tt class="literal">\ref{key}</tt></h5> +<a id="id2521388" class="indexterm"></a><a id="id2521395" +class="indexterm"></a> +<p>The <tt class="literal">\ref</tt> command produces the number of +the sectional unit, equation number, ... of the corresponding +<tt class="literal">\label</tt> command. For a smart version see +<a href="#cmd-vref">\vref</a>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="definitions"></a>2.3.3 +Definitions</h4></div></div></div> +<h5 class="title"> +<a id="cmd-newcommand-title"></a><tt class="literal">\newcommand</tt></h5> +<a id="id2521458" class="indexterm"></a><a id="id2521465" +class="indexterm"></a><a id="id2521472" class="indexterm"></a> +<pre class="programlisting"> +\newcommand{cmd}[args]{definition} +\newcommand{cmd}[args][default]{definition} +\renewcommand{cmd}[args]{definition} +\renewcommand{cmd}[args][default]{definition} +</pre> +<p>These commands define (or redefine) a command.</p> +<div class="table"><a id="id2521491"></a> +<p class="title"><b>Table 1.1. Options for +<tt class="literal">\newcommand</tt></b></p> +<table summary="Options for \newcommand" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">cmd</td> +<td align="justify">A command name beginning with a +<tt class="literal">\</tt>. For +<tt class="literal">\newcommand</tt> it must not be already defined +and must not begin with <tt class="literal">\end</tt>; for +<tt class="literal">\renewcommand</tt> it must already be +defined.</td></tr> +<tr> +<td align="left">args</td> +<td align="justify">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.</td></tr> +<tr> +<td align="left">def</td> +<td align="justify">If this optional parameter is present, it means +that the command's first argument is optional. The default value of +the optional argument is <tt class="literal">def</tt>.</td></tr> +<tr> +<td align="left">definition</td> +<td align="justify">The text to be substituted for every occurrence +of <tt class="literal">cmd</tt>; a parameter of the form +<tt class="literal">#n</tt> in <tt class="literal">cmd</tt> is +replaced by the text of the nth argument when this substitution +takes place.</td></tr></tbody></table></div> +<h5 class="title"> +<a id="cmd-newenvironment-title"></a><tt class="literal">\newenvironment</tt></h5> +<a id="id2521657" class="indexterm"></a><a id="id2521664" +class="indexterm"></a><a id="id2521671" class="indexterm"></a> +<pre class="programlisting"> +\newenvironment{nam}[args]{begdef}{enddef} +\newenvironment{nam}[args][default]{begdef}{enddef} +\renewenvironment{nam}[args]{begdef}{enddef} +</pre> +<p>These commands define or redefine an environment.</p> +<div class="table"><a id="id2521690"></a> +<p class="title"><b>Table 1.2. Options for +<tt class="literal">\newenvironment</tt></b></p> +<table summary="Options for \newenvironment" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">nam</td> +<td align="justify">The name of the environment. For +<tt class="literal">\newenvironment</tt> there must be no currently +defined environment by that name, and the command +<tt class="literal">\nam</tt> must be undefined. For +<tt class="literal">\renewenvironment</tt> the environment must +already be defined.</td></tr> +<tr> +<td align="left">args</td> +<td align="justify">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 +<tt class="literal">{begdef}</tt> part.</td></tr> +<tr> +<td align="left">default</td> +<td align="justify">If this is specified, the first argument is +optional, and <tt class="literal">default</tt> gives the default +value for that argument.</td></tr> +<tr> +<td align="left">begdef</td> +<td align="justify">The text substituted for every occurrence of +<tt class="literal">\begin{nam}</tt>; a parameter of the form +<tt class="literal">#n</tt> in <tt class="literal">cmd</tt> is +replaced by the text of the nth argument when this substitution +takes place.</td></tr> +<tr> +<td align="left">enddef</td> +<td align="justify">The text substituted for every occurrence of +<tt class="literal">\end{nam}</tt>. It may not contain any argument +parameters.</td></tr></tbody></table></div> +<h5 class="title"> +<a id="cmd-newtheorem-title"></a><tt class="literal">\newtheorem</tt></h5> +<a id="id2521865" class="indexterm"></a><a id="id2521872" +class="indexterm"></a><a id="id2521878" class="indexterm"></a> +<pre class="programlisting"> +\newtheorem{env_name}{caption}[within] +\newtheorem{env_name}[numbered_like]{caption} +</pre> +<p>This command defines a theorem-like environment.</p> +<div class="table"><a id="id2521896"></a> +<p class="title"><b>Table 1.3. Options for +<tt class="literal">\newtheorem</tt></b></p> +<table summary="Options for \newtheorem" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">env_name</td> +<td align="justify">The name of the environment to be defined. A +string of letters. It must not be the name of an existing +environment or counter.</td></tr> +<tr> +<td align="left">caption</td> +<td align="justify">The text printed at the beginning of the +environment, right before the number. This may simply say +<span class="emphasis"><em>Theorem</em></span>, for +example.</td></tr> +<tr> +<td align="left">within</td> +<td align="justify">The name of an already defined counter, usually +of a sectional unit. Provides a means of resetting the new theorem +counter <span class="bold"><b>within</b></span> the sectional +unit.</td></tr> +<tr> +<td align="left">numbered_like</td> +<td align="justify">The name of an already defined theorem-like +environment.</td></tr></tbody></table></div> +<p>The <tt class="literal">\newtheorem</tt> command may have at +most one optional argument.</p> +<h5 class="title"> +<a id="cmd-newfont-title"></a><tt class="literal">\newfont</tt></h5> +<a id="id2522022" class="indexterm"></a><a id="id2522028" +class="indexterm"></a><a id="id2522035" class="indexterm"></a> +<p><tt class="literal">\newfont{cmd}{font_name}</tt></p> +<p>Defines the command name <tt class="literal">cmd</tt>, which +must not be currently defined, to be a declaration that selects the +font named <tt class="literal">font_name</tt> to be the current +font.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="document-classes"></a>2.3.4 Document +Classes</h4></div></div></div> +<a id="id2522083" class="indexterm"></a><a id="id2522090" +class="indexterm"></a><a id="id2522097" +class="indexterm"></a><a id="id2522104" +class="indexterm"></a><a id="id2522110" +class="indexterm"></a><a id="id2522117" +class="indexterm"></a><a id="id2522124" class="indexterm"></a> +<p>Valid LaTeX document classes include:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>article</li> +<li>report</li> +<li>letter</li> +<li>book</li> +<li>slides</li></ul></div> +<p>Other document classes are often available. See +<a href="#overview" +title="2.2 Overview of LaTeX and Local Guide ">Overview</a>, for +details. They are selected with the following command:</p> +<p><tt class="literal">\documentclass [options] {class}</tt></p> +<p>All the standard classes (except slides) accept the following +options for selecting the typeface size +(<tt class="literal">10pt</tt> is default):</p> +<p><tt class="literal">10pt, 11pt, 12pt</tt></p> +<p>All classes accept these options for selecting the paper size +(default is letter):</p> +<p>a4paper, a5paper, b5paper, letterpaper, legalpaper, +executivepaper</p> +<p>Miscellaneous options:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>landscape --- selects landscape format. Default is +portrait.</li> +<li>titlepage, notitlepage --- selects if there should be a +separate title page.</li> +<li>leqno --- equation number on left side of equations. Default is +right side.</li> +<li>fleqn --- displayed formulas flush left. Default is +centered.</li> +<li>openbib --- use <span class="emphasis"><em>open</em></span> +bibliography format.</li> +<li>draft, final --- mark/do not mark overfull boxes with a rule. +Default is final.</li></ul></div> +<p>These options are not available with the slides class:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>oneside, twoside --- selects one- or twosided layout. Default +is oneside, except for the book class.</li> +<li>openright, openany --- determines if a chapter should start on +a right-hand page. Default is openright for book.</li> +<li>onecolumn, twocolumn --- one or two columns. Defaults to one +column.</li></ul></div> +<p>The slides class offers the option +<tt class="literal">clock</tt> for printing the time at the bottom +of each note.</p> +<p>If you specify more than one option, they must be separated by a +comma.</p> +<p>Additional packages are loaded by a</p> +<p><a id="usepackage-linkend"></a> +<tt class="literal">\usepackage[options]{pkg}</tt> +<a id="id2522347" class="indexterm"></a></p> +<p>command. If you specify more than one package, they must be +separated by a comma. <a id="id2522359" class="indexterm"></a> +<a id="id2522365" class="indexterm"></a></p> +<p>Any options given in the <tt class="literal">\documentclass</tt> +command that are unknown by the selected document class are passed +on to the packages loaded with +<tt class="literal">\usepackage</tt>. <a id="id2522390" +class="indexterm"></a> <a id="id2522397" class="indexterm"></a></p> +<a id="id2522405" class="indexterm"></a></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="layout"></a>2.3.5 +Layout</h4></div></div></div> +<p>Miscellaneous commands for controlling the general layout of the +page.</p> +<h5 class="title"> +<a id="cmd-flushbottom-title"></a><tt class="literal">\flushbottom</tt></h5> +<a id="id2522444" class="indexterm"></a> +<p>The <tt class="literal">\flushbottom</tt> declaration makes all +text pages the same height, adding extra vertical space when +necessary to fill out the page.</p> +<p>This is the standard if twocolumn mode is selected.</p> +<h5 class="title"> +<a id="cmd-onecolumn-title"></a><tt class="literal">\onecolumn</tt></h5> +<a id="id2522480" class="indexterm"></a> +<p>The <tt class="literal">\onecolumn</tt> declaration starts a new +page and produces single-column output.</p> +<h5 class="title"> +<a id="cmd-raggedbottom-title"></a><tt class="literal">\raggedbottom</tt></h5> +<a id="id2522511" class="indexterm"></a> +<p>The <tt class="literal">\raggedbottom</tt> declaration makes all +pages the height of the text on that page. No extra vertical space +is added.</p> +<h5 class="title"> +<a id="cmd-twocolumn-title"></a><tt class="literal">\twocolumn</tt></h5> +<a id="id2522542" class="indexterm"></a><a id="id2522549" +class="indexterm"></a> +<p><tt class="literal">\twocolumn[text]</tt></p> +<p>The <tt class="literal">\twocolumn</tt> declaration starts a new +page and produces two-column output. If the optional +<tt class="literal">text</tt> argument is present, it is typeset in +one-column mode.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="env-latex"></a>2.3.6 +Environments</h4></div></div></div> +<a id="id2522598" class="indexterm"></a><a id="id2522605" +class="indexterm"></a><a id="id2522612" class="indexterm"></a> +<p>LaTeX provides a number of different paragraph-making +environments. Each environment begins and ends in the same +manner.</p> +<pre class="programlisting"> +\begin{environment-name} + . + . + . +\end{environment-name} +</pre> +<h5 class="title"><a id="env-array"></a>array</h5> +<a id="id2522642" class="indexterm"></a><a id="id2522649" +class="indexterm"></a> +<pre class="programlisting"> +\begin{array}{col1col2...coln} +column 1 entry & column 2 entry ... & column n entry \\ + . + . + . +\end{array} +</pre> +<p>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, <tt class="literal">coln</tt>, +is specified by a single letter that tells how items in that row +should be formatted.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">c</tt> --- for centered</li> +<li><tt class="literal">l</tt> --- for flush left</li> +<li><tt class="literal">r</tt> --- for flush right</li></ul></div> +<p>Column entries must be separated by an +<tt class="literal">&</tt>. Column entries may include other +LaTeX commands. Each row of the array must be terminated with the +string <tt class="literal">\\</tt>.</p> +<p>Note that the <tt class="literal">array</tt> environment can +only be used in math mode, so normally it is used inside an +<tt class="literal">equation</tt> environment.</p> +<h5 class="title"> +<a id="env-center"></a><tt class="literal">center</tt></h5> +<a id="id2522771" class="indexterm"></a><a id="id2522778" +class="indexterm"></a> +<pre class="programlisting"> +\begin{center} +Text on line 1 \\ +Text on line 2 \\ + . + . + . +\end{center} +</pre> +<p>The <tt class="literal">center</tt> 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 <tt class="literal">\\</tt>.</p> +<h5 class="title"> +<a id="cmd-centering"></a><tt class="literal">\centering</tt></h5> +<a id="id2522824" class="indexterm"></a><a id="id2522831" +class="indexterm"></a><a id="id2522837" class="indexterm"></a> +<p>This declaration corresponds to the +<tt class="literal">center</tt> environment. This declaration can +be used inside an environment such as +<tt class="literal">quote</tt> or in a +<tt class="literal">parbox</tt>. The text of a figure or table can +be centered on the page by putting a +<tt class="literal">\centering</tt> command at the beginning of the +figure or table environment.</p> +<p>Unlike the <tt class="literal">center</tt> environment, the +<tt class="literal">\centering</tt> 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 <tt class="literal">\end</tt> command (of +an environment like quote) that ends the paragraph unit.</p> +<h5 class="title"> +<a id="env-description"></a><tt class="literal">description</tt></h5> +<a id="id2522919" class="indexterm"></a><a id="id2522926" +class="indexterm"></a> +<pre class="programlisting"> +\begin{description} +\item [label] First item +\item [label] Second item + . + . + . +\end{description} +</pre> +<p>The <tt class="literal">description</tt> environment is used to +make labelled lists. The <tt class="literal">label</tt> is bold +face and flushed right.</p> +<h5 class="title"> +<a id="env-enumerate"></a><tt class="literal">enumerate</tt></h5> +<a id="id2522970" class="indexterm"></a><a id="id2522977" +class="indexterm"></a> +<pre class="programlisting"> +\begin{enumerate} +\item First item +\item Second item + . + . + . +\end{enumerate} +</pre> +<p>The <tt class="literal">enumerate</tt> 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.</p> +<p>Each item of an enumerated list begins with an +<tt class="literal">\item</tt> command. There must be at least one +<tt class="literal">\item</tt> command within the environment.</p> +<p>The <tt class="literal">enumerate</tt> environment uses the +<tt class="literal">enumi</tt> through +<tt class="literal">enumiv</tt> counters (see <a href="#counters" +title="2.3.1 Counters">Counters</a>). The type of numbering can be +changed by redefining <tt class="literal">\theenumi</tt> etc.</p> +<h5 class="title"> +<a id="env-eqnarray"></a><tt class="literal">eqnarray</tt></h5> +<a id="id2523071" class="indexterm"></a><a id="id2523078" +class="indexterm"></a><a id="id2523085" class="indexterm"></a> +<pre class="programlisting"> +\begin{eqnarray} +math formula 1 \\ +math formula 2 \\ + . + . + . +\end{eqnarray} +</pre> +<p>The <tt class="literal">eqnarray</tt> environment is used to +display a sequence of equations or inequalities. It is very much +like a three-column <tt class="literal">array</tt> environment, +with consecutive rows separated by <tt class="literal">\\</tt> and +consecutive items within a row separated by an +<tt class="literal">&</tt>.</p> +<p>An equation number is placed on every line unless that line has +a <tt class="literal">\nonumber</tt> command.</p> +<a id="id2523140" class="indexterm"></a> +<p>The command <tt class="literal">\lefteqn</tt> is used for +splitting long formulas across lines. It typesets its argument in +display style flush left in a box of zero width.</p> +<h5 class="title"> +<a id="env-equation"></a><tt class="literal">equation</tt></h5> +<a id="id2523173" class="indexterm"></a><a id="id2523180" +class="indexterm"></a><a id="id2523187" class="indexterm"></a> +<pre class="programlisting"> +\begin{equation} + math formula +\end{equation} +</pre> +<p>The <tt class="literal">equation</tt> environment centers your +equation on the page and places the equation number in the right +margin.</p> +<h5 class="title"> +<a id="env-figure"></a><tt class="literal">figure</tt></h5> +<a id="id2523223" class="indexterm"></a><a id="id2523230" +class="indexterm"></a> +<pre class="programlisting"> +\begin{figure}[placement] + + body of the figure + +\caption{figure title} +\end{figure} +</pre> +<a id="id2523244" class="indexterm"></a> +<p>Figures are objects that are not part of the normal text, and +are usually <span class="emphasis"><em>floated</em></span> to a +convenient place, like the top of a page. Figures will not be split +between two pages.</p> +<p>The optional argument <tt class="literal">[placement]</tt> +determines where LaTeX will try to place your figure. There are +four places where LaTeX can possibly put a float:</p> +<div class="orderedlist"> +<ol type="1"> +<li> +<p><tt class="literal">h</tt> (Here) - at the position in the text +where the figure environment appears.</p></li> +<li> +<p><tt class="literal">t</tt> (Top) - at the top of a text +page.</p></li> +<li> +<p><tt class="literal">b</tt> (Bottom) - at the bottom of a text +page.</p></li> +<li> +<p><tt class="literal">p</tt> (Page of floats) - on a separate +float page, which is a page containing no text, only +floats.</p></li></ol></div> +<p>The standard report and article classes use the default +placement <tt class="literal">tbp</tt>.</p> +<p>The body of the figure is made up of whatever text, LaTeX +commands, etc. you wish. The <tt class="literal">\caption</tt> +command allows you to title your figure.</p> +<h5 class="title"> +<a id="env-flushleft"></a><tt class="literal">flushleft</tt></h5> +<a id="id2523376" class="indexterm"></a><a id="id2523383" +class="indexterm"></a><a id="id2523390" class="indexterm"></a> +<pre class="programlisting"> +\begin{flushleft} +Text on line 1 \\ +Text on line 2 \\ + . + . + . +\end{flushleft} +</pre> +<p>The <tt class="literal">flushleft</tt> 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 +<tt class="literal">\\</tt>.</p> +<h5 class="title"> +<a id="cmd-raggedright"></a><tt class="literal">\raggedright</tt></h5> +<a id="id2523435" class="indexterm"></a><a id="id2523442" +class="indexterm"></a><a id="id2523449" +class="indexterm"></a><a id="id2523456" class="indexterm"></a> +<p>This declaration corresponds to the +<tt class="literal">flushleft</tt> environment. This declaration +can be used inside an environment such as +<tt class="literal">quote</tt> or in a +<tt class="literal">parbox</tt>.</p> +<p>Unlike the <tt class="literal">flushleft</tt> environment, the +<tt class="literal">\raggedright</tt> 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 <tt class="literal">\end</tt> command (of +an environment like quote) that ends the paragraph unit.</p> +<h5 class="title"> +<a id="env-flushright"></a><tt class="literal">flushright</tt></h5> +<a id="id2523530" class="indexterm"></a><a id="id2523537" +class="indexterm"></a><a id="id2523544" class="indexterm"></a> +<pre class="programlisting"> +\begin{flushright} +Text on line 1 \\ +Text on line 2 \\ + . + . + . +\end{flushright} +</pre> +<p>The <tt class="literal">flushright</tt> 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 <tt class="literal">\\</tt>.</p> +<h5 class="title"> +<a id="cmd-raggedleft"></a><tt class="literal">\raggedleft</tt></h5> +<a id="id2523590" class="indexterm"></a><a id="id2523597" +class="indexterm"></a><a id="id2523604" +class="indexterm"></a><a id="id2523611" class="indexterm"></a> +<p>This declaration corresponds to the +<tt class="literal">flushright</tt> environment. This declaration +can be used inside an environment such as +<tt class="literal">quote</tt> or in a +<tt class="literal">parbox</tt>.</p> +<p>Unlike the <tt class="literal">flushright</tt> environment, the +<tt class="literal">\raggedleft</tt> 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 <tt class="literal">\end</tt> command (of +an environment like quote) that ends the paragraph unit.</p> +<h5 class="title"> +<a id="env-itemize"></a><tt class="literal">itemize</tt></h5> +<a id="id2523684" class="indexterm"></a><a id="id2523690" +class="indexterm"></a><a id="id2523697" class="indexterm"></a> +<pre class="programlisting"> +\begin{itemize} +\item First item +\item Second item + . + . + . +\end{itemize} +</pre> +<p>The <tt class="literal">itemize</tt> environment produces a +<span class="emphasis"><em>bulleted</em></span> list. Itemizations +can be nested within one another, up to four levels deep. They can +also be nested within other paragraph-making environments.</p> +<p>Each item of an <tt class="literal">itemized</tt> list begins +with an <tt class="literal">\item</tt> command. There must be at +least one <tt class="literal">\item</tt> command within the +environment.</p> +<p>The <tt class="literal">itemize</tt> environment uses the +<tt class="literal">itemi</tt> through +<tt class="literal">itemiv</tt> counters (see <a href="#counters" +title="2.3.1 Counters">Counters</a>). The type of numbering can be +changed by redefining <tt class="literal">\theitemi</tt> etc.</p> +<h5 class="title"> +<a id="env-letter"></a><tt class="literal">letter</tt></h5> +<a id="id2523799" class="indexterm"></a> +<p>This environment is used for creating letters. See +<a href="#letters" title="2.3.9 Letters">Letters</a>.</p> +<h5 class="title"> +<a id="env-list"></a><tt class="literal">list</tt></h5> +<a id="id2523830" class="indexterm"></a><a id="id2523837" +class="indexterm"></a> +<p>The <tt class="literal">list</tt> 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.</p> +<pre class="programlisting"> +\begin{list}{label}{spacing} +\item First item +\item Second item + . + . + . +\end{list} +</pre> +<p>The <tt class="literal">{label}</tt> 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.</p> +<p>The <tt class="literal">{spacing}</tt> argument contains +commands to change the spacing parameters for the list. This +argument will most often be null, i.e., +<tt class="literal">{}</tt>. This will select all default spacing +which should suffice for most cases.</p> +<h5 class="title"> +<a id="env-minipage"></a><tt class="literal">minipage</tt></h5> +<a id="id2523912" class="indexterm"></a><a id="id2523919" +class="indexterm"></a><a id="id2523926" +class="indexterm"></a><a id="id2523933" class="indexterm"></a> +<pre class="programlisting"> +\begin{minipage}[position][height][inner-pos]{width} + text +\end{minipage} +</pre> +<p>The <tt class="literal">minipage</tt> environment is similar to +a <tt class="literal">\parbox</tt> command. It takes the same +optional <tt class="literal">position</tt> argument and mandatory +<tt class="literal">width</tt> argument. You may use other +paragraph-making environments inside a minipage.</p> +<p>Footnotes in a <tt class="literal">minipage</tt> environment are +handled in a way that is particularly useful for putting footnotes +in figures or tables. A <tt class="literal">\footnote</tt> or +<tt class="literal">\footnotetext</tt> command puts the footnote at +the bottom of the minipage instead of at the bottom of the page, +and it uses the <tt class="literal">mpfootnote</tt> counter instead +of the ordinary <tt class="literal">footnote</tt> counter See +<a href="#counters" title="2.3.1 Counters">Counters</a>.</p> +<p>NOTE: Don't put one minipage inside another if you are using +footnotes; they may wind up at the bottom of the wrong +minipage.</p> +<h5 class="title"> +<a id="env-picture"></a><tt class="literal">picture</tt></h5> +<a id="id2524040" class="indexterm"></a><a id="id2524047" +class="indexterm"></a><a id="id2524054" class="indexterm"></a> +<pre class="programlisting"> +\begin{picture}(width,height)(x offset,y offset) + . + . + picture commands + . + . +\end{picture} +</pre> +<p>The <tt class="literal">picture</tt> 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 <tt class="literal">5</tt>, <tt class="literal">2.3</tt> or +<tt class="literal">-3.1416</tt>. A coordinate specifies a length +in multiples of the unit length +<tt class="literal">\unitlength</tt>, so if +<tt class="literal">\unitlength</tt> has been set to +<tt class="literal">1cm</tt>, then the coordinate 2.54 specifies a +length of 2.54 centimetres. You can change the value of +<tt class="literal">\unitlength</tt> anywhere you want, using the +<tt class="literal">\setlength</tt> command, but strange things +will happen if you try changing it inside the picture +environment.</p> +<p>A position is a pair of coordinates, such as +<tt class="literal">(2.4,-5)</tt>, specifying the point with +x-coordinate <tt class="literal">2.4</tt> and y-coordinate +<tt class="literal">-5</tt>. 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.</p> +<p>The <tt class="literal">picture</tt> environment has one +mandatory argument, which is a <tt class="literal">position</tt>. +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.</p> +<p>The <tt class="literal">picture</tt> environment also has an +optional <tt class="literal">position</tt> argument, following the +<tt class="literal">size</tt> 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 +<tt class="literal">\unitlength</tt> has been set to +<tt class="literal">1mm</tt>, the command</p> +<pre class="programlisting"> +\begin{picture}(100,200)(10,20) +</pre> +<p>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.</p> +<p>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.</p> +<p>Everything that appears in a picture is drawn by the +<tt class="literal">\put</tt> command. The command</p> +<pre class="programlisting"> +\put (11.3,-.3){...} +</pre> +<p>puts the object specified by <tt class="literal">...</tt> in the +picture, with its reference point at coordinates (11.3,-.3). The +reference points for various objects will be described below.</p> +<p>The <tt class="literal">\put</tt> command creates an +<span class="bold"><b>LR box</b></span>. You can put anything in +the text argument of the <tt class="literal">\put</tt> command that +you'd put into the argument of an <tt class="literal">\mbox</tt> +and related commands. When you do this, the reference point will be +the lower left corner of the box.</p> +<p>Picture commands:</p> +<h5 class="title"> +<a id="cmd-circle"></a><tt class="literal">\circle{diameter}, +\circle*{diameter}</tt></h5> +<a id="id2524329" class="indexterm"></a> +<p>The <tt class="literal">\circle</tt> command produces a circle +with a diameter as close to the specified one as possible. If the +<tt class="literal">*</tt>-form of the command is used, LaTeX draws +a solid circle.</p> +<p>Note that only circles up to 40 pt can be drawn.</p> +<h5 class="title"> +<a id="cmd-dashbox"></a><tt class="literal">\dashbox</tt></h5> +<a id="id2524374" class="indexterm"></a> +<p>Draws a box with a dashed line.</p> +<p> +<tt class="literal">\dashbox{dash_length}(width,height){...}</tt></p> +<p>The <tt class="literal">\dashbox</tt> has an extra argument +which specifies the width of each dash. A dashed box looks best +when the <tt class="literal">width</tt> and +<tt class="literal">height</tt> are multiples of the +<tt class="literal">dash_length</tt>.</p> +<h5 class="title"> +<a id="cmd-frame"></a><tt class="literal">\frame{...}</tt></h5> +<a id="id2524435" class="indexterm"></a> +<p>The <tt class="literal">\frame</tt> 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.</p> +<h5 class="title"> +<a id="cmd-framebox-op-picture-cp"></a><tt class="literal">\framebox(width,height)[position]{...}</tt></h5> +<a id="id2524469" class="indexterm"></a> +<p>The <tt class="literal">\framebox</tt> command is exactly the +same as the <tt class="literal">\makebox</tt> command, except that +it puts a frame around the outside of the box that it creates.</p> +<p>The <tt class="literal">framebox</tt> command produces a rule of +thickness <tt class="literal">\fboxrule</tt>, and leaves a space +<tt class="literal">\fboxsep</tt> between the rule and the contents +of the box.</p> +<h5 class="title"><a id="cmd-line"></a><tt class="literal">\line(x +slope,y slope){length}</tt></h5> +<a id="id2524529" class="indexterm"></a> +<p>The <tt class="literal">\line</tt> command draws a line of the +specified <tt class="literal">length</tt> and +<tt class="literal">slope</tt>.</p> +<p>Note that LaTeX can only draw lines with slope = x/y, where x +and y have integer values from -6 through 6.</p> +<h5 class="title"> +<a id="cmd-linethickness"></a><tt class="literal">\linethickness{dimension}</tt></h5> +<a id="id2524580" class="indexterm"></a> +<p>Declares the thickness of horizontal and vertical lines in a +picture environment to be <tt class="literal">dimension</tt>, which +must be a positive length. It does not affect the thickness of +slanted lines and circles, or the quarter circles drawn by +<tt class="literal">\oval</tt> to form the corners of an oval.</p> +<h5 class="title"> +<a id="cmd-makebox-op-picture-cp"></a><tt class="literal">\makebox(width,height)[position]{...}</tt></h5> +<a id="id2524621" class="indexterm"></a> +<p>The <tt class="literal">\makebox</tt> command for the picture +environment is similar to the normal +<tt class="literal">\makebox</tt> command except that you must +specify a <tt class="literal">width</tt> and +<tt class="literal">height</tt> in multiples of +<tt class="literal">\unitlength</tt>.</p> +<p>The optional argument, <tt class="literal">[position]</tt>, +specifies the quadrant that your text appears in. You may select up +to two of the following:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">t</tt> - Moves the item to the top of the +rectangle</li> +<li><tt class="literal">b</tt> - Moves the item to the bottom</li> +<li><tt class="literal">l</tt> - Moves the item to the left</li> +<li><tt class="literal">r</tt> - Moves the item to the +right</li></ul></div> +<p>See <a href="#cmd-makebox">\makebox</a>.</p> +<h5 class="title"> +<a id="cmd-multiput"></a><tt class="literal">\multiput(x coord,y +coord)(delta x,delta y){number of copies}{object}</tt></h5> +<a id="id2524752" class="indexterm"></a> +<p>The <tt class="literal">\multiput</tt> command can be used when +you are putting the same object in a regular pattern across a +picture.</p> +<h5 class="title"> +<a id="cmd-oval"></a><tt class="literal">\oval(width,height)[portion]</tt></h5> +<a id="id2524783" class="indexterm"></a> +<p>The <tt class="literal">\oval</tt> command produces a rectangle +with rounded corners. The optional argument, +<tt class="literal">[portion]</tt>, allows you to select part of +the oval.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">t</tt> - Selects the top portion</li> +<li><tt class="literal">b</tt> - Selects the bottom portion</li> +<li><tt class="literal">r</tt> - Selects the right portion</li> +<li><tt class="literal">l</tt> - Selects the left +portion</li></ul></div> +<p>Note that the <span class="emphasis"><em>corners</em></span> of +the oval are made with quarter circles with a maximum radius of 20 +pt, so large <span class="emphasis"><em>ovals</em></span> will look +more like boxes with rounded corners.</p> +<h5 class="title"><a id="cmd-put"></a><tt class="literal">\put(x +coord,y coord){ ... }</tt></h5> +<a id="id2524885" class="indexterm"></a> +<p>The <tt class="literal">\put</tt> command places the item +specified by the mandatory argument at the given coordinates.</p> +<h5 class="title"> +<a id="cmd-shortstack"></a><tt class="literal">\shortstack[position]{... +\\ ... \\ ...}</tt></h5> +<a id="id2524917" class="indexterm"></a> +<p>The <tt class="literal">\shortstack</tt> command produces a +stack of objects. The valid positions are:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">r</tt> - Moves the objects to the right of +the stack</li> +<li><tt class="literal">l</tt> - Moves the objects to the left of +the stack</li> +<li><tt class="literal">c</tt> - Moves the objects to the centre of +the stack (default)</li></ul></div> +<h5 class="title"> +<a id="cmd-vector"></a><tt class="literal">\vector(x slope,y +slope){length}</tt></h5> +<a id="id2524989" class="indexterm"></a> +<p>The <tt class="literal">\vector</tt> command draws a line with +an arrow of the specified length and slope. The +<tt class="literal">x</tt> and <tt class="literal">y</tt> values +must lie between -4 and +4, inclusive.</p> +<h5 class="title"> +<a id="env-quotation"></a><tt class="literal">quotation</tt></h5> +<a id="id2525032" class="indexterm"></a><a id="id2525038" +class="indexterm"></a><a id="id2525046" class="indexterm"></a> +<pre class="programlisting"> +\begin{quotation} + text +\end{quotation} +</pre> +<p>The margins of the <tt class="literal">quotation</tt> +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.</p> +<h5 class="title"> +<a id="env-quote"></a><tt class="literal">quote</tt></h5> +<a id="id2525085" class="indexterm"></a><a id="id2525092" +class="indexterm"></a><a id="id2525099" class="indexterm"></a> +<pre class="programlisting"> +\begin{quote} + text +\end{quote} +</pre> +<p>The margins of the <tt class="literal">quote</tt> 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.</p> +<h5 class="title"> +<a id="env-tabbing"></a><tt class="literal">tabbing</tt></h5> +<a id="id2525137" class="indexterm"></a><a id="id2525144" +class="indexterm"></a><a id="id2525151" class="indexterm"></a> +<pre class="programlisting"> +\begin{tabbing} +text \= more text \= still more text \= last text \\ +second row \> \> more \\ + . + . + . +\end{tabbing} +</pre> +<p>The <tt class="literal">tabbing</tt> 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.</p> +<p>It is best suited for cases where the width of each column is +constant and known in advance.</p> +<p>This environment can be broken across pages, unlike the +<tt class="literal">tabular</tt> environment.</p> +<p>The following commands can be used inside a +<tt class="literal">tabbing</tt> environment:</p> +<div class="table"><a id="id2525205"></a> +<p class="title"><b>Table 1.4. Commands in a +<tt class="literal">tabbing</tt> environment</b></p> +<table summary="Commands in a tabbing environment" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">\= <a id="id2525244" class="indexterm"></a></td> +<td align="justify">Sets a tab stop at the current +position.</td></tr> +<tr> +<td align="left">\> <a id="id2525263" +class="indexterm"></a></td> +<td align="justify">Advances to the next tab stop.</td></tr> +<tr> +<td align="left">\< <a id="id2525282" +class="indexterm"></a></td> +<td align="justify">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.</td></tr> +<tr> +<td align="left">\+ <a id="id2525302" class="indexterm"></a></td> +<td align="justify">Moves the left margin of the next and all the +following commands one tab stop to the right.</td></tr> +<tr> +<td align="left">\- <a id="id2525322" class="indexterm"></a></td> +<td align="justify">Moves the left margin of the next and all the +following commands one tab stop to the left.</td></tr> +<tr> +<td align="left">\' <a id="id2525341" class="indexterm"></a></td> +<td align="justify">Moves everything that you have typed so far in +the current column, i.e. everything from the most recent +<tt class="literal">\></tt>, <tt class="literal">\<</tt>, +<tt class="literal">\'</tt>, <tt class="literal">\\</tt>, or +<tt class="literal">\kill</tt> command, to the right of the +previous column, flush against the current column's tab +stop.</td></tr> +<tr> +<td align="left">\` <a id="id2525392" class="indexterm"></a></td> +<td align="justify">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 +<tt class="literal">\`</tt> command moves all the text that follows +it, up to the <tt class="literal">\\</tt> or +<tt class="literal">\end{tabbing}</tt> command that ends the line, +to the right margin of the tabbing environment. There must be no +<tt class="literal">\></tt> or <tt class="literal">\'</tt> +command between the <tt class="literal">\`</tt> and the command +that ends the line.</td></tr> +<tr> +<td align="left">\kill <a id="id2525452" +class="indexterm"></a></td> +<td align="justify">Sets tab stops without producing text. Works +just like <tt class="literal">\\</tt> except that it throws away +the current line instead of producing output for it. The effect of +any <tt class="literal">\=</tt>, <tt class="literal">\+</tt> or +<tt class="literal">\-</tt> commands in that line remain in +effect.</td></tr> +<tr> +<td align="left">\pushtabs <a id="id2525497" +class="indexterm"></a></td> +<td align="justify">Saves all current tab stop positions. Useful +for temporarily changing tab stop positions in the middle of a +<tt class="literal">tabbing</tt> environment.</td></tr> +<tr> +<td align="left">\poptabs <a id="id2525524" +class="indexterm"></a></td> +<td align="justify">Restores the tab stop positions saved by the +last <tt class="literal">\pushtabs</tt>.</td></tr> +<tr> +<td align="left">\a <a id="id2525548" class="indexterm"></a></td> +<td align="justify">In a <tt class="literal">tabbing</tt> +environment, the commands <tt class="literal">\=</tt>, +<tt class="literal">\'</tt> and <tt class="literal">\`</tt> do not +produce accents as normal. Instead, the commands +<tt class="literal">\a=</tt>, <tt class="literal">\a'</tt> and +<tt class="literal">\a`</tt> are +used.</td></tr></tbody></table></div> +<p>This example typesets a Pascal function in a traditional +format:</p> +<pre class="programlisting"> +\begin{tabbing} +function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ +\end{tabbing} +</pre> +<h5 class="title"> +<a id="env-table"></a><tt class="literal">table</tt></h5> +<a id="id2525638" class="indexterm"></a><a id="id2525645" +class="indexterm"></a><a id="id2525652" class="indexterm"></a> +<pre class="programlisting"> +\begin{table}[placement] + + body of the table + +\caption{table title} +\end{table} +</pre> +<p>Tables are objects that are not part of the normal text, and are +usually <span class="emphasis"><em>floated</em></span> to a +convenient place, like the top of a page. Tables will not be split +between two pages.</p> +<p>The optional argument <tt class="literal">[placement]</tt> +determines where LaTeX will try to place your table. There are four +places where LaTeX can possibly put a float:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">h</tt> : Here - at the position in the text +where the table environment appears.</li> +<li><tt class="literal">t</tt> : Top - at the top of a text +page.</li> +<li><tt class="literal">b</tt> : Bottom - at the bottom of a text +page.</li> +<li><tt class="literal">p</tt> : Page of floats - on a separate +float page, which is a page containing no text, only +floats.</li></ul></div> +<p>The standard <tt class="literal">report</tt> and +<tt class="literal">article</tt> classes use the default placement +<tt class="literal">[tbp]</tt>.</p> +<p>The body of the table is made up of whatever text, LaTeX +commands, etc., you wish. The <tt class="literal">\caption</tt> +command allows you to title your table.</p> +<h5 class="title"> +<a id="env-tabular"></a><tt class="literal">tabular</tt></h5> +<a id="id2525799" class="indexterm"></a><a id="id2525806" +class="indexterm"></a><a id="id2525813" class="indexterm"></a> +<pre class="programlisting"> +\begin{tabular}[pos]{cols} +column 1 entry & column 2 entry ... & column n entry \\ + . + . + . +\end{tabular} +</pre> +<p>or</p> +<pre class="programlisting"> +\begin{tabular*}{width}[pos]{cols} +column 1 entry & column 2 entry ... & column n entry \\ + . + . + . +\end{tabular*} +</pre> +<p>These environments produce a box consisting of a sequence of +rows of items, aligned vertically in columns. The mandatory and +optional arguments consist of:</p> +<div class="table"><a id="id2525850"></a> +<p class="title"><b>Table 1.5. Commands used inside a +<tt class="literal">tabular</tt> environment</b></p> +<table summary="Commands used inside a tabular environment" +border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">width</td> +<td align="justify">Specifies the width of the +<tt class="literal">tabular*</tt> environment. There must be rubber +space between columns that can stretch to fill out the specified +width.</td></tr> +<tr> +<td align="left">pos</td> +<td align="justify">Specifies the vertical position; default is +alignment on the centre of the environment. +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">t</tt> - align on top row</li> +<li><tt class="literal">b</tt> - align on bottom +row</li></ul></div></td></tr> +<tr> +<td align="left">cols</td> +<td align="justify">Specifies the column formatting. It consists of +a sequence of the following specifiers, corresponding to the +sequence of columns and intercolumn material. +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">l</tt> - A column of left-aligned +items.</li> +<li><tt class="literal">r</tt> - A column of right-aligned +items.</li> +<li><tt class="literal">c</tt> - A column of centred items.</li> +<li><tt class="literal">|</tt> - A vertical line the full height +and depth of the environment.</li> +<li><tt class="literal">@{text}</tt> - This inserts +<tt class="literal">text</tt> 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 +<tt class="literal">\extracolsep{wd}</tt> command in an +@-expression causes an extra space of width +<tt class="literal">wd</tt> to appear to the left of all subsequent +columns, until countermanded by another +<tt class="literal">\extracolsep</tt> command. Unlike ordinary +intercolumn space, this extra space is not suppressed by an +@-expression. An <tt class="literal">\extracolsep</tt> command can +be used only in an @-expression in the +<tt class="literal">cols</tt> argument.</li> +<li> +<p><tt class="literal">p{wd}</tt> - Produces a column with each +item typeset in a parbox of width <tt class="literal">wd</tt>, as +if it were the argument of a +<tt class="literal">\parbox[t]{wd}</tt> command. However, a +<tt class="literal">\\</tt> may not appear in the item, except in +the following situations:</p> +<div class="orderedlist"> +<ol type="1"> +<li>inside an environment like <tt class="literal">minipage</tt>, +<tt class="literal">array</tt>, or +<tt class="literal">tabular</tt>.</li> +<li>inside an explicit <tt class="literal">\parbox</tt>.</li> +<li>in the scope of a <tt class="literal">\centering</tt>, +<tt class="literal">\raggedright</tt>, or +<tt class="literal">\raggedleft</tt> declaration. The latter +declarations must appear inside braces or an environment when used +in a <tt class="literal">p</tt>-column +element.</li></ol></div></li> +<li><tt class="literal">*{num}{cols}</tt> - Equivalent to +<tt class="literal">num</tt> copies of +<tt class="literal">cols</tt>, where <tt class="literal">num</tt> +is any positive integer and <tt class="literal">cols</tt> is any +list of column-specifiers, which may contain another +<tt class="literal">*-expression</tt>.</li></ul></div></td></tr></tbody></table></div> +<p>These commands can be used inside a +<tt class="literal">tabular</tt> environment:</p> +<h5 class="title"> +<a id="cmd-cline"></a><tt class="literal">\cline{i-j}</tt></h5> +<a id="id2526249" class="indexterm"></a> +<p>The <tt class="literal">\cline</tt> command draws horizontal +lines across the columns specified, beginning in column +<tt class="literal">i</tt> and ending in column +<tt class="literal">j</tt>, which are identified in the mandatory +argument.</p> +<h5 class="title"> +<a id="cmd-hline"></a><tt class="literal">\hline</tt></h5> +<a id="id2526292" class="indexterm"></a> +<p>The <tt class="literal">\hline</tt> 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.</p> +<h5 class="title"> +<a id="cmd-multicolumn"></a><tt class="literal">\multicolumn</tt></h5> +<a id="id2526324" class="indexterm"></a> +<p><tt class="literal">\multicolumn{cols}{pos}{text}</tt></p> +<p>The <tt class="literal">\multicolumn</tt> is used to make an +entry that spans several columns. The first mandatory argument, +<tt class="literal">cols</tt>, specifies the number of columns to +span. The second mandatory argument, <tt class="literal">pos</tt>, +specifies the formatting of the entry; <tt class="literal">c</tt> +for centred, <tt class="literal">l</tt> for flushleft, +<tt class="literal">r</tt> for flushright. The third mandatory +argument, <tt class="literal">text</tt>, specifies what text is to +make up the entry.</p> +<h5 class="title"> +<a id="cmd-vline"></a><tt class="literal">\vline</tt></h5> +<a id="id2526402" class="indexterm"></a> +<p>The <tt class="literal">\vline</tt> command will draw a vertical +line extending the full height and depth of its row. An +<tt class="literal">\hfill</tt> command can be used to move the +line to the edge of the column. It can also be used in an +@-expression.</p> +<h5 class="title"> +<a id="env-thebibliography"></a><tt class="literal">thebibliography</tt></h5> +<a id="id2526441" class="indexterm"></a><a id="id2526448" +class="indexterm"></a> +<pre class="programlisting"> +\begin{thebibliography}{widest-label} +\bibitem[label]{cite_key} + . + . + . +\end{thebibliography} +</pre> +<p>The <tt class="literal">thebibliography</tt> environment +produces a bibliography or reference list. In the +<tt class="literal">article</tt> class, this reference list is +labelled <span class="emphasis"><em>References</em></span>; in the +<tt class="literal">report</tt> class, it is labelled +<span class="emphasis"><em>Bibliography</em></span>.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">widest-label</tt>: Text that, when printed, +is approximately as wide as the widest item label produces by the +<tt class="literal">\bibitem</tt> commands.</li></ul></div> +<h5 class="title"> +<a id="cmd-bibitem"></a><tt class="literal">\bibitem[label]{cite_key}</tt></h5> +<a id="id2526531" class="indexterm"></a> +<p>The <tt class="literal">\bibitem</tt> command generates an entry +labelled by <tt class="literal">label</tt>. If the +<tt class="literal">label</tt> argument is missing, a number is +generated as the <tt class="literal">label</tt>, using the +<tt class="literal">enumi</tt> counter. The +<tt class="literal">cite_key</tt> is any sequence of letters, +numbers, and punctuation symbols not containing a comma. This +command writes an entry on the <tt class="filename">.aux</tt> file +containing <tt class="literal">cite_key</tt> and the item's +<tt class="literal">label</tt>. When this +<tt class="filename">.aux</tt> file is read by the +<tt class="literal">\begin{document}</tt> command, the item's +<tt class="literal">label</tt> is associated with +<tt class="literal">cite_key</tt>, causing the reference to +<tt class="literal">cite_key</tt> by a +<tt class="literal">\cite</tt> command to produce the associated +<tt class="literal">label</tt>.</p> +<h5 class="title"> +<a id="cmd-cite"></a><tt class="literal">\cite[text]{key_list}</tt></h5> +<a id="id2526657" class="indexterm"></a> +<p>The <tt class="literal">key_list</tt> argument is a list of +citation keys. This command generates an in-text citation to the +references associated with the keys in +<tt class="literal">key_list</tt> by entries on the +<tt class="filename">.aux</tt> file read by the +<tt class="literal">\begin{document}</tt> command.</p> +<p>The optional <tt class="literal">text</tt> argument will appear +after the citation, i.e. +<tt class="literal">\cite[p.~2f.]{knuth}</tt> might produce +`[Knuth, p. 2]'.</p> +<p><a id="id2526714" class="indexterm"></a> The package +<tt class="literal">cite.sty</tt> allows a line break in the +<tt class="literal">\cite</tt> reference and can sort numerical +entries.</p> +<p><a id="id2526740" class="indexterm"></a> +<tt class="literal">overcite.sty</tt> makes citations like +footnotes.</p> +<h5 class="title"> +<a id="cmd-nocite"></a><tt class="literal">\nocite{key_list}</tt></h5> +<a id="id2526770" class="indexterm"></a> +<p>The <tt class="literal">\nocite</tt> command produces no text, +but writes <tt class="literal">key_list</tt>, which is a list of +one or more citation keys, on the <tt class="filename">.aux</tt> +file. <tt class="literal">\nocite{*}</tt> uses all entries from the +BibTeX database.</p> +<h5 class="title"><a id="using-bibtex"></a>Using BibTeX</h5> +<a id="id2526818" class="indexterm"></a><a id="id2526825" +class="indexterm"></a><a id="id2526837" +class="indexterm"></a><a id="id2526844" +class="indexterm"></a><a id="id2526855" class="indexterm"></a> +<p>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 +<tt class="literal">thebibliography</tt> environment. Instead, you +include the lines</p> +<pre class="programlisting"> +\bibliographystyle{style} +\bibliography{bibfile} +</pre> +<p>where <tt class="literal">style</tt> refers to a file +<tt class="literal">style.bst</tt>, which defines how your +citations will look.</p> +<div class="table"><a id="id2526898"></a> +<p class="title"><b>Table 1.6. Standard styles +distributed with BibTeX</b></p> +<table summary="Standard styles distributed with BibTeX" +border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">alpha</td> +<td align="justify">Sorted alphabetically. Labels are formed from +name of author and year of publication.</td></tr> +<tr> +<td align="left">plain</td> +<td align="justify">Sorted alphabetically. Labels are +numeric.</td></tr> +<tr> +<td align="left">unsrt</td> +<td align="justify">Like <tt class="literal">plain</tt>, but +entries are in order of citation.</td></tr> +<tr> +<td align="left">abbrv</td> +<td align="justify">Like <tt class="literal">plain</tt>, but more +compact labels.</td></tr></tbody></table></div> +<p>In addition, numerous other BibTeX style files exist tailored to +the demands of various publications.</p> +<p>The argument to <tt class="literal">\bibliography</tt> refers to +the file <tt class="literal">bibfile.bib</tt>, which should contain +your database in BibTeX format. Only the entries referred to via +<tt class="literal">\cite</tt> and <tt class="literal">\nocite</tt> +will be listed in the bibliography.</p> +<h5 class="title"> +<a id="env-theorem"></a><tt class="literal">theorem</tt></h5> +<a id="id2527036" class="indexterm"></a><a id="id2527043" +class="indexterm"></a> +<pre class="programlisting"> +\begin{theorem} + theorem text +\end{theorem} +</pre> +<p>The <tt class="literal">theorem</tt> environment produces +<span class="emphasis"><em>Theorem x</em></span> in boldface +followed by your theorem text.</p> +<h5 class="title"> +<a id="env-titlepage"></a><tt class="literal">titlepage</tt></h5> +<a id="id2527084" class="indexterm"></a><a id="id2527091" +class="indexterm"></a><a id="id2527098" class="indexterm"></a> +<pre class="programlisting"> +\begin{titlepage} + text +\end{titlepage} +</pre> +<p>The <tt class="literal">titlepage</tt> 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 <tt class="literal">\today</tt> +command comes in handy for title pages. <a id="id2527130" +class="indexterm"></a></p> +<p>Note that you can use the <tt class="literal">\maketitle</tt> +(see <a href="#cmd-maketitle">\maketitle</a>) command to produce a +standard title page.</p> +<h5 class="title"> +<a id="env-verbatim"></a><tt class="literal">verbatim</tt></h5> +<a id="id2527170" class="indexterm"></a><a id="id2527177" +class="indexterm"></a><a id="id2527184" +class="indexterm"></a><a id="id2527191" +class="indexterm"></a><a id="id2527198" class="indexterm"></a> +<pre class="programlisting"> +\begin{verbatim} + text +\end{verbatim} +</pre> +<p>The <tt class="literal">verbatim</tt> 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.</p> +<h5 class="title"><a id="cmd-verb"></a><tt class="literal">\verb +char literal_text char</tt> <tt class="literal">\verb*char +literal_text char</tt></h5> +<a id="id2527251" class="indexterm"></a><a id="id2527258" +class="indexterm"></a> +<p>Typesets <tt class="literal">literal_text</tt> exactly as typed, +including special characters and spaces, using a typewriter +(<tt class="literal">\tt</tt>) type style. There may be no space +between <tt class="literal">\verb</tt> or +<tt class="literal">\verb*</tt> and <tt class="literal">char</tt> +(space is shown here only for clarity). The +<tt class="literal">*-form</tt> differs only in that spaces are +printed</p> +<h5 class="title"> +<a id="env-verse"></a><tt class="literal">verse</tt></h5> +<a id="id2527321" class="indexterm"></a><a id="id2527327" +class="indexterm"></a> +<pre class="programlisting"> +\begin{verse} + text +\end{verse} +</pre> +<p>The <tt class="literal">verse</tt> environment is designed for +poetry, though you may find other uses for it.</p> +<p>The margins are indented on the left and the right. Separate the +lines of each stanza with <tt class="literal">\\</tt>, and use one +or more blank lines to separate the stanzas.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="footnotes"></a>2.3.7 +Footnotes</h4></div></div></div> +<a id="id2527382" class="indexterm"></a> +<p>Footnotes can be produced in one of two ways. They can be +produced with one command, the <tt class="literal">\footnote</tt> +command. They can also be produced with two commands, the +<tt class="literal">\footnotemark</tt> and the +<tt class="literal">\footnotetext</tt> commands. See the specific +command for information on why you would use one over the +other.</p> +<h5 class="title"> +<a id="cmd-cmd-footnote"></a><tt class="literal">\footnote[number]{text}</tt></h5> +<a id="id2527428" class="indexterm"></a> +<p>The <tt class="literal">\footnote</tt> command places the +numbered footnote <tt class="literal">text</tt> at the bottom of +the current page. The optional argument, +<tt class="literal">number</tt>, 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 +<tt class="literal">\chapter</tt>, in figures, tables or in a +<tt class="literal">tabular</tt> environment.</p> +<h5 class="title"> +<a id="cmd-footnotemark"></a><tt class="literal">\footnotemark</tt></h5> +<a id="id2527486" class="indexterm"></a> +<p>The <tt class="literal">\footnotemark</tt> command puts the +footnote <tt class="literal">number</tt> in the text. This command +can be used in inner paragraph mode. The text of the footnote is +supplied by the <tt class="literal">\footnotetext</tt> command.</p> +<p>This command can be used to produce several consecutive footnote +markers referring to the same footnote by using</p> +<p><tt class="literal">\footnotemark[\value{footnote}]</tt></p> +<p>after the first <tt class="literal">\footnote</tt> command.</p> +<h5 class="title"> +<a id="cmd-footnotetext"></a><tt class="literal">\footnotetext[number]{text}</tt></h5> +<a id="id2527554" class="indexterm"></a> +<p>The <tt class="literal">\footnotetext</tt> command produces the +<tt class="literal">text</tt> to be placed at the bottom of the +page. This command can come anywhere after the +<tt class="literal">\footnotemark</tt> command. The +<tt class="literal">\footnotetext</tt> command must appear in outer +paragraph mode.</p> +<p>The optional argument, <tt class="literal">number</tt>, is used +to change the default footnote number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="lengths"></a>2.3.8 +Lengths</h4></div></div></div> +<a id="id2527617" class="indexterm"></a> +<p>A <tt class="literal">length</tt> is a measure of distance. Many +LaTeX commands take a length as an argument.</p> +<h5 class="title"> +<a id="cmd-newlength"></a><tt class="literal">\newlength</tt></h5> +<a id="id2527651" class="indexterm"></a><a id="id2527658" +class="indexterm"></a> +<p><tt class="literal">\newlength{\gnat}</tt></p> +<p>The <tt class="literal">\newlength</tt> command defines the +mandatory argument, <tt class="literal">\gnat</tt>, as a +<tt class="literal">length</tt> command with a value of +<tt class="literal">0in</tt>. An error occurs if a +<tt class="literal">\gnat</tt> command already exists.</p> +<h5 class="title"> +<a id="cmd-setlength"></a><tt class="literal">\setlength</tt></h5> +<a id="id2527721" class="indexterm"></a><a id="id2527728" +class="indexterm"></a> +<p><tt class="literal">\setlength{\gnat}{length}</tt></p> +<p>The <tt class="literal">\setlength</tt> command is used to set +the value of a <tt class="literal">length</tt> command. The +<tt class="literal">length</tt> argument can be expressed in any +terms of length LaTeX understands, i.e., inches +(<tt class="literal">in</tt>), millimetres +(<tt class="literal">mm</tt>), points +(<tt class="literal">pt</tt>), etc.</p> +<h5 class="title"> +<a id="cmd-addtolength"></a><tt class="literal">\addtolength</tt></h5> +<a id="id2527801" class="indexterm"></a><a id="id2527808" +class="indexterm"></a> +<p><tt class="literal">\addtolength{\gnat}{length}</tt></p> +<p>The <tt class="literal">\addtolength</tt> command increments +<span class="emphasis"><em>length command</em></span> by the amount +specified in the <tt class="literal">length</tt> argument. It can +be a negative amount.</p> +<h5 class="title"> +<a id="cmd-settodepth"></a><tt class="literal">\settodepth</tt></h5> +<a id="id2527857" class="indexterm"></a> +<p><tt class="literal">\settodepth{\gnat}{text}</tt></p> +<p>The <tt class="literal">\settodepth</tt> command sets the value +of a <tt class="literal">length</tt> command equal to the depth of +the <tt class="literal">text</tt> argument.</p> +<h5 class="title"> +<a id="cmd-settoheight"></a><tt class="literal">\settoheight</tt></h5> +<a id="id2527906" class="indexterm"></a> +<p><tt class="literal">\settoheight{\gnat}{text}</tt></p> +<p>The <tt class="literal">\settoheight</tt> command sets the value +of a <tt class="literal">length</tt> command equal to the height of +the <tt class="literal">text</tt> argument.</p> +<h5 class="title"> +<a id="cmd-settowidth"></a><tt class="literal">\settowidth</tt></h5> +<a id="id2527956" class="indexterm"></a> +<p><tt class="literal">\settowidth{\gnat}{text}</tt></p> +<p>The <tt class="literal">\settowidth</tt> command sets the value +of a <tt class="literal">length</tt> command equal to the width of +the <tt class="literal">text</tt> argument.</p> +<h5 class="title"> +<a id="predefined-lengths-title"></a><tt class="literal">Predefined +lengths</tt></h5> +<a id="id2528006" class="indexterm"></a><a id="id2528013" +class="indexterm"></a> +<p><a id="cmd-length-pre-width"></a><tt class="literal">\width</tt> +<a id="id2528031" class="indexterm"></a></p> +<p> +<a id="cmd-length-pre-height"></a><tt class="literal">\height</tt> +<a id="id2528050" class="indexterm"></a></p> +<p><a id="cmd-length-pre-depth"></a><tt class="literal">\depth</tt> +<a id="id2528069" class="indexterm"></a></p> +<p> +<a id="cmd-length-pre-totalheight"></a><tt class="literal">\totalheight</tt> +<a id="id2528088" class="indexterm"></a></p> +<p>These length parameters can be used in the arguments of the +box-making commands See <a href="#spaces-and-boxes" +title="2.3.17 Spaces & Boxes">Spaces & Boxes</a>. They +specify the natural width etc. of the text in the box. +<tt class="literal">\totalheight</tt> equals +<tt class="literal">\height</tt> + <tt class="literal">\depth</tt>. +To make a box with the text stretched to double the natural size, +e.g., say</p> +<p><tt class="literal">\makebox[2\width]{Get a +stretcher}</tt></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="letters"></a>2.3.9 +Letters</h4></div></div></div> +<a id="id2528153" class="indexterm"></a><a id="id2528160" +class="indexterm"></a> +<p>You can use LaTeX to typeset letters, both personal and +business. The <tt class="literal">letter</tt> document class is +designed to make a number of letters at once, although you can make +just one if you so desire.</p> +<p>Your <tt class="filename">.tex</tt> source file has the same +minimum commands as the other document classes, i.e., you must have +the following commands as a minimum:</p> +<pre class="programlisting"> +\documentclass{letter} +\begin{document} + ... letters ... +\end{document} +</pre> +<p>Each letter is a <tt class="literal">letter</tt> environment, +whose argument is the name and address of the recipient. For +example, you might have:</p> +<pre class="programlisting"> +\begin{letter}{Mr. Joe Smith\\ 2345 Princess St.\\ Edinburgh, EH1 1AA} + ... +\end{letter} +</pre> +<p>The letter itself begins with the +<tt class="literal">\opening</tt> command. The text of the letter +follows. It is typed as ordinary LaTeX input. Commands that make no +sense in a letter, like <tt class="literal">\chapter</tt>, do not +work. The letter closes with a <tt class="literal">\closing</tt> +command.</p> +<p>After the <tt class="literal">closing</tt>, you can have +additional material. The <tt class="literal">\cc</tt> command +produces the usual <span class="emphasis"><em>cc: ...</em></span>. +There's also a similar <tt class="literal">\encl</tt> command for a +list of enclosures. With both these commands, use +<tt class="literal">\\</tt> to separate the items.</p> +<p>These commands are used with the <tt class="literal">letter</tt> +class:</p> +<h5 class="title"><a id="cmd-address"></a>\address</h5> +<a id="id2528302" class="indexterm"></a> +<p><tt class="literal">\address{Return address}</tt></p> +<p>The return address, as it should appear on the letter and the +envelope. Separate lines of the address should be separated by +<tt class="literal">\\</tt> commands. If you do not make an +<tt class="literal">\address</tt> declaration, then the letter will +be formatted for copying onto your organisation's standard +letterhead. (See <a href="#overview" +title="2.2 Overview of LaTeX and Local Guide ">Overview</a>, for +details on your local implementation). If you give an +<tt class="literal">\address</tt> declaration, then the letter will +be formatted as a personal letter.</p> +<h5 class="title"><a id="cmd-cc"></a>\cc</h5> +<a id="id2528361" class="indexterm"></a><a id="id2528368" +class="indexterm"></a> +<p><tt class="literal">\cc{Kate Schechter\\Rob McKenna}</tt></p> +<p>Generate a list of other persons the letter was sent to. Each +name is printed on a separate line.</p> +<h5 class="title"><a id="cmd-closing"></a>\closing</h5> +<a id="id2528397" class="indexterm"></a><a id="id2528404" +class="indexterm"></a> +<p><tt class="literal">\closing{text}</tt></p> +<p>The letter closes with a <tt class="literal">\closing</tt> +command, i.e.,</p> +<pre class="programlisting"> +\closing{Best Regards,} +</pre> +<h5 class="title"><a id="cmd-encl"></a>\encl</h5> +<a id="id2528444" class="indexterm"></a><a id="id2528451" +class="indexterm"></a> +<p><tt class="literal">\encl{CV\\Certificates}</tt></p> +<p>Generate a list of enclosed material.</p> +<h5 class="title"><a id="cmd-location"></a>\location</h5> +<a id="id2528480" class="indexterm"></a> +<p><tt class="literal">\location{address}</tt></p> +<p>This modifies your organisation's standard address. This only +appears if the <tt class="literal">firstpage</tt> pagestyle is +selected.</p> +<h5 class="title"><a id="cmd-makelabels"></a>\makelabels</h5> +<a id="id2528515" class="indexterm"></a> +<p><tt class="literal">\makelabels{number}</tt></p> +<p>If you issue this command in the preamble, LaTeX will create a +sheet of address labels. This sheet will be output before the +letters.</p> +<h5 class="title"><a id="cmd-name"></a>\name</h5> +<a id="id2528548" class="indexterm"></a> +<p><tt class="literal">\name{June Davenport}</tt></p> +<p>Your name, used for printing on the envelope together with the +return address.</p> +<h5 class="title"><a id="cmd-opening"></a>\opening</h5> +<a id="id2528577" class="indexterm"></a><a id="id2528584" +class="indexterm"></a> +<p><tt class="literal">\opening{text}</tt></p> +<p>The letter begins with the <tt class="literal">\opening</tt> +command. The mandatory argument, <tt class="literal">text</tt>, is +whatever text you wish to start your letter, i.e.,</p> +<pre class="programlisting"> +\opening{Dear Joe,} +</pre> +<h5 class="title"><a id="cmd-ps"></a>\ps</h5> +<a id="id2528632" class="indexterm"></a> +<p><tt class="literal">\ps</tt></p> +<p>Use this command before a postscript.</p> +<h5 class="title"><a id="cmd-signature"></a>\signature</h5> +<a id="id2528660" class="indexterm"></a> +<p><tt class="literal">\signature{Harvey Swick}</tt></p> +<p>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 <tt class="literal">\\</tt> +commands.</p> +<h5 class="title"><a id="cmd-startbreaks"></a>\startbreaks</h5> +<a id="id2528696" class="indexterm"></a> +<p><tt class="literal">\startbreaks</tt></p> +<p>Used after a <tt class="literal">\stopbreaks</tt> command to +allow page breaks again.</p> +<h5 class="title"><a id="cmd-stopbreaks"></a>\stopbreaks</h5> +<a id="id2528732" class="indexterm"></a> +<p><tt class="literal">\stopbreaks</tt></p> +<p>Inhibit page breaks until a +<tt class="literal">\startbreaks</tt> command occurs.</p> +<h5 class="title"><a id="cmd-telephone"></a>\telephone</h5> +<a id="id2528766" class="indexterm"></a> +<p><tt class="literal">\telephone{number}</tt></p> +<p>This is your telephone number. This only appears if the +<tt class="literal">firstpage</tt> pagestyle is selected.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="line-and-page-breaking"></a>2.3.10 Line +& Page Breaking</h4></div></div></div> +<a id="id2528809" class="indexterm"></a><a id="id2528816" +class="indexterm"></a><a id="id2528823" class="indexterm"></a> +<p>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 +<tt class="literal">\\</tt> command, but LaTeX usually does it for +you.</p> +<h5 class="title"><a id="cmd-bslash"></a>\\</h5> +<a id="id2528860" class="indexterm"></a><a id="id2528867" +class="indexterm"></a> +<p><tt class="literal">\\[extra-space], \\*[extra-space]</tt></p> +<p>The <tt class="literal">\\</tt> command tells LaTeX to start a +new line. It has an optional argument, +<tt class="literal">extra-space</tt>, that specifies how much extra +vertical space is to be inserted before the next line. This can be +a negative amount.</p> +<p>The <tt class="literal">\\*</tt> command is the same as the +ordinary <tt class="literal">\\</tt> command except that it tells +LaTeX not to start a new page after the line.</p> +<h5 class="title"><a id="cmd-dash-op-hyphenation-cp"></a>\-</h5> +<a id="id2528935" class="indexterm"></a><a id="id2528942" +class="indexterm"></a> +<p>The <tt class="literal">\-</tt> 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 <tt class="literal">\-</tt> command is used for the +exceptional cases.</p> +<p>Note that when you insert <tt class="literal">\-</tt> 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.</p> +<h5 class="title"> +<a id="cmd-cleardoublepage"></a>\cleardoublepage</h5> +<a id="id2528999" class="indexterm"></a><a id="id2529006" +class="indexterm"></a> +<p>The <tt class="literal">\cleardoublepage</tt> 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.</p> +<h5 class="title"><a id="cmd-clearpage"></a>\clearpage</h5> +<a id="id2529037" class="indexterm"></a><a id="id2529044" +class="indexterm"></a> +<p>The <tt class="literal">\clearpage</tt> command ends the current +page and causes all figures and tables that have so far appeared in +the input to be printed.</p> +<h5 class="title"> +<a id="cmd-enlargethispage"></a>\enlargethispage</h5> +<a id="id2529072" class="indexterm"></a><a id="id2529079" +class="indexterm"></a> +<p><tt class="literal">\enlargethispage{size}</tt></p> +<p><tt class="literal">\enlargethispage*{size}</tt></p> +<p>Enlarge the <tt class="literal">\textheight</tt> for the current +page by the specified amount; e.g. +<tt class="literal">\enlargethispage{\baselineskip}</tt> will allow +one additional line.</p> +<p>The starred form tries to squeeze the material together on the +page as much as possible. This is normally used together with an +explicit <tt class="literal">\pagebreak</tt>.</p> +<h5 class="title"><a id="cmd-samepage"></a>\samepage</h5> +<a id="id2529141" class="indexterm"></a> +<p><tt class="literal">\samepage</tt></p> +<p>The object in the argument <tt class="literal">{}</tt> should be +on the current page.</p> +<h5 class="title"><a id="cmd-fussy"></a>\fussy</h5> +<a id="id2529176" class="indexterm"></a> +<p><tt class="literal">\fussy</tt></p> +<p>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.</p> +<p>This command cancels the effect of a previous +<tt class="literal">\sloppy</tt> command. +<a href="#cmd-sloppy">\sloppy</a></p> +<h5 class="title"><a id="cmd-hyphenation"></a>\hyphenation</h5> +<a id="id2529227" class="indexterm"></a><a id="id2529234" +class="indexterm"></a> +<p><tt class="literal">\hyphenation{words}</tt></p> +<p>The <tt class="literal">\hyphenation</tt> command declares +allowed hyphenation points, where <tt class="literal">words</tt> is +a list of words, separated by spaces, in which each hyphenation +point is indicated by a <tt class="literal">-</tt> character.</p> +<h5 class="title"><a id="cmd-linebreak"></a>\linebreak</h5> +<a id="id2529283" class="indexterm"></a><a id="id2529290" +class="indexterm"></a> +<p><tt class="literal">\linebreak[number]</tt></p> +<p>The <tt class="literal">\linebreak</tt> command tells LaTeX to +break the current line at the point of the command. With the +optional argument, <tt class="literal">number</tt>, you can convert +the <tt class="literal">\linebreak</tt> 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.</p> +<p>The <tt class="literal">\linebreak</tt> command causes LaTeX to +stretch the line so it extends to the right margin.</p> +<h5 class="title"><a id="cmd-newline"></a>\newline</h5> +<a id="id2529357" class="indexterm"></a><a id="id2529364" +class="indexterm"></a> +<p>The <tt class="literal">\newline</tt> command breaks the line +right where it is. It can only be used in paragraph mode.</p> +<h5 class="title"><a id="cmd-newpage"></a>\newpage</h5> +<a id="id2529392" class="indexterm"></a><a id="id2529398" +class="indexterm"></a> +<p>The <tt class="literal">\newpage</tt> command ends the current +page. In contrast to <a href="#cmd-pagebreak">\pagebreak</a> it can +produce a partly empty page, even when +<a href="#cmd-flushbottom-title">\flushbottom</a> is active.</p> +<h5 class="title"><a id="cmd-nolinebreak"></a>\nolinebreak</h5> +<a id="id2529443" class="indexterm"></a> +<p><tt class="literal">\nolinebreak[number]</tt></p> +<p>The <tt class="literal">\nolinebreak</tt> command prevents LaTeX +from breaking the current line at the point of the command. With +the optional argument, <tt class="literal">number</tt>, you can +convert the <tt class="literal">\nolinebreak</tt> 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.</p> +<h5 class="title"><a id="cmd-nopagebreak"></a>\nopagebreak</h5> +<a id="id2529498" class="indexterm"></a> +<p><tt class="literal">\nopagebreak[number]</tt></p> +<p>The <tt class="literal">\nopagebreak</tt> command prevents LaTeX +from breaking the current page at the point of the command. With +the optional argument, <tt class="literal">number</tt>, you can +convert the <tt class="literal">\nopagebreak</tt> 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.</p> +<h5 class="title"><a id="cmd-pagebreak"></a>\pagebreak</h5> +<a id="id2529553" class="indexterm"></a><a id="id2529559" +class="indexterm"></a> +<p><tt class="literal">\pagebreak[number]</tt></p> +<p>The <tt class="literal">\pagebreak</tt> command tells LaTeX to +break the current page at the point of the command. With the +optional argument, <tt class="literal">number</tt>, you can convert +the <tt class="literal">\pagebreak</tt> 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.</p> +<h5 class="title"><a id="cmd-sloppy"></a>\sloppy</h5> +<a id="id2529612" class="indexterm"></a> +<p><tt class="literal">\sloppy</tt></p> +<p>This declaration makes TeX less fussy about line breaking. This +can prevent overfull boxes, but may leave too much space between +words.</p> +<p>Lasts until a <tt class="literal">\fussy</tt> command is issued. +<a href="#cmd-fussy">\fussy</a>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="making-paragraphs"></a>2.3.11 Making +Paragraphs</h4></div></div></div> +<a id="id2529670" class="indexterm"></a><a id="id2529677" +class="indexterm"></a> +<p>A paragraph is ended by one or more completely blank lines --- +lines not containing even a <tt class="literal">%</tt>. 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.</p> +<h5 class="title"><a id="cmd-indent"></a>\indent</h5> +<a id="id2529706" class="indexterm"></a><a id="id2529713" +class="indexterm"></a> +<p><tt class="literal">\indent</tt></p> +<p>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.</p> +<h5 class="title"><a id="cmd-noindent"></a>\noindent</h5> +<a id="id2529744" class="indexterm"></a><a id="id2529751" +class="indexterm"></a> +<p><tt class="literal">\noindent</tt></p> +<p>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.</p> +<h5 class="title"><a id="cmd-par"></a>\par</h5> +<a id="id2529781" class="indexterm"></a><a id="id2529787" +class="indexterm"></a> +<p>Equivalent to a blank line; often used to make command or +environment definitions easier to read.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="margin-notes"></a>2.3.12 Margin +Notes</h4></div></div></div> +<a id="id2529815" class="indexterm"></a><a id="id2529822" +class="indexterm"></a><a id="id2529829" class="indexterm"></a> +<p>The command <tt class="literal">\marginpar[left]{right}</tt> +creates a note in the margin. The first line will be at the same +height as the line in the text where the +<tt class="literal">\marginpar</tt> occurs.</p> +<p>When you only specify the mandatory argument +<tt class="literal">right</tt>, the text will be placed</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>in the right margin for one-sided layout</li> +<li>in the outside margin for two-sided layout</li> +<li>in the nearest margin for two-column layout.</li></ul></div> +<p>By issuing the command +<tt class="literal">\reversemarginpar</tt>, you can force the +marginal notes to go into the opposite (inside) margin.</p> +<p>When you specify both arguments, <tt class="literal">left</tt> +is used for the left margin, and <tt class="literal">right</tt> is +used for the right margin.</p> +<p>The first word will normally not be hyphenated; you can enable +hyphenation by prefixing the first word with a +<tt class="literal">\hspace{0pt}</tt> command.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="math-formulae"></a>2.3.13 Math +Formulae</h4></div></div></div> +<a id="id2529943" class="indexterm"></a><a id="id2529950" +class="indexterm"></a><a id="id2529957" +class="indexterm"></a><a id="id2529964" +class="indexterm"></a><a id="id2529971" +class="indexterm"></a><a id="id2529977" +class="indexterm"></a><a id="id2529984" +class="indexterm"></a><a id="id2529990" class="indexterm"></a> +<div class="table"><a id="id2529997"></a> +<p class="title"><b>Table 1.7. Three environments that +put LaTeX in math mode</b></p> +<table summary="Three environments that put LaTeX in math mode" +border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">math</td> +<td align="justify">For Formulae that appear right in the +text.</td></tr> +<tr> +<td align="left">displaymath</td> +<td align="justify">For Formulae that appear on their own +line.</td></tr> +<tr> +<td align="left">equation</td> +<td align="justify">The same as the displaymath environment except +that it adds an equation number in the right +margin.</td></tr></tbody></table></div> +<p>The <tt class="literal">math</tt> environment can be used in +both paragraph and LR mode, but the +<tt class="literal">displaymath</tt> and +<tt class="literal">equation</tt> environments can be used only in +paragraph mode. The <tt class="literal">math</tt> and +<tt class="literal">displaymath</tt> environments are used so often +that they have the following short forms:</p> +<pre class="programlisting"> +\(...\) instead of \begin{math}...\end{math} + +\[...\] instead of \begin{displaymath}...\end{displaymath} +</pre> +<p>In fact, the <tt class="literal">math</tt> environment is so +common that it has an even shorter form:</p> +<pre class="programlisting"> +$ ... $ instead of \(...\) +</pre> +<a id="id2530129" class="indexterm"></a> +<h5 class="title"> +<a id="subscripts-and-superscripts-title"></a>Subscripts & +Superscripts</h5> +<a id="id2530148" class="indexterm"></a><a id="id2530154" +class="indexterm"></a><a id="id2530161" +class="indexterm"></a><a id="id2530168" class="indexterm"></a> +<p>To get an expression <span class="emphasis"><em>exp</em></span> +to appear as a subscript, you just type +<tt class="literal">_{</tt><span class="emphasis"><em>exp</em></span><tt class="literal"> +}</tt> . To get <span class="emphasis"><em>exp</em></span> to +appear as a superscript, you type +<tt class="literal">^{</tt><span class="emphasis"><em>exp</em></span> +<tt class="literal">}</tt>. 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.</p> +<h5 class="title"><a id="math-symbols-title"></a>Math Symbols</h5> +<a id="id2530229" class="indexterm"></a><a id="id2530236" +class="indexterm"></a><a id="id2530243" class="indexterm"></a> +<h5 class="title"><a id="spacing-in-math-mode-title"></a>Spacing in +Math Mode</h5> +<a id="id2530261" class="indexterm"></a><a id="id2530268" +class="indexterm"></a> +<p>In a <tt class="literal">math</tt> 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:</p> +<a id="id2530299" class="indexterm"></a><a id="id2530306" +class="indexterm"></a><a id="id2530313" +class="indexterm"></a><a id="id2530319" class="indexterm"></a> +<div class="orderedlist"> +<ol type="1"> +<li> +<p><tt class="literal">\;</tt> - a thick space</p></li> +<li> +<p><tt class="literal">\:</tt> - a medium space</p></li> +<li> +<p><tt class="literal">\,</tt> - a thin space</p></li> +<li> +<p><tt class="literal">\!</tt> - a negative thin +space</p></li></ol></div> +<h5 class="title"><a id="math-miscellany-title"></a>Math +Miscellany</h5> +<a id="id2530384" class="indexterm"></a> +<div class="table"><a id="id2530391"></a> +<p class="title"><b>Table 1.8. Math Miscellany</b></p> +<table summary="Math Miscellany" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left"> +<a id="cmd-math-misc-cdots"></a>\cdots<a id="id2530429" +class="indexterm"></a></td> +<td align="justify">Produces a horizontal ellipsis where the dots +are raised to the centre of the line.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-ddots"></a>\ddots +<a id="id2530454" class="indexterm"></a></td> +<td align="justify">Produces a diagonal ellipsis.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-frac"></a>\frac{num}{den} +<a id="id2530477" class="indexterm"></a></td> +<td align="justify">Produces the fraction +<tt class="literal">num</tt> divided by +<tt class="literal">den</tt>.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-ldots"></a>\ldots +<a id="id2530510" class="indexterm"></a></td> +<td align="justify">Produces an ellipsis. This command works in any +mode, not just math mode.</td></tr> +<tr> +<td align="left"> +<a id="cmd-math-misc-overbrace"></a>\overbrace{text} +<a id="id2530534" class="indexterm"></a></td> +<td align="justify">Generates a brace over text.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-overline"></a>\overline{text} +<a id="id2530557" class="indexterm"></a></td> +<td align="justify">Causes the argument text to be +overlined.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-sqrt"></a>\sqrt[root]{arg} +<a id="id2530580" class="indexterm"></a></td> +<td align="justify">Produces the square root of its argument. The +optional argument, <tt class="literal">root</tt>, determines what +root to produce, i.e., the cube root of +<tt class="literal">x+y</tt> would be typed as +<tt class="literal">$\sqrt[3]{x+y}$</tt>.</td></tr> +<tr> +<td align="left"> +<a id="cmd-math-misc-underbrace"></a>\underbrace{text} +<a id="id2530623" class="indexterm"></a></td> +<td align="justify">Generates text with a brace +underneath.</td></tr> +<tr> +<td align="left"> +<a id="cmd-math-misc-underline"></a>\underline{text} +<a id="id2530646" class="indexterm"></a></td> +<td align="justify">Causes the argument text to be underlined. This +command can also be used in paragraph and LR modes.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-vdots"></a>\vdots +<a id="id2530671" class="indexterm"></a></td> +<td align="justify">Produces a vertical ellipsis.</td></tr> +<tr> +<td align="left"><a id="cmd-math-misc-ensuremath"></a>\ensuremath{} +<a id="id2530695" class="indexterm"></a></td> +<td align="justify">It's argument is set in math mode. This is +needed for own definitions.</td></tr></tbody></table></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="modes"></a>2.3.14 +Modes</h4></div></div></div> +<a id="id2530726" class="indexterm"></a><a id="id2530733" +class="indexterm"></a><a id="id2530740" +class="indexterm"></a><a id="id2530747" +class="indexterm"></a><a id="id2530754" class="indexterm"></a> +<p>When LaTeX is processing your input text, it is always in one of +three modes:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>paragraph mode</li> +<li>Math mode</li> +<li>Left-to-right mode, called LR mode for short</li></ul></div> +<p>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.</p> +<p><span class="emphasis"><em>Paragraph mode</em></span> 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 <span class="emphasis"><em>math +mode</em></span> when it's generating a mathematical formula. In +<span class="emphasis"><em>LR mode</em></span>, 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 +<tt class="literal">\mbox</tt>, 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.</p> +<p>LaTeX is in LR mode when it starts making a box with an +<tt class="literal">\mbox</tt> 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 <tt class="literal">parbox</tt>. When +LaTeX is in paragraph mode while making a box, it is said to be in +<span class="emphasis"><em>inner paragraph mode</em></span>. Its +normal paragraph mode, which it starts out in, is called +<span class="emphasis"><em>outer paragraph +mode</em></span>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="page-styles"></a>2.3.15 Page +Styles</h4></div></div></div> +<a id="id2530916" class="indexterm"></a><a id="id2530922" +class="indexterm"></a> +<p>The <tt class="literal">\documentclass</tt> command determines +the size and position of the page's head and foot. The page style +determines what goes in them.</p> +<h5 class="title"><a id="cmd-maketitle"></a>\maketitle</h5> +<a id="id2530951" class="indexterm"></a><a id="id2530958" +class="indexterm"></a> +<p><tt class="literal">\maketitle</tt></p> +<p>The <tt class="literal">\maketitle</tt> command generates a +title on a separate title page. In the +<tt class="literal">article</tt> class, +<tt class="literal">\maketitle</tt> will also switch to pagestyle +<tt class="literal">plain</tt>. See <a href="#page-styles" +title="2.3.15 Page Styles">Page Styles</a> for commands to change +page numbering.</p> +<p>Information used to produce the title is obtained from the +following declarations:</p> +<p>See <a href="#page-styles" title="2.3.15 Page Styles">Page +Styles</a> for the commands to give the information.</p> +<h5 class="title"><a id="cmd-author"></a>\author</h5> +<a id="id2531036" class="indexterm"></a><a id="id2531043" +class="indexterm"></a> +<p><tt class="literal">\author{names}</tt></p> +<p>The <tt class="literal">\author</tt> command declares the +author(s), where <tt class="literal">names</tt> is a list of +authors separated by <tt class="literal">\and</tt> commands. Use +<tt class="literal">\\</tt> to separate lines within a single +author's entry -- for example, to give the author's institution or +address.</p> +<h5 class="title"><a id="cmd-date"></a>\date</h5> +<a id="id2531098" class="indexterm"></a><a id="id2531105" +class="indexterm"></a> +<p><tt class="literal">\date{text}</tt></p> +<p>The <tt class="literal">\date</tt> command declares +<span class="emphasis"><em>text</em></span> to be the document's +date. With no <tt class="literal">\date</tt> command, the current +date is used.</p> +<h5 class="title"><a id="cmd-thanks"></a>\thanks</h5> +<a id="id2531149" class="indexterm"></a><a id="id2531156" +class="indexterm"></a> +<p><tt class="literal">\thanks{text}</tt></p> +<p>The <tt class="literal">\thanks</tt> command produces a +<tt class="literal">\footnote</tt> to the title.</p> +<h5 class="title"><a id="cmd-title"></a>\title</h5> +<a id="id2531196" class="indexterm"></a><a id="id2531203" +class="indexterm"></a> +<p><tt class="literal">\title{text}</tt></p> +<p>The <tt class="literal">\title</tt> command declares +<tt class="literal">text</tt> to be the title. Use +<tt class="literal">\\</tt> to tell LaTeX where to start a new line +in a long title.</p> +<h5 class="title"><a id="cmd-pagenumbering"></a>\pagenumbering</h5> +<a id="id2531254" class="indexterm"></a><a id="id2531261" +class="indexterm"></a> +<p><tt class="literal">\pagenumbering{num_style}</tt></p> +<p>Specifies the style of page numbers. Possible values of +<tt class="literal">num_style</tt> are:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">arabic</tt> - Arabic numerals</li> +<li><tt class="literal">roman</tt> - Lowercase Roman numerals</li> +<li><tt class="literal">Roman</tt> - Uppercase Roman numerals</li> +<li><tt class="literal">alph</tt> - Lowercase letters</li> +<li><tt class="literal">Alph</tt> - Uppercase +letters</li></ul></div> +<h5 class="title"><a id="cmd-pagestyle"></a>\pagestyle</h5> +<a id="id2531355" class="indexterm"></a> +<p><tt class="literal">\pagestyle{option}</tt></p> +<p>The <tt class="literal">\pagestyle</tt> command changes the +style from the current page on throughout the remainder of your +document.</p> +<p>The valid options are:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">plain</tt> - Just a plain page number.</li> +<li><tt class="literal">empty</tt> - Produces empty heads and feet +- no page numbers.</li> +<li><tt class="literal">headings</tt> - Puts running headings on +each page. The document style specifies what goes in the +headings.</li> +<li><tt class="literal">myheadings</tt> - You specify what is to go +in the heading with the <tt class="literal">\markboth</tt> or the +<tt class="literal">\markright</tt> commands.</li></ul></div> +<h5 class="title"><a id="cmd-markboth"></a>\markboth</h5> +<a id="id2531458" class="indexterm"></a> +<pre class="programlisting"> +\markboth{left head}{right head} +</pre> +<p>The <tt class="literal">\markboth</tt> command is used in +conjunction with the page style <tt class="literal">myheadings</tt> +for setting both the left and the right heading. You should note +that a <span class="emphasis"><em>left-hand heading</em></span> is +generated by the last <tt class="literal">\markboth</tt> command +before the end of the page, while a +<span class="emphasis"><em>right-hand heading</em></span> is +generated by the first <tt class="literal">\markboth</tt> or +<tt class="literal">\markright</tt> that comes on the page if there +is one, otherwise by the last one before the page.</p> +<h5 class="title"><a id="cmd-markright"></a>\markright</h5> +<a id="id2531527" class="indexterm"></a> +<pre class="programlisting"> +\markright{right head} +</pre> +<p>The <tt class="literal">\markright</tt> command is used in +conjunction with the page style <tt class="literal">myheadings</tt> +for setting the right heading, leaving the left heading unchanged. +You should note that a <span class="emphasis"><em>left-hand +heading</em></span> is generated by the last +<tt class="literal">\markboth</tt> command before the end of the +page, while a <span class="emphasis"><em>right-hand +heading</em></span> is generated by the first +<tt class="literal">\markboth</tt> or +<tt class="literal">\markright</tt> that comes on the page if there +is one, otherwise by the last one before the page.</p> +<h5 class="title"><a id="cmd-thispagestyle"></a>\thispagestyle</h5> +<a id="id2531597" class="indexterm"></a> +<p><tt class="literal">\thispagestyle{option}</tt></p> +<p>The <tt class="literal">\thispagestyle</tt> command works in the +same manner as the <tt class="literal">\pagestyle</tt> command +except that it changes the style for the current page +only.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="sectioning"></a>2.3.16 +Sectioning</h4></div></div></div> +<a id="id2531644" class="indexterm"></a><a id="id2531651" +class="indexterm"></a><a id="id2531658" +class="indexterm"></a><a id="id2531664" +class="indexterm"></a><a id="id2531671" +class="indexterm"></a><a id="id2531678" class="indexterm"></a> +<p>Sectioning commands provide the means to structure your text +into units.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li> +<a id="cmd-sectioning-part"></a><tt class="literal">\part</tt></li> +<li> +<a id="cmd-sectioning-chapter"></a><tt class="literal">\chapter</tt> +(report and book class only)</li> +<li> +<a id="cmd-sectioning-section"></a><tt class="literal">\section</tt></li> +<li> +<a id="cmd-sectioning-subsection"></a><tt class="literal">\subsection</tt></li> +<li> +<a id="cmd-sectioning-subsubsection"></a><tt class="literal">\subsubsection</tt></li> +<li> +<a id="cmd-sectioning-paragraph"></a><tt class="literal">\paragraph</tt></li> +<li> +<a id="cmd-sectioning-subparagraph"></a><tt class="literal">\subparagraph</tt></li></ul></div> +<p>All sectioning commands take the same general form, i.e.,</p> +<p><tt class="literal">\chapter[optional]{title}</tt></p> +<p>In addition to providing the heading in the text, the mandatory +argument of the sectioning command can appear in two other +places:</p> +<div class="orderedlist"> +<ol type="1"> +<li> +<p>The table of contents</p></li> +<li> +<p>The running head at the top of the page</p></li></ol></div> +<p>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 <tt class="literal">optional</tt> +argument that provides the text for these other two purposes.</p> +<p>All sectioning commands have <tt class="literal">*</tt>-forms +that print a <span class="emphasis"><em>title</em></span>, but do +not include a number and do not make an entry in the table of +contents.</p> +<a id="id2531863" class="indexterm"></a><a id="id2531870" +class="indexterm"></a> +<p> +<a id="cmd-sectioning-appendix"></a><tt class="literal">\appendix</tt></p> +<p>The <tt class="literal">\appendix</tt> command changes the way +sectional units are numbered. The +<tt class="literal">\appendix</tt> command generates no text and +does not affect the numbering of parts. The normal use of this +command is something like</p> +<pre class="programlisting"> +\chapter{The First Chapter} + ... +\appendix +\chapter{The First Appendix} +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="spaces-and-boxes"></a>2.3.17 Spaces & +Boxes</h4></div></div></div> +<a id="id2531930" class="indexterm"></a><a id="id2531937" +class="indexterm"></a> +<p>All the predefined length parameters See +<a href="#predefined-lengths-title">Predefined lengths</a> can be +used in the arguments of the box-making commands.</p> +<h5 class="title"><a id="cmd-dotfill"></a>\dotfill</h5> +<a id="id2531966" class="indexterm"></a> +<p>The <tt class="literal">\dotfill</tt> command produces a +<span class="emphasis"><em>rubber length</em></span> that produces +dots instead of just spaces.</p> +<h5 class="title"><a id="cmd-hfill"></a>\hfill</h5> +<a id="id2531997" class="indexterm"></a> +<p>The <tt class="literal">\hfill</tt> fill command produces a +<span class="emphasis"><em>rubber length</em></span> which can +stretch or shrink horizontally. It will be filled with spaces.</p> +<h5 class="title"><a id="cmd-hrulefill"></a>\hrulefill</h5> +<a id="id2532029" class="indexterm"></a> +<p>The <tt class="literal">\hrulefill</tt> fill command produces a +<span class="emphasis"><em>rubber length</em></span> which can +stretch or shrink horizontally. It will be filled with a horizontal +rule.</p> +<h5 class="title"><a id="cmd-hspace"></a>\hspace</h5> +<a id="id2532060" class="indexterm"></a> +<p><tt class="literal">\hspace{length}, \hspace*{length}</tt></p> +<p>The <tt class="literal">\hspace</tt> 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 <tt class="literal">\hspace</tt> +command. Adding negative space is like backspacing.</p> +<p>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 +<tt class="literal">*</tt> argument. Then the space is never +removed.</p> +<h5 class="title"><a id="cmd-addvspace"></a>\addvspace</h5> +<a id="id2532127" class="indexterm"></a><a id="id2532134" +class="indexterm"></a><a id="id2532141" class="indexterm"></a> +<p><tt class="literal">\addvspace{length}</tt></p> +<p>The <tt class="literal">\addvspace</tt> 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 +<tt class="literal">\addvspace</tt> command, then this command will +not add more space than needed to make the natural length of the +total vertical space equal to <tt class="literal">length</tt>.</p> +<h5 class="title"><a id="cmd-bigskip"></a>\bigskip</h5> +<a id="id2532192" class="indexterm"></a> +<p>The <tt class="literal">\bigskip</tt> command is equivalent to +<tt class="literal">\vspace{bigskipamount}</tt> where +<tt class="literal">bigskipamount</tt> is determined by the +document class.</p> +<h5 class="title"><a id="cmd-medskip"></a>\medskip</h5> +<a id="id2532231" class="indexterm"></a> +<p>The <tt class="literal">\medskip</tt> command is equivalent to +<tt class="literal">\vspace{medskipamount}</tt> where +<tt class="literal">medskipamount</tt> is determined by the +document class.</p> +<h5 class="title"><a id="cmd-smallskip"></a>\smallskip</h5> +<a id="id2532271" class="indexterm"></a> +<p><tt class="literal">\smallskip</tt></p> +<p>The <tt class="literal">\smallskip</tt> command is equivalent to +<tt class="literal">\vspace{smallskipamount}</tt> where +<tt class="literal">smallskipamount</tt> is determined by the +document class.</p> +<h5 class="title"><a id="cmd-vfill"></a>\vfill</h5> +<a id="id2532318" class="indexterm"></a> +<p>The <tt class="literal">\vfill</tt> fill command produces a +rubber length which can stretch or shrink vertically.</p> +<h5 class="title"><a id="cmd-vspace"></a>\vspace</h5> +<a id="id2532344" class="indexterm"></a> +<p><tt class="literal">\vspace{length}, \vspace*{length}</tt></p> +<p>The <tt class="literal">\vspace</tt> 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 <tt class="literal">\vspace</tt> +command.</p> +<p>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 +<tt class="literal">*</tt> argument. Then the space is never +removed.</p> +<h5 class="title"><a id="cmd-fbox"></a>\fbox</h5> +<a id="id2532410" class="indexterm"></a> +<p><tt class="literal">\fbox{text}</tt></p> +<p>The <tt class="literal">\fbox</tt> command is exactly the same +as the <tt class="literal">\mbox</tt> command, except that it puts +a frame around the outside of the box that it creates.</p> +<h5 class="title"><a id="cmd-framebox"></a>\framebox</h5> +<a id="id2532450" class="indexterm"></a> +<p><tt class="literal">\framebox[width][position]{text}</tt></p> +<p>The <tt class="literal">\framebox</tt> command is exactly the +same as the <tt class="literal">\makebox</tt> command, except that +it puts a frame around the outside of the box that it creates.</p> +<p>The framebox command produces a rule of thickness +<tt class="literal">\fboxrule</tt>, and leaves a space +<tt class="literal">\fboxsep</tt> between the rule and the contents +of the box.</p> +<h5 class="title"><a id="env-lrbox"></a>lrbox</h5> +<a id="id2532509" class="indexterm"></a> +<p><tt class="literal">\begin{lrbox}{cmd} text \end{lrbox}</tt></p> +<p>This is the environment form of +<tt class="literal">\sbox</tt>.</p> +<p>The text inside the environment is saved in the box +<tt class="literal">cmd</tt>, which must have been declared with +<tt class="literal">\newsavebox</tt>.</p> +<h5 class="title"><a id="cmd-makebox"></a>\makebox</h5> +<a id="id2532560" class="indexterm"></a> +<p><tt class="literal">\makebox[width][position]{text}</tt></p> +<p>The <tt class="literal">\makebox</tt> command creates a box just +wide enough to contain the <tt class="literal">text</tt> specified. +The width of the box is specified by the optional +<tt class="literal">width</tt> argument. The position of the text +within the box is determined by the optional +<tt class="literal">position</tt> argument.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">c</tt> --- centred (default)</li> +<li><tt class="literal">l</tt> --- flushleft</li> +<li><tt class="literal">r</tt> --- flushright</li> +<li><tt class="literal">s</tt> --- stretch from left to right +margin. The text must contain stretchable space for this to +work.</li></ul></div> +<p>See <a href="#cmd-makebox-op-picture-cp">\makebox +(picture)</a>.</p> +<h5 class="title"><a id="cmd-mbox"></a>\mbox</h5> +<a id="id2532676" class="indexterm"></a> +<p><tt class="literal">\mbox{text}</tt></p> +<p>The <tt class="literal">\mbox</tt> command creates a box just +wide enough to hold the text created by its argument.</p> +<p>Use this command to prevent text from being split across +lines.</p> +<h5 class="title"><a id="cmd-newsavebox"></a>\newsavebox</h5> +<a id="id2532716" class="indexterm"></a> +<p><tt class="literal">\newsavebox{cmd}</tt></p> +<p>Declares <tt class="literal">cmd</tt>, which must be a command +name that is not already defined, to be a bin for saving boxes.</p> +<h5 class="title"><a id="cmd-parbox"></a>\parbox</h5> +<a id="id2532751" class="indexterm"></a> +<p> +<tt class="literal">\parbox[position][height][inner-pos]{width}{text}</tt></p> +<p>A <tt class="literal">parbox</tt> is a box whose contents are +created in <tt class="literal">paragraph</tt> mode. The +<tt class="literal">\parbox</tt> has two mandatory arguments:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">width</tt> - specifies the width of the +parbox, and</li> +<li><tt class="literal">text</tt> - the text that goes inside the +parbox.</li></ul></div> +<p>LaTeX will position a <tt class="literal">parbox</tt> so its +centre lines up with the centre of the text line. The optional +<span class="emphasis"><em>position</em></span> argument allows you +to line up either the top or bottom line in the parbox (default is +top).</p> +<p>If the <span class="emphasis"><em>height</em></span> argument is +not given, the box will have the natural height of the text.</p> +<p>The <span class="emphasis"><em>inner-pos</em></span> argument +controls the placement of the text inside the box. If it is not +specified, <span class="emphasis"><em>position</em></span> is +used.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">t</tt> --- text is placed at the top of the +box.</li> +<li><tt class="literal">c</tt> --- text is centred in the box.</li> +<li><tt class="literal">b</tt> --- text is placed at the bottom of +the box.</li> +<li><tt class="literal">s</tt> --- stretch vertically. The text +must contain vertically stretchable space for this to +work.</li></ul></div> +<p>A <tt class="literal">\parbox</tt> 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 <tt class="literal">\parbox</tt> argument. +For larger pieces of text, including ones containing a +paragraph-making environment, you should use a +<tt class="literal">minipage</tt> environment See +<a href="#env-minipage">minipage</a>.</p> +<h5 class="title"><a id="cmd-raisebox"></a>\raisebox</h5> +<a id="id2532948" class="indexterm"></a> +<p> +<tt class="literal">\raisebox{distance}[extend-above][extend-below]{text}</tt></p> +<p>The <tt class="literal">\raisebox</tt> 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 <tt class="literal">LR mode</tt>.</p> +<p>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 <tt class="literal">\raisebox</tt> +command lets you tell LaTeX how tall it is.</p> +<p>The first optional argument, +<tt class="literal">extend-above</tt>, makes LaTeX think that the +text extends above the line by the amount specified. The second +optional argument, <tt class="literal">extend-below</tt>, makes +LaTeX think that the text extends below the line by the amount +specified.</p> +<h5 class="title"><a id="cmd-rule"></a>\rule</h5> +<a id="id2533042" class="indexterm"></a> +<p> +<tt class="literal">\rule[raise-height]{width}{thickness}</tt></p> +<p>The <tt class="literal">\rule</tt> command is used to produce +horizontal lines. The arguments are defined as follows:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">raise-height</tt> - specifies how high to +raise the rule (optional)</li> +<li><tt class="literal">width</tt> - specifies the length of the +rule (mandatory)</li> +<li><tt class="literal">thickness</tt> - specifies the thickness of +the rule (mandatory)</li></ul></div> +<h5 class="title"><a id="cmd-savebox"></a>\savebox</h5> +<a id="id2533117" class="indexterm"></a> +<p><tt class="literal">\savebox{cmd}[width][pos]{text}</tt></p> +<p>This command typeset <tt class="literal">text</tt> in a box just +as for <tt class="literal">\makebox</tt>. However, instead of +printing the resulting box, it saves it in bin +<tt class="literal">cmd</tt>, which must have been declared with +<tt class="literal">\newsavebox</tt>.</p> +<h5 class="title"><a id="cmd-sbox"></a>\sbox</h5> +<a id="id2533170" class="indexterm"></a> +<p><tt class="literal">\sbox{cmd}\{text}</tt></p> +<p>This commands typesets <tt class="literal">text</tt> in a box +just as for <tt class="literal">\mbox</tt>. However, instead of +printing the resulting box, it saves it in +<tt class="literal">cmd</tt>, which must have been declared with +<tt class="literal">\newsavebox</tt>.</p> +<h5 class="title"><a id="cmd-usebox"></a>\usebox</h5> +<a id="id2533223" class="indexterm"></a> +<p><tt class="literal">\usebox{cmd}</tt></p> +<p>Prints the box most recently saved in bin +<tt class="literal">cmd</tt> by a <tt class="literal">\savebox</tt> +command.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="special-characters"></a>2.3.18 Special +Characters</h4></div></div></div> +<a id="id2533269" class="indexterm"></a><a id="id2533276" +class="indexterm"></a><a id="id2533283" +class="indexterm"></a><a id="id2533290" class="indexterm"></a> +<p>The following characters play a special role in LaTeX and are +called <span class="emphasis"><em>special printing +characters</em></span>, or simply +<span class="emphasis"><em>special characters</em></span>.</p> +<pre class="programlisting"> +# $ % & ~ _ ^ \ { } +</pre> +<p>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 +<tt class="literal">\</tt> in front of the character. For example, +<tt class="literal">\$</tt> will produce <tt class="literal">$</tt> +in your output.</p> +<p>One exception to this rule is the <tt class="literal">\</tt> +itself because <tt class="literal">\\</tt> has its own special +meaning. A <tt class="literal">\</tt> is produced by typing +<tt class="literal">$\backslash$</tt> in your file.</p> +<p>Also, <tt class="literal">\~</tt> means `place a tilde accent +over the following letter', so you will probably want to use +<tt class="literal">\verb</tt> instead.</p> +<a id="id2533390" class="indexterm"></a><a id="id2533397" +class="indexterm"></a><a id="id2533404" class="indexterm"></a> +<p>In addition, you can access any character of a font once you +know its number by using the <tt class="literal">\symbol</tt> +command. For example, the character used for displaying spaces in +the <tt class="literal">\verb*</tt> command has the code decimal +32, so it can be typed as <tt class="literal">\symbol{32}</tt>.</p> +<p>You can also specify octal numbers with +<tt class="literal">'</tt> or hexadecimal numbers with +<tt class="literal">"</tt>, so the previous example could also be +written as <tt class="literal">\symbol{'40}</tt> or +<tt class="literal">\symbol{"20}</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="special-symbols"></a>2.3.19 Special +Symbols</h4></div></div></div> +<a id="id2533481" class="indexterm"></a> +<h5 class="title"><a id="accents-on-chars-title"></a>Accents on +Characters</h5> +<a id="id2533505" class="indexterm"></a> +<p>The rules differ somewhat depending whether you are in +<a href="#modes" title="2.3.14 Modes">text mode</a>, +<a href="#modes" title="2.3.14 Modes">math modes</a>, or the +<a href="#env-tabbing">tabbing environment</a>.</p> +<h5 class="title"><a id="id2533542"></a>Text Mode</h5> +<p>The following accents may be placed on letters. Although +<span class="emphasis"><em>o</em></span> is used in most of the +example, the accents may be placed on any letter. Accents may even +be placed above a <span class="emphasis"><em>missing</em></span> +letter; for example, <tt class="literal">\~{}</tt> produces a tilde +over a blank space.</p> +<p>The following commands may be used only in paragraph or LR +mode:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\`{o}</tt> produces a grave accent, +<span class="emphasis"><em>ò</em></span></li> +<li><tt class="literal">\'{o}</tt> produces an acute accent, +<span class="emphasis"><em>ó</em></span></li> +<li><tt class="literal">\^{o}</tt> produces a circumflex, +<span class="emphasis"><em>ô</em></span></li> +<li><tt class="literal">\"{o}</tt> produces an umlaut or dieresis, +<span class="emphasis"><em>ö</em></span></li> +<li><tt class="literal">\H{o}</tt> produces a long Hungarian +umlaut</li> +<li><tt class="literal">\~{o}</tt> produces a tilde, +<span class="emphasis"><em>õ</em></span></li> +<li><tt class="literal">\c{c}</tt> produces a cedilla, +<span class="emphasis"><em>ç</em></span></li> +<li><tt class="literal">\={o}</tt> produces a macron accent (a bar +over the letter)</li> +<li><tt class="literal">\b{o}</tt> produces a bar under the +letter</li> +<li><tt class="literal">\.{o}</tt> produces a dot over the +letter</li> +<li><tt class="literal">\d{o}</tt> produces a dot under the +letter</li> +<li><tt class="literal">\u{o}</tt> produces a breve over the +letter</li> +<li><tt class="literal">\v{o}</tt> produces a +<span class="emphasis"><em>v</em></span> over the letter</li> +<li><tt class="literal">\t{oo}</tt> produces a +<span class="emphasis"><em>tie</em></span> (inverted u) over the +two letters</li></ul></div> +<p>Note that the letters <span class="emphasis"><em>i</em></span> +and <span class="emphasis"><em>j</em></span> 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 +<tt class="literal">\i</tt> and <tt class="literal">\j</tt> can be +used to produce dotless letters.</p> +<p>For example,</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\^{\i}</tt> should be used for i, +circumflex, î</li> +<li><tt class="literal">\"{\i}</tt> should be used for i, umlaut, +ï</li></ul></div> +<h5 class="title"><a id="accents-chars-math"></a>Math Mode</h5> +<p>Several of the above and some similar accents can also be +produced in math mode. The following commands may be used +<span class="emphasis"><em>only</em></span> in math mode:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\hat{o}</tt> is similar to the circumflex +(cf. <tt class="literal">\^</tt>)</li> +<li><tt class="literal">\widehat{oo}</tt> is a wide version of +<span class="emphasis"><em>\hat</em></span> over several +letters</li> +<li><tt class="literal">\check{o}</tt> is a vee or check (cf. +<tt class="literal">\v</tt>)</li> +<li><tt class="literal">\tilde{o}</tt> is a tilde (cf. +<tt class="literal">\~</tt>)</li> +<li><tt class="literal">\widetilde{oo}</tt> is a wide version of +<tt class="literal">\tilde</tt> over several letters</li> +<li><tt class="literal">\acute{o}</tt> is an acute accent (cf. +<tt class="literal">\`</tt>)</li> +<li><tt class="literal">\grave{o}</tt> is a grave accent (cf. +<tt class="literal">>\'</tt>)</li> +<li><tt class="literal">\dot{o}</tt> is a dot over the letter (cf. +<tt class="literal">\.</tt>)</li> +<li><tt class="literal">\ddot{o}</tt> is a double dot over the +letter</li> +<li><tt class="literal">\breve{o}</tt> is a breve (cf. +<tt class="literal">\u</tt>)</li> +<li><tt class="literal">\bar{o}</tt> is a macron (cf. +<tt class="literal">\=</tt>)</li> +<li><tt class="literal">\vec{o}</tt> is a vector (arrow) over the +letter</li></ul></div> +<h5 class="title"><a id="accents-chars-tabbing"></a>Tabbing +Environment</h5> +<p>Some of the accent marks used in running text have other uses in +the <a href="#env-tabbing">Tabbing Environment</a>. In that case +they can be created with the following command:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">>\a'</tt> for an acute accent</li> +<li><tt class="literal">\a`</tt> for a grave accent</li> +<li><tt class="literal">\a=</tt> for a macron +accent</li></ul></div> +<h5 class="title"><a id="arrows-title"></a>Arrows</h5> +<a id="id2534131" class="indexterm"></a> +<p>LaTeX provides commands for all sorts of arrows. The following +commands are used only in math mode.</p> +<p>In general the command names are created from +<tt class="literal">left</tt>, <tt class="literal">right</tt>, +<tt class="literal">up</tt>, or <tt class="literal">down</tt>. +<tt class="literal">leftright</tt> gives a double headed arrow. +Prefacing with <tt class="literal">long</tt> gives a longer arrow. +Capitalizing the first letter gives a double-shanked arrow.</p> +<p>Examples are:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\leftarrow</tt></li> +<li><tt class="literal">\Leftarrow</tt></li> +<li><tt class="literal">\longleftarrow</tt></li> +<li><tt class="literal">\Longleftarrow</tt></li> +<li><tt class="literal">\rightarrow</tt></li> +<li><tt class="literal">\Rightarrow</tt></li> +<li><tt class="literal">\longrightarrow</tt></li> +<li><tt class="literal">\Longrightarrow</tt></li> +<li><tt class="literal">\leftrightarrow</tt></li> +<li><tt class="literal">\Leftrightarrow</tt></li> +<li><tt class="literal">\longleftrightarrow</tt></li> +<li><tt class="literal">\uparrow</tt></li> +<li><tt class="literal">\downarrow</tt></li> +<li><tt class="literal">\Uparrow</tt></li> +<li><tt class="literal">>\nearrow</tt> points from southwest to +northeast</li> +<li><tt class="literal">\searrow</tt> points from northwest to +southeast</li> +<li><tt class="literal">\swarrow</tt> points from northeast to +southwest</li> +<li><tt class="literal">\nwarrow</tt> points from southeast to +northwest</li></ul></div> +<p>The <tt class="literal">\stackrel</tt> command is useful for +putting things over or under your arrow.</p> +<p>See also:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><a href="#math-symbols-title">Math Symbols</a></li> +<li><a href="#binary-and-relational-ops-title">Binary and +Relational Operators</a></li> +<li><a href="#greek-letters-title">Greek Letters</a></li> +<li><a href="#misc-symbols-title">Miscellaneous Symbols</a></li> +<li><a href="#variable-math-size-symbols-title">Variable Size Math +Symbols</a></li></ul></div> +<h5 class="title"> +<a id="binary-and-relational-ops-title"></a>Binary and Relational +Operators</h5> +<a id="id2534488" class="indexterm"></a><a id="id2534497" +class="indexterm"></a><a id="id2534507" +class="indexterm"></a><a id="id2534519" class="indexterm"></a> +<p>Some <span class="emphasis"><em>math</em></span> symbols are +obtained by typing the corresponding keyboard character. Examples +include</p> +<pre class="programlisting"> ++ - = < > +</pre> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>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).</p></div> +<p>The following commands may be used only in math mode:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\pm</tt> plus or minus sign</li> +<li><tt class="literal">\mp</tt> minus or plus sign</li> +<li><tt class="literal">\times</tt> times (an "x")</li> +<li><tt class="literal">\div</tt> divided by sign</li> +<li><tt class="literal">\ast</tt> an asterisk (centered)</li> +<li><tt class="literal">\star</tt> a five-point star +(centered)</li> +<li><tt class="literal">\bullet</tt> a bullet</li> +<li><tt class="literal">\circ</tt> an open bullet</li> +<li><tt class="literal">\cdot</tt> a centered dot</li> +<li><tt class="literal">\leq</tt> less than or equal to</li> +<li><tt class="literal">\ll</tt> much less than</li> +<li><tt class="literal">\subset</tt> is a subset of</li> +<li><tt class="literal">\geq</tt> greater than or equal to</li> +<li><tt class="literal">\gg</tt> much greater than</li> +<li><tt class="literal">\equiv</tt> equivalence symbol</li> +<li><tt class="literal">\sim</tt> similar to</li> +<li><tt class="literal">\simeq</tt> similar or equal to</li> +<li><tt class="literal">\approx</tt> approximately equal to</li> +<li><tt class="literal">\neq</tt> not equal to</li> +<li><tt class="literal">\per</tt> "perpendicular to" symbols</li> +<li><tt class="literal">\propto</tt> proportional +to</li></ul></div> +<p>Note that <span class="emphasis"><em>greater than</em></span> +and <span class="emphasis"><em>less than</em></span> are obtained +simply by entering <tt class="literal">></tt> and +<tt class="literal"><</tt>.</p> +<p>A slash, indicating <span class="emphasis"><em>not</em></span> +can be placed through a symbol (or a letter) with the +<tt class="literal">\not</tt> command. For example, not less than +is <tt class="literal">\not<</tt> and not less than or equal to +is <tt class="literal">\not\leq</tt>. If the slash isn't properly +positioned it can be moved by putting a math mode spacing command +between the <tt class="literal">\not</tt>and the symbol.</p> +<h5 class="title"><a id="delimiters-title"></a>Delimiters</h5> +<a id="id2534883" class="indexterm"></a> +<p>Delimiters are objects which act logically like parentheses. +These can be used only in math mode.</p> +<p>The delimiters recognized by LaTeX include:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">(</tt> (left parenthesis)</li> +<li><tt class="literal">)</tt> (right parenthesis)</li> +<li><tt class="literal">[</tt> (left bracket)</li> +<li><tt class="literal">]</tt> (right bracket)</li> +<li><tt class="literal">\{</tt> (left brace)</li> +<li><tt class="literal">\}</tt> (right brace)</li> +<li><tt class="literal">|</tt> (vertical line)</li> +<li><tt class="literal">\vert</tt> (vertical line)</li> +<li><tt class="literal">\|</tt> (double vertical lines)</li> +<li><tt class="literal">\Vert</tt> (double vertical lines)</li> +<li><tt class="literal">/</tt> (slash)</li> +<li><tt class="literal">\backslash</tt> (backslash)</li> +<li><tt class="literal">\langle</tt> (left angle bracket)</li> +<li><tt class="literal">\rangle</tt> (right angle bracket)</li> +<li><tt class="literal">\uparrow</tt> (uparrow)</li> +<li><tt class="literal">\downarrow</tt> (down arrow)</li> +<li><tt class="literal">\updownarrow</tt> (up/down +arrow)</li></ul></div> +<h5 class="title"><a id="id2535106"></a>Making Delimiters the Right +Size</h5> +<p>Delimiters in formulas should be big enough to +<span class="emphasis"><em>fit</em></span> around the formulas they +delimit (for example arround arrays). To obtain +<span class="emphasis"><em>stretchable</em></span> delimiters +(LaTeX makes them the appropriate size) type a +<tt class="literal">\left</tt> or <tt class="literal">\right</tt> +command before the delimiter. <tt class="literal">\left</tt> and +<tt class="literal">\right</tt> commands must come in matching +pairs, although the delimiters themselves need not be the same. +Thus, <tt class="literal">\left \{ ... \right \[</tt> produces a +legal pair. In cases where only one delimiter is desired, it is +possible to make the matching delimiter +<span class="emphasis"><em>invisible</em></span> by typing a period +(<tt class="literal">.</tt>) after the command, i.e., +<tt class="literal">\left.</tt> or +<tt class="literal">\right.</tt></p> +<p>In an <a href="#env-eqnarray">eqnarray</a> environment the +matching <tt class="literal">\left</tt> and +<tt class="literal">\right</tt> cannot be split between lines and +it may be necessary to use an +<span class="emphasis"><em>invisible</em></span> +<tt class="literal">\right.</tt> and +<tt class="literal">\left.</tt> 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 +<span class="emphasis"><em>local part</em></span>, so that the size +of the <span class="emphasis"><em>visible</em></span> +<span class="emphasis"><em>left</em></span> and +<span class="emphasis"><em>right</em></span> 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 <tt class="literal">\rule</tt>. It can also be +accomplished with the <tt class="literal">\vphantom</tt> command, +which I have not found documented, but which appears to work.</p> +<p><tt class="literal">\vphantom{construct}</tt> creates a +zero-width object with the height of +<tt class="literal">construct</tt>. The argument can contain things +such as <tt class="literal">\frac</tt> or the +<span class="emphasis"><em>variable size math symbols</em></span> +and should be chosen according to what is in the section with the +delimiter you want to match.</p> +<h5 class="title"><a id="id2535294"></a>Some Examples</h5> +<h5 class="title"><a id="id2535300"></a>A six-j symbol</h5> +<pre class="programlisting"> +\[ \left\{ +\begin{array}{ccc} +a & b & c \\ +d & e & f \end{array} +\right>\} \] +</pre> +<p>This should be displayed something like (insofar as it can be +rendered in "ascii art"):</p> +<pre class="programlisting"> +( a b c ) +- - +( d e f ) +</pre> +<p>Note that the <tt class="literal">\[ ... \]</tt> set this off as +<span class="emphasis"><em>Display Math</em></span>, and that the +<span class="emphasis"><em>Array Environment</em></span> is used to +generate the three centered columns inside the braces.</p> +<h5 class="title"><a id="id2535342"></a>A "multiple choice" +equation</h5> +<pre class="programlisting"> +\[ f(x) = + \left\{ \begin{array}{l} + 0, x < 0 \\ 1, x = 0 \\ + 2, x > 0 \end{array} \right. \] +</pre> +<p>will be displayed as</p> +<pre class="programlisting"> + ( 0, x < 0 +f(x) = - 1, x = 0 + ( 2, x > 0 +</pre> +<p>Note that the <span class="emphasis"><em>invisible</em></span> +<tt class="literal">\right</tt> delimiter is specified using a +<span class="emphasis"><em>period</em></span>.</p> +<h5 class="title"><a id="ellipsis-title"></a>Ellipsis</h5> +<a id="id2535395" class="indexterm"></a> +<p>Ellipses (three dots) can be produced by the following +commands</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\ldots</tt> horizontally at bottom of +line</li> +<li><tt class="literal">\cdots</tt> horizontally center of line +(math mode only)</li> +<li><tt class="literal">\ddots</tt> diagonal (math mode only)</li> +<li><tt class="literal">\vdots</tt> vertical (math mode +only)</li></ul></div> +<h5 class="title"><a id="greek-letters-title"></a>Greek +Letters</h5> +<a id="id2535471" class="indexterm"></a> +<p>These commands may be used only in math mode:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\alpha</tt></li> +<li><tt class="literal">\beta</tt></li> +<li><tt class="literal">\gamma</tt></li> +<li><tt class="literal">\delta</tt></li> +<li><tt class="literal">\epsilon</tt></li> +<li><tt class="literal">\varepsilon</tt> (variation, +script-like)</li> +<li><tt class="literal">\zeta</tt></li> +<li><tt class="literal">\eta</tt></li> +<li><tt class="literal">\theta</tt></li> +<li><tt class="literal">\vartheta</tt> (variation, +script-like)</li> +<li><tt class="literal">\iota</tt></li> +<li><tt class="literal">\kappa</tt></li> +<li><tt class="literal">\lambda</tt></li> +<li><tt class="literal">\mu</tt></li> +<li><tt class="literal">\nu</tt></li> +<li><tt class="literal">\xi</tt></li> +<li><tt class="literal">\pi</tt></li> +<li><tt class="literal">\varpi</tt> (variation)</li> +<li><tt class="literal">\rho</tt></li> +<li><tt class="literal">\varrho</tt> (variation, with the +tail)</li> +<li><tt class="literal">\sigma</tt></li> +<li><tt class="literal">\varsigma</tt> (variation, +script-like)</li> +<li><tt class="literal">\tau</tt></li> +<li><tt class="literal">\upsilon</tt></li> +<li><tt class="literal">\phi</tt></li> +<li><tt class="literal">\varphi</tt> (variation, script-like)</li> +<li><tt class="literal">\chi</tt></li> +<li><tt class="literal">\psi</tt></li> +<li><tt class="literal">\omega</tt></li></ul></div> +<p>Capital letters:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">\Gamma</tt></li> +<li><tt class="literal">\Delta</tt></li> +<li><tt class="literal">\Theta</tt></li> +<li><tt class="literal">\Lambda</tt></li> +<li><tt class="literal">\Xi</tt></li> +<li><tt class="literal">\Pi</tt></li> +<li><tt class="literal">\Sigma</tt></li> +<li><tt class="literal">\Upsilon</tt></li> +<li><tt class="literal">\Phi</tt></li> +<li><tt class="literal">\Psi</tt></li> +<li><tt class="literal">\Omega</tt></li></ul></div> +<p>See also:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><a href="#math-symbols-title">Math Symbols</a></li> +<li><a href="#accents-on-chars-title">Accents</a></li> +<li><a href="#misc-symbols-title">Miscellaneous +Symbols</a></li></ul></div> +<h5 class="title"><a id="misc-symbols-title"></a>Miscellaneous +Symbols</h5> +<a id="id2535966" class="indexterm"></a> +<h5 class="title"><a id="id2535978"></a>Some symbols for math</h5> +<p>The following symbols are also used only in math mode</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li> +<a id="cmd-misc-symbol-aleph"></a><tt class="literal">\aleph</tt> +Hebrew aleph</li> +<li><a id="cmd-misc-symbol-hbar"></a><tt class="literal">\hbar</tt> +h-bar, Planck's constant</li> +<li> +<a id="cmd-misc-symbol-imath"></a><tt class="literal">\imath</tt> +variation on <span class="emphasis"><em>i</em></span>; no dot</li> +<li> +<a id="cmd-misc-symbol-jmath"></a><tt class="literal">\jmath</tt> +variation on <span class="emphasis"><em>j</em></span>; no dot</li> +<li><a id="cmd-misc-symbol-ell"></a><tt class="literal">\ell</tt> +script (loop) <span class="emphasis"><em>l</em></span></li> +<li><a id="cmd-misc-symbol-wp"></a><tt class="literal">\wp</tt> +fancy script lowercase +<span class="emphasis"><em>P</em></span></li> +<li><a id="cmd-misc-symbol-re"></a><tt class="literal">\Re</tt> +script capital <span class="emphasis"><em>R</em></span> +(<span class="emphasis"><em>Real</em></span>)</li> +<li><a id="cmd-misc-symbol-im"></a><tt class="literal">\Im</tt> +script capital <span class="emphasis"><em>I</em></span> +(<span class="emphasis"><em>Imaginary</em></span>)</li> +<li> +<a id="cmd-misc-symbol-prime"></a><tt class="literal">\prime</tt> +prime (also obtained by typing <tt class="literal">'</tt>)</li> +<li> +<a id="cmd-misc-symbol-nabla"></a><tt class="literal">\nabla</tt> +inverted capital Delta</li> +<li><a id="cmd-misc-symbol-surd"></a><tt class="literal">\surd</tt> +radical (square root) symbol</li> +<li> +<a id="cmd-misc-symbol-angle"></a><tt class="literal">\angle</tt> +angle symbol</li> +<li> +<a id="cmd-misc-symbol-forall"></a><tt class="literal">\forall</tt> +<span class="emphasis"><em>for all</em></span> (inverted A)</li> +<li> +<a id="cmd-misc-symbol-exists"></a><tt class="literal">\exists</tt> +<span class="emphasis"><em>exists</em></span> (left-facing E)</li> +<li> +<a id="cmd-misc-symbol-partial"></a><tt class="literal">\partial</tt> +partial derivative symbol</li> +<li> +<a id="cmd-misc-symbol-infty"></a><tt class="literal">\infty</tt> +infinity symbol</li> +<li> +<a id="cmd-misc-symbol-triangle"></a><tt class="literal">\triangle</tt> +open triangle symbol</li> +<li><a id="cmd-misc-symbol-box"></a><tt class="literal">\Box</tt> +open square</li> +<li> +<a id="cmd-misc-symbol-diamond"></a><tt class="literal">\Diamond</tt> +open diamond</li> +<li><a id="cmd-misc-symbol-flat"></a><tt class="literal">\flat</tt> +music: flat symbol</li> +<li> +<a id="cmd-misc-symbol-natural"></a><tt class="literal">\natural</tt> +music: natural symbol</li> +<li> +<a id="cmd-misc-symbol-clubsuit"></a><tt class="literal">\clubsuit</tt> +playing cards: club suit symbol</li> +<li> +<a id="cmd-misc-symbol-diamondsuit"></a><tt class="literal">\diamondsuit</tt> +playing cards: diamond suit symbol</li> +<li> +<a id="cmd-misc-symbol-heartsuit"></a><tt class="literal">\heartsuit</tt> +playing cards: heart suit symbol</li> +<li> +<a id="cmd-misc-symbol-spadsuit"></a><tt class="literal">\spadesuit</tt> +playing cards: space suit symbol</li></ul></div> +<h5 class="title"><a id="id2536435"></a>Some Other Symbols</h5> +<p>The following symbols can be used in any mode:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><a id="cmd-other-symbol-dag"></a><tt class="literal">\dag</tt> +dagger</li> +<li> +<a id="cmd-other-symbol-ddag"></a>><tt class="literal">\ddag</tt> +double dagger</li> +<li><a id="cmd-other-symbol-s"></a>><tt class="literal">\S</tt> +section symbol</li> +<li><a id="cmd-other-symbol-p"></a>><tt class="literal">\P</tt> +paragraph symbol</li> +<li> +<a id="cmd-other-symbol-copyright"></a>><tt class="literal">\copyright</tt> +copyright symbol</li> +<li> +<a id="cmd-other-symbol-pounds"></a>><tt class="literal">\pounds</tt> +British pound sterling symbol</li></ul></div> +<h5 class="title"><a id="id2536553"></a>Calligraphic Style +Letters</h5> +<p>Twenty-six calligraphic letters are provided (the upper case +alphabet). These can only be used in math mode.</p> +<p>In LaTeX 2.09 they are produced with the +<tt class="literal">\cal</tt> declaration:</p> +<pre class="programlisting"> +${\cal A}$ +</pre> +<p>In LaTeX2e they are obtained with the +<tt class="literal">\mathcal</tt> command:</p> +<pre class="programlisting"> +$\mathcal{CAL}$ +</pre> +<h5 class="title"><a id="math-functions-title"></a>Math +Functions</h5> +<a id="id2536611" class="indexterm"></a> +<p>Functions like <span class="emphasis"><em>log</em></span> or +<span class="emphasis"><em>cos</em></span> 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.</p> +<p>Some of these commands are:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li> +<a id="cmd-math-func-arccos"></a><tt class="literal">\arccos</tt></li> +<li> +<a id="cmd-math-func-arcsin"></a><tt class="literal">\arcsin</tt></li> +<li> +<a id="cmd-math-func-arctan"></a><tt class="literal">\arctan</tt></li> +<li> +<a id="cmd-math-func-cos"></a><tt class="literal">\cos</tt></li> +<li> +<a id="cmd-math-func-cosh"></a><tt class="literal">\cosh</tt></li> +<li> +<a id="cmd-math-func-cot"></a><tt class="literal">\cot</tt></li> +<li> +<a id="cmd-math-func-coth"></a><tt class="literal">\coth</tt></li> +<li> +<a id="cmd-math-func-csc"></a><tt class="literal">\csc</tt></li> +<li> +<a id="cmd-math-func-deg"></a><tt class="literal">\deg</tt></li> +<li> +<a id="cmd-math-func-det"></a><tt class="literal">\det</tt></li> +<li> +<a id="cmd-math-func-dim"></a><tt class="literal">\dim</tt></li> +<li> +<a id="cmd-math-func-exp"></a><tt class="literal">\exp</tt></li> +<li> +<a id="cmd-math-func-gcd"></a><tt class="literal">\gcd</tt></li> +<li> +<a id="cmd-math-func-hom"></a><tt class="literal">\hom</tt></li> +<li> +<a id="cmd-math-func-inf"></a><tt class="literal">\inf</tt></li> +<li> +<a id="cmd-math-func-ker"></a><tt class="literal">\ker</tt></li> +<li><a id="cmd-math-func-lg"></a><tt class="literal">\lg</tt></li> +<li> +<a id="cmd-math-func-lim"></a><tt class="literal">\lim</tt></li> +<li> +<a id="cmd-math-func-liminf"></a><tt class="literal">\liminf</tt></li> +<li> +<a id="cmd-math-func-limsup"></a><tt class="literal">\limsup</tt></li> +<li><a id="cmd-math-func-ln"></a><tt class="literal">\ln</tt></li> +<li> +<a id="cmd-math-func-log"></a><tt class="literal">\log</tt></li> +<li> +<a id="cmd-math-func-max"></a><tt class="literal">\max</tt></li> +<li> +<a id="cmd-math-func-min"></a><tt class="literal">\min</tt></li> +<li> +<a id="cmd-math-func-sec"></a><tt class="literal">\sec</tt></li> +<li> +<a id="cmd-math-func-sin"></a><tt class="literal">\sin</tt></li> +<li> +<a id="cmd-math-func-sinh"></a><tt class="literal">\sinh</tt></li> +<li> +<a id="cmd-math-func-sup"></a><tt class="literal">\sup</tt></li> +<li> +<a id="cmd-math-func-tan"></a><tt class="literal">\tan</tt></li> +<li> +<a id="cmd-math-func-tanh"></a><tt class="literal">\tanh</tt></li></ul></div> +<p>Two commands are provided for the "modulus" function</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li> +<a id="cmd-math-func-bmod"></a><tt class="literal">\bmod</tt></li> +<li> +<a id="cmd-math-func-pmod"></a><tt class="literal">\pmod{}</tt></li></ul></div> +<p>The former would be used to write "a mod b" as +<tt class="literal">a \bmod b</tt> and the latter, which requires +an argument that is displayed in parentheses, would be used to +write "n = i (mod j)" as <tt class="literal">n = i +\pmod{j}</tt></p> +<h5 class="title"> +<a id="variable-math-size-symbols-title"></a>Variable Size Math +Symbols</h5> +<a id="id2537138" class="indexterm"></a> +<p>The size of some mathematical symbols, notably summation signs, +product signs, and integral signs, depends on the environment in +which they appear (i.e., <tt class="literal">displaymath</tt> as +opposed to <tt class="literal">math</tt> environments.</p> +<p>These include:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><a id="cmd-math-symbol-sum"></a><tt class="literal">\sum</tt> a +summation sign (capital sigma)</li> +<li><a id="cmd-math-symbol-prod"></a><tt class="literal">\prod</tt> +a product (capital pi)</li> +<li> +<a id="cmd-math-symbol-coprod"></a><tt class="literal">\coprod</tt> +a coproduct (inverted capital pi)</li> +<li><a id="cmd-math-symbol-int"></a><tt class="literal">\int</tt> +an integral sign</li> +<li><a id="cmd-math-symbol-oint"></a><tt class="literal">\oint</tt> +a surface (circular) integral sign</li> +<li> +<a id="cmd-math-symbol-bigcup"></a><tt class="literal">\bigcup</tt> +big "U"</li> +<li> +<a id="cmd-math-symbol-bigcap"></a><tt class="literal">\bigcap</tt> +big inverted "U"</li> +<li> +<a id="cmd-math-symbol-bigvee"></a><tt class="literal">\bigvee</tt> +big "V"</li> +<li> +<a id="cmd-math-symbol-bigwedge"></a><tt class="literal">\bigwedge</tt> +big inverted "V"</li> +<li> +<a id="cmd-math-symbol-bigodot"></a><tt class="literal">\bigodot</tt> +big "O" with dot at center</li> +<li> +<a id="cmd-math-symbol-bigotimes"></a><tt class="literal">\bigotimes</tt> +big "O" with cross inside</li> +<li> +<a id="cmd-math-symbol-bigoplus"></a><tt class="literal">\bigoplus</tt> +big "O" with a + inside</li> +<li> +<a id="cmd-math-symbol-biguplus"></a><tt class="literal">\biguplus</tt> +big "U" with a + inside</li></ul></div> +<p>The <tt class="literal">\sqrt</tt> command also produces a +variable size symbol appropriate for the size of hte radicand +argument.</p> +<p>The "limits" associated with these symbols are entered as +<span class="emphasis"><em>subscripts</em></span> for entries +appearing below the symbol and as +<span class="emphasis"><em>superscripts</em></span> for entries +appearing above the symbol. For example the sum from n=0 to +infinity of x<sup>n</sup> would be entered as</p> +<pre class="programlisting"> +\sum_{n=0}^{\infty} x_{n} +</pre> +<p>The actual placement of the limits depends on whether this is in +<tt class="literal">displaymath</tt> mode in which case they are +placed below/above or in +<span class="emphasis"><em>math</em></span> mode in running text in +which case they are placed as regular subscripts and +superscripts.</p> +<p>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 +<tt class="literal">\mathop</tt> command.</p> +<p><span class="emphasis"><em>Hats</em></span> and +<span class="emphasis"><em>tildes</em></span> over symbols which +stretch (as best they can) to the correct size for their arguments +are produced by <tt class="literal">\widehat</tt> and +<tt class="literal">\widetilde</tt></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="splitting-the-input"></a>2.3.20 Splitting +the Input</h4></div></div></div> +<a id="id2537484" class="indexterm"></a><a id="id2537491" +class="indexterm"></a> +<p>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.</p> +<h5 class="title"><a id="cmd-include-title"></a>\include</h5> +<a id="id2537521" class="indexterm"></a> +<p><tt class="literal">\include{file}</tt></p> +<p>The <tt class="literal">\include</tt> command is used in +conjunction with the <tt class="literal">\includeonly</tt> command +for selective inclusion of files. The <tt class="literal">file</tt> +argument is the first name of a file, denoting +<tt class="filename">file.tex</tt>. If +<tt class="literal">file</tt> is one the file names in the file +list of the <tt class="literal">\includeonly</tt> command or if +there is no <tt class="literal">\includeonly</tt> command, the +<tt class="literal">\include</tt> command is equivalent to</p> +<pre class="programlisting"> +\clearpage \input{file} \clearpage +</pre> +<p>except that if the file <tt class="filename">file.tex</tt> does +not exist, then a warning message rather than an error is produced. +If the file is not in the file list, the +<tt class="literal">\include</tt> command is equivalent to +<tt class="literal">\clearpage</tt>.</p> +<p>The <tt class="literal">\include</tt> command may not appear in +the preamble or in a file read by another +<tt class="literal">\include</tt> command.</p> +<h5 class="title"> +<a id="cmd-includeonly-title"></a>\includeonly</h5> +<a id="id2537650" class="indexterm"></a> +<p> +<tt class="literal">\includeonly{</tt><span class="emphasis"><em>file_list</em></span><tt class="literal"> +}</tt></p> +<p>The <tt class="literal">\includeonly</tt> command controls which +files will be read in by an <tt class="literal">\include</tt> +command. <span class="emphasis"><em>file_list</em></span> should be +a comma-separated list of filenames. Each filename must match +exactly a filename specified in a <tt class="literal">\include</tt> +command. This command can only appear in the preamble.</p> +<h5 class="title"><a id="cmd-input-title"></a>\input</h5> +<a id="id2537710" class="indexterm"></a> +<p><tt class="literal">\input{file}</tt></p> +<p>The <tt class="literal">\input</tt> command causes the indicated +<tt class="literal">file</tt> 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 +<tt class="filename">file.tex</tt> is used.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="starting-and-ending"></a>2.3.21 Starting +& Ending</h4></div></div></div> +<a id="id2537767" class="indexterm"></a><a id="id2537774" +class="indexterm"></a> +<p>Your input file must contain the following commands as a +minimum:</p> +<pre class="programlisting"> +\documentclass{class} +\begin{document} + ... your text goes here ... +\end{document} +</pre> +<p>where the <tt class="literal">class</tt> selected is one of the +valid classes for LaTeX. See <a href="#document-classes" +title="2.3.4 Document Classes">Document Classes</a> (and see +<a href="#overview" +title="2.2 Overview of LaTeX and Local Guide ">Overview</a>), for +details of the various document classes available locally.</p> +<p>You may include other LaTeX commands between the +<tt class="literal">\documentclass</tt> and the +<tt class="literal">\begin{document}</tt> commands (i.e., in the +`preamble').</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="table-of-contents"></a>2.3.22 Table of +Contents</h4></div></div></div> +<a id="id2537859" class="indexterm"></a> +<p>A table of contents is produced with the +<tt class="literal">\tableofcontents</tt> <a id="id2537874" +class="indexterm"></a> 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 +<tt class="literal">\newpage</tt> command after the +<tt class="literal">\tableofcontents</tt> command.</p> +<p>There are similar commands +<tt class="literal">\listoffigures</tt> <a id="id2537912" +class="indexterm"></a> and <tt class="literal">\listoftables</tt> +<a id="id2537925" class="indexterm"></a> for producing a list of +figures and a list of tables, respectively. Everything works +exactly the same as for the table of contents.</p> +<p>NOTE: If you want any of these items to be generated, you cannot +have the <tt class="literal">\nofiles</tt> <a id="id2537945" +class="indexterm"></a> command in your document.</p> +<h5 class="title"> +<a id="cmd-addcontentsline-title"></a>\addcontentsline</h5> +<a id="id2537964" class="indexterm"></a> +<p> +<tt class="literal">\addcontentsline{file}{sec_unit}{entry}</tt></p> +<p>The <tt class="literal">\addcontentsline</tt> command adds an +entry to the specified list or table where:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">file</tt> is the extension of the file on +which information is to be written: <tt class="literal">toc</tt> +(table of contents), <tt class="literal">lof</tt> (list of +figures), or <tt class="literal">lot</tt> (list of tables).</li> +<li> +<p><tt class="literal">sec_unit</tt> controls the formatting of the +entry. It should be one of the following, depending upon the value +of the file argument:</p> +<div class="orderedlist"> +<ol type="1"> +<li><tt class="literal">toc</tt> --- the name of the sectional +unit, such as part or subsection.</li> +<li><tt class="literal">lof</tt> --- figure</li> +<li><tt class="literal">lot</tt> --- table</li></ol></div></li> +<li><tt class="literal">entry</tt> is the text of the +entry.</li></ul></div> +<h5 class="title"> +<a id="cmd-addtocontents-title"></a>\addtocontents</h5> +<a id="id2538097" class="indexterm"></a> +<p><tt class="literal">\addtocontents{file}{text}</tt></p> +<p>The <tt class="literal">\addtocontents</tt> command adds text +(or formatting commands) directly to the file that generates the +table of contents or list of figures or tables.</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">file</tt> is the extension of the file on +which information is to be written: <tt class="literal">toc</tt> +(table of contents), <tt class="literal">lof</tt> (list of +figures), or <tt class="literal">lot</tt> (list of tables).</li> +<li><tt class="literal">text</tt> is the information to be +written.</li></ul></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="terminal-input-slash-output"></a>2.3.23 +Terminal Input/Output</h4></div></div></div> +<a id="id2538186" class="indexterm"></a><a id="id2538193" +class="indexterm"></a> +<h5 class="title"><a id="cmd-typein-title"></a>\typein</h5> +<a id="id2538211" class="indexterm"></a> +<p><tt class="literal">\typein[cmd]{msg}</tt></p> +<p>Prints <tt class="literal">msg</tt> on the terminal and causes +LaTeX to stop and wait for you to type a line of input, ending with +return. If the <tt class="literal">cmd</tt> argument is missing, +the typed input is processed as if it had been included in the +input file in place of the <tt class="literal">\typein</tt> +command. If the <tt class="literal">cmd</tt> argument is present, +it must be a command name. This command name is then defined or +redefined to be the typed input.</p> +<h5 class="title"><a id="cmd-typeout-title"></a>\typeout</h5> +<a id="id2538271" class="indexterm"></a> +<p><tt class="literal">\typeout{msg}</tt></p> +<p>Prints <tt class="literal">msg</tt> on the terminal and in the +<tt class="literal">log</tt> file. Commands in +<tt class="literal">msg</tt> that are defined with +<tt class="literal">\newcommand</tt> or +<tt class="literal">\renewcommand</tt> are replaced by their +definitions before being printed.</p> +<p>LaTeX's usual rules for treating multiple spaces as a single +space and ignoring spaces after a command name apply to +<tt class="literal">msg</tt>. A <tt class="literal">\space</tt> +command in <tt class="literal">msg</tt> causes a single space to be +printed. A <tt class="literal">^^J</tt> in +<tt class="literal">msg</tt> prints a newline.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="typefaces"></a>2.3.24 +Typefaces</h4></div></div></div> +<a id="id2538374" class="indexterm"></a><a id="id2538381" +class="indexterm"></a> +<p>The <tt class="literal">typeface</tt> is specified by giving the +<span class="emphasis"><em>size</em></span> and +<span class="emphasis"><em>style</em></span>. A typeface is also +called a <span class="emphasis"><em>font</em></span>.</p> +<h5 class="title"><a id="styles-title"></a>\Styles</h5> +<a id="id2538418" class="indexterm"></a><a id="id2538425" +class="indexterm"></a><a id="id2538432" class="indexterm"></a> +<p>The following type style commands are supported by LaTeX.</p> +<p>These commands are used like <tt class="literal">\textit{italics +text}</tt>. The corresponding command in parenthesis is the +<span class="emphasis"><em>declaration form</em></span>, which +takes no arguments. The scope of the declaration form lasts until +the next type style command or the end of the current group.</p> +<p>The declaration forms are cumulative; i.e., you can say +<tt class="literal">\sffamily\bfseries</tt> to get sans serif +boldface.</p> +<p>You can also use the environment form of the declaration forms; +e.g. +<tt class="literal">\begin{ttfamily}...\end{ttfamily}</tt>.</p> +<div class="table"><a id="id2538486"></a> +<p class="title"><b>Table 1.9. Typefaces</b></p> +<table summary="Typefaces" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">\textrm (\rmfamily) <a id="id2538519" +class="indexterm"></a> <a id="id2538526" +class="indexterm"></a></td> +<td align="justify">Roman.</td></tr> +<tr> +<td align="left">\textit (\itshape) <a id="id2538544" +class="indexterm"></a> <a id="id2538551" class="indexterm"></a>, +\emph <a id="id2538558" class="indexterm"></a></td> +<td align="justify">Emphasis (toggles between \textit and +\textrm).</td></tr> +<tr> +<td align="left">\textmd (\mdseries) <a id="id2538577" +class="indexterm"></a> <a id="id2538584" +class="indexterm"></a></td> +<td align="justify">Medium weight (default). The opposite of +boldface.</td></tr> +<tr> +<td align="left">\textbf (\bfseries) <a id="id2538603" +class="indexterm"></a> <a id="id2538610" +class="indexterm"></a></td> +<td align="justify">Boldface.</td></tr> +<tr> +<td align="left">\textup (\upshape) <a id="id2538628" +class="indexterm"></a> <a id="id2538635" +class="indexterm"></a></td> +<td align="justify">Upright (default). The opposite of +slanted.</td></tr> +<tr> +<td align="left">\textsl (\slshape) <a id="id2538653" +class="indexterm"></a> <a id="id2538660" +class="indexterm"></a></td> +<td align="justify">Slanted.</td></tr> +<tr> +<td align="left">\textsf (\sffamily) <a id="id2538678" +class="indexterm"></a> <a id="id2538685" +class="indexterm"></a></td> +<td align="justify">Sans serif.</td></tr> +<tr> +<td align="left">\textsc (\scshape) <a id="id2538704" +class="indexterm"></a> <a id="id2538710" +class="indexterm"></a></td> +<td align="justify">Small caps.</td></tr> +<tr> +<td align="left">\texttt (\ttfamily) <a id="id2538729" +class="indexterm"></a> <a id="id2538735" +class="indexterm"></a></td> +<td align="justify">Typewriter.</td></tr> +<tr> +<td align="left">\textnormal (\normalfont) <a id="id2538754" +class="indexterm"></a> <a id="id2538761" +class="indexterm"></a></td> +<td align="justify">Main document font.</td></tr> +<tr> +<td align="left">\mathrm <a id="id2538779" +class="indexterm"></a></td> +<td align="justify">Roman, for use in math mode.</td></tr> +<tr> +<td align="left">\mathbf <a id="id2538797" +class="indexterm"></a></td> +<td align="justify">Boldface, for use in math mode. For bold +symbols or complete equations take a look at +<a href="#boldsymbol-linkend"><tt class="literal">\boldsymbol</tt></a> +and <a href="#cmd-bm"><tt class="literal">\bm</tt></a>.</td></tr> +<tr> +<td align="left">\mathsf <a id="id2538839" +class="indexterm"></a></td> +<td align="justify">Sans serif, for use in math mode.</td></tr> +<tr> +<td align="left">\mathtt <a id="id2538858" +class="indexterm"></a></td> +<td align="justify">Typewriter, for use in math mode.</td></tr> +<tr> +<td align="left">\mathit <a id="id2538876" +class="indexterm"></a></td> +<td align="justify">Italics, for use in math mode, e.g. variable +names with several letters.</td></tr> +<tr> +<td align="left">\mathnormal <a id="id2538895" +class="indexterm"></a></td> +<td align="justify">For use in math mode, e.g. inside another type +style declaration.</td></tr> +<tr> +<td align="left">\mathcal <a id="id2538914" +class="indexterm"></a></td> +<td align="justify">`Calligraphic' letters, for use in math +mode.</td></tr></tbody></table></div> +<p>In addition, the command +<tt class="literal">\mathversion{bold}</tt> <a id="id2538939" +class="indexterm"></a> can be used for switching to bold letters +and symbols in formulas. +<tt class="literal">\mathversion{normal}</tt> restores the +default.</p> +<h5 class="title"><a id="sizes-title"></a>Sizes</h5> +<a id="id2538965" class="indexterm"></a><a id="id2538972" +class="indexterm"></a><a id="id2538979" class="indexterm"></a> +<p>The following standard type size commands are supported by +LaTeX.</p> +<p>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.</p> +<p>You can also use the environment form of these commands; e.g. +<tt class="literal">\begin{tiny}...\end{tiny}</tt>.</p> +<div class="table"><a id="id2539011"></a> +<p class="title"><b>Table 1.10. Standard type size +commands</b></p> +<table summary="Standard type size commands" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">\tiny<a id="id2539045" class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\scriptsize <a id="id2539066" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\footnotesize <a id="id2539084" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\small <a id="id2539103" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\normalsize <a id="id2539122" +class="indexterm"></a></td> +<td align="justify">(default)</td></tr> +<tr> +<td align="left">\large <a id="id2539141" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\Large <a id="id2539160" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\LARGE <a id="id2539179" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\huge <a id="id2539198" +class="indexterm"></a></td> +<td align="justify"></td></tr> +<tr> +<td align="left">\Huge <a id="id2539216" +class="indexterm"></a></td> +<td align="justify"> </td></tr></tbody></table></div> +<h5 class="title"> +<a id="low-dash-level-font-commands-title"></a>Low-level font +commands</h5> +<a id="id2539242" class="indexterm"></a><a id="id2539250" +class="indexterm"></a> +<p>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 +<i class="citetitle">The LaTeX Companion</i>.</p> +<div class="table"><a id="id2539271"></a> +<p class="title"><b>Table 1.11. Low-level font +commands</b></p> +<table summary="Low-level font commands" border="0"> +<colgroup> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left">\fontencoding{enc} <a id="id2539304" +class="indexterm"></a></td> +<td align="justify">Select font encoding. Valid encodings include +<tt class="literal">OT1</tt> and +<tt class="literal">T1</tt>.</td></tr> +<tr> +<td align="left">\fontfamily{family} <a id="id2539334" +class="indexterm"></a></td> +<td align="justify">Select font family. Valid families include: +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">cmr</tt> for Computer Modern Roman</li> +<li><tt class="literal">cmss</tt> for Computer Modern Sans +Serif</li> +<li><tt class="literal">cmtt</tt> for Computer Modern +Typewriter</li></ul></div> +and numerous others.</td></tr> +<tr> +<td align="left">\fontseries{series} <a id="id2539391" +class="indexterm"></a></td> +<td align="justify">Select font series. Valid series include: +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">m</tt> Medium (normal)</li> +<li><tt class="literal">b</tt> Bold</li> +<li><tt class="literal">c</tt> Condensed</li> +<li><tt class="literal">bc</tt> Bold condensed</li> +<li><tt class="literal">bx</tt> Bold extended</li></ul></div> +and various other combinations.</td></tr> +<tr> +<td align="left">\fontshape{shape} <a id="id2539468" +class="indexterm"></a></td> +<td align="justify">Select font shape. Valid shapes are: +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li><tt class="literal">n</tt> Upright (normal)</li> +<li><tt class="literal">it</tt> Italic</li> +<li><tt class="literal">sl</tt> Slanted (oblique)</li> +<li><tt class="literal">sc</tt> Small caps</li> +<li><tt class="literal">ui</tt> Upright italics</li> +<li><tt class="literal">ol</tt> Outline</li></ul></div> +The two last shapes are not available for most font +families.</td></tr> +<tr> +<td align="left">\fontsize{size}{skip} <a id="id2539555" +class="indexterm"></a></td> +<td align="justify">Set font size. The first parameter is the font +size to switch to; the second is the +<tt class="literal">\baselineskip</tt> 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.</td></tr> +<tr> +<td align="left">\selectfont <a id="id2539583" +class="indexterm"></a></td> +<td align="justify">The changes made by calling the four font +commands described above do not come into effect until +<tt class="literal">\selectfont</tt> is called.</td></tr> +<tr> +<td align="left">\usefont{enc}{family}{series}{shape} +<a id="id2539610" class="indexterm"></a></td> +<td align="justify">Equivalent to calling +<tt class="literal">\fontencoding</tt>, +<tt class="literal">\fontfamily</tt>, +<tt class="literal">\fontseries</tt> and +<tt class="literal">\fontshape</tt> with the given parameters, +followed by +<tt class="literal">\selectfont</tt>.</td></tr></tbody></table></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="parameters"></a>2.4 +Parameters</h3></div></div></div> +<a id="id2539672" class="indexterm"></a> +<p>The input file specification indicates the file to be formatted; +TeX uses <tt class="filename">.tex</tt> 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.</p> +<p><tt class="literal">latex \scrollmode\input foo.tex</tt></p> +<p>will process <tt class="filename">foo.tex</tt> without pausing +after every error.</p> +<p>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 +<tt class="literal">texput.log</tt>.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="latex-packages"></a>3 +LaTeX Packages</h2></div></div></div> +<a id="id2539754" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="amsmath"></a>3.1 +<tt class="filename">amsmath</tt></h3></div></div></div> +<a id="id2539778" class="indexterm"></a><a id="id2539785" +class="indexterm"></a> +<p><tt class="literal">amsmath</tt> consists of several packages to +aid in typesetting math.</p> +<div class="variablelist"><a id="boldsymbol-linkend"></a> +<dl> +<dt> +<span class="term"><tt class="literal">\boldsymbol</tt></span></dt> +<dd><a id="id2539828" class="indexterm"></a> +<p>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 <a href="#cmd-bm"><tt class="literal">\bm</tt></a> command +which takes better care of spacing.</p></dd> +<dt> +<a id="pmb-linkend"></a><span class="term"><tt class="literal">\pmb</tt></span></dt> +<dd><a id="id2539871" class="indexterm"></a> +<p>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!</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="dcolumn"></a>3.2 +<tt class="filename">dcolumn</tt></h3></div></div></div> +<a id="id2539910" class="indexterm"></a><a id="id2539917" +class="indexterm"></a> +<p><tt class="literal">\usepackage{dcolumn}</tt></p> +<p>Defines a system for defining columns of entries in an +<tt class="literal">array</tt> or <tt class="literal">tabular</tt> +which are to be aligned on a <span class="emphasis"><em>decimal +point</em></span>.</p> +<p>This package defines <tt class="literal">D</tt> to be a column +specifier with three arguments:</p> +<pre class="programlisting"> +D{sep.tex}{sep.dvi}{decimal places} +</pre> +<p><tt class="literal">sep.tex</tt> should be a single character, +this is used as the separator in the <tt class="literal">.tex</tt> +file. It will usually be '<tt class="literal">.</tt>' or +'<tt class="literal">,</tt>'.</p> +<p><tt class="literal">sep.dvi</tt> is used as the separator in the +output.</p> +<p><tt class="literal">decimal places</tt> should be the maximum +number of decimal places in the column.</p> +<p><tt class="literal">\newcolumntype</tt> can be used to define +own column types.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="float"></a>3.3 +<tt class="filename">float</tt></h3></div></div></div> +<a id="id2540048" class="indexterm"></a> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The contents of this section was taken from the documentation of +<tt class="filename">float</tt> v1.3d of 2001/11/08.</p></div> +<p>“<span class="quote">This style option improves the +interface for defining objects such as figures and tabels in LaTeX. +It adds the notion of a <span class="emphasis"><em>float +style</em></span> that governs the appearance of +floats.</span>”</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\newfloat{<placement>}{<ext>}[<within>]</tt></span></dt> +<dd><a id="id2540101" class="indexterm"></a><a id="id2540108" +class="indexterm"></a> +<p>Add a new class of floats.</p></dd> +<dt> +<span class="term"><tt class="literal">\floatstyle{<style>}</tt></span></dt> +<dd><a id="id2540138" class="indexterm"></a><a id="id2540145" +class="indexterm"></a> +<p>Sets a default float style.</p></dd> +<dt> +<span class="term"><tt class="literal">\floatname{<style>}{<name>}</tt></span></dt> +<dd><a id="id2540175" class="indexterm"></a><a id="id2540182" +class="indexterm"></a> +<p>Define the <span class="emphasis"><em>float name</em></span> +used in the caption of a float.</p></dd> +<dt> +<span class="term"><tt class="literal">\floatplacement{<>}{<placement>}</tt></span></dt> +<dd><a id="id2540216" class="indexterm"></a><a id="id2540223" +class="indexterm"></a> +<p>Resets the default placement specifier of a class of +floats.</p></dd> +<dt> +<span class="term"><tt class="literal">\restylefloat<style></tt></span></dt> +<dd><a id="id2540253" class="indexterm"></a><a id="id2540260" +class="indexterm"></a> +<p>Change styles for the standard float types +<tt class="literal">figure</tt> and +<tt class="literal">table</tt>.</p></dd> +<dt> +<span class="term"><tt class="literal">\listof{<type>}{<title>}</tt></span></dt> +<dd><a id="id2540303" class="indexterm"></a><a id="id2540309" +class="indexterm"></a> +<p>Produces a list of all floats of a given +class.</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="fontenc"></a>3.4 +<tt class="filename">fontenc</tt></h3></div></div></div> +<a id="id2540350" class="indexterm"></a> +<p><tt class="literal">\usepackage[T1]{fontenc}</tt></p> +<p>chooses T1-fonts and allows correct automatic +hyphenation.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="german"></a>3.5 +<tt class="filename">german</tt></h3></div></div></div> +<a id="id2540390" class="indexterm"></a><a id="id2540397" +class="indexterm"></a> +<p>Das <tt class="literal">german</tt> Paket muß geladen +sein:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">"a</tt></span></dt> +<dd><a id="id2540437" class="indexterm"></a> +<p>erzeugt ein <span class="emphasis"><em>ä</em></span></p> +<p>entsprechend <tt class="literal">"o</tt>, +<tt class="literal">"u</tt>, <tt class="literal">"A</tt>, +<tt class="literal">"O</tt>, <tt class="literal">"U</tt>, +<tt class="literal">"s (ß)</tt></p></dd> +<dt><span class="term"><tt class="literal">"ck</tt></span></dt> +<dd><a id="id2540504" class="indexterm"></a> +<p>wird bei Trennung zu <tt class="literal">k-k</tt></p></dd> +<dt><span class="term"><tt class="literal">"ff</tt></span></dt> +<dd><a id="id2540538" class="indexterm"></a> +<p>wird bei Trennung zu <tt class="literal">ff-f</tt></p> +<p>entsprechend <tt class="literal">"ll</tt>, +<tt class="literal">"mm</tt>, <tt class="literal">"pp</tt>, +<tt class="literal">"rr</tt>, <tt class="literal">"tt</tt></p></dd> +<dt><span class="term"><tt class="literal">\glqq</tt></span></dt> +<dd><a id="id2540604" class="indexterm"></a> +<p>oder <tt class="literal">"`</tt> erzeugt untere doppelte +Anführungszeichen</p></dd> +<dt> +<a id="cmd-grqq"></a><span class="term"><tt class="literal">\grqq</tt></span></dt> +<dd><a id="id2540644" class="indexterm"></a> +<p>oder <tt class="literal">"'</tt> erzeugt obere doppelte +Anführungszeichen</p></dd> +<dt><span class="term"><tt class="literal">\glq</tt></span></dt> +<dd><a id="id2540681" class="indexterm"></a> +<p>erzeugt untere einfache Anführungszeichen</p></dd> +<dt><span class="term"><tt class="literal">\flqq</tt></span></dt> +<dd><a id="id2540711" class="indexterm"></a> +<p>oder <tt class="literal">"<</tt> doppelte linke +französische Anführungszeichen</p></dd> +<dt><span class="term"><tt class="literal">\frqq</tt></span></dt> +<dd><a id="id2540748" class="indexterm"></a> +<p>oder <tt class="literal">"></tt> doppelte rechte +französische Anführungszeichen</p></dd> +<dt><span class="term"><tt class="literal">\flq</tt></span></dt> +<dd><a id="id2540785" class="indexterm"></a> +<p>einfache linke französische Anführungszeichen</p></dd> +<dt><span class="term"><tt class="literal">\frq</tt></span></dt> +<dd><a id="id2540815" class="indexterm"></a> +<p>einfache rechte französische +Anführungszeichen</p></dd> +<dt><span class="term"><tt class="literal">"|</tt></span></dt> +<dd><a id="id2540846" class="indexterm"></a> +<p>verhindert eine Ligatur an der Stelle</p></dd> +<dt><span class="term"><tt class="literal">\-</tt></span></dt> +<dd><a id="id2540875" class="indexterm"></a> +<p>markiert mögliche Trennstelle, im restlichen Wort ist keine +Trennung mehr möglich</p></dd> +<dt><span class="term"><tt class="literal">"-</tt></span></dt> +<dd><a id="id2540906" class="indexterm"></a> +<p>Trennvorschlag, der Rest des Wortes kann noch automatisch +getrennt werden</p></dd> +<dt><span class="term"><tt class="literal">""</tt></span></dt> +<dd><a id="id2540936" class="indexterm"></a> +<p>Trennvorschlag, bei dem bei einer Trennung kein Bindestrich +eingefügt wird</p></dd> +<dt><span class="term"><tt class="literal">"~</tt></span></dt> +<dd><a id="id2540967" class="indexterm"></a> +<p>Bindestrich, an dem nicht getrennt werden darf</p></dd> +<dt><span class="term"><tt class="literal">"=</tt></span></dt> +<dd><a id="id2540996" class="indexterm"></a> +<p>Bindestrich, an dem getrennt werden darf</p></dd> +<dt><span class="term"><tt class="literal">\dq</tt></span></dt> +<dd><a id="id2541025" class="indexterm"></a> +<p>erzeugt ein nicht-typographisches gerades +Anführungszeichen</p> +<pre class="programlisting"> +\texttt{\dq} +</pre></dd> +<dt><span class="term"><tt class="literal"><</tt></span></dt> +<dd><a id="id2541062" class="indexterm"></a> +<p>oder <tt class="literal">\dq</tt> ergibt das +Zoll-Zeichen</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="graphics"></a>3.6 +<tt class="filename">graphics</tt></h3></div></div></div> +<a id="id2541109" class="indexterm"></a><a id="id2541116" +class="indexterm"></a> +<p>Look up details in <tt class="filename">grfguide</tt>.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="includegraphics"></a>3.6.1 +\includegraphics</h4></div></div></div> +<a id="id2541152" class="indexterm"></a> +<p><tt class="literal">\includegraphics[]{picture-name}</tt></p> +<p>File extensions of the graphics should be omitted, so it's +easier to change the format (for example for pdf or ps +output).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="graphicspath"></a>3.6.2 +\graphicspath</h4></div></div></div> +<a id="id2541188" class="indexterm"></a> +<p><tt class="literal">\graphicspath{dir-list}</tt></p> +<p><tt class="literal">dir-list</tt> is a list of absolute or +relative paths, where the command <a href="#includegraphics" +title="3.6.1 \includegraphics"><tt class="literal">\includegraphics{}</tt></a> +searches for the graphic files:</p> +<p><tt class="literal">\graphicspath{{eps/}{tiff/}}</tt> would +cause the system to look in the subdirectories +<tt class="literal">eps</tt> and <tt class="literal">tiff</tt> of +the current directory. This is unix syntax, on a Mac it would +be:</p> +<p><tt class="literal">\graphicspath{{:eps:}{:tiff:}}</tt></p> +<p>Under Windows/DOS use also the slash <tt class="literal">/</tt> +to separate directories. Not all tex installations can handle +filenames with spaces. So it's better to avoid +them.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="hyperref"></a>3.7 +<tt class="filename">hyperref</tt></h3></div></div></div> +<a id="id2541288" class="indexterm"></a><a id="id2541297" +class="indexterm"></a> +<p>For more infos read in the book <span class="emphasis"><em>LaTeX +Web Companion</em></span> or <span class="emphasis"><em>Mit LaTeX +ins Web</em></span>.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="hyperref-options"></a>3.7.1 +Options</h4></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term">4</span></dt> +<dd><a id="id2541354" class="indexterm"></a> +<p>use Acrobat 4 features (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">a4paper, a5paper, b5paper, legalpaper, +letterpaper, executivepaper</span></dt> +<dd><a id="id2541391" class="indexterm"></a><a id="id2541407" +class="indexterm"></a><a id="id2541423" +class="indexterm"></a><a id="id2541439" +class="indexterm"></a><a id="id2541454" +class="indexterm"></a><a id="id2541470" class="indexterm"></a> +<p>use the specified paper size.</p></dd> +<dt><span class="term">anchorcolor</span></dt> +<dd><a id="id2541500" class="indexterm"></a> +<p>set color of anchors (default: +<tt class="literal">black</tt>).</p></dd> +<dt><span class="term">backref</span></dt> +<dd><a id="id2541536" class="indexterm"></a> +<p>do bibliographical back references (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">baseurl</span></dt> +<dd><a id="id2541572" class="indexterm"></a> +<p>set base URL for document (default: +<tt class="literal">empty</tt>).</p></dd> +<dt><span class="term">bookmarks</span></dt> +<dd><a id="id2541608" class="indexterm"></a> +<p>make bookmarks (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">bookmarksnumbered</span></dt> +<dd><a id="id2541644" class="indexterm"></a> +<p>put section numbers in bookmarks (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">bookmarksopen</span></dt> +<dd><a id="id2541680" class="indexterm"></a> +<p>open up bookmark tree (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">bookmarksopenlevel</span></dt> +<dd><a id="id2541716" class="indexterm"></a> +<p>level to which bookmarks are open (default: +<tt class="literal">\maxdimen</tt>).</p></dd> +<dt><span class="term">bookmarkstype</span></dt> +<dd><a id="id2541752" class="indexterm"></a> +<p>to specify which `toc' file to mimic toc.</p></dd> +<dt><span class="term">breaklinks</span></dt> +<dd><a id="id2541782" class="indexterm"></a> +<p>allow links to break over lines (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">citebordercolor</span></dt> +<dd><a id="id2541819" class="indexterm"></a> +<p>color of border around cites (default: <tt class="literal">0 1 +0</tt>).</p></dd> +<dt><span class="term">citecolor</span></dt> +<dd><a id="id2541855" class="indexterm"></a> +<p>color of citation links (default: +<tt class="literal">green</tt>).</p></dd> +<dt><span class="term">colorlinks</span></dt> +<dd><a id="id2541891" class="indexterm"></a> +<p>color links (default: <tt class="literal">false</tt>).</p></dd> +<dt><span class="term">debug</span></dt> +<dd><a id="id2541926" class="indexterm"></a> +<p>provide details of anchors defined (same as verbose, default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">draft</span></dt> +<dd><a id="id2541962" class="indexterm"></a> +<p>do not do any hyper linking (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">dvipdf, dvipdfm, dvips, dvipsone, dviwindo, +hypertex,</span> <span class="term">latex2html, pdftex, tex4ht, +textures, ps2pdf, vtex,</span></dt> +<dd><a id="id2542003" class="indexterm"></a><a id="id2542019" +class="indexterm"></a><a id="id2542035" +class="indexterm"></a><a id="id2542051" +class="indexterm"></a><a id="id2542066" +class="indexterm"></a><a id="id2542082" +class="indexterm"></a><a id="id2542098" +class="indexterm"></a><a id="id2542114" +class="indexterm"></a><a id="id2542130" +class="indexterm"></a><a id="id2542146" +class="indexterm"></a><a id="id2542162" class="indexterm"></a> +<p>use the specified backend.</p></dd> +<dt><span class="term">extension</span></dt> +<dd><a id="id2542191" class="indexterm"></a> +<p>suffix of linked files (default: +<tt class="literal">dvi</tt>).</p></dd> +<dt><span class="term">filebordercolor</span></dt> +<dd><a id="id2542227" class="indexterm"></a> +<p>color of border around file links (default: +<tt class="literal">0 .5 .5</tt>).</p></dd> +<dt><span class="term">filecolor</span></dt> +<dd><a id="id2542263" class="indexterm"></a> +<p>color of file links (default: +<tt class="literal">cyan</tt>).</p></dd> +<dt><span class="term">frenchlinks</span></dt> +<dd><a id="id2542299" class="indexterm"></a> +<p>use small caps instead of color for links (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">hyperfigures</span></dt> +<dd><a id="id2542335" class="indexterm"></a> +<p>make figures hyper links (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">hyperindex</span></dt> +<dd><a id="id2542371" class="indexterm"></a> +<p>set up hyperlinked indices (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">hypertexnames</span></dt> +<dd><a id="id2542407" class="indexterm"></a> +<p>use guessable names for links (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">implicit</span></dt> +<dd><a id="id2542443" class="indexterm"></a> +<p>redefine LaTeX internals (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">linkbordercolor</span></dt> +<dd><a id="id2542482" class="indexterm"></a> +<p>color of border around links (default: <tt class="literal">1 0 +0</tt>).</p></dd> +<dt><span class="term">linkcolor</span></dt> +<dd><a id="id2542518" class="indexterm"></a> +<p>color of links (default: <tt class="literal">red</tt>).</p></dd> +<dt><span class="term">linktocpage</span></dt> +<dd><a id="id2542554" class="indexterm"></a> +<p>make page number, not text, be link on TOC, LOF and LOT +(default: <tt class="literal">false</tt>).</p></dd> +<dt><span class="term">menubordercolor</span></dt> +<dd><a id="id2542590" class="indexterm"></a> +<p>color of border around menu links (default: +<tt class="literal">1 0 0</tt>).</p></dd> +<dt><span class="term">menucolor</span></dt> +<dd><a id="id2542627" class="indexterm"></a> +<p>color for menu links (default: +<tt class="literal">red</tt>).</p></dd> +<dt><span class="term">naturalnames</span></dt> +<dd><a id="id2542662" class="indexterm"></a> +<p>use LaTeX-computed names for links (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">nesting</span></dt> +<dd><a id="id2542702" class="indexterm"></a> +<p>allow nesting of links (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">pageanchor</span></dt> +<dd><a id="id2542738" class="indexterm"></a> +<p>put an anchor on every page (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">pagebackref</span></dt> +<dd><a id="id2542773" class="indexterm"></a> +<p>backreference by page number (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">pagebordercolor</span></dt> +<dd><a id="id2542809" class="indexterm"></a> +<p>color of border around page links (default: +<tt class="literal">1 1 0</tt>).</p></dd> +<dt><span class="term">pagecolor</span></dt> +<dd><a id="id2542846" class="indexterm"></a> +<p>color of page links (default: +<tt class="literal">red</tt>).</p></dd> +<dt><span class="term">pdfauthor</span></dt> +<dd><a id="id2542881" class="indexterm"></a> +<p>text for PDF Author field (default: empty).</p></dd> +<dt><span class="term">pdfborder</span></dt> +<dd><a id="id2542911" class="indexterm"></a> +<p>width of PDF link border (default: <tt class="literal">0 0 +1</tt>; <tt class="literal">0 0 0</tt> for +<tt class="literal">colorlinks</tt>)</p></dd> +<dt><span class="term">pdfcenterwindow</span></dt> +<dd><a id="id2542959" class="indexterm"></a> +<p>position the document window center of the screen (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">pdfcreator</span></dt> +<dd><a id="id2542995" class="indexterm"></a> +<p>text for PDF Creator field (default: LaTeX with hyperref +package).</p></dd> +<dt><span class="term">pdffitwindow</span></dt> +<dd><a id="id2543029" class="indexterm"></a> +<p>resize document window to fit document size (default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">pdfhighlight</span></dt> +<dd><a id="id2543066" class="indexterm"></a> +<p>set highlighting of PDF links (default: +<tt class="literal">/I</tt>).</p></dd> +<dt><span class="term">pdfkeywords</span></dt> +<dd><a id="id2543101" class="indexterm"></a> +<p>text for PDF Keywords field (default: empty).</p></dd> +<dt><span class="term">pdfmenubar</span></dt> +<dd><a id="id2543131" class="indexterm"></a> +<p>make PDF viewer's menu bar visible (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">pdfnewwindow</span></dt> +<dd><a id="id2543167" class="indexterm"></a> +<p>make links that open another PDF file start a new window +(default: <tt class="literal">false</tt>).</p></dd> +<dt><span class="term">pdfpagelayout</span></dt> +<dd><a id="id2543204" class="indexterm"></a> +<p>set layout of PDF pages (default: empty).</p></dd> +<dt><span class="term">pdfpagemode</span></dt> +<dd><a id="id2543234" class="indexterm"></a> +<p>set default mode of PDF display (default: empty).</p></dd> +<dt><span class="term">pdfpagescrop</span></dt> +<dd><a id="id2543264" class="indexterm"></a> +<p>set crop size of PDF document (default: empty).</p></dd> +<dt><span class="term">pdfpagetransition</span></dt> +<dd><a id="id2543294" class="indexterm"></a> +<p>set PDF page transition style (default: empty).</p></dd> +<dt><span class="term">pdfproducer</span></dt> +<dd><a id="id2543325" class="indexterm"></a> +<p>text for PDF Producer field (default: empty).</p></dd> +<dt><span class="term">pdfstartpage</span></dt> +<dd><a id="id2543355" class="indexterm"></a> +<p>page at which PDF document opens (default: +<tt class="literal">1</tt>).</p></dd> +<dt><span class="term">pdfstartview</span></dt> +<dd><a id="id2543391" class="indexterm"></a> +<p>starting view of PDF document (default: +<tt class="literal">/Fit</tt>).</p></dd> +<dt><span class="term">pdfsubject</span></dt> +<dd><a id="id2543427" class="indexterm"></a> +<p>text for PDF Subject field (default: empty).</p></dd> +<dt><span class="term">pdftitle</span></dt> +<dd><a id="id2543457" class="indexterm"></a> +<p>text for PDF Title field(default: empty).</p></dd> +<dt><span class="term">pdftoolbar</span></dt> +<dd><a id="id2543487" class="indexterm"></a> +<p>make PDF toolbar visible (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">pdfview</span></dt> +<dd><a id="id2543522" class="indexterm"></a> +<p>PDF `view' when on link traversal (default: empty).</p></dd> +<dt><span class="term">pdfwindowui</span></dt> +<dd><a id="id2543552" class="indexterm"></a> +<p>make PDF user interface elements visible (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">plainpages</span></dt> +<dd><a id="id2543588" class="indexterm"></a> +<p>do page number anchors as plain arabic (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">raiselinks</span></dt> +<dd><a id="id2543624" class="indexterm"></a> +<p>raise up links (for HyperTeX backend; default: +<tt class="literal">false</tt>).</p></dd> +<dt><span class="term">runbordercolor</span></dt> +<dd><a id="id2543661" class="indexterm"></a> +<p>color of border around run links (default: <tt class="literal">0 +.7 .7</tt>).</p></dd> +<dt><span class="term">unicode</span></dt> +<dd><a id="id2543697" class="indexterm"></a> +<p>Unicode encoded pdf strings (default: +<tt class="literal">true</tt>).</p></dd> +<dt><span class="term">urlbordercolor</span></dt> +<dd><a id="id2543733" class="indexterm"></a> +<p>color of border around URL links (default: <tt class="literal">0 +1 1</tt>).</p></dd> +<dt><span class="term">urlcolor</span></dt> +<dd><a id="id2543769" class="indexterm"></a> +<p>color of URL links (default: +<tt class="literal">magenta</tt>).</p></dd> +<dt><span class="term">verbose</span></dt> +<dd><a id="id2543804" class="indexterm"></a> +<p>be chatty (default: +<tt class="literal">false</tt>).</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="hyperref-commands"></a>3.7.2 +Commands</h4></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\texorpdfstring{TeX-string}{pdf-string}</tt></span></dt> +<dd><a id="id2543868" class="indexterm"></a> +<p>allows different texts for PDF or TeX creation.</p> +<pre class="programlisting"> +\section{The role of \texorpdfstring{H$_2$O}{water}} +</pre></dd> +<dt> +<a id="href"></a><span class="term"><tt class="literal">\href{URL}{Text}</tt></span></dt> +<dd><a id="id2543915" class="indexterm"></a> +<p>the text will be resolved into a URL. The URL must be complete, +according to a base-url which might be defined in a +<a href="#cmd-hyperbaseurl"><tt class="literal">\hyperbaseurl</tt></a>.</p> +<pre class="programlisting"> +\href{http://www.karpfenteich.net/pit/}{Peter's input tips} +</pre></dd> +<dt> +<span class="term"><a id="cmd-hyperbaseurl"></a><tt class="literal"> +\hyperbaseurl{URL}</tt></span></dt> +<dd><a id="id2543972" class="indexterm"></a> +<p>defines a base URL, which is preset to a given URL. This helps +to make portable documents.</p></dd> +<dt> +<span class="term"><tt class="literal">\hyperimage{image-URL}</tt></span></dt> +<dd><a id="id2544006" class="indexterm"></a> +<p>includes the picture of the URL reference.</p></dd> +<dt> +<span class="term"><tt class="literal">\hyperref{URL}{category}{name}{text}</tt>,</span> +<span class="term"><tt class="literal">\hyperref[mark]{text}</tt>,</span></dt> +<dd><a id="id2544047" class="indexterm"></a> +<p><tt class="literal">text</tt> is activated as a hyperlink to the +point which is defined with a +<a href="#cmd-label-title"><tt class="filename">\label</tt></a> +command with the symbolic name +<tt class="literal">mark</tt>.</p></dd> +<dt> +<span class="term"><tt class="literal">\hyperlink{name}{text}</tt>,</span> +<span class="term"><tt class="literal">\hyertarget{name}{text}</tt>,</span></dt> +<dd><a id="id2544113" class="indexterm"></a><a id="id2544129" +class="indexterm"></a> +<p><tt class="literal">\hyperlink</tt> creates an internal link to +an object which is somewhere defined with a +<tt class="literal">\hypertarget</tt> command.</p> +<p>For HTML the command <tt class="literal">\hyperlink</tt> inserts +a <tt class="literal">#</tt> character in front of each link. Thus +it'll refer to the topical document, while +<tt class="literal">\href</tt> will expect a complete URL.</p></dd> +<dt> +<span class="term"><tt class="literal">\autoref{marker}</tt></span></dt> +<dd><a id="id2544197" class="indexterm"></a> +<p><tt class="literal">\autoref</tt> is a substitution for the +standard <tt class="literal">\ref</tt> command. It inserts a +context sensitive phrase.</p> +<pre class="programlisting"> +see \autoref{foo} +</pre> +<p>for a <tt class="literal">\label</tt> in a section will output +<span class="emphasis"><em>see section 3</em></span> for an +example.</p> +<p>There are macros to change the default output with the help of +the <tt class="literal">\renewcommand</tt>:</p> +<pre class="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* +</pre></dd> +<dt> +<span class="term"><a id="cmd-nolinkurl"></a><tt class="literal">\nolinkurl</tt></span></dt> +<dd><a id="id2544292" class="indexterm"></a> +<p>Allows line breaks in a verbatim like environment like +<tt class="literal">\url</tt>, but without the hyperlink function. +This is useful to define own commands like this example:</p> +<pre class="programlisting"> +\newcommand*{\urlw}[1]{\href{http://www.#1}% + {\nolinkurl{www.#1}}} +</pre> +<p>This new defined command <tt class="literal">\urlw</tt> allows +the user to typeset a linkable (this function is offered by +<tt class="literal">\href</tt>) +<tt class="literal">www.example.org</tt> address in the latex +source like this:</p> +<pre class="programlisting"> +\urlw{example.org} +</pre> +<p>This will produce the string +<tt class="literal">www.example.org</tt> which is hyperlinked and +breakable (when the driver like pdfTeX allows line breaks in +links).</p></dd></dl></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="inputenc"></a>3.8 +<tt class="filename">inputenc</tt></h3></div></div></div> +<a id="id2544394" class="indexterm"></a> +<p><tt class="literal">\usepackage[encoding +name]{inputenc}</tt></p> +<p>Allows to specify an input encoding for direct input of +character codes > 127, e.g. accented characters.</p> +<p>Important encodings are:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">latin9, +latin1</tt></span></dt> +<dd> +<p>Linux, Unix, VMS</p> +<a id="id2544441" class="indexterm"></a><a id="id2544448" +class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">ansinew</tt></span></dt> +<dd> +<p>Windows (codepage 1252)</p> +<a id="id2544471" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">cp850</tt></span></dt> +<dd> +<p>OS/2, MSDOS (codpage 850)</p> +<a id="id2544495" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">applemac</tt></span></dt> +<dd> +<p>Apple Macintosh</p> +<a id="id2544519" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="komascript"></a>3.9 +<tt class="filename">KOMA-Script</tt></h3></div></div></div> +<a id="id2544549" class="indexterm"></a><a id="id2544557" +class="indexterm"></a> +<p>The <tt class="literal">KOMA-Script</tt> package has a very +detailed and well written documentation. Read the +<tt class="literal">scrguide</tt> for further information! :-)</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="komascript-page-layout"></a>3.9.1 +Page-Layout</h4></div></div></div> +<p><tt class="literal">\typearea[BCOR]{DIV}</tt></p> +<a id="id2544614" class="indexterm"></a> +<p><tt class="literal">\areaset[BCOR]{Breite}{Höhe}</tt></p> +<a id="id2544631" class="indexterm"></a></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="komascript-options"></a>3.9.2 +Options</h4></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term">headinclude, headexclude,</span> +<span class="term">footinclude, footexclude,</span></dt> +<dd><a id="id2544671" class="indexterm"></a><a id="id2544680" +class="indexterm"></a><a id="id2544688" +class="indexterm"></a><a id="id2544697" class="indexterm"></a> +<p>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.</p></dd> +<dt><span class="term">DIV</span></dt> +<dd><a id="id2544722" class="indexterm"></a> +<p>is a factor which determins how large the used page size is. +This method takes care of good typography.</p> +<p>Try values between 10 and 15. Higher values will cause smaller +margins. An example would be: +<tt class="literal">DIV12</tt>.</p></dd> +<dt><span class="term">BCOR</span></dt> +<dd><a id="id2544758" class="indexterm"></a> +<p>Binding correction. Takes care of the loss of the visible paper +size when the paper is cut and a book is +bound.</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="komascript-scrlttr2"></a>3.9.3 Letter +Class <tt class="literal">scrlttr2</tt></h4></div></div></div> +<a id="id2544796" class="indexterm"></a> +<p>This reference is based on the excellent +<tt class="literal">scrguien.pdf</tt> from 2002-09-06.</p> +<h5 class="title"><a id="id2544819"></a>Options</h5> +<a id="id2544825" class="indexterm"></a> +<h5 class="title"><a id="id2544840"></a>Defining Options Later</h5> +<a id="id2544846" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\KOMAoptions{options +list}</tt></span></dt> +<dd>Use this to change options after loading the class. List single +or multiple options, separated by commas.</dd></dl></div> +<h5 class="title"><a id="id2544888"></a>Page Layout Options</h5> +<a id="id2544894" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">paper=format</tt></span></dt> +<dd>Defines the paper format.</dd> +<dt><span class="term"><tt class="literal">BCOR=length</tt>,</span> +<span class="term"><tt class="literal">DIV=value</tt>,</span> +<span class="term"><tt class="literal">headlines=count</tt>,</span></dt> +<dd>Divisor, binding correction, and number of headlines.</dd> +<dt> +<span class="term"><tt class="literal">enlargefirstpage</tt></span></dt> +<dd>If <span class="emphasis"><em>true</em></span> some more text +would fit on the first page</dd></dl></div> +<h5 class="title"><a id="id2544988"></a>Other Layout Options</h5> +<a id="id2544994" class="indexterm"></a><a id="id2545010" +class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">twoside</tt></span></dt> +<dd>Activate possibilities of a double-sided document, but stay +with with the one-sided layout as far as possible.</dd> +<dt> +<span class="term"><tt class="literal">cleardoublepage=style</tt></span></dt> +<dd> +<p>Inserted pages by <tt class="literal">\cleardoublepage</tt> get +one of these page styles:</p> +<div class="itemizedlist"> +<ul type="disc"> +<li><tt class="literal">empty</tt></li> +<li><tt class="literal">plain</tt></li> +<li><tt class="literal">standard</tt></li></ul></div></dd> +<dt><span class="term"><tt class="literal">headsepline</tt>,</span> +<span class="term"><tt class="literal">footsepline</tt>,</span></dt> +<dd>Insert a separator line below the head or above the foot.</dd> +<dt><span class="term"><tt class="literal">mpinclude</tt>,</span> +<span class="term"><tt class="literal">mpexclude</tt>,</span></dt> +<dd>These two options of the <tt class="literal">typearea</tt> +package should not be used with +<tt class="literal">scrlttr2</tt>.</dd> +<dt> +<span class="term"><tt class="literal">pagenumber=position</tt></span></dt> +<dd> +<p>This option defines if and where a page number will be placed. +Possible values are:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">bot</tt>,</span> +<span class="term"><tt class="literal">foot</tt>,</span></dt> +<dd>Page number in foot, horizontal position not changed</dd> +<dt><span class="term"><tt class="literal">botcenter</tt>,</span> +<span class="term"><tt class="literal">botcentered</tt>,</span> +<span class="term"><tt class="literal">botmiddle</tt>,</span> +<span class="term"><tt class="literal">footcenter</tt>,</span> +<span class="term"><tt class="literal">footcentered</tt>,</span> +<span class="term"><tt class="literal">footmiddle</tt>,</span></dt> +<dd>Page number infoot,centered</dd> +<dt><span class="term"><tt class="literal">botleft</tt>,</span> +<span class="term"><tt class="literal">footleft</tt>,</span></dt> +<dd>Page number in foot, left justified</dd> +<dt><span class="term"><tt class="literal">botrigth</tt>,</span> +<span class="term"><tt class="literal">footright</tt>,</span></dt> +<dd>Page number in foot, right justified</dd> +<dt><span class="term"><tt class="literal">center</tt>,</span> +<span class="term"><tt class="literal">centered</tt>,</span> +<span class="term"><tt class="literal">middle</tt>,</span></dt> +<dd>Page number centered horizontally, vertical position not +changed</dd> +<dt><span class="term"><tt class="literal">false</tt>,</span> +<span class="term"><tt class="literal">no</tt>,</span> +<span class="term"><tt class="literal">off</tt>,</span></dt> +<dd>No page number</dd> +<dt><span class="term"><tt class="literal">head</tt>,</span> +<span class="term"><tt class="literal">top</tt>,</span></dt> +<dd>Page number in head, horizontal position not changed</dd> +<dt><span class="term"><tt class="literal">headcenter</tt>,</span> +<span class="term"><tt class="literal">headcentered</tt>,</span> +<span class="term"><tt class="literal">headmiddle</tt>,</span> +<span class="term"><tt class="literal">topcenter</tt>,</span> +<span class="term"><tt class="literal">topcentered</tt>,</span> +<span class="term"><tt class="literal">topmiddle</tt>,</span></dt> +<dd>Page number in head, centered</dd> +<dt><span class="term"><tt class="literal">headleft</tt>,</span> +<span class="term"><tt class="literal">topleft</tt>,</span></dt> +<dd>Page number in head, left justified</dd> +<dt><span class="term"><tt class="literal">headright</tt>,</span> +<span class="term"><tt class="literal">topright</tt>,</span></dt> +<dd>Page number in head, right justified</dd> +<dt><span class="term"><tt class="literal">left</tt></span></dt> +<dd>Page number left, vertical position not changed</dd> +<dt><span class="term"><tt class="literal">right</tt></span></dt> +<dd>Page number right, vertical position not +changed</dd></dl></div> +<p>Default is <tt class="literal">botcenter</tt></p></dd> +<dt> +<span class="term"><tt class="literal">parskip=value</tt></span></dt> +<dd> +<p>Mark paragraphs alternatively by vertical skip. Possible values +are:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">false</tt>,</span> +<span class="term"><tt class="literal">off</tt>,</span></dt> +<dd>Paragraph indentation instead of verticalk space</dd> +<dt><span class="term"><tt class="literal">full</tt>,</span> +<span class="term"><tt class="literal">on</tt>,</span> +<span class="term"><tt class="literal">true</tt>,</span></dt> +<dd>One line vertical space between paragraphs; at least 1 em free +space in the last line.</dd> +<dt><span class="term"><tt class="literal">full*</tt></span></dt> +<dd>One line vertical space betwen paragraphs; at least a quarter +of a line free space at the end of a paragraph.</dd> +<dt><span class="term"><tt class="literal">full+</tt></span></dt> +<dd>One line vertical space betwen paragraphs; at least a third of +aline free space at the end of a paragraph.</dd> +<dt><span class="term"><tt class="literal">full-</tt></span></dt> +<dd>One line vertical space betwen paragraphs; last line of a +paragraph may be arbitrarily filled.</dd> +<dt><span class="term"><tt class="literal">half</tt></span></dt> +<dd>Half a line vertical space between paragraphs; at least 1 em +free space in the last line.</dd> +<dt><span class="term"><tt class="literal">half*</tt></span></dt> +<dd>Half a line vertical space between paragraphs; at least a +quarter of a line free space at the end of a paragraph.</dd> +<dt><span class="term"><tt class="literal">half+</tt></span></dt> +<dd>Half a line vertical space between paragraphs; at least a third +of a line free space at the end of a paragraph.</dd> +<dt><span class="term"><tt class="literal">half-</tt></span></dt> +<dd>One line vertical space between paragraphs; last line may be +arbitrarily filled.</dd></dl></div> +<p>Default is <tt class="literal">false</tt>.</p></dd></dl></div> +<h5 class="title"><a id="id2545774"></a>Font Options</h5> +<a id="id2545779" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">fontsize=size</tt></span></dt> +<dd>Font size of the document. Defaults to +<tt class="literal">12pt</tt>.</dd></dl></div> +<h5 class="title"><a id="id2545825"></a>Options for Letterhead and +Address</h5> +<a id="id2545831" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">fromalign</tt></span></dt> +<dd> +<p>Defines the placement of the from address in the letterhead. +Possible values are:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">center</tt>,</span> +<span class="term"><tt class="literal">centered</tt>,</span> +<span class="term"><tt class="literal">middle</tt>,</span></dt> +<dd>Return address centered.</dd> +<dt><span class="term"><tt class="literal">false</tt>,</span> +<span class="term"><tt class="literal">no</tt>,</span> +<span class="term"><tt class="literal">off</tt>,</span></dt> +<dd>Standard design for return address.</dd> +<dt><span class="term"><tt class="literal">left</tt></span></dt> +<dd>Left justified return address.</dd> +<dt><span class="term"><tt class="literal">rigth</tt></span></dt> +<dd>Right justified return address.</dd></dl></div> +<p>Default is <tt class="literal">left</tt></p></dd> +<dt> +<span class="term"><tt class="literal">fromrule</tt></span></dt> +<dd> +<p>Allows to place a horizontal rule within return address. +Possible values are:</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">afteraddress</tt>,</span> +<span class="term"><tt class="literal">below</tt>,</span> +<span class="term"><tt class="literal">true</tt>,</span> +<span class="term"><tt class="literal">yes</tt>,</span></dt> +<dd>Line below return address</dd> +<dt> +<span class="term"><tt class="literal">aftername</tt></span></dt> +<dd>Line right below sender's name</dd> +<dt><span class="term"><tt class="literal">false</tt>,</span> +<span class="term"><tt class="literal">no</tt>,</span> +<span class="term"><tt class="literal">off</tt>,</span></dt> +<dd>No line.</dd></dl></div> +<p>Default is <tt class="literal">false</tt>.</p></dd> +<dt> +<span class="term"><tt class="literal">fromphone</tt></span></dt> +<dd>Defines whether the phone number will be part of the return +address.</dd> +<dt><span class="term"><tt class="literal">fromfax</tt></span></dt> +<dd>Defines whether the facsimile number will be part of the return +address.</dd> +<dt> +<span class="term"><tt class="literal">fromemail</tt></span></dt> +<dd>Defines whether the email address will be part of the return +address.</dd> +<dt><span class="term"><tt class="literal">fromurl</tt></span></dt> +<dd>Defines whether the URL will be part of the return +address.</dd> +<dt> +<span class="term"><tt class="literal">fromlogo</tt></span></dt> +<dd>Defines whether the logo will be part of the return +address.</dd> +<dt> +<span class="term"><tt class="literal">addrfield</tt></span></dt> +<dd>Defines whether a return address field will be set.</dd> +<dt> +<span class="term"><tt class="literal">backaddress</tt></span></dt> +<dd>Defines whether a return address for window envelopes will be +set.</dd> +<dt><span class="term"><tt class="literal">subject</tt></span></dt> +<dd> +<p>Choose of your subject should have a title and if the subject +should be set before or after the opening. Possible values are:</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">afteropening</tt></span></dt> +<dd>Set subject after opening.</dd> +<dt> +<span class="term"><tt class="literal">beforeopening</tt></span></dt> +<dd>Set subject before opening.</dd> +<dt><span class="term"><tt class="literal">titled</tt></span></dt> +<dd>Add title to subject.</dd> +<dt> +<span class="term"><tt class="literal">untitled</tt></span></dt> +<dd>Do not add title to subject.</dd></dl></div> +<p>Defaults are <tt class="literal">beforeopening</tt> and +<tt class="literal">untitled</tt>.</p></dd> +<dt> +<span class="term"><tt class="literal">locfield</tt></span></dt> +<dd> +<p>Toggle between presets for the field width of additionbal sender +attributes.</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">narrow</tt></span></dt> +<dd>Small sender supplement field.</dd> +<dt><span class="term"><tt class="literal">wide</tt></span></dt> +<dd>Wide sender supplement field.</dd></dl></div> +<p>Default is <tt class="literal">narrow</tt>.</p></dd> +<dt> +<span class="term"><tt class="literal">foldmarks</tt></span></dt> +<dd>Activates fold marks.</dd> +<dt> +<span class="term"><tt class="literal">numericaldate</tt></span></dt> +<dd>Toggles between standard, language-dependent date presentation +and a short, numerical one.</dd> +<dt><span class="term"><tt class="literal">refline</tt></span></dt> +<dd>Defines that the reference line may extend beyond the normal +type area.</dd></dl></div> +<h5 class="title"><a id="id2546465"></a>Format Options</h5> +<a id="id2546471" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">draft</tt></span></dt> +<dd>Toggles between the final and the draft +version.</dd></dl></div> +<h5 class="title"><a id="id2546513"></a>Letter Class Option +Files</h5> +<a id="id2546519" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\LoadLetterOption{name}</tt></span></dt> +<dd> +<p>Load a <tt class="literal">lco</tt> file. +<tt class="literal">name</tt> is the filename without suffix.</p> +<p>Predefined <tt class="literal">lco</tt> files:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">DIN</tt></span></dt> +<dd>For A4 size paper, complying with DIN 676.</dd> +<dt> +<span class="term"><tt class="literal">DINmtext</tt></span></dt> +<dd>For A4 size paper, complying with DIN 676, but using an +alternate layout with more text on the first page.</dd> +<dt><span class="term"><tt class="literal">KOMAold</tt></span></dt> +<dd>Fo AQ4 paper size using a layout close to the obsolete +<tt class="literal">scrlettr</tt> class.</dd> +<dt><span class="term"><tt class="literal">SN</tt></span></dt> +<dd>For Swiss letters with address field on the right side, +according to SN 010 130</dd> +<dt><span class="term"><tt class="literal">SNleft</tt></span></dt> +<dd>For Swiss letters with address field on the left +side.</dd></dl></div></dd> +<dt> +<span class="term"><tt class="literal">\LetterOptionNeedsPaperSize{option +name}{paper size}</tt></span></dt> +<dd>Useful to be abel to emit warnings if the user selects a +different paper size from the one the <tt class="literal">lco</tt> +file is based on.</dd></dl></div> +<h5 class="title"><a id="id2546713"></a>General Document +Properties</h5> +<a id="id2546718" class="indexterm"></a> +<h5 class="title"><a id="id2546734"></a>Font Selection</h5> +<a id="id2546740" class="indexterm"></a> +<p>See also the section for <span class="emphasis"><em>Changing +Fonts</em></span> in KOMA-Script (still to be written).</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">backaddress</tt></span></dt> +<dd>Back address for a window envelope</dd> +<dt> +<span class="term"><tt class="literal">descriptionlabel</tt></span></dt> +<dd>Label in a <tt class="literal">description</tt> +environment</dd> +<dt> +<span class="term"><tt class="literal">fromaddress</tt></span></dt> +<dd>Sender's address in letterhead</dd> +<dt> +<span class="term"><tt class="literal">fromname</tt></span></dt> +<dd>Sender's address in letterhead if different from +<tt class="literal">fromaddress</tt></dd> +<dt> +<span class="term"><tt class="literal">pagefoot</tt></span></dt> +<dd>Footer, sometimes header of a page</dd> +<dt> +<span class="term"><tt class="literal">pagehead</tt></span></dt> +<dd>Header, sometimes footer of a page</dd> +<dt> +<span class="term"><tt class="literal">pagenumber</tt></span></dt> +<dd>Page number in footer or header</dd> +<dt><span class="term"><tt class="literal">subject</tt></span></dt> +<dd>Subject in the opening</dd> +<dt><span class="term"><tt class="literal">title</tt></span></dt> +<dd>Headline in the opening</dd></dl></div> +<h5 class="title"><a id="id2546939"></a>Page Style</h5> +<a id="id2546945" class="indexterm"></a> +<p>See also the section for <span class="emphasis"><em>Page +Style</em></span> in KOMA-Script (still to be written).</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">empty</tt></span></dt> +<dd>Entirely empty headers and footers</dd> +<dt><span class="term"><tt class="literal">plain</tt></span></dt> +<dd>Empty head and and only page number in header or footer</dd> +<dt> +<span class="term"><tt class="literal">headings</tt></span></dt> +<dd>Automatic page headings</dd> +<dt> +<span class="term"><tt class="literal">myheadings</tt></span></dt> +<dd>Manual page headings</dd></dl></div> +<h5 class="title"><a id="id2547046"></a>Variables</h5> +<a id="id2547052" class="indexterm"></a> +<p>The main difference between a +<span class="emphasis"><em>command</em></span> and a +<span class="emphasis"><em>variable</em></span> is that a command +usually triggers an action whereas a variable only consists of +plain text. Furthermore a variable can have an additional +description.</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\newkomavar[description]{name}</tt>,</span> +<span class="term"><tt class="literal">\newkomavar*[description]{name}</tt>,</span> +<span class="term"><tt class="literal">\addtoreffields{name}</tt>,</span></dt> +<dd><a id="id2547114" class="indexterm"></a><a id="id2547130" +class="indexterm"></a> +<p><tt class="literal">\newkomavar</tt> defines a new variable, +addressed with <tt class="literal">name</tt>.</p> +<p>The command <tt class="literal">\addtoreffields</tt> adds the +variable <tt class="literal">name</tt> to the reference fields. See +section <a href="#scrlttr-business-line">Business Line</a>.</p> +<p>The command <tt class="literal">\newkomavar*</tt> works like +<tt class="literal">\newkomavar</tt> with an additional call of the +command +<tt class="literal">\addtoreffields</tt>.</p></dd></dl></div> +<p>Overview of all variables:</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">backaddress</tt></span></dt> +<dd><a id="id2547233" class="indexterm"></a> +<p>Back address for window envelopes</p></dd> +<dt> +<span class="term"><tt class="literal">backaddressseparator</tt></span></dt> +<dd><a id="id2547265" class="indexterm"></a> +<p>Separator within the back address</p></dd> +<dt> +<span class="term"><tt class="literal">ccseparator</tt></span></dt> +<dd><a id="id2547299" class="indexterm"></a> +<p>Separator between title of additional recipients and additional +recipients</p></dd> +<dt> +<span class="term"><tt class="literal">customer</tt></span></dt> +<dd><a id="id2547332" class="indexterm"></a> +<p>Customer number</p></dd> +<dt><span class="term"><tt class="literal">date</tt></span></dt> +<dd><a id="id2547365" class="indexterm"></a> +<p>Date</p></dd> +<dt> +<span class="term"><tt class="literal">emailseparator</tt></span></dt> +<dd><a id="id2547398" class="indexterm"></a> +<p>Separator between e-mail name and e-mail address</p></dd> +<dt> +<span class="term"><tt class="literal">enclseparator</tt></span></dt> +<dd><a id="id2547431" class="indexterm"></a> +<p>Separator between title of enclosure and and enclosures</p></dd> +<dt> +<span class="term"><tt class="literal">faxseparator</tt></span></dt> +<dd><a id="id2547465" class="indexterm"></a> +<p>Separator between title of fax and fax number</p></dd> +<dt> +<span class="term"><tt class="literal">fromaddress</tt></span></dt> +<dd><a id="id2547499" class="indexterm"></a> +<p>Sender's address without its name</p></dd> +<dt> +<span class="term"><tt class="literal">frombank</tt></span></dt> +<dd><a id="id2547532" class="indexterm"></a> +<p>Sender's bank account</p></dd> +<dt> +<span class="term"><tt class="literal">fromemail</tt></span></dt> +<dd><a id="id2547564" class="indexterm"></a> +<p>Sender's e-mail</p></dd> +<dt><span class="term"><tt class="literal">fromfax</tt></span></dt> +<dd><a id="id2547597" class="indexterm"></a> +<p>Sender's fax number</p></dd> +<dt> +<span class="term"><tt class="literal">fromlogo</tt></span></dt> +<dd><a id="id2547630" class="indexterm"></a> +<p>Commands for inserting the sender's logo</p></dd> +<dt> +<span class="term"><tt class="literal">fromname</tt></span></dt> +<dd><a id="id2547663" class="indexterm"></a> +<p>Complete name of the sender</p></dd> +<dt> +<span class="term"><tt class="literal">fromphone</tt></span></dt> +<dd><a id="id2547696" class="indexterm"></a> +<p>Sender's telephone number</p></dd> +<dt><span class="term"><tt class="literal">fromurl</tt></span></dt> +<dd><a id="id2547728" class="indexterm"></a> +<p>URL of the sender</p></dd> +<dt><span class="term"><tt class="literal">invoice</tt></span></dt> +<dd><a id="id2547761" class="indexterm"></a> +<p>Invoice number</p></dd> +<dt> +<span class="term"><tt class="literal">location</tt></span></dt> +<dd><a id="id2547794" class="indexterm"></a> +<p>More details of the sender</p></dd> +<dt><span class="term"><tt class="literal">myref</tt></span></dt> +<dd><a id="id2547827" class="indexterm"></a> +<p>Sender's reference</p></dd> +<dt><span class="term"><tt class="literal">place</tt></span></dt> +<dd><a id="id2547859" class="indexterm"></a> +<p>Place</p></dd> +<dt> +<span class="term"><tt class="literal">placeseparator</tt></span></dt> +<dd><a id="id2547892" class="indexterm"></a> +<p>Separator between place and date</p></dd> +<dt> +<span class="term"><tt class="literal">phoneseparator</tt></span></dt> +<dd><a id="id2547925" class="indexterm"></a> +<p>Separator between title of telephone and telephone +number</p></dd> +<dt> +<span class="term"><tt class="literal">signature</tt></span></dt> +<dd><a id="id2547959" class="indexterm"></a> +<p>Signature beneath the ending of the letter</p></dd> +<dt> +<span class="term"><tt class="literal">specialmail</tt></span></dt> +<dd><a id="id2547992" class="indexterm"></a> +<p>Special mail</p></dd> +<dt><span class="term"><tt class="literal">subject</tt></span></dt> +<dd><a id="id2548025" class="indexterm"></a> +<p>Subject</p></dd> +<dt> +<span class="term"><tt class="literal">subjectseparator</tt></span></dt> +<dd><a id="id2548058" class="indexterm"></a> +<p>Separator between title of subject and subject</p></dd> +<dt><span class="term"><tt class="literal">title</tt></span></dt> +<dd><a id="id2548091" class="indexterm"></a> +<p>Letter title</p></dd> +<dt><span class="term"><tt class="literal">toname</tt></span></dt> +<dd><a id="id2548124" class="indexterm"></a> +<p>Complete name of recipient</p></dd> +<dt> +<span class="term"><tt class="literal">toaddress</tt></span></dt> +<dd><a id="id2548156" class="indexterm"></a> +<p>Address of recipient without its name</p></dd> +<dt> +<span class="term"><tt class="literal">yourmail</tt></span></dt> +<dd><a id="id2548190" class="indexterm"></a> +<p>Date of recipient's mail</p></dd> +<dt><span class="term"><tt class="literal">yourref</tt></span></dt> +<dd><a id="id2548222" class="indexterm"></a> +<p>Recipient's reference</p></dd></dl></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\setkomavar{name}[description]{content}</tt>,</span> +<span class="term"><tt class="literal">\setkomavar*{name}{description}</tt>,</span></dt> +<dd><a id="id2548272" class="indexterm"></a> +<p><tt class="literal">\setkomavar</tt> sets the content of the +variable <tt class="literal">name</tt>. The optional argument sets +the <tt class="literal">description</tt> of the variable.</p> +<p><tt class="literal">\setkomavar*</tt> only sets the +<tt class="literal">description</tt>.</p></dd></dl></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\usekomavar[command]{name}</tt>,</span> +<span class="term"><tt class="literal">\usekomavar*[command]{name}</tt>,</span></dt> +<dd><a id="id2548353" class="indexterm"></a> +<p><tt class="literal">\usekomavar</tt> gives you access to the +content of the variable <tt class="literal">name</tt>.</p> +<p><tt class="literal">\usekomavar*</tt> gives you access to the +<tt class="literal">description</tt> of the variable +<tt class="literal">name</tt>.</p></dd></dl></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\ifkomavarempty{name}{true}{false}</tt>,</span> +<span class="term"><tt class="literal">\ifkomavarempty*{name}{true}{false}</tt>,</span></dt> +<dd><a id="id2548434" class="indexterm"></a> +<p>The <tt class="literal">true</tt> argument will be executed if +the content or description is empty. Otherwise the +<tt class="literal">false</tt> argument will be executed.</p> +<p>The starred version handles the description of a variable, the +variant without star the content.</p></dd></dl></div> +<h5 class="title"><a id="id2548477"></a>Pseudo Lengths</h5> +<a id="id2548483" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\@newplength{name}</tt></span></dt> +<dd>Defines a new pseudo length</dd> +<dt> +<span class="term"><tt class="literal">\useplength{name}</tt></span></dt> +<dd>Access value of pseudo length +<tt class="literal">name</tt></dd> +<dt> +<span class="term"><tt class="literal">\setlengthtoplength[factor]{length}{pseudo +length}</tt> ,</span> +<span class="term"><tt class="literal">\addtolengthplength[factor]{length}{pseudo +length}</tt> ,</span></dt> +<dd>Assign a multiple of <tt class="literal">pseudo length</tt> to +a real <tt class="literal">length</tt>. Adds a multiple of +<tt class="literal">pseudo length</tt> to +<tt class="literal">length</tt>.</dd> +<dt> +<span class="term"><tt class="literal">\@setplength[factor]{pseudo +length}{value}</tt> ,</span> +<span class="term"><tt class="literal">\@addtoplength[factor]{pseudo +length}{value}</tt> ,</span></dt> +<dd>Assign a multiple of a <tt class="literal">value</tt> to a +<tt class="literal">pseudo length</tt>. Adds +<tt class="literal">value</tt> to <tt class="literal">pseudo +length</tt>.</dd></dl></div> +<h5 class="title"><a id="id2548654"></a>Letter Declaration</h5> +<a id="id2548663" class="indexterm"></a> +<h5 class="title"><a id="id2548679"></a>Letterhead</h5> +<a id="id2548685" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">firstheadvpos</tt></span></dt> +<dd>Distance between the top of the sheet and the letterhead.</dd> +<dt> +<span class="term"><tt class="literal">firstheadwidth</tt></span></dt> +<dd>Width of the letterhead.</dd> +<dt><span class="term"><tt class="literal">fromname</tt>,</span> +<span class="term"><tt class="literal">fromaddress</tt>,</span> +<span class="term"><tt class="literal">fromphone</tt>,</span> +<span class="term"><tt class="literal">fromfax</tt>,</span> +<span class="term"><tt class="literal">fromemail</tt>,</span> +<span class="term"><tt class="literal">fromurl</tt>,</span> +<span class="term"><tt class="literal">fromlogo</tt>,</span></dt> +<dd>This variables give all statements concerning the sender +necessary to create the letterhead.</dd> +<dt> +<span class="term"><tt class="literal">phoneseparator</tt>,</span> +<span class="term"><tt class="literal">faxseparator</tt>,</span> +<span class="term"><tt class="literal">emailseparator</tt>,</span> +<span class="term"><tt class="literal">urlseparator</tt>,</span></dt> +<dd>Separators for variables in letterhead.</dd> +<dt> +<span class="term"><tt class="literal">\firsthead{construction}</tt></span></dt> +<dd>Create letterhead freely.</dd></dl></div> +<h5 class="title"><a id="id2548859"></a>Footer</h5> +<a id="id2548865" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">firstfootvpos</tt></span></dt> +<dd>Distance between footer and upper border of the sheet.</dd> +<dt> +<span class="term"><tt class="literal">firstfootwidth</tt></span></dt> +<dd>Width of letter's firstpage footer.</dd> +<dt> +<span class="term"><tt class="literal">\firstfoot{Construction}</tt></span></dt> +<dd>Set definition for first page's footer</dd></dl></div> +<h5 class="title"><a id="id2548942"></a>Address</h5> +<a id="id2548948" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">toaddrvpos</tt>,</span> +<span class="term"><tt class="literal">toaddrhpos</tt>,</span></dt> +<dd>Distance between address window of a window envelope and the +upper and left border of the sheet.</dd> +<dt> +<span class="term"><tt class="literal">toaddrwidth</tt></span></dt> +<dd>Width of the address window.</dd> +<dt> +<span class="term"><tt class="literal">toaddrindent</tt></span></dt> +<dd>Value of indentation for the address from the left border.</dd> +<dt><span class="term"><tt class="literal">backaddress</tt>,</span> +<span class="term"><tt class="literal">backaddressseparator</tt>,</span> +<span class="term"><tt class="literal">backaddrheight</tt>,</span></dt> +<dd>Double backslashes within return address will be exchanged with +<tt class="literal">backaddressseparator</tt>. Height of the return +address field.</dd> +<dt><span class="term"><tt class="literal">specialmail</tt>,</span> +<span class="term"><tt class="literal">specialmailindent</tt>,</span> +<span class="term"><tt class="literal">specialmailrightindent</tt>,</span></dt> +<dd>Optionally set between return address and addressee. +<tt class="literal">specialmailindent</tt> and +<tt class="literal">specialmailrightindent</tt> determine left and +right indentation.</dd> +<dt><span class="term"><tt class="literal">toname</tt>,</span> +<span class="term"><tt class="literal">toaddress</tt>,</span></dt> +<dd>Usually not set directly by the user.</dd> +<dt> +<span class="term"><tt class="literal">\begin{letter}[options]{address}</tt></span></dt> +<dd>Major point of the letter class.</dd> +<dt> +<span class="term"><tt class="literal">\AtBeginLetter{command}</tt></span></dt> +<dd>Hook for commands run at begin of a letter.</dd></dl></div> +<h5 class="title"><a id="id2549175"></a>Sender's Extension</h5> +<a id="id2549181" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">locwidth</tt></span></dt> +<dd>Declares width of sender's extensions.</dd> +<dt> +<span class="term"><tt class="literal">location</tt></span></dt> +<dd>Content of sender's extension.</dd></dl></div> +<h5 class="title"><a id="scrlttr-business-line"></a>Business +Line</h5> +<a id="id2549251" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">refvpos</tt></span></dt> +<dd>Distance between upper border of sheet and business line.</dd> +<dt> +<span class="term"><tt class="literal">refwidth</tt></span></dt> +<dd>Available width for the business line.</dd> +<dt> +<span class="term"><tt class="literal">refaftervskip</tt></span></dt> +<dd>Vertical space to be inserted beneath business line.</dd> +<dt><span class="term"><tt class="literal">place</tt>,</span> +<span class="term"><tt class="literal">placeseparator</tt>,</span></dt> +<dd>If all variables for business line are empty, the content of +<tt class="literal">place</tt> and +<tt class="literal">placeseparator</tt> will be set, followed by +content of <tt class="literal">date</tt>.</dd> +<dt><span class="term"><tt class="literal">yourref</tt>,</span> +<span class="term"><tt class="literal">yourmail</tt>,</span> +<span class="term"><tt class="literal">myref</tt>,</span> +<span class="term"><tt class="literal">customer</tt>,</span> +<span class="term"><tt class="literal">invoice</tt>,</span> +<span class="term"><tt class="literal">date</tt>,</span></dt> +<dd>Typical fields for business lines.</dd></dl></div> +<h5 class="title"><a id="id2549423"></a>Title and Subject Line</h5> +<a id="id2549428" class="indexterm"></a><a id="id2549444" +class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">title</tt></span></dt> +<dd>Additional tile. Set centered beneath the business line.</dd> +<dt><span class="term"><tt class="literal">subject</tt>,</span> +<span class="term"><tt class="literal">subjectseparator</tt>,</span></dt> +<dd>Set the subject of the letter, optional prefixed by a +label.</dd></dl></div> +<h5 class="title"><a id="id2549511"></a>Further Issues</h5> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">tfoldmarkvpos</tt>,</span> +<span class="term"><tt class="literal">bfoldmarkvpos</tt>,</span></dt> +<dd>Position of upper and lower fold mark.</dd> +<dt> +<span class="term"><tt class="literal">foldmarkhpos</tt></span></dt> +<dd>Distance between fold marks and the sheet's left border.</dd> +<dt> +<span class="term"><tt class="literal">frombank</tt></span></dt> +<dd>Internally not used yet.</dd> +<dt> +<span class="term"><tt class="literal">\nexthead{construction}</tt>,</span> +<span class="term"><tt class="literal">\nextfoot{construction}</tt>,</span></dt> +<dd>Create letter head or foot for the following pages +freely.</dd></dl></div> +<h5 class="title"><a id="id2549610"></a>The Text</h5> +<a id="id2549615" class="indexterm"></a> +<h5 class="title"><a id="id2549631"></a>Opening</h5> +<a id="id2549637" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\opening{opening}</tt></span></dt> +<dd>Set the opening of the letter.</dd></dl></div> +<h5 class="title"><a id="id2549676"></a>Footnotes</h5> +<a id="id2549682" class="indexterm"></a> +<p>See section <span class="emphasis"><em>Footnotes</em></span> in +KOMA-Script (still to be written).</p> +<h5 class="title"><a id="id2549706"></a>Lists</h5> +<a id="id2549712" class="indexterm"></a> +<p>See section <span class="emphasis"><em>Lists</em></span> in +KOMA-Script (still to be written).</p> +<h5 class="title"><a id="id2549736"></a>Margin Notes</h5> +<a id="id2549742" class="indexterm"></a> +<p>See section <span class="emphasis"><em>Margin Notes</em></span> +in KOMA-Script (still to be written).</p> +<h5 class="title"><a id="id2549766"></a>Text Emphasis</h5> +<a id="id2549772" class="indexterm"></a> +<p>See section <span class="emphasis"><em>Logical Markup of +Text</em></span> in KOMA-Script (still to be written).</p> +<h5 class="title"><a id="id2549796"></a>Closing Part</h5> +<a id="id2549802" class="indexterm"></a> +<h5 class="title"><a id="id2549818"></a>Closing</h5> +<a id="id2549823" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">signature</tt></span></dt> +<dd>Inlcudes an explanation for the inscription. Defaults to +<tt class="literal">\usekomavar{fromname}</tt>.</dd> +<dt><span class="term"><tt class="literal">\closing{closing +phrase}</tt></span></dt> +<dd>Typesets the colsing phrase follwoed by a vertical space and +the contents fo variable <tt class="literal">signature</tt>.</dd> +<dt><span class="term"><tt class="literal">sigindent</tt>,</span> +<span class="term"><tt class="literal">sigbeforevskip</tt>,</span> +<span class="term"><tt class="literal">\raggedsignature</tt>,</span></dt> +<dd>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.</dd></dl></div> +<h5 class="title"><a id="id2549930"></a>Postscript, Carbon Copy, +and Enclosures</h5> +<a id="id2549937" class="indexterm"></a><a id="id2549952" +class="indexterm"></a><a id="id2549968" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\ps</tt></span></dt> +<dd>Set a postscript.</dd> +<dt><span class="term"><tt class="literal">\cc{distribution +list}</tt>,</span> +<span class="term"><tt class="literal">ccseparator</tt>,</span></dt> +<dd>Set a ddistribution list. If the contents of +<tt class="literal">ccseparator</tt> isn't empty then the name and +the content of the variable is inserted prior to distribution +list.</dd> +<dt> +<span class="term"><tt class="literal">\encl{enclosures}</tt>,</span> +<span class="term"><tt class="literal">enclseparator</tt>,</span></dt> +<dd>Same structur as the distribution list.</dd></dl></div> +<h5 class="title"><a id="id2550066"></a>Language Support</h5> +<a id="id2550072" class="indexterm"></a> +<h5 class="title"><a id="id2550088"></a>Language Selection</h5> +<a id="id2550094" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\captionenglish</tt>,</span> +<span class="term"><tt class="literal">\captionUSenglish</tt>,</span> +<span class="term"><tt class="literal">\captionamerican</tt>,</span> +<span class="term"><tt class="literal">\captionbritish</tt>,</span> +<span class="term"><tt class="literal">\captionUKenglish</tt>,</span> +<span class="term"><tt class="literal">\captiongerman</tt>,</span> +<span class="term"><tt class="literal">\captionngerman</tt>,</span> +<span class="term"><tt class="literal">\captionaustrian</tt>,</span> +<span class="term"><tt class="literal">\captionfrench</tt>,</span> +<span class="term"><tt class="literal">\captionitalian</tt>,</span> +<span class="term"><tt class="literal">\captionspanish</tt>,</span> +<span class="term"><tt class="literal">\captiondutch</tt>,</span> +<span class="term"><tt class="literal">\captioncroatian</tt>,</span></dt> +<dd>If the used language selection scheme does not support +switching the language the above commands can be used +directly.</dd> +<dt> +<span class="term"><tt class="literal">\dateenglish</tt>,</span> +<span class="term"><tt class="literal">\dateUSenglish</tt>,</span> +<span class="term"><tt class="literal">\dateamerican</tt>,</span> +<span class="term"><tt class="literal">\datebritish</tt>,</span> +<span class="term"><tt class="literal">\dateUKenglish</tt>,</span> +<span class="term"><tt class="literal">\dategerman</tt>,</span> +<span class="term"><tt class="literal">\datengerman</tt>,</span> +<span class="term"><tt class="literal">\dateaustrian</tt>,</span> +<span class="term"><tt class="literal">\datefrench</tt>,</span> +<span class="term"><tt class="literal">\dateitalian</tt>,</span> +<span class="term"><tt class="literal">\datespanish</tt>,</span> +<span class="term"><tt class="literal">\datedutch</tt>,</span> +<span class="term"><tt class="literal">\datecrotian</tt>,</span></dt> +<dd>Numerical date representation.</dd></dl></div> +<h5 class="title"><a id="id2550325"></a>Language-Dependent +Terms</h5> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\yourrefname</tt>,</span> +<span class="term"><tt class="literal">\youremailname</tt>,</span> +<span class="term"><tt class="literal">\myrefname</tt>,</span> +<span class="term"><tt class="literal">\customername</tt>,</span> +<span class="term"><tt class="literal">\invoicename</tt>,</span> +<span class="term"><tt class="literal">\subjectname</tt>,</span> +<span class="term"><tt class="literal">\ccname</tt>,</span> +<span class="term"><tt class="literal">\enclname</tt>,</span> +<span class="term"><tt class="literal">\headtoname</tt>,</span> +<span class="term"><tt class="literal">\headfromname</tt>,</span> +<span class="term"><tt class="literal">\datename</tt>,</span> +<span class="term"><tt class="literal">\pagename</tt>,</span> +<span class="term"><tt class="literal">\phonename</tt>,</span> +<span class="term"><tt class="literal">\faxname</tt>,</span> +<span class="term"><tt class="literal">\emailname</tt>,</span> +<span class="term"><tt class="literal">\wwwname</tt>,</span> +<span class="term"><tt class="literal">\bankname</tt>,</span></dt> +<dd>These defintions can be modified to support a new language of +for private customization.</dd></dl></div> +<h5 class="title"><a id="id2550468"></a>Defining Language +Terms</h5> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\providecaptioname{language}{term}{definition}</tt>,</span> +<span class="term"><tt class="literal">\newcaptioname{language}{term}{defintion}</tt>,</span> +<span class="term"><tt class="literal">\renewcaptionname{language}{term}{definition}</tt>,</span></dt> +<dd>Assign a <span class="emphasis"><em>definition</em></span> for +a <span class="emphasis"><em>language</em></span> to a +<span class="emphasis"><em>term</em></span>.</dd></dl></div> +<h5 class="title"><a id="id2550526"></a>Address Files and Circular +Letters</h5> +<a id="id2550533" class="indexterm"></a><a id="id2550549" +class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\adrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{Comment}{Key}</tt></span></dt> +<dd>Address entry for address files. The file extension has to be +<tt class="literal">.adr</tt>!</dd> +<dt> +<span class="term"><tt class="literal">\addrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{F3}{F4}{Key}</tt></span></dt> +<dd>This command supports four freely definable parameters for an +address entry.</dd> +<dt><span class="term"><tt class="literal">\adrchar{initial +letter}</tt>,</span> +<span class="term"><tt class="literal">\addrchar{initial +letter}</tt>,</span></dt> +<dd>Separator for address entries. Ignored by +<tt class="literal">scrlttr2</tt>.</dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="komascript-scraddr"></a>3.9.4 Address +Files with <tt class="literal">scraddr</tt></h4></div></div></div> +<a id="id2550668" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\InputAddressFile{file +name}</tt></span></dt> +<dd><a id="id2550698" class="indexterm"></a> +<p>Read the contents of the given address file. Filename extension +has to be <tt class="literal">.adr</tt> and has to be omitted in +the argument.</p></dd> +<dt><span class="term"><tt class="literal">\Name{Key}</tt>,</span> +<span class="term"><tt class="literal">\FirstName{Key}</tt>,</span> +<span class="term"><tt class="literal">\LastName{Key}</tt>,</span> +<span class="term"><tt class="literal">\Address{Key}</tt>,</span> +<span class="term"><tt class="literal">\Telephone{Key}</tt>,</span> +<span class="term"><tt class="literal">\FreeI{Key}</tt>,</span> +<span class="term"><tt class="literal">\FreeII{Key}</tt>,</span> +<span class="term"><tt class="literal">\Comment{Key}</tt>,</span> +<span class="term"><tt class="literal">\FreeIII{Key}</tt>,</span> +<span class="term"><tt class="literal">\FreeIV{Key}</tt>,</span></dt> +<dd><a id="id2550801" class="indexterm"></a><a id="id2550817" +class="indexterm"></a><a id="id2550833" +class="indexterm"></a><a id="id2550849" +class="indexterm"></a><a id="id2550865" +class="indexterm"></a><a id="id2550881" +class="indexterm"></a><a id="id2550897" +class="indexterm"></a><a id="id2550912" +class="indexterm"></a><a id="id2550928" +class="indexterm"></a><a id="id2550944" class="indexterm"></a> +<p>Access to the data in address file. +<tt class="literal">\Name</tt> is a concatenation of +<tt class="literal">\FirstName</tt> and +<tt class="literal">\LastName</tt>.</p></dd> +<dt> +<span class="term"><tt class="literal">AdrFreeIVempty</tt>,</span> +<span class="term"><tt class="literal">AdrFreeIVshow</tt>,</span> +<span class="term"><tt class="literal">AdrFreeIVwarn</tt>,</span> +<span class="term"><tt class="literal">AdrFreeIVstop</tt>,</span></dt> +<dd>Package warning options. Defaults to +<tt class="literal">AdrFreeIVshow</tt>.</dd></dl></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="mathpazo"></a>3.10 +<tt class="filename">mathpazo</tt></h3></div></div></div> +<a id="id2551052" class="indexterm"></a><a id="id2551059" +class="indexterm"></a> +<p>Math fonts for the use with the Palatino font.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="upDelta-upOmega"></a>3.10.1 \upDelta / +\upOmega</h4></div></div></div> +<a id="id2551091" class="indexterm"></a><a id="id2551098" +class="indexterm"></a> +<p>Math fonts for the use with the Palatino font.</p> +<p>Package options are:</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">[slantedGreek]</tt></span></dt> +<dd> +<p>Uppercase Greek will be typeset slanted.</p></dd> +<dt> +<span class="term"><tt class="literal">[noBBpl]</tt></span></dt> +<dd> +<p>Do not use PazoMathBlackboardBold as (partial) blackboard bold +font (e.g with <tt class="literal">\mathbb{R}</tt>).</p></dd> +<dt><span class="term"><tt class="literal">[osf]</tt></span></dt> +<dd> +<p>Make the font family <tt class="literal">pplj</tt> (Palatino +with old style numerals) the default roman font, and use an +alternative version of the virtual math italic fonts +(<tt class="literal">zplmrj7m</tt> and +<tt class="literal">zplmbj7m</tt>) with upright Palatino old style +numerals for use with the <tt class="literal">\oldstylenums</tt> +command.</p></dd> +<dt> +<span class="term"><tt class="literal">[osfeqnnum]</tt></span></dt> +<dd> +<p>Use old style numerals for equation +numbering.</p></dd></dl></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="varioref"></a>3.11 +<tt class="filename">varioref</tt></h3></div></div></div> +<a id="id2551242" class="indexterm"></a><a id="id2551249" +class="indexterm"></a> +<p>Smarter version of the original latex2e +<a href="#cross-references" title="2.3.2 Cross References">cross +reference commands</a>. Generated strings are customizable, Babel +options are recognized (further info in the package +documentation).</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><a id="cmd-vref"></a><tt class="literal">\vref</tt>,</span> +<span class="term"><a id="cmd-vpageref"></a><tt class="literal">\vpageref</tt>,</span></dt> +<dd><a id="id2551309" class="indexterm"></a><a id="id2551318" +class="indexterm"></a> +<p><tt class="literal">\vref</tt> is similar to +<tt class="literal">\ref</tt> but adds an additional page +reference, like <span class="emphasis"><em>on the facing +page</em></span> or <span class="emphasis"><em>on page +27</em></span> whenever the corresponding +<a href="#cmd-label-title"><tt class="filename">\label</tt></a> is +not on the same page.</p> +<p><tt class="literal">\vpageref</tt> is a variation of +<tt class="literal">\pageref</tt> with similar +functionality.</p></dd> +<dt><span class="term"><tt class="literal">\vrefrange</tt>,</span> +<span class="term"><tt class="literal">\vpagerefrange</tt>,</span></dt> +<dd><a id="id2551398" class="indexterm"></a><a id="id2551407" +class="indexterm"></a> +<p>The <tt class="literal">\v...range</tt> 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.</p></dd> +<dt><span class="term"><tt class="literal">\vref*</tt>,</span> +<span class="term"><tt class="literal">\vpageref*</tt>,</span> +<span class="term"><tt class="literal">\vpagerefrange*</tt>,</span></dt> +<dd> +<p>Star * variants do not add any space before the generated text +for situations like:</p> +<pre class="programlisting"> +(\vref{foo} ...) +</pre></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="small-packages"></a>3.12 Several Small +Packages</h3></div></div></div> +<a id="id2551486" class="indexterm"></a><a id="id2551493" +class="indexterm"></a><a id="id2551500" class="indexterm"></a> +<p>Must be loaded with the usual +<a href="#usepackage-linkend"><tt class="literal">\usepackage</tt></a> +command. Further info for a package to be found in the +documentation (dvi, pdf, ps) or in the +<tt class="literal">sty</tt>-file itself.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bm-package"></a>3.12.1 +<tt class="filename">bm</tt></h4></div></div></div> +<a id="id2551555" class="indexterm"></a><a id="id2551564" +class="indexterm"></a><a id="id2551576" class="indexterm"></a> +<p>Bold math symbols or equations with better spacing then the +<tt class="literal">\boldsymbold</tt> command. <a id="id2551598" +class="indexterm"></a> If possible load after other packages which +redefine the fonts. When no bold font is available for a certain +char <tt class="literal">bm</tt> will use +<span class="emphasis"><em>poor man's bold</em></span> +<a href="#pmb-linkend"><tt class="literal">\pmb</tt></a>.</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><a id="cmd-bm"></a><tt class="literal">\bm</tt></span></dt> +<dd><a id="id2551652" class="indexterm"></a> +<p>Produces bold math symbol or equation.</p></dd> +<dt> +<span class="term"><tt class="literal">\unboldmath</tt></span></dt> +<dd><a id="id2551678" class="indexterm"></a> +<p>Can be used to set parts of an equation +unbold.</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="url-package"></a>3.12.2 +<tt class="filename">url</tt></h4></div></div></div> +<a id="id2551716" class="indexterm"></a><a id="id2551724" +class="indexterm"></a> +<p>Defines line breakable hyperlinked (uses <a href="#hyperref" +title="3.7 hyperref">hyperref</a> package) verbatim input for urls +and e-mail addresses.</p> +<p>Example: <tt class="literal">\url{http://example.org}</tt> +outputs <tt class="literal">http://example.org</tt>.</p> +<p>Related commands are +<a href="#href"><tt class="literal">\href</tt></a> and +<a href="#cmd-nolinkurl"><tt class="literal">\nolinkurl</tt></a>.</p></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="generic-packages"></a>4 Generic +Packages</h2></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pictex"></a>4.1 PiCTeX +(tbd.)</h3></div></div></div> +<a id="id2551827" class="indexterm"></a> +<p>tbd.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pstricks"></a>4.2 +PSTricks</h3></div></div></div> +<a id="id2551853" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="pstricks-ovw"></a>4.2.1 +Overview</h4></div></div></div> +<p>The idea behind the PSTricks package of Timothy van Zandt +<a id="id2551856" class="indexterm"></a> is to provide most of the +PostScript language in LaTeX and TeX syntax.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="pstricks-commands"></a>4.2.2 Commands and +Parameters</h4></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-color"></a>4.2.2.1 +Color</h5></div></div></div> +<a id="id2551932" class="indexterm"></a><a id="id2551948" +class="indexterm"></a><a id="id2551964" +class="indexterm"></a><a id="id2551980" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\newgray{color}{num}</tt> +,</span> +<span class="term"><tt class="literal">\newrgbcolor{color}{num1 +num2 num3}</tt> ,</span> +<span class="term"><tt class="literal">\newhsbcolor{color}{num1 +num2 num3}</tt> ,</span> +<span class="term"><tt class="literal">\newcmykcolor{color}{num1 +num2 num3 num4}</tt> ,</span></dt></dl></div> +<p>Note that these commands are obsolete for LaTeX. Load PSTricks +with <tt class="literal">\usepackage{pstcol}</tt> and use the +standard LaTeX color commands instead.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-setting"></a>4.2.2.2 Setting +graphics parameters</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\psset{par1=value1,par2=value2,...}</tt></span></dt> +<dd><a id="id2552100" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-dimensions"></a>4.2.2.3 +Dimensions, coordinates and angles</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pssetlength{cmd}{dim}</tt></span></dt> +<dd><a id="id2552152" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">unit=dim, xunit=dim, +yunit=dim, yunit=dim</tt></span></dt> +<dd><a id="id2552183" class="indexterm"></a><a id="id2552199" +class="indexterm"></a><a id="id2552215" +class="indexterm"></a><a id="id2552230" class="indexterm"></a> +<p>Default: <tt class="literal">1cm</tt></p></dd> +<dt> +<span class="term"><tt class="literal">\degrees[num]</tt></span></dt> +<dd><a id="id2552271" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\radians</tt></span></dt> +<dd><a id="id2552302" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-basic"></a>4.2.2.4 Basic graphics +parameters</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">linewidth=dim</tt></span></dt> +<dd><a id="id2552356" class="indexterm"></a> +<p>Default: <tt class="literal">.8pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">linecolor=color</tt></span></dt> +<dd><a id="id2552397" class="indexterm"></a> +<p>Default: <tt class="literal">black</tt></p></dd> +<dt> +<span class="term"><tt class="literal">showpoints=true/false</tt></span></dt> +<dd><a id="id2552437" class="indexterm"></a> +<p>Default: +<tt class="literal">false</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-lines"></a>4.2.2.5 Lines and +polygons</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">linearc=dim</tt></span></dt> +<dd><a id="id2552499" class="indexterm"></a> +<p>Default: <tt class="literal">0pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">framearc=num</tt></span></dt> +<dd><a id="id2552540" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd> +<dt> +<span class="term"><tt class="literal">cornersize=relative/absolute</tt></span></dt> +<dd><a id="id2552580" class="indexterm"></a> +<p>Default: <tt class="literal">relative</tt></p></dd> +<dt> +<span class="term"><tt class="literal">\psline*[par]{arrows}(x0,y0)(x1,y1)...(xn,yn)</tt></span></dt> +<dd><a id="id2552622" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\qline(coor0)(coor1)</tt></span></dt> +<dd><a id="id2552653" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pspolygon*[par](x0,y0)(x1,y1)(x2,y2)...(xn,yn)</tt></span></dt> +<dd><a id="id2552685" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psframe*[par](x0,y0)(x1,y1)</tt></span></dt> +<dd><a id="id2552717" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-arcs"></a>4.2.2.6 Arcs, circles +and ellipses</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pscircle*[par](x0,y0){radius}</tt></span></dt> +<dd><a id="id2552770" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\qdisk(coor){radius}</tt></span></dt> +<dd><a id="id2552801" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pswedge*[par](x0,y0){radius}{angle1}{angle2}</tt></span></dt> +<dd><a id="id2552833" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psellipse*[par](x0,y0)(x1,y1)</tt></span></dt> +<dd><a id="id2552864" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psarc*[par]{arrows}(x,y){radius}{angleA}{angleB}</tt></span></dt> +<dd><a id="id2552896" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psarcn*[par]{arrows}(x,y){radius}{angleA}{angleB}</tt></span></dt> +<dd><a id="id2552928" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">arcsep=dim, arcsepA=dim, +arcsepB=dim</tt></span></dt> +<dd><a id="id2552960" class="indexterm"></a><a id="id2552976" +class="indexterm"></a><a id="id2552992" class="indexterm"></a> +<p>Default: <tt class="literal">0pt</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-curves"></a>4.2.2.7 +Curves</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\psbezier*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)(x3,y3)</tt></span></dt> +<dd><a id="id2553054" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\parabola*[par]{arrows}(x0,y0)(x1,y1)</tt></span></dt> +<dd><a id="id2553086" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pscurve*[par]{arrows}(x1,y1)...(xn,yn)</tt></span></dt> +<dd><a id="id2553118" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psecurve*[par]{arrows}(x1,y1)...(xn,yn)</tt></span></dt> +<dd><a id="id2553149" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psccurve*[par]{arrows}(x1,y1)...(xn,yn)</tt></span></dt> +<dd><a id="id2553181" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">curvature=num1 num2 +num3</tt></span></dt> +<dd><a id="id2553212" class="indexterm"></a> +<p>Default: <tt class="literal">1 .1 +0</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-dots"></a>4.2.2.8 +Dots</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\psdots*[par](x1,y1)(x2,y2)...(xn,yn)</tt></span></dt> +<dd><a id="id2553275" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">dotstyle=style</tt></span></dt> +<dd><a id="id2553306" class="indexterm"></a> +<p>Default: <tt class="literal">*</tt></p> +<p>Dots: <tt class="literal">*, o, +, triangle, triangle*, square, +square*, pentagon, pentagon*, |</tt></p></dd> +<dt><span class="term"><tt class="literal">dotscale=num1 +num2</tt></span></dt> +<dd><a id="id2553356" class="indexterm"></a> +<p>Default: <tt class="literal">1</tt></p></dd> +<dt> +<span class="term"><tt class="literal">dotangle=angle</tt></span></dt> +<dd><a id="id2553396" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-grids"></a>4.2.2.9 +Grids</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\psgrid(x0,y0)(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2553459" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">gridwidth=dim</tt></span></dt> +<dd><a id="id2553490" class="indexterm"></a> +<p>Default: <tt class="literal">.8pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gridcolor=color</tt></span></dt> +<dd><a id="id2553530" class="indexterm"></a> +<p>Default: <tt class="literal">black</tt></p></dd> +<dt> +<span class="term"><tt class="literal">griddots=num</tt></span></dt> +<dd><a id="id2553569" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gridlabels=dim</tt></span></dt> +<dd><a id="id2553608" class="indexterm"></a> +<p>Default: <tt class="literal">10pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gridlabelcolor=color</tt></span></dt> +<dd><a id="id2553647" class="indexterm"></a> +<p>Default: <tt class="literal">black</tt></p></dd> +<dt> +<span class="term"><tt class="literal">subgriddiv=int</tt></span></dt> +<dd><a id="id2553687" class="indexterm"></a> +<p>Default: <tt class="literal">5</tt></p></dd> +<dt> +<span class="term"><tt class="literal">subgridwidth=dim</tt></span></dt> +<dd><a id="id2553726" class="indexterm"></a> +<p>Default: <tt class="literal">.4pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">subgridcolor=color</tt></span></dt> +<dd><a id="id2553766" class="indexterm"></a> +<p>Default: <tt class="literal">gray</tt></p></dd> +<dt> +<span class="term"><tt class="literal">subgriddots=num</tt></span></dt> +<dd><a id="id2553805" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-plots"></a>4.2.2.10 +Plots</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\fileplot*[par]{file}</tt></span></dt> +<dd><a id="id2553866" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\dataplot*[par]{commands}</tt></span></dt> +<dd><a id="id2553898" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\savedata{command}[data]</tt></span></dt> +<dd><a id="id2553929" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\readdata{command}{file}</tt></span></dt> +<dd><a id="id2553961" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\listplot*[par]{list}</tt></span></dt> +<dd><a id="id2553992" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psplot*[par]{xmin}{xmax}{function}</tt></span></dt> +<dd><a id="id2554024" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\parametricplot*[par]{tmin}{tmax}{function}</tt></span></dt> +<dd><a id="id2554056" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">plotstyle=style</tt></span></dt> +<dd><a id="id2554087" class="indexterm"></a> +<p>Default: <tt class="literal">line</tt></p></dd> +<dt> +<span class="term"><tt class="literal">plotpoints=int</tt></span></dt> +<dd><a id="id2554126" class="indexterm"></a> +<p>Default: <tt class="literal">50</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-coordinate"></a>4.2.2.11 +Coordinate systems</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">origin={coor}</tt></span></dt> +<dd><a id="id2554188" class="indexterm"></a> +<p>Default: <tt class="literal">0pt,0pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">swapaxes=true</tt></span></dt> +<dd><a id="id2554228" class="indexterm"></a> +<p>Default: +<tt class="literal">false</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-line-styles"></a>4.2.2.12 Line +styles</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">linestyle=style</tt></span></dt> +<dd><a id="id2554289" class="indexterm"></a> +<p>Default: <tt class="literal">solid</tt></p></dd> +<dt><span class="term"><tt class="literal">dash=dim1 +dim2</tt></span></dt> +<dd><a id="id2554328" class="indexterm"></a> +<p>Default: <tt class="literal">5pt 3pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">dotsep=dim</tt></span></dt> +<dd><a id="id2554368" class="indexterm"></a> +<p>Default: <tt class="literal">3pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">border=dim</tt></span></dt> +<dd><a id="id2554407" class="indexterm"></a> +<p>Default: <tt class="literal">0pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">bordercolor=color</tt></span></dt> +<dd><a id="id2554446" class="indexterm"></a> +<p>Default: <tt class="literal">white</tt></p></dd> +<dt> +<span class="term"><tt class="literal">doubleline=true/false</tt></span></dt> +<dd><a id="id2554485" class="indexterm"></a> +<p>Default: <tt class="literal">false</tt></p></dd> +<dt> +<span class="term"><tt class="literal">doublesep=dim</tt></span></dt> +<dd><a id="id2554524" class="indexterm"></a> +<p>Default: <tt class="literal">1.25\pslinewidth</tt></p></dd> +<dt> +<span class="term"><tt class="literal">doublecolor=color</tt></span></dt> +<dd><a id="id2554564" class="indexterm"></a> +<p>Default: <tt class="literal">white</tt></p></dd> +<dt> +<span class="term"><tt class="literal">shadow=true/false</tt></span></dt> +<dd><a id="id2554604" class="indexterm"></a> +<p>Default: <tt class="literal">false</tt></p></dd> +<dt> +<span class="term"><tt class="literal">shadowsize=dim</tt></span></dt> +<dd><a id="id2554643" class="indexterm"></a> +<p>Default: <tt class="literal">3pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">shadowangle=angle</tt></span></dt> +<dd><a id="id2554683" class="indexterm"></a> +<p>Default: <tt class="literal">-45</tt></p></dd> +<dt> +<span class="term"><tt class="literal">shadowcolor=color</tt></span></dt> +<dd><a id="id2554722" class="indexterm"></a> +<p>Default: <tt class="literal">darkgray</tt></p></dd> +<dt> +<span class="term"><tt class="literal">dimen=outer/inner/middle</tt></span></dt> +<dd><a id="id2554761" class="indexterm"></a> +<p>Default: +<tt class="literal">outer</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-fill-styles"></a>4.2.2.13 Fill +styles</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">fillstyle=style</tt></span></dt> +<dd><a id="id2554823" class="indexterm"></a> +<p>Default: <tt class="literal">none</tt></p></dd> +<dt> +<span class="term"><tt class="literal">fillcolor=color</tt></span></dt> +<dd><a id="id2554862" class="indexterm"></a> +<p>Default: <tt class="literal">white</tt></p></dd> +<dt> +<span class="term"><tt class="literal">hatchwidth=dim</tt></span></dt> +<dd><a id="id2554902" class="indexterm"></a> +<p>Default: <tt class="literal">.8pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">hatchsep=dim</tt></span></dt> +<dd><a id="id2554941" class="indexterm"></a> +<p>Default: <tt class="literal">4pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">hatchcolor=color</tt></span></dt> +<dd><a id="id2554981" class="indexterm"></a> +<p>Default: <tt class="literal">black</tt></p></dd> +<dt> +<span class="term"><tt class="literal">hatchangle=rot</tt></span></dt> +<dd><a id="id2555020" class="indexterm"></a> +<p>Default: <tt class="literal">45</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-arrowheads"></a>4.2.2.14 +Arrowheads and such</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">arrows=style</tt></span></dt> +<dd><a id="id2555080" class="indexterm"></a> +<p>Default: <tt class="literal">-</tt></p> +<p>Arrows: <tt class="literal">-, <->, >-<, +<<->>, >>-<<, |-|, |*-|*, [-], (-), o-o, +*-*, oo-oo, **-**, c-c, cc-cc, C-C</tt></p></dd> +<dt><span class="term"><tt class="literal">arrowsize=dim +num</tt></span></dt> +<dd><a id="id2555133" class="indexterm"></a> +<p>Default: <tt class="literal">2pt 3</tt></p></dd> +<dt> +<span class="term"><tt class="literal">arrowlength=num</tt></span></dt> +<dd><a id="id2555172" class="indexterm"></a> +<p>Default: <tt class="literal">1.4</tt></p></dd> +<dt> +<span class="term"><tt class="literal">arrowinset=num</tt></span></dt> +<dd><a id="id2555211" class="indexterm"></a> +<p>Default: <tt class="literal">.4</tt></p></dd> +<dt><span class="term"><tt class="literal">tbarsize=dim +num</tt></span></dt> +<dd><a id="id2555250" class="indexterm"></a> +<p>Default: <tt class="literal">2pt 5</tt></p></dd> +<dt><span class="term"><tt class="literal">bracketlength=num, +rbracketlength=num</tt></span></dt> +<dd><a id="id2555290" class="indexterm"></a><a id="id2555306" +class="indexterm"></a> +<p>Default: <tt class="literal">.15</tt></p></dd> +<dt><span class="term"><tt class="literal">dotsize=dim +num</tt></span></dt> +<dd><a id="id2555346" class="indexterm"></a> +<p>Default: <tt class="literal">.5pt 2.5</tt></p></dd> +<dt><span class="term"><tt class="literal">arrowscale=num1 +num2</tt></span></dt> +<dd><a id="id2555385" class="indexterm"></a> +<p>Default: <tt class="literal">1</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-custom"></a>4.2.2.15 Custom +styles</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\newpsobject{name}{object}{par1=value1,...}</tt></span></dt> +<dd><a id="id2555446" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\newpsstyle{name}{par1=value1,...}</tt></span></dt> +<dd><a id="id2555478" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-basics"></a>4.2.2.16 The +basics</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pscustom*[par]{commands}</tt></span></dt> +<dd><a id="id2555530" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-parameters"></a>4.2.2.17 +Parameters</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">linetype=int</tt></span></dt> +<dd><a id="id2555583" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-graphics-objects"></a>4.2.2.18 +Graphics objects</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">liftpen=0/1/2</tt></span></dt> +<dd><a id="id2555644" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="safe-tricks"></a>4.2.2.19 Safe +tricks</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\newpath</tt></span></dt> +<dd><a id="id2555705" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\moveto(coor)</tt></span></dt> +<dd><a id="id2555736" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\closepath</tt></span></dt> +<dd><a id="id2555767" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\stroke[par]</tt></span></dt> +<dd><a id="id2555798" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\fill[par]</tt></span></dt> +<dd><a id="id2555830" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\gsave</tt></span></dt> +<dd><a id="id2555861" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\grestore</tt></span></dt> +<dd><a id="id2555892" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\translate(coor)</tt></span></dt> +<dd><a id="id2555923" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\scale{num1 +num2}</tt></span></dt> +<dd><a id="id2555955" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\rotate{angle}</tt></span></dt> +<dd><a id="id2555986" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\swapaxes</tt></span></dt> +<dd><a id="id2556017" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\msave</tt></span></dt> +<dd><a id="id2556048" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\mrestore</tt></span></dt> +<dd><a id="id2556080" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\openshadow[par]</tt></span></dt> +<dd><a id="id2556111" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\closedshadow[par]</tt></span></dt> +<dd><a id="id2556142" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\movepath(coor)</tt></span></dt> +<dd><a id="id2556174" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pretty-safe-tricks"></a>4.2.2.20 Pretty +safe tricks</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\lineto(coor)</tt></span></dt> +<dd><a id="id2556226" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\rlineto(coor)</tt></span></dt> +<dd><a id="id2556258" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\curveto(x1,y1)(x2,y2)(x3,y3)</tt></span></dt> +<dd><a id="id2556289" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\rcurveto(x1,y1)(x2,y2)(x3,y3)</tt></span></dt> +<dd><a id="id2556320" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="hackers"></a>4.2.2.21 For hackers +only</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\code{code}</tt></span></dt> +<dd><a id="id2556373" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\dim{dim}</tt></span></dt> +<dd><a id="id2556404" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\coor(x1,y1)(x2,y2)...(xn,yn)</tt></span></dt> +<dd><a id="id2556436" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\rcoor(x1,y1)(x2,y2)...(xn,yn)</tt></span></dt> +<dd><a id="id2556467" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\file{file}</tt></span></dt> +<dd><a id="id2556499" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\arrows{arrows}</tt></span></dt> +<dd><a id="id2556530" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\setcolor{color}</tt></span></dt> +<dd><a id="id2556561" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pictures"></a>4.2.2.22 +Pictures</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pspicture*[baseline](x0,y0)(x1,y1)</tt></span></dt> +<dd><a id="id2556613" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\endpspicture</tt></span></dt> +<dd><a id="id2556644" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="placing"></a>4.2.2.23 Placing and rotating +whatever</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\rput*[refpoint]{rotation}(x,y){stuff}</tt></span></dt> +<dd><a id="id2556698" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\uput*{labelsep}[refangle]{rotation}(x,y){stuff}</tt></span></dt> +<dd><a id="id2556729" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pslabelsep</tt></span></dt> +<dd><a id="id2556761" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">labelsep=dim</tt></span></dt> +<dd><a id="id2556792" class="indexterm"></a> +<p>Default: <tt class="literal">5pt</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-repetition"></a>4.2.2.24 +Repetition</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\multirput*[refpoint]{angle}(x0,y0)(x1,y1){int}{stuff}</tt></span></dt> +<dd><a id="id2556854" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\multips{angle}(x0,y0)(x1,y1){int}{graphics}</tt></span></dt> +<dd><a id="id2556886" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-axes"></a>4.2.2.25 +Axes</h5></div></div></div> +<a id="id2556920" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\psaxes*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)</tt></span></dt> +<dd> +<div class="informaltable"> +<table border="0"> +<colgroup> +<col align="left" /> +<col align="left" /> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left"> +<span class="emphasis"><em>Horizontal</em></span></td> +<td align="left"> +<span class="emphasis"><em>Vertical</em></span></td> +<td align="left"><span class="emphasis"><em>Dflt</em></span></td> +<td align="justify"> +<span class="emphasis"><em>Description</em></span></td></tr> +<tr> +<td align="left">Ox=num</td> +<td align="left">Oy=num</td> +<td align="left">0</td> +<td align="justify">Label at origin.</td></tr> +<tr> +<td align="left">Dx=num</td> +<td align="left">Dy=num</td> +<td align="left">1</td> +<td align="justify">Label increment.</td></tr> +<tr> +<td align="left">dx=dim</td> +<td align="left">oy=dim</td> +<td align="left">0pt</td> +<td align="justify">Dist btwn +labels.</td></tr></tbody></table></div></dd> +<dt> +<span class="term"><tt class="literal">labels=all/x/y/none</tt></span></dt> +<dd><a id="id2557092" class="indexterm"></a> +<p>Default: <tt class="literal">all</tt></p></dd> +<dt> +<span class="term"><tt class="literal">showorigin=true/false</tt></span></dt> +<dd><a id="id2557132" class="indexterm"></a> +<p>Default: <tt class="literal">true</tt></p></dd> +<dt> +<span class="term"><tt class="literal">ticks=all/x/y/none</tt></span></dt> +<dd><a id="id2557173" class="indexterm"></a> +<p>Default: <tt class="literal">all</tt></p></dd> +<dt> +<span class="term"><tt class="literal">tickstyle=full/top/bottom</tt></span></dt> +<dd><a id="id2557213" class="indexterm"></a> +<p>Default: <tt class="literal">full</tt></p></dd> +<dt> +<span class="term"><tt class="literal">ticksize=dim</tt></span></dt> +<dd><a id="id2557254" class="indexterm"></a> +<p>Default: <tt class="literal">3pt</tt></p></dd> +<dt><span class="term"><tt class="literal">\psxlabel, +\psylabel</tt></span></dt> +<dd><a id="id2557295" class="indexterm"></a><a id="id2557311" +class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">axesstyle=axes/frame/none</tt></span></dt> +<dd><a id="id2557343" class="indexterm"></a> +<p>Default: <tt class="literal">axes</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-framed"></a>4.2.2.26 Framed +boxes</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">framesep=dim</tt></span></dt> +<dd><a id="id2557406" class="indexterm"></a> +<p>Default: <tt class="literal">3pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">boxsep=true/false</tt></span></dt> +<dd><a id="id2557446" class="indexterm"></a> +<p>Default: <tt class="literal">true</tt></p></dd> +<dt> +<span class="term"><tt class="literal">\psframebox*[par]{stuff}</tt></span></dt> +<dd><a id="id2557487" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psdblframebox*[par]{stuff}</tt></span></dt> +<dd><a id="id2557519" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psshadowbox*[par]{stuff}</tt></span></dt> +<dd><a id="id2557551" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pscirclebox*[par]{stuff}</tt></span></dt> +<dd><a id="id2557582" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\cput*[par]{angle}(x,y){stuff}</tt></span></dt> +<dd><a id="id2557614" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psovalbox*[par]{stuff}</tt></span></dt> +<dd><a id="id2557645" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-clipping"></a>4.2.2.27 +Clipping</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\clipbox[dim]{stuff}</tt></span></dt> +<dd><a id="id2557698" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\psclip{graphics} ... +\endpsclip</tt></span></dt> +<dd><a id="id2557730" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-rotation"></a>4.2.2.28 Rotation +and scaling boxes</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\rotateleft{stuff}</tt></span></dt> +<dd><a id="id2557782" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\rotateright{stuff}</tt></span></dt> +<dd><a id="id2557813" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\rotatedown{stuff}</tt></span></dt> +<dd><a id="id2557845" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\scalebox{num1 +num2}{stuff}</tt></span></dt> +<dd><a id="id2557876" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\scaleboxto(x,y){stuff}</tt></span></dt> +<dd><a id="id2557908" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-nodes"></a>4.2.2.29 +Nodes</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\rnode[refpoint]{name}{stuff}</tt></span></dt> +<dd><a id="id2557961" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\Rnode(x,y){name}{stuff}</tt></span></dt> +<dd><a id="id2557992" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\RnodeRef</tt></span></dt> +<dd><a id="id2558023" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pnode(x,y){name}</tt></span></dt> +<dd><a id="id2558054" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\cnode*[par](x,y){radius}{name}</tt></span></dt> +<dd><a id="id2558086" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\circlenode*[par]{name}{stuff}</tt></span></dt> +<dd><a id="id2558118" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\cnodeput*[par]{angle}(x,y){name}{stuff}</tt></span></dt> +<dd><a id="id2558150" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ovalnode*[par]{name}{stuff}</tt></span></dt> +<dd><a id="id2558181" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-connections"></a>4.2.2.30 Node +connections</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">nodesep=dim</tt></span></dt> +<dd><a id="id2558235" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd> +<dt> +<span class="term"><tt class="literal">offset=dim</tt></span></dt> +<dd><a id="id2558276" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd> +<dt><span class="term"><tt class="literal">arm=dim</tt></span></dt> +<dd><a id="id2558316" class="indexterm"></a> +<p>Default: <tt class="literal">10pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">angle=angle</tt></span></dt> +<dd><a id="id2558356" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd> +<dt> +<span class="term"><tt class="literal">arcangle=angle</tt></span></dt> +<dd><a id="id2558397" class="indexterm"></a> +<p>Default: <tt class="literal">8</tt></p></dd> +<dt> +<span class="term"><tt class="literal">ncurv=num</tt></span></dt> +<dd><a id="id2558438" class="indexterm"></a> +<p>Default: <tt class="literal">.67</tt></p></dd> +<dt> +<span class="term"><tt class="literal">loopsize=dim</tt></span></dt> +<dd><a id="id2558478" class="indexterm"></a> +<p>Default: <tt class="literal">1cm</tt></p></dd> +<dt> +<span class="term"><tt class="literal">\ncline*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558519" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncLine*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558551" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\nccurve*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558582" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncarc*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558614" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncbar*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558646" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncdiag*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558677" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncdiagg*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558709" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncangle*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558741" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncangles*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558772" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\ncloop*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2558804" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\nccircle*[par]{arrows}{node}{radius}</tt></span></dt> +<dd><a id="id2558836" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pcline*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2558868" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pccurve*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2558899" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pcarc*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2558931" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pcbar*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2558963" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pcdiag*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2558995" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pcangle*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2559026" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pcloop*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2559058" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-attaching"></a>4.2.2.31 Attaching +labels to node connections</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\lput*[refpoint]{rotation}(pos){stuff}</tt></span></dt> +<dd><a id="id2559112" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\aput*[labelsep]{angle}(pos){stuff}</tt></span></dt> +<dd><a id="id2559144" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\bput*[labelsep]{angle}(pos){stuff}</tt></span></dt> +<dd><a id="id2559175" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\mput*[refpoint]{stuff}</tt></span></dt> +<dd><a id="id2559206" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\Aput*[labelsep]{stuff}</tt></span></dt> +<dd><a id="id2559238" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\Bput*[labelsep]{stuff}</tt></span></dt> +<dd><a id="id2559269" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-coils"></a>4.2.2.32 Coils and +zigzags</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pscoil*[par]{arrows}(x0,y0)(x1,y1)</tt></span></dt> +<dd><a id="id2559323" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psCoil*[par]{angle1}{angle2}</tt></span></dt> +<dd><a id="id2559355" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pszigzag*[par]{arrows}(x0,y0)(x1,y1)</tt></span></dt> +<dd><a id="id2559386" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">coilwidth=dim</tt></span></dt> +<dd><a id="id2559418" class="indexterm"></a> +<p>Default: <tt class="literal">1cm</tt></p></dd> +<dt> +<span class="term"><tt class="literal">coilheight=num</tt></span></dt> +<dd><a id="id2559458" class="indexterm"></a> +<p>Default: <tt class="literal">1</tt></p></dd> +<dt> +<span class="term"><tt class="literal">coilarm=dim</tt></span></dt> +<dd><a id="id2559498" class="indexterm"></a> +<p>Default: <tt class="literal">.5cm</tt></p></dd> +<dt> +<span class="term"><tt class="literal">coilaspect=angle</tt></span></dt> +<dd><a id="id2559540" class="indexterm"></a> +<p>Default: <tt class="literal">45</tt></p></dd> +<dt> +<span class="term"><tt class="literal">coilinc=angle</tt></span></dt> +<dd><a id="id2559580" class="indexterm"></a> +<p>Default: <tt class="literal">10</tt></p></dd> +<dt> +<span class="term"><tt class="literal">\nccoil*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2559621" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\nczigzag*[par]{arrows}{nodeA}{nodeB}</tt></span></dt> +<dd><a id="id2559652" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pccoil*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2559684" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pczigzag*[par]{arrows}(x1,y1)(x2,y2)</tt></span></dt> +<dd><a id="id2559716" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-coordinates"></a>4.2.2.33 Special +coordinates</h5></div></div></div> +<p><tt class="literal">\SpecialCoor</tt></p> +<a id="id2559759" class="indexterm"></a> +<div class="table"><a id="id2559775"></a> +<p class="title"><b>Table 1.12. Special coordinates and +angles</b></p> +<table summary="Special coordinates and angles" border="0"> +<colgroup> +<col align="left" /> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left"> +<span class="emphasis"><em>Coordinate</em></span></td> +<td align="left"> +<span class="emphasis"><em>Example</em></span></td> +<td align="justify"> +<span class="emphasis"><em>Description</em></span></td></tr> +<tr> +<td align="left">(x,y)</td> +<td align="left">(3,4)</td> +<td align="justify">Cartesian coordinate.</td></tr> +<tr> +<td align="left">(r;a)</td> +<td align="left">(3;110)</td> +<td align="justify">Polar coordinate.</td></tr> +<tr> +<td align="left">(node)</td> +<td align="left">(A)</td> +<td align="justify">Center of node.</td></tr> +<tr> +<td align="left">([par]node)</td> +<td align="left">([angle=45]A)</td> +<td align="justify">Relative to node.</td></tr> +<tr> +<td align="left">(!ps)</td> +<td align="left">(!5 3.3 2 exp)</td> +<td align="justify">Raw PostScript.</td></tr> +<tr> +<td align="left">(coor1|coor2)</td> +<td align="left">(A|1in;30)</td> +<td align="justify">Combination.</td></tr></tbody></table> +<table summary="Special coordinates and angles" border="0"> +<colgroup> +<col align="left" /> +<col align="left" /> +<col align="justify" /></colgroup> +<tbody> +<tr> +<td align="left"> </td> +<td class="auto-generated"> </td> +<td class="auto-generated"> </td></tr> +<tr> +<td align="left"><span class="emphasis"><em>Angle</em></span></td> +<td align="left"> +<span class="emphasis"><em>Example</em></span></td> +<td align="justify"> +<span class="emphasis"><em>Description</em></span></td></tr> +<tr> +<td align="left">num</td> +<td align="left">45</td> +<td align="justify">Angle.</td></tr> +<tr> +<td align="left">(coor)</td> +<td align="left">(-1,1)</td> +<td align="justify">Coordinate (vector).</td></tr> +<tr> +<td align="left">!ps</td> +<td align="left">!33 sqrt</td> +<td align="justify">Raw PostScript.</td></tr></tbody></table></div> +<p><tt class="literal">\NormalCoor</tt></p> +<a id="id2560044" class="indexterm"></a></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-overlays"></a>4.2.2.34 +Overlays</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\overlaybox +stuff\endoverlaybox</tt></span></dt> +<dd><a id="id2560093" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\psoverlay{string}</tt></span></dt> +<dd><a id="id2560124" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\putoverlaybox{string}</tt></span></dt> +<dd><a id="id2560156" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">gradbegin=color</tt></span></dt> +<dd><a id="id2560187" class="indexterm"></a> +<p>Default: <tt class="literal">gradbegin</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gradend=color</tt></span></dt> +<dd><a id="id2560228" class="indexterm"></a> +<p>Default: <tt class="literal">gradend</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gradlines=int</tt></span></dt> +<dd><a id="id2560269" class="indexterm"></a> +<p>Default: <tt class="literal">500</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gradmidpoint=num</tt></span></dt> +<dd><a id="id2560309" class="indexterm"></a> +<p>Default: <tt class="literal">.9</tt></p></dd> +<dt> +<span class="term"><tt class="literal">gradangle=angle</tt></span></dt> +<dd><a id="id2560350" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-path"></a>4.2.2.35 Typesetting +text along a path</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pstextpath[pos](x,y){graphics +object}{text}</tt></span></dt> +<dd><a id="id2560412" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-stroking"></a>4.2.2.36 Stroking +and filling character paths</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">\pscharpath*[par]{text}</tt></span></dt> +<dd><a id="id2560465" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\pscharclip*[par]{text} +... \endpscharclip</tt></span></dt> +<dd><a id="id2560497" class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-exporting"></a>4.2.2.37 Exporting +EPS files</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\TeXtoEPS ... +\endTeXtoEPS</tt></span></dt> +<dd><a id="id2560550" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\PSTtoEPS[par]{file}{graphics +objects}</tt></span></dt> +<dd><a id="id2560581" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">bbllx=dim</tt></span></dt> +<dd><a id="id2560613" class="indexterm"></a> +<p>Default: <tt class="literal">-1pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">bblly=dim</tt></span></dt> +<dd><a id="id2560653" class="indexterm"></a> +<p>Default: <tt class="literal">-1pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">bburx=dim</tt></span></dt> +<dd><a id="id2560694" class="indexterm"></a> +<p>Default: <tt class="literal">1pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">bbury=dim</tt></span></dt> +<dd><a id="id2560734" class="indexterm"></a> +<p>Default: <tt class="literal">1pt</tt></p></dd> +<dt> +<span class="term"><tt class="literal">headerfile=file</tt></span></dt> +<dd><a id="id2560774" class="indexterm"></a> +<p>Default: <tt class="literal">s</tt></p></dd> +<dt> +<span class="term"><tt class="literal">headers=none/all/user</tt></span></dt> +<dd><a id="id2560815" class="indexterm"></a> +<p>Default: <tt class="literal">none</tt></p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-boxes"></a>4.2.2.38 +Boxes</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\psmathboxtrue, +\psmathboxfalse</tt></span></dt> +<dd><a id="id2560878" class="indexterm"></a><a id="id2560894" +class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\everypsbox{commands}</tt></span></dt> +<dd><a id="id2560925" class="indexterm"></a></dd> +<dt> +<span class="term"><tt class="literal">\pslongbox{name}{cmd}</tt></span></dt> +<dd><a id="id2560956" class="indexterm"></a></dd> +<dt><span class="term"><tt class="literal">\psverbboxtrue, +\psverbboxfalse</tt></span></dt> +<dd><a id="id2560988" class="indexterm"></a><a id="id2561004" +class="indexterm"></a></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h5 class="title"><a id="pstricks-tricks"></a>4.2.2.39 Tips and +More Tricks</h5></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">\pslbrace, +\psrbrace</tt></span></dt> +<dd><a id="id2561058" class="indexterm"></a><a id="id2561073" +class="indexterm"></a></dd></dl></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="pstricks-add-packages"></a>4.2.3 List of +Additional PSTricks Packages</h4></div></div></div> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/psgo/" + target="_top"><tt class="literal">psgo</tt></a></span></dt> +<dd>Draw Go diagrams</dd> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-blur/" + target="_top"><tt class="literal">pst-blur</tt></a></span></dt> +<dd>PSTricks package for "blurred" shadows</dd> +<dt> +<span class="term"><a href="http://dominique.rodriguez.9online.fr/pst-eucl/" + target="_top"><tt class="literal">pst-euc</tt></a></span></dt> +<dd>Géométrie en LaTeX et PSTricks</dd> +<dt> +<span class="term"><a href="http://www.tug.org/applications/PSTricks/More/pst-fr3d.tar.gz" + target="_top"><tt class="literal">pst-fr3d</tt></a></span></dt> +<dd>Three dimensional framed Boxes</dd> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-ghsb/" + target="_top"><tt class="literal">pst-ghsb</tt></a></span></dt> +<dd>PSTricks package for HSB Gradients</dd> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-gr3d/" + target="_top"><tt class="literal">pst-gr3d</tt></a></span></dt> +<dd>PSTricks package for 3D grids</dd> +<dt> +<span class="term"><a href="http://members.aol.com/ManuelLuque2/optique.htm" + target="_top"><tt class="literal">pst-lens</tt></a></span></dt> +<dd>Optique géométrique</dd> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/" + target="_top"><tt class="literal">pst-node</tt></a></span></dt> +<dd>PSTricks package for nodes</dd> +<dt> +<span class="term"><a href="http://members.aol.com/Mluque5130/pst-ob3d.tar.gz" + target="_top"><tt class="literal">pst-ob3d</tt></a></span></dt> +<dd>A PSTricks package for three dimensional basic objects</dd> +<dt> +<span class="term"><a href="http://www.tug.org/applications/PSTricks/Physics/Oscilloscopes/" + target="_top"><tt class="literal">pst-osci</tt></a></span></dt> +<dd>Oscilloscopes with PSTricks</dd> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-poly/" + target="_top"><tt class="literal">pst-poly</tt></a></span></dt> +<dd>Polygons with PSTricks</dd> +<dt> +<span class="term"><a href="ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/" + target="_top"><tt class="literal">pst-tree</tt></a></span></dt> +<dd>PSTricks package for trees</dd> +<dt> +<span class="term"><a href="http://www.ensta.fr/~diam/latex/pst-uml/" + target="_top"><tt class="literal">pst-uml</tt></a></span></dt> +<dd>Draw easily diagrams with UML notation</dd> +<dt> +<span class="term"><a href="http://perso.enst.fr/~lombardy/Vauc/" +target="_top"><tt class="literal">vaucansom.sty</tt></a></span></dt> +<dd>Drawing automata</dd></dl></div></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="fontinst"></a>5 +<tt class="filename">fontinst</tt> (tbd.)</h2></div></div></div> +<a id="id2561444" class="indexterm"></a> +<p>tbd.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="context"></a>6 ConTeXt +(tbd.)</h2></div></div></div> +<a id="id2561469" class="indexterm"></a><a id="id2561478" +class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="context-ovw"></a>6.1 +Overview</h3></div></div></div> +<p>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.</p> +<p>Some of the unique features of ConTeXt are:</p> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Inline XML (including MathML, ChemML, and PhysML)</li> +<li>really good XML support in general</li> +<li>inline MetaPost</li></ul></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="texinfo"></a>7 Texinfo +(tbd.)</h2></div></div></div> +<a id="id2561513" class="indexterm"></a> +<p>tbd.</p></div></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="pdftex"></a>Chapter 2. pdfTeX</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#pdftex-options">1 +Options</a></span></dt> +<dd> +<dl> +<dt> +<span class="section"><a href="#pdftex-option-file-line-error-style"> +1.1 +<tt class="filename">--file-line-error-style</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-fmt">1.2 +<tt class="filename">--fmt format</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-help">1.3 +<tt class="filename">--help</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-ini">1.4 +<tt class="filename">--ini</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-interaction%20mode">1.5 +<tt class="filename">--interaction mode</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-ipc">1.6 +<tt class="filename">--ipc</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-ipc-start">1.7 +<tt class="filename">--ipc-start</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-jobname-name">1.8 +<tt class="filename">--jobname name</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-kpathsea-debug">1.9 +<tt class="filename">--kpathsea-debug bitmask</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-maketex">1.10 +<tt class="filename">--maketex fmt</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-no-maketex">1.11 +<tt class="filename">--no-maketex fmt</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-output-comment">1.12 +<tt class="filename">--output-comment string</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-parse-first-line">1.13 +<tt class="filename">--parse-first-line</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-progname">1.14 +<tt class="filename">--progname name</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-recorder">1.15 +<tt class="filename">--recorder</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-shell-escape">1.16 +<tt class="filename">--shell-escape</tt></a></span></dt> +<dt> +<span class="section"><a href="#pdftex-option-translate-file">1.17 +<tt class="filename">--translate-file tcxname</tt></a></span></dt> +<dt><span class="section"><a href="#pdftex-option-version">1.18 +<tt class="filename">--version</tt></a></span></dt></dl></dd> +<dt><span class="section"><a href="#pdftex-environment">2 +Environment</a></span></dt></dl></div> +<a id="id2561599" class="indexterm"></a> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The contents of this section was taken from +<tt class="filename">pdftex(1)</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="pdftex-options"></a>1 +Options</h2></div></div></div> +<a id="id2561639" class="indexterm"></a> +<p>pdfTeX understands the following command line options.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"> +<a id="pdftex-option-file-line-error-style"></a>1.1 +<tt class="filename">--file-line-error-style</tt></h3></div></div></div> +<a id="id2561675" class="indexterm"></a> +<p>Print error messages in the form +<tt class="literal">file:line:error</tt> which is similar to the +way many compilers format them.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-fmt"></a>1.2 +<tt class="filename">--fmt format</tt></h3></div></div></div> +<a id="id2561719" class="indexterm"></a> +<p>Use <tt class="literal">format</tt> as the name of the format to +be used, instead of the name by which pdfTeX was called or a +<tt class="literal">%&</tt> line.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-help"></a>1.3 +<tt class="filename">--help</tt></h3></div></div></div> +<a id="id2561774" class="indexterm"></a> +<p>Print help message and exit.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-ini"></a>1.4 +<tt class="filename">--ini</tt></h3></div></div></div> +<a id="id2561810" class="indexterm"></a> +<p>Be <span><b class="command">pdfinitex</b></span>, for dumping +formats; this is implicitly true if the program is called as +<span><b class="command">pdfinitex</b></span>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-interaction mode"></a>1.5 +<tt class="filename">--interaction mode</tt></h3></div></div></div> +<a id="id2561860" class="indexterm"></a> +<p>Sets the interaction mode. The mode can be one of +<tt class="literal">batchmode</tt>, +<tt class="literal">nonstopmode</tt>, +<tt class="literal">scrollmode</tt>, and +<tt class="literal">errorstopmode</tt>. The meaning of these modes +is the same as that of the corresponding +<tt class="literal">\commands</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-ipc"></a>1.6 +<tt class="filename">--ipc</tt></h3></div></div></div> +<a id="id2561928" class="indexterm"></a> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-ipc-start"></a>1.7 +<tt class="filename">--ipc-start</tt></h3></div></div></div> +<a id="id2561967" class="indexterm"></a> +<p>As <tt class="literal">--ipc</tt>, and starts the server at the +other end as well. Whether this option is available is the choice +of the installer.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-jobname-name"></a>1.8 +<tt class="filename">--jobname name</tt></h3></div></div></div> +<a id="id2562011" class="indexterm"></a> +<p>Use <tt class="literal">name</tt> for the job name, instead of +deriving it from the name of the input file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-kpathsea-debug"></a>1.9 +<tt class="filename">--kpathsea-debug +bitmask</tt></h3></div></div></div> +<a id="id2562055" class="indexterm"></a> +<p>Sets path searching debugging flags according to the +<tt class="literal">bitmask</tt>. See the Kpathsea manual for +details.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-maketex"></a>1.10 +<tt class="filename">--maketex fmt</tt></h3></div></div></div> +<a id="id2562099" class="indexterm"></a> +<p>Enable <span><b class="command">mktexfmt</b></span>, where +<tt class="literal">fmt</tt> must be one of +<tt class="literal">tex</tt> or +<tt class="literal">tfm</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-no-maketex"></a>1.11 +<tt class="filename">--no-maketex fmt</tt></h3></div></div></div> +<a id="id2562160" class="indexterm"></a> +<p>Disable <span><b class="command">mktexfmt</b></span>, where +<tt class="literal">fmt</tt> must be one of +<tt class="literal">tex</tt> or +<tt class="literal">tfm</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-output-comment"></a>1.12 +<tt class="filename">--output-comment +string</tt></h3></div></div></div> +<a id="id2562220" class="indexterm"></a> +<p>Use <tt class="literal">string</tt> for the DVI file comment +instead of the date.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-parse-first-line"></a>1.13 +<tt class="filename">--parse-first-line</tt></h3></div></div></div> +<a id="id2562260" class="indexterm"></a> +<p>If the first line of the main input file begins with +<tt class="literal">%&</tt> parse it to look for a dump name or +a <tt class="literal">--translate-file</tt> option.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-progname"></a>1.14 +<tt class="filename">--progname name</tt></h3></div></div></div> +<a id="id2562311" class="indexterm"></a> +<p>Pretend to be program <tt class="literal">name</tt>. This +affects both the format used and the search paths.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-recorder"></a>1.15 +<tt class="filename">--recorder</tt></h3></div></div></div> +<a id="id2562354" class="indexterm"></a> +<p>Enable the filename recorder. This leaves a trace of the files +opened for input and output in a file with extension +<tt class="literal">.fls</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-shell-escape"></a>1.16 +<tt class="filename">--shell-escape</tt></h3></div></div></div> +<a id="id2562399" class="indexterm"></a> +<p>Enable the <tt class="literal">\write18{command}</tt> construct. +The command can be any Bourne shell command. This construct is +normally disallowed for security reasons.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-translate-file"></a>1.17 +<tt class="filename">--translate-file +tcxname</tt></h3></div></div></div> +<a id="id2562444" class="indexterm"></a> +<p>Use the <tt class="literal">tcxname</tt> translation +table.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="pdftex-option-version"></a>1.18 +<tt class="filename">--version</tt></h3></div></div></div> +<a id="id2562487" class="indexterm"></a> +<p>Print version information and exit.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="pdftex-environment"></a>2 Environment</h2></div></div></div> +<a id="id2562518" class="indexterm"></a> +<p>See the Kpathsearch library documentation (the `Path +specifications' node) for the details of how the environment +variables are used when searching. The +<span><b class="command">kpsewhich</b></span> utility can be used +to query the values of the variables.</p> +<p>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.</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">TEXMFOUTPUT</tt></span></dt> +<dd><a id="id2562576" class="indexterm"></a> +<p>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 +<tt class="literal">TEXMFOUTPUT</tt>. There is no default value for +that variable. For example, if you say +<span><b class="command">pdftex paper</b></span> and the current +directory is not writable, if <tt class="literal">TEXMFOUTPUT</tt> +has the value <tt class="literal">/tmp</tt>, pdfTeX attempts to +create <tt class="literal">/tmp/paper.log</tt> (and +<tt class="literal">/tmp/paper.pdf</tt>, if any output is +produced.)</p></dd> +<dt> +<span class="term"><tt class="literal">TEXINPUTS</tt></span></dt> +<dd><a id="id2562664" class="indexterm"></a> +<p>Search path for <tt class="literal">\input</tt> and +<tt class="literal">\openin</tt> 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 +<tt class="filename">texmf.cnf</tt> file. For example, set +<tt class="literal">TEXINPUTS</tt> to +<tt class="literal">".:/home/usr/tex:"</tt> to prepend the current +direcory and <tt class="literal">``/home/user/tex''</tt> to the +standard search path.</p></dd> +<dt> +<span class="term"><tt class="literal">TEXFONTS</tt></span></dt> +<dd><a id="id2562741" class="indexterm"></a> +<p>earch path for font metric (<tt class="literal">.tfm</tt>) +files.</p></dd> +<dt> +<span class="term"><tt class="literal">TEXFORMATS</tt></span></dt> +<dd><a id="id2562783" class="indexterm"></a> +<p>Search path for format files.</p></dd> +<dt><span class="term"><tt class="literal">TEXPOOL</tt></span></dt> +<dd><a id="id2562818" class="indexterm"></a> +<p>Search path for <span><b class="command">pdfinitex</b></span> +internal strings.</p></dd> +<dt><span class="term"><tt class="literal">TEXEDIT</tt></span></dt> +<dd><a id="id2562859" class="indexterm"></a> +<p>Command template for switching to editor. The default, usually +<span><b class="command">vi</b></span>, is set when pdfTeX is +compiled.</p></dd></dl></div></div></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="metafont"></a>Chapter 3. Metafont +(tbd.)</h2></div></div></div> +<a id="id2562920" class="indexterm"></a> +<p>tbd.</p></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="metapost"></a>Chapter 4. MetaPost</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#metapost-options">1 +Options</a></span></dt> +<dd> +<dl> +<dt> +<span class="section"><a href="#metapost-option-file-line-error-style"> +1.1 +<tt class="filename">--file-line-error-style</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-help">1.2 +<tt class="filename">--help</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-ini">1.3 +<tt class="filename">--ini</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-intercation">1.4 +<tt class="filename">--interaction mode</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-jobname">1.5 +<tt class="filename">--jobname name</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-kpathsea-debug">1.6 +<tt class="filename">--kpathsea-debug bitmask</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-mem">1.7 +<tt class="filename">--mem mem</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-parse-first-line">1.8 +<tt class="filename">--parse-first-line</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-progname">1.9 +<tt class="filename">--progname name</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-recorder">1.10 +<tt class="filename">--recorder</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-T">1.11 +<tt class="filename">-T</tt></a></span></dt> +<dt> +<span class="section"><a href="#metapost-option-translate-file">1.12 +<tt class="filename">--translate-file tcxname</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-troff">1.13 +<tt class="filename">--troff</tt></a></span></dt> +<dt><span class="section"><a href="#metapost-option-version">1.14 +<tt class="filename">--version</tt></a></span></dt></dl></dd> +<dt><span class="section"><a href="#metapost-environment">2 +Environment</a></span></dt></dl></div> +<a id="id2562948" class="indexterm"></a> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The contents of this section was taken from +<tt class="filename">mpost(1)</tt>.</p></div> +<p>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.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="metapost-options"></a>1 Options</h2></div></div></div> +<a id="id2563000" class="indexterm"></a> +<p>MetaPost understands the following command line options.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"> +<a id="metapost-option-file-line-error-style"></a>1.1 +<tt class="filename">--file-line-error-style</tt></h3></div></div></div> +<a id="id2563034" class="indexterm"></a> +<p>Print error messages in the form +<tt class="literal">file:line:error</tt> which is similar to the +way many compilers format them.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-help"></a>1.2 +<tt class="filename">--help</tt></h3></div></div></div> +<a id="id2563078" class="indexterm"></a> +<p>Print help message and exit.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-ini"></a>1.3 +<tt class="filename">--ini</tt></h3></div></div></div> +<a id="id2563114" class="indexterm"></a> +<p>Be <span><b class="command">inimpost</b></span>, for dumping +bases; this is implicitly true if the program is called as +<span><b class="command">inimpost</b></span>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-intercation"></a>1.4 +<tt class="filename">--interaction mode</tt></h3></div></div></div> +<a id="id2563164" class="indexterm"></a> +<p>Sets the interaction mode. The mode can be one of +<tt class="literal">batchmode</tt>, +<tt class="literal">nonstopmode</tt>, +<tt class="literal">scrollmode</tt>, and +<tt class="literal">errorstopmode</tt>. The meaning of these modes +is the same as that of the corresponding commands.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-jobname"></a>1.5 +<tt class="filename">--jobname name</tt></h3></div></div></div> +<a id="id2563226" class="indexterm"></a> +<p>Use <tt class="literal">name</tt> for the job name, instead of +deriving it from the name of the input file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-kpathsea-debug"></a>1.6 +<tt class="filename">--kpathsea-debug +bitmask</tt></h3></div></div></div> +<a id="id2563270" class="indexterm"></a> +<p>Sets path searching debugging flags according to the +<tt class="literal">bitmask</tt>. See the Kpathsea manual for +details.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-mem"></a>1.7 +<tt class="filename">--mem mem</tt></h3></div></div></div> +<a id="id2563313" class="indexterm"></a> +<p>Use <tt class="literal">mem</tt> as the name of the mem to be +used, instead of the name by which MetaPost was called or a +<tt class="literal">%&</tt> line.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-parse-first-line"></a>1.8 +<tt class="filename">--parse-first-line</tt></h3></div></div></div> +<a id="id2563365" class="indexterm"></a> +<p>If the first line of the main input file begins with +<tt class="literal">%&</tt> parse it to look for a dump name or +a <tt class="literal">--translate-file</tt> option.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-progname"></a>1.9 +<tt class="filename">--progname name</tt></h3></div></div></div> +<a id="id2563416" class="indexterm"></a> +<p>Pretend to be program <tt class="literal">name</tt>. This +affects both the format used and the search paths.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-recorder"></a>1.10 +<tt class="filename">--recorder</tt></h3></div></div></div> +<a id="id2563459" class="indexterm"></a> +<p>Enable the filename recorder. This leaves a trace of the files +opened for input and output in a file with extension +<tt class="literal">.fls.</tt></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-T"></a>1.11 +<tt class="filename">-T</tt></h3></div></div></div> +<a id="id2563501" class="indexterm"></a> +<p>Produce TROFF output.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-translate-file"></a>1.12 +<tt class="filename">--translate-file +tcxname</tt></h3></div></div></div> +<a id="id2563538" class="indexterm"></a> +<p>Use the <tt class="literal">tcxname</tt> translation +table.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-troff"></a>1.13 +<tt class="filename">--troff</tt></h3></div></div></div> +<a id="id2563582" class="indexterm"></a> +<p>As -T.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="metapost-option-version"></a>1.14 +<tt class="filename">--version</tt></h3></div></div></div> +<a id="id2563618" class="indexterm"></a> +<p>Print version information and exit.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="metapost-environment"></a>2 +Environment</h2></div></div></div> +<a id="id2563650" class="indexterm"></a> +<p>See the Kpathsearch library documentation (the `Path +specifications' node) for the details of how the environment +variables are use when searching. The +<span><b class="command">kpsewhich</b></span> utility can be used +to query the values of the variables.</p> +<p>If the environment variable <tt class="literal">TEXMFOUTPUT</tt> +is set, MetaPost attempts to put its output files in it, if they +cannot be put in the current directory.</p> +<p>Here is a list of the environment variables which affect the +behavior of MetaPost:</p> +<div class="variablelist"> +<dl> +<dt> +<span class="term"><tt class="literal">MPINPUTS</tt></span></dt> +<dd><a id="id2563705" class="indexterm"></a> +<p>Search path for input files.</p></dd> +<dt> +<span class="term"><tt class="literal">MFINPUTS</tt></span></dt> +<dd><a id="id2563738" class="indexterm"></a> +<p>Auxiliary search path for input files with +<tt class="literal">.mf</tt> extensions.</p></dd> +<dt> +<span class="term"><tt class="literal">MPSUPPORT</tt></span></dt> +<dd><a id="id2563776" class="indexterm"></a> +<p>Directory for various tables for handling included TeX and +troff.</p></dd> +<dt> +<span class="term"><tt class="literal">MPXCOMMAND</tt></span></dt> +<dd><a id="id2563813" class="indexterm"></a> +<p>The name of a shell script that converts embedded typesetting +commands to a form that MetaPost understands. Defaults: +<tt class="literal">makempx</tt> for TeX and +<tt class="literal">troffmpx</tt> for troff.</p></dd> +<dt><span class="term"><tt class="literal">TEX</tt></span></dt> +<dd><a id="id2563864" class="indexterm"></a> +<p>The version of TeX - or LaTeX - to use when processing +<span><b class="command">btex</b></span> and +<span><b class="command">verbatimtex</b></span> commands. Default +TeX. This version of MetaPost allows you to use a +<tt class="literal">`%&format'</tt> line instead.</p></dd> +<dt><span class="term"><tt class="literal">TROFF</tt></span></dt> +<dd><a id="id2563928" class="indexterm"></a> +<p>The troff pipeline for <span><b class="command">btex</b></span> +and <span><b class="command">verbatimtex</b></span> commands. +Default <tt class="literal">eqn -d\$\$ | troff</tt></p></dd> +<dt><span class="term"><tt class="literal">MPEDIT</tt></span></dt> +<dd><a id="id2563978" class="indexterm"></a> +<p>A command template for invoking an editor.</p></dd></dl></div> +<p>A <tt class="literal">.mem</tt> file is a binary file that +permits fast loading of macro packages. MetaPost reads the default +<tt class="literal">plain.mem</tt> unless another +<tt class="literal">.mem</tt> file is specified at the start of the +first line with an <tt class="literal">&</tt> just before it. +There is also an <tt class="literal">mfplain.mem</tt> that +simulates plain Metafont so that MetaPost can read +<tt class="literal">.mf</tt> fonts. (Plain Metafont is described in +<span class="emphasis"><em>The Metafontbook</em></span>).</p> +<p>Experts can create <tt class="literal">.mem</tt> files by +invoking <span><b class="command">inimpost</b></span> and giving +macro definitions followed by a dump command.</p> +<p>The MetaPost language is similar to Metafont, but the manual +<span class="emphasis"><em>A User's Manual for MetaPost</em></span> +assumes no knowledge of Metafont. MetaPost does not have bitmap +output commands or Metafont's online display +mechanism.</p></div></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="bibtex"></a>Chapter 5. BibTeX</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#bibtex-parameters">1 +Parameters</a></span></dt> +<dt><span class="section"><a href="#bibtex-command-qualifiers">2 +Command Qualifiers</a></span></dt> +<dt><span class="section"><a href="#bibtex-bib-files">3 bib +files</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#bibtex-string-command">3.1 +<tt class="filename">@STRING</tt> command</a></span></dt> +<dt><span class="section"><a href="#bibtex-entry-format">3.2 Entry +Format</a></span></dt> +<dt><span class="section"><a href="#bibtex-entry-types">3.3 Entry +Types</a></span></dt> +<dt><span class="section"><a href="#bibtex-field-text">3.4 Field +Text</a></span></dt> +<dt><span class="section"><a href="#bibtex-field-types">3.5 Field +Types</a></span></dt></dl></dd> +<dt><span class="section"><a href="#bibtex-bst-files">4 bst +files</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#bibtex-bst-abbr">4.1 +<tt class="filename">ABBRV.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-alpha">4.2 +<tt class="filename">ALPHA.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-plain">4.3 +<tt class="filename">PLAIN.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-sample">4.4 +<tt class="filename">SAMPLE.BST</tt></a></span></dt> +<dt><span class="section"><a href="#bibtex-bst-unsrt">4.5 +<tt class="filename">UNSRT.BST</tt></a></span></dt></dl></dd></dl></div> +<a id="id2564099" class="indexterm"></a> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The contents of this section was taken from the HTML helppages +for BibTeX of Norman Walsh (Version 1.0, 12 Apr 94).</p></div> +<p>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.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="bibtex-parameters"></a>1 Parameters</h2></div></div></div> +<a id="id2564142" class="indexterm"></a> +<p><tt class="literal">bibliography-file-spec</tt></p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="bibtex-command-qualifiers"></a>2 Command +Qualifiers</h2></div></div></div> +<a id="id2564187" class="indexterm"></a> +<p><tt class="literal">/BIBINPUTS /BIBINPUTS=(name,...)</tt></p> +<p>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 +<tt class="literal">/BIBINPUTS</tt> option.</p> +<p>Default is <tt class="literal">/BIBINPUTS=(TEX_BIB:)</tt>; TeX +looks in the directory associated with the logical name +<tt class="literal">TEX_BIB.</tt></p> +<p><tt class="literal">/STATS /STATS /NOSTATS [D]</tt></p> +<p>This qualifier is used while debugging +<tt class="literal">.BST</tt> files to determine BIBTEX memory +usage.</p> +<p><tt class="literal">/TEXINPUTS /TEXINPUTS=(name,...)</tt></p> +<p>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 +<tt class="literal">/TEXINPUTS</tt> option.</p> +<p>Default is <tt class="literal">/TEXINPUTS=(TEX_INPUTS)</tt>; TeX +looks in the directory associated with the logical name +<tt class="literal">TEX_INPUTS</tt>.</p> +<p><tt class="literal">/TRACE /TRACE /NOTRACE [D]</tt></p> +<p>This qualifier is used while debugging +<tt class="literal">.BST</tt> files to follow program +flow.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="bibtex-bib-files"></a>3 bib files</h2></div></div></div> +<a id="id2564338" class="indexterm"></a> +<p>This help entry contains the same information as Appendix B of +the LaTeX manual. It describes the format of a bibliography +database (<tt class="literal">.BIB</tt>) file.</p> +<p>A bibliography database file may contains two types of entry - +an abbreviation definition or a reference entry for citation.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-string-command"></a>3.1 +<tt class="filename">@STRING</tt> command</h3></div></div></div> +<a id="id2564389" class="indexterm"></a> +<p>The <tt class="literal">@STRING</tt> command is used to define +abbreviations for use by BibTeX within the bibliography database +file. The command</p> +<pre class="programlisting"> + @string{jgg1 = "Journal of Gnats and Gnus, Series~1"} +</pre> +<p>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.</p> +<p>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:</p> +<pre class="programlisting"> + @STRING{JgG1 = "Journal of Gnats and Gnus, Series~1"} +</pre> +<p>A <tt class="literal">@string</tt> 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 <tt class="literal">@string</tt> commands is at the +beginning of the file. A <tt class="literal">@string</tt> 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'.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-entry-format"></a>3.2 Entry +Format</h3></div></div></div> +<a id="id2564482" class="indexterm"></a> +<p>A bibliography database file contains a series of reference +entries like the following:</p> +<pre class="programlisting"> + @BOOK{kn:gnus, + AUTHOR = "Donald E. Knudson", + TITLE = "1966 World Gnus Almanac", + PUBLISHER = {Permafrost Press}, + ADDRESS = {Novisibirsk} } +</pre> +<p>The <tt class="literal">@BOOK</tt> 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 +<tt class="literal">\cite</tt> command referring to the entry.</p> +<p>This entry has four fields, named +<tt class="literal">AUTHOR</tt>, <tt class="literal">TITLE</tt>, +<tt class="literal">PUBLISHER</tt> and +<tt class="literal">ADDRESS</tt>. 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.</p> +<p>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:</p> +<pre class="programlisting"> +@BOOK(kn:gnus, author = {Donald E. Knudson}, + TITLE = "1966 World Gnus Almanac", + PUBLISHER = {Permafrost Press}, + ADDRESS = {Novisibirsk} ) +</pre> +<p>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 <tt class="literal">\cite</tt> commands in the +LaTeX input file.</p> +<p>The quotes or braces can be omitted around text consisting +entirely of numerals. The following two fields are equivalent:</p> +<pre class="programlisting"> +Volume = "27" Volume = 27 +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-entry-types"></a>3.3 Entry +Types</h3></div></div></div> +<a id="id2564636" class="indexterm"></a> +<p>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.</p> +<p>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:</p> +<div class="variablelist"> +<dl> +<dt><span class="term">Required</span></dt> +<dd> +<p>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.</p></dd> +<dt><span class="term">Optional</span></dt> +<dd> +<p>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.</p></dd> +<dt><span class="term">Ignored</span></dt> +<dd> +<p>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.</p></dd></dl></div> +<p>BibTeX ignores the case of letters in the entry type.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-article"></a>3.3.1 +article entry</h4></div></div></div> +<a id="id2564768" class="indexterm"></a> +<p>An article from a journal or magazine.</p> +<p>Format:</p> +<pre class="programlisting"> +@ARTICLE{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-journal" +title="3.5.10 journal field">journal</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-volume" +title="3.5.22 volume field">volume</a>, +<a href="#bibtex-field-types-number" +title="3.5.14 number field">number</a>, +<a href="#bibtex-field-types-pages" +title="3.5.16 pages field">pages</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-book"></a>3.3.2 book +entry</h4></div></div></div> +<a id="id2564903" class="indexterm"></a> +<p>A book with an explicit publisher.</p> +<p>Format:</p> +<pre class="programlisting"> +@BOOK{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a> or +<a href="#bibtex-field-types-editor" +title="3.5.7 editor field">editor</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-publisher" +title="3.5.17 publisher field">publisher</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-volume" +title="3.5.22 volume field">volume</a>, +<a href="#bibtex-field-types-series" +title="3.5.19 series field">series</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-edition" +title="3.5.6 edition field">edition</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-booklet"></a>3.3.3 +booklet entry</h4></div></div></div> +<a id="id2565048" class="indexterm"></a> +<p>A work that is printed and bound, but without a named publisher +or sponsoring institution.</p> +<p>Format:</p> +<pre class="programlisting"> +@BOOKLET{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a></p> +<p>Optional fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-howpublished" +title="3.5.8 howpublished field">howpublished</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-conference"></a>3.3.4 +conference entry</h4></div></div></div> +<a id="id2565158" class="indexterm"></a> +<p>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.</p> +<p>Format:</p> +<pre class="programlisting"> +@CONFERENCE{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-booktitle" +title="3.5.4 booktitle field">booktitle</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-editor" +title="3.5.7 editor field">editor</a>, +<a href="#bibtex-field-types-pages" +title="3.5.16 pages field">pages</a>, +<a href="#bibtex-field-types-organization" +title="3.5.15 organization field">organization</a>, +<a href="#bibtex-field-types-publisher" +title="3.5.17 publisher field">publisher</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-inbook"></a>3.3.5 +inbook entry</h4></div></div></div> +<a id="id2565304" class="indexterm"></a> +<p>A part of a book, which may be a chapter and/or a range of +pages.</p> +<p>Format:</p> +<pre class="programlisting"> +@INBOOK{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a> or +<a href="#bibtex-field-types-editor" +title="3.5.7 editor field">editor</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-chapter" +title="3.5.5 chapter field">chapter</a> and/or +<a href="#bibtex-field-types-pages" +title="3.5.16 pages field">pages</a>, +<a href="#bibtex-field-types-publisher" +title="3.5.17 publisher field">publisher</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-volume" +title="3.5.22 volume field">volume</a>, +<a href="#bibtex-field-types-series" +title="3.5.19 series field">series</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-edition" +title="3.5.6 edition field">edition</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-incollection"></a>3.3.6 +incollection entry</h4></div></div></div> +<a id="id2565459" class="indexterm"></a> +<p>A part of a book with its own title.</p> +<p>Format:</p> +<pre class="programlisting"> +@INCOLLECTION{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-booktitle" +title="3.5.4 booktitle field">booktitle</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-editor" +title="3.5.7 editor field">editor</a>, +<a href="#bibtex-field-types-pages" +title="3.5.16 pages field">pages</a>, +<a href="#bibtex-field-types-organization" +title="3.5.15 organization field">organization</a>, +<a href="#bibtex-field-types-publisher" +title="3.5.17 publisher field">publisher</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="bibtex-entry-types-inproceedings"></a>3.3.7 inproceedings +entry</h4></div></div></div> +<a id="id2565598" class="indexterm"></a> +<p>An article in the proceedings of a conference.</p> +<p>Format:</p> +<pre class="programlisting"> +@INPROCEEDINGS{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-booktitle" +title="3.5.4 booktitle field">booktitle</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-editor" +title="3.5.7 editor field">editor</a>, +<a href="#bibtex-field-types-pages" +title="3.5.16 pages field">pages</a>, +<a href="#bibtex-field-types-organization" +title="3.5.15 organization field">organization</a>, +<a href="#bibtex-field-types-publisher" +title="3.5.17 publisher field">publisher</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-manual"></a>3.3.8 +manual entry</h4></div></div></div> +<a id="id2565738" class="indexterm"></a> +<p>Technical documentation.</p> +<p>Format:</p> +<pre class="programlisting"> +@MANUAL{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a></p> +<p>Optional fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-organization" +title="3.5.15 organization field">organization</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-edition" +title="3.5.6 edition field">edition</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="bibtex-entry-types-mastersthesis"></a>3.3.9 mastersthesis +entry</h4></div></div></div> +<a id="id2565854" class="indexterm"></a> +<p>A Master's thesis.</p> +<p>Format:</p> +<pre class="programlisting"> +@MASTERSTHESIS{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-school" +title="3.5.18 school field">school</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-misc"></a>3.3.10 misc +entry</h4></div></div></div> +<a id="id2565963" class="indexterm"></a> +<p>Use this type when nothing else seems appropriate.</p> +<p>Format:</p> +<pre class="programlisting"> +@MISC{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: none</p> +<p>Optional fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-howpublished" +title="3.5.8 howpublished field">howpublished</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-phdthesis"></a>3.3.11 +phdthesis entry</h4></div></div></div> +<a id="id2566065" class="indexterm"></a> +<p>A PhD thesis.</p> +<p>Format:</p> +<pre class="programlisting"> +@PHDTHESIS{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-school" +title="3.5.18 school field">school</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-proceedings"></a>3.3.12 +proceedings entry</h4></div></div></div> +<a id="id2566173" class="indexterm"></a> +<p>The proceedings of a conference.</p> +<p>Format:</p> +<pre class="programlisting"> +@PROCEEDINGS{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-editor" +title="3.5.7 editor field">editor</a>, +<a href="#bibtex-field-types-publisher" +title="3.5.17 publisher field">publisher</a>, +<a href="#bibtex-field-types-organization" +title="3.5.15 organization field">organization</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-techreport"></a>3.3.13 +techreport entry</h4></div></div></div> +<a id="id2566290" class="indexterm"></a> +<p>A report published by a school or other institution, usually +numbered within a series.</p> +<p>Format:</p> +<pre class="programlisting"> +@TECHREPORT{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-institution" +title="3.5.9 institution field">institution</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a></p> +<p>Optional fields: <a href="#bibtex-field-types-type" +title="3.5.21 type field">type</a>, +<a href="#bibtex-field-types-number" +title="3.5.14 number field">number</a>, +<a href="#bibtex-field-types-address" +title="3.5.1 address field">address</a>, +<a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-entry-types-unpublished"></a>3.3.14 +unpublished entry</h4></div></div></div> +<a id="id2566418" class="indexterm"></a> +<p>A document with an author and title, but not formally +published.</p> +<p>Format:</p> +<pre class="programlisting"> +@UNPUBLISHED{citation_key, + required_fields [, optional_fields] } +</pre> +<p>Required fields: <a href="#bibtex-field-types-author" +title="3.5.3 author field">author</a>, +<a href="#bibtex-field-types-title" +title="3.5.20 title field">title</a>, +<a href="#bibtex-field-types-note" +title="3.5.13 note field">note</a></p> +<p>Optional fields: <a href="#bibtex-field-types-month" +title="3.5.12 month field">month</a>, +<a href="#bibtex-field-types-year" +title="3.5.23 year field">year</a>, +<a href="#bibtex-field-types-key" +title="3.5.11 key field">key</a></p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-field-text"></a>3.4 Field +Text</h3></div></div></div> +<a id="id2566513" class="indexterm"></a> +<p>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.</p> +<p>BibTeX manipulates the case of letters in the field text as +described in the subtopics below.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-text-names"></a>3.4.1 +Names</h4></div></div></div> +<a id="id2566554" class="indexterm"></a> +<p>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.</p> +<p>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.)</p> +<p>Most names can be entered in the obvious way, either with or +without a comma, as in the following examples:</p> +<p>"John Paul Jones" "Jones, John Paul" "Ludwig von Beethoven" "von +Beethoven, Ludwig"</p> +<p>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:</p> +<p>"Brinch Hansen, Per"</p> +<p>To understand why, you must understand how BibTeX handles names +(for what follows, a "name" corresponds to a person).</p> +<p>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</p> +<p>"Per Brinch Hansen"</p> +<p>instead, BibTeX would erroneously think "Brinch" were a +First-part token, just as "Paul" is a First-part token in +"John~Paul Jones".</p> +<p>Here's another example:</p> +<p>"Charles Louis Xavier Joseph de la Vallee Poussin"</p> +<p>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.</p> +<p>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:</p> +<p>"{Barnes and Noble, Inc.}" "{Barnes and} {Noble, Inc.}" +"{Barnes} {and} {Noble,} {Inc.}"</p> +<p>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.</p> +<p>So the two names</p> +<p>"von Beethoven, Ludwig" "{von Beethoven}, Ludwig"</p> +<p>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.</p> +<p>"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:</p> +<p>"Ford, Jr., Henry"</p> +<p>However, a few people do not use a comma. They are handled by +considering the "Jr." to be part of the last Last token:</p> +<p>"{Steele Jr.}, Guy L." "Guy L. {Steele Jr.}"</p> +<p>This name has no Jr part.</p> +<p>To summarize, you may type a name in one of three forms:</p> +<p>"First von Last" "von Last, First" "von Last, Jr, First"</p> +<p>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.</p> +<p>If there are multiple authors or editors, their names must be +separated by the word "and", surrounded by spaces, not enclosed in +braces:</p> +<p>AUTHOR = "Ralph Alpher and Bethe, Hans and George Gamow"</p> +<p>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."</p> +<p>BibTeX's rules are actually a bit more complicated than +indicated here, but this description will suffice for most +names.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-text-titles"></a>3.4.2 +Titles</h4></div></div></div> +<a id="id2566787" class="indexterm"></a> +<p>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):</p> +<p>TITLE = "The Agony and the Ecstasy"</p> +<p>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.</p> +<p>"The Gnats and Gnus of {Africa}" "The Gnats and Gnus of +{A}frica"</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-text-abbr"></a>3.4.3 +Abbreviations</h4></div></div></div> +<a id="id2566843" class="indexterm"></a> +<p>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:</p> +<p><tt class="literal">" # % ' ( ) , = { }</tt></p> +<p>The abbreviation is typed in place of the text field, with no +braces or quotation marks. If 'jgg1' is an abbreviation for</p> +<p>Journal of Gnats and Gnus, Series~1</p> +<p>then the following are equivalent:</p> +<p>JOURNAL = jgg1 JOURNAL = "Journal of Gnats and Gnus, +Series~1"</p> +<p>Some abbreviations are predefined by the bibliography style. +These always include the usual 3 letter abbreviations for the +month: jan, feb, mar etc.</p> +<p>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.</p> +<p>You can define your own abbreviations by using BibTeX's +<tt class="literal">@STRING</tt> command.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-field-types"></a>3.5 Field +Types</h3></div></div></div> +<a id="id2566930" class="indexterm"></a> +<p>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.</p> +<p>BibTeX ignores the case of letters in the field names.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-address"></a>3.5.1 +address field</h4></div></div></div> +<a id="id2566969" class="indexterm"></a> +<p>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.</p> +<p>Format:</p> +<pre class="programlisting"> +ADDRESS = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-annote"></a>3.5.2 +annote field</h4></div></div></div> +<a id="id2567012" class="indexterm"></a> +<p>An annotation, used only for annotated bibliography styles +(which are not among the standard ones).</p> +<p>Format:</p> +<pre class="programlisting"> +ANNOTE = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-author"></a>3.5.3 +author field</h4></div></div></div> +<a id="id2567054" class="indexterm"></a> +<p>The name(s) of the author(s).</p> +<p>Format:</p> +<pre class="programlisting"> +AUTHOR = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-booktitle"></a>3.5.4 +booktitle field</h4></div></div></div> +<a id="id2567096" class="indexterm"></a> +<p>Title of a book, part of which is being cited.</p> +<p>Format:</p> +<pre class="programlisting"> +BOOKTITLE = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-chapter"></a>3.5.5 +chapter field</h4></div></div></div> +<a id="id2567138" class="indexterm"></a> +<p>A chapter number.</p> +<p>Format:</p> +<pre class="programlisting"> +CHAPTER = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-edition"></a>3.5.6 +edition field</h4></div></div></div> +<a id="id2567178" class="indexterm"></a> +<p>The edition of a book - for example, "second".</p> +<p>Format:</p> +<pre class="programlisting"> +EDITION = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-editor"></a>3.5.7 +editor field</h4></div></div></div> +<a id="id2567220" class="indexterm"></a> +<p>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.</p> +<p>Format:</p> +<pre class="programlisting"> +EDITOR = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-howpublished"></a>3.5.8 +howpublished field</h4></div></div></div> +<a id="id2567263" class="indexterm"></a> +<p>How something strange has been published.</p> +<p>Format:</p> +<pre class="programlisting"> +HOWPUBLISHED = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-institution"></a>3.5.9 +institution field</h4></div></div></div> +<a id="id2567304" class="indexterm"></a> +<p>The institution that published the work.</p> +<p>Format:</p> +<pre class="programlisting"> +INSTITUTION = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-journal"></a>3.5.10 +journal field</h4></div></div></div> +<a id="id2567346" class="indexterm"></a> +<p>A journal name. Abbreviations are provided for many journals; +see the Local Guide.</p> +<p>Format:</p> +<pre class="programlisting"> +JOURNAL = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-key"></a>3.5.11 key +field</h4></div></div></div> +<a id="id2567388" class="indexterm"></a> +<p>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 +<tt class="literal">\cite</tt> command and at the beginning of the +entry.</p> +<p>Format:</p> +<pre class="programlisting"> +KEY = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-month"></a>3.5.12 month +field</h4></div></div></div> +<a id="id2567438" class="indexterm"></a> +<p>The month in which the work was published or, for an unpublished +work, in which it was written.</p> +<p>Format:</p> +<pre class="programlisting"> +MONTH = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-note"></a>3.5.13 note +field</h4></div></div></div> +<a id="id2567480" class="indexterm"></a> +<p>Any additional information that can help the reader.</p> +<p>Format:</p> +<pre class="programlisting"> +NOTE = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-number"></a>3.5.14 +number field</h4></div></div></div> +<a id="id2567521" class="indexterm"></a> +<p>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.</p> +<p>Format:</p> +<pre class="programlisting"> +NUMBER = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="bibtex-field-types-organization"></a>3.5.15 organization +field</h4></div></div></div> +<a id="id2567565" class="indexterm"></a> +<p>The organization sponsoring a conference.</p> +<p>Format:</p> +<pre class="programlisting"> +ORGANIZATION = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-pages"></a>3.5.16 pages +field</h4></div></div></div> +<a id="id2567607" class="indexterm"></a> +<p>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. ></p> +<p>Format:</p> +<pre class="programlisting"> +PAGES = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-publisher"></a>3.5.17 +publisher field</h4></div></div></div> +<a id="id2567654" class="indexterm"></a> +<p>The publisher's name.</p> +<p>Format:</p> +<pre class="programlisting"> +PUBLISHER = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-school"></a>3.5.18 +school field</h4></div></div></div> +<a id="id2567695" class="indexterm"></a> +<p>The name of the school where a thesis was written.</p> +<p>Format:</p> +<pre class="programlisting"> +SCHOOL = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-series"></a>3.5.19 +series field</h4></div></div></div> +<a id="id2567737" class="indexterm"></a> +<p>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.</p> +<p>Format:</p> +<pre class="programlisting"> +SERIES = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-title"></a>3.5.20 title +field</h4></div></div></div> +<a id="id2567781" class="indexterm"></a> +<p>The work's title.</p> +<p>Format:</p> +<pre class="programlisting"> +TITLE = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-type"></a>3.5.21 type +field</h4></div></div></div> +<a id="id2567821" class="indexterm"></a> +<p>The type of a technical report - for example, "Research +Note".</p> +<p>Format:</p> +<pre class="programlisting"> +TYPE = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-volume"></a>3.5.22 +volume field</h4></div></div></div> +<a id="id2567862" class="indexterm"></a> +<p>The volume of a journal or multivolume book work.</p> +<p>Format:</p> +<pre class="programlisting"> +VOLUME = field_text +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="bibtex-field-types-year"></a>3.5.23 year +field</h4></div></div></div> +<a id="id2567903" class="indexterm"></a> +<p>The year of publication or, for an unpublished work, the year it +was written. This field's text should contain only numerals.</p> +<p>Format:</p> +<pre class="programlisting"> +YEAR = field_text +</pre></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="bibtex-bst-files"></a>4 bst files</h2></div></div></div> +<a id="id2567947" class="indexterm"></a> +<p>Bibliography style files define the style of a bibliography +source list.</p> +<p>The standard bibliography style files are +<a href="#bibtex-bst-plain" +title="4.3 PLAIN.BST"><tt class="filename">PLAIN</tt></a>, +<a href="#bibtex-bst-unsrt" +title="4.5 UNSRT.BST"><tt class="filename">UNSRT</tt></a>, +<a href="#bibtex-bst-alpha" +title="4.2 ALPHA.BST"><tt class="filename">ALPHA</tt></a> and +<a href="#bibtex-bst-abbr" +title="4.1 ABBRV.BST"><tt class="filename">ABBRV</tt></a>.</p> +<p>If you want to make a bibliography style of your own, look at +<a href="#bibtex-bst-sample" +title="4.4 SAMPLE.BST"><tt class="filename">SAMPLE.BST</tt></a>.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-bst-abbr"></a>4.1 +<tt class="filename">ABBRV.BST</tt></h3></div></div></div> +<a id="id2568057" class="indexterm"></a> +<p>This style is the same as the style defined in +<tt class="filename">PLAIN.BST</tt>, except that entries are more +compact because first names, month names and journal names are +abbreviated.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-bst-alpha"></a>4.2 +<tt class="filename">ALPHA.BST</tt></h3></div></div></div> +<a id="id2568101" class="indexterm"></a> +<p>This style is the same as the style defined in +<tt class="filename">PLAIN.BST</tt> except that entry labels like +"Knu66", formed from the author's name and the year of publication, +are used.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-bst-plain"></a>4.3 +<tt class="filename">PLAIN.BST</tt></h3></div></div></div> +<a id="id2568146" class="indexterm"></a> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-bst-sample"></a>4.4 +<tt class="filename">SAMPLE.BST</tt></h3></div></div></div> +<a id="id2568185" class="indexterm"></a> +<p>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:</p> +<p>[Jones79] Jones, R. L. and Richards, P. Q. The Birds and the +Bees. {\it Journal of Irreproducible Results 4}, 2 (Jan. 1979), +27-33.</p> +<p>[Jones82a] Jones, P. G. The Bees and the Trees ... (1982).</p> +<p>[Jones82b] Jones, R. L. The Trees and the Peas ... (1982).</p> +<p>[Krist74] Kristofferson, R. P. Peopl and Places ... (1974)</p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="bibtex-bst-unsrt"></a>4.5 +<tt class="filename">UNSRT.BST</tt></h3></div></div></div> +<a id="id2568257" class="indexterm"></a> +<p>This style is that same as <tt class="filename">PLAIN.BST</tt> +except that entries appear in the order of their first +citation.</p></div></div></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="makeindex"></a>Chapter 6. Make-Index</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#makeindex-options">1 +Options</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#makeindex-option-c">1.1 +<tt class="filename">-c</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-g">1.2 +<tt class="filename">-g</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-i">1.3 +<tt class="filename">-i</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-l">1.4 +<tt class="filename">-l</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-q">1.5 +<tt class="filename">-q</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-r">1.6 +<tt class="filename">-r</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-s-sty">1.7 +<tt class="filename">-s sty</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-o-ind">1.8 +<tt class="filename">-o ind</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-t-log">1.9 +<tt class="filename">-t log</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-p-no">1.10 +<tt class="filename">-p no</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-L">1.11 +<tt class="filename">-L</tt></a></span></dt> +<dt><span class="section"><a href="#makeindex-option-T">1.12 +<tt class="filename">-T</tt></a></span></dt></dl></dd> +<dt><span class="section"><a href="#makeindex-style-file">2 Style +File</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#makeindex-style">2.1 Input +Style Specifiers</a></span></dt> +<dt> +<span class="section"><a href="#makeindex-output-style-specs">2.2 +Output Style Specifiers</a></span></dt></dl></dd> +<dt><span class="section"><a href="#makeindex-example">3 +Example</a></span></dt> +<dt><span class="section"><a href="#makeindex-ordering">4 +Ordering</a></span></dt> +<dt><span class="section"><a href="#makeindex-special-effects">5 +Special Effects</a></span></dt></dl></div> +<a id="id2568311" class="indexterm"></a> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The contents of this section was taken from the HTML helppages +for Make-Index of Norman Walsh (Version 1.0, 12 Apr 94).</p> +<p>Some obvious errors in this documentation have been corrected +according to <tt class="filename">makeindex(1L)</tt>.</p> +<p>Additional information was taken from +<tt class="filename">makeindex(1L)</tt> and the program source +files as found in teTeX 2.0.2.</p></div> +<p>Make-Index 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 +<tt class="literal">.idx</tt> 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 (<tt class="literal">idx0</tt>) is +used to determine other related input/output files. The default +input file type is <tt class="literal">.idx</tt>.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="makeindex-options"></a>1 Options</h2></div></div></div> +<a id="id2568409" class="indexterm"></a> +<p>Make-Index is a Unix program, and therefore has a Unix-style +command line. Instead of qualifiers delimited with a slash +(<tt class="literal">/</tt>), Make-Index options are delimited with +a hyphen (<tt class="literal">-</tt>).</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-c"></a>1.1 +<tt class="filename">-c</tt></h3></div></div></div> +<a id="id2568460" class="indexterm"></a> +<p>Enable blank compression. By default every blank counts in the +index key. The <tt class="literal">-c</tt> option ignores leading +and trailing blanks and tabs and compresses intermediate ones to a +single space.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-g"></a>1.2 +<tt class="filename">-g</tt></h3></div></div></div> +<a id="id2568504" class="indexterm"></a> +<p>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 +<tt class="literal">'+'</tt>). If the quote character is not +redefined, Make-Index will produce an error message and +abort.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-i"></a>1.3 +<tt class="filename">-i</tt></h3></div></div></div> +<a id="id2568553" class="indexterm"></a> +<p>Use <tt class="literal">stdin</tt> as the input file. When this +option is specified and the <tt class="literal">-o</tt> is not, +output is written to <tt class="literal">stdout</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-l"></a>1.4 +<tt class="filename">-l</tt></h3></div></div></div> +<a id="id2568607" class="indexterm"></a> +<p>Use letter ordering. Default is word ordering (explained in the +<a href="#makeindex-ordering" title="4 Ordering">Ordering</a> +section).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-q"></a>1.5 +<tt class="filename">-q</tt></h3></div></div></div> +<a id="id2568652" class="indexterm"></a> +<p>Quiet mode, send no messages to <tt class="literal">stderr</tt>. +By default progress and error messages are sent to +<tt class="literal">stderr</tt> as well as the transcript file. The +<tt class="literal">-q</tt> option disables the +<tt class="literal">stderr</tt> messages.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-r"></a>1.6 +<tt class="filename">-r</tt></h3></div></div></div> +<a id="id2568712" class="indexterm"></a> +<p>Disable implicit page range formation. By default three or more +successive pages will be automatically abbreviated as a range (e.g. +1--5). The <tt class="literal">-r</tt> option disables it, making +the explicit range operators the only way to create page ranges +(see the <a href="#makeindex-special-effects" +title="5 Special Effects">Special Effects</a> section +below).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-s-sty"></a>1.7 +<tt class="filename">-s sty</tt></h3></div></div></div> +<a id="id2568768" class="indexterm"></a> +<p>Take <tt class="literal">sty</tt> 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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-o-ind"></a>1.8 +<tt class="filename">-o ind</tt></h3></div></div></div> +<a id="id2568813" class="indexterm"></a> +<p>Take <tt class="literal">ind</tt> as the output index file. By +default the file name base of the first input file +<tt class="literal">idx0</tt> concatenated with the extension +<tt class="literal">.ind</tt> is used as the output file +name.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-t-log"></a>1.9 +<tt class="filename">-t log</tt></h3></div></div></div> +<a id="id2568869" class="indexterm"></a> +<p>Take <tt class="literal">log</tt> as the transcript file. By +default the file name base of the first input file +<tt class="literal">idx0</tt> concatenated with the extension +<tt class="literal">.ilg</tt> is used as the transcript file +name.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-p-no"></a>1.10 +<tt class="filename">-p no</tt></h3></div></div></div> +<a id="id2568925" class="indexterm"></a> +<p>Set the starting page number of the output index file to be +<tt class="literal">no</tt>. This is useful when the index file is +to be formatted separately. Other than pure numbers, three special +cases are allowed for no: <tt class="literal">any</tt>, +<tt class="literal">odd</tt>, and <tt class="literal">even</tt>. 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 (<tt class="literal">idx0</tt>) +with the extension <tt class="literal">.log</tt>. The last source +page is obtained by searching backward in the log file for the +first instance of a number included in +<tt class="literal">[...]</tt>. 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:</p> +<div class="variablelist"> +<dl> +<dt><span class="term">any</span></dt> +<dd> +<p>The starting page is the last source page number plus +1.</p></dd> +<dt><span class="term">odd</span></dt> +<dd> +<p>The starting page is the first odd page following the last +source page number.</p></dd> +<dt><span class="term">even</span></dt> +<dd> +<p>The starting page is the first even page following the last +source page number.</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-L"></a>1.11 +<tt class="filename">-L</tt></h3></div></div></div> +<a id="id2569061" class="indexterm"></a> +<p>Sort based on locale settings. String comparisons for sorting +are done using <span><b class="command">strcoll(3)</b></span>, +which compares strings according to the current locale category +<tt class="literal">LC_COLLATE</tt>.</p> +<p>Not available on all systems (depends on compile time +settings).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-option-T"></a>1.12 +<tt class="filename">-T</tt></h3></div></div></div> +<a id="id2569115" class="indexterm"></a> +<p>Special support for Thai documents.</p> +<p>Not available on all systems (depends on compile time +settings).</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="makeindex-style-file"></a>2 Style +File</h2></div></div></div> +<a id="id2569152" class="indexterm"></a> +<p>The style file format is very simple. It is a list of +<tt class="literal"><specifier, attribute></tt> 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 +`<tt class="literal">%</tt>' is a comment. The following is a list +of all the specifiers and their respective arguments where +<tt class="literal"><string></tt> is an arbitrary string +delimited by double quotes (<tt class="literal">"..."</tt>), +<tt class="literal"><char></tt> is a single letter embraced +by single quotes (<tt class="literal">'...'</tt>), and +<tt class="literal"><number></tt> is a nonnegative integer. +The maximum length of a <tt class="literal"><string></tt> 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 <tt class="envar">INDEXSTYLE</tt>.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-style"></a>2.1 Input Style +Specifiers</h3></div></div></div> +<a id="id2569242" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-actual-char"></a>2.1.1 actual +<char></h4></div></div></div> +<a id="id2569266" class="indexterm"></a> +<p>Default: <tt class="literal">@</tt></p> +<p>The symbol which indicates that the next entry is to appear in +the actual index file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-arg-close"></a>2.1.2 arg_close +<char></h4></div></div></div> +<a id="id2569306" class="indexterm"></a> +<p>Default: <tt class="literal">}</tt></p> +<p>This is the closing delimiter for the index entry +argument.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-style-arg-open"></a>2.1.3 +arg_open <char></h4></div></div></div> +<a id="id2569350" class="indexterm"></a> +<p>Default: <tt class="literal">{</tt></p> +<p>This is the opening delimiter for the index entry +argument.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-encap-char"></a>2.1.4 encap +<char></h4></div></div></div> +<a id="id2569390" class="indexterm"></a> +<p>Default: <tt class="literal">|</tt></p> +<p>The symbol which indicates that the rest of the argument list is +to be used as the encapsulating command for the page +number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-escape-char"></a>2.1.5 escape +<char></h4></div></div></div> +<a id="id2569430" class="indexterm"></a> +<p>Default: <tt class="literal">\\</tt></p> +<p>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.</p> +<p>Notice that the two symbols must be distinct.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-style-string"></a>2.1.6 keyword +<string></h4></div></div></div> +<a id="id2569478" class="indexterm"></a> +<p>Default: <tt class="literal">"\\indexentry"</tt></p> +<p>This is the command which tells Make-Index that its argument is +an index entry.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-level-char"></a>2.1.7 level +<char></h4></div></div></div> +<a id="id2569521" class="indexterm"></a> +<p>Default: <tt class="literal">!</tt></p> +<p>The delimiter which denotes a new level of subitem.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-quote-char"></a>2.1.8 quote +<char></h4></div></div></div> +<a id="id2569561" class="indexterm"></a> +<p>Default: <tt class="literal">"</tt></p> +<p><tt class="literal">quote</tt> 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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-range-close"></a>2.1.9 +range_close <char></h4></div></div></div> +<a id="id2569608" class="indexterm"></a> +<p>Default: <tt class="literal">)</tt></p> +<p>The closing delimiter indicating the end of an explicit page +range.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-range-open"></a>2.1.10 +range_open <char></h4></div></div></div> +<a id="id2569648" class="indexterm"></a> +<p>Default: <tt class="literal">(</tt></p> +<p>The opening delimiter indicating the beginning of an explicit +page range.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="makeindex-output-style-specs"></a>2.2 +Output Style Specifiers</h3></div></div></div> +<a id="id2569690" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-page-compositor"></a>2.2.1 +page_compositor <string></h4></div></div></div> +<a id="id2569713" class="indexterm"></a> +<p>Default: <tt class="literal">"-"</tt></p> +<p>This specifier is used to separate a range of page numbers.</p> +<p>Officially undocumented!</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-preamble-string"></a>2.2.2 preamble +<string></h4></div></div></div> +<a id="id2569758" class="indexterm"></a> +<p>Default: <tt class="literal">"\\begin{theindex}\n"</tt></p> +<p>The preamble of actual index file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-postamble-string"></a>2.2.3 postamble +<string></h4></div></div></div> +<a id="id2569798" class="indexterm"></a> +<p>Default: <tt class="literal">"\n\n\\end{theindex}\n"</tt></p> +<p>The postamble of actual index file.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-setpage-prefix"></a>2.2.4 +setpage_prefix <string></h4></div></div></div> +<a id="id2569838" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\setcounter{page}{"</tt></p> +<p>The prefix of the command which sets the starting page +number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-setpage-suffix"></a>2.2.5 +setpage_suffix <string></h4></div></div></div> +<a id="id2569880" class="indexterm"></a> +<p>Default: <tt class="literal">"}\n"</tt></p> +<p>The suffix of the command which sets the starting page +number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-group-skip"></a>2.2.6 +group_skip <string></h4></div></div></div> +<a id="id2569921" class="indexterm"></a> +<p>Default: <tt class="literal">"\n\n \\indexspace\n"</tt></p> +<p>The vertical space to be inserted before a new group +begins.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-heading-prefix-string"></a>2.2.7 +heading_prefix <string></h4></div></div></div> +<a id="id2569960" class="indexterm"></a> +<p>Default: <tt class="literal">""</tt></p> +<p>The header prefix to be inserted before a new letter +begins.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-heading-suffix-string"></a>2.2.8 +heading_suffix <string></h4></div></div></div> +<a id="id2570000" class="indexterm"></a> +<p>Default: <tt class="literal">""</tt></p> +<p>The header suffix to be inserted before a new letter +begins.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-headings-flag"></a>2.2.9 +headings_flag <string></h4></div></div></div> +<a id="id2570041" class="indexterm"></a> +<p>Default: <tt class="literal">0</tt></p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-symhead-positive"></a>2.2.10 +symhead_positive <string></h4></div></div></div> +<a id="id2570084" class="indexterm"></a> +<p>Default: <tt class="literal">"Symbols"</tt></p> +<p>Heading for symbols to be inserted if +<tt class="literal">headings_flag</tt> is positive.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-symhead-negative"></a>2.2.11 +symhead_negative <string></h4></div></div></div> +<a id="id2570131" class="indexterm"></a> +<p>Default: <tt class="literal">"symbols"</tt></p> +<p>Heading for symbols to be inserted if +<tt class="literal">headings_flag</tt> is negative.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-numhead-positive"></a>2.2.12 +numhead_positive <string></h4></div></div></div> +<a id="id2570178" class="indexterm"></a> +<p>Default: <tt class="literal">"Numbers"</tt></p> +<p>Heading for numbers to be inserted if +<tt class="literal">headings_flag</tt> is positive.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="makeindex-output-numhead-negative"></a>2.2.13 +numhead_negative <string></h4></div></div></div> +<a id="id2570224" class="indexterm"></a> +<p>Default: <tt class="literal">"numbers"</tt></p> +<p>Heading for numbers to be inserted if +<tt class="literal">headings_flag</tt> is negative.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-0"></a>2.2.14 item_0 +<string></h4></div></div></div> +<a id="id2570271" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\item "</tt></p> +<p>The command to be inserted between two primary (level 0) +items.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-1"></a>2.2.15 item_1 +<string></h4></div></div></div> +<a id="id2570312" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\subitem "</tt></p> +<p>The command to be inserted between two secondary (level 1) +items.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-2"></a>2.2.16 item_2 +<string></h4></div></div></div> +<a id="id2570352" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\subsubitem "</tt></p> +<p>The command to be inserted between two level 2 items.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-01"></a>2.2.17 +item_01 <string></h4></div></div></div> +<a id="id2570392" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\subitem "</tt></p> +<p>The command to be inserted between a level 0 item and a level 1 +item.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-x1"></a>2.2.18 +item_x1 <string></h4></div></div></div> +<a id="id2570432" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\subitem "</tt></p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-12"></a>2.2.19 +item_12 <string></h4></div></div></div> +<a id="id2570474" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\subsubitem "</tt></p> +<p>The command to be inserted between a level 1 item and a level 2 +item.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-item-x2"></a>2.2.20 +item_x2 <string></h4></div></div></div> +<a id="id2570515" class="indexterm"></a> +<p>Default: <tt class="literal">"\n \\subsubitem "</tt></p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-delim-0"></a>2.2.21 +delim_0 <string></h4></div></div></div> +<a id="id2570557" class="indexterm"></a> +<p>Default: <tt class="literal">", "</tt></p> +<p>The delimiter to be inserted between a level 0 key and its first +page number. Default is a comma followed by a blank.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-delim-1"></a>2.2.22 +delim_1 <string></h4></div></div></div> +<a id="id2570598" class="indexterm"></a> +<p>Default: <tt class="literal">", "</tt></p> +<p>The delimiter to be inserted between a level 1 key and its first +page number. Default is a comma followed by a blank.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-delim-2"></a>2.2.23 +delim_2 <string></h4></div></div></div> +<a id="id2570640" class="indexterm"></a> +<p>Default: <tt class="literal">", "</tt></p> +<p>The delimiter to be inserted between a level 2 key and its first +page number. Default is a comma followed by a blank.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-delim-n"></a>2.2.24 +delim_n <string></h4></div></div></div> +<a id="id2570681" class="indexterm"></a> +<p>Default: <tt class="literal">", "</tt></p> +<p>The delimiter to be inserted between two page numbers for the +same key in any level. Default is a comma followed by a +blank.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-delim-r"></a>2.2.25 +delim_r <string></h4></div></div></div> +<a id="id2570722" class="indexterm"></a> +<p>Default: <tt class="literal">"--"</tt></p> +<p>The delimiter to be inserted between the starting and ending +page numbers of a range.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-delim-t"></a>2.2.26 +delim_t <string></h4></div></div></div> +<a id="id2570762" class="indexterm"></a> +<p>Default: <tt class="literal">""</tt></p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-encap-prefix"></a>2.2.27 +encap_prefix <string></h4></div></div></div> +<a id="id2570803" class="indexterm"></a> +<p>Default: <tt class="literal">"\\"</tt></p> +<p>The prefix for the command which encapsulates the page +number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-encap-infox"></a>2.2.28 +encap_infix <string></h4></div></div></div> +<a id="id2570844" class="indexterm"></a> +<p>Default: <tt class="literal">"{"</tt></p> +<p>The prefix for the command which encapsulates the page +number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-encap-suffix"></a>2.2.29 +encap_suffix <string></h4></div></div></div> +<a id="id2570885" class="indexterm"></a> +<p>Default: <tt class="literal">"}"</tt></p> +<p>The suffix for the command which encapsulates the page +number.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-line-max"></a>2.2.30 +line_max <number></h4></div></div></div> +<a id="id2570925" class="indexterm"></a> +<p>Default: <tt class="literal">72</tt></p> +<p>The maximum length of a line in the output beyond which a line +wraps around.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-indent-space"></a>2.2.31 +indent_space <string></h4></div></div></div> +<a id="id2570965" class="indexterm"></a> +<p>Default: <tt class="literal">"\t\t"</tt></p> +<p>The space to be inserted in front of a wrapped line. Default is +two tabs.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-indent-length"></a>2.2.32 +indent_length <number></h4></div></div></div> +<a id="id2571006" class="indexterm"></a> +<p>Default: <tt class="literal">16</tt></p> +<p>The length of indent_space. In the default case this is 16 (for +2 tabs).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-suffix-2p"></a>2.2.33 +suffix_2p <string></h4></div></div></div> +<a id="id2571047" class="indexterm"></a> +<p>Default: <tt class="literal">""</tt></p> +<p>Delimiter to replace the range delimiter and the second page +number of a two page list. When present, it overrides +<tt class="literal">delim_r</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-suffix-3p"></a>2.2.34 +suffix_3p <string></h4></div></div></div> +<a id="id2571094" class="indexterm"></a> +<p>Default: <tt class="literal">""</tt></p> +<p>Delimiter to replace the range delimiter and the second page +number of a three page list. When present, it overrides +<tt class="literal">delim_r</tt> and +<tt class="literal">suffix_mp</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="makeindex-output-suffix-mp"></a>2.2.35 +suffix_mp <string></h4></div></div></div> +<a id="id2571147" class="indexterm"></a> +<p>Default: <tt class="literal">""</tt></p> +<p>Delimiter to replace the range delimiter and the second page +number of a multiple page list (three or more pages). When present, +it overrides +<tt class="literal">delim_r</tt>.</p></div></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="makeindex-example"></a>3 Example</h2></div></div></div> +<a id="id2571196" class="indexterm"></a> +<p>The following example shows a style file called +<tt class="literal">book.isty</tt> which defines a stand-alone +index for a book. By stand-alone, we mean it can be formatted +independent of the main source.</p> +<pre class="programlisting"> +preamble +"\\documentstyle[12pt]{book} +\\begin{document} +\\begin{theindex} +{\\small\n" + +postamble +"\n\n} +\\end{theindex} +\\end{document}\n" +</pre> +<p>Suppose a particular book style requires the index (as well as +any chapters) to start from an odd page number. Given +<tt class="literal">foo.idx</tt> as the raw index file, the +following command line produces an index in file +<tt class="literal">foo-.ind</tt>.</p> +<pre class="programlisting"> +makeindex -s book.isty -o foo-.ind -p odd foo +</pre> +<p>The reason to use a non-default output file name is to avoid +clobbering the source output (presumably +<tt class="literal">foo.dvi</tt>) because if the index is in file +<tt class="literal">foo.ind</tt>, its output will also be in +<tt class="literal">foo.dvi</tt> as a result of separate formatting +using . In the example the index is in +<tt class="literal">foo-.ind</tt>, its output will be in +<tt class="literal">foo-.dvi</tt> and thus introduces no +confusion.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="makeindex-ordering"></a>4 Ordering</h2></div></div></div> +<a id="id2571306" class="indexterm"></a> +<p>By default <tt class="literal">makeindex</tt> assumes word +ordering. The <tt class="literal">-l</tt> 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:</p> +<div class="informaltable"> +<table border="0"> +<colgroup> +<col align="left" /> +<col align="left" /></colgroup> +<thead> +<tr> +<th align="left"><span class="emphasis"><em>word +order</em></span></th> +<th align="left"><span class="emphasis"><em>letter +order</em></span></th></tr></thead> +<tbody> +<tr> +<td align="left">sea lion</td> +<td align="left">seal</td></tr> +<tr> +<td align="left">seal</td> +<td align="left">seal lion</td></tr></tbody></table></div> +<p>Numbers are sorted in numeric order. For instance,</p> +<div class="informaltable"> +<table border="0"> +<colgroup> +<col align="left" /></colgroup> +<tbody> +<tr> +<td align="left">9 (nine), 123</td></tr> +<tr> +<td align="left">123 10 (ten), see Derek, +Bo</td></tr></tbody></table></div> +<p>Letters are first sorted with uppercase and lowercase considered +identical; then, within identical words the uppercase letter +precedes its lowercase counterpart.</p> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="makeindex-special-effects"></a>5 Special +Effects</h2></div></div></div> +<a id="id2571484" class="indexterm"></a> +<p>In the normal case entries such as</p> +<pre class="programlisting"> +\indexentry{alpha}{1} +\indexentry{alpha!beta}{3} +\indexentry{alpha!beta!gamma}{10} +</pre> +<p>in the raw index file will be converted to</p> +<pre class="programlisting"> +\item alpha, 1 + \subitem beta, 3 + \subsubitem gamma, 10 +</pre> +<p>in the output index file by Make-Index. Notice that the level +symbol (<tt class="literal">!</tt>) is used to delimit levels of +nesting.</p> +<p>It is possible to make an item appear in a designated form by +using the actual (<tt class="literal">@</tt>) operator. For +instance,</p> +<pre class="programlisting"> +\indexentry{alpha@{\it alpha\/}}{1} +</pre> +<p>will become</p> +<pre class="programlisting"> +\item {\it alpha\/} 1 +</pre> +<p>after the conversion. The idea is that the pattern preceding +<tt class="literal">@</tt> 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.</p> +<p>It is also possible to encapsulate a page number with a +designated command using the encap (<tt class="literal">|</tt>) +operator. For example, in the default case,</p> +<pre class="programlisting"> +\indexentry{alpha|bold}{1} +</pre> +<p>will be converted to</p> +<pre class="programlisting"> +\item alpha \bold{1} +</pre> +<p>where <tt class="literal">\bold{n}</tt> will expand to +<tt class="literal">{\bf n}</tt>. 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 +<tt class="literal">encap_prefix</tt>, +<tt class="literal">encap_infix</tt>, and +<tt class="literal">encap_suffix</tt> correspond respectively to +backslash, left brace, and right brace. If this is to be formatted +by languages other than , they would be defined differently.</p> +<p>By the same token, the <tt class="literal">encap</tt> operator +can be used to make cross references in the index. For +instance,</p> +<pre class="programlisting"> +\indexentry{alpha|see{beta}}{1} +</pre> +<p>will become</p> +<pre class="programlisting"> +\item alpha \see{beta}{1} +</pre> +<p>in the output index file after the conversion, where</p> +<pre class="programlisting"> +\see{beta}{1} +</pre> +<p>will expand to</p> +<pre class="programlisting"> +{\it see\/} beta +</pre> +<p>Notice that in a cross reference like this the page number +disappears. Therefore, where to insert such a command in the source +is immaterial.</p> +<p>A pair of encap concatenated with +<tt class="literal">range_open</tt> (<tt class="literal">|(</tt>) +and with <tt class="literal">range_close</tt> +(<tt class="literal">|)</tt>) creates an explicit page range. That +is,</p> +<pre class="programlisting"> +\indexentry{alpha|(}{1} +\indexentry{alpha|)}{5} +</pre> +<p>will become</p> +<pre class="programlisting"> +\item alpha, 1--5 +</pre> +<p>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.</p> +<p>This explicit page range formation can also include an extra +command to set the page range in a designated font. Thus</p> +<pre class="programlisting"> +\indexentry{alpha|(bold}{1} +\indexentry{alpha|)}{5} +</pre> +<p>will become</p> +<pre class="programlisting"> +\item alpha, \bold{1--5} +</pre> +<p>A couple of special cases are worth mentioning here. First, +entries like</p> +<pre class="programlisting"> +\indexentry{alpha|(}{1} +\indexentry{alpha|bold}{3} +\indexentry{alpha|)}{5} +</pre> +<p>will be interpreted as</p> +<pre class="programlisting"> +\item alpha, \bold{3}, 1--5 +</pre> +<p>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,</p> +<pre class="programlisting"> +\indexentry{alpha|(}{i} +\indexentry{alpha}{iv} +\indexentry{alpha}{3} +\indexentry{alpha|)}{7} +</pre> +<p>will be turned into</p> +<pre class="programlisting"> +\item alpha, 1--iv, 3--7 +</pre> +<p>with a warning message in the transcript complaining about the +illegal range formation.</p> +<p>Finally, every special symbol mentioned in this section may be +escaped by the quote operator (<tt class="literal">"</tt>). +Thus</p> +<pre class="programlisting"> +\indexentry{alpha"@beta}{1} +</pre> +<p>will actually become</p> +<pre class="programlisting"> +\item alpha@beta, 1 +</pre> +<p>as a result of executing Make-Index. However, if quote is +preceded by escape (<tt class="literal">\</tt>), its following +letter is not escaped. That is,</p> +<pre class="programlisting"> +\indexentry{f\"ur}{1} +</pre> +<p>means</p> +<pre class="programlisting"> +\item f\"ur, 1 +</pre> +<p>which represents umlaut accented <tt class="literal">u</tt> to +the family of processors.</p></div></div> +<div class="chapter" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="xindy"></a>Chapter 7. xindy</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#xindy-command-list">1 Command +List</a></span></dt> +<dd> +<dl> +<dt> +<span class="section"><a href="#xindy-command-list-processing">1.1 +Processing Commands</a></span></dt> +<dt><span class="section"><a href="#xindy-command-list-markup">1.2 +Markup Commands</a></span></dt> +<dt> +<span class="section"><a href="#xindy-command-list-raw-index">1.3 +Raw Index Interface</a></span></dt></dl></dd> +<dt><span class="section"><a href="#xindy-invoking">2 Invoking +xindy</a></span></dt> +<dd> +<dl> +<dt><span class="section"><a href="#xindy-invoking-cmdline">2.1 +Command Line Options</a></span></dt> +<dt><span class="section"><a href="#xindy-search-path">2.2 Search +Path</a></span></dt></dl></dd></dl></div> +<a id="id2571856" class="indexterm"></a> +<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Note</h3> +<p>The content of this section was taken from the original +documentation of xindy V2.1 +(<tt class="filename">Doc/manual*.html</tt>).</p></div> +<p><span class="emphasis"><em>xindy</em></span> means +fle<span class="emphasis"><em>x</em></span>ible +<span class="emphasis"><em>ind</em></span>exing +s<span class="emphasis"><em>y</em></span>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.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"> +<a id="xindy-command-list"></a>1 Command +List</h2></div></div></div> +<a id="id2571920" class="indexterm"></a> +<p>Here is the complete list of xindy's commands that may be used +in the index style. The symbol <tt class="literal">name</tt> always +refers to a string. We separate the commands into the processing +and markup commands. The commands are listed in alphabetical +order.</p> +<p>The parenthesis <tt class="literal">[</tt> and +<tt class="literal">]</tt> denote optional parts of the syntax and +<tt class="literal">{</tt> and <tt class="literal">}</tt> denote +the grouping of elements. A vertical bar indicates alternatives. +However, the enclosing round braces +<span class="emphasis"><em>are</em></span> part of the syntax and +must be supplied.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="xindy-command-list-processing"></a>1.1 +Processing Commands</h3></div></div></div> +<a id="id2571990" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-alphabet"></a>1.1.1 +<tt class="literal">define-alphabet</tt></h4></div></div></div> +<a id="id2572018" class="indexterm"></a> +<pre class="programlisting"> +(define-alphabet name string-list) +</pre> +<p>Defines <tt class="literal">name</tt> to be the alphabet +consisting of all elements of the +<tt class="literal">string-list</tt>. Examples:</p> +<pre class="programlisting"> +(define-alphabet "example-alphabet" ("An" "Example" "Alphabet")) +</pre> +<p>defines an alphabet consisting of exactly three symbols. For the +successor relationship holds: +<tt class="literal">succ("An")="Example"</tt> and +<tt class="literal">succ("Example")="Alphabet"</tt>. The built-in +alphabet <tt class="literal">digits</tt> is defined as follows:</p> +<pre class="programlisting"> +(define-alphabet "digits" + ("0" "1" "2" "3" "4" "5" "6" "7" "8" "9")) +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-attributes"></a>1.1.2 +<tt class="literal">define-attributes</tt></h4></div></div></div> +<a id="id2572110" class="indexterm"></a> +<pre class="programlisting"> +(define-attributes attribute-list) +</pre> +<p>Defines all attributes the raw index may contain. Parameter +<tt class="literal">attribute-list</tt> is a list of list of +strings. The nesting level must not be more than 2. So +<tt class="literal">(..(..)..)</tt> is allowed, whereas +<tt class="literal">(..(..(..)..)..)</tt> is not.</p> +<p>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 <tt class="literal">("definition")</tt> and +<tt class="literal">( ("definition") )</tt> are equivalent. All +elements forming a list are a so-called +<span class="emphasis"><em>attribute group</em></span>. The members +of a group are written to the output file before any member of the +following groups are written.</p> +<p>Examples of valid attributes lists are:</p> +<p><tt class="literal">("definition" "usage")</tt> defines two +attribute groups. The first one contains all references with the +attribute <tt class="literal">definition</tt> and the second one +all with the attribute <tt class="literal">usage</tt>.</p> +<p><tt class="literal">(("definition" "important") "usage")</tt> +defines two attribute groups. The first one contains all references +with the attributes <tt class="literal">definition</tt> or +<tt class="literal">important</tt> and the second one all with the +attribute <tt class="literal">usage</tt>. In the attribute group +<tt class="literal">("definition" "important")</tt> the attribute +<tt class="literal">definition</tt> overrides +<tt class="literal">important</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-crossref-class"></a>1.1.3 +<tt class="literal">define-crossref-class</tt></h4></div></div></div> +<a id="id2572272" class="indexterm"></a> +<pre class="programlisting"> +(define-crossref-class name [:unverified]) +</pre> +<p>Defines <tt class="literal">name</tt> to be a class of cross +references. We distinguish two types of cross reference classes. +<span class="emphasis"><em>Verified</em></span> 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 <tt class="literal">:unverified</tt> +can be used to suppress this behaviour.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-letter-group"></a>1.1.4 +<tt class="literal">define-letter-group</tt></h4></div></div></div> +<a id="id2572338" class="indexterm"></a> +<pre class="programlisting"> +(define-letter-group name [:before lgname] [:after lgname] + [:prefixes list-of-prefixes]) +</pre> +<pre class="programlisting"> +(define-letter-groups list-of-letter-groups) +</pre> +<p>This command defines a letter group with name +<tt class="literal">name</tt>, which must be a string value, +grouping all index entries that have a +<span class="emphasis"><em>sort key</em></span> beginning with the +prefix <tt class="literal">name</tt>. The command</p> +<pre class="programlisting"> +(define-letter-group "a") +</pre> +<p>is equivalent to the command</p> +<pre class="programlisting"> +(define-letter-group "a" :prefixes ("a")) +</pre> +<p>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.</p> +<p>Example:</p> +<pre class="programlisting"> +(define-letter-group "a") +</pre> +<p>defines a letter group containing all index entries beginning +with the string <tt class="literal">"a"</tt>.</p> +<pre class="programlisting"> +(define-letter-group "c" :after "a") +</pre> +<p>defines a letter group containing all index entries beginning +with the string <tt class="literal">"c"</tt>. The letter group +appears behind the letter group <tt class="literal">"a"</tt></p> +<pre class="programlisting"> +(define-letter-group "b" :after "a" :before "c") +</pre> +<p>inserts letter group <tt class="literal">"b"</tt> between letter +group <tt class="literal">"a"</tt> and +<tt class="literal">"c"</tt>. This allows incremental definition of +letter groups by extending already defined ones.</p> +<p>The arguments <tt class="literal">:after</tt> and +<tt class="literal">:before</tt> 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.</p> +<p>The command <tt class="literal">define-letter-groups</tt> (with +an `s' at the end) is simply an abbreviation for a sequence of +<tt class="literal">define-letter-group</tt> definitions where the +elements are ordered in the ordering given by the list. +Example:</p> +<pre class="programlisting"> +(define-letter-groups ("a" "b" "c") +</pre> +<p>equals the definitions</p> +<pre class="programlisting"> +(define-letter-group "a") +(define-letter-group "b" :after "a") +(define-letter-group "c" :after "b") +</pre> +<p>See also commands +<tt class="literal">markup-letter-group-list</tt> and +<tt class="literal">markup-letter-group</tt> for further +information.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-location-class"></a>1.1.5 +<tt class="literal">define-location-class</tt></h4></div></div></div> +<a id="id2572569" class="indexterm"></a> +<pre class="programlisting"> +(define-location-class name layer-list + [:min-range-length num] + [:hierdepth depth] + [:var]) +</pre> +<p>Defines <tt class="literal">name</tt> 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 +<tt class="literal">:sep</tt>. If the keyword +<tt class="literal">:min-range-length</tt> is specified we define +the <span class="emphasis"><em>minimum range length</em></span> to +be used when building ranges. The argument +<tt class="literal">num</tt> must be a positive integer number or +the keyword <tt class="literal">none</tt> in which case the +building of ranges is disallowed. If the switch +<tt class="literal">:var</tt> is specified the declared class is of +type <span class="emphasis"><em>variable</em></span>, i.e. it is a +<span class="emphasis"><em>var-location-class</em></span>. Since +building of ranges is currently only allowed for standard classes +<tt class="literal">:var</tt> and +<tt class="literal">:min-range-length</tt> must not be used +together. The keyword argument <tt class="literal">:hierdepth</tt> +can be used to declare that the location references have to be +tagged in a hierarchical form. Its argument +<tt class="literal">depth</tt> must be an integer number indicating +the number of layers the hierarchy does contain. See command +<tt class="literal">markup-locref-list</tt> for more information. +Examples:</p> +<pre class="programlisting"> +(define-location-class "page-numbers" ("arabic-numbers") + :minimum-range-length 3) +</pre> +<p>Defines the location class <tt class="literal">page-numbers</tt> +consisting of one layer which is the alphabet +<tt class="literal">arabic-numbers</tt>. 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 <tt class="literal">0, 1, ... 2313</tt>, etc.</p> +<pre class="programlisting"> +(define-location-class "sections" :var + ("arabic-numbers" :sep "." + "arabic-numbers" :sep "." + "arabic-numbers")) +</pre> +<p>defines a variable location class. Valid instances are +<tt class="literal">1, 1.1, 1.2, 2, 2.4.5</tt>, but none of +<tt class="literal">2-3</tt> (wrong separator), +<tt class="literal">1.2.3.4</tt> (more than 3 layers), +<tt class="literal">2.3.iv</tt> (roman number instead of arabic +one).</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-location-class-order"></a>1.1.6 +<tt class="literal">define-location-class-order</tt></h4></div></div></div> +<a id="id2572772" class="indexterm"></a> +<pre class="programlisting"> +(define-location-class-order list) +</pre> +<p>Defines the order in which the location classes are written to +the output file. The parameter <tt class="literal">list</tt> is a +list of names of location classes. Examples:</p> +<pre class="programlisting"> +(define-location-class-order + ("page-numbers" "sections" "xrefs")) +</pre> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-rule-set"></a>1.1.7 +<tt class="literal">define-rule-set</tt></h4></div></div></div> +<a id="id2572847" class="indexterm"></a> +<pre class="programlisting"> +(define-rule-set name + [ :inherit-from ("rule-set" "rule-set-2") ] + :rules (<rule>...) ) +</pre> +<p>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 <tt class="literal">sort-rule</tt>. They do not add new +functionality that is not already present with +<tt class="literal">sort-rule</tt>.</p> +<p>A rule can be of the form:</p> +<pre class="programlisting"> +<rule> ::= ("pattern" "replacement" + [:string|:bregexp|:egegexp] [:again]) +</pre> +<p>The following incomplete example defines a new rule set of name +<tt class="literal">isolatin1-tolower</tt> that inherits +definitions from rule set <tt class="literal">latin-tolower</tt>, +overriding or adding the sort rules in the list of +<tt class="literal">:rules</tt>.</p> +<pre class="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) + ... + ) +...) +</pre> +<p>Rule sets can be instantiated with the command +<tt class="literal">use-rule-set</tt>. For further descriptions on +the sorting model refer to the command +<tt class="literal">sort-rule</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-define-sort-rule-orientations"> +</a>1.1.8 +<tt class="literal">define-sort-rule-orientations</tt></h4></div></div></div> +<a id="id2572976" class="indexterm"></a> +<pre class="programlisting"> +(define-sort-rule-orientations (orientations...)) +</pre> +<p>Defines the order for the different sorting phases. The +currently implemented +<span class="emphasis"><em>orientations</em></span> are +<tt class="literal">forward</tt> and +<tt class="literal">backward</tt>. This command must precede all +<tt class="literal">sort-rule</tt> commands in an index style. It +defines the orientations and implicitly sets the maximum number of +sorting phases performed.</p> +<p>For further descriptions on the sorting model refer to the +command <tt class="literal">sort-rule</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-merge-rule"></a>1.1.9 +<tt class="literal">merge-rule</tt></h4></div></div></div> +<a id="id2573057" class="indexterm"></a> +<pre class="programlisting"> +(merge-rule pattern replacement [:again] + [:bregexp | :eregexp | :string]) +</pre> +<p>Defines a keyword mapping rule that can be used to generate the +<span class="emphasis"><em>merge key</em></span> from the +<span class="emphasis"><em>main key</em></span> 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.</p> +<p>The parameter <tt class="literal">pattern</tt> 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 <span class="emphasis"><em>basic regular +expressions</em></span> (BREs) or +<span class="emphasis"><em>extended regular expressions</em></span> +(EREs). You can use the switch <tt class="literal">:bregexp</tt> to +force the interpretation of the pattern as a BRE, or +<tt class="literal">:eregexp</tt> to interpret it as an ERE. If you +want xindy to interpret the pattern literally, use the switch +<tt class="literal">:string</tt>. 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.</p> +<p>The parameter <tt class="literal">replacement</tt> must be a +string possibly containing the special characters +<tt class="literal">&</tt> (substitutes for the complete match) +and <tt class="literal">\1 ,..., \9</tt> (substituting for the +<span class="emphasis"><em>n</em></span>-th submatch. Examples:</p> +<pre class="programlisting"> +(merge-rule "A" "a") +</pre> +<p>replaces each occurrence of the uppercase letter +<tt class="literal">`A'</tt> with its lowercase counterpart.</p> +<pre class="programlisting"> +(merge-rule "\~"([AEOUaeou])" "\1") +</pre> +<p>transforms the TeX umlaut-letters into their stripped +counterparts, such that <tt class="literal">`\"A '</tt> is treated +as an <tt class="literal">`A'</tt> afterwards.</p> +<p>The following sequences have a special meaning:</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">` ~n '</tt></span></dt> +<dd> +<p>End of line symbol +(<span class="emphasis"><em>linefeed</em></span>).</p></dd> +<dt><span class="term"><tt class="literal">` ~b '</tt></span></dt> +<dd> +<p>The ISO-Latin character with the lowest ordinal number.</p></dd> +<dt><span class="term"><tt class="literal">` ~e '</tt></span></dt> +<dd> +<p>The ISO-Latin character with the highest ordinal +number.</p></dd> +<dt><span class="term"><tt class="literal">` ~~ '</tt></span></dt> +<dd> +<p>The tilde character.</p></dd> +<dt><span class="term"><tt class="literal">` ~" '</tt></span></dt> +<dd> +<p>The double quote character.</p></dd></dl></div> +<p>Tilde characters and double quotes have to be quoted themselves +with a tilde character. The special characters +<tt class="literal">` ~b '</tt> and <tt class="literal">` ~e '</tt> +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. <tt class="literal">` m~e '</tt> is +lexicographically placed between <tt class="literal">`m'</tt> and +<tt class="literal">`n'</tt>.</p> +<p>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</p> +<pre class="programlisting"> +(merge-rule "[A-Z]" "&") +</pre> +<p>it is more efficient (though less comfortable) to use</p> +<pre class="programlisting"> +(merge-rule "A" "Ax") +(merge-rule "B" "Bx") +... +(merge-rule "Z" "Zx") +</pre> +<p>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 +<tt class="literal">`alpha'</tt> is checked before +<tt class="literal">`.*'</tt>, but <tt class="literal">`auto'</tt> +and <tt class="literal">`a.*'</tt> are checked in order of their +definition.</p> +<p>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.</p> +<p>Sometimes it is necessary to apply rules anew to the result of a +transformation. By specifying the keyword argument +<tt class="literal">:again</tt> 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</p> +<pre class="programlisting"> +(merge-rule "\$(.*)\$" "\1" :again) +</pre> +<p>deletes <span class="emphasis"><em>all</em></span> surrounding +<tt class="literal">`$ '</tt> symbols from the input.</p> +<p>See also command <tt class="literal">sort-rule</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-merge-to"></a>1.1.10 +<tt class="literal">merge-to</tt></h4></div></div></div> +<a id="id2573462" class="indexterm"></a> +<pre class="programlisting"> +(merge-to attr-from attr-to [:drop]) +</pre> +<p>A merge rule says that the attribute +<tt class="literal">attr-from</tt> can be used to build ranges in +<tt class="literal">attr-to</tt>. Both attributes must name valid +attribute names. The switch <tt class="literal">:drop</tt> +indicates, that the original location reference with attribute +<tt class="literal">attr-from</tt> has to be dropped (removed), if +a successful range was built with location references in attribute +<tt class="literal">attr-to</tt>. A detailed description is given +in the section about processing phases.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-require"></a>1.1.11 +<tt class="literal">require</tt></h4></div></div></div> +<a id="id2573541" class="indexterm"></a> +<pre class="programlisting"> +(require filename) +</pre> +<p>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 <tt class="literal">filename</tt> 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:</p> +<pre class="programlisting"> +(require "french/alphabet.xdy") +(require "french/sort-rules.xdy") +(require "tex/locations.xdy") +(require "tex/markup.xdy") +</pre> +<p>Submodules can load other submodules as well. If a file is +required that was already loaded, the +<tt class="literal">require</tt> command is simply ignored and +processing continues without including this file twice. See also +command searchpath.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-searchpath"></a>1.1.12 +<tt class="literal">searchpath</tt></h4></div></div></div> +<a id="id2573612" class="indexterm"></a> +<pre class="programlisting"> +(searchpath {path-string | path-list}) +</pre> +<p>This command adds the given paths to the list of paths, xindy +searches for index style files. The argument +<tt class="literal">path-string</tt> 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:</p> +<pre class="programlisting"> +(searchpath ".:/usr/local/lib/xindy:/usr/local/lib/xindy/english:") +</pre> +<p>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</p> +<pre class="programlisting"> +(searchpath ("." + "/usr/local/lib/xindy" + "/usr/local/lib/xindy/english" + :default)) +</pre> +<p>yields exactly the same result as the example above. Here +<tt class="literal">path-list</tt> must be a list of strings and/or +the keyword(s) <tt class="literal">:default</tt> and +<tt class="literal">:last</tt>. The keyword +<tt class="literal">:default</tt> signifies that the default +pathnames are to be inserted at the specified position in the list. +The keyword <tt class="literal">:last</tt> 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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-sort-rule"></a>1.1.13 +<tt class="literal">sort-rule</tt></h4></div></div></div> +<a id="id2573722" class="indexterm"></a> +<pre class="programlisting"> +(sort-rule pattern replacement [:run level] [:again]) +</pre> +<p>Defines a keyword mapping rule that can be used to generate the +<span class="emphasis"><em>sort key</em></span> of an index entry +from the <span class="emphasis"><em>merge key</em></span>. This key +is used to sort the index entries lexicographically after they have +been merged using the merge key.</p> +<p>The argument <tt class="literal">:run</tt> indicates that this +rule is only in effect a the specified +<span class="emphasis"><em>level</em></span> (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 (<tt class="literal">new-sort-rules</tt>) that comes with +this distribution.</p> +<p>See command <tt class="literal">merge-rule</tt> for more +information about keyword rules.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"> +<a id="xindy-command-list-processing-use-rule-set"></a>1.1.14 +<tt class="literal">use-rule-set</tt></h4></div></div></div> +<a id="id2573810" class="indexterm"></a> +<pre class="programlisting"> +(use-rule-set [:run phase] + [:rule-set ( <rule-set>... )) +</pre> +<p>This command instantiates the gives rule sets to be in effect at +sorting phase <tt class="literal">phase</tt>. The order of the rule +sets given with argument <tt class="literal">:rule-set</tt> 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.</p> +<p>The following example declares that in phase 0 the rule sets +<tt class="literal">din5007</tt> and +<tt class="literal">isolatin1-tolower</tt> should be active, +whereas in phase 2 the other rule sets have to be applied.</p> +<pre class="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" + )) +</pre> +<p>For a discussion on rule sets refer to command +<tt class="literal">define-rule-set</tt>.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="xindy-command-list-markup"></a>1.2 Markup +Commands</h3></div></div></div> +<a id="id2573907" class="indexterm"></a> +<p>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 +<span class="emphasis"><em>environments</em></span>, the syntax and +naming scheme of all commands follows a simple structure.</p> +<p>The commands can be separated into +<span class="emphasis"><em>environment</em></span> and +<span class="emphasis"><em>list-environment</em></span> commands. +All commands of the first group support the keyword arguments +<tt class="literal">:open</tt> and <tt class="literal">:close</tt>, +whereas the second group additionally supports the keyword argument +<tt class="literal">:sep</tt>. If one of these keyword arguments is +missing, the default markup tag is always the empty tag. The +<tt class="literal">:open</tt> tag is always printed before the +object itself and the <tt class="literal">:close</tt> tag is always +printed after the object has been printed. If a list is printed the +<tt class="literal">:sep</tt> 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 +<tt class="literal">`-list'</tt> as part of their command name.</p> +<p>Since the number of commands and the heavy usage of +<span class="emphasis"><em>default</em></span> and +<span class="emphasis"><em>specialized</em></span> 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 <tt class="literal">markup-trace</tt>.</p> +<p>Here follows the list of markup commands in alphabetical order +with some of the commands grouped together.</p> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574023"></a>1.2.1 +<tt class="literal">markup-attribute-group-list</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-attribute-group-list [:open string] [:close string] + [:sep string]) + +(markup-attribute-group [:open string] [:close string] + [:group group-num]) +</pre> +<p>Location class groups consist of lists of attribute groups. The +markup of this list can be defined with the command +<tt class="literal">markup-attribute-group-list</tt>.</p> +<p>To allow different markup for different attribute groups the +command <tt class="literal">markup-attribute-group</tt> can be +specialized on the group number with the keyword argument +<tt class="literal">:group</tt> which must be an integer number. +E.g., given are the groups <tt class="literal">("definition" +"theorem")</tt> and <tt class="literal">("default")</tt> with group +numbers 0 and 1, then</p> +<pre class="programlisting"> +(markup-attribute-group :open "<group0>" :close </group0>" + :group 0) + +(markup-attribute-group :open "<group1>" :close "</group1>" + :group 1) +</pre> +<p>can be used to assign different markup for both groups in a +SGML-based language.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574100"></a>1.2.2 +<tt class="literal">markup-crossref-list</tt></h4></div></div></div> +<pre class="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]) +</pre> +<p>A crossref class group contains cross references of the same +class. The separator between the classes is defined with the +<tt class="literal">(markup-locclass-list :sep)</tt>-parameter. A +list of cross references can be tagged with the +<tt class="literal">command markup-crossref-list</tt> that +specializes on the <tt class="literal">:class</tt> argument.</p> +<p>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 <tt class="literal">command +markup-crossref-layer-list</tt> can be used.</p> +<p>Each layer of a cross reference can be assigned two tags that +specialize on the class of the reference, like all other +commands.</p> +<p>A suitable markup for a cross reference class +<tt class="literal">see</tt> within LaTeX2e could look like +that:</p> +<pre class="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 "}") +</pre> +<p>An example output could look like <tt class="literal">... see +house; garden,winter; greenhouse</tt></p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574200"></a>1.2.3 +<tt class="literal">markup-index</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-index [:open string] [:close string] + [ :flat | :tree | :hierdepth depth ]) +</pre> +<p>Defines the markup tags that enclose the whole index via the +<tt class="literal">:open</tt> and <tt class="literal">:close</tt> +parameters. Examples:</p> +<pre class="programlisting"> +(markup-index :open "Here comes the index~n" + :close "That's all folks!~n") +</pre> +<p>defines that the <tt class="literal">:open</tt> string is +printed before the rest of the index and the +<tt class="literal">:close</tt> string appears after the index is +printed.</p> +<p>Additionally one can specify the form of the generated index. It +is possible to produce flat indexes by specifying the switch +<tt class="literal">:flat</tt>, to generate a tree with the +<tt class="literal">:tree</tt> switch or any kind of mixture +between both by specifying the depth up to which trees shall be +built with the parameter <tt class="literal">:hierdepth</tt>. Its +argument depth is the number of layers that can be formed into a +tree. Therefore <tt class="literal">:flat</tt> is an abbrevation of +<tt class="literal">:hierdepth 0</tt> and +<tt class="literal">:tree</tt> is an abbrevation of +<tt class="literal">:hierdepth max-depth</tt>, with +<tt class="literal">max-depth</tt> being the maximum number of +layers a keyword has. An example: the keywords</p> +<pre class="programlisting"> +("tree" "binary" "AVL") +("tree" "binary" "natural") +</pre> +<p>can be transformed in the following ways:</p> +<p>A flat index (<tt class="literal">:flat</tt> or +<tt class="literal">:hierdepth 0</tt>)</p> +<pre class="programlisting"> +tree binary AVL +tree binary natural +</pre> +<p>with <tt class="literal">:hierdepth 1</tt></p> +<pre class="programlisting"> +tree + binary AVL + binary natural +</pre> +<p>and a tree (<tt class="literal">:tree</tt> or +<tt class="literal">:hierdepth > 1</tt>)</p> +<pre class="programlisting"> +tree + binary + AVL + natural +</pre> +<p>Most often one will create tree-like indexes or ones that are +flat.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574381"></a>1.2.4 +<tt class="literal">markup-indexentry-list</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-indexentry-list [:open string] [:close string] + [:sep string] [:depth integer]) + +(markup-indexentry [:open string] [:close string] + [:depth integer]) +</pre> +<p>Letter groups consists of a list of index entries. The command +<tt class="literal">markup-indexentry-list</tt> defines the markup +of these lists. The markup can be specialized on the depth if the +index is hierarchically organized. The command</p> +<pre class="programlisting"> +(markup-indexentry-list :open "\begin{IdxentList}" + :close "\end{IdxentList}" + :sep "~n") +</pre> +<p>defines that the index entries of all layers are wrapped into +the given markup tags. If additionally</p> +<pre class="programlisting"> +(markup-indexentry-list :open "\begin{IdxentListII}" + :close "\end{IdxentListII}" + :sep "~n" + :depth 2) +</pre> +<p>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.</p> +<p>The command <tt class="literal">markup-indexentry</tt> 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 +<tt class="literal">:depth</tt> 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.</p> +<pre class="programlisting"> +(markup-indexentry :open "\begin{Indexentry}" + :close "\end{Indexentry}") +</pre> +<p>defines that the index entries of all layers are wrapped into +the given markup tags. If additionally</p> +<pre class="programlisting"> +(markup-indexentry :open "\begin{IndexentryII}" + :close "\end{IndexentryII}" + :depth 2) +</pre> +<p>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.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574484"></a>1.2.5 +<tt class="literal">markup-keyword-list</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-keyword-list [:open string] [:close string] + [:sep string] [:depth integer]) + +(markup-keyword [:open string] [:close string] + [:depth integer]) +</pre> +<p>The print key of an index entry consists of a list of strings. +The markup of this list can be defined with the command +<tt class="literal">markup-keyword-list</tt>. The keyword argument +<tt class="literal">:depth</tt> may be specified to define the +markup of the list at a particular depth.</p> +<p>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 <tt class="literal">markup-keyword</tt>. Since we maybe +need different markup for different layers, the optional keyword +argument can be used to specialize this markup for some +depth.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574539"></a>1.2.6 +<tt class="literal">markup-letter-group-list</tt></h4></div></div></div> +<pre class="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]) +</pre> +<p>The first command defines the markup of the letter group with +name <tt class="literal">group-name</tt>. 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 +<tt class="literal">:open-head</tt> and +<tt class="literal">:close-head</tt> is specified additional markup +is added as can be described as follows:</p> +<pre class="programlisting"> +<OPEN> + IF (:open-head OR :close-head) + <OPEN-HEAD> + transformer-of(<GROUP-NAME>) + <CLOSE-HEAD> + FI + <INDEXENTRIES...> +<CLOSE> +</pre> +<p>Here, <tt class="literal">transformer-of</tt> 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 <tt class="literal">:upcase</tt>, +<tt class="literal">:downcase</tt> and +<tt class="literal">:capitalize</tt> which result in the +corresponding string conversions. If none of them is specified no +transformation is done at all.</p> +<p>The command <tt class="literal">markup-letter-group</tt> defines +the markup of the list of letter groups.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574639"></a>1.2.7 +<tt class="literal">markup-locclass-list</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-locclass-list [:open string] [:close string] + [:sep string]) +</pre> +<p>Each index entry contains a list of location class groups. This +markup command can be used to define the markup of this +list.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574664"></a>1.2.8 +<tt class="literal">markup-locref</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-locref [:open string] [:close string] + [:class locref-class] + [:attr attribute] + [:depth integer]) +</pre> +<p>The markup tags of a location reference can be specialized on +the three arguments <tt class="literal">:class</tt>, +<tt class="literal">:attr</tt> and additionally, if sub-references +are used, <tt class="literal">:depth</tt>. Most often one will only +use a tag depending on the attribute. For example, all location +references with the attribute <tt class="literal">definition</tt> +should appear in a font series like bold, emphasizing the +importance of this location reference; those with the attribute +<tt class="literal">default</tt> 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.</p> +<pre class="programlisting"> +(markup-locref :open "<B>" :close "</B>" :attr "definition") +(markup-locref :open "<I>" :close "</I>" :attr "default") +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574736"></a>1.2.9 +<tt class="literal">markup-locref-class</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-locref-class [:open string] [:close string] + [:class locref-class]) +</pre> +<p>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 +<tt class="literal">:class</tt>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574768"></a>1.2.10 +<tt class="literal">markup-locref-layer</tt></h4></div></div></div> +<pre class="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]) +</pre> +<p>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).</p> +<p>The first command allows to tag the elements of a layer list +differently. The first element of this list can is specialisable +with <tt class="literal">:layer 0</tt>, the next element with +<tt class="literal">:layer 1</tt>, etc. See the next example for an +example.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574818"></a>1.2.11 +<tt class="literal">markup-locref-list</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-locref-list [:open string] [:close string] [:sep string] + [:depth integer] [:class locref-class]) +</pre> +<p>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 +<tt class="literal">:class</tt>, and on +<tt class="literal">:depth</tt> that specializes on the different +subentry levels when using location references with +sub-references.</p> +<p>Given is a list of location references that have the class +description</p> +<pre class="programlisting"> +(define-location-class "Appendix" + ("ALPHA" :sep "-" "arabic-numbers") + :hierdepth 2) +</pre> +<p>This location class has instances like +<tt class="literal">A-1</tt>, <tt class="literal">B-5</tt>, etc. +The keyword argument <tt class="literal">:hierdepth 2</tt> informs +xindy to markup these location references in a hierarchical form. +With the commands</p> +<pre class="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") +</pre> +<p>we obtain a markup sequence for some example data that could +look like</p> +<pre class="programlisting"> + \bf A} 1,2,5; {\bf B} 5,6,9; {\bf D} 1,5,8; ... +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2574916"></a>1.2.12 +<tt class="literal">markup-range</tt></h4></div></div></div> +<pre class="programlisting"> +(markup-range [:open string] [:close string] [:sep string] + [:class locref-class] + [:length num] [:ignore-end]) +</pre> +<p>A range consists of two location references. Markup can be +specified with the <tt class="literal">:open</tt> and +<tt class="literal">:close</tt> arguments and one separator given +by the argument <tt class="literal">:sep</tt>.</p> +<p>Since both location references are tagged with markup defined by +the command <tt class="literal">markup-locref</tt> 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 <tt class="literal">:length</tt> can be used to define +different markup for different lengths. In conjunction with +<tt class="literal">:length</tt> 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 +<tt class="literal">:ignore-end</tt>.</p> +<p>The markup tags for a range (X,Y) can be described as +follows:</p> +<pre class="programlisting"> +<OPEN> + Markup of location reference X +<SEP> + IF (not :ignore-end) + Markup of location reference Y + FI +<CLOSE> +</pre> +<p>The following tags can be used to define a range of page numbers +(given in a location class <tt class="literal">page-numbers</tt>) +without considering the open and close parameters:</p> +<pre class="programlisting"> +(markup-range :sep "-" :class "page-numbers") +</pre> +<p>Location ranges then appear separated by a hyphen in a form like +this:</p> +<pre class="programlisting"> + ..., 5-8, 19-23, ... +</pre></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h4 class="title"><a id="id2575040"></a>1.2.13 +<tt class="literal">(markup-trace [:on] [:open string] [:close +string])</tt></h4></div></div></div> +<p>This command can be used to activate the tracing of all markup +commands xindy executes. The switch <tt class="literal">:on</tt> +activates the trace. If <tt class="literal">:on</tt> is omitted, +the command line flag <tt class="literal">-t</tt> 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 <tt class="literal">:open</tt> is +<tt class="literal">`<'</tt> and for +<tt class="literal">:close</tt> is <tt class="literal">`>'</tt>. +The beginning of an example output could look like:</p> +<pre class="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]> + ... +</pre> +<p>We use a simple indentation scheme to make the structure of the +tags visible. The symbolic tag +<tt class="literal"><LETTER-GROUP:OPEN ["a"]></tt> for +example indicates that the tag that can be specified with the +command</p> +<pre class="programlisting"> +(markup-letter-group :open "XXX" :group "a" ... ) +</pre> +<p>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</p> +<pre class="programlisting"> +(markup-trace :open "%%" :close "~n") +</pre> +<p>or a definition in the TeX document like</p> +<pre class="programlisting"> +\def\ignore#1{} +</pre> +<p>combined with the command</p> +<pre class="programlisting"> +(markup-trace :open "\ignore{" :close "}") +</pre></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="xindy-command-list-raw-index"></a>1.3 Raw +Index Interface</h3></div></div></div> +<a id="id2575175" class="indexterm"></a> +<p>This section can be skipped if the reader is not interested in +adapting xindy to a new document preparation system.</p> +<p>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 +<span><b class="command">perl</b></span>, +<span><b class="command">sed</b></span> or +<span><b class="command">awk</b></span> 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.</p> +<p>The format of the raw index interface of xindy is defined as +follows:</p> +<pre class="programlisting"> +(indexentry { :key string-list [:print string-list] + | :tkey list-of-layers } + [:attr string] + { :locref string [:open-range | :close-range] + | :xref string-list } ) +</pre> +<p>The pseudo variable +<span class="emphasis"><em>string</em></span> is a sequence of +characters surrounded by double quotes, e.g.</p> +<pre class="programlisting"> +"Hi, it's me" "one" "a string with two \"double quotes\"" +</pre> +<p>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 +<span class="emphasis"><em>string list</em></span> is simply a list +of strings separated by whitespaces and surrounded by round braces. +An example of a string list is</p> +<pre class="programlisting"> +("This" "is" "a" "list" "of" "strings") +</pre> +<p>So far about the syntax. The semantics of the different elements +are described here.</p> +<div class="variablelist"> +<dl> +<dt><span class="term"><tt class="literal">:key</tt></span></dt> +<dd> +<p>The argument <span class="emphasis"><em>string list</em></span> +defines the keyword of the index entry. It must be a list of +strings, since the keyword may consist of different layers such as +<tt class="literal">("heap" "fibonacci")</tt>.</p></dd> +<dt><span class="term"><tt class="literal">:print</tt></span></dt> +<dd> +<p>The optional <span class="emphasis"><em>print key</em></span> +defines the way the keyword has to be printed in the markup +phase.</p></dd> +<dt><span class="term"><tt class="literal">:tkey</tt></span></dt> +<dd> +<p>Another possibility to define the keys of an index entry is with +the <tt class="literal">:tkey</tt> keyword argument. It can be used +instead of the <tt class="literal">:key</tt> and +<tt class="literal">:print</tt> 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</p> +<pre class="programlisting"> +:tkey (("This") ("is") ("a") ("bang" "BANG !!!")) +</pre> +<p>is equivalent to</p> +<pre class="programlisting"> +:key ("This" "is" "a" "bang") +:print ("This" "is" "a" "BANG !!!") +</pre></dd> +<dt><span class="term"><tt class="literal">:locref</tt></span></dt> +<dd> +<p>The reference an index entry describes can be a +<span class="emphasis"><em>location reference</em></span> or a +<span class="emphasis"><em>cross reference</em></span>. The switch +<tt class="literal">:locref</tt> describes a location reference. +Its optional arguments are <tt class="literal">:open-range</tt> and +<tt class="literal">:close-range</tt>. The +<span class="emphasis"><em>string</em></span> that must be supplied +must somehow encode the location reference. It might look like the +string <tt class="literal">"25"</tt> representing the page number +25, or <tt class="literal">"Appendix-I"</tt> representing the first +appendix numbered in uppercase roman numerals.</p></dd> +<dt> +<span class="term"><tt class="literal">:open-range,:close-range</tt></span></dt> +<dd> +<p>These are switches that do not take any arguments. They describe +the beginning and ending of a +<span class="emphasis"><em>range</em></span>, starting or ending +from the location reference that is given by the argument +<tt class="literal">:locref</tt>. If they are supplied, the +location reference may have influence on the way ranges are +build.</p></dd> +<dt><span class="term"><tt class="literal">:xref</tt></span></dt> +<dd> +<p>These arguments choose the second alternative. The argument +<span class="emphasis"><em>string list</em></span> of parameter +<tt class="literal">:xref</tt> describes where the index entry +should point to.</p></dd> +<dt><span class="term"><tt class="literal">:attr</tt></span></dt> +<dd> +<p>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 +<tt class="literal">default</tt>.</p></dd></dl></div> +<p>Some examples:</p> +<pre class="programlisting"> +(indexentry :key ("airplane") :locref "25" :attr "default") +</pre> +<p>defines an index entry with the key +<span class="emphasis"><em>airplane'</em></span> indexed on page +<span class="emphasis"><em>25'</em></span>. This index entry has +the attribute <tt class="literal">default</tt>.</p> +<pre class="programlisting"> +(indexentry :key ("house") :xref("building") :attr "see") +</pre> +<p>defines a cross reference with the key +<tt class="literal">house</tt> pointing to the term +<tt class="literal">building</tt>. This cross reference belongs to +the cross reference class <tt class="literal">see</tt>.</p> +<pre class="programlisting"> +(indexentry :key ("house") :xref("building") :open-range) +</pre> +<p>is an invalid specification, since +<tt class="literal">:open-range</tt> mustn't be used together with +cross references.</p></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="xindy-invoking"></a>2 +Invoking xindy</h2></div></div></div> +<a id="id2575621" class="indexterm"></a> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="xindy-invoking-cmdline"></a>2.1 Command +Line Options</h3></div></div></div> +<a id="id2575644" class="indexterm"></a> +<p>The following command line options are accepted:</p> +<pre class="programlisting"> +xindy [-h] [-t] [-v] [-l logfile] [-o outfile] + [-L n] [-f filterprog] + indexstyle raw-index +</pre> +<p>The argument <tt class="literal">indexstyle</tt> names a file, +containing the index style description. The argument +<tt class="literal">raw-index</tt> names a file, containing the raw +index. Both arguments are mandatory.</p> +<div class="variablelist"> +<dl> +<dt><span class="term">-h</span></dt> +<dd> +<p>Gives a short summary of all command line options.</p></dd> +<dt><span class="term">-l</span></dt> +<dd> +<p>Writes helpful information into the specified +<tt class="literal">logfile</tt>. For example, the keyword mappings +are written into this file, so one can check if the intended +mappings were actually performed this way.</p></dd> +<dt><span class="term">-o</span></dt> +<dd> +<p>Explicitly defines the name of the +<tt class="literal">output</tt> file. If not given, the name of the +<tt class="literal">raw-index</tt> is used with its extension +changed to <tt class="literal">.ind</tt> (or added, if it had no +extension at all).</p></dd> +<dt><span class="term">-t</span></dt> +<dd> +<p>Enters tracing mode of the symbolic markup tags. The format of +the emitted tags can be defined with the command +<tt class="literal">markup-trace</tt>.</p></dd> +<dt><span class="term">-L</span></dt> +<dd> +<p>Set the xindy logging-level to +<tt class="literal">n</tt>.</p></dd> +<dt><span class="term">-f</span></dt> +<dd> +<p>Run <tt class="literal">filterprog</tt> on +<tt class="literal">raw-index</tt> before reading. The program must +act as a filter reading from <tt class="literal">stdin</tt> and +writing to <tt class="literal">stdout</tt>. The most obvious use of +this option in conjunction with TeX is to run +<tt class="literal">-f tex2xindy</tt> on the index file prior to +reading the entries into xindy.</p></dd> +<dt><span class="term">-v</span></dt> +<dd> +<p>Shows the version number of xindy.</p></dd></dl></div> +<p>Errors and warnings are reported to +<tt class="literal">stdout</tt> and additionally to the logfile if +<tt class="literal">-l</tt> was specified.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h3 class="title"><a id="xindy-search-path"></a>2.2 Search +Path</h3></div></div></div> +<a id="id2575892" class="indexterm"></a> +<p>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 <tt class="envar">XINDY_SEARCHPATH</tt> 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 <a href="#xindy-command-list-processing-searchpath" +title="1.1.12 searchpath">searchpath</a> for further +details.</p></div></div></div> +<div class="appendix" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="appendices"></a>Appendix A. Appendices</h2></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="#issues">1 Bugs / Known Issues / +Missing Features</a></span></dt> +<dt><span class="section"><a href="#about">2 About this +Document</a></span></dt> +<dt><span class="section"><a href="#release-news">3 Release +News</a></span></dt> +<dt><span class="section"><a href="#gfdl">4 GNU Free Documentation +License</a></span></dt> +<dt> +<span class="index"><a href="#tex-refs-idx">Index</a></span></dt></dl></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="issues"></a>1 Bugs / +Known Issues / Missing Features</h2></div></div></div> +<a id="id2575966" class="indexterm"></a> +<div class="variablelist"> +<dl> +<dt><span class="term">PDF</span></dt> +<dd> +<p>The PDF file is an experimental version generated using +<a href="http://dblatex.sf.net" target="_top">DB2LaTeX</a>. There +is much room for improvements and we will work on this.</p></dd> +<dt><span class="term">Texinfo</span></dt> +<dd> +<p>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 <span class="emphasis"><em>docbook2X</em></span> +project at <a href="http://docbook2x.sourceforge.net" +target="_top">http://docbook2x.sourceforge.net</a>.</p></dd> +<dt><span class="term">vim-help</span></dt> +<dd> +<p>Quite a few poeple are asking for a version in vim-help format. +<a href="mailto:srinath@eecs.berkeley.edu" target="_top">Srinath +Avadhanula</a> has already done some work on +this.</p></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="about"></a>2 About +this Document</h2></div></div></div> +<a id="id2576071" class="indexterm"></a> +<p>The source format of this document is +<a href="http://www.oasis-open.org/committees/docbook/" +target="_top">DocBook XML (V4.3)</a>.</p> +<p>The various output formats were generated using:</p> +<div class="itemizedlist"> +<ul type="disc"> +<li><a href="http://xmlsoft.org/XSLT/" target="_top">xsltproc +(libxml2-2.6.16/libxslt-1.1.12)</a> as XSLT processor</li> +<li><a href="http://sourceforge.net/projects/docbook" +target="_top">DocBook XSL Stylesheets (V1.68.1)</a> for HTML</li> +<li><a href="http://db2latex.sf.net/" target="_top">DB2LaTeX XSL +Stylesheets (V0.8pre1+20050330</a> for LaTeX/PDF</li> +<li><tt class="literal">scrbook [2004/09/16 v2.9t LaTeX2e KOMA +document class]</tt> of +<a href="ftp://dante.ctan.org/tex-archive/macros/latex/contrib/koma-script/" + target="_top">KOMA-Script</a></li> +<li> +<a href="ftp://ftp.dante.de/tex-archive/fonts/ps-type1/lm/tex/latex/lm/" + target="_top">Latin Modern Type 1 Fonts (V0.92)</a></li> +<li>pdfLaTeX (3.14159-1.10b) for generating PDF +output</li></ul></div> +<p>You'll always find the newest version of this document at +<a href="http://www.miwie.org/tex-refs/" +target="_top">http://www.miwie.org/tex-refs/</a>.</p></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="release-news"></a>3 +Release News</h2></div></div></div> +<div class="variablelist"> +<dl> +<dt><span class="term">V0.3.9 05-05-14</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Consistent naming scheme of IDs to ease the use of this +reference for other projects</li> +<li>Added new section <a href="#float" title="3.3 float">float</a> +in chapter <a href="#latex" +title="2 LaTeX">LaTeX</a></li></ul></div></dd> +<dt><span class="term">V0.3.8 04-10-28</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Minor changes in <a href="#page-styles" +title="2.3.15 Page Styles">\maketitle</a></li></ul></div></dd> +<dt><span class="term">V0.3.7 04-08-26</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Corrected typos and markup errors in chapter <a href="#bibtex" +title="Chapter 5. BibTeX">BibTeX</a></li> +<li>Switched to DocBook XML V4.3</li> +<li>Added new section <a href="#opt-latex" +title="2.1 Options">Options</a> in chapter <a href="#latex" +title="2 LaTeX">LaTeX</a></li></ul></div></dd> +<dt><span class="term">V0.3.6 04-06-21</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Added a note in chapter <a href="#latex" +title="2 LaTeX">LaTeX</a> with the copyright and permission notice +of the original file <tt class="filename">latex2.texi</tt></li> +<li>Corrected typos and added missing hyperlinks in chapter +<a href="#xindy" title="Chapter 7. xindy">xindy</a></li> +<li>PDF file optimized/linearized and some +finetuning</li></ul></div></dd> +<dt><span class="term">V0.3.5 04-05-01</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Added content to chapters <a href="#metapost" +title="Chapter 4. MetaPost">MetaPost</a> and +<a href="#pdftex" +title="Chapter 2. pdfTeX">pdfTeX</a></li> +<li>Enhanced index for chapter <a href="#metapost" +title="Chapter 4. MetaPost">Make-Index</a></li></ul></div></dd> +<dt><span class="term">V0.3.4 04-04-24</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Version control system changed from CVS to SVN</li> +<li>Added missing entries to chapter <a href="#makeindex" +title="Chapter 6. Make-Index">Make-Index</a></li></ul></div></dd> +<dt><span class="term">V0.3.3 04-01-26</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Corrected again section <a href="#makeindex-output-style-specs" +title="2.2 Output Style Specifiers">Output Style Specifiers</a> and +<a href="#makeindex-style" title="2.1 Input Style Specifiers">Input +Style Specifiers</a> of chapter <a href="#makeindex" +title="Chapter 6. Make-Index">Make-Index</a></li> +<li>Corrected some symbols in the index</li></ul></div></dd> +<dt><span class="term">V0.3.2 04-01-16</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Corrected sections <a href="#makeindex-output-style-specs" +title="2.2 Output Style Specifiers">Output Style Specifiers</a> and +<a href="#makeindex-style" title="2.1 Input Style Specifiers">Input +Style Specifiers</a> of chapter <a href="#makeindex" +title="Chapter 6. Make-Index">Make-Index</a></li> +<li>Enhanced index in PDF</li></ul></div></dd> +<dt><span class="term">V0.3.1 04-01-06</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>More work on PDF</li> +<li>Modularized XSL stylesheet files</li> +<li>Corrected some typos</li></ul></div></dd> +<dt><span class="term">V0.3.0 03-12-25</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Changed document root to +<span class="emphasis"><em>book</em></span></li> +<li>More work on PDF version</li> +<li>Using new XSL stylesheets V1.64.1</li> +<li>Minor fixes</li></ul></div></dd> +<dt><span class="term">V0.2.6 03-10-27</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Rearranged appendix</li> +<li>Work on PDF version</li></ul></div></dd> +<dt><span class="term">V0.2.5 03-10-17</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Added contents of <a href="#gfdl" +title="4 GNU Free Documentation License">GNU FDL</a> in +appendix</li> +<li>Using new XSL stylesheets V1.62.4</li> +<li>Switched to <a href="http://xmlsoft.org/XSLT/" +target="_top"><tt class="literal">xsltproc</tt></a> as +XSLT-processor</li> +<li>Reedited some deeply nested sections</li> +<li>Changed colors in CSS</li></ul></div></dd> +<dt><span class="term">V0.2.4 03-09-06</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Added subsection <a href="#dcolumn" +title="3.2 dcolumn"><tt class="literal">dcolumn</tt></a></li> +<li>Subsection <a href="#fontenc" +title="3.4 fontenc"><tt class="literal">fontenc</tt></a> translated +into english</li> +<li>Corrected typo in +<a href="#cmd-sbox"><tt class="filename">\sbox</tt></a></li></ul></div></dd> +<dt><span class="term">V0.2.3 03-04-12</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Provide PDF output using <a href="http://www.pragma-ade.com/" +target="_top">ConTeXt</a> and +<a href="http://www.hobby.nl/~scaprea/context/index.html" +target="_top">DocBook In ConTeXt</a> (still experimental)</li> +<li>Reedited (beautified) sections LaTeX / Commands / +<a href="#counters" title="2.3.1 Counters">Counters</a> | +<a href="#cross-references" title="2.3.2 Cross References">Cross +References</a> | <a href="#definitions" +title="2.3.3 Definitions">Definitions</a> | <a href="#layout" +title="2.3.5 Layout">Layout</a> | <a href="#env-latex" +title="2.3.6 Environments">Environments</a> | <a href="#footnotes" +title="2.3.7 Footnotes">Footnotes</a></li></ul></div></dd> +<dt><span class="term">V0.2.2 03-01-26</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Added bzip2 compressed version of source and outfiles +tarball</li> +<li>Using new XSL stylesheets V1.60.1</li> +<li>Eliminated more spurious &Acirc; characters in HTML +output</li></ul></div></dd> +<dt><span class="term">V0.2.1 03-01-18</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Using new XSL stylesheets V1.59.2</li> +<li>Eliminated spurious &Acirc; characters</li></ul></div></dd> +<dt><span class="term">V0.2.0 03-01-11</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Using new XSL stylesheets V1.58.1</li> +<li>Minor changes to CSS file</li> +<li>License changed to +<a href="http://www.gnu.org/licenses/fdl.html" target="_top">GNU +Free Documentation License</a></li> +<li>Added subsection <a href="#pstricks-commands" +title="4.2.2 Commands and Parameters">Commands and Parameters</a> +to section <a href="#pstricks" +title="4.2 PSTricks">PSTricks</a></li> +<li>Reworked <a href="#inputenc" title="3.8 inputenc">inputenc</a> +section</li></ul></div></dd> +<dt><span class="term">V0.1.3 02-10-17</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Started rework of <a href="#komascript" +title="3.9 KOMA-Script">KOMA-Script</a> section</li> +<li>Added subsection <a href="#pstricks-add-packages" +title="4.2.3 List of Additional PSTricks Packages">Additional +PSTricks Packages</a></li> +<li>Using new XSL stylesheets V1.56.1</li></ul></div></dd> +<dt><span class="term">V0.1.2 02-10-01</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Reworked <a href="#hyperref" title="3.7 hyperref">hyperref</a> +section</li></ul></div></dd> +<dt><span class="term">V0.1.1 02-09-19</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Added template sections for <a href="#pictex" +title="4.1 PiCTeX (tbd.)">PiCTeX</a> and <a href="#texinfo" +title="7 Texinfo (tbd.)">Texinfo</a></li> +<li>Added subsection <a href="#release-news" +title="3 Release News">Release News</a> in appendix +<a href="#about" title="2 About this Document">About this +Document</a></li> +<li>Using new XSL stylesheets V1.55.0</li> +<li>Added missing CSS file to outfiles tarball</li> +<li>Corrected wrong FPI</li></ul></div></dd> +<dt><span class="term">V0.1.0 02-08-20</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Eliminated trailing '.' in numbered sections</li> +<li>Minor markup errors corrected</li> +<li>Reworked CSS file</li></ul></div></dd> +<dt><span class="term">V0.0.5 02-08-10</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Switched to DocBook XML 4.2</li> +<li>Sections 'Bibindex' and 'xindy' completed</li></ul></div></dd> +<dt><span class="term">V0.0.4 02-07-25</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>Section 'Makeindex' completed</li></ul></div></dd> +<dt><span class="term">V0.0.3 02-07-13</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>New XSL stylesheets solve bug in creating index (no other +changes)</li></ul></div></dd> +<dt><span class="term">V0.0.2 02-07-05</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>New (template) sections 'fontinst', 'Bibtex', 'Makeindex', and +'xindy'</li> +<li>New section 'Special Symbols'</li> +<li>Added information for 'german' package</li> +<li>Registered as a new project (tex-refs) on +freshmeat.net</li></ul></div></dd> +<dt><span class="term">V0.0.1 02-06-21</span></dt> +<dd> +<div class="itemizedlist"> +<ul type="disc" compact="compact"> +<li>First official +announcement</li></ul></div></dd></dl></div></div> +<div class="section" lang="en"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a id="gfdl"></a>4 GNU Free +Documentation License</h2></div></div></div> +<h5 class="title"><a id="id2577462"></a>Version 1.2, November +2002</h5> +<pre class="programlisting"> + 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. +</pre></div> +<div class="index"> +<div class="titlepage"> +<div> +<div> +<h2 class="title"> +<a id="tex-refs-idx"></a>Index</h2></div></div></div> +<div class="index"> +<div class="indexdiv"> +<h3>Symbols</h3> +<dl> +<dt>$, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\!, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\' (tabbing), <a href="#env-latex">Environments</a></dt> +<dt>\(, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\), <a href="#math-formulae">Math Formulae</a></dt> +<dt>\+, <a href="#env-latex">Environments</a></dt> +<dt>\,, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\- (hyphenation), <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>\- (tabbing) , <a href="#env-latex">Environments</a></dt> +<dt>\;, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\< , <a href="#env-latex">Environments</a></dt> +<dt>\=, <a href="#env-latex">Environments</a></dt> +<dt>\>, <a href="#env-latex">Environments</a></dt> +<dt>\a, <a href="#env-latex">Environments</a></dt> +<dt>\addcontentsline, <a href="#table-of-contents">Table of +Contents</a></dt> +<dt>\address, <a href="#letters">Letters</a></dt> +<dt>\addtocontents, <a href="#table-of-contents">Table of +Contents</a></dt> +<dt>\addtocounter{counter}{value}, +<a href="#counters">Counters</a></dt> +<dt>\addtolength, <a href="#lengths">Lengths</a></dt> +<dt>\addvspace, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\alph, <a href="#counters">Counters</a></dt> +<dt>\Alph, <a href="#counters">Counters</a></dt> +<dt>\appendix, <a href="#sectioning">Sectioning</a></dt> +<dt>\arabic, <a href="#counters">Counters</a></dt> +<dt>\areaset, +<a href="#komascript-page-layout">Page-Layout</a></dt> +<dt>\author, <a href="#page-styles">Page Styles</a></dt> +<dt>\backslash, <a href="#special-characters">Special +Characters</a></dt> +<dt>\begin, <a href="#env-latex">Environments</a></dt> +<dt>\bfseries, <a href="#typefaces">Typefaces</a></dt> +<dt>\bibitem, <a href="#env-latex">Environments</a></dt> +<dt>\bibliography, <a href="#env-latex">Environments</a></dt> +<dt>\bibliographystyle, <a href="#env-latex">Environments</a></dt> +<dt>\bigskip, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\bm, <a href="#bm-package">bm</a></dt> +<dt>\boldsymbol, <a href="#amsmath">amsmath</a></dt> +<dt>\boldsymbold, <a href="#bm-package">bm</a></dt> +<dt>\caption, <a href="#env-latex">Environments</a></dt> +<dt>\cc, <a href="#letters">Letters</a></dt> +<dt>\cdots, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\centering, <a href="#env-latex">Environments</a></dt> +<dt>\chapter, <a href="#sectioning">Sectioning</a></dt> +<dt>\circle, <a href="#env-latex">Environments</a></dt> +<dt>\cite, <a href="#env-latex">Environments</a></dt> +<dt>\cleardoublepage, <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>\clearpage, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\cline, <a href="#env-latex">Environments</a></dt> +<dt>\closing, <a href="#letters">Letters</a></dt> +<dt>\COLON, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\dashbox, <a href="#env-latex">Environments</a></dt> +<dt>\date, <a href="#page-styles">Page Styles</a></dt> +<dt>\ddots, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\depth, <a href="#lengths">Lengths</a></dt> +<dt>\documentclass, <a href="#document-classes">Document +Classes</a></dt> +<dt>\dotfill, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\emph, <a href="#typefaces">Typefaces</a></dt> +<dt>\encl, <a href="#letters">Letters</a></dt> +<dt>\end, <a href="#env-latex">Environments</a></dt> +<dt>\enlargethispage, <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>\ensuremath{}, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\fbox, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\floatname, <a href="#float">float</a></dt> +<dt>\floatplacement, <a href="#float">float</a></dt> +<dt>\floatstyle, <a href="#float">float</a></dt> +<dt>\flushbottom, <a href="#layout">Layout</a></dt> +<dt>\fnsymbol, <a href="#counters">Counters</a></dt> +<dt>\fontencoding, <a href="#typefaces">Typefaces</a></dt> +<dt>\fontfamily, <a href="#typefaces">Typefaces</a></dt> +<dt>\fontseries, <a href="#typefaces">Typefaces</a></dt> +<dt>\fontshape, <a href="#typefaces">Typefaces</a></dt> +<dt>\fontsize, <a href="#typefaces">Typefaces</a></dt> +<dt>\footnote, <a href="#footnotes">Footnotes</a></dt> +<dt>\footnotemark, <a href="#footnotes">Footnotes</a></dt> +<dt>\footnotesize, <a href="#typefaces">Typefaces</a></dt> +<dt>\footnotetext, <a href="#footnotes">Footnotes</a></dt> +<dt>\frac, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\frame, <a href="#env-latex">Environments</a></dt> +<dt>\framebox, <a href="#env-latex">Environments</a>, +<a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\fussy, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\graphicspath, <a href="#graphicspath">\graphicspath</a></dt> +<dt>\height, <a href="#lengths">Lengths</a></dt> +<dt>\hfill, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\hline, <a href="#env-latex">Environments</a></dt> +<dt>\hrulefill, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\hspace, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\huge, <a href="#typefaces">Typefaces</a></dt> +<dt>\Huge, <a href="#typefaces">Typefaces</a></dt> +<dt>\hyphenation, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\include, <a href="#splitting-the-input">Splitting the +Input</a></dt> +<dt>\includegraphics, +<a href="#includegraphics">\includegraphics</a></dt> +<dt>\includeonly, <a href="#splitting-the-input">Splitting the +Input</a></dt> +<dt>\indent, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>\input, <a href="#splitting-the-input">Splitting the +Input</a></dt> +<dt>\item, <a href="#env-latex">Environments</a></dt> +<dt>\itshape, <a href="#typefaces">Typefaces</a></dt> +<dt>\kill, <a href="#env-latex">Environments</a></dt> +<dt>\label, <a href="#cross-references">Cross References</a></dt> +<dt>\large, <a href="#typefaces">Typefaces</a></dt> +<dt>\Large, <a href="#typefaces">Typefaces</a></dt> +<dt>\LARGE, <a href="#typefaces">Typefaces</a></dt> +<dt>\ldots, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\lefteqn, <a href="#env-latex">Environments</a></dt> +<dt>\line, <a href="#env-latex">Environments</a></dt> +<dt>\linebreak, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\linethickness, <a href="#env-latex">Environments</a></dt> +<dt>\listof, <a href="#float">float</a></dt> +<dt>\listoffigures, <a href="#table-of-contents">Table of +Contents</a></dt> +<dt>\listoftables, <a href="#table-of-contents">Table of +Contents</a></dt> +<dt>\location, <a href="#letters">Letters</a></dt> +<dt>\makebox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\makebox (picture), <a href="#env-latex">Environments</a></dt> +<dt>\makelabels, <a href="#letters">Letters</a></dt> +<dt>\maketitle, <a href="#page-styles">Page Styles</a></dt> +<dt>\markboth, <a href="#page-styles">Page Styles</a></dt> +<dt>\markright, <a href="#page-styles">Page Styles</a></dt> +<dt>\mathbf, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathcal, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathit, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathnormal, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathrm, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathsf, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathtt, <a href="#typefaces">Typefaces</a></dt> +<dt>\mathversion, <a href="#typefaces">Typefaces</a></dt> +<dt>\mbox, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\mdseries, <a href="#typefaces">Typefaces</a></dt> +<dt>\medskip, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\multicolumn, <a href="#env-latex">Environments</a></dt> +<dt>\multiput, <a href="#env-latex">Environments</a></dt> +<dt>\name, <a href="#letters">Letters</a></dt> +<dt>\newcommand, <a href="#definitions">Definitions</a></dt> +<dt>\newcounter, <a href="#counters">Counters</a></dt> +<dt>\newenvironment, <a href="#definitions">Definitions</a></dt> +<dt>\newfloat, <a href="#float">float</a></dt> +<dt>\newfont, <a href="#definitions">Definitions</a></dt> +<dt>\newlength, <a href="#lengths">Lengths</a></dt> +<dt>\newline, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\newpage, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\newsavebox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\newtheorem, <a href="#definitions">Definitions</a></dt> +<dt>\nocite, <a href="#env-latex">Environments</a></dt> +<dt>\nofiles, <a href="#table-of-contents">Table of +Contents</a></dt> +<dt>\noindent, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>\nolinebreak, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\nopagebreak, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\normalfont, <a href="#typefaces">Typefaces</a></dt> +<dt>\normalsize, <a href="#typefaces">Typefaces</a></dt> +<dt>\onecolumn, <a href="#layout">Layout</a></dt> +<dt>\opening, <a href="#letters">Letters</a></dt> +<dt>\oval, <a href="#env-latex">Environments</a></dt> +<dt>\overbrace, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\overline, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\pagebreak, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\pagenumbering, <a href="#page-styles">Page Styles</a></dt> +<dt>\pageref, <a href="#cross-references">Cross References</a></dt> +<dt>\pagestyle, <a href="#page-styles">Page Styles</a></dt> +<dt>\par, <a href="#making-paragraphs">Making Paragraphs</a></dt> +<dt>\paragraph, <a href="#sectioning">Sectioning</a></dt> +<dt>\parbox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\pmb, <a href="#amsmath">amsmath</a></dt> +<dt>\poptabs, <a href="#env-latex">Environments</a></dt> +<dt>\ps, <a href="#letters">Letters</a></dt> +<dt>\pushtabs, <a href="#env-latex">Environments</a></dt> +<dt>\put, <a href="#env-latex">Environments</a></dt> +<dt>\raggedbottom, <a href="#layout">Layout</a></dt> +<dt>\raggedleft, <a href="#env-latex">Environments</a></dt> +<dt>\raggedright, <a href="#env-latex">Environments</a></dt> +<dt>\raisebox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\ref, <a href="#cross-references">Cross References</a></dt> +<dt>\refstepcounter, <a href="#counters">Counters</a></dt> +<dt>\restylefloat, <a href="#float">float</a></dt> +<dt>\rmfamily, <a href="#typefaces">Typefaces</a></dt> +<dt>\roman, <a href="#counters">Counters</a></dt> +<dt>\Roman, <a href="#counters">Counters</a></dt> +<dt>\rule, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\samepage, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\savebox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\sbox, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\scriptsize, <a href="#typefaces">Typefaces</a></dt> +<dt>\scshape, <a href="#typefaces">Typefaces</a></dt> +<dt>\selectfont, <a href="#typefaces">Typefaces</a></dt> +<dt>\setcounter, <a href="#counters">Counters</a></dt> +<dt>\setlength, <a href="#lengths">Lengths</a></dt> +<dt>\settodepth, <a href="#lengths">Lengths</a></dt> +<dt>\settoheight, <a href="#lengths">Lengths</a></dt> +<dt>\settowidth, <a href="#lengths">Lengths</a></dt> +<dt>\sffamily, <a href="#typefaces">Typefaces</a></dt> +<dt>\shortstack, <a href="#env-latex">Environments</a></dt> +<dt>\signature, <a href="#letters">Letters</a></dt> +<dt>\sloppy, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\slshape, <a href="#typefaces">Typefaces</a></dt> +<dt>\small, <a href="#typefaces">Typefaces</a></dt> +<dt>\smallskip, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\sqrt, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\startbreaks, <a href="#letters">Letters</a></dt> +<dt>\stepcounter, <a href="#counters">Counters</a></dt> +<dt>\stopbreaks, <a href="#letters">Letters</a></dt> +<dt>\subparagraph, <a href="#sectioning">Sectioning</a></dt> +<dt>\subsection, <a href="#sectioning">Sectioning</a></dt> +<dt>\subsubsection, <a href="#sectioning">Sectioning</a></dt> +<dt>\symbol, <a href="#special-characters">Special +Characters</a></dt> +<dt>\tableofcontents, <a href="#table-of-contents">Table of +Contents</a></dt> +<dt>\telephone, <a href="#letters">Letters</a></dt> +<dt>\textbf, <a href="#typefaces">Typefaces</a></dt> +<dt>\textit, <a href="#typefaces">Typefaces</a></dt> +<dt>\textmd, <a href="#typefaces">Typefaces</a></dt> +<dt>\textnormal, <a href="#typefaces">Typefaces</a></dt> +<dt>\textrm, <a href="#typefaces">Typefaces</a></dt> +<dt>\textsc, <a href="#typefaces">Typefaces</a></dt> +<dt>\textsf, <a href="#typefaces">Typefaces</a></dt> +<dt>\textsl, <a href="#typefaces">Typefaces</a></dt> +<dt>\texttt, <a href="#typefaces">Typefaces</a></dt> +<dt>\textup, <a href="#typefaces">Typefaces</a></dt> +<dt>\thanks, <a href="#page-styles">Page Styles</a></dt> +<dt>\thispagestyle, <a href="#page-styles">Page Styles</a></dt> +<dt>\tiny, <a href="#typefaces">Typefaces</a></dt> +<dt>\title, <a href="#page-styles">Page Styles</a></dt> +<dt>\today, <a href="#env-latex">Environments</a></dt> +<dt>\totalheight, <a href="#lengths">Lengths</a></dt> +<dt>\ttfamily, <a href="#typefaces">Typefaces</a></dt> +<dt>\twocolumn, <a href="#layout">Layout</a></dt> +<dt>\typearea, +<a href="#komascript-page-layout">Page-Layout</a></dt> +<dt>\typein, <a href="#terminal-input-slash-output">Terminal +Input/Output</a></dt> +<dt>\typeout, <a href="#terminal-input-slash-output">Terminal +Input/Output</a></dt> +<dt>\unboldmath, <a href="#bm-package">bm</a></dt> +<dt>\underbrace, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\underline, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\upDelta, <a href="#upDelta-upOmega">\upDelta / +\upOmega</a></dt> +<dt>\upOmega, <a href="#upDelta-upOmega">\upDelta / +\upOmega</a></dt> +<dt>\upshape, <a href="#typefaces">Typefaces</a></dt> +<dt>\usebox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\usecounter, <a href="#counters">Counters</a></dt> +<dt>\usefont, <a href="#typefaces">Typefaces</a></dt> +<dt>\usepackage, <a href="#document-classes">Document +Classes</a></dt> +<dt>\value, <a href="#counters">Counters</a></dt> +<dt>\vdots, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\vector, <a href="#env-latex">Environments</a></dt> +<dt>\verb, <a href="#env-latex">Environments</a></dt> +<dt>\vfill, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>\vline, <a href="#env-latex">Environments</a></dt> +<dt>\vpageref, <a href="#varioref">varioref</a></dt> +<dt>\vpagerefrange, <a href="#varioref">varioref</a></dt> +<dt>\vref, <a href="#varioref">varioref</a></dt> +<dt>\vrefrange, <a href="#varioref">varioref</a></dt> +<dt>\vspace, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt> +<dt>\width, <a href="#lengths">Lengths</a></dt> +<dt>\[, <a href="#math-formulae">Math Formulae</a></dt> +<dt>\\, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>\], <a href="#math-formulae">Math Formulae</a></dt> +<dt>\` (tabbing), <a href="#env-latex">Environments</a></dt> +<dt>^, <a href="#math-formulae">Math Formulae</a></dt> +<dt>_, <a href="#math-formulae">Math Formulae</a></dt></dl></div> +<div class="indexdiv"> +<h3>A</h3> +<dl> +<dt>About this Document, <a href="#about">About this +Document</a></dt> +<dt>Accents, <a href="#special-symbols">Special Symbols</a></dt> +<dt>Accessing any character of a font, +<a href="#special-characters">Special Characters</a></dt> +<dt>Aligning Equations, <a href="#env-latex">Environments</a></dt> +<dt>amsmath, <a href="#amsmath">amsmath</a></dt> +<dt>ansinew, <a href="#inputenc">inputenc</a></dt> +<dt>Appendix, creating, <a href="#sectioning">Sectioning</a></dt> +<dt>applemac, <a href="#inputenc">inputenc</a></dt> +<dt>array, <a href="#env-latex">Environments</a></dt> +<dt>Arrays, math, <a href="#env-latex">Environments</a></dt> +<dt>Arrows, <a href="#special-symbols">Special Symbols</a></dt> +<dt>article class, <a href="#document-classes">Document +Classes</a></dt> +<dt>Author, for titlepage, <a href="#page-styles">Page +Styles</a></dt></dl></div> +<div class="indexdiv"> +<h3>B</h3> +<dl> +<dt>BCOR, <a href="#komascript-options">Options</a></dt> +<dt>Bibliography, creating (automatically), +<a href="#env-latex">Environments</a></dt> +<dt>Bibliography, creating (manually), +<a href="#env-latex">Environments</a></dt> +<dt>BibTeX, <a href="#bibtex">BibTeX</a></dt> +<dd> +<dl> +<dt>bib files, <a href="#bibtex-bib-files">bib files</a></dt> +<dd> +<dl> +<dt>@STRING command, <a href="#bibtex-string-command">@STRING +command</a></dt> +<dt>Entry Format, <a href="#bibtex-entry-format">Entry +Format</a></dt> +<dt>Entry Types, <a href="#bibtex-entry-types">Entry Types</a></dt> +<dt>Field Text, <a href="#bibtex-field-text">Field Text</a></dt> +<dt>Field Types, <a href="#bibtex-field-types">Field +Types</a></dt></dl></dd> +<dt>bst files, <a href="#bibtex-bst-files">bst files</a></dt> +<dd> +<dl> +<dt>ABBRV.BST, <a href="#bibtex-bst-abbr">ABBRV.BST</a></dt> +<dt>ALPHA.BST, <a href="#bibtex-bst-alpha">ALPHA.BST</a></dt> +<dt>PLAIN.BST, <a href="#bibtex-bst-plain">PLAIN.BST</a></dt> +<dt>SAMPLE.BST, <a href="#bibtex-bst-sample">SAMPLE.BST</a></dt> +<dt>UNSRT.BST, +<a href="#bibtex-bst-unsrt">UNSRT.BST</a></dt></dl></dd> +<dt>Command Qualifiers, +<a href="#bibtex-command-qualifiers">Command Qualifiers</a></dt> +<dt>Entry Types</dt> +<dd> +<dl> +<dt>article entry, <a href="#bibtex-entry-types-article">article +entry</a></dt> +<dt>book entry, <a href="#bibtex-entry-types-book">book +entry</a></dt> +<dt>booklet entry, <a href="#bibtex-entry-types-booklet">booklet +entry</a></dt> +<dt>conference entry, +<a href="#bibtex-entry-types-conference">conference entry</a></dt> +<dt>inbook entry, <a href="#bibtex-entry-types-inbook">inbook +entry</a></dt> +<dt>incollection entry, +<a href="#bibtex-entry-types-incollection">incollection +entry</a></dt> +<dt>inproceedings entry, +<a href="#bibtex-entry-types-inproceedings">inproceedings +entry</a></dt> +<dt>manual entry, <a href="#bibtex-entry-types-manual">manual +entry</a></dt> +<dt>mastersthesis entry, +<a href="#bibtex-entry-types-mastersthesis">mastersthesis +entry</a></dt> +<dt>misc entry, <a href="#bibtex-entry-types-misc">misc +entry</a></dt> +<dt>phdthesis entry, +<a href="#bibtex-entry-types-phdthesis">phdthesis entry</a></dt> +<dt>proceedings entry, +<a href="#bibtex-entry-types-proceedings">proceedings +entry</a></dt> +<dt>techreport entry, +<a href="#bibtex-entry-types-techreport">techreport entry</a></dt> +<dt>unpublished entry, +<a href="#bibtex-entry-types-unpublished">unpublished +entry</a></dt></dl></dd> +<dt>Field Text</dt> +<dd> +<dl> +<dt>Abbreviations, +<a href="#bibtex-field-text-abbr">Abbreviations</a></dt> +<dt>Names, <a href="#bibtex-field-text-names">Names</a></dt> +<dt>Titles, +<a href="#bibtex-field-text-titles">Titles</a></dt></dl></dd> +<dt>Field Types</dt> +<dd> +<dl> +<dt>address field, <a href="#bibtex-field-types-address">address +field</a></dt> +<dt>annote field, <a href="#bibtex-field-types-annote">annote +field</a></dt> +<dt>author field, <a href="#bibtex-field-types-author">author +field</a></dt> +<dt>booktitle field, +<a href="#bibtex-field-types-booktitle">booktitle field</a></dt> +<dt>chapter field, <a href="#bibtex-field-types-chapter">chapter +field</a></dt> +<dt>edition field, <a href="#bibtex-field-types-edition">edition +field</a></dt> +<dt>editor field, <a href="#bibtex-field-types-editor">editor +field</a></dt> +<dt>howpublished field, +<a href="#bibtex-field-types-howpublished">howpublished +field</a></dt> +<dt>institution field, +<a href="#bibtex-field-types-institution">institution +field</a></dt> +<dt>journal field, <a href="#bibtex-field-types-journal">journal +field</a></dt> +<dt>key field, <a href="#bibtex-field-types-key">key field</a></dt> +<dt>month field, <a href="#bibtex-field-types-month">month +field</a></dt> +<dt>note field, <a href="#bibtex-field-types-note">note +field</a></dt> +<dt>number field, <a href="#bibtex-field-types-number">number +field</a></dt> +<dt>organization field, +<a href="#bibtex-field-types-organization">organization +field</a></dt> +<dt>pages field, <a href="#bibtex-field-types-pages">pages +field</a></dt> +<dt>publisher field, +<a href="#bibtex-field-types-publisher">publisher field</a></dt> +<dt>school field, <a href="#bibtex-field-types-school">school +field</a></dt> +<dt>series field, <a href="#bibtex-field-types-series">series +field</a></dt> +<dt>title field, <a href="#bibtex-field-types-title">title +field</a></dt> +<dt>type field, <a href="#bibtex-field-types-type">type +field</a></dt> +<dt>volume field, <a href="#bibtex-field-types-volume">volume +field</a></dt> +<dt>year field, <a href="#bibtex-field-types-year">year +field</a></dt></dl></dd> +<dt>Parameters, <a href="#bibtex-parameters">Parameters</a></dt> +<dt>using, <a href="#env-latex">Environments</a></dt></dl></dd> +<dt>Binary Operators, <a href="#special-symbols">Special +Symbols</a></dt> +<dt>bm, <a href="#bm-package">bm</a></dt> +<dt>book class, <a href="#document-classes">Document +Classes</a></dt> +<dt>Boxes, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt></dl></div> +<div class="indexdiv"> +<h3>C</h3> +<dl> +<dt>Cc list, <a href="#letters">Letters</a></dt> +<dt>center, <a href="#env-latex">Environments</a></dt> +<dt>Centering text, <a href="#env-latex">Environments</a></dt> +<dt>Centering text, environment for, +<a href="#env-latex">Environments</a></dt> +<dt>Characters, reserved, <a href="#special-characters">Special +Characters</a></dt> +<dt>Characters, special, <a href="#special-characters">Special +Characters</a></dt> +<dt>cite.sty, <a href="#env-latex">Environments</a></dt> +<dt>Classes of document, <a href="#document-classes">Document +Classes</a></dt> +<dt>Commands, defining new ones, +<a href="#definitions">Definitions</a></dt> +<dt>Computer programs, typesetting, +<a href="#env-latex">Environments</a></dt> +<dt>ConTeXt, <a href="#context">ConTeXt (tbd.)</a></dt> +<dt>Counters, a list of, <a href="#counters">Counters</a></dt> +<dt>Counters, creating, <a href="#counters">Counters</a></dt> +<dt>Counters, getting the value of, +<a href="#counters">Counters</a></dt> +<dt>Counters, setting, <a href="#counters">Counters</a></dt> +<dt>cp850, <a href="#inputenc">inputenc</a></dt> +<dt>Creating letters, <a href="#letters">Letters</a></dt> +<dt>Creating pictures, <a href="#env-latex">Environments</a></dt> +<dt>Creating tables, <a href="#env-latex">Environments</a></dt> +<dt>Credits, <a href="#credits">Credits</a></dt> +<dt>Cross referencing, <a href="#cross-references">Cross +References</a></dt> +<dt>Cross referencing using page number, +<a href="#cross-references">Cross References</a></dt> +<dt>Cross referencing using section number, +<a href="#cross-references">Cross References</a></dt></dl></div> +<div class="indexdiv"> +<h3>D</h3> +<dl> +<dt>Date, for titlepage, <a href="#page-styles">Page +Styles</a></dt> +<dt>dcolumn, <a href="#dcolumn">dcolumn</a></dt> +<dt>Defining a new command, +<a href="#definitions">Definitions</a></dt> +<dt>Defining new environments, +<a href="#definitions">Definitions</a></dt> +<dt>Defining new fonts, <a href="#definitions">Definitions</a></dt> +<dt>Defining new theorems, +<a href="#definitions">Definitions</a></dt> +<dt>Delimiters, <a href="#special-symbols">Special Symbols</a></dt> +<dt>description, <a href="#env-latex">Environments</a></dt> +<dt>Displaying quoted text, +<a href="#env-latex">Environments</a></dt> +<dt>Displaying quoted text with paragraph indentation, +<a href="#env-latex">Environments</a></dt> +<dt>DIV, <a href="#komascript-options">Options</a></dt> +<dt>Document Classes, <a href="#document-classes">Document +Classes</a></dt></dl></div> +<div class="indexdiv"> +<h3>E</h3> +<dl> +<dt>Ellipsis, <a href="#special-symbols">Special Symbols</a></dt> +<dt>Enclosed material, <a href="#letters">Letters</a></dt> +<dt>Ending & Starting, <a href="#starting-and-ending">Starting +& Ending</a></dt> +<dt>Enlarge current page, <a href="#line-and-page-breaking">Line +& Page Breaking</a></dt> +<dt>enumerate, <a href="#env-latex">Environments</a></dt> +<dt>Environments, <a href="#env-latex">Environments</a></dt> +<dt>Environments, defining, +<a href="#definitions">Definitions</a></dt> +<dt>eqnarray, <a href="#env-latex">Environments</a></dt> +<dt>equation, <a href="#env-latex">Environments</a></dt> +<dt>Equations, aligning, <a href="#env-latex">Environments</a></dt> +<dt>Equations, environment for, +<a href="#env-latex">Environments</a></dt> +<dt>exponent, <a href="#math-formulae">Math +Formulae</a></dt></dl></div> +<div class="indexdiv"> +<h3>F</h3> +<dl> +<dt>figure, <a href="#env-latex">Environments</a></dt> +<dt>Figures, footnotes in, +<a href="#env-latex">Environments</a></dt> +<dt>float, <a href="#float">float</a></dt> +<dd> +<dl> +<dt>\floatname, <a href="#float">float</a></dt> +<dt>\floatplacement, <a href="#float">float</a></dt> +<dt>\floatstyle, <a href="#float">float</a></dt> +<dt>\listof, <a href="#float">float</a></dt> +<dt>\newfloat, <a href="#float">float</a></dt> +<dt>\restylefloat, <a href="#float">float</a></dt></dl></dd> +<dt>Flushing a page, <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>flushleft, <a href="#env-latex">Environments</a></dt> +<dt>flushright, <a href="#env-latex">Environments</a></dt> +<dt>Font commands, low-level, +<a href="#typefaces">Typefaces</a></dt> +<dt>Font Sizes, <a href="#typefaces">Typefaces</a></dt> +<dt>Font Styles, <a href="#typefaces">Typefaces</a></dt> +<dt>fontenc, <a href="#fontenc">fontenc</a></dt> +<dt>fontinst, <a href="#fontinst">fontinst (tbd.)</a></dt> +<dt>Fonts, <a href="#typefaces">Typefaces</a></dt> +<dt>Fonts, new commands for, +<a href="#definitions">Definitions</a></dt> +<dt>footexclude, <a href="#komascript-options">Options</a></dt> +<dt>footinclude, <a href="#komascript-options">Options</a></dt> +<dt>Footnotes in figures, +<a href="#env-latex">Environments</a></dt> +<dt>Footnotes, creating, <a href="#footnotes">Footnotes</a></dt> +<dt>Formatting Text, <a href="#env-latex">Environments</a></dt> +<dt>Formulae, environment for, +<a href="#env-latex">Environments</a></dt> +<dt>Formulae, maths, <a href="#math-formulae">Math +Formulae</a></dt></dl></div> +<div class="indexdiv"> +<h3>G</h3> +<dl> +<dt>german, <a href="#german">german</a></dt> +<dd> +<dl> +<dt>!-, <a href="#german">german</a></dt> +<dt>"", <a href="#german">german</a></dt> +<dt>"=, <a href="#german">german</a></dt> +<dt>"a, <a href="#german">german</a></dt> +<dt>"ck, <a href="#german">german</a></dt> +<dt>"ff, <a href="#german">german</a></dt> +<dt>"|, <a href="#german">german</a></dt> +<dt>"~, <a href="#german">german</a></dt> +<dt><, <a href="#german">german</a></dt> +<dt>\-, <a href="#german">german</a></dt> +<dt>\dq, <a href="#german">german</a></dt> +<dt>\flq, <a href="#german">german</a></dt> +<dt>\flqq, <a href="#german">german</a></dt> +<dt>\frq, <a href="#german">german</a></dt> +<dt>\frqq, <a href="#german">german</a></dt> +<dt>\glq, <a href="#german">german</a></dt> +<dt>\glqq, <a href="#german">german</a></dt> +<dt>\grqq, <a href="#german">german</a></dt></dl></dd> +<dt>Global options, <a href="#document-classes">Document +Classes</a></dt> +<dt>graphics, <a href="#graphics">graphics</a></dt> +<dt>Greek letters, <a href="#math-formulae">Math Formulae</a></dt> +<dt>Greek Letters, <a href="#special-symbols">Special +Symbols</a></dt></dl></div> +<div class="indexdiv"> +<h3>H</h3> +<dl> +<dt>headexclude, <a href="#komascript-options">Options</a></dt> +<dt>headinclude, <a href="#komascript-options">Options</a></dt> +<dt>hyperref, <a href="#hyperref">hyperref</a></dt> +<dd> +<dl> +<dt>commands</dt> +<dd> +<dl> +<dt>\autoref, <a href="#hyperref-commands">Commands</a></dt> +<dt>\href, <a href="#hyperref-commands">Commands</a></dt> +<dt>\hyperbaseurl, <a href="#hyperref-commands">Commands</a></dt> +<dt>\hyperimage, <a href="#hyperref-commands">Commands</a></dt> +<dt>\hyperlink, <a href="#hyperref-commands">Commands</a></dt> +<dt>\hyperref, <a href="#hyperref-commands">Commands</a></dt> +<dt>\hypertarget, <a href="#hyperref-commands">Commands</a></dt> +<dt>\nolinkurl, <a href="#hyperref-commands">Commands</a></dt> +<dt>\texorpdfstring, +<a href="#hyperref-commands">Commands</a></dt></dl></dd> +<dt>options</dt> +<dd> +<dl> +<dt>4, <a href="#hyperref-options">Options</a></dt> +<dt>a4paper, <a href="#hyperref-options">Options</a></dt> +<dt>a5paper, <a href="#hyperref-options">Options</a></dt> +<dt>anchorcolor, <a href="#hyperref-options">Options</a></dt> +<dt>b5paper, <a href="#hyperref-options">Options</a></dt> +<dt>backref, <a href="#hyperref-options">Options</a></dt> +<dt>baseurl, <a href="#hyperref-options">Options</a></dt> +<dt>bookmarks, <a href="#hyperref-options">Options</a></dt> +<dt>bookmarksnumbered, <a href="#hyperref-options">Options</a></dt> +<dt>bookmarksopen, <a href="#hyperref-options">Options</a></dt> +<dt>bookmarksopenlevel, +<a href="#hyperref-options">Options</a></dt> +<dt>bookmarkstype, <a href="#hyperref-options">Options</a></dt> +<dt>breaklinks, <a href="#hyperref-options">Options</a></dt> +<dt>citebordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>citecolor, <a href="#hyperref-options">Options</a></dt> +<dt>colorlinks, <a href="#hyperref-options">Options</a></dt> +<dt>debug, <a href="#hyperref-options">Options</a></dt> +<dt>draft, <a href="#hyperref-options">Options</a></dt> +<dt>dvipdf, <a href="#hyperref-options">Options</a></dt> +<dt>dvipdfm, <a href="#hyperref-options">Options</a></dt> +<dt>dvips, <a href="#hyperref-options">Options</a></dt> +<dt>dvipsone, <a href="#hyperref-options">Options</a></dt> +<dt>dviwindo, <a href="#hyperref-options">Options</a></dt> +<dt>executivepaper, <a href="#hyperref-options">Options</a></dt> +<dt>extension, <a href="#hyperref-options">Options</a></dt> +<dt>filebordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>filecolor, <a href="#hyperref-options">Options</a></dt> +<dt>frenchlinks, <a href="#hyperref-options">Options</a></dt> +<dt>hyperfigures, <a href="#hyperref-options">Options</a></dt> +<dt>hyperindex, <a href="#hyperref-options">Options</a></dt> +<dt>hypertex, <a href="#hyperref-options">Options</a></dt> +<dt>hypertexnames, <a href="#hyperref-options">Options</a></dt> +<dt>implicit, <a href="#hyperref-options">Options</a></dt> +<dt>latex2html, <a href="#hyperref-options">Options</a></dt> +<dt>legalpaper, <a href="#hyperref-options">Options</a></dt> +<dt>letterpaper, <a href="#hyperref-options">Options</a></dt> +<dt>linkbordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>linkcolor, <a href="#hyperref-options">Options</a></dt> +<dt>linktocpage, <a href="#hyperref-options">Options</a></dt> +<dt>menubordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>menucolor, <a href="#hyperref-options">Options</a></dt> +<dt>naturalnames, <a href="#hyperref-options">Options</a></dt> +<dt>nesting, <a href="#hyperref-options">Options</a></dt> +<dt>pageanchor, <a href="#hyperref-options">Options</a></dt> +<dt>pagebackref, <a href="#hyperref-options">Options</a></dt> +<dt>pagebordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>pagecolor, <a href="#hyperref-options">Options</a></dt> +<dt>pdfauthor, <a href="#hyperref-options">Options</a></dt> +<dt>pdfborder, <a href="#hyperref-options">Options</a></dt> +<dt>pdfcenterwindow, <a href="#hyperref-options">Options</a></dt> +<dt>pdfcreator, <a href="#hyperref-options">Options</a></dt> +<dt>pdffitwindow, <a href="#hyperref-options">Options</a></dt> +<dt>pdfhighlight, <a href="#hyperref-options">Options</a></dt> +<dt>pdfkeywords, <a href="#hyperref-options">Options</a></dt> +<dt>pdfmenubar, <a href="#hyperref-options">Options</a></dt> +<dt>pdfnewwindow, <a href="#hyperref-options">Options</a></dt> +<dt>pdfpagelayout, <a href="#hyperref-options">Options</a></dt> +<dt>pdfpagemode, <a href="#hyperref-options">Options</a></dt> +<dt>pdfpagescrop, <a href="#hyperref-options">Options</a></dt> +<dt>pdfpagetransition, <a href="#hyperref-options">Options</a></dt> +<dt>pdfproducer, <a href="#hyperref-options">Options</a></dt> +<dt>pdfstartpage, <a href="#hyperref-options">Options</a></dt> +<dt>pdfstartview, <a href="#hyperref-options">Options</a></dt> +<dt>pdfsubject, <a href="#hyperref-options">Options</a></dt> +<dt>pdftex, <a href="#hyperref-options">Options</a></dt> +<dt>pdftitle, <a href="#hyperref-options">Options</a></dt> +<dt>pdftoolbar, <a href="#hyperref-options">Options</a></dt> +<dt>pdfview, <a href="#hyperref-options">Options</a></dt> +<dt>pdfwindowui, <a href="#hyperref-options">Options</a></dt> +<dt>plainpages, <a href="#hyperref-options">Options</a></dt> +<dt>raiselinks, <a href="#hyperref-options">Options</a></dt> +<dt>runbordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>tex4ht, <a href="#hyperref-options">Options</a></dt> +<dt>textures, <a href="#hyperref-options">Options</a></dt> +<dt>unicode, <a href="#hyperref-options">Options</a></dt> +<dt>urlbordercolor, <a href="#hyperref-options">Options</a></dt> +<dt>urlcolor, <a href="#hyperref-options">Options</a></dt> +<dt>verbose, <a href="#hyperref-options">Options</a></dt> +<dt>vtex, +<a href="#hyperref-options">Options</a></dt></dl></dd></dl></dd> +<dt>Hyphenation, defining, <a href="#line-and-page-breaking">Line +& Page Breaking</a></dt> +<dt>Hyphenation, forcing, <a href="#line-and-page-breaking">Line +& Page Breaking</a></dt></dl></div> +<div class="indexdiv"> +<h3>I</h3> +<dl> +<dt>Indent, forcing, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>Indent, suppressing, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>Input file, splitting, <a href="#splitting-the-input">Splitting +the Input</a></dt> +<dt>Input/Output, <a href="#terminal-input-slash-output">Terminal +Input/Output</a></dt> +<dt>inputenc, <a href="#inputenc">inputenc</a></dt> +<dt>Inserting figures, <a href="#env-latex">Environments</a></dt> +<dt>itemize, <a href="#env-latex">Environments</a></dt></dl></div> +<div class="indexdiv"> +<h3>J</h3> +<dl> +<dt>Justification, ragged left, +<a href="#env-latex">Environments</a></dt> +<dt>Justification, ragged right, +<a href="#env-latex">Environments</a></dt></dl></div> +<div class="indexdiv"> +<h3>K</h3> +<dl> +<dt>Known Issues, <a href="#issues">Bugs / Known Issues / Missing +Features</a></dt> +<dt>KOMA-Script, <a href="#komascript">KOMA-Script</a></dt> +<dd> +<dl> +<dt>scraddr, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dd> +<dl> +<dt>\Address{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\Comment{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\FirstName{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\FreeIII{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\FreeII{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\FreeIV{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\FreeI{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\InputAddressFile, <a href="#komascript-scraddr">Address Files +with scraddr</a></dt> +<dt>\LastName{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\Name{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt> +<dt>\Telephone{}, <a href="#komascript-scraddr">Address Files with +scraddr</a></dt></dl></dd> +<dt>scrlttr2, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dd> +<dl> +<dt>address, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>address files, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>backaddress, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>backaddressseparator, <a href="#komascript-scrlttr2">Letter +Class scrlttr2</a></dt> +<dt>business line, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>carbon copy, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>ccseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>circular letters, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>Closing, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>Closing Part, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>customer, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>date, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>emailseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>enclosure, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>enclseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>faxseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>font options, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>font selection, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>footer, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>footnotes, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>format options, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromaddress, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>frombank, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromemail, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromfax, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromlogo, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromname, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromphone, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>fromurl, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>general document properties, +<a href="#komascript-scrlttr2">Letter Class scrlttr2</a></dt> +<dt>invoice, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>language selection, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>language support, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>letter class option files, +<a href="#komascript-scrlttr2">Letter Class scrlttr2</a></dt> +<dt>letter declaration, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>letterhead, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>lists, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>location, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>margin notes, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>myref, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>Opening, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>options, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>options for letterhead and address, +<a href="#komascript-scrlttr2">Letter Class scrlttr2</a></dt> +<dt>other layout, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>page layout, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>page style, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>phoneseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>place, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>placeseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>postscript, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>pseudo lengths, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>sender's extension, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>signature, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>specialmail, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>subject, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>subject line, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>subjectseparator, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>text, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>text emphasis, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>title, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>title line, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>toaddress, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>toname, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>variables, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>yourmail, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>yourref, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>\addtoreffields, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>\ifkomavarempty, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>\KOMAoptions{}, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>\newkomavar, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>\setkomavar, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt> +<dt>\usekomavar, <a href="#komascript-scrlttr2">Letter Class +scrlttr2</a></dt></dl></dd></dl></dd></dl></div> +<div class="indexdiv"> +<h3>L</h3> +<dl> +<dt>Labelled lists, creating, +<a href="#env-latex">Environments</a></dt> +<dt>LaTeX</dt> +<dd> +<dl> +<dt>Options, <a href="#opt-latex">Options</a></dt> +<dd> +<dl> +<dt>-file-line-error-style, +<a href="#opt-latex-file-line-error-style">-file-line-error-style</a></dt> +<dt>-fmt=FMTNAME, <a href="#opt-latex-fmt">-fmt=FMTNAME</a></dt> +<dt>-help, <a href="#opt-latex-help">-help</a></dt> +<dt>-ini, <a href="#opt-latex-ini">-ini</a></dt> +<dt>-interaction=STRING, +<a href="#opt-latex-interaction%20mode">-interaction=STRING</a></dt> +<dt>-ipc, <a href="#opt-latex-ipc">-ipc</a></dt> +<dt>-ipc-start, <a href="#opt-latex-ipc-start">-ipc-start</a></dt> +<dt>-jobname=STRING, +<a href="#opt-latex-jobname-name">-jobname=STRING</a></dt> +<dt>-kpathsea-debug=NUMBER, +<a href="#opt-latex-kpathsea-debug">-kpathsea-debug=NUMBER</a></dt> +<dt>-mltex, <a href="#opt-latex-mltex">-mltex</a></dt> +<dt>-output-comment=STRING, +<a href="#opt-latex-output-comment">-output-comment=STRING</a></dt> +<dt>-parse-first-line, +<a href="#opt-latex-parse-first-line">-parse-first-line</a></dt> +<dt>-progname=STRING, +<a href="#opt-latex-progname">-progname=STRING</a></dt> +<dt>-recorder, <a href="#opt-latex-recorder">-recorder</a></dt> +<dt>-shell-escape, +<a href="#opt-latex-shell-escape">-shell-escape</a></dt> +<dt>-src-specials, +<a href="#opt-latex-src-specials">-src-specials</a></dt> +<dt>-src-specials=WHERE, +<a href="#opt-latex-src-specials-where">-src-specials=WHERE</a></dt> +<dt>-translate-file=TCXNAME, +<a href="#opt-latex-translate-file-tcxname">-translate-file=TCXNAME</a></dt> +<dt>-version, +<a href="#opt-latex-version">-version</a></dt></dl></dd></dl></dd> +<dt>LaTeX overview, <a href="#overview">Overview of LaTeX and Local +Guide</a></dt> +<dt>LaTeX Packages, <a href="#latex-packages">LaTeX +Packages</a></dt> +<dt>latin1, <a href="#inputenc">inputenc</a></dt> +<dt>latin9, <a href="#inputenc">inputenc</a></dt> +<dt>Layout commands, <a href="#document-classes">Document +Classes</a></dt> +<dt>Left-justifying text, +<a href="#env-latex">Environments</a></dt> +<dt>Left-justifying text, environment for, +<a href="#env-latex">Environments</a></dt> +<dt>Left-to-right mode, <a href="#modes">Modes</a></dt> +<dt>Lengths, adding to, <a href="#lengths">Lengths</a></dt> +<dt>Lengths, defining a new, <a href="#lengths">Lengths</a></dt> +<dt>Lengths, defining and using, +<a href="#lengths">Lengths</a></dt> +<dt>Lengths, predefined, <a href="#lengths">Lengths</a></dt> +<dt>Lengths, setting value of, <a href="#lengths">Lengths</a></dt> +<dt>letter, <a href="#env-latex">Environments</a></dt> +<dt>letter class, <a href="#document-classes">Document +Classes</a></dt> +<dt>Letters, <a href="#letters">Letters</a></dt> +<dt>Letters, ending, <a href="#letters">Letters</a></dt> +<dt>Letters, starting, <a href="#letters">Letters</a></dt> +<dt>Line Breaking, <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>Line breaks, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>Lines in tables, <a href="#env-latex">Environments</a></dt> +<dt>Lining text up in columns using tab stops, +<a href="#env-latex">Environments</a></dt> +<dt>Lining text up in tables, +<a href="#env-latex">Environments</a></dt> +<dt>list, <a href="#env-latex">Environments</a></dt> +<dt>Lists of items, <a href="#env-latex">Environments</a></dt> +<dt>Lists of items, generic, +<a href="#env-latex">Environments</a></dt> +<dt>Lists of items, numbered, +<a href="#env-latex">Environments</a></dt> +<dt>Loading additional packages, +<a href="#document-classes">Document Classes</a></dt> +<dt>Low-level font commands, +<a href="#typefaces">Typefaces</a></dt> +<dt>LR mode, <a href="#modes">Modes</a></dt> +<dt>lrbox, <a href="#spaces-and-boxes">Spaces & +Boxes</a></dt></dl></div> +<div class="indexdiv"> +<h3>M</h3> +<dl> +<dt>Make-Index, <a href="#makeindex">Make-Index</a></dt> +<dd> +<dl> +<dt>Example, <a href="#makeindex-example">Example</a></dt> +<dt>Input Style Specifiers, <a href="#makeindex-style">Input Style +Specifiers</a></dt> +<dd> +<dl> +<dt>actual, <a href="#makeindex-actual-char">actual +<char></a></dt> +<dt>arg_close, <a href="#makeindex-arg-close">arg_close +<char></a></dt> +<dt>arg_open, <a href="#makeindex-style-arg-open">arg_open +<char></a></dt> +<dt>encap, <a href="#makeindex-encap-char">encap +<char></a></dt> +<dt>escape, <a href="#makeindex-escape-char">escape +<char></a></dt> +<dt>keyword, <a href="#makeindex-style-string">keyword +<string></a></dt> +<dt>level, <a href="#makeindex-level-char">level +<char></a></dt> +<dt>quote, <a href="#makeindex-quote-char">quote +<char></a></dt> +<dt>range_close, <a href="#makeindex-range-close">range_close +<char></a></dt> +<dt>range_open, <a href="#makeindex-range-open">range_open +<char></a></dt></dl></dd> +<dt>Options, <a href="#makeindex-options">Options</a></dt> +<dd> +<dl> +<dt>-c, <a href="#makeindex-option-c">-c</a></dt> +<dt>-g, <a href="#makeindex-option-g">-g</a></dt> +<dt>-i, <a href="#makeindex-option-i">-i</a></dt> +<dt>-l, <a href="#makeindex-option-l">-l</a></dt> +<dt>-L, <a href="#makeindex-option-L">-L</a></dt> +<dt>-o ind, <a href="#makeindex-option-o-ind">-o ind</a></dt> +<dt>-p no, <a href="#makeindex-option-p-no">-p no</a></dt> +<dt>-q, <a href="#makeindex-option-q">-q</a></dt> +<dt>-r, <a href="#makeindex-option-r">-r</a></dt> +<dt>-s sty, <a href="#makeindex-option-s-sty">-s sty</a></dt> +<dt>-T, <a href="#makeindex-option-T">-T</a></dt> +<dt>-t log, <a href="#makeindex-option-t-log">-t +log</a></dt></dl></dd> +<dt>Ordering, <a href="#makeindex-ordering">Ordering</a></dt> +<dt>Output Style Specifiers, +<a href="#makeindex-output-style-specs">Output Style +Specifiers</a></dt> +<dd> +<dl> +<dt>delim_0, <a href="#makeindex-output-delim-0">delim_0 +<string></a></dt> +<dt>delim_1, <a href="#makeindex-output-delim-1">delim_1 +<string></a></dt> +<dt>delim_2, <a href="#makeindex-output-delim-2">delim_2 +<string></a></dt> +<dt>delim_n, <a href="#makeindex-output-delim-n">delim_n +<string></a></dt> +<dt>delim_r, <a href="#makeindex-output-delim-r">delim_r +<string></a></dt> +<dt>delim_t, <a href="#makeindex-output-delim-t">delim_t +<string></a></dt> +<dt>encap_infix, +<a href="#makeindex-output-encap-infox">encap_infix +<string></a></dt> +<dt>encap_prefix, +<a href="#makeindex-output-encap-prefix">encap_prefix +<string></a></dt> +<dt>encap_suffix, +<a href="#makeindex-output-encap-suffix">encap_suffix +<string></a></dt> +<dt>group_skip, <a href="#makeindex-output-group-skip">group_skip +<string></a></dt> +<dt>headings_flag, +<a href="#makeindex-output-headings-flag">headings_flag +<string></a></dt> +<dt>heading_prefix, +<a href="#makeindex-output-heading-prefix-string">heading_prefix +<string></a></dt> +<dt>heading_suffix, +<a href="#makeindex-output-heading-suffix-string">heading_suffix +<string></a></dt> +<dt>indent_length, +<a href="#makeindex-output-indent-length">indent_length +<number></a></dt> +<dt>indent_space, +<a href="#makeindex-output-indent-space">indent_space +<string></a></dt> +<dt>item_0, <a href="#makeindex-output-item-0">item_0 +<string></a></dt> +<dt>item_01, <a href="#makeindex-output-item-01">item_01 +<string></a></dt> +<dt>item_1, <a href="#makeindex-output-item-1">item_1 +<string></a></dt> +<dt>item_12, <a href="#makeindex-output-item-12">item_12 +<string></a></dt> +<dt>item_2, <a href="#makeindex-output-item-2">item_2 +<string></a></dt> +<dt>item_x1, <a href="#makeindex-output-item-x1">item_x1 +<string></a></dt> +<dt>item_x2, <a href="#makeindex-output-item-x2">item_x2 +<string></a></dt> +<dt>line_max, <a href="#makeindex-output-line-max">line_max +<number></a></dt> +<dt>numhead_negative, +<a href="#makeindex-output-numhead-negative">numhead_negative +<string></a></dt> +<dt>numhead_positive, +<a href="#makeindex-output-numhead-positive">numhead_positive +<string></a></dt> +<dt>page_compositor, +<a href="#makeindex-page-compositor">page_compositor +<string></a></dt> +<dt>postamble, +<a href="#makeindex-output-postamble-string">postamble +<string></a></dt> +<dt>preamble, <a href="#makeindex-output-preamble-string">preamble +<string></a></dt> +<dt>setpage_prefix, +<a href="#makeindex-output-setpage-prefix">setpage_prefix +<string></a></dt> +<dt>setpage_suffix, +<a href="#makeindex-output-setpage-suffix">setpage_suffix +<string></a></dt> +<dt>suffix_2p, <a href="#makeindex-output-suffix-2p">suffix_2p +<string></a></dt> +<dt>suffix_3p, <a href="#makeindex-output-suffix-3p">suffix_3p +<string></a></dt> +<dt>suffix_mp, <a href="#makeindex-output-suffix-mp">suffix_mp +<string></a></dt> +<dt>symhead_negative, +<a href="#makeindex-output-symhead-negative">symhead_negative +<string></a></dt> +<dt>symhead_positive, +<a href="#makeindex-output-symhead-positive">symhead_positive +<string></a></dt></dl></dd> +<dt>Special Effects, <a href="#makeindex-special-effects">Special +Effects</a></dt> +<dt>Style File, <a href="#makeindex-style-file">Style +File</a></dt></dl></dd> +<dt>Making a title page, <a href="#env-latex">Environments</a></dt> +<dt>Making paragraphs, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>Margin Notes, <a href="#margin-notes">Margin Notes</a></dt> +<dt>Math Formulae, <a href="#math-formulae">Math Formulae</a></dt> +<dt>Math Functions, <a href="#special-symbols">Special +Symbols</a></dt> +<dt>Math Miscellany, <a href="#math-formulae">Math +Formulae</a></dt> +<dt>Math mode, <a href="#modes">Modes</a></dt> +<dt>Math mode, entering, <a href="#math-formulae">Math +Formulae</a></dt> +<dt>Math mode, spacing, <a href="#math-formulae">Math +Formulae</a></dt> +<dt>Math Symbols, Variable Size, <a href="#special-symbols">Special +Symbols</a></dt> +<dt>mathpazo, <a href="#mathpazo">mathpazo</a></dt> +<dt>Maths symbols, <a href="#math-formulae">Math Formulae</a></dt> +<dt>Metafont, <a href="#metafont">Metafont (tbd.)</a></dt> +<dt>MetaPost, <a href="#metapost">MetaPost</a></dt> +<dd> +<dl> +<dt>Environment, +<a href="#metapost-environment">Environment</a></dt> +<dd> +<dl> +<dt>MFINPUTS, <a href="#metapost-environment">Environment</a></dt> +<dt>MPEDIT, <a href="#metapost-environment">Environment</a></dt> +<dt>MPINPUTS, <a href="#metapost-environment">Environment</a></dt> +<dt>MPSUPPORT, <a href="#metapost-environment">Environment</a></dt> +<dt>MPXCOMMAND, +<a href="#metapost-environment">Environment</a></dt> +<dt>TEX, <a href="#metapost-environment">Environment</a></dt> +<dt>TROFF, +<a href="#metapost-environment">Environment</a></dt></dl></dd> +<dt>Options, <a href="#metapost-options">Options</a></dt> +<dd> +<dl> +<dt>--file-line-error-style, +<a href="#metapost-option-file-line-error-style">--file-line-error-style</a></dt> +<dt>--help, <a href="#metapost-option-help">--help</a></dt> +<dt>--ini, <a href="#metapost-option-ini">--ini</a></dt> +<dt>--interaction mode, +<a href="#metapost-option-intercation">--interaction mode</a></dt> +<dt>--jobname name, <a href="#metapost-option-jobname">--jobname +name</a></dt> +<dt>--kpathsea-debug bitmask, +<a href="#metapost-option-kpathsea-debug">--kpathsea-debug +bitmask</a></dt> +<dt>--mem mem, <a href="#metapost-option-mem">--mem mem</a></dt> +<dt>--parse-first-line, +<a href="#metapost-option-parse-first-line">--parse-first-line</a></dt> +<dt>--progname name, <a href="#metapost-option-progname">--progname +name</a></dt> +<dt>--recorder, +<a href="#metapost-option-recorder">--recorder</a></dt> +<dt>--translate-file tcxname, +<a href="#metapost-option-translate-file">--translate-file +tcxname</a></dt> +<dt>--troff, <a href="#metapost-option-troff">--troff</a></dt> +<dt>--version, +<a href="#metapost-option-version">--version</a></dt> +<dt>-T, +<a href="#metapost-option-T">-T</a></dt></dl></dd></dl></dd> +<dt>minipage, <a href="#env-latex">Environments</a></dt> +<dt>Minipage, creating a, +<a href="#env-latex">Environments</a></dt> +<dt>Modes, <a href="#modes">Modes</a></dt> +<dt>Multicolumn text, <a href="#layout">Layout</a></dt></dl></div> +<div class="indexdiv"> +<h3>N</h3> +<dl> +<dt>New line, starting, <a href="#line-and-page-breaking">Line +& Page Breaking</a></dt> +<dt>New line, starting (paragraph mode), +<a href="#line-and-page-breaking">Line & Page Breaking</a></dt> +<dt>New Page, <a href="#line-and-page-breaking">Line & Page +Breaking</a></dt> +<dt>Notes in the margin, <a href="#margin-notes">Margin +Notes</a></dt></dl></div> +<div class="indexdiv"> +<h3>O</h3> +<dl> +<dt>Operators</dt> +<dd> +<dl> +<dt>Binary, <a href="#special-symbols">Special Symbols</a></dt> +<dt>Relational, <a href="#special-symbols">Special +Symbols</a></dt></dl></dd> +<dt>Options, global, <a href="#document-classes">Document +Classes</a></dt> +<dt>overcite.sty, <a href="#env-latex">Environments</a></dt> +<dt>Overview of LaTeX, <a href="#overview">Overview of LaTeX and +Local Guide</a></dt></dl></div> +<div class="indexdiv"> +<h3>P</h3> +<dl> +<dt>Packages</dt> +<dd> +<dl> +<dt>amsmath, <a href="#amsmath">amsmath</a></dt> +<dt>bm, <a href="#bm-package">bm</a></dt> +<dt>bm.sty, <a href="#bm-package">bm</a></dt> +<dt>dcolumn, <a href="#dcolumn">dcolumn</a></dt> +<dt>german, <a href="#german">german</a></dt> +<dt>graphics, <a href="#graphics">graphics</a></dt> +<dt>hyperref, <a href="#hyperref">hyperref</a></dt> +<dt>KOMA-Script, <a href="#komascript">KOMA-Script</a></dt> +<dt>mathpazo, <a href="#mathpazo">mathpazo</a></dt> +<dt>Several Small Packages, <a href="#small-packages">Several Small +Packages</a></dt> +<dt>url, <a href="#url-package">url</a></dt> +<dt>varioref, <a href="#varioref">varioref</a></dt></dl></dd> +<dt>Packages, loading, <a href="#document-classes">Document +Classes</a></dt> +<dt>Page break, forcing, <a href="#line-and-page-breaking">Line +& Page Breaking</a></dt> +<dt>Page Breaking, <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>Page Formatting, <a href="#line-and-page-breaking">Line & +Page Breaking</a></dt> +<dt>Page numbering, <a href="#page-styles">Page Styles</a></dt> +<dt>Page styles, <a href="#page-styles">Page Styles</a></dt> +<dt>Paragraph mode, <a href="#modes">Modes</a></dt> +<dt>Paragraph, starting a new, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>Paragraphs, <a href="#making-paragraphs">Making +Paragraphs</a></dt> +<dt>Parameters, <a href="#parameters">Parameters</a></dt> +<dt>pdfTeX, <a href="#pdftex">pdfTeX</a></dt> +<dd> +<dl> +<dt>Environment, <a href="#pdftex-environment">Environment</a></dt> +<dd> +<dl> +<dt>TEXEDIT, <a href="#pdftex-environment">Environment</a></dt> +<dt>TEXFONTS, <a href="#pdftex-environment">Environment</a></dt> +<dt>TEXFORMATS, <a href="#pdftex-environment">Environment</a></dt> +<dt>TEXINPUTS, <a href="#pdftex-environment">Environment</a></dt> +<dt>TEXMFOUTPUT, <a href="#pdftex-environment">Environment</a></dt> +<dt>TEXPOOL, +<a href="#pdftex-environment">Environment</a></dt></dl></dd> +<dt>Options, <a href="#pdftex-options">Options</a></dt> +<dd> +<dl> +<dt>--file-line-error-style, +<a href="#pdftex-option-file-line-error-style">--file-line-error-style</a></dt> +<dt>--fmt format, <a href="#pdftex-option-fmt">--fmt +format</a></dt> +<dt>--help, <a href="#pdftex-option-help">--help</a></dt> +<dt>--ini, <a href="#pdftex-option-ini">--ini</a></dt> +<dt>--interaction mode, +<a href="#pdftex-option-interaction%20mode">--interaction +mode</a></dt> +<dt>--ipc, <a href="#pdftex-option-ipc">--ipc</a></dt> +<dt>--ipc-start, +<a href="#pdftex-option-ipc-start">--ipc-start</a></dt> +<dt>--jobname name, <a href="#pdftex-option-jobname-name">--jobname +name</a></dt> +<dt>--kpathsea-debug bitmask, +<a href="#pdftex-option-kpathsea-debug">--kpathsea-debug +bitmask</a></dt> +<dt>--maketex fmt, <a href="#pdftex-option-maketex">--maketex +fmt</a></dt> +<dt>--no-maketex fmt, +<a href="#pdftex-option-no-maketex">--no-maketex fmt</a></dt> +<dt>--output-comment string, +<a href="#pdftex-option-output-comment">--output-comment +string</a></dt> +<dt>--parse-first-line, +<a href="#pdftex-option-parse-first-line">--parse-first-line</a></dt> +<dt>--progname name, <a href="#pdftex-option-progname">--progname +name</a></dt> +<dt>--recorder, +<a href="#pdftex-option-recorder">--recorder</a></dt> +<dt>--shell-escape, +<a href="#pdftex-option-shell-escape">--shell-escape</a></dt> +<dt>--translate-file tcxname, +<a href="#pdftex-option-translate-file">--translate-file +tcxname</a></dt> +<dt>--version, <a href="#pdftex-option-version">--version</a></dt> +<dt>[-no]-maketex=FMT, +<a href="#opt-latex-no-maketex">[-no]-maketex=FMT</a></dt></dl></dd></dl></dd> +<dt>People</dt> +<dd> +<dl> +<dt>Bausum, David, <a href="#plaintex-ovw">Overview</a></dt> +<dt>Berry, Karl, <a href="#credits">Credits</a></dt> +<dt>Borgert, Wolfgang, <a href="#credits">Credits</a></dt> +<dt>Casellas, Ramon, <a href="#credits">Credits</a></dt> +<dt>Danielsson, Holger, <a href="#credits">Credits</a></dt> +<dt>Devenish, James, <a href="#credits">Credits</a></dt> +<dt>Gaesslein, Hubert, <a href="#credits">Credits</a></dt> +<dt>Goossens, Michel, <a href="#overview">Overview of LaTeX and +Local Guide</a></dt> +<dt>Hagen, Hans, <a href="#context">ConTeXt (tbd.)</a></dt> +<dt>Karp, Peter, <a href="#credits">Credits</a></dt> +<dt>Lamport, Leslie, <a href="#overview">Overview of LaTeX and +Local Guide</a></dt> +<dt>Mittelbach, Frank, <a href="#overview">Overview of LaTeX and +Local Guide</a></dt> +<dt>Niepraschk, Rolf, <a href="#credits">Credits</a></dt> +<dt>Nordhaug, Hans Fredrik, <a href="#credits">Credits</a></dt> +<dt>Pepping, Simon, <a href="#credits">Credits</a></dt> +<dt>Samarin, Alexander, <a href="#overview">Overview of LaTeX and +Local Guide</a></dt> +<dt>Stayton, Bob, <a href="#credits">Credits</a></dt> +<dt>van Zandt, Timothy, <a href="#pstricks-ovw">Overview</a></dt> +<dt>Voss, Herbert, <a href="#credits">Credits</a></dt></dl></dd> +<dt>PiCTeX, <a href="#pictex">PiCTeX (tbd.)</a></dt> +<dt>picture, <a href="#env-latex">Environments</a></dt> +<dt>Pictures, creating, <a href="#env-latex">Environments</a></dt> +<dt>PlainTeX, <a href="#plaintex">PlainTeX</a></dt> +<dt>Poetry, an environment for, +<a href="#env-latex">Environments</a></dt> +<dt>Predefined lengths, <a href="#lengths">Lengths</a></dt> +<dt>Programs, typesetting, +<a href="#env-latex">Environments</a></dt> +<dt>PSTricks, <a href="#pstricks">PSTricks</a></dt> +<dd> +<dl> +<dt>commands</dt> +<dd> +<dl> +<dt>\aput, <a href="#pstricks-attaching">Attaching labels to node +connections</a></dt> +<dt>\Aput, <a href="#pstricks-attaching">Attaching labels to node +connections</a></dt> +<dt>\arrows, <a href="#hackers">For hackers only</a></dt> +<dt>\bput, <a href="#pstricks-attaching">Attaching labels to node +connections</a></dt> +<dt>\Bput, <a href="#pstricks-attaching">Attaching labels to node +connections</a></dt> +<dt>\circlenode, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\clipbox, <a href="#pstricks-clipping">Clipping</a></dt> +<dt>\closedshadow, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\closepath, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\cnode, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\cnodeput, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\code, <a href="#hackers">For hackers only</a></dt> +<dt>\coor, <a href="#hackers">For hackers only</a></dt> +<dt>\cput, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>\curveto, <a href="#pretty-safe-tricks">Pretty safe +tricks</a></dt> +<dt>\dataplot, <a href="#pstricks-plots">Plots</a></dt> +<dt>\degrees, <a href="#pstricks-dimensions">Dimensions, +coordinates and angles</a></dt> +<dt>\dim, <a href="#hackers">For hackers only</a></dt> +<dt>\endpspicture, <a href="#pictures">Pictures</a></dt> +<dt>\everypsbox, <a href="#pstricks-boxes">Boxes</a></dt> +<dt>\file, <a href="#hackers">For hackers only</a></dt> +<dt>\fileplot, <a href="#pstricks-plots">Plots</a></dt> +<dt>\fill, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\grestore, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\gsave, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\lineto, <a href="#pretty-safe-tricks">Pretty safe +tricks</a></dt> +<dt>\listplot, <a href="#pstricks-plots">Plots</a></dt> +<dt>\lput, <a href="#pstricks-attaching">Attaching labels to node +connections</a></dt> +<dt>\movepath, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\moveto, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\mput, <a href="#pstricks-attaching">Attaching labels to node +connections</a></dt> +<dt>\mrestore, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\msave, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\multips, <a href="#pstricks-repetition">Repetition</a></dt> +<dt>\multirput, <a href="#pstricks-repetition">Repetition</a></dt> +<dt>\ncangle, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncangles, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncarc, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncbar, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\nccircle, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\nccoil, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\nccurve, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncdiag, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncdiagg, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncline, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncLine, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\ncloop, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\nczigzag, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\newcmykcolor, <a href="#pstricks-color">Color</a></dt> +<dt>\newgray, <a href="#pstricks-color">Color</a></dt> +<dt>\newhsbcolor, <a href="#pstricks-color">Color</a></dt> +<dt>\newpath, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\newpsobject, <a href="#pstricks-custom">Custom styles</a></dt> +<dt>\newpsstyle, <a href="#pstricks-custom">Custom styles</a></dt> +<dt>\newrgbcolor, <a href="#pstricks-color">Color</a></dt> +<dt>\NormalCoor, <a href="#pstricks-coordinates">Special +coordinates</a></dt> +<dt>\openshadow, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\ovalnode, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\overlaybox, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>\parabola, <a href="#pstricks-curves">Curves</a></dt> +<dt>\parametricplot, <a href="#pstricks-plots">Plots</a></dt> +<dt>\pcangle, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pcarc, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pcbar, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pccoil, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\pccurve, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pcdiag, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pcline, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pcloop, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>\pczigzag, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\pnode, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\psarc, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>\psarcn, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>\psaxes, <a href="#pstricks-axes">Axes</a></dt> +<dt>\psbezier, <a href="#pstricks-curves">Curves</a></dt> +<dt>\psccurve, <a href="#pstricks-curves">Curves</a></dt> +<dt>\pscharclip, <a href="#pstricks-stroking">Stroking and filling +character paths</a></dt> +<dt>\pscharpath, <a href="#pstricks-stroking">Stroking and filling +character paths</a></dt> +<dt>\pscircle, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>\pscirclebox, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>\psclip, <a href="#pstricks-clipping">Clipping</a></dt> +<dt>\pscoil, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\psCoil, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\pscurve, <a href="#pstricks-curves">Curves</a></dt> +<dt>\pscustom, <a href="#pstricks-basics">The basics</a></dt> +<dt>\psdblframebox, <a href="#pstricks-framed">Framed +boxes</a></dt> +<dt>\psdots, <a href="#pstricks-dots">Dots</a></dt> +<dt>\psecurve, <a href="#pstricks-curves">Curves</a></dt> +<dt>\psellipse, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>\psframe, <a href="#pstricks-lines">Lines and polygons</a></dt> +<dt>\psframebox, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>\psgrid, <a href="#pstricks-grids">Grids</a></dt> +<dt>\pslabelsep, <a href="#placing">Placing and rotating +whatever</a></dt> +<dt>\pslbrace, <a href="#pstricks-tricks">Tips and More +Tricks</a></dt> +<dt>\psline, <a href="#pstricks-lines">Lines and polygons</a></dt> +<dt>\pslongbox, <a href="#pstricks-boxes">Boxes</a></dt> +<dt>\psmathboxfalse, <a href="#pstricks-boxes">Boxes</a></dt> +<dt>\psmathboxtrue, <a href="#pstricks-boxes">Boxes</a></dt> +<dt>\psovalbox, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>\psoverlay, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>\pspicture, <a href="#pictures">Pictures</a></dt> +<dt>\psplot, <a href="#pstricks-plots">Plots</a></dt> +<dt>\pspolygon, <a href="#pstricks-lines">Lines and +polygons</a></dt> +<dt>\psrbrace, <a href="#pstricks-tricks">Tips and More +Tricks</a></dt> +<dt>\psset, <a href="#pstricks-setting">Setting graphics +parameters</a></dt> +<dt>\pssetlength, <a href="#pstricks-dimensions">Dimensions, +coordinates and angles</a></dt> +<dt>\psshadowbox, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>\pstextpath, <a href="#pstricks-path">Typesetting text along a +path</a></dt> +<dt>\PSTtoEPS, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>\psverbboxfalse, <a href="#pstricks-boxes">Boxes</a></dt> +<dt>\psverbboxtrue, <a href="#pstricks-boxes">Boxes</a></dt> +<dt>\pswedge, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>\psxlabel, <a href="#pstricks-axes">Axes</a></dt> +<dt>\psylabel, <a href="#pstricks-axes">Axes</a></dt> +<dt>\pszigzag, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>\putoverlaybox, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>\qline, <a href="#pstricks-lines">Lines and polygons</a></dt> +<dt>\radians, <a href="#pstricks-dimensions">Dimensions, +coordinates and angles</a></dt> +<dt>\rcoor, <a href="#hackers">For hackers only</a></dt> +<dt>\rcurveto, <a href="#pretty-safe-tricks">Pretty safe +tricks</a></dt> +<dt>\readdata, <a href="#pstricks-plots">Plots</a></dt> +<dt>\rlineto, <a href="#pretty-safe-tricks">Pretty safe +tricks</a></dt> +<dt>\rnode, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\Rnode, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\RnodeRef, <a href="#pstricks-nodes">Nodes</a></dt> +<dt>\rotate, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\rotatedown, <a href="#pstricks-rotation">Rotation and scaling +boxes</a></dt> +<dt>\rotateleft, <a href="#pstricks-rotation">Rotation and scaling +boxes</a></dt> +<dt>\rotateright, <a href="#pstricks-rotation">Rotation and scaling +boxes</a></dt> +<dt>\rput, <a href="#placing">Placing and rotating +whatever</a></dt> +<dt>\savedata, <a href="#pstricks-plots">Plots</a></dt> +<dt>\scale, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\scalebox, <a href="#pstricks-rotation">Rotation and scaling +boxes</a></dt> +<dt>\scaleboxto, <a href="#pstricks-rotation">Rotation and scaling +boxes</a></dt> +<dt>\setcolor, <a href="#hackers">For hackers only</a></dt> +<dt>\SpecialCoor, <a href="#pstricks-coordinates">Special +coordinates</a></dt> +<dt>\stroke, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\swapaxes, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\TeXtoEPS, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>\translate, <a href="#safe-tricks">Safe tricks</a></dt> +<dt>\uput, <a href="#placing">Placing and rotating +whatever</a></dt></dl></dd> +<dt>parameter</dt> +<dd> +<dl> +<dt>angle, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>arcangle, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>arcsep, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>arcsepA, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>arcsepB, <a href="#pstricks-arcs">Arcs, circles and +ellipses</a></dt> +<dt>arm, <a href="#pstricks-connections">Node connections</a></dt> +<dt>arrowinset, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>arrowlength, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>arrows, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>arrowscale, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>arrowsize, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>axesstyle, <a href="#pstricks-axes">Axes</a></dt> +<dt>bbllx, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>bblly, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>bburx, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>bbury, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>border, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>bordercolor, <a href="#pstricks-line-styles">Line +styles</a></dt> +<dt>boxsep, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>bracketlength, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>coilheight, <a href="#pstricks-coils">Coils and +zigzags</a></dt> +<dt>coilinc, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>coilwidth, <a href="#pstricks-coils">Coils and zigzags</a></dt> +<dt>cornersize, <a href="#pstricks-lines">Lines and +polygons</a></dt> +<dt>curvature, <a href="#pstricks-curves">Curves</a></dt> +<dt>dash, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>dimen, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>dotangle, <a href="#pstricks-dots">Dots</a></dt> +<dt>dotscale, <a href="#pstricks-dots">Dots</a></dt> +<dt>dotsep, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>dotsize, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>dotstyle, <a href="#pstricks-dots">Dots</a></dt> +<dt>doublecolor, <a href="#pstricks-line-styles">Line +styles</a></dt> +<dt>doubleline, <a href="#pstricks-line-styles">Line +styles</a></dt> +<dt>doublesep, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>fillcolor, <a href="#pstricks-fill-styles">Fill styles</a></dt> +<dt>fillstyle, <a href="#pstricks-fill-styles">Fill styles</a></dt> +<dt>framearc, <a href="#pstricks-lines">Lines and polygons</a></dt> +<dt>framesep, <a href="#pstricks-framed">Framed boxes</a></dt> +<dt>gradangle, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>gradbegin, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>gradend, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>gradlines, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>gradmidpoint, <a href="#pstricks-overlays">Overlays</a></dt> +<dt>gridcolor, <a href="#pstricks-grids">Grids</a></dt> +<dt>griddots, <a href="#pstricks-grids">Grids</a></dt> +<dt>gridlabelcolor, <a href="#pstricks-grids">Grids</a></dt> +<dt>gridlabels, <a href="#pstricks-grids">Grids</a></dt> +<dt>gridwidth, <a href="#pstricks-grids">Grids</a></dt> +<dt>hatchangle, <a href="#pstricks-fill-styles">Fill +styles</a></dt> +<dt>hatchcolor, <a href="#pstricks-fill-styles">Fill +styles</a></dt> +<dt>hatchsep, <a href="#pstricks-fill-styles">Fill styles</a></dt> +<dt>hatchwidth, <a href="#pstricks-fill-styles">Fill +styles</a></dt> +<dt>headerfile, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>headers, <a href="#pstricks-exporting">Exporting EPS +files</a></dt> +<dt>labels, <a href="#pstricks-axes">Axes</a></dt> +<dt>labelsep, <a href="#placing">Placing and rotating +whatever</a></dt> +<dt>liftpen, <a href="#pstricks-graphics-objects">Graphics +objects</a></dt> +<dt>linearc, <a href="#pstricks-lines">Lines and polygons</a></dt> +<dt>linecolor, <a href="#pstricks-basic">Basic graphics +parameters</a></dt> +<dt>linestyle, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>linetype, <a href="#pstricks-parameters">Parameters</a></dt> +<dt>linewidth, <a href="#pstricks-basic">Basic graphics +parameters</a></dt> +<dt>loopsize, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>ncurv, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>nodesep, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>offset, <a href="#pstricks-connections">Node +connections</a></dt> +<dt>origin, <a href="#pstricks-coordinate">Coordinate +systems</a></dt> +<dt>plotpoints, <a href="#pstricks-plots">Plots</a></dt> +<dt>plotstyle, <a href="#pstricks-plots">Plots</a></dt> +<dt>rbracketlength, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>runit, <a href="#pstricks-dimensions">Dimensions, coordinates +and angles</a></dt> +<dt>shadow, <a href="#pstricks-line-styles">Line styles</a></dt> +<dt>shadowangle, <a href="#pstricks-line-styles">Line +styles</a></dt> +<dt>shadowcolor, <a href="#pstricks-line-styles">Line +styles</a></dt> +<dt>shadowsize, <a href="#pstricks-line-styles">Line +styles</a></dt> +<dt>showorigin, <a href="#pstricks-axes">Axes</a></dt> +<dt>showpoints, <a href="#pstricks-basic">Basic graphics +parameters</a></dt> +<dt>subgriddots, <a href="#pstricks-grids">Grids</a></dt> +<dt>subgridwidth, <a href="#pstricks-grids">Grids</a></dt> +<dt>swapaxes, <a href="#pstricks-coordinate">Coordinate +systems</a></dt> +<dt>tbarsize, <a href="#pstricks-arrowheads">Arrowheads and +such</a></dt> +<dt>ticks, <a href="#pstricks-axes">Axes</a></dt> +<dt>ticksize, <a href="#pstricks-axes">Axes</a></dt> +<dt>tickstyle, <a href="#pstricks-axes">Axes</a></dt> +<dt>unit, <a href="#pstricks-dimensions">Dimensions, coordinates +and angles</a></dt> +<dt>xunit, <a href="#pstricks-dimensions">Dimensions, coordinates +and angles</a></dt> +<dt>yunit, <a href="#pstricks-dimensions">Dimensions, coordinates +and angles</a></dt></dl></dd></dl></dd></dl></div> +<div class="indexdiv"> +<h3>Q</h3> +<dl> +<dt>quotation, <a href="#env-latex">Environments</a></dt> +<dt>quote, <a href="#env-latex">Environments</a></dt> +<dt>Quoted text with paragraph indentation, displaying, +<a href="#env-latex">Environments</a></dt> +<dt>Quoted text, displaying, +<a href="#env-latex">Environments</a></dt></dl></div> +<div class="indexdiv"> +<h3>R</h3> +<dl> +<dt>Ragged left text, <a href="#env-latex">Environments</a></dt> +<dt>Ragged left text, environment for, +<a href="#env-latex">Environments</a></dt> +<dt>Ragged right text, <a href="#env-latex">Environments</a></dt> +<dt>Ragged right text, environment for, +<a href="#env-latex">Environments</a></dt> +<dt>Relational Operators, <a href="#special-symbols">Special +Symbols</a></dt> +<dt>Remarks in the margin, <a href="#margin-notes">Margin +Notes</a></dt> +<dt>report class, <a href="#document-classes">Document +Classes</a></dt> +<dt>Reserved Characters, <a href="#special-characters">Special +Characters</a></dt> +<dt>Right-justifying text, +<a href="#env-latex">Environments</a></dt> +<dt>Right-justifying text, environment for, +<a href="#env-latex">Environments</a></dt></dl></div> +<div class="indexdiv"> +<h3>S</h3> +<dl> +<dt>Sectioning, <a href="#sectioning">Sectioning</a></dt> +<dt>Several Small Packages, <a href="#small-packages">Several Small +Packages</a></dt> +<dt>Simulating typed text, +<a href="#env-latex">Environments</a></dt> +<dt>Sizes of text, <a href="#typefaces">Typefaces</a></dt> +<dt>Small Packages, <a href="#small-packages">Several Small +Packages</a></dt> +<dt>Space, inserting vertical, <a href="#spaces-and-boxes">Spaces +& Boxes</a></dt> +<dt>Spaces, <a href="#spaces-and-boxes">Spaces & Boxes</a></dt> +<dt>Spacing, within Math mode, <a href="#math-formulae">Math +Formulae</a></dt> +<dt>Special Characters, <a href="#special-characters">Special +Characters</a></dt> +<dt>Splitting the input file, +<a href="#splitting-the-input">Splitting the Input</a></dt> +<dt>Starting & Ending, <a href="#starting-and-ending">Starting +& Ending</a></dt> +<dt>Starting on a right-hand page, +<a href="#line-and-page-breaking">Line & Page Breaking</a></dt> +<dt>Styles of text, <a href="#typefaces">Typefaces</a></dt> +<dt>Styles, page, <a href="#page-styles">Page Styles</a></dt> +<dt>Subscript, <a href="#math-formulae">Math Formulae</a></dt> +<dt>Superscript, <a href="#math-formulae">Math Formulae</a></dt> +<dt>Symbols, <a href="#math-formulae">Math Formulae</a></dt> +<dd> +<dl> +<dt>Miscellaneous, <a href="#special-symbols">Special +Symbols</a></dt> +<dt>Special, <a href="#special-symbols">Special +Symbols</a></dt></dl></dd></dl></div> +<div class="indexdiv"> +<h3>T</h3> +<dl> +<dt>Tab stops, using, <a href="#env-latex">Environments</a></dt> +<dt>tabbing, <a href="#env-latex">Environments</a></dt> +<dt>table, <a href="#env-latex">Environments</a></dt> +<dt>Table of Contents, creating, <a href="#table-of-contents">Table +of Contents</a></dt> +<dt>Tables, creating, <a href="#env-latex">Environments</a></dt> +<dt>tabular, <a href="#env-latex">Environments</a></dt> +<dt>Terminal Input/Output, +<a href="#terminal-input-slash-output">Terminal +Input/Output</a></dt> +<dt>Texinfo, <a href="#texinfo">Texinfo (tbd.)</a></dt> +<dt>Thanks, for titlepage, <a href="#page-styles">Page +Styles</a></dt> +<dt>thebibliography, <a href="#env-latex">Environments</a></dt> +<dt>theorem, <a href="#env-latex">Environments</a></dt> +<dt>Theorems, defining, <a href="#definitions">Definitions</a></dt> +<dt>Theorems, typesetting, +<a href="#env-latex">Environments</a></dt> +<dt>Title making, <a href="#page-styles">Page Styles</a></dt> +<dt>Title pages, creating, +<a href="#env-latex">Environments</a></dt> +<dt>Title, for titlepage, <a href="#page-styles">Page +Styles</a></dt> +<dt>titlepage, <a href="#env-latex">Environments</a></dt> +<dt>Typed text, simulating, +<a href="#env-latex">Environments</a></dt> +<dt>Typeface Sizes, <a href="#typefaces">Typefaces</a></dt> +<dt>Typeface Styles, <a href="#typefaces">Typefaces</a></dt> +<dt>Typefaces, <a href="#typefaces">Typefaces</a></dt></dl></div> +<div class="indexdiv"> +<h3>U</h3> +<dl> +<dt>url, <a href="#url-package">url</a></dt> +<dt>Using BibTeX, +<a href="#env-latex">Environments</a></dt></dl></div> +<div class="indexdiv"> +<h3>V</h3> +<dl> +<dt>Variables, a list of, <a href="#counters">Counters</a></dt> +<dt>varioref, <a href="#varioref">varioref</a></dt> +<dt>verbatim, <a href="#env-latex">Environments</a></dt> +<dt>Verbatim text, <a href="#env-latex">Environments</a></dt> +<dt>verse, <a href="#env-latex">Environments</a></dt> +<dt>Vertical space, inserting, <a href="#spaces-and-boxes">Spaces +& Boxes</a></dt></dl></div> +<div class="indexdiv"> +<h3>X</h3> +<dl> +<dt>xindy, <a href="#xindy">xindy</a></dt> +<dd> +<dl> +<dt>Command List, <a href="#xindy-command-list">Command +List</a></dt> +<dd> +<dl> +<dt>Markup Commands, <a href="#xindy-command-list-markup">Markup +Commands</a></dt> +<dt>Raw Index Interface, +<a href="#xindy-command-list-raw-index">Raw Index +Interface</a></dt></dl></dd> +<dt>Invoking, <a href="#xindy-invoking">Invoking xindy</a></dt> +<dd> +<dl> +<dt>Command Line Options, <a href="#xindy-invoking-cmdline">Command +Line Options</a></dt> +<dt>Search Path, <a href="#xindy-search-path">Search +Path</a></dt></dl></dd> +<dt>Processing Commands, +<a href="#xindy-command-list-processing">Processing +Commands</a></dt> +<dd> +<dl> +<dt>define-alphabet, +<a href="#xindy-command-list-processing-define-alphabet">define-alphabet</a></dt> +<dt>define-attributes, +<a href="#xindy-command-list-processing-define-attributes">define-attributes</a></dt> +<dt>define-crossref-class, +<a href="#xindy-command-list-processing-define-crossref-class">define-crossref-class</a></dt> +<dt>define-letter-group, +<a href="#xindy-command-list-processing-define-letter-group">define-letter-group</a></dt> +<dt>define-location-class, +<a href="#xindy-command-list-processing-define-location-class">define-location-class</a></dt> +<dt>define-location-class-order, +<a href="#xindy-command-list-processing-define-location-class-order"> +define-location-class-order</a></dt> +<dt>define-rule-set, +<a href="#xindy-command-list-processing-define-rule-set">define-rule-set</a></dt> +<dt>define-sort-rule-orientations, +<a href="#xindy-command-list-processing-define-sort-rule-orientations"> +define-sort-rule-orientations</a></dt> +<dt>merge-rule, +<a href="#xindy-command-list-processing-merge-rule">merge-rule</a></dt> +<dt>merge-to, +<a href="#xindy-command-list-processing-merge-to">merge-to</a></dt> +<dt>require, +<a href="#xindy-command-list-processing-require">require</a></dt> +<dt>searchpath, +<a href="#xindy-command-list-processing-searchpath">searchpath</a></dt> +<dt>sort-rule, +<a href="#xindy-command-list-processing-sort-rule">sort-rule</a></dt> +<dt>use-rule-set, +<a href="#xindy-command-list-processing-use-rule-set">use-rule-set</a></dt></dl></dd></dl></dd></dl></div></div></div></div></div> +</body> +</html> |