diff options
author | Karl Berry <karl@freefriends.org> | 2025-02-15 21:35:09 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2025-02-15 21:35:09 +0000 |
commit | c40f9daee255490732b342d15fba38fb94c92c59 (patch) | |
tree | 2ae9e8baf02c14586a9fd78f6f8ccec0aeecefa4 /Master | |
parent | 068530fa8de8734798c6b4905c569f38491cf07f (diff) |
rm tex-refs, removed on CTAN
git-svn-id: svn://tug.org/texlive/trunk@74022 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/README | 5 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/tex-refs-0.4.1.tar.bz2 | bin | 118180 -> 0 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.epub | bin | 167393 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/tex-refs.html | 18237 | ||||
-rw-r--r-- | Master/texmf-dist/doc/generic/tex-refs/tex-refs.txt | 8776 | ||||
-rwxr-xr-x | Master/tlpkg/bin/tlpkg-ctan-check | 2 | ||||
-rwxr-xr-x | Master/tlpkg/libexec/ctan2tds | 1 | ||||
-rw-r--r-- | Master/tlpkg/tlpsrc/collection-langenglish.tlpsrc | 1 | ||||
-rw-r--r-- | Master/tlpkg/tlpsrc/scheme-tetex.tlpsrc | 1 | ||||
-rw-r--r-- | Master/tlpkg/tlpsrc/tex-refs.tlpsrc | 1 |
11 files changed, 2 insertions, 27146 deletions
diff --git a/Master/texmf-dist/doc/generic/tex-refs/README b/Master/texmf-dist/doc/generic/tex-refs/README deleted file mode 100644 index 1bc45bec74a..00000000000 --- a/Master/texmf-dist/doc/generic/tex-refs/README +++ /dev/null @@ -1,5 +0,0 @@ -The tex-refs project has the aim of providing a help file for LaTeX (and -its friends like ConTeXt, Metapost, Metafont, etc.) using DocBook/XML. -It is released under the GFDL. - -The home page is http://www.miwie.org/tex-refs. diff --git a/Master/texmf-dist/doc/generic/tex-refs/tex-refs-0.4.1.tar.bz2 b/Master/texmf-dist/doc/generic/tex-refs/tex-refs-0.4.1.tar.bz2 Binary files differdeleted file mode 100644 index d2dd8c5eea2..00000000000 --- a/Master/texmf-dist/doc/generic/tex-refs/tex-refs-0.4.1.tar.bz2 +++ /dev/null diff --git a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.css b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.css deleted file mode 100644 index c4d1e1bdc53..00000000000 --- a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.css +++ /dev/null @@ -1,124 +0,0 @@ -/* $Id: tex-refs.css 120 2004-03-26 20:19:43Z mw $ */ - -body { background-color: whitesmoke; - } - -h1.title { background-color: gainsboro; - text-align: center; - font-family: sans-serif; - color: black; - } - -h2.title { background-color: gainsboro; - font-family: sans-serif; - color: black; - } - -h3.title { background-color: gainsboro; - font-family: sans-serif; - color: black; - } - -h4.title { background-color: gainsboro; - font-family: sans-serif; - color: black; - } -h5.title { background-color: gainsboro; - font-family: sans-serif; -/* font-size: small; */ - color: black; - } -h6.title { background-color: gainsboro; - font-family: sans-serif; -/* font-size: x-small; */ - font-size: small; - color: black; - } -span.title { background-color: gainsboro; - font-family: sans-serif; -/* font-size: x-small; */ - font-size: small; - color: black; - } - -.title { background-color: gainsboro; - font-family: sans-serif; - } - -.authorgroup { - background-color: #EEEEEE - } - -.copyright { - } - -.legalnotice { - } - -.revhistory { - } - -.abstract { - margin-top: 1em - } - -.toc { - } - -.itemizedlist { - } - -.orderedlist { - } - -.variablelist { - } - -.term { background-color: #EFEFEF - } - -pre.programlisting -{ - background-color: #E0E0E0; - border: thin solid gray; - margin-top: 1.33ex; - margin-bottom: 1.33ex; -} - - -.footer-date { font-size: xx-small; - font-family: monospace; - } - - -#customheader, #customfooter -{ - /* list of fonts provides fallbacks if a font is not present */ - font-family: Verdana, Arial, Helvetica, Sans-Serif; - /* font size, relative to body font size */ - font-size: 80%; - - /* line height, relative to body font size */ - line-height: 200%; - - text-align: center; - vertical-align: middle; - color: #fff; - background-color: #009; -} - -/* leave more space between last paragraph and footer */ -/* some browser do not add up the bottom margin of the prior element */ -/* and the top margin of the footer */ -#customfooter { - margin-top: 15px; -} - -/* define special font for logo */ -/* list of fonts provides fallbacks in case selected fonts are not present -*/ -.logo -{ - font-family: Lucida Console, Verdana, Arial, Sans-Serif; -} - diff --git a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.epub b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.epub Binary files differdeleted file mode 100644 index 1700fe76a06..00000000000 --- a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.epub +++ /dev/null diff --git a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.html b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.html deleted file mode 100644 index 4d62e45786a..00000000000 --- a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.html +++ /dev/null @@ -1,18237 +0,0 @@ -<!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 name="generator" content= -"HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" /> -<meta http-equiv="Content-Type" content= -"text/html; charset=us-ascii" /> -<title>References for TeX and Friends</title> -<link rel="stylesheet" type="text/css" href="tex-refs.css" /> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /> -</head> -<body> -<div xml:lang="en" class="book" title= -"References for TeX and Friends" lang="en"> -<div class="titlepage"> -<div> -<div> -<h1 class="title"><a id="idp425680" name="idp425680"></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><code class="email"><<a class="email" href= -"mailto:mw%20at%20miwie%20dot%20in-berlin%20dot%20de">mw at miwie dot in-berlin dot de</a>></code></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 - 2012 Michael -Wiedmann</p> -</div> -<div> -<div class="legalnotice" title="License"><a id="idp270624" name= -"idp270624"></a> -<p class="legalnotice-title"><strong>License</strong></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.4.1</td> -<td align="left">2012-12-03</td> -</tr> -<tr> -<td align="left" colspan="2">Removed obsolete file still referenced -in Makefile (no visible changes)</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 class="ulink" -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 class="ulink" 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><strong>Table of Contents</strong></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 <code class= -"filename">amsmath</code></a></span></dt> -<dt><span class="section"><a href="#dcolumn">3.2 <code class= -"filename">dcolumn</code></a></span></dt> -<dt><span class="section"><a href="#float">3.3 <code class= -"filename">float</code></a></span></dt> -<dt><span class="section"><a href="#fontenc">3.4 <code class= -"filename">fontenc</code></a></span></dt> -<dt><span class="section"><a href="#german">3.5 <code class= -"filename">german</code></a></span></dt> -<dt><span class="section"><a href="#graphics">3.6 <code class= -"filename">graphics</code></a></span></dt> -<dt><span class="section"><a href="#hyperref">3.7 <code class= -"filename">hyperref</code></a></span></dt> -<dt><span class="section"><a href="#inputenc">3.8 <code class= -"filename">inputenc</code></a></span></dt> -<dt><span class="section"><a href="#komascript">3.9 <code class= -"filename">KOMA-Script</code></a></span></dt> -<dt><span class="section"><a href="#mathpazo">3.10 <code class= -"filename">mathpazo</code></a></span></dt> -<dt><span class="section"><a href="#varioref">3.11 <code class= -"filename">varioref</code></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 <code class= -"filename">fontinst</code> (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 <code class= -"filename">--file-line-error-style</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-fmt">1.2 -<code class="filename">--fmt format</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-help">1.3 -<code class="filename">--help</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-ini">1.4 -<code class="filename">--ini</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-interaction-mode">1.5 <code class= -"filename">--interaction mode</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-ipc">1.6 -<code class="filename">--ipc</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-ipc-start">1.7 -<code class="filename">--ipc-start</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-jobname-name">1.8 -<code class="filename">--jobname name</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-kpathsea-debug">1.9 <code class= -"filename">--kpathsea-debug bitmask</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-maketex">1.10 -<code class="filename">--maketex fmt</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-no-maketex">1.11 -<code class="filename">--no-maketex fmt</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-output-comment">1.12 <code class= -"filename">--output-comment string</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-parse-first-line">1.13 <code class= -"filename">--parse-first-line</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-progname">1.14 -<code class="filename">--progname name</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-recorder">1.15 -<code class="filename">--recorder</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-shell-escape">1.16 <code class= -"filename">--shell-escape</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-translate-file">1.17 <code class= -"filename">--translate-file tcxname</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-version">1.18 -<code class="filename">--version</code></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 <code class= -"filename">--file-line-error-style</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-help">1.2 -<code class="filename">--help</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-ini">1.3 -<code class="filename">--ini</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-intercation">1.4 <code class= -"filename">--interaction mode</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-jobname">1.5 -<code class="filename">--jobname name</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-kpathsea-debug">1.6 <code class= -"filename">--kpathsea-debug bitmask</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-mem">1.7 -<code class="filename">--mem mem</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-parse-first-line">1.8 <code class= -"filename">--parse-first-line</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-progname">1.9 -<code class="filename">--progname name</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-recorder">1.10 -<code class="filename">--recorder</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-T">1.11 -<code class="filename">-T</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-translate-file">1.12 <code class= -"filename">--translate-file tcxname</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-troff">1.13 -<code class="filename">--troff</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-version">1.14 -<code class="filename">--version</code></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 -<code class="filename">@STRING</code> 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 -<code class="filename">ABBRV.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-alpha">4.2 -<code class="filename">ALPHA.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-plain">4.3 -<code class="filename">PLAIN.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-sample">4.4 -<code class="filename">SAMPLE.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-unsrt">4.5 -<code class="filename">UNSRT.BST</code></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 -<code class="filename">-c</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-g">1.2 -<code class="filename">-g</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-i">1.3 -<code class="filename">-i</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-l">1.4 -<code class="filename">-l</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-q">1.5 -<code class="filename">-q</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-r">1.6 -<code class="filename">-r</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-s-sty">1.7 -<code class="filename">-s sty</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-o-ind">1.8 -<code class="filename">-o ind</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-t-log">1.9 -<code class="filename">-t log</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-p-no">1.10 -<code class="filename">-p no</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-L">1.11 -<code class="filename">-L</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-T">1.12 -<code class="filename">-T</code></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><strong>List of Tables</strong></p> -<dl> -<dt>1.1 <a href="#table-newcommand">Options for <code class= -"literal">\newcommand</code></a></dt> -<dt>1.2 <a href="#table-newenvironment">Options for <code class= -"literal">\newenvironment</code></a></dt> -<dt>1.3 <a href="#table-newtheorem">Options for <code class= -"literal">\newtheorem</code></a></dt> -<dt>1.4 <a href="#table-tabbing">Commands in a <code class= -"literal">tabbing</code> environment</a></dt> -<dt>1.5 <a href="#table-tabular">Commands used inside a -<code class="literal">tabular</code> environment</a></dt> -<dt>1.6 <a href="#table-standard-styles">Standard styles -distributed with BibTeX</a></dt> -<dt>1.7 <a href="#table-math-mode">Three environments that put -LaTeX in math mode</a></dt> -<dt>1.8 <a href="#table-math-miscellany">Math Miscellany</a></dt> -<dt>1.9 <a href="#table-typefaces">Typefaces</a></dt> -<dt>1.10 <a href="#table-standard-type-size-commands">Standard type -size commands</a></dt> -<dt>1.11 <a href="#table-low-level-font-commands">Low-level font -commands</a></dt> -<dt>1.12 <a href="#table-special-coordinates">Special coordinates -and angles</a></dt> -</dl> -</div> -<div class="preface" title="Preface"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="preface" name="preface"></a>Preface</h2> -</div> -</div> -</div> -<p>LaTeX2e is a document preparation system implemented as a macro -package for Donald E. Knuth's TeX typesetting program.</p> -<p>LaTeX was originally conceived by Leslie Lamport.</p> -<p>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><a class="ulink" href="http://www.tug.org" target="_top">TUG -(TeX User Group)</a> and <a class="ulink" 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>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>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" title="Credits"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="credits" name="credits"></a>Credits</h2> -</div> -</div> -</div> -<a id="idp250720" class="indexterm" name="idp250720"></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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"> -<p class="simpara">Karl Berry</p> -<a id="idp245776" class="indexterm" name="idp245776"></a></li> -<li class="listitem"> -<p class="simpara">Wolfgang Borgert</p> -<a id="idp248064" class="indexterm" name="idp248064"></a></li> -<li class="listitem"> -<p class="simpara">Ramon Casellas</p> -<a id="idp294304" class="indexterm" name="idp294304"></a></li> -<li class="listitem"> -<p class="simpara">Holger Danielsson</p> -<a id="idp296592" class="indexterm" name="idp296592"></a></li> -<li class="listitem"> -<p class="simpara">James Devenish</p> -<a id="idp298880" class="indexterm" name="idp298880"></a></li> -<li class="listitem"> -<p class="simpara">Hubert Gaesslein</p> -<a id="idp301168" class="indexterm" name="idp301168"></a></li> -<li class="listitem"> -<p class="simpara">Peter Karp</p> -<a id="idp303456" class="indexterm" name="idp303456"></a></li> -<li class="listitem"> -<p class="simpara">Rolf Niepraschk</p> -<a id="idp305744" class="indexterm" name="idp305744"></a></li> -<li class="listitem"> -<p class="simpara">Hans Fredrik Nordhaug</p> -<a id="idp308032" class="indexterm" name="idp308032"></a></li> -<li class="listitem"> -<p class="simpara">Simon Pepping</p> -<a id="idp2040400" class="indexterm" name="idp2040400"></a></li> -<li class="listitem"> -<p class="simpara">Bob Stayton</p> -<a id="idp2042688" class="indexterm" name="idp2042688"></a></li> -<li class="listitem"> -<p class="simpara">Herbert Voss</p> -<a id="idp2044976" class="indexterm" name="idp2044976"></a></li> -</ul> -</div> -</div> -<div xml:lang="en" class="chapter" title="Chapter 1. TeX" -lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="tex" name= -"tex"></a>Chapter 1. TeX</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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 <code class= -"filename">amsmath</code></a></span></dt> -<dt><span class="section"><a href="#dcolumn">3.2 <code class= -"filename">dcolumn</code></a></span></dt> -<dt><span class="section"><a href="#float">3.3 <code class= -"filename">float</code></a></span></dt> -<dt><span class="section"><a href="#fontenc">3.4 <code class= -"filename">fontenc</code></a></span></dt> -<dt><span class="section"><a href="#german">3.5 <code class= -"filename">german</code></a></span></dt> -<dt><span class="section"><a href="#graphics">3.6 <code class= -"filename">graphics</code></a></span></dt> -<dt><span class="section"><a href="#hyperref">3.7 <code class= -"filename">hyperref</code></a></span></dt> -<dt><span class="section"><a href="#inputenc">3.8 <code class= -"filename">inputenc</code></a></span></dt> -<dt><span class="section"><a href="#komascript">3.9 <code class= -"filename">KOMA-Script</code></a></span></dt> -<dt><span class="section"><a href="#mathpazo">3.10 <code class= -"filename">mathpazo</code></a></span></dt> -<dt><span class="section"><a href="#varioref">3.11 <code class= -"filename">varioref</code></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 <code class= -"filename">fontinst</code> (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" title="1 PlainTeX"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="plaintex" name= -"plaintex"></a>1 PlainTeX</h2> -</div> -</div> -</div> -<a id="idp2050448" class="indexterm" name="idp2050448"></a> -<div class="section" title="1.1 Overview"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="plaintex-ovw" name="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="idp2053504" class="indexterm" -name="idp2053504"></a> <a class="ulink" 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" title="2 LaTeX"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="latex" name= -"latex"></a>2 LaTeX</h2> -</div> -</div> -</div> -<div class="note" title="Note" style= -"margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Note</h3> -<p>The original file <code class="filename">latex2e.texi</code> -contains the following copyright and permission notice:</p> -<p><span class="quote">“<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>”</span></p> -<p><span class="quote">“<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>”</span></p> -</div> -<div class="section" title="2.1 Options"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="opt-latex" name="opt-latex"></a>2.1 -Options</h3> -</div> -</div> -</div> -<a id="idp6690976" class="indexterm" name="idp6690976"></a> -<p>LaTeX understands the following command line options.</p> -<div class="section" title="2.1.1 -file-line-error-style"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-file-line-error-style" name= -"opt-latex-file-line-error-style"></a>2.1.1 <code class= -"filename">-file-line-error-style</code></h4> -</div> -</div> -</div> -<a id="idp6694720" class="indexterm" name="idp6694720"></a> -<p>Print error messages in the form <code class= -"literal">file:line:error</code>.</p> -</div> -<div class="section" title="2.1.2 -fmt=FMTNAME"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-fmt" name= -"opt-latex-fmt"></a>2.1.2 <code class= -"filename">-fmt=FMTNAME</code></h4> -</div> -</div> -</div> -<a id="idp6699120" class="indexterm" name="idp6699120"></a> -<p>Use <code class="literal">FMTMAME</code> instead of program name -or a %& line.</p> -</div> -<div class="section" title="2.1.3 -ini"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-ini" name= -"opt-latex-ini"></a>2.1.3 <code class="filename">-ini</code></h4> -</div> -</div> -</div> -<a id="idp6703520" class="indexterm" name="idp6703520"></a> -<p>Be <span class="command"><strong>initex</strong></span>, for -dumping formats; this is implicitly true if the program is called -as <span class="command"><strong>initex</strong></span>.</p> -</div> -<div class="section" title="2.1.4 -interaction=STRING"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-interaction-mode" name= -"opt-latex-interaction-mode"></a>2.1.4 <code class= -"filename">-interaction=STRING</code></h4> -</div> -</div> -</div> -<a id="idp6708544" class="indexterm" name="idp6708544"></a> -<p>Set interaction mode (<code class= -"literal">STRING=batchmode/nonstopmode/scrollmode/errorstopmode</code>).</p> -</div> -<div class="section" title="2.1.5 -ipc"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-ipc" name= -"opt-latex-ipc"></a>2.1.5 <code class="filename">-ipc</code></h4> -</div> -</div> -</div> -<a id="idp6712944" class="indexterm" name="idp6712944"></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" title="2.1.6 -ipc-start"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-ipc-start" name= -"opt-latex-ipc-start"></a>2.1.6 <code class= -"filename">-ipc-start</code></h4> -</div> -</div> -</div> -<a id="idp6717104" class="indexterm" name="idp6717104"></a> -<p>As <code class="literal">-ipc</code>, and also start the server -at the other end.</p> -<p>Note: not available on all systems.</p> -</div> -<div class="section" title="2.1.7 -jobname=STRING"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-jobname-name" name= -"opt-latex-jobname-name"></a>2.1.7 <code class= -"filename">-jobname=STRING</code></h4> -</div> -</div> -</div> -<a id="idp6721888" class="indexterm" name="idp6721888"></a> -<p>Set the job name to <code class="literal">STRING</code>.</p> -</div> -<div class="section" title="2.1.8 -kpathsea-debug=NUMBER"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-kpathsea-debug" name= -"opt-latex-kpathsea-debug"></a>2.1.8 <code class= -"filename">-kpathsea-debug=NUMBER</code></h4> -</div> -</div> -</div> -<a id="idp6726288" class="indexterm" name="idp6726288"></a> -<p>Sets path searching debugging flags according to the bits of -<code class="literal">NUMBER</code>.</p> -</div> -<div class="section" title="2.1.9 [-no]-maketex=FMT"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-no-maketex" name= -"opt-latex-no-maketex"></a>2.1.9 <code class= -"filename">[-no]-maketex=FMT</code></h4> -</div> -</div> -</div> -<a id="idp6730688" class="indexterm" name="idp6730688"></a> -<p>Disable/enable <span class= -"command"><strong>mktexFMT</strong></span> generation -(FMT=tex/tfm).</p> -</div> -<div class="section" title="2.1.10 -mltex"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-mltex" name= -"opt-latex-mltex"></a>2.1.10 <code class= -"filename">-mltex</code></h4> -</div> -</div> -</div> -<a id="idp6735088" class="indexterm" name="idp6735088"></a> -<p>Enable MLTeX extensions such as <code class= -"literal">\charsubdef</code>.</p> -</div> -<div class="section" title="2.1.11 -output-comment=STRING"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-output-comment" name= -"opt-latex-output-comment"></a>2.1.11 <code class= -"filename">-output-comment=STRING</code></h4> -</div> -</div> -</div> -<a id="idp6739488" class="indexterm" name="idp6739488"></a> -<p>use <code class="literal">STRING</code> for DVI file comment -instead of date.</p> -</div> -<div class="section" title="2.1.12 -parse-first-line"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-parse-first-line" name= -"opt-latex-parse-first-line"></a>2.1.12 <code class= -"filename">-parse-first-line</code></h4> -</div> -</div> -</div> -<a id="idp6743888" class="indexterm" name="idp6743888"></a> -<p>Parse of the first line of the input file.</p> -</div> -<div class="section" title="2.1.13 -progname=STRING"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-progname" name= -"opt-latex-progname"></a>2.1.13 <code class= -"filename">-progname=STRING</code></h4> -</div> -</div> -</div> -<a id="idp6747664" class="indexterm" name="idp6747664"></a> -<p>Set program (and fmt) name to <code class= -"literal">STRING</code>.</p> -</div> -<div class="section" title="2.1.14 -recorder"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-recorder" name= -"opt-latex-recorder"></a>2.1.14 <code class= -"filename">-recorder</code></h4> -</div> -</div> -</div> -<a id="idp6752064" class="indexterm" name="idp6752064"></a> -<p>Enable filename recorder.</p> -</div> -<div class="section" title="2.1.15 -shell-escape"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-shell-escape" name= -"opt-latex-shell-escape"></a>2.1.15 <code class= -"filename">-shell-escape</code></h4> -</div> -</div> -</div> -<a id="idp6755840" class="indexterm" name="idp6755840"></a> -<p>Enable <code class="literal">\write18{SHELL COMMAND}</code>.</p> -</div> -<div class="section" title="2.1.16 -src-specials"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-src-specials" name= -"opt-latex-src-specials"></a>2.1.16 <code class= -"filename">-src-specials</code></h4> -</div> -</div> -</div> -<a id="idp6760240" class="indexterm" name="idp6760240"></a> -<p>Insert source specials into the DVI file.</p> -</div> -<div class="section" title="2.1.17 -src-specials=WHERE"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-src-specials-where" name= -"opt-latex-src-specials-where"></a>2.1.17 <code class= -"filename">-src-specials=WHERE</code></h4> -</div> -</div> -</div> -<a id="idp6764016" class="indexterm" name="idp6764016"></a> -<p>Insert source specials in certain places of the DVI file. -<code class="literal">WHERE</code> is a comma-separated value list: -<code class="literal">cr display hbox math par parend -vbox</code>.</p> -</div> -<div class="section" title="2.1.18 -translate-file=TCXNAME"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-translate-file-tcxname" name= -"opt-latex-translate-file-tcxname"></a>2.1.18 <code class= -"filename">-translate-file=TCXNAME</code></h4> -</div> -</div> -</div> -<a id="idp6769040" class="indexterm" name="idp6769040"></a> -<p>Use the <code class="literal">TCX</code> file <code class= -"literal">TCXNAME</code>.</p> -</div> -<div class="section" title="2.1.19 -help"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-help" name= -"opt-latex-help"></a>2.1.19 <code class= -"filename">-help</code></h4> -</div> -</div> -</div> -<a id="idp6774064" class="indexterm" name="idp6774064"></a> -<p>Display this help and exit.</p> -</div> -<div class="section" title="2.1.20 -version"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="opt-latex-version" name= -"opt-latex-version"></a>2.1.20 <code class= -"filename">-version</code></h4> -</div> -</div> -</div> -<a id="idp6777840" class="indexterm" name="idp6777840"></a> -<p>Output version information and exit.</p> -</div> -</div> -<div class="section" title="2.2 Overview of LaTeX and Local Guide"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="overview" name="overview"></a>2.2 Overview -of LaTeX and Local Guide</h3> -</div> -</div> -</div> -<a id="idp6781760" class="indexterm" name="idp6781760"></a><a id= -"idp6782512" class="indexterm" name="idp6782512"></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 class="orderedlist" type="1"> -<li class="listitem"> -<p>A <span class="emphasis"><em>Device Independent</em></span>, or -<code class="filename">.dvi</code> 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 <code class="literal">xdvi</code>, which actually uses the -<code class="filename">.dvi</code> file.</p> -</li> -<li class="listitem"> -<p>A <span class="emphasis"><em>transcript</em></span> or -<code class="filename">.log</code> file that contains summary -information and diagnostic messages for any errors discovered in -the input file.</p> -</li> -<li class="listitem"> -<p>An <span class="emphasis"><em>auxiliary</em></span> or -<code class="filename">.aux</code> 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 -<em class="citetitle">The TeXbook</em> 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><em class="citetitle">LaTeX: A Document Preparation System</em>, -by Leslie Lamport,<a id="idp6796768" class="indexterm" name= -"idp6796768"></a> Addison-Wesley Publishing Company, 2nd edition, -1994.</p> -<p><em class="citetitle">The LaTeX Companion</em>, by Michel -Goossens,<a id="idp6798800" class="indexterm" name= -"idp6798800"></a> Frank Mittelbach, <a id="idp6799808" class= -"indexterm" name="idp6799808"></a> and Alexander Samarin,<a id= -"idp6800816" class="indexterm" name="idp6800816"></a> -Addison-Wesley, 1994.</p> -</div> -<div class="section" title="2.3 Commands"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="commands" name="commands"></a>2.3 -Commands</h3> -</div> -</div> -</div> -<p>A LaTeX command begins with the command name, which consists of -a <code class="literal">\</code> followed by either (a) a string of -letters or (b) a single non-letter. Arguments contained in square -brackets, <code class="literal">[]</code>, are optional while -arguments contained in braces, <code class="literal">{}</code>, 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" title="2.3.1 Counters"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="counters" name="counters"></a>2.3.1 -Counters</h4> -</div> -</div> -</div> -<a id="idp6807984" class="indexterm" name="idp6807984"></a><a id= -"idp6808736" class="indexterm" name="idp6808736"></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 -<code class="literal">\</code> (<code class="literal">enumi</code> -- <code class="literal">enumiv</code> 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" name= -"cmd-addtocounter"></a><code class= -"literal">\addtocounter</code></h5> -<a id="idp6814944" class="indexterm" name="idp6814944"></a> -<p>The <code class="literal">\addtocounter</code> command -increments the <code class="literal">counter</code> by the amount -specified by the <code class="literal">value</code> argument. The -<code class="literal">value</code> argument can be negative.</p> -<h5 class="title"><a id="cmd-alph-title" name= -"cmd-alph-title"></a><code class= -"literal">\alph{counter}</code></h5> -<a id="idp6819808" class="indexterm" name="idp6819808"></a><a id= -"idp6820560" class="indexterm" name="idp6820560"></a> -<p>This command causes the value of the <code class= -"literal">counter</code> to be printed in alphabetic characters. -The <code class="literal">\alph</code> command uses lower case -alphabetic alphabetic characters, i.e., <code class="literal">a, b, -c...</code> while the <code class="literal">\Alph</code> command -uses upper case alphabetic characters, i.e., <code class= -"literal">A, B, C...</code>.</p> -<h5 class="title"><a id="cmd-arabic-title" name= -"cmd-arabic-title"></a><code class= -"literal">\arabic{counter}</code></h5> -<a id="idp6826048" class="indexterm" name="idp6826048"></a> -<p>The <code class="literal">\arabic</code> command causes the -value of the <code class="literal">counter</code> to be printed in -Arabic numbers, i.e., <code class="literal">3</code>.</p> -<h5 class="title"><a id="cmd-fnsymbol-title" name= -"cmd-fnsymbol-title"></a><code class= -"literal">\fnsymbol{counter}</code></h5> -<a id="idp6830288" class="indexterm" name="idp6830288"></a> -<p>The <code class="literal">\fnsymbol</code> command causes the -value of the <code class="literal">counter</code> to be printed in -a specific sequence of nine symbols that can be used for numbering -footnotes.</p> -<p>NB. <code class="literal">counter</code> must have a value -between 1 and 9 inclusive.</p> -<h5 class="title"><a id="cmd-newcounter-title" name= -"cmd-newcounter-title"></a><code class= -"literal">\newcounter{foo}[counter]</code></h5> -<a id="idp6835040" class="indexterm" name="idp6835040"></a><a id= -"idp6835792" class="indexterm" name="idp6835792"></a> -<p>The <code class="literal">\newcounter</code> command defines a -new counter named <code class="literal">foo</code>. The counter is -initialized to zero.</p> -<p>The optional argument <code class="literal">[counter]</code> -causes the counter <code class="literal">foo</code> to be reset -whenever the counter named in the optional argument is -incremented.</p> -<h5 class="title"><a id="cmd-refstepcounter-title" name= -"cmd-refstepcounter-title"></a><code class= -"literal">\refstepcounter{counter}</code></h5> -<a id="idp6841152" class="indexterm" name="idp6841152"></a> -<p>The <code class="literal">\refstepcounter</code> command works -like <code class="literal">\stepcounter</code>. See <a class="link" -href="#cmd-stepcounter-title" title= -"2.3.1. \stepcounter{counter}">\stepcounter</a>, except it -also defines the current <code class="literal">\ref</code> value to -be the result of <code class="literal">\thecounter</code>.</p> -<h5 class="title"><a id="cmd-roman-title" name= -"cmd-roman-title"></a><code class= -"literal">\roman{counter}</code></h5> -<a id="idp6858944" class="indexterm" name="idp6858944"></a><a id= -"idp6859696" class="indexterm" name="idp6859696"></a> -<p>This command causes the value of the <code class= -"literal">counter</code> to be printed in Roman numerals. The -<code class="literal">\roman</code> command uses lower case Roman -numerals, i.e., <code class="literal">i, ii, iii...</code>, while -the <code class="literal">\Roman</code> command uses upper case -Roman numerals, i.e., <code class="literal">I, II, -III...</code>.</p> -<h5 class="title"><a id="cmd-stepcounter-title" name= -"cmd-stepcounter-title"></a><code class= -"literal">\stepcounter{counter}</code></h5> -<a id="idp6865184" class="indexterm" name="idp6865184"></a> -<p>The <code class="literal">\stepcounter</code> command adds one -to the <code class="literal">counter</code> and resets all -subsidiary counters.</p> -<h5 class="title"><a id="cmd-setcounter-title" name= -"cmd-setcounter-title"></a><code class= -"literal">\setcounter{counter}{value}</code></h5> -<a id="idp6868800" class="indexterm" name="idp6868800"></a><a id= -"idp6869552" class="indexterm" name="idp6869552"></a> -<p>The <code class="literal">\setcounter</code> command sets the -value of the <code class="literal">counter</code> to that specified -by the <code class="literal">value</code> argument.</p> -<h5 class="title"><a id="cmd-usecounter-title" name= -"cmd-usecounter-title"></a><code class= -"literal">\usecounter{counter}</code></h5> -<a id="idp6873792" class="indexterm" name="idp6873792"></a> -<p>The <code class="literal">\usecounter</code> command is used in -the second argument of the <code class="literal">list</code> -environment to allow the counter specified to be used to number the -list items.</p> -<h5 class="title"><a id="cmd-value-title" name= -"cmd-value-title"></a><code class= -"literal">\value{counter}</code></h5> -<a id="idp6877520" class="indexterm" name="idp6877520"></a><a id= -"idp6878272" class="indexterm" name="idp6878272"></a> -<p>The <code class="literal">\value</code> command produces the -value of the <code class="literal">counter</code> named in the -mandatory argument. It can be used where LaTeX expects an integer -or number, such as the second argument of a <code class= -"literal">\setcounter</code> or <code class= -"literal">\addtocounter</code> 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" title="2.3.2 Cross References"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="cross-references" name= -"cross-references"></a>2.3.2 Cross References</h4> -</div> -</div> -</div> -<a id="idp6884544" class="indexterm" name="idp6884544"></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 class= -"link" href="#varioref" title="3.11 varioref"><code class= -"literal">varioref</code></a>.</p> -<h5 class="title"><a id="cmd-label-title" name= -"cmd-label-title"></a><code class="literal">\label{key}</code></h5> -<a id="idp6888528" class="indexterm" name="idp6888528"></a> -<p>A <code class="literal">\label</code> command appearing in -ordinary text assigns to the <code class="literal">key</code> the -number of the current sectional unit; one appearing inside a -numbered environment assigns that number to the <code class= -"literal">key</code>.</p> -<p>A <code class="literal">key</code> 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">cha</code> for -chapters</li> -<li class="listitem"><code class="literal">sec</code> for -lower-level sectioning commands</li> -<li class="listitem"><code class="literal">fig</code> for -figures</li> -<li class="listitem"><code class="literal">tab</code> for -tables</li> -<li class="listitem"><code class="literal">eq</code> for -equations</li> -</ul> -</div> -<p>Thus, a label for a figure would look like <code class= -"literal">fig:bandersnatch</code>.</p> -<h5 class="title"><a id="cmd-pageref" name= -"cmd-pageref"></a><code class="literal">\pageref{key}</code></h5> -<a id="idp6902624" class="indexterm" name="idp6902624"></a><a id= -"idp6903376" class="indexterm" name="idp6903376"></a> -<p>The <code class="literal">\pageref</code> command produces the -page number of the place in the text where the corresponding -<code class="literal">\label</code> command appears. ie. where -<code class="literal">\label{key}</code> appears. For a smart -version see <a class="link" href="#cmd-vpageref"><code class= -"literal">\vpageref</code></a>.</p> -<h5 class="title"><a id="cmd-ref-title" name= -"cmd-ref-title"></a><code class="literal">\ref{key}</code></h5> -<a id="idp6908720" class="indexterm" name="idp6908720"></a><a id= -"idp6909472" class="indexterm" name="idp6909472"></a> -<p>The <code class="literal">\ref</code> command produces the -number of the sectional unit, equation number, ... of the -corresponding <code class="literal">\label</code> command. For a -smart version see <a class="link" href="#cmd-vref">\vref</a>.</p> -</div> -<div class="section" title="2.3.3 Definitions"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="definitions" name="definitions"></a>2.3.3 -Definitions</h4> -</div> -</div> -</div> -<h5 class="title"><a id="cmd-newcommand-title" name= -"cmd-newcommand-title"></a><code class= -"literal">\newcommand</code></h5> -<a id="idp6915344" class="indexterm" name="idp6915344"></a><a id= -"idp6916096" class="indexterm" name="idp6916096"></a><a id= -"idp6916848" class="indexterm" name="idp6916848"></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="table-newcommand" name= -"table-newcommand"></a> -<p class="title"><strong>Table 1.1. Options for -<code class="literal">\newcommand</code></strong></p> -<div class="table-contents"> -<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 <code class= -"literal">\</code>. For <code class="literal">\newcommand</code> it -must not be already defined and must not begin with <code class= -"literal">\end</code>; for <code class= -"literal">\renewcommand</code> 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 <code class="literal">def</code>.</td> -</tr> -<tr> -<td align="left">definition</td> -<td align="justify">The text to be substituted for every occurrence -of <code class="literal">cmd</code>; a parameter of the form -<code class="literal">#n</code> in <code class="literal">cmd</code> -is replaced by the text of the nth argument when this substitution -takes place.</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<h5 class="title"><a id="cmd-newenvironment-title" name= -"cmd-newenvironment-title"></a><code class= -"literal">\newenvironment</code></h5> -<a id="idp6935872" class="indexterm" name="idp6935872"></a><a id= -"idp6936624" class="indexterm" name="idp6936624"></a><a id= -"idp6937376" class="indexterm" name="idp6937376"></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="table-newenvironment" name= -"table-newenvironment"></a> -<p class="title"><strong>Table 1.2. Options for -<code class="literal">\newenvironment</code></strong></p> -<div class="table-contents"> -<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 <code class= -"literal">\newenvironment</code> there must be no currently defined -environment by that name, and the command <code class= -"literal">\nam</code> must be undefined. For <code class= -"literal">\renewenvironment</code> 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 <code class= -"literal">{begdef}</code> part.</td> -</tr> -<tr> -<td align="left">default</td> -<td align="justify">If this is specified, the first argument is -optional, and <code class="literal">default</code> 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 -<code class="literal">\begin{nam}</code>; a parameter of the form -<code class="literal">#n</code> in <code class="literal">cmd</code> -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 -<code class="literal">\end{nam}</code>. It may not contain any -argument parameters.</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<h5 class="title"><a id="cmd-newtheorem-title" name= -"cmd-newtheorem-title"></a><code class= -"literal">\newtheorem</code></h5> -<a id="idp6957904" class="indexterm" name="idp6957904"></a><a id= -"idp6958656" class="indexterm" name="idp6958656"></a><a id= -"idp6959408" class="indexterm" name="idp6959408"></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="table-newtheorem" name= -"table-newtheorem"></a> -<p class="title"><strong>Table 1.3. Options for -<code class="literal">\newtheorem</code></strong></p> -<div class="table-contents"> -<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"><strong>within</strong></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> -</div> -<br class="table-break" /> -<p>The <code class="literal">\newtheorem</code> command may have at -most one optional argument.</p> -<h5 class="title"><a id="cmd-newfont-title" name= -"cmd-newfont-title"></a><code class="literal">\newfont</code></h5> -<a id="idp6974816" class="indexterm" name="idp6974816"></a><a id= -"idp6975568" class="indexterm" name="idp6975568"></a><a id= -"idp6976320" class="indexterm" name="idp6976320"></a> -<p><code class="literal">\newfont{cmd}{font_name}</code></p> -<p>Defines the command name <code class="literal">cmd</code>, which -must not be currently defined, to be a declaration that selects the -font named <code class="literal">font_name</code> to be the current -font.</p> -</div> -<div class="section" title="2.3.4 Document Classes"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="document-classes" name= -"document-classes"></a>2.3.4 Document Classes</h4> -</div> -</div> -</div> -<a id="idp6980944" class="indexterm" name="idp6980944"></a><a id= -"idp6981696" class="indexterm" name="idp6981696"></a><a id= -"idp6982448" class="indexterm" name="idp6982448"></a><a id= -"idp6983200" class="indexterm" name="idp6983200"></a><a id= -"idp6983952" class="indexterm" name="idp6983952"></a><a id= -"idp6984704" class="indexterm" name="idp6984704"></a><a id= -"idp6985456" class="indexterm" name="idp6985456"></a> -<p>Valid LaTeX document classes include:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">article</li> -<li class="listitem">report</li> -<li class="listitem">letter</li> -<li class="listitem">book</li> -<li class="listitem">slides</li> -</ul> -</div> -<p>Other document classes are often available. See <a class="link" -href="#overview" title= -"2.2 Overview of LaTeX and Local Guide">Overview</a>, for details. -They are selected with the following command:</p> -<p><code class="literal">\documentclass [options] -{class}</code></p> -<p>All the standard classes (except slides) accept the following -options for selecting the typeface size (<code class= -"literal">10pt</code> is default):</p> -<p><code class="literal">10pt, 11pt, 12pt</code></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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">landscape --- selects landscape format. -Default is portrait.</li> -<li class="listitem">titlepage, notitlepage --- selects if there -should be a separate title page.</li> -<li class="listitem">leqno --- equation number on left side of -equations. Default is right side.</li> -<li class="listitem">fleqn --- displayed formulas flush left. -Default is centered.</li> -<li class="listitem">openbib --- use <span class= -"emphasis"><em>open</em></span> bibliography format.</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">oneside, twoside --- selects one- or twosided -layout. Default is oneside, except for the book class.</li> -<li class="listitem">openright, openany --- determines if a chapter -should start on a right-hand page. Default is openright for -book.</li> -<li class="listitem">onecolumn, twocolumn --- one or two columns. -Defaults to one column.</li> -</ul> -</div> -<p>The slides class offers the option <code class= -"literal">clock</code> 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" name="usepackage-linkend"></a> -<code class="literal">\usepackage[options]{pkg}</code> <a id= -"idp7008832" class="indexterm" name="idp7008832"></a></p> -<p>command. If you specify more than one package, they must be -separated by a comma. <a id="idp7010080" class="indexterm" name= -"idp7010080"></a> <a id="idp7010832" class="indexterm" name= -"idp7010832"></a></p> -<p>Any options given in the <code class= -"literal">\documentclass</code> command that are unknown by the -selected document class are passed on to the packages loaded with -<code class="literal">\usepackage</code>. <a id="idp7013344" class= -"indexterm" name="idp7013344"></a> <a id="idp7014096" class= -"indexterm" name="idp7014096"></a></p> -<a id="idp7014976" class="indexterm" name="idp7014976"></a></div> -<div class="section" title="2.3.5 Layout"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="layout" name="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" name= -"cmd-flushbottom-title"></a><code class= -"literal">\flushbottom</code></h5> -<a id="idp7018688" class="indexterm" name="idp7018688"></a> -<p>The <code class="literal">\flushbottom</code> 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" name= -"cmd-onecolumn-title"></a><code class= -"literal">\onecolumn</code></h5> -<a id="idp7022208" class="indexterm" name="idp7022208"></a> -<p>The <code class="literal">\onecolumn</code> declaration starts a -new page and produces single-column output.</p> -<h5 class="title"><a id="cmd-raggedbottom-title" name= -"cmd-raggedbottom-title"></a><code class= -"literal">\raggedbottom</code></h5> -<a id="idp7025296" class="indexterm" name="idp7025296"></a> -<p>The <code class="literal">\raggedbottom</code> 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" name= -"cmd-twocolumn-title"></a><code class= -"literal">\twocolumn</code></h5> -<a id="idp7028416" class="indexterm" name="idp7028416"></a><a id= -"idp7029168" class="indexterm" name="idp7029168"></a> -<p><code class="literal">\twocolumn[text]</code></p> -<p>The <code class="literal">\twocolumn</code> declaration starts a -new page and produces two-column output. If the optional -<code class="literal">text</code> argument is present, it is -typeset in one-column mode.</p> -</div> -<div class="section" title="2.3.6 Environments"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="env-latex" name="env-latex"></a>2.3.6 -Environments</h4> -</div> -</div> -</div> -<a id="idp7034128" class="indexterm" name="idp7034128"></a><a id= -"idp7034880" class="indexterm" name="idp7034880"></a><a id= -"idp7035632" class="indexterm" name="idp7035632"></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" name="env-array"></a>array</h5> -<a id="idp7038736" class="indexterm" name="idp7038736"></a><a id= -"idp7039488" class="indexterm" name="idp7039488"></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, <code class= -"literal">coln</code>, is specified by a single letter that tells -how items in that row should be formatted.</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">c</code> --- for -centered</li> -<li class="listitem"><code class="literal">l</code> --- for flush -left</li> -<li class="listitem"><code class="literal">r</code> --- for flush -right</li> -</ul> -</div> -<p>Column entries must be separated by an <code class= -"literal">&</code>. Column entries may include other LaTeX -commands. Each row of the array must be terminated with the string -<code class="literal">\\</code>.</p> -<p>Note that the <code class="literal">array</code> environment can -only be used in math mode, so normally it is used inside an -<code class="literal">equation</code> environment.</p> -<h5 class="title"><a id="env-center" name= -"env-center"></a><code class="literal">center</code></h5> -<a id="idp7051984" class="indexterm" name="idp7051984"></a><a id= -"idp7052736" class="indexterm" name="idp7052736"></a> -<pre class="programlisting"> -\begin{center} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{center} -</pre> -<p>The <code class="literal">center</code> 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 <code class="literal">\\</code>.</p> -<h5 class="title"><a id="cmd-centering" name= -"cmd-centering"></a><code class="literal">\centering</code></h5> -<a id="idp7057296" class="indexterm" name="idp7057296"></a><a id= -"idp7058048" class="indexterm" name="idp7058048"></a><a id= -"idp7058800" class="indexterm" name="idp7058800"></a> -<p>This declaration corresponds to the <code class= -"literal">center</code> environment. This declaration can be used -inside an environment such as <code class="literal">quote</code> or -in a <code class="literal">parbox</code>. The text of a figure or -table can be centered on the page by putting a <code class= -"literal">\centering</code> command at the beginning of the figure -or table environment.</p> -<p>Unlike the <code class="literal">center</code> environment, the -<code class="literal">\centering</code> 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 <code class="literal">\end</code> -command (of an environment like quote) that ends the paragraph -unit.</p> -<h5 class="title"><a id="env-description" name= -"env-description"></a><code class="literal">description</code></h5> -<a id="idp7066928" class="indexterm" name="idp7066928"></a><a id= -"idp7067680" class="indexterm" name="idp7067680"></a> -<pre class="programlisting"> -\begin{description} -\item [label] First item -\item [label] Second item - . - . - . -\end{description} -</pre> -<p>The <code class="literal">description</code> environment is used -to make labelled lists. The <code class="literal">label</code> is -bold face and flushed right.</p> -<h5 class="title"><a id="env-enumerate" name= -"env-enumerate"></a><code class="literal">enumerate</code></h5> -<a id="idp7072112" class="indexterm" name="idp7072112"></a><a id= -"idp7072864" class="indexterm" name="idp7072864"></a> -<pre class="programlisting"> -\begin{enumerate} -\item First item -\item Second item - . - . - . -\end{enumerate} -</pre> -<p>The <code class="literal">enumerate</code> 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 <code class= -"literal">\item</code> command. There must be at least one -<code class="literal">\item</code> command within the -environment.</p> -<p>The <code class="literal">enumerate</code> environment uses the -<code class="literal">enumi</code> through <code class= -"literal">enumiv</code> counters (see <a class="link" href= -"#counters" title="2.3.1 Counters">Counters</a>). The type of -numbering can be changed by redefining <code class= -"literal">\theenumi</code> etc.</p> -<h5 class="title"><a id="env-eqnarray" name= -"env-eqnarray"></a><code class="literal">eqnarray</code></h5> -<a id="idp7082000" class="indexterm" name="idp7082000"></a><a id= -"idp7082752" class="indexterm" name="idp7082752"></a><a id= -"idp7083504" class="indexterm" name="idp7083504"></a> -<pre class="programlisting"> -\begin{eqnarray} -math formula 1 \\ -math formula 2 \\ - . - . - . -\end{eqnarray} -</pre> -<p>The <code class="literal">eqnarray</code> environment is used to -display a sequence of equations or inequalities. It is very much -like a three-column <code class="literal">array</code> environment, -with consecutive rows separated by <code class="literal">\\</code> -and consecutive items within a row separated by an <code class= -"literal">&</code>.</p> -<p>An equation number is placed on every line unless that line has -a <code class="literal">\nonumber</code> command.</p> -<a id="idp7089168" class="indexterm" name="idp7089168"></a> -<p>The command <code class="literal">\lefteqn</code> 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" name= -"env-equation"></a><code class="literal">equation</code></h5> -<a id="idp7092320" class="indexterm" name="idp7092320"></a><a id= -"idp7093072" class="indexterm" name="idp7093072"></a><a id= -"idp7093824" class="indexterm" name="idp7093824"></a> -<pre class="programlisting"> -\begin{equation} - math formula -\end{equation} -</pre> -<p>The <code class="literal">equation</code> environment centers -your equation on the page and places the equation number in the -right margin.</p> -<h5 class="title"><a id="env-figure" name= -"env-figure"></a><code class="literal">figure</code></h5> -<a id="idp7097568" class="indexterm" name="idp7097568"></a><a id= -"idp7098320" class="indexterm" name="idp7098320"></a> -<pre class="programlisting"> -\begin{figure}[placement] - - body of the figure - -\caption{figure title} -\end{figure} -</pre> -<a id="idp7099792" class="indexterm" name="idp7099792"></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 <code class="literal">[placement]</code> -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 class="orderedlist" type="1"> -<li class="listitem"> -<p><code class="literal">h</code> (Here) - at the position in the -text where the figure environment appears.</p> -</li> -<li class="listitem"> -<p><code class="literal">t</code> (Top) - at the top of a text -page.</p> -</li> -<li class="listitem"> -<p><code class="literal">b</code> (Bottom) - at the bottom of a -text page.</p> -</li> -<li class="listitem"> -<p><code class="literal">p</code> (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 <code class="literal">tbp</code>.</p> -<p>The body of the figure is made up of whatever text, LaTeX -commands, etc. you wish. The <code class="literal">\caption</code> -command allows you to title your figure.</p> -<h5 class="title"><a id="env-flushleft" name= -"env-flushleft"></a><code class="literal">flushleft</code></h5> -<a id="idp7113328" class="indexterm" name="idp7113328"></a><a id= -"idp7114080" class="indexterm" name="idp7114080"></a><a id= -"idp7114832" class="indexterm" name="idp7114832"></a> -<pre class="programlisting"> -\begin{flushleft} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushleft} -</pre> -<p>The <code class="literal">flushleft</code> 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 <code class="literal">\\</code>.</p> -<h5 class="title"><a id="cmd-raggedright" name= -"cmd-raggedright"></a><code class= -"literal">\raggedright</code></h5> -<a id="idp7119376" class="indexterm" name="idp7119376"></a><a id= -"idp7120128" class="indexterm" name="idp7120128"></a><a id= -"idp7120880" class="indexterm" name="idp7120880"></a><a id= -"idp7121632" class="indexterm" name="idp7121632"></a> -<p>This declaration corresponds to the <code class= -"literal">flushleft</code> environment. This declaration can be -used inside an environment such as <code class= -"literal">quote</code> or in a <code class= -"literal">parbox</code>.</p> -<p>Unlike the <code class="literal">flushleft</code> environment, -the <code class="literal">\raggedright</code> 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 <code class= -"literal">\end</code> command (of an environment like quote) that -ends the paragraph unit.</p> -<h5 class="title"><a id="env-flushright" name= -"env-flushright"></a><code class="literal">flushright</code></h5> -<a id="idp7128960" class="indexterm" name="idp7128960"></a><a id= -"idp7129712" class="indexterm" name="idp7129712"></a><a id= -"idp7130464" class="indexterm" name="idp7130464"></a> -<pre class="programlisting"> -\begin{flushright} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushright} -</pre> -<p>The <code class="literal">flushright</code> 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 <code class="literal">\\</code>.</p> -<h5 class="title"><a id="cmd-raggedleft" name= -"cmd-raggedleft"></a><code class="literal">\raggedleft</code></h5> -<a id="idp7134992" class="indexterm" name="idp7134992"></a><a id= -"idp7135744" class="indexterm" name="idp7135744"></a><a id= -"idp7136496" class="indexterm" name="idp7136496"></a><a id= -"idp7137248" class="indexterm" name="idp7137248"></a> -<p>This declaration corresponds to the <code class= -"literal">flushright</code> environment. This declaration can be -used inside an environment such as <code class= -"literal">quote</code> or in a <code class= -"literal">parbox</code>.</p> -<p>Unlike the <code class="literal">flushright</code> environment, -the <code class="literal">\raggedleft</code> 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 <code class= -"literal">\end</code> command (of an environment like quote) that -ends the paragraph unit.</p> -<h5 class="title"><a id="env-itemize" name= -"env-itemize"></a><code class="literal">itemize</code></h5> -<a id="idp7144576" class="indexterm" name="idp7144576"></a><a id= -"idp7145328" class="indexterm" name="idp7145328"></a><a id= -"idp7146080" class="indexterm" name="idp7146080"></a> -<pre class="programlisting"> -\begin{itemize} -\item First item -\item Second item - . - . - . -\end{itemize} -</pre> -<p>The <code class="literal">itemize</code> 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 <code class="literal">itemized</code> list -begins with an <code class="literal">\item</code> command. There -must be at least one <code class="literal">\item</code> command -within the environment.</p> -<p>The <code class="literal">itemize</code> environment uses the -<code class="literal">itemi</code> through <code class= -"literal">itemiv</code> counters (see <a class="link" href= -"#counters" title="2.3.1 Counters">Counters</a>). The type of -numbering can be changed by redefining <code class= -"literal">\theitemi</code> etc.</p> -<h5 class="title"><a id="env-letter" name= -"env-letter"></a><code class="literal">letter</code></h5> -<a id="idp7156192" class="indexterm" name="idp7156192"></a> -<p>This environment is used for creating letters. See <a class= -"link" href="#letters" title="2.3.9 Letters">Letters</a>.</p> -<h5 class="title"><a id="env-list" name="env-list"></a><code class= -"literal">list</code></h5> -<a id="idp7159264" class="indexterm" name="idp7159264"></a><a id= -"idp7160016" class="indexterm" name="idp7160016"></a> -<p>The <code class="literal">list</code> 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 <code class="literal">{label}</code> 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 <code class="literal">{spacing}</code> argument contains -commands to change the spacing parameters for the list. This -argument will most often be null, i.e., <code class= -"literal">{}</code>. This will select all default spacing which -should suffice for most cases.</p> -<h5 class="title"><a id="env-minipage" name= -"env-minipage"></a><code class="literal">minipage</code></h5> -<a id="idp7167424" class="indexterm" name="idp7167424"></a><a id= -"idp7168176" class="indexterm" name="idp7168176"></a><a id= -"idp7168928" class="indexterm" name="idp7168928"></a><a id= -"idp7169680" class="indexterm" name="idp7169680"></a> -<pre class="programlisting"> -\begin{minipage}[position][height][inner-pos]{width} - text -\end{minipage} -</pre> -<p>The <code class="literal">minipage</code> environment is similar -to a <code class="literal">\parbox</code> command. It takes the -same optional <code class="literal">position</code> argument and -mandatory <code class="literal">width</code> argument. You may use -other paragraph-making environments inside a minipage.</p> -<p>Footnotes in a <code class="literal">minipage</code> environment -are handled in a way that is particularly useful for putting -footnotes in figures or tables. A <code class= -"literal">\footnote</code> or <code class= -"literal">\footnotetext</code> command puts the footnote at the -bottom of the minipage instead of at the bottom of the page, and it -uses the <code class="literal">mpfootnote</code> counter instead of -the ordinary <code class="literal">footnote</code> counter See -<a class="link" 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" name= -"env-picture"></a><code class="literal">picture</code></h5> -<a id="idp7180336" class="indexterm" name="idp7180336"></a><a id= -"idp7181088" class="indexterm" name="idp7181088"></a><a id= -"idp7181840" class="indexterm" name="idp7181840"></a> -<pre class="programlisting"> -\begin{picture}(width,height)(x offset,y offset) - . - . - picture commands - . - . -\end{picture} -</pre> -<p>The <code class="literal">picture</code> 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 <code class="literal">5</code>, <code class= -"literal">2.3</code> or <code class="literal">-3.1416</code>. A -coordinate specifies a length in multiples of the unit length -<code class="literal">\unitlength</code>, so if <code class= -"literal">\unitlength</code> has been set to <code class= -"literal">1cm</code>, then the coordinate 2.54 specifies a length -of 2.54 centimetres. You can change the value of <code class= -"literal">\unitlength</code> anywhere you want, using the -<code class="literal">\setlength</code> 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 <code class= -"literal">(2.4,-5)</code>, specifying the point with x-coordinate -<code class="literal">2.4</code> and y-coordinate <code class= -"literal">-5</code>. 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 <code class="literal">picture</code> environment has one -mandatory argument, which is a <code class= -"literal">position</code>. 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 <code class="literal">picture</code> environment also has an -optional <code class="literal">position</code> argument, following -the <code class="literal">size</code> 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 <code class= -"literal">\unitlength</code> has been set to <code class= -"literal">1mm</code>, 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 -<code class="literal">\put</code> command. The command</p> -<pre class="programlisting"> -\put (11.3,-.3){...} -</pre> -<p>puts the object specified by <code class="literal">...</code> 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 <code class="literal">\put</code> command creates an -<span class="bold"><strong>LR box</strong></span>. You can put -anything in the text argument of the <code class= -"literal">\put</code> command that you'd put into the argument of -an <code class="literal">\mbox</code> 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" name= -"cmd-circle"></a><code class="literal">\circle{diameter}, -\circle*{diameter}</code></h5> -<a id="idp7208560" class="indexterm" name="idp7208560"></a> -<p>The <code class="literal">\circle</code> command produces a -circle with a diameter as close to the specified one as possible. -If the <code class="literal">*</code>-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" name= -"cmd-dashbox"></a><code class="literal">\dashbox</code></h5> -<a id="idp7213072" class="indexterm" name="idp7213072"></a> -<p>Draws a box with a dashed line.</p> -<p><code class= -"literal">\dashbox{dash_length}(width,height){...}</code></p> -<p>The <code class="literal">\dashbox</code> has an extra argument -which specifies the width of each dash. A dashed box looks best -when the <code class="literal">width</code> and <code class= -"literal">height</code> are multiples of the <code class= -"literal">dash_length</code>.</p> -<h5 class="title"><a id="cmd-frame" name= -"cmd-frame"></a><code class="literal">\frame{...}</code></h5> -<a id="idp7219472" class="indexterm" name="idp7219472"></a> -<p>The <code class="literal">\frame</code> 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" name= -"cmd-framebox-op-picture-cp"></a><code class= -"literal">\framebox(width,height)[position]{...}</code></h5> -<a id="idp7222592" class="indexterm" name="idp7222592"></a> -<p>The <code class="literal">\framebox</code> command is exactly -the same as the <code class="literal">\makebox</code> command, -except that it puts a frame around the outside of the box that it -creates.</p> -<p>The <code class="literal">framebox</code> command produces a -rule of thickness <code class="literal">\fboxrule</code>, and -leaves a space <code class="literal">\fboxsep</code> between the -rule and the contents of the box.</p> -<h5 class="title"><a id="cmd-line" name="cmd-line"></a><code class= -"literal">\line(x slope,y slope){length}</code></h5> -<a id="idp7228576" class="indexterm" name="idp7228576"></a> -<p>The <code class="literal">\line</code> command draws a line of -the specified <code class="literal">length</code> and <code class= -"literal">slope</code>.</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" name= -"cmd-linethickness"></a><code class= -"literal">\linethickness{dimension}</code></h5> -<a id="idp7233712" class="indexterm" name="idp7233712"></a> -<p>Declares the thickness of horizontal and vertical lines in a -picture environment to be <code class="literal">dimension</code>, -which must be a positive length. It does not affect the thickness -of slanted lines and circles, or the quarter circles drawn by -<code class="literal">\oval</code> to form the corners of an -oval.</p> -<h5 class="title"><a id="cmd-makebox-op-picture-cp" name= -"cmd-makebox-op-picture-cp"></a><code class= -"literal">\makebox(width,height)[position]{...}</code></h5> -<a id="idp7237616" class="indexterm" name="idp7237616"></a> -<p>The <code class="literal">\makebox</code> command for the -picture environment is similar to the normal <code class= -"literal">\makebox</code> command except that you must specify a -<code class="literal">width</code> and <code class= -"literal">height</code> in multiples of <code class= -"literal">\unitlength</code>.</p> -<p>The optional argument, <code class="literal">[position]</code>, -specifies the quadrant that your text appears in. You may select up -to two of the following:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">t</code> - Moves the -item to the top of the rectangle</li> -<li class="listitem"><code class="literal">b</code> - Moves the -item to the bottom</li> -<li class="listitem"><code class="literal">l</code> - Moves the -item to the left</li> -<li class="listitem"><code class="literal">r</code> - Moves the -item to the right</li> -</ul> -</div> -<p>See <a class="link" href="#cmd-makebox" title= -"2.3.17. \makebox">\makebox</a>.</p> -<h5 class="title"><a id="cmd-multiput" name= -"cmd-multiput"></a><code class="literal">\multiput(x coord,y -coord)(delta x,delta y){number of copies}{object}</code></h5> -<a id="idp7251104" class="indexterm" name="idp7251104"></a> -<p>The <code class="literal">\multiput</code> 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" name="cmd-oval"></a><code class= -"literal">\oval(width,height)[portion]</code></h5> -<a id="idp7254224" class="indexterm" name="idp7254224"></a> -<p>The <code class="literal">\oval</code> command produces a -rectangle with rounded corners. The optional argument, <code class= -"literal">[portion]</code>, allows you to select part of the -oval.</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">t</code> - Selects the -top portion</li> -<li class="listitem"><code class="literal">b</code> - Selects the -bottom portion</li> -<li class="listitem"><code class="literal">r</code> - Selects the -right portion</li> -<li class="listitem"><code class="literal">l</code> - 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" name="cmd-put"></a><code class= -"literal">\put(x coord,y coord){ ... }</code></h5> -<a id="idp7264976" class="indexterm" name="idp7264976"></a> -<p>The <code class="literal">\put</code> command places the item -specified by the mandatory argument at the given coordinates.</p> -<h5 class="title"><a id="cmd-shortstack" name= -"cmd-shortstack"></a><code class= -"literal">\shortstack[position]{... \\ ... \\ ...}</code></h5> -<a id="idp7268080" class="indexterm" name="idp7268080"></a> -<p>The <code class="literal">\shortstack</code> command produces a -stack of objects. The valid positions are:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">r</code> - Moves the -objects to the right of the stack</li> -<li class="listitem"><code class="literal">l</code> - Moves the -objects to the left of the stack</li> -<li class="listitem"><code class="literal">c</code> - Moves the -objects to the centre of the stack (default)</li> -</ul> -</div> -<h5 class="title"><a id="cmd-vector" name= -"cmd-vector"></a><code class="literal">\vector(x slope,y -slope){length}</code></h5> -<a id="idp7275744" class="indexterm" name="idp7275744"></a> -<p>The <code class="literal">\vector</code> command draws a line -with an arrow of the specified length and slope. The <code class= -"literal">x</code> and <code class="literal">y</code> values must -lie between -4 and +4, inclusive.</p> -<h5 class="title"><a id="env-quotation" name= -"env-quotation"></a><code class="literal">quotation</code></h5> -<a id="idp7280080" class="indexterm" name="idp7280080"></a><a id= -"idp7280832" class="indexterm" name="idp7280832"></a><a id= -"idp7281584" class="indexterm" name="idp7281584"></a> -<pre class="programlisting"> -\begin{quotation} - text -\end{quotation} -</pre> -<p>The margins of the <code class="literal">quotation</code> -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" name= -"env-quote"></a><code class="literal">quote</code></h5> -<a id="idp7285424" class="indexterm" name="idp7285424"></a><a id= -"idp7286176" class="indexterm" name="idp7286176"></a><a id= -"idp7286928" class="indexterm" name="idp7286928"></a> -<pre class="programlisting"> -\begin{quote} - text -\end{quote} -</pre> -<p>The margins of the <code class="literal">quote</code> -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" name= -"env-tabbing"></a><code class="literal">tabbing</code></h5> -<a id="idp7290736" class="indexterm" name="idp7290736"></a><a id= -"idp7291488" class="indexterm" name="idp7291488"></a><a id= -"idp7292240" class="indexterm" name="idp7292240"></a> -<pre class="programlisting"> -\begin{tabbing} -text \= more text \= still more text \= last text \\ -second row \> \> more \\ - . - . - . -\end{tabbing} -</pre> -<p>The <code class="literal">tabbing</code> 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 -<code class="literal">tabular</code> environment.</p> -<p>The following commands can be used inside a <code class= -"literal">tabbing</code> environment:</p> -<div class="table"><a id="table-tabbing" name="table-tabbing"></a> -<p class="title"><strong>Table 1.4. Commands in a -<code class="literal">tabbing</code> environment</strong></p> -<div class="table-contents"> -<table summary="Commands in a tabbing environment" border="0"> -<colgroup> -<col align="left" /> -<col align="justify" /></colgroup> -<tbody> -<tr> -<td align="left">\= <a id="idp7302176" class="indexterm" name= -"idp7302176"></a></td> -<td align="justify">Sets a tab stop at the current position.</td> -</tr> -<tr> -<td align="left">\> <a id="idp7304192" class="indexterm" name= -"idp7304192"></a></td> -<td align="justify">Advances to the next tab stop.</td> -</tr> -<tr> -<td align="left">\< <a id="idp7306208" class="indexterm" name= -"idp7306208"></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="idp7308416" class="indexterm" name= -"idp7308416"></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="idp7310560" class="indexterm" name= -"idp7310560"></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="idp7312704" class="indexterm" name= -"idp7312704"></a></td> -<td align="justify">Moves everything that you have typed so far in -the current column, i.e. everything from the most recent -<code class="literal">\></code>, <code class= -"literal">\<</code>, <code class="literal">\'</code>, -<code class="literal">\\</code>, or <code class= -"literal">\kill</code> command, to the right of the previous -column, flush against the current column's tab stop.</td> -</tr> -<tr> -<td align="left">\` <a id="idp7318112" class="indexterm" name= -"idp7318112"></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 -<code class="literal">\`</code> command moves all the text that -follows it, up to the <code class="literal">\\</code> or -<code class="literal">\end{tabbing}</code> command that ends the -line, to the right margin of the tabbing environment. There must be -no <code class="literal">\></code> or <code class= -"literal">\'</code> command between the <code class= -"literal">\`</code> and the command that ends the line.</td> -</tr> -<tr> -<td align="left">\kill <a id="idp7324320" class="indexterm" name= -"idp7324320"></a></td> -<td align="justify">Sets tab stops without producing text. Works -just like <code class="literal">\\</code> except that it throws -away the current line instead of producing output for it. The -effect of any <code class="literal">\=</code>, <code class= -"literal">\+</code> or <code class="literal">\-</code> commands in -that line remain in effect.</td> -</tr> -<tr> -<td align="left">\pushtabs <a id="idp7329056" class="indexterm" -name="idp7329056"></a></td> -<td align="justify">Saves all current tab stop positions. Useful -for temporarily changing tab stop positions in the middle of a -<code class="literal">tabbing</code> environment.</td> -</tr> -<tr> -<td align="left">\poptabs <a id="idp7331840" class="indexterm" -name="idp7331840"></a></td> -<td align="justify">Restores the tab stop positions saved by the -last <code class="literal">\pushtabs</code>.</td> -</tr> -<tr> -<td align="left">\a <a id="idp7334560" class="indexterm" name= -"idp7334560"></a></td> -<td align="justify">In a <code class="literal">tabbing</code> -environment, the commands <code class="literal">\=</code>, -<code class="literal">\'</code> and <code class="literal">\`</code> -do not produce accents as normal. Instead, the commands -<code class="literal">\a=</code>, <code class="literal">\a'</code> -and <code class="literal">\a`</code> are used.</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<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" name= -"env-table"></a><code class="literal">table</code></h5> -<a id="idp7343712" class="indexterm" name="idp7343712"></a><a id= -"idp7344464" class="indexterm" name="idp7344464"></a><a id= -"idp7345216" class="indexterm" name="idp7345216"></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 <code class="literal">[placement]</code> -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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">h</code> : Here - at the -position in the text where the table environment appears.</li> -<li class="listitem"><code class="literal">t</code> : Top - at the -top of a text page.</li> -<li class="listitem"><code class="literal">b</code> : Bottom - at -the bottom of a text page.</li> -<li class="listitem"><code class="literal">p</code> : Page of -floats - on a separate float page, which is a page containing no -text, only floats.</li> -</ul> -</div> -<p>The standard <code class="literal">report</code> and -<code class="literal">article</code> classes use the default -placement <code class="literal">[tbp]</code>.</p> -<p>The body of the table is made up of whatever text, LaTeX -commands, etc., you wish. The <code class="literal">\caption</code> -command allows you to title your table.</p> -<h5 class="title"><a id="env-tabular" name= -"env-tabular"></a><code class="literal">tabular</code></h5> -<a id="idp7360416" class="indexterm" name="idp7360416"></a><a id= -"idp7361168" class="indexterm" name="idp7361168"></a><a id= -"idp7361920" class="indexterm" name="idp7361920"></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="table-tabular" name="table-tabular"></a> -<p class="title"><strong>Table 1.5. Commands used inside -a <code class="literal">tabular</code> environment</strong></p> -<div class="table-contents"> -<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 <code class= -"literal">tabular*</code> 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">t</code> - align on top -row</li> -<li class="listitem"><code class="literal">b</code> - 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">l</code> - A column of -left-aligned items.</li> -<li class="listitem"><code class="literal">r</code> - A column of -right-aligned items.</li> -<li class="listitem"><code class="literal">c</code> - A column of -centred items.</li> -<li class="listitem"><code class="literal">|</code> - A vertical -line the full height and depth of the environment.</li> -<li class="listitem"><code class="literal">@{text}</code> - This -inserts <code class="literal">text</code> 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 <code class= -"literal">\extracolsep{wd}</code> command in an @-expression causes -an extra space of width <code class="literal">wd</code> to appear -to the left of all subsequent columns, until countermanded by -another <code class="literal">\extracolsep</code> command. Unlike -ordinary intercolumn space, this extra space is not suppressed by -an @-expression. An <code class="literal">\extracolsep</code> -command can be used only in an @-expression in the <code class= -"literal">cols</code> argument.</li> -<li class="listitem"> -<p class="simpara"><code class="literal">p{wd}</code> - Produces a -column with each item typeset in a parbox of width <code class= -"literal">wd</code>, as if it were the argument of a <code class= -"literal">\parbox[t]{wd}</code> command. However, a <code class= -"literal">\\</code> may not appear in the item, except in the -following situations:</p> -<div class="orderedlist"> -<ol class="orderedlist" type="1"> -<li class="listitem">inside an environment like <code class= -"literal">minipage</code>, <code class="literal">array</code>, or -<code class="literal">tabular</code>.</li> -<li class="listitem">inside an explicit <code class= -"literal">\parbox</code>.</li> -<li class="listitem">in the scope of a <code class= -"literal">\centering</code>, <code class= -"literal">\raggedright</code>, or <code class= -"literal">\raggedleft</code> declaration. The latter declarations -must appear inside braces or an environment when used in a -<code class="literal">p</code>-column element.</li> -</ol> -</div> -</li> -<li class="listitem"><code class="literal">*{num}{cols}</code> - -Equivalent to <code class="literal">num</code> copies of -<code class="literal">cols</code>, where <code class= -"literal">num</code> is any positive integer and <code class= -"literal">cols</code> is any list of column-specifiers, which may -contain another <code class="literal">*-expression</code>.</li> -</ul> -</div> -</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<p>These commands can be used inside a <code class= -"literal">tabular</code> environment:</p> -<h5 class="title"><a id="cmd-cline" name= -"cmd-cline"></a><code class="literal">\cline{i-j}</code></h5> -<a id="idp7407632" class="indexterm" name="idp7407632"></a> -<p>The <code class="literal">\cline</code> command draws horizontal -lines across the columns specified, beginning in column -<code class="literal">i</code> and ending in column <code class= -"literal">j</code>, which are identified in the mandatory -argument.</p> -<h5 class="title"><a id="cmd-hline" name= -"cmd-hline"></a><code class="literal">\hline</code></h5> -<a id="idp7412064" class="indexterm" name="idp7412064"></a> -<p>The <code class="literal">\hline</code> 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" name= -"cmd-multicolumn"></a><code class= -"literal">\multicolumn</code></h5> -<a id="idp7415248" class="indexterm" name="idp7415248"></a> -<p><code class="literal">\multicolumn{cols}{pos}{text}</code></p> -<p>The <code class="literal">\multicolumn</code> is used to make an -entry that spans several columns. The first mandatory argument, -<code class="literal">cols</code>, specifies the number of columns -to span. The second mandatory argument, <code class= -"literal">pos</code>, specifies the formatting of the entry; -<code class="literal">c</code> for centred, <code class= -"literal">l</code> for flushleft, <code class="literal">r</code> -for flushright. The third mandatory argument, <code class= -"literal">text</code>, specifies what text is to make up the -entry.</p> -<h5 class="title"><a id="cmd-vline" name= -"cmd-vline"></a><code class="literal">\vline</code></h5> -<a id="idp7423152" class="indexterm" name="idp7423152"></a> -<p>The <code class="literal">\vline</code> command will draw a -vertical line extending the full height and depth of its row. An -<code class="literal">\hfill</code> 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" name= -"env-thebibliography"></a><code class= -"literal">thebibliography</code></h5> -<a id="idp7427024" class="indexterm" name="idp7427024"></a><a id= -"idp7427776" class="indexterm" name="idp7427776"></a> -<pre class="programlisting"> -\begin{thebibliography}{widest-label} -\bibitem[label]{cite_key} - . - . - . -\end{thebibliography} -</pre> -<p>The <code class="literal">thebibliography</code> environment -produces a bibliography or reference list. In the <code class= -"literal">article</code> class, this reference list is labelled -<span class="emphasis"><em>References</em></span>; in the -<code class="literal">report</code> class, it is labelled -<span class="emphasis"><em>Bibliography</em></span>.</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">widest-label</code>: -Text that, when printed, is approximately as wide as the widest -item label produces by the <code class="literal">\bibitem</code> -commands.</li> -</ul> -</div> -<h5 class="title"><a id="cmd-bibitem" name= -"cmd-bibitem"></a><code class= -"literal">\bibitem[label]{cite_key}</code></h5> -<a id="idp7436240" class="indexterm" name="idp7436240"></a> -<p>The <code class="literal">\bibitem</code> command generates an -entry labelled by <code class="literal">label</code>. If the -<code class="literal">label</code> argument is missing, a number is -generated as the <code class="literal">label</code>, using the -<code class="literal">enumi</code> counter. The <code class= -"literal">cite_key</code> is any sequence of letters, numbers, and -punctuation symbols not containing a comma. This command writes an -entry on the <code class="filename">.aux</code> file containing -<code class="literal">cite_key</code> and the item's <code class= -"literal">label</code>. When this <code class= -"filename">.aux</code> file is read by the <code class= -"literal">\begin{document}</code> command, the item's <code class= -"literal">label</code> is associated with <code class= -"literal">cite_key</code>, causing the reference to <code class= -"literal">cite_key</code> by a <code class="literal">\cite</code> -command to produce the associated <code class= -"literal">label</code>.</p> -<h5 class="title"><a id="cmd-cite" name="cmd-cite"></a><code class= -"literal">\cite[text]{key_list}</code></h5> -<a id="idp7448832" class="indexterm" name="idp7448832"></a> -<p>The <code class="literal">key_list</code> argument is a list of -citation keys. This command generates an in-text citation to the -references associated with the keys in <code class= -"literal">key_list</code> by entries on the <code class= -"filename">.aux</code> file read by the <code class= -"literal">\begin{document}</code> command.</p> -<p>The optional <code class="literal">text</code> argument will -appear after the citation, i.e. <code class= -"literal">\cite[p.~2f.]{knuth}</code> might produce `[Knuth, p. -2]'.</p> -<p><a id="idp7454592" class="indexterm" name="idp7454592"></a> The -package <code class="literal">cite.sty</code> allows a line break -in the <code class="literal">\cite</code> reference and can sort -numerical entries.</p> -<p><a id="idp7457232" class="indexterm" name="idp7457232"></a> -<code class="literal">overcite.sty</code> makes citations like -footnotes.</p> -<h5 class="title"><a id="cmd-nocite" name= -"cmd-nocite"></a><code class= -"literal">\nocite{key_list}</code></h5> -<a id="idp7460224" class="indexterm" name="idp7460224"></a> -<p>The <code class="literal">\nocite</code> command produces no -text, but writes <code class="literal">key_list</code>, which is a -list of one or more citation keys, on the <code class= -"filename">.aux</code> file. <code class= -"literal">\nocite{*}</code> uses all entries from the BibTeX -database.</p> -<h5 class="title"><a id="using-bibtex" name= -"using-bibtex"></a>Using BibTeX</h5> -<a id="idp7465232" class="indexterm" name="idp7465232"></a><a id= -"idp7466016" class="indexterm" name="idp7466016"></a><a id= -"idp7467504" class="indexterm" name="idp7467504"></a><a id= -"idp7468336" class="indexterm" name="idp7468336"></a><a id= -"idp7469504" class="indexterm" name="idp7469504"></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 -<code class="literal">thebibliography</code> environment. Instead, -you include the lines</p> -<pre class="programlisting"> -\bibliographystyle{style} -\bibliography{bibfile} -</pre> -<p>where <code class="literal">style</code> refers to a file -<code class="literal">style.bst</code>, which defines how your -citations will look.</p> -<div class="table"><a id="table-standard-styles" name= -"table-standard-styles"></a> -<p class="title"><strong>Table 1.6. Standard styles -distributed with BibTeX</strong></p> -<div class="table-contents"> -<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 <code class="literal">plain</code>, but -entries are in order of citation.</td> -</tr> -<tr> -<td align="left">abbrv</td> -<td align="justify">Like <code class="literal">plain</code>, but -more compact labels.</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<p>In addition, numerous other BibTeX style files exist tailored to -the demands of various publications.</p> -<p>The argument to <code class="literal">\bibliography</code> -refers to the file <code class="literal">bibfile.bib</code>, which -should contain your database in BibTeX format. Only the entries -referred to via <code class="literal">\cite</code> and <code class= -"literal">\nocite</code> will be listed in the bibliography.</p> -<h5 class="title"><a id="env-theorem" name= -"env-theorem"></a><code class="literal">theorem</code></h5> -<a id="idp7489328" class="indexterm" name="idp7489328"></a><a id= -"idp7490080" class="indexterm" name="idp7490080"></a> -<pre class="programlisting"> -\begin{theorem} - theorem text -\end{theorem} -</pre> -<p>The <code class="literal">theorem</code> 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" name= -"env-titlepage"></a><code class="literal">titlepage</code></h5> -<a id="idp7494080" class="indexterm" name="idp7494080"></a><a id= -"idp7494832" class="indexterm" name="idp7494832"></a><a id= -"idp7495584" class="indexterm" name="idp7495584"></a> -<pre class="programlisting"> -\begin{titlepage} - text -\end{titlepage} -</pre> -<p>The <code class="literal">titlepage</code> 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 <code class= -"literal">\today</code> command comes in handy for title pages. -<a id="idp7498704" class="indexterm" name="idp7498704"></a></p> -<p>Note that you can use the <code class= -"literal">\maketitle</code> (see <a class="link" href= -"#cmd-maketitle" title="2.3.15. \maketitle">\maketitle</a>) -command to produce a standard title page.</p> -<h5 class="title"><a id="env-verbatim" name= -"env-verbatim"></a><code class="literal">verbatim</code></h5> -<a id="idp7502448" class="indexterm" name="idp7502448"></a><a id= -"idp7503200" class="indexterm" name="idp7503200"></a><a id= -"idp7503952" class="indexterm" name="idp7503952"></a><a id= -"idp7504704" class="indexterm" name="idp7504704"></a><a id= -"idp7505456" class="indexterm" name="idp7505456"></a> -<pre class="programlisting"> -\begin{verbatim} - text -\end{verbatim} -</pre> -<p>The <code class="literal">verbatim</code> 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" name="cmd-verb"></a><code class= -"literal">\verb char literal_text char</code> <code class= -"literal">\verb*char literal_text char</code></h5> -<a id="idp7510608" class="indexterm" name="idp7510608"></a><a id= -"idp7511360" class="indexterm" name="idp7511360"></a> -<p>Typesets <code class="literal">literal_text</code> exactly as -typed, including special characters and spaces, using a typewriter -(<code class="literal">\tt</code>) type style. There may be no -space between <code class="literal">\verb</code> or <code class= -"literal">\verb*</code> and <code class="literal">char</code> -(space is shown here only for clarity). The <code class= -"literal">*-form</code> differs only in that spaces are printed</p> -<h5 class="title"><a id="env-verse" name= -"env-verse"></a><code class="literal">verse</code></h5> -<a id="idp7517584" class="indexterm" name="idp7517584"></a><a id= -"idp7518336" class="indexterm" name="idp7518336"></a> -<pre class="programlisting"> -\begin{verse} - text -\end{verse} -</pre> -<p>The <code class="literal">verse</code> 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 <code class="literal">\\</code>, and use -one or more blank lines to separate the stanzas.</p> -</div> -<div class="section" title="2.3.7 Footnotes"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="footnotes" name="footnotes"></a>2.3.7 -Footnotes</h4> -</div> -</div> -</div> -<a id="idp7523456" class="indexterm" name="idp7523456"></a> -<p>Footnotes can be produced in one of two ways. They can be -produced with one command, the <code class= -"literal">\footnote</code> command. They can also be produced with -two commands, the <code class="literal">\footnotemark</code> and -the <code class="literal">\footnotetext</code> 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" name= -"cmd-cmd-footnote"></a><code class= -"literal">\footnote[number]{text}</code></h5> -<a id="idp7527936" class="indexterm" name="idp7527936"></a> -<p>The <code class="literal">\footnote</code> command places the -numbered footnote <code class="literal">text</code> at the bottom -of the current page. The optional argument, <code class= -"literal">number</code>, 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 <code class= -"literal">\chapter</code>, in figures, tables or in a <code class= -"literal">tabular</code> environment.</p> -<h5 class="title"><a id="cmd-footnotemark" name= -"cmd-footnotemark"></a><code class= -"literal">\footnotemark</code></h5> -<a id="idp7533616" class="indexterm" name="idp7533616"></a> -<p>The <code class="literal">\footnotemark</code> command puts the -footnote <code class="literal">number</code> in the text. This -command can be used in inner paragraph mode. The text of the -footnote is supplied by the <code class= -"literal">\footnotetext</code> command.</p> -<p>This command can be used to produce several consecutive footnote -markers referring to the same footnote by using</p> -<p><code class="literal">\footnotemark[\value{footnote}]</code></p> -<p>after the first <code class="literal">\footnote</code> -command.</p> -<h5 class="title"><a id="cmd-footnotetext" name= -"cmd-footnotetext"></a><code class= -"literal">\footnotetext[number]{text}</code></h5> -<a id="idp7540416" class="indexterm" name="idp7540416"></a> -<p>The <code class="literal">\footnotetext</code> command produces -the <code class="literal">text</code> to be placed at the bottom of -the page. This command can come anywhere after the <code class= -"literal">\footnotemark</code> command. The <code class= -"literal">\footnotetext</code> command must appear in outer -paragraph mode.</p> -<p>The optional argument, <code class="literal">number</code>, is -used to change the default footnote number.</p> -</div> -<div class="section" title="2.3.8 Lengths"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="lengths" name="lengths"></a>2.3.8 -Lengths</h4> -</div> -</div> -</div> -<a id="idp7546496" class="indexterm" name="idp7546496"></a> -<p>A <code class="literal">length</code> is a measure of distance. -Many LaTeX commands take a length as an argument.</p> -<h5 class="title"><a id="cmd-newlength" name= -"cmd-newlength"></a><code class="literal">\newlength</code></h5> -<a id="idp7549872" class="indexterm" name="idp7549872"></a><a id= -"idp7550624" class="indexterm" name="idp7550624"></a> -<p><code class="literal">\newlength{\gnat}</code></p> -<p>The <code class="literal">\newlength</code> command defines the -mandatory argument, <code class="literal">\gnat</code>, as a -<code class="literal">length</code> command with a value of -<code class="literal">0in</code>. An error occurs if a <code class= -"literal">\gnat</code> command already exists.</p> -<h5 class="title"><a id="cmd-setlength" name= -"cmd-setlength"></a><code class="literal">\setlength</code></h5> -<a id="idp7556992" class="indexterm" name="idp7556992"></a><a id= -"idp7557744" class="indexterm" name="idp7557744"></a> -<p><code class="literal">\setlength{\gnat}{length}</code></p> -<p>The <code class="literal">\setlength</code> command is used to -set the value of a <code class="literal">length</code> command. The -<code class="literal">length</code> argument can be expressed in -any terms of length LaTeX understands, i.e., inches (<code class= -"literal">in</code>), millimetres (<code class= -"literal">mm</code>), points (<code class="literal">pt</code>), -etc.</p> -<h5 class="title"><a id="cmd-addtolength" name= -"cmd-addtolength"></a><code class= -"literal">\addtolength</code></h5> -<a id="idp7564992" class="indexterm" name="idp7564992"></a><a id= -"idp7565744" class="indexterm" name="idp7565744"></a> -<p><code class="literal">\addtolength{\gnat}{length}</code></p> -<p>The <code class="literal">\addtolength</code> command increments -<span class="emphasis"><em>length command</em></span> by the amount -specified in the <code class="literal">length</code> argument. It -can be a negative amount.</p> -<h5 class="title"><a id="cmd-settodepth" name= -"cmd-settodepth"></a><code class="literal">\settodepth</code></h5> -<a id="idp7570496" class="indexterm" name="idp7570496"></a> -<p><code class="literal">\settodepth{\gnat}{text}</code></p> -<p>The <code class="literal">\settodepth</code> command sets the -value of a <code class="literal">length</code> command equal to the -depth of the <code class="literal">text</code> argument.</p> -<h5 class="title"><a id="cmd-settoheight" name= -"cmd-settoheight"></a><code class= -"literal">\settoheight</code></h5> -<a id="idp7575488" class="indexterm" name="idp7575488"></a> -<p><code class="literal">\settoheight{\gnat}{text}</code></p> -<p>The <code class="literal">\settoheight</code> command sets the -value of a <code class="literal">length</code> command equal to the -height of the <code class="literal">text</code> argument.</p> -<h5 class="title"><a id="cmd-settowidth" name= -"cmd-settowidth"></a><code class="literal">\settowidth</code></h5> -<a id="idp7580480" class="indexterm" name="idp7580480"></a> -<p><code class="literal">\settowidth{\gnat}{text}</code></p> -<p>The <code class="literal">\settowidth</code> command sets the -value of a <code class="literal">length</code> command equal to the -width of the <code class="literal">text</code> argument.</p> -<h5 class="title"><a id="predefined-lengths-title" name= -"predefined-lengths-title"></a><code class="literal">Predefined -lengths</code></h5> -<a id="idp7585472" class="indexterm" name="idp7585472"></a><a id= -"idp7586224" class="indexterm" name="idp7586224"></a> -<p><a id="cmd-length-pre-width" name= -"cmd-length-pre-width"></a><code class="literal">\width</code> -<a id="idp7587968" class="indexterm" name="idp7587968"></a></p> -<p><a id="cmd-length-pre-height" name= -"cmd-length-pre-height"></a><code class="literal">\height</code> -<a id="idp7589840" class="indexterm" name="idp7589840"></a></p> -<p><a id="cmd-length-pre-depth" name= -"cmd-length-pre-depth"></a><code class="literal">\depth</code> -<a id="idp7591712" class="indexterm" name="idp7591712"></a></p> -<p><a id="cmd-length-pre-totalheight" name= -"cmd-length-pre-totalheight"></a><code class= -"literal">\totalheight</code> <a id="idp7593584" class="indexterm" -name="idp7593584"></a></p> -<p>These length parameters can be used in the arguments of the -box-making commands See <a class="link" 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. <code class= -"literal">\totalheight</code> equals <code class= -"literal">\height</code> + <code class="literal">\depth</code>. To -make a box with the text stretched to double the natural size, -e.g., say</p> -<p><code class="literal">\makebox[2\width]{Get a -stretcher}</code></p> -</div> -<div class="section" title="2.3.9 Letters"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="letters" name="letters"></a>2.3.9 -Letters</h4> -</div> -</div> -</div> -<a id="idp7599872" class="indexterm" name="idp7599872"></a><a id= -"idp7600624" class="indexterm" name="idp7600624"></a> -<p>You can use LaTeX to typeset letters, both personal and -business. The <code class="literal">letter</code> 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 <code class="filename">.tex</code> 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 <code class="literal">letter</code> -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 <code class= -"literal">\opening</code> command. The text of the letter follows. -It is typed as ordinary LaTeX input. Commands that make no sense in -a letter, like <code class="literal">\chapter</code>, do not work. -The letter closes with a <code class="literal">\closing</code> -command.</p> -<p>After the <code class="literal">closing</code>, you can have -additional material. The <code class="literal">\cc</code> command -produces the usual <span class="emphasis"><em>cc: ...</em></span>. -There's also a similar <code class="literal">\encl</code> command -for a list of enclosures. With both these commands, use -<code class="literal">\\</code> to separate the items.</p> -<p>These commands are used with the <code class= -"literal">letter</code> class:</p> -<h5 class="title"><a id="cmd-address" name= -"cmd-address"></a>\address</h5> -<a id="idp7614784" class="indexterm" name="idp7614784"></a> -<p><code class="literal">\address{Return address}</code></p> -<p>The return address, as it should appear on the letter and the -envelope. Separate lines of the address should be separated by -<code class="literal">\\</code> commands. If you do not make an -<code class="literal">\address</code> declaration, then the letter -will be formatted for copying onto your organisation's standard -letterhead. (See <a class="link" href="#overview" title= -"2.2 Overview of LaTeX and Local Guide">Overview</a>, for details -on your local implementation). If you give an <code class= -"literal">\address</code> declaration, then the letter will be -formatted as a personal letter.</p> -<h5 class="title"><a id="cmd-cc" name="cmd-cc"></a>\cc</h5> -<a id="idp7620624" class="indexterm" name="idp7620624"></a><a id= -"idp7621376" class="indexterm" name="idp7621376"></a> -<p><code class="literal">\cc{Kate Schechter\\Rob -McKenna}</code></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" name= -"cmd-closing"></a>\closing</h5> -<a id="idp7624384" class="indexterm" name="idp7624384"></a><a id= -"idp7625136" class="indexterm" name="idp7625136"></a> -<p><code class="literal">\closing{text}</code></p> -<p>The letter closes with a <code class="literal">\closing</code> -command, i.e.,</p> -<pre class="programlisting"> -\closing{Best Regards,} -</pre> -<h5 class="title"><a id="cmd-encl" name="cmd-encl"></a>\encl</h5> -<a id="idp7629264" class="indexterm" name="idp7629264"></a><a id= -"idp7630016" class="indexterm" name="idp7630016"></a> -<p><code class="literal">\encl{CV\\Certificates}</code></p> -<p>Generate a list of enclosed material.</p> -<h5 class="title"><a id="cmd-location" name= -"cmd-location"></a>\location</h5> -<a id="idp7632896" class="indexterm" name="idp7632896"></a> -<p><code class="literal">\location{address}</code></p> -<p>This modifies your organisation's standard address. This only -appears if the <code class="literal">firstpage</code> pagestyle is -selected.</p> -<h5 class="title"><a id="cmd-makelabels" name= -"cmd-makelabels"></a>\makelabels</h5> -<a id="idp7636496" class="indexterm" name="idp7636496"></a> -<p><code class="literal">\makelabels{number}</code></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" name="cmd-name"></a>\name</h5> -<a id="idp7639872" class="indexterm" name="idp7639872"></a> -<p><code class="literal">\name{June Davenport}</code></p> -<p>Your name, used for printing on the envelope together with the -return address.</p> -<h5 class="title"><a id="cmd-opening" name= -"cmd-opening"></a>\opening</h5> -<a id="idp7642848" class="indexterm" name="idp7642848"></a><a id= -"idp7643600" class="indexterm" name="idp7643600"></a> -<p><code class="literal">\opening{text}</code></p> -<p>The letter begins with the <code class="literal">\opening</code> -command. The mandatory argument, <code class="literal">text</code>, -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" name="cmd-ps"></a>\ps</h5> -<a id="idp7648432" class="indexterm" name="idp7648432"></a> -<p><code class="literal">\ps</code></p> -<p>Use this command before a postscript.</p> -<h5 class="title"><a id="cmd-signature" name= -"cmd-signature"></a>\signature</h5> -<a id="idp7651312" class="indexterm" name="idp7651312"></a> -<p><code class="literal">\signature{Harvey Swick}</code></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 <code class= -"literal">\\</code> commands.</p> -<h5 class="title"><a id="cmd-startbreaks" name= -"cmd-startbreaks"></a>\startbreaks</h5> -<a id="idp7655008" class="indexterm" name="idp7655008"></a> -<p><code class="literal">\startbreaks</code></p> -<p>Used after a <code class="literal">\stopbreaks</code> command to -allow page breaks again.</p> -<h5 class="title"><a id="cmd-stopbreaks" name= -"cmd-stopbreaks"></a>\stopbreaks</h5> -<a id="idp7658512" class="indexterm" name="idp7658512"></a> -<p><code class="literal">\stopbreaks</code></p> -<p>Inhibit page breaks until a <code class= -"literal">\startbreaks</code> command occurs.</p> -<h5 class="title"><a id="cmd-telephone" name= -"cmd-telephone"></a>\telephone</h5> -<a id="idp7662016" class="indexterm" name="idp7662016"></a> -<p><code class="literal">\telephone{number}</code></p> -<p>This is your telephone number. This only appears if the -<code class="literal">firstpage</code> pagestyle is selected.</p> -</div> -<div class="section" title="2.3.10 Line & Page Breaking"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="line-and-page-breaking" name= -"line-and-page-breaking"></a>2.3.10 Line & Page Breaking</h4> -</div> -</div> -</div> -<a id="idp7665984" class="indexterm" name="idp7665984"></a><a id= -"idp7666736" class="indexterm" name="idp7666736"></a><a id= -"idp7667488" class="indexterm" name="idp7667488"></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 <code class= -"literal">\\</code> command, but LaTeX usually does it for you.</p> -<h5 class="title"><a id="cmd-bslash" name="cmd-bslash"></a>\\</h5> -<a id="idp7671200" class="indexterm" name="idp7671200"></a><a id= -"idp7671952" class="indexterm" name="idp7671952"></a> -<p><code class="literal">\\[extra-space], -\\*[extra-space]</code></p> -<p>The <code class="literal">\\</code> command tells LaTeX to start -a new line. It has an optional argument, <code class= -"literal">extra-space</code>, that specifies how much extra -vertical space is to be inserted before the next line. This can be -a negative amount.</p> -<p>The <code class="literal">\\*</code> command is the same as the -ordinary <code class="literal">\\</code> 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" name= -"cmd-dash-op-hyphenation-cp"></a>\-</h5> -<a id="idp7678704" class="indexterm" name="idp7678704"></a><a id= -"idp7679456" class="indexterm" name="idp7679456"></a> -<p>The <code class="literal">\-</code> 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 <code class="literal">\-</code> command is used for the -exceptional cases.</p> -<p>Note that when you insert <code class="literal">\-</code> -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" name= -"cmd-cleardoublepage"></a>\cleardoublepage</h5> -<a id="idp7685120" class="indexterm" name="idp7685120"></a><a id= -"idp7685872" class="indexterm" name="idp7685872"></a> -<p>The <code class="literal">\cleardoublepage</code> 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" name= -"cmd-clearpage"></a>\clearpage</h5> -<a id="idp7688784" class="indexterm" name="idp7688784"></a><a id= -"idp7689536" class="indexterm" name="idp7689536"></a> -<p>The <code class="literal">\clearpage</code> 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" name= -"cmd-enlargethispage"></a>\enlargethispage</h5> -<a id="idp7692304" class="indexterm" name="idp7692304"></a><a id= -"idp7693056" class="indexterm" name="idp7693056"></a> -<p><code class="literal">\enlargethispage{size}</code></p> -<p><code class="literal">\enlargethispage*{size}</code></p> -<p>Enlarge the <code class="literal">\textheight</code> for the -current page by the specified amount; e.g. <code class= -"literal">\enlargethispage{\baselineskip}</code> 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 <code class="literal">\pagebreak</code>.</p> -<h5 class="title"><a id="cmd-samepage" name= -"cmd-samepage"></a>\samepage</h5> -<a id="idp7699312" class="indexterm" name="idp7699312"></a> -<p><code class="literal">\samepage</code></p> -<p>The object in the argument <code class="literal">{}</code> -should be on the current page.</p> -<h5 class="title"><a id="cmd-fussy" name= -"cmd-fussy"></a>\fussy</h5> -<a id="idp7702816" class="indexterm" name="idp7702816"></a> -<p><code class="literal">\fussy</code></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 <code class= -"literal">\sloppy</code> command. <a class="link" href= -"#cmd-sloppy" title="2.3.10. \sloppy">\sloppy</a></p> -<h5 class="title"><a id="cmd-hyphenation" name= -"cmd-hyphenation"></a>\hyphenation</h5> -<a id="idp7707856" class="indexterm" name="idp7707856"></a><a id= -"idp7708608" class="indexterm" name="idp7708608"></a> -<p><code class="literal">\hyphenation{words}</code></p> -<p>The <code class="literal">\hyphenation</code> command declares -allowed hyphenation points, where <code class= -"literal">words</code> is a list of words, separated by spaces, in -which each hyphenation point is indicated by a <code class= -"literal">-</code> character.</p> -<h5 class="title"><a id="cmd-linebreak" name= -"cmd-linebreak"></a>\linebreak</h5> -<a id="idp7713552" class="indexterm" name="idp7713552"></a><a id= -"idp7714304" class="indexterm" name="idp7714304"></a> -<p><code class="literal">\linebreak[number]</code></p> -<p>The <code class="literal">\linebreak</code> command tells LaTeX -to break the current line at the point of the command. With the -optional argument, <code class="literal">number</code>, you can -convert the <code class="literal">\linebreak</code> 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 <code class="literal">\linebreak</code> command causes LaTeX -to stretch the line so it extends to the right margin.</p> -<h5 class="title"><a id="cmd-newline" name= -"cmd-newline"></a>\newline</h5> -<a id="idp7721184" class="indexterm" name="idp7721184"></a><a id= -"idp7721936" class="indexterm" name="idp7721936"></a> -<p>The <code class="literal">\newline</code> command breaks the -line right where it is. It can only be used in paragraph mode.</p> -<h5 class="title"><a id="cmd-newpage" name= -"cmd-newpage"></a>\newpage</h5> -<a id="idp7724672" class="indexterm" name="idp7724672"></a><a id= -"idp7725424" class="indexterm" name="idp7725424"></a> -<p>The <code class="literal">\newpage</code> command ends the -current page. In contrast to <a class="link" href="#cmd-pagebreak" -title="2.3.10. \pagebreak">\pagebreak</a> it can produce a -partly empty page, even when <a class="link" href= -"#cmd-flushbottom-title" title= -"2.3.5. \flushbottom">\flushbottom</a> is active.</p> -<h5 class="title"><a id="cmd-nolinebreak" name= -"cmd-nolinebreak"></a>\nolinebreak</h5> -<a id="idp7729456" class="indexterm" name="idp7729456"></a> -<p><code class="literal">\nolinebreak[number]</code></p> -<p>The <code class="literal">\nolinebreak</code> command prevents -LaTeX from breaking the current line at the point of the command. -With the optional argument, <code class="literal">number</code>, -you can convert the <code class="literal">\nolinebreak</code> -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" name= -"cmd-nopagebreak"></a>\nopagebreak</h5> -<a id="idp7734864" class="indexterm" name="idp7734864"></a> -<p><code class="literal">\nopagebreak[number]</code></p> -<p>The <code class="literal">\nopagebreak</code> command prevents -LaTeX from breaking the current page at the point of the command. -With the optional argument, <code class="literal">number</code>, -you can convert the <code class="literal">\nopagebreak</code> -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" name= -"cmd-pagebreak"></a>\pagebreak</h5> -<a id="idp7740272" class="indexterm" name="idp7740272"></a><a id= -"idp7741024" class="indexterm" name="idp7741024"></a> -<p><code class="literal">\pagebreak[number]</code></p> -<p>The <code class="literal">\pagebreak</code> command tells LaTeX -to break the current page at the point of the command. With the -optional argument, <code class="literal">number</code>, you can -convert the <code class="literal">\pagebreak</code> 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" name= -"cmd-sloppy"></a>\sloppy</h5> -<a id="idp7746448" class="indexterm" name="idp7746448"></a> -<p><code class="literal">\sloppy</code></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 <code class="literal">\fussy</code> command is -issued. <a class="link" href="#cmd-fussy" title= -"2.3.10. \fussy">\fussy</a>.</p> -</div> -<div class="section" title="2.3.11 Making Paragraphs"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="making-paragraphs" name= -"making-paragraphs"></a>2.3.11 Making Paragraphs</h4> -</div> -</div> -</div> -<a id="idp7751872" class="indexterm" name="idp7751872"></a><a id= -"idp7752624" class="indexterm" name="idp7752624"></a> -<p>A paragraph is ended by one or more completely blank lines --- -lines not containing even a <code class="literal">%</code>. 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" name= -"cmd-indent"></a>\indent</h5> -<a id="idp7755536" class="indexterm" name="idp7755536"></a><a id= -"idp7756288" class="indexterm" name="idp7756288"></a> -<p><code class="literal">\indent</code></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" name= -"cmd-noindent"></a>\noindent</h5> -<a id="idp7759376" class="indexterm" name="idp7759376"></a><a id= -"idp7760128" class="indexterm" name="idp7760128"></a> -<p><code class="literal">\noindent</code></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" name="cmd-par"></a>\par</h5> -<a id="idp7763184" class="indexterm" name="idp7763184"></a><a id= -"idp7763936" class="indexterm" name="idp7763936"></a> -<p>Equivalent to a blank line; often used to make command or -environment definitions easier to read.</p> -</div> -<div class="section" title="2.3.12 Margin Notes"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="margin-notes" name= -"margin-notes"></a>2.3.12 Margin Notes</h4> -</div> -</div> -</div> -<a id="idp7766448" class="indexterm" name="idp7766448"></a><a id= -"idp7767200" class="indexterm" name="idp7767200"></a><a id= -"idp7767952" class="indexterm" name="idp7767952"></a> -<p>The command <code class="literal">\marginpar[left]{right}</code> -creates a note in the margin. The first line will be at the same -height as the line in the text where the <code class= -"literal">\marginpar</code> occurs.</p> -<p>When you only specify the mandatory argument <code class= -"literal">right</code>, the text will be placed</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">in the right margin for one-sided layout</li> -<li class="listitem">in the outside margin for two-sided -layout</li> -<li class="listitem">in the nearest margin for two-column -layout.</li> -</ul> -</div> -<p>By issuing the command <code class= -"literal">\reversemarginpar</code>, you can force the marginal -notes to go into the opposite (inside) margin.</p> -<p>When you specify both arguments, <code class= -"literal">left</code> is used for the left margin, and <code class= -"literal">right</code> 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 <code class= -"literal">\hspace{0pt}</code> command.</p> -</div> -<div class="section" title="2.3.13 Math Formulae"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="math-formulae" name= -"math-formulae"></a>2.3.13 Math Formulae</h4> -</div> -</div> -</div> -<a id="idp7779168" class="indexterm" name="idp7779168"></a><a id= -"idp7779920" class="indexterm" name="idp7779920"></a><a id= -"idp7780672" class="indexterm" name="idp7780672"></a><a id= -"idp7781424" class="indexterm" name="idp7781424"></a><a id= -"idp7782176" class="indexterm" name="idp7782176"></a><a id= -"idp7782928" class="indexterm" name="idp7782928"></a><a id= -"idp7783680" class="indexterm" name="idp7783680"></a><a id= -"idp7784432" class="indexterm" name="idp7784432"></a> -<div class="table"><a id="table-math-mode" name= -"table-math-mode"></a> -<p class="title"><strong>Table 1.7. Three environments -that put LaTeX in math mode</strong></p> -<div class="table-contents"> -<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> -</div> -<br class="table-break" /> -<p>The <code class="literal">math</code> environment can be used in -both paragraph and LR mode, but the <code class= -"literal">displaymath</code> and <code class= -"literal">equation</code> environments can be used only in -paragraph mode. The <code class="literal">math</code> and -<code class="literal">displaymath</code> 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 <code class="literal">math</code> environment is so -common that it has an even shorter form:</p> -<pre class="programlisting"> -$ ... $ instead of \(...\) -</pre> -<a id="idp7799472" class="indexterm" name="idp7799472"></a> -<h5 class="title"><a id="subscripts-and-superscripts-title" name= -"subscripts-and-superscripts-title"></a>Subscripts & -Superscripts</h5> -<a id="idp7801088" class="indexterm" name="idp7801088"></a><a id= -"idp7801840" class="indexterm" name="idp7801840"></a><a id= -"idp7802592" class="indexterm" name="idp7802592"></a><a id= -"idp7803344" class="indexterm" name="idp7803344"></a> -<p>To get an expression <span class="emphasis"><em>exp</em></span> -to appear as a subscript, you just type <code class= -"literal">_{</code><span class= -"emphasis"><em>exp</em></span><code class="literal">}</code> . To -get <span class="emphasis"><em>exp</em></span> to appear as a -superscript, you type <code class="literal">^{</code><span class= -"emphasis"><em>exp</em></span> <code class="literal">}</code>. -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" name= -"math-symbols-title"></a>Math Symbols</h5> -<a id="idp7809568" class="indexterm" name="idp7809568"></a><a id= -"idp7810320" class="indexterm" name="idp7810320"></a><a id= -"idp7811072" class="indexterm" name="idp7811072"></a> -<h5 class="title"><a id="spacing-in-math-mode-title" name= -"spacing-in-math-mode-title"></a>Spacing in Math Mode</h5> -<a id="idp7812688" class="indexterm" name="idp7812688"></a><a id= -"idp7813440" class="indexterm" name="idp7813440"></a> -<p>In a <code class="literal">math</code> 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="idp7816656" class="indexterm" name="idp7816656"></a><a id= -"idp7817408" class="indexterm" name="idp7817408"></a><a id= -"idp7818160" class="indexterm" name="idp7818160"></a><a id= -"idp7818912" class="indexterm" name="idp7818912"></a> -<div class="orderedlist"> -<ol class="orderedlist" type="1"> -<li class="listitem"> -<p><code class="literal">\;</code> - a thick space</p> -</li> -<li class="listitem"> -<p><code class="literal">\:</code> - a medium space</p> -</li> -<li class="listitem"> -<p><code class="literal">\,</code> - a thin space</p> -</li> -<li class="listitem"> -<p><code class="literal">\!</code> - a negative thin space</p> -</li> -</ol> -</div> -<h5 class="title"><a id="math-miscellany-title" name= -"math-miscellany-title"></a>Math Miscellany</h5> -<a id="idp7825808" class="indexterm" name="idp7825808"></a> -<div class="table"><a id="table-math-miscellany" name= -"table-math-miscellany"></a> -<p class="title"><strong>Table 1.8. Math -Miscellany</strong></p> -<div class="table-contents"> -<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" name= -"cmd-math-misc-cdots"></a>\cdots<a id="idp7830896" class= -"indexterm" name="idp7830896"></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" name= -"cmd-math-misc-ddots"></a>\ddots <a id="idp7833520" class= -"indexterm" name="idp7833520"></a></td> -<td align="justify">Produces a diagonal ellipsis.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-frac" name= -"cmd-math-misc-frac"></a>\frac{num}{den} <a id="idp7835776" class= -"indexterm" name="idp7835776"></a></td> -<td align="justify">Produces the fraction <code class= -"literal">num</code> divided by <code class= -"literal">den</code>.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-ldots" name= -"cmd-math-misc-ldots"></a>\ldots <a id="idp7839280" class= -"indexterm" name="idp7839280"></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" name= -"cmd-math-misc-overbrace"></a>\overbrace{text} <a id="idp7841632" -class="indexterm" name="idp7841632"></a></td> -<td align="justify">Generates a brace over text.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-overline" name= -"cmd-math-misc-overline"></a>\overline{text} <a id="idp7843888" -class="indexterm" name="idp7843888"></a></td> -<td align="justify">Causes the argument text to be overlined.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-sqrt" name= -"cmd-math-misc-sqrt"></a>\sqrt[root]{arg} <a id="idp7846144" class= -"indexterm" name="idp7846144"></a></td> -<td align="justify">Produces the square root of its argument. The -optional argument, <code class="literal">root</code>, determines -what root to produce, i.e., the cube root of <code class= -"literal">x+y</code> would be typed as <code class= -"literal">$\sqrt[3]{x+y}$</code>.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-underbrace" name= -"cmd-math-misc-underbrace"></a>\underbrace{text} <a id="idp7850448" -class="indexterm" name="idp7850448"></a></td> -<td align="justify">Generates text with a brace underneath.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-underline" name= -"cmd-math-misc-underline"></a>\underline{text} <a id="idp7852704" -class="indexterm" name="idp7852704"></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" name= -"cmd-math-misc-vdots"></a>\vdots <a id="idp7855216" class= -"indexterm" name="idp7855216"></a></td> -<td align="justify">Produces a vertical ellipsis.</td> -</tr> -<tr> -<td align="left"><a id="cmd-math-misc-ensuremath" name= -"cmd-math-misc-ensuremath"></a>\ensuremath{} <a id="idp7857600" -class="indexterm" name="idp7857600"></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> -<br class="table-break" /></div> -<div class="section" title="2.3.14 Modes"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="modes" name="modes"></a>2.3.14 Modes</h4> -</div> -</div> -</div> -<a id="idp7860720" class="indexterm" name="idp7860720"></a><a id= -"idp7861472" class="indexterm" name="idp7861472"></a><a id= -"idp7862224" class="indexterm" name="idp7862224"></a><a id= -"idp7862976" class="indexterm" name="idp7862976"></a><a id= -"idp7863728" class="indexterm" name="idp7863728"></a> -<p>When LaTeX is processing your input text, it is always in one of -three modes:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">paragraph mode</li> -<li class="listitem">Math mode</li> -<li class="listitem">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 <code class= -"literal">\mbox</code>, 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 -<code class="literal">\mbox</code> 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 <code class="literal">parbox</code>. -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" title="2.3.15 Page Styles"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="page-styles" name="page-styles"></a>2.3.15 -Page Styles</h4> -</div> -</div> -</div> -<a id="idp7879632" class="indexterm" name="idp7879632"></a><a id= -"idp7880384" class="indexterm" name="idp7880384"></a> -<p>The <code class="literal">\documentclass</code> 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" name= -"cmd-maketitle"></a>\maketitle</h5> -<a id="idp7883152" class="indexterm" name="idp7883152"></a><a id= -"idp7883904" class="indexterm" name="idp7883904"></a> -<p><code class="literal">\maketitle</code></p> -<p>The <code class="literal">\maketitle</code> command generates a -title on a separate title page. In the <code class= -"literal">article</code> class, <code class= -"literal">\maketitle</code> will also switch to pagestyle -<code class="literal">plain</code>. See <a class="link" 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 class="link" 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" name= -"cmd-author"></a>\author</h5> -<a id="idp7891680" class="indexterm" name="idp7891680"></a><a id= -"idp7892432" class="indexterm" name="idp7892432"></a> -<p><code class="literal">\author{names}</code></p> -<p>The <code class="literal">\author</code> command declares the -author(s), where <code class="literal">names</code> is a list of -authors separated by <code class="literal">\and</code> commands. -Use <code class="literal">\\</code> 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" name="cmd-date"></a>\date</h5> -<a id="idp7897952" class="indexterm" name="idp7897952"></a><a id= -"idp7898704" class="indexterm" name="idp7898704"></a> -<p><code class="literal">\date{text}</code></p> -<p>The <code class="literal">\date</code> command declares -<span class="emphasis"><em>text</em></span> to be the document's -date. With no <code class="literal">\date</code> command, the -current date is used.</p> -<h5 class="title"><a id="cmd-thanks" name= -"cmd-thanks"></a>\thanks</h5> -<a id="idp7903216" class="indexterm" name="idp7903216"></a><a id= -"idp7903968" class="indexterm" name="idp7903968"></a> -<p><code class="literal">\thanks{text}</code></p> -<p>The <code class="literal">\thanks</code> command produces a -<code class="literal">\footnote</code> to the title.</p> -<h5 class="title"><a id="cmd-title" name= -"cmd-title"></a>\title</h5> -<a id="idp7908096" class="indexterm" name="idp7908096"></a><a id= -"idp7908848" class="indexterm" name="idp7908848"></a> -<p><code class="literal">\title{text}</code></p> -<p>The <code class="literal">\title</code> command declares -<code class="literal">text</code> to be the title. Use <code class= -"literal">\\</code> to tell LaTeX where to start a new line in a -long title.</p> -<h5 class="title"><a id="cmd-pagenumbering" name= -"cmd-pagenumbering"></a>\pagenumbering</h5> -<a id="idp7913984" class="indexterm" name="idp7913984"></a><a id= -"idp7914736" class="indexterm" name="idp7914736"></a> -<p><code class="literal">\pagenumbering{num_style}</code></p> -<p>Specifies the style of page numbers. Possible values of -<code class="literal">num_style</code> are:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">arabic</code> - Arabic -numerals</li> -<li class="listitem"><code class="literal">roman</code> - Lowercase -Roman numerals</li> -<li class="listitem"><code class="literal">Roman</code> - Uppercase -Roman numerals</li> -<li class="listitem"><code class="literal">alph</code> - Lowercase -letters</li> -<li class="listitem"><code class="literal">Alph</code> - Uppercase -letters</li> -</ul> -</div> -<h5 class="title"><a id="cmd-pagestyle" name= -"cmd-pagestyle"></a>\pagestyle</h5> -<a id="idp7924624" class="indexterm" name="idp7924624"></a> -<p><code class="literal">\pagestyle{option}</code></p> -<p>The <code class="literal">\pagestyle</code> 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">plain</code> - Just a -plain page number.</li> -<li class="listitem"><code class="literal">empty</code> - Produces -empty heads and feet - no page numbers.</li> -<li class="listitem"><code class="literal">headings</code> - Puts -running headings on each page. The document style specifies what -goes in the headings.</li> -<li class="listitem"><code class="literal">myheadings</code> - You -specify what is to go in the heading with the <code class= -"literal">\markboth</code> or the <code class= -"literal">\markright</code> commands.</li> -</ul> -</div> -<h5 class="title"><a id="cmd-markboth" name= -"cmd-markboth"></a>\markboth</h5> -<a id="idp7935344" class="indexterm" name="idp7935344"></a> -<pre class="programlisting"> -\markboth{left head}{right head} -</pre> -<p>The <code class="literal">\markboth</code> command is used in -conjunction with the page style <code class= -"literal">myheadings</code> 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 <code class="literal">\markboth</code> command before the end -of the page, while a <span class="emphasis"><em>right-hand -heading</em></span> is generated by the first <code class= -"literal">\markboth</code> or <code class= -"literal">\markright</code> 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" name= -"cmd-markright"></a>\markright</h5> -<a id="idp7942144" class="indexterm" name="idp7942144"></a> -<pre class="programlisting"> -\markright{right head} -</pre> -<p>The <code class="literal">\markright</code> command is used in -conjunction with the page style <code class= -"literal">myheadings</code> 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 <code class="literal">\markboth</code> command before the end -of the page, while a <span class="emphasis"><em>right-hand -heading</em></span> is generated by the first <code class= -"literal">\markboth</code> or <code class= -"literal">\markright</code> 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" name= -"cmd-thispagestyle"></a>\thispagestyle</h5> -<a id="idp7948960" class="indexterm" name="idp7948960"></a> -<p><code class="literal">\thispagestyle{option}</code></p> -<p>The <code class="literal">\thispagestyle</code> command works in -the same manner as the <code class="literal">\pagestyle</code> -command except that it changes the style for the current page -only.</p> -</div> -<div class="section" title="2.3.16 Sectioning"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="sectioning" name="sectioning"></a>2.3.16 -Sectioning</h4> -</div> -</div> -</div> -<a id="idp7953568" class="indexterm" name="idp7953568"></a><a id= -"idp7954320" class="indexterm" name="idp7954320"></a><a id= -"idp7955072" class="indexterm" name="idp7955072"></a><a id= -"idp7955824" class="indexterm" name="idp7955824"></a><a id= -"idp7956576" class="indexterm" name="idp7956576"></a><a id= -"idp7957328" class="indexterm" name="idp7957328"></a> -<p>Sectioning commands provide the means to structure your text -into units.</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a id="cmd-sectioning-part" name= -"cmd-sectioning-part"></a><code class="literal">\part</code></li> -<li class="listitem"><a id="cmd-sectioning-chapter" name= -"cmd-sectioning-chapter"></a><code class="literal">\chapter</code> -(report and book class only)</li> -<li class="listitem"><a id="cmd-sectioning-section" name= -"cmd-sectioning-section"></a><code class= -"literal">\section</code></li> -<li class="listitem"><a id="cmd-sectioning-subsection" name= -"cmd-sectioning-subsection"></a><code class= -"literal">\subsection</code></li> -<li class="listitem"><a id="cmd-sectioning-subsubsection" name= -"cmd-sectioning-subsubsection"></a><code class= -"literal">\subsubsection</code></li> -<li class="listitem"><a id="cmd-sectioning-paragraph" name= -"cmd-sectioning-paragraph"></a><code class= -"literal">\paragraph</code></li> -<li class="listitem"><a id="cmd-sectioning-subparagraph" name= -"cmd-sectioning-subparagraph"></a><code class= -"literal">\subparagraph</code></li> -</ul> -</div> -<p>All sectioning commands take the same general form, i.e.,</p> -<p><code class="literal">\chapter[optional]{title}</code></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 class="orderedlist" type="1"> -<li class="listitem"> -<p>The table of contents</p> -</li> -<li class="listitem"> -<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 <code class= -"literal">optional</code> argument that provides the text for these -other two purposes.</p> -<p>All sectioning commands have <code class= -"literal">*</code>-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="idp7975504" class="indexterm" name="idp7975504"></a><a id= -"idp7976256" class="indexterm" name="idp7976256"></a> -<p><a id="cmd-sectioning-appendix" name= -"cmd-sectioning-appendix"></a><code class= -"literal">\appendix</code></p> -<p>The <code class="literal">\appendix</code> command changes the -way sectional units are numbered. The <code class= -"literal">\appendix</code> 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" title="2.3.17 Spaces & Boxes"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="spaces-and-boxes" name= -"spaces-and-boxes"></a>2.3.17 Spaces & Boxes</h4> -</div> -</div> -</div> -<a id="idp7981952" class="indexterm" name="idp7981952"></a><a id= -"idp7982704" class="indexterm" name="idp7982704"></a> -<p>All the predefined length parameters See <a class="link" href= -"#predefined-lengths-title" title= -"2.3.8. Predefined lengths">Predefined lengths</a> can be used -in the arguments of the box-making commands.</p> -<h5 class="title"><a id="cmd-dotfill" name= -"cmd-dotfill"></a>\dotfill</h5> -<a id="idp7985408" class="indexterm" name="idp7985408"></a> -<p>The <code class="literal">\dotfill</code> 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" name= -"cmd-hfill"></a>\hfill</h5> -<a id="idp7988416" class="indexterm" name="idp7988416"></a> -<p>The <code class="literal">\hfill</code> 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" name= -"cmd-hrulefill"></a>\hrulefill</h5> -<a id="idp7991520" class="indexterm" name="idp7991520"></a> -<p>The <code class="literal">\hrulefill</code> 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" name= -"cmd-hspace"></a>\hspace</h5> -<a id="idp7994640" class="indexterm" name="idp7994640"></a> -<p><code class="literal">\hspace{length}, -\hspace*{length}</code></p> -<p>The <code class="literal">\hspace</code> 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 <code class= -"literal">\hspace</code> 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 -<code class="literal">*</code> argument. Then the space is never -removed.</p> -<h5 class="title"><a id="cmd-addvspace" name= -"cmd-addvspace"></a>\addvspace</h5> -<a id="idp8001216" class="indexterm" name="idp8001216"></a><a id= -"idp8001968" class="indexterm" name="idp8001968"></a><a id= -"idp8002720" class="indexterm" name="idp8002720"></a> -<p><code class="literal">\addvspace{length}</code></p> -<p>The <code class="literal">\addvspace</code> 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 <code class="literal">\addvspace</code> command, then this -command will not add more space than needed to make the natural -length of the total vertical space equal to <code class= -"literal">length</code>.</p> -<h5 class="title"><a id="cmd-bigskip" name= -"cmd-bigskip"></a>\bigskip</h5> -<a id="idp8008256" class="indexterm" name="idp8008256"></a> -<p>The <code class="literal">\bigskip</code> command is equivalent -to <code class="literal">\vspace{bigskipamount}</code> where -<code class="literal">bigskipamount</code> is determined by the -document class.</p> -<h5 class="title"><a id="cmd-medskip" name= -"cmd-medskip"></a>\medskip</h5> -<a id="idp8012864" class="indexterm" name="idp8012864"></a> -<p>The <code class="literal">\medskip</code> command is equivalent -to <code class="literal">\vspace{medskipamount}</code> where -<code class="literal">medskipamount</code> is determined by the -document class.</p> -<h5 class="title"><a id="cmd-smallskip" name= -"cmd-smallskip"></a>\smallskip</h5> -<a id="idp8017408" class="indexterm" name="idp8017408"></a> -<p><code class="literal">\smallskip</code></p> -<p>The <code class="literal">\smallskip</code> command is -equivalent to <code class="literal">\vspace{smallskipamount}</code> -where <code class="literal">smallskipamount</code> is determined by -the document class.</p> -<h5 class="title"><a id="cmd-vfill" name= -"cmd-vfill"></a>\vfill</h5> -<a id="idp8022928" class="indexterm" name="idp8022928"></a> -<p>The <code class="literal">\vfill</code> fill command produces a -rubber length which can stretch or shrink vertically.</p> -<h5 class="title"><a id="cmd-vspace" name= -"cmd-vspace"></a>\vspace</h5> -<a id="idp8026048" class="indexterm" name="idp8026048"></a> -<p><code class="literal">\vspace{length}, -\vspace*{length}</code></p> -<p>The <code class="literal">\vspace</code> 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 <code class= -"literal">\vspace</code> 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 -<code class="literal">*</code> argument. Then the space is never -removed.</p> -<h5 class="title"><a id="cmd-fbox" name="cmd-fbox"></a>\fbox</h5> -<a id="idp8033392" class="indexterm" name="idp8033392"></a> -<p><code class="literal">\fbox{text}</code></p> -<p>The <code class="literal">\fbox</code> command is exactly the -same as the <code class="literal">\mbox</code> command, except that -it puts a frame around the outside of the box that it creates.</p> -<h5 class="title"><a id="cmd-framebox" name= -"cmd-framebox"></a>\framebox</h5> -<a id="idp8037904" class="indexterm" name="idp8037904"></a> -<p><code class= -"literal">\framebox[width][position]{text}</code></p> -<p>The <code class="literal">\framebox</code> command is exactly -the same as the <code class="literal">\makebox</code> 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 <code class= -"literal">\fboxrule</code>, and leaves a space <code class= -"literal">\fboxsep</code> between the rule and the contents of the -box.</p> -<h5 class="title"><a id="env-lrbox" name="env-lrbox"></a>lrbox</h5> -<a id="idp8044752" class="indexterm" name="idp8044752"></a> -<p><code class="literal">\begin{lrbox}{cmd} text -\end{lrbox}</code></p> -<p>This is the environment form of <code class= -"literal">\sbox</code>.</p> -<p>The text inside the environment is saved in the box <code class= -"literal">cmd</code>, which must have been declared with -<code class="literal">\newsavebox</code>.</p> -<h5 class="title"><a id="cmd-makebox" name= -"cmd-makebox"></a>\makebox</h5> -<a id="idp8050640" class="indexterm" name="idp8050640"></a> -<p><code class="literal">\makebox[width][position]{text}</code></p> -<p>The <code class="literal">\makebox</code> command creates a box -just wide enough to contain the <code class="literal">text</code> -specified. The width of the box is specified by the optional -<code class="literal">width</code> argument. The position of the -text within the box is determined by the optional <code class= -"literal">position</code> argument.</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">c</code> --- centred -(default)</li> -<li class="listitem"><code class="literal">l</code> --- -flushleft</li> -<li class="listitem"><code class="literal">r</code> --- -flushright</li> -<li class="listitem"><code class="literal">s</code> --- stretch -from left to right margin. The text must contain stretchable space -for this to work.</li> -</ul> -</div> -<p>See <a class="link" href="#cmd-makebox-op-picture-cp" title= -"2.3.6. \makebox(width,height)[position]{...}">\makebox -(picture)</a>.</p> -<h5 class="title"><a id="cmd-mbox" name="cmd-mbox"></a>\mbox</h5> -<a id="idp8064032" class="indexterm" name="idp8064032"></a> -<p><code class="literal">\mbox{text}</code></p> -<p>The <code class="literal">\mbox</code> 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" name= -"cmd-newsavebox"></a>\newsavebox</h5> -<a id="idp8068592" class="indexterm" name="idp8068592"></a> -<p><code class="literal">\newsavebox{cmd}</code></p> -<p>Declares <code class="literal">cmd</code>, 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" name= -"cmd-parbox"></a>\parbox</h5> -<a id="idp8072704" class="indexterm" name="idp8072704"></a> -<p><code class= -"literal">\parbox[position][height][inner-pos]{width}{text}</code></p> -<p>A <code class="literal">parbox</code> is a box whose contents -are created in <code class="literal">paragraph</code> mode. The -<code class="literal">\parbox</code> has two mandatory -arguments:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">width</code> - specifies -the width of the parbox, and</li> -<li class="listitem"><code class="literal">text</code> - the text -that goes inside the parbox.</li> -</ul> -</div> -<p>LaTeX will position a <code class="literal">parbox</code> 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">t</code> --- text is -placed at the top of the box.</li> -<li class="listitem"><code class="literal">c</code> --- text is -centred in the box.</li> -<li class="listitem"><code class="literal">b</code> --- text is -placed at the bottom of the box.</li> -<li class="listitem"><code class="literal">s</code> --- stretch -vertically. The text must contain vertically stretchable space for -this to work.</li> -</ul> -</div> -<p>A <code class="literal">\parbox</code> 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 <code class="literal">\parbox</code> -argument. For larger pieces of text, including ones containing a -paragraph-making environment, you should use a <code class= -"literal">minipage</code> environment See <a class="link" href= -"#env-minipage" title="2.3.6. minipage">minipage</a>.</p> -<h5 class="title"><a id="cmd-raisebox" name= -"cmd-raisebox"></a>\raisebox</h5> -<a id="idp8094976" class="indexterm" name="idp8094976"></a> -<p><code class= -"literal">\raisebox{distance}[extend-above][extend-below]{text}</code></p> -<p>The <code class="literal">\raisebox</code> 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 <code class="literal">LR -mode</code>.</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 <code class= -"literal">\raisebox</code> command lets you tell LaTeX how tall it -is.</p> -<p>The first optional argument, <code class= -"literal">extend-above</code>, makes LaTeX think that the text -extends above the line by the amount specified. The second optional -argument, <code class="literal">extend-below</code>, makes LaTeX -think that the text extends below the line by the amount -specified.</p> -<h5 class="title"><a id="cmd-rule" name="cmd-rule"></a>\rule</h5> -<a id="idp8105536" class="indexterm" name="idp8105536"></a> -<p><code class= -"literal">\rule[raise-height]{width}{thickness}</code></p> -<p>The <code class="literal">\rule</code> command is used to -produce horizontal lines. The arguments are defined as follows:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">raise-height</code> - -specifies how high to raise the rule (optional)</li> -<li class="listitem"><code class="literal">width</code> - specifies -the length of the rule (mandatory)</li> -<li class="listitem"><code class="literal">thickness</code> - -specifies the thickness of the rule (mandatory)</li> -</ul> -</div> -<h5 class="title"><a id="cmd-savebox" name= -"cmd-savebox"></a>\savebox</h5> -<a id="idp8114176" class="indexterm" name="idp8114176"></a> -<p><code class="literal">\savebox{cmd}[width][pos]{text}</code></p> -<p>This command typeset <code class="literal">text</code> in a box -just as for <code class="literal">\makebox</code>. However, instead -of printing the resulting box, it saves it in bin <code class= -"literal">cmd</code>, which must have been declared with -<code class="literal">\newsavebox</code>.</p> -<h5 class="title"><a id="cmd-sbox" name="cmd-sbox"></a>\sbox</h5> -<a id="idp8120368" class="indexterm" name="idp8120368"></a> -<p><code class="literal">\sbox{cmd}\{text}</code></p> -<p>This commands typesets <code class="literal">text</code> in a -box just as for <code class="literal">\mbox</code>. However, -instead of printing the resulting box, it saves it in <code class= -"literal">cmd</code>, which must have been declared with -<code class="literal">\newsavebox</code>.</p> -<h5 class="title"><a id="cmd-usebox" name= -"cmd-usebox"></a>\usebox</h5> -<a id="idp8126672" class="indexterm" name="idp8126672"></a> -<p><code class="literal">\usebox{cmd}</code></p> -<p>Prints the box most recently saved in bin <code class= -"literal">cmd</code> by a <code class="literal">\savebox</code> -command.</p> -</div> -<div class="section" title="2.3.18 Special Characters"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="special-characters" name= -"special-characters"></a>2.3.18 Special Characters</h4> -</div> -</div> -</div> -<a id="idp8132064" class="indexterm" name="idp8132064"></a><a id= -"idp8132880" class="indexterm" name="idp8132880"></a><a id= -"idp8133696" class="indexterm" name="idp8133696"></a><a id= -"idp8134512" class="indexterm" name="idp8134512"></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 <code class= -"literal">\</code> in front of the character. For example, -<code class="literal">\$</code> will produce <code class= -"literal">$</code> in your output.</p> -<p>One exception to this rule is the <code class="literal">\</code> -itself because <code class="literal">\\</code> has its own special -meaning. A <code class="literal">\</code> is produced by typing -<code class="literal">$\backslash$</code> in your file.</p> -<p>Also, <code class="literal">\~</code> means `place a tilde -accent over the following letter', so you will probably want to use -<code class="literal">\verb</code> instead.</p> -<a id="idp8145728" class="indexterm" name="idp8145728"></a><a id= -"idp8146544" class="indexterm" name="idp8146544"></a><a id= -"idp8147360" class="indexterm" name="idp8147360"></a> -<p>In addition, you can access any character of a font once you -know its number by using the <code class="literal">\symbol</code> -command. For example, the character used for displaying spaces in -the <code class="literal">\verb*</code> command has the code -decimal 32, so it can be typed as <code class= -"literal">\symbol{32}</code>.</p> -<p>You can also specify octal numbers with <code class= -"literal">'</code> or hexadecimal numbers with <code class= -"literal">"</code>, so the previous example could also be written -as <code class="literal">\symbol{'40}</code> or <code class= -"literal">\symbol{"20}</code>.</p> -</div> -<div class="section" title="2.3.19 Special Symbols"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="special-symbols" name= -"special-symbols"></a>2.3.19 Special Symbols</h4> -</div> -</div> -</div> -<a id="idp8156048" class="indexterm" name="idp8156048"></a> -<h5 class="title"><a id="accents-on-chars-title" name= -"accents-on-chars-title"></a>Accents on Characters</h5> -<a id="idp8158960" class="indexterm" name="idp8158960"></a> -<p>The rules differ somewhat depending whether you are in <a class= -"link" href="#modes" title="2.3.14 Modes">text mode</a>, <a class= -"link" href="#modes" title="2.3.14 Modes">math modes</a>, or the -<a class="link" href="#env-tabbing" title= -"2.3.6. tabbing">tabbing environment</a>.</p> -<h5 class="title"><a id="idp8163120" name="idp8163120"></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, <code class="literal">\~{}</code> 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\`{o}</code> produces a -grave accent, <span class="emphasis"><em>ò</em></span></li> -<li class="listitem"><code class="literal">\'{o}</code> produces an -acute accent, <span class="emphasis"><em>ó</em></span></li> -<li class="listitem"><code class="literal">\^{o}</code> produces a -circumflex, <span class="emphasis"><em>ô</em></span></li> -<li class="listitem"><code class="literal">\"{o}</code> produces an -umlaut or dieresis, <span class= -"emphasis"><em>ö</em></span></li> -<li class="listitem"><code class="literal">\H{o}</code> produces a -long Hungarian umlaut</li> -<li class="listitem"><code class="literal">\~{o}</code> produces a -tilde, <span class="emphasis"><em>õ</em></span></li> -<li class="listitem"><code class="literal">\c{c}</code> produces a -cedilla, <span class="emphasis"><em>ç</em></span></li> -<li class="listitem"><code class="literal">\={o}</code> produces a -macron accent (a bar over the letter)</li> -<li class="listitem"><code class="literal">\b{o}</code> produces a -bar under the letter</li> -<li class="listitem"><code class="literal">\.{o}</code> produces a -dot over the letter</li> -<li class="listitem"><code class="literal">\d{o}</code> produces a -dot under the letter</li> -<li class="listitem"><code class="literal">\u{o}</code> produces a -breve over the letter</li> -<li class="listitem"><code class="literal">\v{o}</code> produces a -<span class="emphasis"><em>v</em></span> over the letter</li> -<li class="listitem"><code class="literal">\t{oo}</code> 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 -<code class="literal">\i</code> and <code class="literal">\j</code> -can be used to produce dotless letters.</p> -<p>For example,</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\^{\i}</code> should be -used for i, circumflex, î</li> -<li class="listitem"><code class="literal">\"{\i}</code> should be -used for i, umlaut, ï</li> -</ul> -</div> -<h5 class="title"><a id="accents-chars-math" name= -"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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\hat{o}</code> is -similar to the circumflex (cf. <code class= -"literal">\^</code>)</li> -<li class="listitem"><code class="literal">\widehat{oo}</code> is a -wide version of <span class="emphasis"><em>\hat</em></span> over -several letters</li> -<li class="listitem"><code class="literal">\check{o}</code> is a -vee or check (cf. <code class="literal">\v</code>)</li> -<li class="listitem"><code class="literal">\tilde{o}</code> is a -tilde (cf. <code class="literal">\~</code>)</li> -<li class="listitem"><code class="literal">\widetilde{oo}</code> is -a wide version of <code class="literal">\tilde</code> over several -letters</li> -<li class="listitem"><code class="literal">\acute{o}</code> is an -acute accent (cf. <code class="literal">\`</code>)</li> -<li class="listitem"><code class="literal">\grave{o}</code> is a -grave accent (cf. <code class="literal">>\'</code>)</li> -<li class="listitem"><code class="literal">\dot{o}</code> is a dot -over the letter (cf. <code class="literal">\.</code>)</li> -<li class="listitem"><code class="literal">\ddot{o}</code> is a -double dot over the letter</li> -<li class="listitem"><code class="literal">\breve{o}</code> is a -breve (cf. <code class="literal">\u</code>)</li> -<li class="listitem"><code class="literal">\bar{o}</code> is a -macron (cf. <code class="literal">\=</code>)</li> -<li class="listitem"><code class="literal">\vec{o}</code> is a -vector (arrow) over the letter</li> -</ul> -</div> -<h5 class="title"><a id="accents-chars-tabbing" name= -"accents-chars-tabbing"></a>Tabbing Environment</h5> -<p>Some of the accent marks used in running text have other uses in -the <a class="link" href="#env-tabbing" title= -"2.3.6. tabbing">Tabbing Environment</a>. In that case they -can be created with the following command:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">>\a'</code> for an -acute accent</li> -<li class="listitem"><code class="literal">\a`</code> for a grave -accent</li> -<li class="listitem"><code class="literal">\a=</code> for a macron -accent</li> -</ul> -</div> -<h5 class="title"><a id="arrows-title" name= -"arrows-title"></a>Arrows</h5> -<a id="idp8231888" class="indexterm" name="idp8231888"></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 <code class= -"literal">left</code>, <code class="literal">right</code>, -<code class="literal">up</code>, or <code class= -"literal">down</code>. <code class="literal">leftright</code> gives -a double headed arrow. Prefacing with <code class= -"literal">long</code> gives a longer arrow. Capitalizing the first -letter gives a double-shanked arrow.</p> -<p>Examples are:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\leftarrow</code></li> -<li class="listitem"><code class="literal">\Leftarrow</code></li> -<li class="listitem"><code class= -"literal">\longleftarrow</code></li> -<li class="listitem"><code class= -"literal">\Longleftarrow</code></li> -<li class="listitem"><code class="literal">\rightarrow</code></li> -<li class="listitem"><code class="literal">\Rightarrow</code></li> -<li class="listitem"><code class= -"literal">\longrightarrow</code></li> -<li class="listitem"><code class= -"literal">\Longrightarrow</code></li> -<li class="listitem"><code class= -"literal">\leftrightarrow</code></li> -<li class="listitem"><code class= -"literal">\Leftrightarrow</code></li> -<li class="listitem"><code class= -"literal">\longleftrightarrow</code></li> -<li class="listitem"><code class="literal">\uparrow</code></li> -<li class="listitem"><code class="literal">\downarrow</code></li> -<li class="listitem"><code class="literal">\Uparrow</code></li> -<li class="listitem"><code class="literal">>\nearrow</code> -points from southwest to northeast</li> -<li class="listitem"><code class="literal">\searrow</code> points -from northwest to southeast</li> -<li class="listitem"><code class="literal">\swarrow</code> points -from northeast to southwest</li> -<li class="listitem"><code class="literal">\nwarrow</code> points -from southeast to northwest</li> -</ul> -</div> -<p>The <code class="literal">\stackrel</code> command is useful for -putting things over or under your arrow.</p> -<p>See also:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a class="link" href="#math-symbols-title" -title="2.3.13. Math Symbols">Math Symbols</a></li> -<li class="listitem"><a class="link" href= -"#binary-and-relational-ops-title" title= -"2.3.19. Binary and Relational Operators">Binary and -Relational Operators</a></li> -<li class="listitem"><a class="link" href="#greek-letters-title" -title="2.3.19. Greek Letters">Greek Letters</a></li> -<li class="listitem"><a class="link" href="#misc-symbols-title" -title="2.3.19. Miscellaneous Symbols">Miscellaneous -Symbols</a></li> -<li class="listitem"><a class="link" href= -"#variable-math-size-symbols-title" title= -"2.3.19. Variable Size Math Symbols">Variable Size Math -Symbols</a></li> -</ul> -</div> -<h5 class="title"><a id="binary-and-relational-ops-title" name= -"binary-and-relational-ops-title"></a>Binary and Relational -Operators</h5> -<a id="idp8273408" class="indexterm" name="idp8273408"></a><a id= -"idp8274480" class="indexterm" name="idp8274480"></a><a id= -"idp8275552" class="indexterm" name="idp8275552"></a><a id= -"idp8277040" class="indexterm" name="idp8277040"></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" title="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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\pm</code> plus or minus -sign</li> -<li class="listitem"><code class="literal">\mp</code> minus or plus -sign</li> -<li class="listitem"><code class="literal">\times</code> times (an -"x")</li> -<li class="listitem"><code class="literal">\div</code> divided by -sign</li> -<li class="listitem"><code class="literal">\ast</code> an asterisk -(centered)</li> -<li class="listitem"><code class="literal">\star</code> a -five-point star (centered)</li> -<li class="listitem"><code class="literal">\bullet</code> a -bullet</li> -<li class="listitem"><code class="literal">\circ</code> an open -bullet</li> -<li class="listitem"><code class="literal">\cdot</code> a centered -dot</li> -<li class="listitem"><code class="literal">\leq</code> less than or -equal to</li> -<li class="listitem"><code class="literal">\ll</code> much less -than</li> -<li class="listitem"><code class="literal">\subset</code> is a -subset of</li> -<li class="listitem"><code class="literal">\geq</code> greater than -or equal to</li> -<li class="listitem"><code class="literal">\gg</code> much greater -than</li> -<li class="listitem"><code class="literal">\equiv</code> -equivalence symbol</li> -<li class="listitem"><code class="literal">\sim</code> similar -to</li> -<li class="listitem"><code class="literal">\simeq</code> similar or -equal to</li> -<li class="listitem"><code class="literal">\approx</code> -approximately equal to</li> -<li class="listitem"><code class="literal">\neq</code> not equal -to</li> -<li class="listitem"><code class="literal">\per</code> -"perpendicular to" symbols</li> -<li class="listitem"><code class="literal">\propto</code> -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 <code class="literal">></code> and -<code class="literal"><</code>.</p> -<p>A slash, indicating <span class="emphasis"><em>not</em></span> -can be placed through a symbol (or a letter) with the <code class= -"literal">\not</code> command. For example, not less than is -<code class="literal">\not<</code> and not less than or equal to -is <code class="literal">\not\leq</code>. If the slash isn't -properly positioned it can be moved by putting a math mode spacing -command between the <code class="literal">\not</code>and the -symbol.</p> -<h5 class="title"><a id="delimiters-title" name= -"delimiters-title"></a>Delimiters</h5> -<a id="idp8319136" class="indexterm" name="idp8319136"></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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">(</code> (left -parenthesis)</li> -<li class="listitem"><code class="literal">)</code> (right -parenthesis)</li> -<li class="listitem"><code class="literal">[</code> (left -bracket)</li> -<li class="listitem"><code class="literal">]</code> (right -bracket)</li> -<li class="listitem"><code class="literal">\{</code> (left -brace)</li> -<li class="listitem"><code class="literal">\}</code> (right -brace)</li> -<li class="listitem"><code class="literal">|</code> (vertical -line)</li> -<li class="listitem"><code class="literal">\vert</code> (vertical -line)</li> -<li class="listitem"><code class="literal">\|</code> (double -vertical lines)</li> -<li class="listitem"><code class="literal">\Vert</code> (double -vertical lines)</li> -<li class="listitem"><code class="literal">/</code> (slash)</li> -<li class="listitem"><code class="literal">\backslash</code> -(backslash)</li> -<li class="listitem"><code class="literal">\langle</code> (left -angle bracket)</li> -<li class="listitem"><code class="literal">\rangle</code> (right -angle bracket)</li> -<li class="listitem"><code class="literal">\uparrow</code> -(uparrow)</li> -<li class="listitem"><code class="literal">\downarrow</code> (down -arrow)</li> -<li class="listitem"><code class="literal">\updownarrow</code> -(up/down arrow)</li> -</ul> -</div> -<h5 class="title"><a id="idp8345328" name="idp8345328"></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 <code class="literal">\left</code> or -<code class="literal">\right</code> command before the delimiter. -<code class="literal">\left</code> and <code class= -"literal">\right</code> commands must come in matching pairs, -although the delimiters themselves need not be the same. Thus, -<code class="literal">\left \{ ... \right \[</code> 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 -(<code class="literal">.</code>) after the command, i.e., -<code class="literal">\left.</code> or <code class= -"literal">\right.</code></p> -<p>In an <a class="link" href="#env-eqnarray" title= -"2.3.6. eqnarray">eqnarray</a> environment the matching -<code class="literal">\left</code> and <code class= -"literal">\right</code> cannot be split between lines and it may be -necessary to use an <span class= -"emphasis"><em>invisible</em></span> <code class= -"literal">\right.</code> and <code class="literal">\left.</code> 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 <code class="literal">\rule</code>. It can also be -accomplished with the <code class="literal">\vphantom</code> -command, which I have not found documented, but which appears to -work.</p> -<p><code class="literal">\vphantom{construct}</code> creates a -zero-width object with the height of <code class= -"literal">construct</code>. The argument can contain things such as -<code class="literal">\frac</code> 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="idp8366256" name="idp8366256"></a>Some -Examples</h5> -<h5 class="title"><a id="idp8366944" name="idp8366944"></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 <code class="literal">\[ ... \]</code> 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="idp8371424" name="idp8371424"></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> -<code class="literal">\right</code> delimiter is specified using a -<span class="emphasis"><em>period</em></span>.</p> -<h5 class="title"><a id="ellipsis-title" name= -"ellipsis-title"></a>Ellipsis</h5> -<a id="idp8377040" class="indexterm" name="idp8377040"></a> -<p>Ellipses (three dots) can be produced by the following -commands</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\ldots</code> -horizontally at bottom of line</li> -<li class="listitem"><code class="literal">\cdots</code> -horizontally center of line (math mode only)</li> -<li class="listitem"><code class="literal">\ddots</code> diagonal -(math mode only)</li> -<li class="listitem"><code class="literal">\vdots</code> vertical -(math mode only)</li> -</ul> -</div> -<h5 class="title"><a id="greek-letters-title" name= -"greek-letters-title"></a>Greek Letters</h5> -<a id="idp8385840" class="indexterm" name="idp8385840"></a> -<p>These commands may be used only in math mode:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\alpha</code></li> -<li class="listitem"><code class="literal">\beta</code></li> -<li class="listitem"><code class="literal">\gamma</code></li> -<li class="listitem"><code class="literal">\delta</code></li> -<li class="listitem"><code class="literal">\epsilon</code></li> -<li class="listitem"><code class="literal">\varepsilon</code> -(variation, script-like)</li> -<li class="listitem"><code class="literal">\zeta</code></li> -<li class="listitem"><code class="literal">\eta</code></li> -<li class="listitem"><code class="literal">\theta</code></li> -<li class="listitem"><code class="literal">\vartheta</code> -(variation, script-like)</li> -<li class="listitem"><code class="literal">\iota</code></li> -<li class="listitem"><code class="literal">\kappa</code></li> -<li class="listitem"><code class="literal">\lambda</code></li> -<li class="listitem"><code class="literal">\mu</code></li> -<li class="listitem"><code class="literal">\nu</code></li> -<li class="listitem"><code class="literal">\xi</code></li> -<li class="listitem"><code class="literal">\pi</code></li> -<li class="listitem"><code class="literal">\varpi</code> -(variation)</li> -<li class="listitem"><code class="literal">\rho</code></li> -<li class="listitem"><code class="literal">\varrho</code> -(variation, with the tail)</li> -<li class="listitem"><code class="literal">\sigma</code></li> -<li class="listitem"><code class="literal">\varsigma</code> -(variation, script-like)</li> -<li class="listitem"><code class="literal">\tau</code></li> -<li class="listitem"><code class="literal">\upsilon</code></li> -<li class="listitem"><code class="literal">\phi</code></li> -<li class="listitem"><code class="literal">\varphi</code> -(variation, script-like)</li> -<li class="listitem"><code class="literal">\chi</code></li> -<li class="listitem"><code class="literal">\psi</code></li> -<li class="listitem"><code class="literal">\omega</code></li> -</ul> -</div> -<p>Capital letters:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">\Gamma</code></li> -<li class="listitem"><code class="literal">\Delta</code></li> -<li class="listitem"><code class="literal">\Theta</code></li> -<li class="listitem"><code class="literal">\Lambda</code></li> -<li class="listitem"><code class="literal">\Xi</code></li> -<li class="listitem"><code class="literal">\Pi</code></li> -<li class="listitem"><code class="literal">\Sigma</code></li> -<li class="listitem"><code class="literal">\Upsilon</code></li> -<li class="listitem"><code class="literal">\Phi</code></li> -<li class="listitem"><code class="literal">\Psi</code></li> -<li class="listitem"><code class="literal">\Omega</code></li> -</ul> -</div> -<p>See also:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a class="link" href="#math-symbols-title" -title="2.3.13. Math Symbols">Math Symbols</a></li> -<li class="listitem"><a class="link" href="#accents-on-chars-title" -title="2.3.19. Accents on Characters">Accents</a></li> -<li class="listitem"><a class="link" href="#misc-symbols-title" -title="2.3.19. Miscellaneous Symbols">Miscellaneous -Symbols</a></li> -</ul> -</div> -<h5 class="title"><a id="misc-symbols-title" name= -"misc-symbols-title"></a>Miscellaneous Symbols</h5> -<a id="idp8444672" class="indexterm" name="idp8444672"></a> -<h5 class="title"><a id="idp8446160" name="idp8446160"></a>Some -symbols for math</h5> -<p>The following symbols are also used only in math mode</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a id="cmd-misc-symbol-aleph" name= -"cmd-misc-symbol-aleph"></a><code class="literal">\aleph</code> -Hebrew aleph</li> -<li class="listitem"><a id="cmd-misc-symbol-hbar" name= -"cmd-misc-symbol-hbar"></a><code class="literal">\hbar</code> -h-bar, Planck's constant</li> -<li class="listitem"><a id="cmd-misc-symbol-imath" name= -"cmd-misc-symbol-imath"></a><code class="literal">\imath</code> -variation on <span class="emphasis"><em>i</em></span>; no dot</li> -<li class="listitem"><a id="cmd-misc-symbol-jmath" name= -"cmd-misc-symbol-jmath"></a><code class="literal">\jmath</code> -variation on <span class="emphasis"><em>j</em></span>; no dot</li> -<li class="listitem"><a id="cmd-misc-symbol-ell" name= -"cmd-misc-symbol-ell"></a><code class="literal">\ell</code> script -(loop) <span class="emphasis"><em>l</em></span></li> -<li class="listitem"><a id="cmd-misc-symbol-wp" name= -"cmd-misc-symbol-wp"></a><code class="literal">\wp</code> fancy -script lowercase <span class="emphasis"><em>P</em></span></li> -<li class="listitem"><a id="cmd-misc-symbol-re" name= -"cmd-misc-symbol-re"></a><code class="literal">\Re</code> script -capital <span class="emphasis"><em>R</em></span> (<span class= -"emphasis"><em>Real</em></span>)</li> -<li class="listitem"><a id="cmd-misc-symbol-im" name= -"cmd-misc-symbol-im"></a><code class="literal">\Im</code> script -capital <span class="emphasis"><em>I</em></span> (<span class= -"emphasis"><em>Imaginary</em></span>)</li> -<li class="listitem"><a id="cmd-misc-symbol-prime" name= -"cmd-misc-symbol-prime"></a><code class="literal">\prime</code> -prime (also obtained by typing <code class="literal">'</code>)</li> -<li class="listitem"><a id="cmd-misc-symbol-nabla" name= -"cmd-misc-symbol-nabla"></a><code class="literal">\nabla</code> -inverted capital Delta</li> -<li class="listitem"><a id="cmd-misc-symbol-surd" name= -"cmd-misc-symbol-surd"></a><code class="literal">\surd</code> -radical (square root) symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-angle" name= -"cmd-misc-symbol-angle"></a><code class="literal">\angle</code> -angle symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-forall" name= -"cmd-misc-symbol-forall"></a><code class="literal">\forall</code> -<span class="emphasis"><em>for all</em></span> (inverted A)</li> -<li class="listitem"><a id="cmd-misc-symbol-exists" name= -"cmd-misc-symbol-exists"></a><code class="literal">\exists</code> -<span class="emphasis"><em>exists</em></span> (left-facing E)</li> -<li class="listitem"><a id="cmd-misc-symbol-partial" name= -"cmd-misc-symbol-partial"></a><code class="literal">\partial</code> -partial derivative symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-infty" name= -"cmd-misc-symbol-infty"></a><code class="literal">\infty</code> -infinity symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-triangle" name= -"cmd-misc-symbol-triangle"></a><code class= -"literal">\triangle</code> open triangle symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-box" name= -"cmd-misc-symbol-box"></a><code class="literal">\Box</code> open -square</li> -<li class="listitem"><a id="cmd-misc-symbol-diamond" name= -"cmd-misc-symbol-diamond"></a><code class="literal">\Diamond</code> -open diamond</li> -<li class="listitem"><a id="cmd-misc-symbol-flat" name= -"cmd-misc-symbol-flat"></a><code class="literal">\flat</code> -music: flat symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-natural" name= -"cmd-misc-symbol-natural"></a><code class="literal">\natural</code> -music: natural symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-clubsuit" name= -"cmd-misc-symbol-clubsuit"></a><code class= -"literal">\clubsuit</code> playing cards: club suit symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-diamondsuit" name= -"cmd-misc-symbol-diamondsuit"></a><code class= -"literal">\diamondsuit</code> playing cards: diamond suit -symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-heartsuit" name= -"cmd-misc-symbol-heartsuit"></a><code class= -"literal">\heartsuit</code> playing cards: heart suit symbol</li> -<li class="listitem"><a id="cmd-misc-symbol-spadsuit" name= -"cmd-misc-symbol-spadsuit"></a><code class= -"literal">\spadesuit</code> playing cards: space suit symbol</li> -</ul> -</div> -<h5 class="title"><a id="idp8498480" name="idp8498480"></a>Some -Other Symbols</h5> -<p>The following symbols can be used in any mode:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a id="cmd-other-symbol-dag" name= -"cmd-other-symbol-dag"></a><code class="literal">\dag</code> -dagger</li> -<li class="listitem"><a id="cmd-other-symbol-ddag" name= -"cmd-other-symbol-ddag"></a>><code class="literal">\ddag</code> -double dagger</li> -<li class="listitem"><a id="cmd-other-symbol-s" name= -"cmd-other-symbol-s"></a>><code class="literal">\S</code> -section symbol</li> -<li class="listitem"><a id="cmd-other-symbol-p" name= -"cmd-other-symbol-p"></a>><code class="literal">\P</code> -paragraph symbol</li> -<li class="listitem"><a id="cmd-other-symbol-copyright" name= -"cmd-other-symbol-copyright"></a>><code class= -"literal">\copyright</code> copyright symbol</li> -<li class="listitem"><a id="cmd-other-symbol-pounds" name= -"cmd-other-symbol-pounds"></a>><code class= -"literal">\pounds</code> British pound sterling symbol</li> -</ul> -</div> -<h5 class="title"><a id="idp8511904" name= -"idp8511904"></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 <code class= -"literal">\cal</code> declaration:</p> -<pre class="programlisting"> -${\cal A}$ -</pre> -<p>In LaTeX2e they are obtained with the <code class= -"literal">\mathcal</code> command:</p> -<pre class="programlisting"> -$\mathcal{CAL}$ -</pre> -<h5 class="title"><a id="math-functions-title" name= -"math-functions-title"></a>Math Functions</h5> -<a id="idp8518432" class="indexterm" name="idp8518432"></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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a id="cmd-math-func-arccos" name= -"cmd-math-func-arccos"></a><code class= -"literal">\arccos</code></li> -<li class="listitem"><a id="cmd-math-func-arcsin" name= -"cmd-math-func-arcsin"></a><code class= -"literal">\arcsin</code></li> -<li class="listitem"><a id="cmd-math-func-arctan" name= -"cmd-math-func-arctan"></a><code class= -"literal">\arctan</code></li> -<li class="listitem"><a id="cmd-math-func-cos" name= -"cmd-math-func-cos"></a><code class="literal">\cos</code></li> -<li class="listitem"><a id="cmd-math-func-cosh" name= -"cmd-math-func-cosh"></a><code class="literal">\cosh</code></li> -<li class="listitem"><a id="cmd-math-func-cot" name= -"cmd-math-func-cot"></a><code class="literal">\cot</code></li> -<li class="listitem"><a id="cmd-math-func-coth" name= -"cmd-math-func-coth"></a><code class="literal">\coth</code></li> -<li class="listitem"><a id="cmd-math-func-csc" name= -"cmd-math-func-csc"></a><code class="literal">\csc</code></li> -<li class="listitem"><a id="cmd-math-func-deg" name= -"cmd-math-func-deg"></a><code class="literal">\deg</code></li> -<li class="listitem"><a id="cmd-math-func-det" name= -"cmd-math-func-det"></a><code class="literal">\det</code></li> -<li class="listitem"><a id="cmd-math-func-dim" name= -"cmd-math-func-dim"></a><code class="literal">\dim</code></li> -<li class="listitem"><a id="cmd-math-func-exp" name= -"cmd-math-func-exp"></a><code class="literal">\exp</code></li> -<li class="listitem"><a id="cmd-math-func-gcd" name= -"cmd-math-func-gcd"></a><code class="literal">\gcd</code></li> -<li class="listitem"><a id="cmd-math-func-hom" name= -"cmd-math-func-hom"></a><code class="literal">\hom</code></li> -<li class="listitem"><a id="cmd-math-func-inf" name= -"cmd-math-func-inf"></a><code class="literal">\inf</code></li> -<li class="listitem"><a id="cmd-math-func-ker" name= -"cmd-math-func-ker"></a><code class="literal">\ker</code></li> -<li class="listitem"><a id="cmd-math-func-lg" name= -"cmd-math-func-lg"></a><code class="literal">\lg</code></li> -<li class="listitem"><a id="cmd-math-func-lim" name= -"cmd-math-func-lim"></a><code class="literal">\lim</code></li> -<li class="listitem"><a id="cmd-math-func-liminf" name= -"cmd-math-func-liminf"></a><code class= -"literal">\liminf</code></li> -<li class="listitem"><a id="cmd-math-func-limsup" name= -"cmd-math-func-limsup"></a><code class= -"literal">\limsup</code></li> -<li class="listitem"><a id="cmd-math-func-ln" name= -"cmd-math-func-ln"></a><code class="literal">\ln</code></li> -<li class="listitem"><a id="cmd-math-func-log" name= -"cmd-math-func-log"></a><code class="literal">\log</code></li> -<li class="listitem"><a id="cmd-math-func-max" name= -"cmd-math-func-max"></a><code class="literal">\max</code></li> -<li class="listitem"><a id="cmd-math-func-min" name= -"cmd-math-func-min"></a><code class="literal">\min</code></li> -<li class="listitem"><a id="cmd-math-func-sec" name= -"cmd-math-func-sec"></a><code class="literal">\sec</code></li> -<li class="listitem"><a id="cmd-math-func-sin" name= -"cmd-math-func-sin"></a><code class="literal">\sin</code></li> -<li class="listitem"><a id="cmd-math-func-sinh" name= -"cmd-math-func-sinh"></a><code class="literal">\sinh</code></li> -<li class="listitem"><a id="cmd-math-func-sup" name= -"cmd-math-func-sup"></a><code class="literal">\sup</code></li> -<li class="listitem"><a id="cmd-math-func-tan" name= -"cmd-math-func-tan"></a><code class="literal">\tan</code></li> -<li class="listitem"><a id="cmd-math-func-tanh" name= -"cmd-math-func-tanh"></a><code class="literal">\tanh</code></li> -</ul> -</div> -<p>Two commands are provided for the "modulus" function</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a id="cmd-math-func-bmod" name= -"cmd-math-func-bmod"></a><code class="literal">\bmod</code></li> -<li class="listitem"><a id="cmd-math-func-pmod" name= -"cmd-math-func-pmod"></a><code class="literal">\pmod{}</code></li> -</ul> -</div> -<p>The former would be used to write "a mod b" as <code class= -"literal">a \bmod b</code> and the latter, which requires an -argument that is displayed in parentheses, would be used to write -"n = i (mod j)" as <code class="literal">n = i \pmod{j}</code></p> -<h5 class="title"><a id="variable-math-size-symbols-title" name= -"variable-math-size-symbols-title"></a>Variable Size Math -Symbols</h5> -<a id="idp8579440" class="indexterm" name="idp8579440"></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., <code class="literal">displaymath</code> -as opposed to <code class="literal">math</code> environments.</p> -<p>These include:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><a id="cmd-math-symbol-sum" name= -"cmd-math-symbol-sum"></a><code class="literal">\sum</code> a -summation sign (capital sigma)</li> -<li class="listitem"><a id="cmd-math-symbol-prod" name= -"cmd-math-symbol-prod"></a><code class="literal">\prod</code> a -product (capital pi)</li> -<li class="listitem"><a id="cmd-math-symbol-coprod" name= -"cmd-math-symbol-coprod"></a><code class="literal">\coprod</code> a -coproduct (inverted capital pi)</li> -<li class="listitem"><a id="cmd-math-symbol-int" name= -"cmd-math-symbol-int"></a><code class="literal">\int</code> an -integral sign</li> -<li class="listitem"><a id="cmd-math-symbol-oint" name= -"cmd-math-symbol-oint"></a><code class="literal">\oint</code> a -surface (circular) integral sign</li> -<li class="listitem"><a id="cmd-math-symbol-bigcup" name= -"cmd-math-symbol-bigcup"></a><code class="literal">\bigcup</code> -big "U"</li> -<li class="listitem"><a id="cmd-math-symbol-bigcap" name= -"cmd-math-symbol-bigcap"></a><code class="literal">\bigcap</code> -big inverted "U"</li> -<li class="listitem"><a id="cmd-math-symbol-bigvee" name= -"cmd-math-symbol-bigvee"></a><code class="literal">\bigvee</code> -big "V"</li> -<li class="listitem"><a id="cmd-math-symbol-bigwedge" name= -"cmd-math-symbol-bigwedge"></a><code class= -"literal">\bigwedge</code> big inverted "V"</li> -<li class="listitem"><a id="cmd-math-symbol-bigodot" name= -"cmd-math-symbol-bigodot"></a><code class="literal">\bigodot</code> -big "O" with dot at center</li> -<li class="listitem"><a id="cmd-math-symbol-bigotimes" name= -"cmd-math-symbol-bigotimes"></a><code class= -"literal">\bigotimes</code> big "O" with cross inside</li> -<li class="listitem"><a id="cmd-math-symbol-bigoplus" name= -"cmd-math-symbol-bigoplus"></a><code class= -"literal">\bigoplus</code> big "O" with a + inside</li> -<li class="listitem"><a id="cmd-math-symbol-biguplus" name= -"cmd-math-symbol-biguplus"></a><code class= -"literal">\biguplus</code> big "U" with a + inside</li> -</ul> -</div> -<p>The <code class="literal">\sqrt</code> 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 -<code class="literal">displaymath</code> 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 <code class= -"literal">\mathop</code> 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 <code class="literal">\widehat</code> and <code class= -"literal">\widetilde</code></p> -</div> -<div class="section" title="2.3.20 Splitting the Input"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="splitting-the-input" name= -"splitting-the-input"></a>2.3.20 Splitting the Input</h4> -</div> -</div> -</div> -<a id="idp8618352" class="indexterm" name="idp8618352"></a><a id= -"idp8619136" class="indexterm" name="idp8619136"></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" name= -"cmd-include-title"></a>\include</h5> -<a id="idp8622240" class="indexterm" name="idp8622240"></a> -<p><code class="literal">\include{file}</code></p> -<p>The <code class="literal">\include</code> command is used in -conjunction with the <code class="literal">\includeonly</code> -command for selective inclusion of files. The <code class= -"literal">file</code> argument is the first name of a file, -denoting <code class="filename">file.tex</code>. If <code class= -"literal">file</code> is one the file names in the file list of the -<code class="literal">\includeonly</code> command or if there is no -<code class="literal">\includeonly</code> command, the <code class= -"literal">\include</code> command is equivalent to</p> -<pre class="programlisting"> -\clearpage \input{file} \clearpage -</pre> -<p>except that if the file <code class="filename">file.tex</code> -does not exist, then a warning message rather than an error is -produced. If the file is not in the file list, the <code class= -"literal">\include</code> command is equivalent to <code class= -"literal">\clearpage</code>.</p> -<p>The <code class="literal">\include</code> command may not appear -in the preamble or in a file read by another <code class= -"literal">\include</code> command.</p> -<h5 class="title"><a id="cmd-includeonly-title" name= -"cmd-includeonly-title"></a>\includeonly</h5> -<a id="idp8636864" class="indexterm" name="idp8636864"></a> -<p><code class="literal">\includeonly{</code><span class= -"emphasis"><em>file_list</em></span><code class= -"literal">}</code></p> -<p>The <code class="literal">\includeonly</code> command controls -which files will be read in by an <code class= -"literal">\include</code> 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 <code class="literal">\include</code> command. This -command can only appear in the preamble.</p> -<h5 class="title"><a id="cmd-input-title" name= -"cmd-input-title"></a>\input</h5> -<a id="idp8643840" class="indexterm" name="idp8643840"></a> -<p><code class="literal">\input{file}</code></p> -<p>The <code class="literal">\input</code> command causes the -indicated <code class="literal">file</code> 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 -<code class="filename">file.tex</code> is used.</p> -</div> -<div class="section" title="2.3.21 Starting & Ending"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="starting-and-ending" name= -"starting-and-ending"></a>2.3.21 Starting & Ending</h4> -</div> -</div> -</div> -<a id="idp8650144" class="indexterm" name="idp8650144"></a><a id= -"idp8650960" class="indexterm" name="idp8650960"></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 <code class="literal">class</code> selected is one of -the valid classes for LaTeX. See <a class="link" href= -"#document-classes" title="2.3.4 Document Classes">Document -Classes</a> (and see <a class="link" 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 <code class= -"literal">\documentclass</code> and the <code class= -"literal">\begin{document}</code> commands (i.e., in the -`preamble').</p> -</div> -<div class="section" title="2.3.22 Table of Contents"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="table-of-contents" name= -"table-of-contents"></a>2.3.22 Table of Contents</h4> -</div> -</div> -</div> -<a id="idp8660416" class="indexterm" name="idp8660416"></a> -<p>A table of contents is produced with the <code class= -"literal">\tableofcontents</code> <a id="idp8662256" class= -"indexterm" name="idp8662256"></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 <code class="literal">\newpage</code> command -after the <code class="literal">\tableofcontents</code> -command.</p> -<p>There are similar commands <code class= -"literal">\listoffigures</code> <a id="idp8666416" class= -"indexterm" name="idp8666416"></a> and <code class= -"literal">\listoftables</code> <a id="idp8667952" class="indexterm" -name="idp8667952"></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 <code class="literal">\nofiles</code> <a id="idp8670096" -class="indexterm" name="idp8670096"></a> command in your -document.</p> -<h5 class="title"><a id="cmd-addcontentsline-title" name= -"cmd-addcontentsline-title"></a>\addcontentsline</h5> -<a id="idp8672336" class="indexterm" name="idp8672336"></a> -<p><code class= -"literal">\addcontentsline{file}{sec_unit}{entry}</code></p> -<p>The <code class="literal">\addcontentsline</code> command adds -an entry to the specified list or table where:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">file</code> is the -extension of the file on which information is to be written: -<code class="literal">toc</code> (table of contents), <code class= -"literal">lof</code> (list of figures), or <code class= -"literal">lot</code> (list of tables).</li> -<li class="listitem"> -<p class="simpara"><code class="literal">sec_unit</code> 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 class="orderedlist" type="1"> -<li class="listitem"><code class="literal">toc</code> --- the name -of the sectional unit, such as part or subsection.</li> -<li class="listitem"><code class="literal">lof</code> --- -figure</li> -<li class="listitem"><code class="literal">lot</code> --- -table</li> -</ol> -</div> -</li> -<li class="listitem"><code class="literal">entry</code> is the text -of the entry.</li> -</ul> -</div> -<h5 class="title"><a id="cmd-addtocontents-title" name= -"cmd-addtocontents-title"></a>\addtocontents</h5> -<a id="idp8687536" class="indexterm" name="idp8687536"></a> -<p><code class="literal">\addtocontents{file}{text}</code></p> -<p>The <code class="literal">\addtocontents</code> 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">file</code> is the -extension of the file on which information is to be written: -<code class="literal">toc</code> (table of contents), <code class= -"literal">lof</code> (list of figures), or <code class= -"literal">lot</code> (list of tables).</li> -<li class="listitem"><code class="literal">text</code> is the -information to be written.</li> -</ul> -</div> -</div> -<div class="section" title="2.3.23 Terminal Input/Output"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="terminal-input-slash-output" name= -"terminal-input-slash-output"></a>2.3.23 Terminal Input/Output</h4> -</div> -</div> -</div> -<a id="idp8697776" class="indexterm" name="idp8697776"></a><a id= -"idp8698592" class="indexterm" name="idp8698592"></a> -<h5 class="title"><a id="cmd-typein-title" name= -"cmd-typein-title"></a>\typein</h5> -<a id="idp8700464" class="indexterm" name="idp8700464"></a> -<p><code class="literal">\typein[cmd]{msg}</code></p> -<p>Prints <code class="literal">msg</code> on the terminal and -causes LaTeX to stop and wait for you to type a line of input, -ending with return. If the <code class="literal">cmd</code> -argument is missing, the typed input is processed as if it had been -included in the input file in place of the <code class= -"literal">\typein</code> command. If the <code class= -"literal">cmd</code> 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" name= -"cmd-typeout-title"></a>\typeout</h5> -<a id="idp8707360" class="indexterm" name="idp8707360"></a> -<p><code class="literal">\typeout{msg}</code></p> -<p>Prints <code class="literal">msg</code> on the terminal and in -the <code class="literal">log</code> file. Commands in <code class= -"literal">msg</code> that are defined with <code class= -"literal">\newcommand</code> or <code class= -"literal">\renewcommand</code> 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 -<code class="literal">msg</code>. A <code class= -"literal">\space</code> command in <code class="literal">msg</code> -causes a single space to be printed. A <code class= -"literal">^^J</code> in <code class="literal">msg</code> prints a -newline.</p> -</div> -<div class="section" title="2.3.24 Typefaces"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="typefaces" name="typefaces"></a>2.3.24 -Typefaces</h4> -</div> -</div> -</div> -<a id="idp8719168" class="indexterm" name="idp8719168"></a><a id= -"idp8719984" class="indexterm" name="idp8719984"></a> -<p>The <code class="literal">typeface</code> 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" name= -"styles-title"></a>\Styles</h5> -<a id="idp8724480" class="indexterm" name="idp8724480"></a><a id= -"idp8725296" class="indexterm" name="idp8725296"></a><a id= -"idp8726112" class="indexterm" name="idp8726112"></a> -<p>The following type style commands are supported by LaTeX.</p> -<p>These commands are used like <code class= -"literal">\textit{italics text}</code>. 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 -<code class="literal">\sffamily\bfseries</code> to get sans serif -boldface.</p> -<p>You can also use the environment form of the declaration forms; -e.g. <code class= -"literal">\begin{ttfamily}...\end{ttfamily}</code>.</p> -<div class="table"><a id="table-typefaces" name= -"table-typefaces"></a> -<p class="title"> -<strong>Table 1.9. Typefaces</strong></p> -<div class="table-contents"> -<table summary="Typefaces" border="0"> -<colgroup> -<col align="left" /> -<col align="justify" /></colgroup> -<tbody> -<tr> -<td align="left">\textrm (\rmfamily) <a id="idp8736432" class= -"indexterm" name="idp8736432"></a> <a id="idp8737248" class= -"indexterm" name="idp8737248"></a></td> -<td align="justify">Roman.</td> -</tr> -<tr> -<td align="left">\textit (\itshape) <a id="idp8739408" class= -"indexterm" name="idp8739408"></a> <a id="idp8740224" class= -"indexterm" name="idp8740224"></a>, \emph <a id="idp8741072" class= -"indexterm" name="idp8741072"></a></td> -<td align="justify">Emphasis (toggles between \textit and -\textrm).</td> -</tr> -<tr> -<td align="left">\textmd (\mdseries) <a id="idp8743264" class= -"indexterm" name="idp8743264"></a> <a id="idp8744080" class= -"indexterm" name="idp8744080"></a></td> -<td align="justify">Medium weight (default). The opposite of -boldface.</td> -</tr> -<tr> -<td align="left">\textbf (\bfseries) <a id="idp8746288" class= -"indexterm" name="idp8746288"></a> <a id="idp8747104" class= -"indexterm" name="idp8747104"></a></td> -<td align="justify">Boldface.</td> -</tr> -<tr> -<td align="left">\textup (\upshape) <a id="idp8749264" class= -"indexterm" name="idp8749264"></a> <a id="idp8750080" class= -"indexterm" name="idp8750080"></a></td> -<td align="justify">Upright (default). The opposite of -slanted.</td> -</tr> -<tr> -<td align="left">\textsl (\slshape) <a id="idp8752272" class= -"indexterm" name="idp8752272"></a> <a id="idp8753088" class= -"indexterm" name="idp8753088"></a></td> -<td align="justify">Slanted.</td> -</tr> -<tr> -<td align="left">\textsf (\sffamily) <a id="idp8755248" class= -"indexterm" name="idp8755248"></a> <a id="idp8756064" class= -"indexterm" name="idp8756064"></a></td> -<td align="justify">Sans serif.</td> -</tr> -<tr> -<td align="left">\textsc (\scshape) <a id="idp8758224" class= -"indexterm" name="idp8758224"></a> <a id="idp8759040" class= -"indexterm" name="idp8759040"></a></td> -<td align="justify">Small caps.</td> -</tr> -<tr> -<td align="left">\texttt (\ttfamily) <a id="idp8761200" class= -"indexterm" name="idp8761200"></a> <a id="idp8762016" class= -"indexterm" name="idp8762016"></a></td> -<td align="justify">Typewriter.</td> -</tr> -<tr> -<td align="left">\textnormal (\normalfont) <a id="idp8764176" -class="indexterm" name="idp8764176"></a> <a id="idp8764992" class= -"indexterm" name="idp8764992"></a></td> -<td align="justify">Main document font.</td> -</tr> -<tr> -<td align="left">\mathrm <a id="idp8767152" class="indexterm" name= -"idp8767152"></a></td> -<td align="justify">Roman, for use in math mode.</td> -</tr> -<tr> -<td align="left">\mathbf <a id="idp8769312" class="indexterm" name= -"idp8769312"></a></td> -<td align="justify">Boldface, for use in math mode. For bold -symbols or complete equations take a look at <a class="link" href= -"#boldsymbol-linkend"><code class="literal">\boldsymbol</code></a> -and <a class="link" href="#cmd-bm"><code class= -"literal">\bm</code></a>.</td> -</tr> -<tr> -<td align="left">\mathsf <a id="idp8774144" class="indexterm" name= -"idp8774144"></a></td> -<td align="justify">Sans serif, for use in math mode.</td> -</tr> -<tr> -<td align="left">\mathtt <a id="idp8776304" class="indexterm" name= -"idp8776304"></a></td> -<td align="justify">Typewriter, for use in math mode.</td> -</tr> -<tr> -<td align="left">\mathit <a id="idp8778464" class="indexterm" name= -"idp8778464"></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="idp8780672" class="indexterm" -name="idp8780672"></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="idp8782880" class="indexterm" -name="idp8782880"></a></td> -<td align="justify">`Calligraphic' letters, for use in math -mode.</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<p>In addition, the command <code class= -"literal">\mathversion{bold}</code> <a id="idp8785776" class= -"indexterm" name="idp8785776"></a> can be used for switching to -bold letters and symbols in formulas. <code class= -"literal">\mathversion{normal}</code> restores the default.</p> -<h5 class="title"><a id="sizes-title" name= -"sizes-title"></a>Sizes</h5> -<a id="idp8788656" class="indexterm" name="idp8788656"></a><a id= -"idp8789472" class="indexterm" name="idp8789472"></a><a id= -"idp8790288" class="indexterm" name="idp8790288"></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. -<code class="literal">\begin{tiny}...\end{tiny}</code>.</p> -<div class="table"><a id="table-standard-type-size-commands" name= -"table-standard-type-size-commands"></a> -<p class="title"><strong>Table 1.10. Standard type size -commands</strong></p> -<div class="table-contents"> -<table summary="Standard type size commands" border="0"> -<colgroup> -<col align="left" /> -<col align="justify" /></colgroup> -<tbody> -<tr> -<td align="left">\tiny<a id="idp8798272" class="indexterm" name= -"idp8798272"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\scriptsize <a id="idp8800768" class="indexterm" -name="idp8800768"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\footnotesize <a id="idp8803008" class="indexterm" -name="idp8803008"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\small <a id="idp8805248" class="indexterm" name= -"idp8805248"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\normalsize <a id="idp8807488" class="indexterm" -name="idp8807488"></a></td> -<td align="justify">(default)</td> -</tr> -<tr> -<td align="left">\large <a id="idp8809760" class="indexterm" name= -"idp8809760"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\Large <a id="idp8812000" class="indexterm" name= -"idp8812000"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\LARGE <a id="idp8814240" class="indexterm" name= -"idp8814240"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\huge <a id="idp8816480" class="indexterm" name= -"idp8816480"></a></td> -<td align="justify"></td> -</tr> -<tr> -<td align="left">\Huge <a id="idp8818720" class="indexterm" name= -"idp8818720"></a></td> -<td align="justify"> </td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /> -<h5 class="title"><a id="low-dash-level-font-commands-title" name= -"low-dash-level-font-commands-title"></a>Low-level font -commands</h5> -<a id="idp8821680" class="indexterm" name="idp8821680"></a><a id= -"idp8822496" class="indexterm" name="idp8822496"></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 -<em class="citetitle">The LaTeX Companion</em>.</p> -<div class="table"><a id="table-low-level-font-commands" name= -"table-low-level-font-commands"></a> -<p class="title"><strong>Table 1.11. Low-level font -commands</strong></p> -<div class="table-contents"> -<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="idp8829152" class= -"indexterm" name="idp8829152"></a></td> -<td align="justify">Select font encoding. Valid encodings include -<code class="literal">OT1</code> and <code class= -"literal">T1</code>.</td> -</tr> -<tr> -<td align="left">\fontfamily{family} <a id="idp8832816" class= -"indexterm" name="idp8832816"></a></td> -<td align="justify">Select font family. Valid families include: -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">cmr</code> for Computer -Modern Roman</li> -<li class="listitem"><code class="literal">cmss</code> for Computer -Modern Sans Serif</li> -<li class="listitem"><code class="literal">cmtt</code> for Computer -Modern Typewriter</li> -</ul> -</div> -and numerous others.</td> -</tr> -<tr> -<td align="left">\fontseries{series} <a id="idp8839504" class= -"indexterm" name="idp8839504"></a></td> -<td align="justify">Select font series. Valid series include: -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">m</code> Medium -(normal)</li> -<li class="listitem"><code class="literal">b</code> Bold</li> -<li class="listitem"><code class="literal">c</code> Condensed</li> -<li class="listitem"><code class="literal">bc</code> Bold -condensed</li> -<li class="listitem"><code class="literal">bx</code> Bold -extended</li> -</ul> -</div> -and various other combinations.</td> -</tr> -<tr> -<td align="left">\fontshape{shape} <a id="idp8848528" class= -"indexterm" name="idp8848528"></a></td> -<td align="justify">Select font shape. Valid shapes are: -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem"><code class="literal">n</code> Upright -(normal)</li> -<li class="listitem"><code class="literal">it</code> Italic</li> -<li class="listitem"><code class="literal">sl</code> Slanted -(oblique)</li> -<li class="listitem"><code class="literal">sc</code> Small -caps</li> -<li class="listitem"><code class="literal">ui</code> Upright -italics</li> -<li class="listitem"><code class="literal">ol</code> 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="idp8858864" class= -"indexterm" name="idp8858864"></a></td> -<td align="justify">Set font size. The first parameter is the font -size to switch to; the second is the <code class= -"literal">\baselineskip</code> 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="idp8861936" class="indexterm" -name="idp8861936"></a></td> -<td align="justify">The changes made by calling the four font -commands described above do not come into effect until <code class= -"literal">\selectfont</code> is called.</td> -</tr> -<tr> -<td align="left">\usefont{enc}{family}{series}{shape} <a id= -"idp8864928" class="indexterm" name="idp8864928"></a></td> -<td align="justify">Equivalent to calling <code class= -"literal">\fontencoding</code>, <code class= -"literal">\fontfamily</code>, <code class= -"literal">\fontseries</code> and <code class= -"literal">\fontshape</code> with the given parameters, followed by -<code class="literal">\selectfont</code>.</td> -</tr> -</tbody> -</table> -</div> -</div> -<br class="table-break" /></div> -</div> -<div class="section" title="2.4 Parameters"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="parameters" name="parameters"></a>2.4 -Parameters</h3> -</div> -</div> -</div> -<a id="idp8872224" class="indexterm" name="idp8872224"></a> -<p>The input file specification indicates the file to be formatted; -TeX uses <code class="filename">.tex</code> 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><code class="literal">latex \scrollmode\input foo.tex</code></p> -<p>will process <code class="filename">foo.tex</code> 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 <code class="literal">texput.log</code>.</p> -</div> -</div> -<div class="section" title="3 LaTeX Packages"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="latex-packages" name= -"latex-packages"></a>3 LaTeX Packages</h2> -</div> -</div> -</div> -<a id="idp8881376" class="indexterm" name="idp8881376"></a> -<div class="section" title="3.1 amsmath"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="amsmath" name="amsmath"></a>3.1 -<code class="filename">amsmath</code></h3> -</div> -</div> -</div> -<a id="idp8884448" class="indexterm" name="idp8884448"></a><a id= -"idp8885264" class="indexterm" name="idp8885264"></a> -<p><code class="literal">amsmath</code> consists of several -packages to aid in typesetting math.</p> -<div class="variablelist"><a id="boldsymbol-linkend" name= -"boldsymbol-linkend"></a> -<dl> -<dt><span class="term"><code class= -"literal">\boldsymbol</code></span></dt> -<dd><a id="idp8889984" class="indexterm" name="idp8889984"></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 class="link" href="#cmd-bm"><code class= -"literal">\bm</code></a> command which takes better care of -spacing.</p> -</dd> -<dt><a id="pmb-linkend" name="pmb-linkend"></a><span class= -"term"><code class="literal">\pmb</code></span></dt> -<dd><a id="idp8894896" class="indexterm" name="idp8894896"></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" title="3.2 dcolumn"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="dcolumn" name="dcolumn"></a>3.2 -<code class="filename">dcolumn</code></h3> -</div> -</div> -</div> -<a id="idp8899488" class="indexterm" name="idp8899488"></a><a id= -"idp8900304" class="indexterm" name="idp8900304"></a> -<p><code class="literal">\usepackage{dcolumn}</code></p> -<p>Defines a system for defining columns of entries in an -<code class="literal">array</code> or <code class= -"literal">tabular</code> which are to be aligned on a <span class= -"emphasis"><em>decimal point</em></span>.</p> -<p>This package defines <code class="literal">D</code> to be a -column specifier with three arguments:</p> -<pre class="programlisting"> -D{sep.tex}{sep.dvi}{decimal places} -</pre> -<p><code class="literal">sep.tex</code> should be a single -character, this is used as the separator in the <code class= -"literal">.tex</code> file. It will usually be '<code class= -"literal">.</code>' or '<code class="literal">,</code>'.</p> -<p><code class="literal">sep.dvi</code> is used as the separator in -the output.</p> -<p><code class="literal">decimal places</code> should be the -maximum number of decimal places in the column.</p> -<p><code class="literal">\newcolumntype</code> can be used to -define own column types.</p> -</div> -<div class="section" title="3.3 float"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="float" name="float"></a>3.3 <code class= -"filename">float</code></h3> -</div> -</div> -</div> -<a id="idp8915328" class="indexterm" name="idp8915328"></a> -<div class="note" title="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 -<code class="filename">float</code> v1.3d of 2001/11/08.</p> -</div> -<p><span class="quote">“<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>”</span></p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\newfloat{<placement>}{<ext>}[<within>]</code></span></dt> -<dd><a id="idp8921072" class="indexterm" name= -"idp8921072"></a><a id="idp8921888" class="indexterm" name= -"idp8921888"></a> -<p>Add a new class of floats.</p> -</dd> -<dt><span class="term"><code class= -"literal">\floatstyle{<style>}</code></span></dt> -<dd><a id="idp8925456" class="indexterm" name= -"idp8925456"></a><a id="idp8926272" class="indexterm" name= -"idp8926272"></a> -<p>Sets a default float style.</p> -</dd> -<dt><span class="term"><code class= -"literal">\floatname{<style>}{<name>}</code></span></dt> -<dd><a id="idp8929808" class="indexterm" name= -"idp8929808"></a><a id="idp8930624" class="indexterm" name= -"idp8930624"></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"><code class= -"literal">\floatplacement{<>}{<placement>}</code></span></dt> -<dd><a id="idp8934608" class="indexterm" name= -"idp8934608"></a><a id="idp8935424" class="indexterm" name= -"idp8935424"></a> -<p>Resets the default placement specifier of a class of floats.</p> -</dd> -<dt><span class="term"><code class= -"literal">\restylefloat<style></code></span></dt> -<dd><a id="idp8938976" class="indexterm" name= -"idp8938976"></a><a id="idp8939792" class="indexterm" name= -"idp8939792"></a> -<p>Change styles for the standard float types <code class= -"literal">figure</code> and <code class="literal">table</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">\listof{<type>}{<title>}</code></span></dt> -<dd><a id="idp8944768" class="indexterm" name= -"idp8944768"></a><a id="idp8945584" class="indexterm" name= -"idp8945584"></a> -<p>Produces a list of all floats of a given class.</p> -</dd> -</dl> -</div> -</div> -<div class="section" title="3.4 fontenc"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="fontenc" name="fontenc"></a>3.4 -<code class="filename">fontenc</code></h3> -</div> -</div> -</div> -<a id="idp8950272" class="indexterm" name="idp8950272"></a> -<p><code class="literal">\usepackage[T1]{fontenc}</code></p> -<p>chooses T1-fonts and allows correct automatic hyphenation.</p> -</div> -<div class="section" title="3.5 german"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="german" name="german"></a>3.5 <code class= -"filename">german</code></h3> -</div> -</div> -</div> -<a id="idp8954880" class="indexterm" name="idp8954880"></a><a id= -"idp8955696" class="indexterm" name="idp8955696"></a> -<p>Das <code class="literal">german</code> Paket muß geladen -sein:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">"a</code></span></dt> -<dd><a id="idp8960208" class="indexterm" name="idp8960208"></a> -<p>erzeugt ein <span class="emphasis"><em>ä</em></span></p> -<p>entsprechend <code class="literal">"o</code>, <code class= -"literal">"u</code>, <code class="literal">"A</code>, <code class= -"literal">"O</code>, <code class="literal">"U</code>, <code class= -"literal">"s (ß)</code></p> -</dd> -<dt><span class="term"><code class="literal">"ck</code></span></dt> -<dd><a id="idp8968464" class="indexterm" name="idp8968464"></a> -<p>wird bei Trennung zu <code class="literal">k-k</code></p> -</dd> -<dt><span class="term"><code class="literal">"ff</code></span></dt> -<dd><a id="idp8972512" class="indexterm" name="idp8972512"></a> -<p>wird bei Trennung zu <code class="literal">ff-f</code></p> -<p>entsprechend <code class="literal">"ll</code>, <code class= -"literal">"mm</code>, <code class="literal">"pp</code>, -<code class="literal">"rr</code>, <code class= -"literal">"tt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">\glqq</code></span></dt> -<dd><a id="idp8980512" class="indexterm" name="idp8980512"></a> -<p>oder <code class="literal">"`</code> erzeugt untere doppelte -Anführungszeichen</p> -</dd> -<dt><a id="cmd-grqq" name="cmd-grqq"></a><span class= -"term"><code class="literal">\grqq</code></span></dt> -<dd><a id="idp8985248" class="indexterm" name="idp8985248"></a> -<p>oder <code class="literal">"'</code> erzeugt obere doppelte -Anführungszeichen</p> -</dd> -<dt><span class="term"><code class= -"literal">\glq</code></span></dt> -<dd><a id="idp8989552" class="indexterm" name="idp8989552"></a> -<p>erzeugt untere einfache Anführungszeichen</p> -</dd> -<dt><span class="term"><code class= -"literal">\flqq</code></span></dt> -<dd><a id="idp8993120" class="indexterm" name="idp8993120"></a> -<p>oder <code class="literal">"<</code> doppelte linke -französische Anführungszeichen</p> -</dd> -<dt><span class="term"><code class= -"literal">\frqq</code></span></dt> -<dd><a id="idp8997424" class="indexterm" name="idp8997424"></a> -<p>oder <code class="literal">"></code> doppelte rechte -französische Anführungszeichen</p> -</dd> -<dt><span class="term"><code class= -"literal">\flq</code></span></dt> -<dd><a id="idp9001728" class="indexterm" name="idp9001728"></a> -<p>einfache linke französische Anführungszeichen</p> -</dd> -<dt><span class="term"><code class= -"literal">\frq</code></span></dt> -<dd><a id="idp9005296" class="indexterm" name="idp9005296"></a> -<p>einfache rechte französische Anführungszeichen</p> -</dd> -<dt><span class="term"><code class="literal">"|</code></span></dt> -<dd><a id="idp9008832" class="indexterm" name="idp9008832"></a> -<p>verhindert eine Ligatur an der Stelle</p> -</dd> -<dt><span class="term"><code class="literal">\-</code></span></dt> -<dd><a id="idp9012272" class="indexterm" name="idp9012272"></a> -<p>markiert mögliche Trennstelle, im restlichen Wort ist keine -Trennung mehr möglich</p> -</dd> -<dt><span class="term"><code class="literal">"-</code></span></dt> -<dd><a id="idp9015904" class="indexterm" name="idp9015904"></a> -<p>Trennvorschlag, der Rest des Wortes kann noch automatisch -getrennt werden</p> -</dd> -<dt><span class="term"><code class="literal">""</code></span></dt> -<dd><a id="idp9019488" class="indexterm" name="idp9019488"></a> -<p>Trennvorschlag, bei dem bei einer Trennung kein Bindestrich -eingefügt wird</p> -</dd> -<dt><span class="term"><code class="literal">"~</code></span></dt> -<dd><a id="idp9023056" class="indexterm" name="idp9023056"></a> -<p>Bindestrich, an dem nicht getrennt werden darf</p> -</dd> -<dt><span class="term"><code class="literal">"=</code></span></dt> -<dd><a id="idp9026512" class="indexterm" name="idp9026512"></a> -<p>Bindestrich, an dem getrennt werden darf</p> -</dd> -<dt><span class="term"><code class="literal">\dq</code></span></dt> -<dd><a id="idp9030016" class="indexterm" name="idp9030016"></a> -<p>erzeugt ein nicht-typographisches gerades -Anführungszeichen</p> -<pre class="programlisting"> -\texttt{\dq} -</pre></dd> -<dt><span class="term"><code class= -"literal"><</code></span></dt> -<dd><a id="idp9034288" class="indexterm" name="idp9034288"></a> -<p>oder <code class="literal">\dq</code> ergibt das -Zoll-Zeichen</p> -</dd> -</dl> -</div> -</div> -<div class="section" title="3.6 graphics"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="graphics" name="graphics"></a>3.6 -<code class="filename">graphics</code></h3> -</div> -</div> -</div> -<a id="idp9039840" class="indexterm" name="idp9039840"></a><a id= -"idp9040656" class="indexterm" name="idp9040656"></a> -<p>Look up details in <code class="filename">grfguide</code>.</p> -<div class="section" title="3.6.1 \includegraphics"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="includegraphics" name= -"includegraphics"></a>3.6.1 \includegraphics</h4> -</div> -</div> -</div> -<a id="idp9044768" class="indexterm" name="idp9044768"></a> -<p><code class= -"literal">\includegraphics[]{picture-name}</code></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" title="3.6.2 \graphicspath"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="graphicspath" name= -"graphicspath"></a>3.6.2 \graphicspath</h4> -</div> -</div> -</div> -<a id="idp9048736" class="indexterm" name="idp9048736"></a> -<p><code class="literal">\graphicspath{dir-list}</code></p> -<p><code class="literal">dir-list</code> is a list of absolute or -relative paths, where the command <a class="link" href= -"#includegraphics" title="3.6.1 \includegraphics"><code class= -"literal">\includegraphics{}</code></a> searches for the graphic -files:</p> -<p><code class="literal">\graphicspath{{eps/}{tiff/}}</code> would -cause the system to look in the subdirectories <code class= -"literal">eps</code> and <code class="literal">tiff</code> of the -current directory. This is unix syntax, on a Mac it would be:</p> -<p><code class="literal">\graphicspath{{:eps:}{:tiff:}}</code></p> -<p>Under Windows/DOS use also the slash <code class= -"literal">/</code> 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" title="3.7 hyperref"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="hyperref" name="hyperref"></a>3.7 -<code class="filename">hyperref</code></h3> -</div> -</div> -</div> -<a id="idp9060176" class="indexterm" name="idp9060176"></a><a id= -"idp9061248" class="indexterm" name="idp9061248"></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" title="3.7.1 Options"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="hyperref-options" name= -"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="idp9067600" class="indexterm" name="idp9067600"></a> -<p>use Acrobat 4 features (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">a4paper, a5paper, b5paper, legalpaper, -letterpaper, executivepaper</span></dt> -<dd><a id="idp9071872" class="indexterm" name= -"idp9071872"></a><a id="idp9073776" class="indexterm" name= -"idp9073776"></a><a id="idp9075680" class="indexterm" name= -"idp9075680"></a><a id="idp9077584" class="indexterm" name= -"idp9077584"></a><a id="idp9079488" class="indexterm" name= -"idp9079488"></a><a id="idp9081392" class="indexterm" name= -"idp9081392"></a> -<p>use the specified paper size.</p> -</dd> -<dt><span class="term">anchorcolor</span></dt> -<dd><a id="idp9084912" class="indexterm" name="idp9084912"></a> -<p>set color of anchors (default: <code class= -"literal">black</code>).</p> -</dd> -<dt><span class="term">backref</span></dt> -<dd><a id="idp9089152" class="indexterm" name="idp9089152"></a> -<p>do bibliographical back references (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">baseurl</span></dt> -<dd><a id="idp9093408" class="indexterm" name="idp9093408"></a> -<p>set base URL for document (default: <code class= -"literal">empty</code>).</p> -</dd> -<dt><span class="term">bookmarks</span></dt> -<dd><a id="idp9097664" class="indexterm" name="idp9097664"></a> -<p>make bookmarks (default: <code class="literal">true</code>).</p> -</dd> -<dt><span class="term">bookmarksnumbered</span></dt> -<dd><a id="idp9101904" class="indexterm" name="idp9101904"></a> -<p>put section numbers in bookmarks (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">bookmarksopen</span></dt> -<dd><a id="idp9106160" class="indexterm" name="idp9106160"></a> -<p>open up bookmark tree (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">bookmarksopenlevel</span></dt> -<dd><a id="idp9110448" class="indexterm" name="idp9110448"></a> -<p>level to which bookmarks are open (default: <code class= -"literal">\maxdimen</code>).</p> -</dd> -<dt><span class="term">bookmarkstype</span></dt> -<dd><a id="idp9114704" class="indexterm" name="idp9114704"></a> -<p>to specify which `toc' file to mimic toc.</p> -</dd> -<dt><span class="term">breaklinks</span></dt> -<dd><a id="idp9118240" class="indexterm" name="idp9118240"></a> -<p>allow links to break over lines (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">citebordercolor</span></dt> -<dd><a id="idp9122496" class="indexterm" name="idp9122496"></a> -<p>color of border around cites (default: <code class="literal">0 1 -0</code>).</p> -</dd> -<dt><span class="term">citecolor</span></dt> -<dd><a id="idp9126752" class="indexterm" name="idp9126752"></a> -<p>color of citation links (default: <code class= -"literal">green</code>).</p> -</dd> -<dt><span class="term">colorlinks</span></dt> -<dd><a id="idp9130992" class="indexterm" name="idp9130992"></a> -<p>color links (default: <code class="literal">false</code>).</p> -</dd> -<dt><span class="term">debug</span></dt> -<dd><a id="idp9135232" class="indexterm" name="idp9135232"></a> -<p>provide details of anchors defined (same as verbose, default: -<code class="literal">false</code>).</p> -</dd> -<dt><span class="term">draft</span></dt> -<dd><a id="idp9139520" class="indexterm" name="idp9139520"></a> -<p>do not do any hyper linking (default: <code class= -"literal">false</code>).</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="idp9144256" class="indexterm" name= -"idp9144256"></a><a id="idp9146160" class="indexterm" name= -"idp9146160"></a><a id="idp9148064" class="indexterm" name= -"idp9148064"></a><a id="idp9149968" class="indexterm" name= -"idp9149968"></a><a id="idp9151872" class="indexterm" name= -"idp9151872"></a><a id="idp9153776" class="indexterm" name= -"idp9153776"></a><a id="idp9155680" class="indexterm" name= -"idp9155680"></a><a id="idp9157584" class="indexterm" name= -"idp9157584"></a><a id="idp9159488" class="indexterm" name= -"idp9159488"></a><a id="idp9161392" class="indexterm" name= -"idp9161392"></a><a id="idp9163296" class="indexterm" name= -"idp9163296"></a> -<p>use the specified backend.</p> -</dd> -<dt><span class="term">extension</span></dt> -<dd><a id="idp9166816" class="indexterm" name="idp9166816"></a> -<p>suffix of linked files (default: <code class= -"literal">dvi</code>).</p> -</dd> -<dt><span class="term">filebordercolor</span></dt> -<dd><a id="idp9171072" class="indexterm" name="idp9171072"></a> -<p>color of border around file links (default: <code class= -"literal">0 .5 .5</code>).</p> -</dd> -<dt><span class="term">filecolor</span></dt> -<dd><a id="idp9175328" class="indexterm" name="idp9175328"></a> -<p>color of file links (default: <code class= -"literal">cyan</code>).</p> -</dd> -<dt><span class="term">frenchlinks</span></dt> -<dd><a id="idp9179568" class="indexterm" name="idp9179568"></a> -<p>use small caps instead of color for links (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">hyperfigures</span></dt> -<dd><a id="idp9183840" class="indexterm" name="idp9183840"></a> -<p>make figures hyper links (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">hyperindex</span></dt> -<dd><a id="idp9188096" class="indexterm" name="idp9188096"></a> -<p>set up hyperlinked indices (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">hypertexnames</span></dt> -<dd><a id="idp9192352" class="indexterm" name="idp9192352"></a> -<p>use guessable names for links (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">implicit</span></dt> -<dd><a id="idp9196608" class="indexterm" name="idp9196608"></a> -<p>redefine LaTeX internals (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">linkbordercolor</span></dt> -<dd><a id="idp9201296" class="indexterm" name="idp9201296"></a> -<p>color of border around links (default: <code class="literal">1 0 -0</code>).</p> -</dd> -<dt><span class="term">linkcolor</span></dt> -<dd><a id="idp9205552" class="indexterm" name="idp9205552"></a> -<p>color of links (default: <code class="literal">red</code>).</p> -</dd> -<dt><span class="term">linktocpage</span></dt> -<dd><a id="idp9209808" class="indexterm" name="idp9209808"></a> -<p>make page number, not text, be link on TOC, LOF and LOT -(default: <code class="literal">false</code>).</p> -</dd> -<dt><span class="term">menubordercolor</span></dt> -<dd><a id="idp9214096" class="indexterm" name="idp9214096"></a> -<p>color of border around menu links (default: <code class= -"literal">1 0 0</code>).</p> -</dd> -<dt><span class="term">menucolor</span></dt> -<dd><a id="idp9218352" class="indexterm" name="idp9218352"></a> -<p>color for menu links (default: <code class= -"literal">red</code>).</p> -</dd> -<dt><span class="term">naturalnames</span></dt> -<dd><a id="idp9222560" class="indexterm" name="idp9222560"></a> -<p>use LaTeX-computed names for links (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">nesting</span></dt> -<dd><a id="idp9227264" class="indexterm" name="idp9227264"></a> -<p>allow nesting of links (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">pageanchor</span></dt> -<dd><a id="idp9231504" class="indexterm" name="idp9231504"></a> -<p>put an anchor on every page (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">pagebackref</span></dt> -<dd><a id="idp9235760" class="indexterm" name="idp9235760"></a> -<p>backreference by page number (default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">pagebordercolor</span></dt> -<dd><a id="idp9240016" class="indexterm" name="idp9240016"></a> -<p>color of border around page links (default: <code class= -"literal">1 1 0</code>).</p> -</dd> -<dt><span class="term">pagecolor</span></dt> -<dd><a id="idp9244272" class="indexterm" name="idp9244272"></a> -<p>color of page links (default: <code class= -"literal">red</code>).</p> -</dd> -<dt><span class="term">pdfauthor</span></dt> -<dd><a id="idp9248480" class="indexterm" name="idp9248480"></a> -<p>text for PDF Author field (default: empty).</p> -</dd> -<dt><span class="term">pdfborder</span></dt> -<dd><a id="idp9252016" class="indexterm" name="idp9252016"></a> -<p>width of PDF link border (default: <code class="literal">0 0 -1</code>; <code class="literal">0 0 0</code> for <code class= -"literal">colorlinks</code>)</p> -</dd> -<dt><span class="term">pdfcenterwindow</span></dt> -<dd><a id="idp9257712" class="indexterm" name="idp9257712"></a> -<p>position the document window center of the screen (default: -<code class="literal">false</code>).</p> -</dd> -<dt><span class="term">pdfcreator</span></dt> -<dd><a id="idp9261984" class="indexterm" name="idp9261984"></a> -<p>text for PDF Creator field (default: LaTeX with hyperref -package).</p> -</dd> -<dt><span class="term">pdffitwindow</span></dt> -<dd><a id="idp9265984" class="indexterm" name="idp9265984"></a> -<p>resize document window to fit document size (default: -<code class="literal">false</code>).</p> -</dd> -<dt><span class="term">pdfhighlight</span></dt> -<dd><a id="idp9270256" class="indexterm" name="idp9270256"></a> -<p>set highlighting of PDF links (default: <code class= -"literal">/I</code>).</p> -</dd> -<dt><span class="term">pdfkeywords</span></dt> -<dd><a id="idp9274480" class="indexterm" name="idp9274480"></a> -<p>text for PDF Keywords field (default: empty).</p> -</dd> -<dt><span class="term">pdfmenubar</span></dt> -<dd><a id="idp9278016" class="indexterm" name="idp9278016"></a> -<p>make PDF viewer's menu bar visible (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">pdfnewwindow</span></dt> -<dd><a id="idp9282272" class="indexterm" name="idp9282272"></a> -<p>make links that open another PDF file start a new window -(default: <code class="literal">false</code>).</p> -</dd> -<dt><span class="term">pdfpagelayout</span></dt> -<dd><a id="idp9286560" class="indexterm" name="idp9286560"></a> -<p>set layout of PDF pages (default: empty).</p> -</dd> -<dt><span class="term">pdfpagemode</span></dt> -<dd><a id="idp9290096" class="indexterm" name="idp9290096"></a> -<p>set default mode of PDF display (default: empty).</p> -</dd> -<dt><span class="term">pdfpagescrop</span></dt> -<dd><a id="idp9293648" class="indexterm" name="idp9293648"></a> -<p>set crop size of PDF document (default: empty).</p> -</dd> -<dt><span class="term">pdfpagetransition</span></dt> -<dd><a id="idp9297184" class="indexterm" name="idp9297184"></a> -<p>set PDF page transition style (default: empty).</p> -</dd> -<dt><span class="term">pdfproducer</span></dt> -<dd><a id="idp9300720" class="indexterm" name="idp9300720"></a> -<p>text for PDF Producer field (default: empty).</p> -</dd> -<dt><span class="term">pdfstartpage</span></dt> -<dd><a id="idp9304256" class="indexterm" name="idp9304256"></a> -<p>page at which PDF document opens (default: <code class= -"literal">1</code>).</p> -</dd> -<dt><span class="term">pdfstartview</span></dt> -<dd><a id="idp9308480" class="indexterm" name="idp9308480"></a> -<p>starting view of PDF document (default: <code class= -"literal">/Fit</code>).</p> -</dd> -<dt><span class="term">pdfsubject</span></dt> -<dd><a id="idp9312736" class="indexterm" name="idp9312736"></a> -<p>text for PDF Subject field (default: empty).</p> -</dd> -<dt><span class="term">pdftitle</span></dt> -<dd><a id="idp9316368" class="indexterm" name="idp9316368"></a> -<p>text for PDF Title field(default: empty).</p> -</dd> -<dt><span class="term">pdftoolbar</span></dt> -<dd><a id="idp9319840" class="indexterm" name="idp9319840"></a> -<p>make PDF toolbar visible (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">pdfview</span></dt> -<dd><a id="idp9324096" class="indexterm" name="idp9324096"></a> -<p>PDF `view' when on link traversal (default: empty).</p> -</dd> -<dt><span class="term">pdfwindowui</span></dt> -<dd><a id="idp9327696" class="indexterm" name="idp9327696"></a> -<p>make PDF user interface elements visible (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">plainpages</span></dt> -<dd><a id="idp9331968" class="indexterm" name="idp9331968"></a> -<p>do page number anchors as plain arabic (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">raiselinks</span></dt> -<dd><a id="idp9336240" class="indexterm" name="idp9336240"></a> -<p>raise up links (for HyperTeX backend; default: <code class= -"literal">false</code>).</p> -</dd> -<dt><span class="term">runbordercolor</span></dt> -<dd><a id="idp9340512" class="indexterm" name="idp9340512"></a> -<p>color of border around run links (default: <code class= -"literal">0 .7 .7</code>).</p> -</dd> -<dt><span class="term">unicode</span></dt> -<dd><a id="idp9344768" class="indexterm" name="idp9344768"></a> -<p>Unicode encoded pdf strings (default: <code class= -"literal">true</code>).</p> -</dd> -<dt><span class="term">urlbordercolor</span></dt> -<dd><a id="idp9349024" class="indexterm" name="idp9349024"></a> -<p>color of border around URL links (default: <code class= -"literal">0 1 1</code>).</p> -</dd> -<dt><span class="term">urlcolor</span></dt> -<dd><a id="idp9353280" class="indexterm" name="idp9353280"></a> -<p>color of URL links (default: <code class= -"literal">magenta</code>).</p> -</dd> -<dt><span class="term">verbose</span></dt> -<dd><a id="idp9357520" class="indexterm" name="idp9357520"></a> -<p>be chatty (default: <code class="literal">false</code>).</p> -</dd> -</dl> -</div> -</div> -<div class="section" title="3.7.2 Commands"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="hyperref-commands" name= -"hyperref-commands"></a>3.7.2 Commands</h4> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\texorpdfstring{TeX-string}{pdf-string}</code></span></dt> -<dd><a id="idp9364528" class="indexterm" name="idp9364528"></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" name="href"></a><span class="term"><code class= -"literal">\href{URL}{Text}</code></span></dt> -<dd><a id="idp9370096" class="indexterm" name="idp9370096"></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 class="link" -href="#cmd-hyperbaseurl"><code class= -"literal">\hyperbaseurl</code></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" name= -"cmd-hyperbaseurl"></a><code class= -"literal">\hyperbaseurl{URL}</code></span></dt> -<dd><a id="idp9376624" class="indexterm" name="idp9376624"></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"><code class= -"literal">\hyperimage{image-URL}</code></span></dt> -<dd><a id="idp9380608" class="indexterm" name="idp9380608"></a> -<p>includes the picture of the URL reference.</p> -</dd> -<dt><span class="term"><code class= -"literal">\hyperref{URL}{category}{name}{text}</code>,</span> -<span class="term"><code class= -"literal">\hyperref[mark]{text}</code></span></dt> -<dd><a id="idp9385424" class="indexterm" name="idp9385424"></a> -<p><code class="literal">text</code> is activated as a hyperlink to -the point which is defined with a <a class="link" href= -"#cmd-label-title" title="2.3.2. \label{key}"><code class= -"filename">\label</code></a> command with the symbolic name -<code class="literal">mark</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">\hyperlink{name}{text}</code>,</span> <span class= -"term"><code class= -"literal">\hyertarget{name}{text}</code></span></dt> -<dd><a id="idp9393072" class="indexterm" name= -"idp9393072"></a><a id="idp9394976" class="indexterm" name= -"idp9394976"></a> -<p><code class="literal">\hyperlink</code> creates an internal link -to an object which is somewhere defined with a <code class= -"literal">\hypertarget</code> command.</p> -<p>For HTML the command <code class="literal">\hyperlink</code> -inserts a <code class="literal">#</code> character in front of each -link. Thus it'll refer to the topical document, while <code class= -"literal">\href</code> will expect a complete URL.</p> -</dd> -<dt><span class="term"><code class= -"literal">\autoref{marker}</code></span></dt> -<dd><a id="idp9402864" class="indexterm" name="idp9402864"></a> -<p><code class="literal">\autoref</code> is a substitution for the -standard <code class="literal">\ref</code> command. It inserts a -context sensitive phrase.</p> -<pre class="programlisting"> -see \autoref{foo} -</pre> -<p>for a <code class="literal">\label</code> 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 <code class="literal">\renewcommand</code>:</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" name= -"cmd-nolinkurl"></a><code class= -"literal">\nolinkurl</code></span></dt> -<dd><a id="idp9413248" class="indexterm" name="idp9413248"></a> -<p>Allows line breaks in a verbatim like environment like -<code class="literal">\url</code>, 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 <code class="literal">\urlw</code> -allows the user to typeset a linkable (this function is offered by -<code class="literal">\href</code>) <code class= -"literal">www.example.org</code> address in the latex source like -this:</p> -<pre class="programlisting"> -\urlw{example.org} -</pre> -<p>This will produce the string <code class= -"literal">www.example.org</code> which is hyperlinked and breakable -(when the driver like pdfTeX allows line breaks in links).</p> -</dd> -</dl> -</div> -</div> -</div> -<div class="section" title="3.8 inputenc"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="inputenc" name="inputenc"></a>3.8 -<code class="filename">inputenc</code></h3> -</div> -</div> -</div> -<a id="idp9424944" class="indexterm" name="idp9424944"></a> -<p><code class="literal">\usepackage[encoding -name]{inputenc}</code></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"><code class="literal">latin9, -latin1</code></span></dt> -<dd> -<p class="simpara">Linux, Unix, VMS</p> -<a id="idp9429952" class="indexterm" name="idp9429952"></a><a id= -"idp9430768" class="indexterm" name="idp9430768"></a></dd> -<dt><span class="term"><code class= -"literal">ansinew</code></span></dt> -<dd> -<p class="simpara">Windows (codepage 1252)</p> -<a id="idp9433584" class="indexterm" name="idp9433584"></a></dd> -<dt><span class="term"><code class= -"literal">cp850</code></span></dt> -<dd> -<p class="simpara">OS/2, MSDOS (codpage 850)</p> -<a id="idp9436544" class="indexterm" name="idp9436544"></a></dd> -<dt><span class="term"><code class= -"literal">applemac</code></span></dt> -<dd> -<p class="simpara">Apple Macintosh</p> -<a id="idp9439360" class="indexterm" name="idp9439360"></a></dd> -</dl> -</div> -</div> -<div class="section" title="3.9 KOMA-Script"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="komascript" name="komascript"></a>3.9 -<code class="filename">KOMA-Script</code></h3> -</div> -</div> -</div> -<a id="idp9442992" class="indexterm" name="idp9442992"></a><a id= -"idp9444032" class="indexterm" name="idp9444032"></a> -<p>The <code class="literal">KOMA-Script</code> package has a very -detailed and well written documentation. Read the <code class= -"literal">scrguide</code> for further information! :-)</p> -<div class="section" title="3.9.1 Page-Layout"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="komascript-page-layout" name= -"komascript-page-layout"></a>3.9.1 Page-Layout</h4> -</div> -</div> -</div> -<p><code class="literal">\typearea[BCOR]{DIV}</code></p> -<a id="idp9450080" class="indexterm" name="idp9450080"></a> -<p><code class= -"literal">\areaset[BCOR]{Breite}{Höhe}</code></p> -<a id="idp9451936" class="indexterm" name="idp9451936"></a></div> -<div class="section" title="3.9.2 Options"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="komascript-options" name= -"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="idp9456288" class="indexterm" name= -"idp9456288"></a><a id="idp9457472" class="indexterm" name= -"idp9457472"></a><a id="idp9458544" class="indexterm" name= -"idp9458544"></a><a id="idp9459616" class="indexterm" name= -"idp9459616"></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="idp9462448" class="indexterm" name="idp9462448"></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: <code class= -"literal">DIV12</code>.</p> -</dd> -<dt><span class="term">BCOR</span></dt> -<dd><a id="idp9466400" class="indexterm" name="idp9466400"></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" title="3.9.3 Letter Class scrlttr2"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="komascript-scrlttr2" name= -"komascript-scrlttr2"></a>3.9.3 Letter Class <code class= -"literal">scrlttr2</code></h4> -</div> -</div> -</div> -<a id="idp9470720" class="indexterm" name="idp9470720"></a> -<p>This reference is based on the excellent <code class= -"literal">scrguien.pdf</code> from 2002-09-06.</p> -<h5 class="title"><a id="idp9473376" name= -"idp9473376"></a>Options</h5> -<a id="idp9474064" class="indexterm" name="idp9474064"></a> -<h5 class="title"><a id="idp9475968" name="idp9475968"></a>Defining -Options Later</h5> -<a id="idp9476656" class="indexterm" name="idp9476656"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\KOMAoptions{options -list}</code></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="idp9481408" name="idp9481408"></a>Page -Layout Options</h5> -<a id="idp9482096" class="indexterm" name="idp9482096"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">paper=format</code></span></dt> -<dd>Defines the paper format.</dd> -<dt><span class="term"><code class= -"literal">BCOR=length</code>,</span> <span class= -"term"><code class="literal">DIV=value</code>,</span> <span class= -"term"><code class="literal">headlines=count</code></span></dt> -<dd>Divisor, binding correction, and number of headlines.</dd> -<dt><span class="term"><code class= -"literal">enlargefirstpage</code></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="idp9492960" name="idp9492960"></a>Other -Layout Options</h5> -<a id="idp9493648" class="indexterm" name="idp9493648"></a><a id= -"idp9495552" class="indexterm" name="idp9495552"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">twoside</code></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"><code class= -"literal">cleardoublepage=style</code></span></dt> -<dd> -<p class="simpara">Inserted pages by <code class= -"literal">\cleardoublepage</code> get one of these page styles:</p> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc"> -<li class="listitem"><code class="literal">empty</code></li> -<li class="listitem"><code class="literal">plain</code></li> -<li class="listitem"><code class="literal">standard</code></li> -</ul> -</div> -</dd> -<dt><span class="term"><code class= -"literal">headsepline</code>,</span> <span class= -"term"><code class="literal">footsepline</code></span></dt> -<dd>Insert a separator line below the head or above the foot.</dd> -<dt><span class="term"><code class= -"literal">mpinclude</code>,</span> <span class="term"><code class= -"literal">mpexclude</code></span></dt> -<dd>These two options of the <code class="literal">typearea</code> -package should not be used with <code class= -"literal">scrlttr2</code>.</dd> -<dt><span class="term"><code class= -"literal">pagenumber=position</code></span></dt> -<dd> -<p class="simpara">This option defines if and where a page number -will be placed. Possible values are:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">bot</code>,</span> -<span class="term"><code class="literal">foot</code></span></dt> -<dd>Page number in foot, horizontal position not changed</dd> -<dt><span class="term"><code class= -"literal">botcenter</code>,</span> <span class="term"><code class= -"literal">botcentered</code>,</span> <span class= -"term"><code class="literal">botmiddle</code>,</span> <span class= -"term"><code class="literal">footcenter</code>,</span> <span class= -"term"><code class="literal">footcentered</code>,</span> -<span class="term"><code class= -"literal">footmiddle</code></span></dt> -<dd>Page number infoot,centered</dd> -<dt><span class="term"><code class="literal">botleft</code>,</span> -<span class="term"><code class= -"literal">footleft</code></span></dt> -<dd>Page number in foot, left justified</dd> -<dt><span class="term"><code class= -"literal">botrigth</code>,</span> <span class="term"><code class= -"literal">footright</code></span></dt> -<dd>Page number in foot, right justified</dd> -<dt><span class="term"><code class="literal">center</code>,</span> -<span class="term"><code class="literal">centered</code>,</span> -<span class="term"><code class="literal">middle</code></span></dt> -<dd>Page number centered horizontally, vertical position not -changed</dd> -<dt><span class="term"><code class="literal">false</code>,</span> -<span class="term"><code class="literal">no</code>,</span> -<span class="term"><code class="literal">off</code></span></dt> -<dd>No page number</dd> -<dt><span class="term"><code class="literal">head</code>,</span> -<span class="term"><code class="literal">top</code></span></dt> -<dd>Page number in head, horizontal position not changed</dd> -<dt><span class="term"><code class= -"literal">headcenter</code>,</span> <span class="term"><code class= -"literal">headcentered</code>,</span> <span class= -"term"><code class="literal">headmiddle</code>,</span> <span class= -"term"><code class="literal">topcenter</code>,</span> <span class= -"term"><code class="literal">topcentered</code>,</span> -<span class="term"><code class= -"literal">topmiddle</code></span></dt> -<dd>Page number in head, centered</dd> -<dt><span class="term"><code class= -"literal">headleft</code>,</span> <span class="term"><code class= -"literal">topleft</code></span></dt> -<dd>Page number in head, left justified</dd> -<dt><span class="term"><code class= -"literal">headright</code>,</span> <span class="term"><code class= -"literal">topright</code></span></dt> -<dd>Page number in head, right justified</dd> -<dt><span class="term"><code class= -"literal">left</code></span></dt> -<dd>Page number left, vertical position not changed</dd> -<dt><span class="term"><code class= -"literal">right</code></span></dt> -<dd>Page number right, vertical position not changed</dd> -</dl> -</div> -<p class="simpara">Default is <code class= -"literal">botcenter</code></p> -</dd> -<dt><span class="term"><code class= -"literal">parskip=value</code></span></dt> -<dd> -<p class="simpara">Mark paragraphs alternatively by vertical skip. -Possible values are:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">false</code>,</span> -<span class="term"><code class="literal">off</code></span></dt> -<dd>Paragraph indentation instead of verticalk space</dd> -<dt><span class="term"><code class="literal">full</code>,</span> -<span class="term"><code class="literal">on</code>,</span> -<span class="term"><code class="literal">true</code></span></dt> -<dd>One line vertical space between paragraphs; at least 1 em free -space in the last line.</dd> -<dt><span class="term"><code class= -"literal">full*</code></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"><code class= -"literal">full+</code></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"><code class= -"literal">full-</code></span></dt> -<dd>One line vertical space betwen paragraphs; last line of a -paragraph may be arbitrarily filled.</dd> -<dt><span class="term"><code class= -"literal">half</code></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"><code class= -"literal">half*</code></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"><code class= -"literal">half+</code></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"><code class= -"literal">half-</code></span></dt> -<dd>One line vertical space between paragraphs; last line may be -arbitrarily filled.</dd> -</dl> -</div> -<p class="simpara">Default is <code class= -"literal">false</code>.</p> -</dd> -</dl> -</div> -<h5 class="title"><a id="idp9584448" name="idp9584448"></a>Font -Options</h5> -<a id="idp9585136" class="indexterm" name="idp9585136"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">fontsize=size</code></span></dt> -<dd>Font size of the document. Defaults to <code class= -"literal">12pt</code>.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9590560" name="idp9590560"></a>Options -for Letterhead and Address</h5> -<a id="idp9591264" class="indexterm" name="idp9591264"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">fromalign</code></span></dt> -<dd> -<p class="simpara">Defines the placement of the from address in the -letterhead. Possible values are:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">center</code>,</span> -<span class="term"><code class="literal">centered</code>,</span> -<span class="term"><code class="literal">middle</code></span></dt> -<dd>Return address centered.</dd> -<dt><span class="term"><code class="literal">false</code>,</span> -<span class="term"><code class="literal">no</code>,</span> -<span class="term"><code class="literal">off</code></span></dt> -<dd>Standard design for return address.</dd> -<dt><span class="term"><code class= -"literal">left</code></span></dt> -<dd>Left justified return address.</dd> -<dt><span class="term"><code class= -"literal">rigth</code></span></dt> -<dd>Right justified return address.</dd> -</dl> -</div> -<p class="simpara">Default is <code class="literal">left</code></p> -</dd> -<dt><span class="term"><code class= -"literal">fromrule</code></span></dt> -<dd> -<p class="simpara">Allows to place a horizontal rule within return -address. Possible values are:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">afteraddress</code>,</span> <span class= -"term"><code class="literal">below</code>,</span> <span class= -"term"><code class="literal">true</code>,</span> <span class= -"term"><code class="literal">yes</code></span></dt> -<dd>Line below return address</dd> -<dt><span class="term"><code class= -"literal">aftername</code></span></dt> -<dd>Line right below sender's name</dd> -<dt><span class="term"><code class="literal">false</code>,</span> -<span class="term"><code class="literal">no</code>,</span> -<span class="term"><code class="literal">off</code></span></dt> -<dd>No line.</dd> -</dl> -</div> -<p class="simpara">Default is <code class= -"literal">false</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">fromphone</code></span></dt> -<dd>Defines whether the phone number will be part of the return -address.</dd> -<dt><span class="term"><code class= -"literal">fromfax</code></span></dt> -<dd>Defines whether the facsimile number will be part of the return -address.</dd> -<dt><span class="term"><code class= -"literal">fromemail</code></span></dt> -<dd>Defines whether the email address will be part of the return -address.</dd> -<dt><span class="term"><code class= -"literal">fromurl</code></span></dt> -<dd>Defines whether the URL will be part of the return -address.</dd> -<dt><span class="term"><code class= -"literal">fromlogo</code></span></dt> -<dd>Defines whether the logo will be part of the return -address.</dd> -<dt><span class="term"><code class= -"literal">addrfield</code></span></dt> -<dd>Defines whether a return address field will be set.</dd> -<dt><span class="term"><code class= -"literal">backaddress</code></span></dt> -<dd>Defines whether a return address for window envelopes will be -set.</dd> -<dt><span class="term"><code class= -"literal">subject</code></span></dt> -<dd> -<p class="simpara">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"><code class= -"literal">afteropening</code></span></dt> -<dd>Set subject after opening.</dd> -<dt><span class="term"><code class= -"literal">beforeopening</code></span></dt> -<dd>Set subject before opening.</dd> -<dt><span class="term"><code class= -"literal">titled</code></span></dt> -<dd>Add title to subject.</dd> -<dt><span class="term"><code class= -"literal">untitled</code></span></dt> -<dd>Do not add title to subject.</dd> -</dl> -</div> -<p class="simpara">Defaults are <code class= -"literal">beforeopening</code> and <code class= -"literal">untitled</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">locfield</code></span></dt> -<dd> -<p class="simpara">Toggle between presets for the field width of -additionbal sender attributes.</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">narrow</code></span></dt> -<dd>Small sender supplement field.</dd> -<dt><span class="term"><code class= -"literal">wide</code></span></dt> -<dd>Wide sender supplement field.</dd> -</dl> -</div> -<p class="simpara">Default is <code class= -"literal">narrow</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">foldmarks</code></span></dt> -<dd>Activates fold marks.</dd> -<dt><span class="term"><code class= -"literal">numericaldate</code></span></dt> -<dd>Toggles between standard, language-dependent date presentation -and a short, numerical one.</dd> -<dt><span class="term"><code class= -"literal">refline</code></span></dt> -<dd>Defines that the reference line may extend beyond the normal -type area.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9664320" name="idp9664320"></a>Format -Options</h5> -<a id="idp9665008" class="indexterm" name="idp9665008"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">draft</code></span></dt> -<dd>Toggles between the final and the draft version.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9669728" name="idp9669728"></a>Letter -Class Option Files</h5> -<a id="idp9670432" class="indexterm" name="idp9670432"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\LoadLetterOption{name}</code></span></dt> -<dd> -<p class="simpara">Load a <code class="literal">lco</code> file. -<code class="literal">name</code> is the filename without -suffix.</p> -<p>Predefined <code class="literal">lco</code> files:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">DIN</code></span></dt> -<dd>For A4 size paper, complying with DIN 676.</dd> -<dt><span class="term"><code class= -"literal">DINmtext</code></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"><code class= -"literal">KOMAold</code></span></dt> -<dd>Fo AQ4 paper size using a layout close to the obsolete -<code class="literal">scrlettr</code> class.</dd> -<dt><span class="term"><code class="literal">SN</code></span></dt> -<dd>For Swiss letters with address field on the right side, -according to SN 010 130</dd> -<dt><span class="term"><code class= -"literal">SNleft</code></span></dt> -<dd>For Swiss letters with address field on the left side.</dd> -</dl> -</div> -</dd> -<dt><span class="term"><code class= -"literal">\LetterOptionNeedsPaperSize{option name}{paper -size}</code></span></dt> -<dd>Useful to be abel to emit warnings if the user selects a -different paper size from the one the <code class= -"literal">lco</code> file is based on.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9692256" name="idp9692256"></a>General -Document Properties</h5> -<a id="idp9692928" class="indexterm" name="idp9692928"></a> -<h5 class="title"><a id="idp9694848" name="idp9694848"></a>Font -Selection</h5> -<a id="idp9695536" class="indexterm" name="idp9695536"></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"><code class= -"literal">backaddress</code></span></dt> -<dd>Back address for a window envelope</dd> -<dt><span class="term"><code class= -"literal">descriptionlabel</code></span></dt> -<dd>Label in a <code class="literal">description</code> -environment</dd> -<dt><span class="term"><code class= -"literal">fromaddress</code></span></dt> -<dd>Sender's address in letterhead</dd> -<dt><span class="term"><code class= -"literal">fromname</code></span></dt> -<dd>Sender's address in letterhead if different from <code class= -"literal">fromaddress</code></dd> -<dt><span class="term"><code class= -"literal">pagefoot</code></span></dt> -<dd>Footer, sometimes header of a page</dd> -<dt><span class="term"><code class= -"literal">pagehead</code></span></dt> -<dd>Header, sometimes footer of a page</dd> -<dt><span class="term"><code class= -"literal">pagenumber</code></span></dt> -<dd>Page number in footer or header</dd> -<dt><span class="term"><code class= -"literal">subject</code></span></dt> -<dd>Subject in the opening</dd> -<dt><span class="term"><code class= -"literal">title</code></span></dt> -<dd>Headline in the opening</dd> -</dl> -</div> -<h5 class="title"><a id="idp9718656" name="idp9718656"></a>Page -Style</h5> -<a id="idp9719344" class="indexterm" name="idp9719344"></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"><code class= -"literal">empty</code></span></dt> -<dd>Entirely empty headers and footers</dd> -<dt><span class="term"><code class= -"literal">plain</code></span></dt> -<dd>Empty head and and only page number in header or footer</dd> -<dt><span class="term"><code class= -"literal">headings</code></span></dt> -<dd>Automatic page headings</dd> -<dt><span class="term"><code class= -"literal">myheadings</code></span></dt> -<dd>Manual page headings</dd> -</dl> -</div> -<h5 class="title"><a id="idp9731008" name= -"idp9731008"></a>Variables</h5> -<a id="idp9731696" class="indexterm" name="idp9731696"></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"><code class= -"literal">\newkomavar[description]{name}</code>,</span> -<span class="term"><code class= -"literal">\newkomavar*[description]{name}</code>,</span> -<span class="term"><code class= -"literal">\addtoreffields{name}</code></span></dt> -<dd><a id="idp9738592" class="indexterm" name= -"idp9738592"></a><a id="idp9740496" class="indexterm" name= -"idp9740496"></a> -<p class="simpara"><code class="literal">\newkomavar</code> defines -a new variable, addressed with <code class= -"literal">name</code>.</p> -<p class="simpara">The command <code class= -"literal">\addtoreffields</code> adds the variable <code class= -"literal">name</code> to the reference fields. See section -<a class="link" href="#scrlttr-business-line" title= -"3.9.3. Business Line">Business Line</a>.</p> -<p class="simpara">The command <code class= -"literal">\newkomavar*</code> works like <code class= -"literal">\newkomavar</code> with an additional call of the command -<code class="literal">\addtoreffields</code>.</p> -</dd> -</dl> -</div> -<p>Overview of all variables:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">backaddress</code></span></dt> -<dd><a id="idp9752048" class="indexterm" name="idp9752048"></a> -<p class="simpara">Back address for window envelopes</p> -</dd> -<dt><span class="term"><code class= -"literal">backaddressseparator</code></span></dt> -<dd><a id="idp9755968" class="indexterm" name="idp9755968"></a> -<p class="simpara">Separator within the back address</p> -</dd> -<dt><span class="term"><code class= -"literal">ccseparator</code></span></dt> -<dd><a id="idp9759888" class="indexterm" name="idp9759888"></a> -<p class="simpara">Separator between title of additional recipients -and additional recipients</p> -</dd> -<dt><span class="term"><code class= -"literal">customer</code></span></dt> -<dd><a id="idp9763856" class="indexterm" name="idp9763856"></a> -<p class="simpara">Customer number</p> -</dd> -<dt><span class="term"><code class= -"literal">date</code></span></dt> -<dd><a id="idp9767760" class="indexterm" name="idp9767760"></a> -<p class="simpara">Date</p> -</dd> -<dt><span class="term"><code class= -"literal">emailseparator</code></span></dt> -<dd><a id="idp9771664" class="indexterm" name="idp9771664"></a> -<p class="simpara">Separator between e-mail name and e-mail -address</p> -</dd> -<dt><span class="term"><code class= -"literal">enclseparator</code></span></dt> -<dd><a id="idp9775616" class="indexterm" name="idp9775616"></a> -<p class="simpara">Separator between title of enclosure and and -enclosures</p> -</dd> -<dt><span class="term"><code class= -"literal">faxseparator</code></span></dt> -<dd><a id="idp9779568" class="indexterm" name="idp9779568"></a> -<p class="simpara">Separator between title of fax and fax -number</p> -</dd> -<dt><span class="term"><code class= -"literal">fromaddress</code></span></dt> -<dd><a id="idp9783520" class="indexterm" name="idp9783520"></a> -<p class="simpara">Sender's address without its name</p> -</dd> -<dt><span class="term"><code class= -"literal">frombank</code></span></dt> -<dd><a id="idp9787440" class="indexterm" name="idp9787440"></a> -<p class="simpara">Sender's bank account</p> -</dd> -<dt><span class="term"><code class= -"literal">fromemail</code></span></dt> -<dd><a id="idp9791344" class="indexterm" name="idp9791344"></a> -<p class="simpara">Sender's e-mail</p> -</dd> -<dt><span class="term"><code class= -"literal">fromfax</code></span></dt> -<dd><a id="idp9795248" class="indexterm" name="idp9795248"></a> -<p class="simpara">Sender's fax number</p> -</dd> -<dt><span class="term"><code class= -"literal">fromlogo</code></span></dt> -<dd><a id="idp9799152" class="indexterm" name="idp9799152"></a> -<p class="simpara">Commands for inserting the sender's logo</p> -</dd> -<dt><span class="term"><code class= -"literal">fromname</code></span></dt> -<dd><a id="idp9803088" class="indexterm" name="idp9803088"></a> -<p class="simpara">Complete name of the sender</p> -</dd> -<dt><span class="term"><code class= -"literal">fromphone</code></span></dt> -<dd><a id="idp9807008" class="indexterm" name="idp9807008"></a> -<p class="simpara">Sender's telephone number</p> -</dd> -<dt><span class="term"><code class= -"literal">fromurl</code></span></dt> -<dd><a id="idp9810928" class="indexterm" name="idp9810928"></a> -<p class="simpara">URL of the sender</p> -</dd> -<dt><span class="term"><code class= -"literal">invoice</code></span></dt> -<dd><a id="idp9814832" class="indexterm" name="idp9814832"></a> -<p class="simpara">Invoice number</p> -</dd> -<dt><span class="term"><code class= -"literal">location</code></span></dt> -<dd><a id="idp9818736" class="indexterm" name="idp9818736"></a> -<p class="simpara">More details of the sender</p> -</dd> -<dt><span class="term"><code class= -"literal">myref</code></span></dt> -<dd><a id="idp9822656" class="indexterm" name="idp9822656"></a> -<p class="simpara">Sender's reference</p> -</dd> -<dt><span class="term"><code class= -"literal">place</code></span></dt> -<dd><a id="idp9826560" class="indexterm" name="idp9826560"></a> -<p class="simpara">Place</p> -</dd> -<dt><span class="term"><code class= -"literal">placeseparator</code></span></dt> -<dd><a id="idp9830464" class="indexterm" name="idp9830464"></a> -<p class="simpara">Separator between place and date</p> -</dd> -<dt><span class="term"><code class= -"literal">phoneseparator</code></span></dt> -<dd><a id="idp9834384" class="indexterm" name="idp9834384"></a> -<p class="simpara">Separator between title of telephone and -telephone number</p> -</dd> -<dt><span class="term"><code class= -"literal">signature</code></span></dt> -<dd><a id="idp9838336" class="indexterm" name="idp9838336"></a> -<p class="simpara">Signature beneath the ending of the letter</p> -</dd> -<dt><span class="term"><code class= -"literal">specialmail</code></span></dt> -<dd><a id="idp9842272" class="indexterm" name="idp9842272"></a> -<p class="simpara">Special mail</p> -</dd> -<dt><span class="term"><code class= -"literal">subject</code></span></dt> -<dd><a id="idp9846176" class="indexterm" name="idp9846176"></a> -<p class="simpara">Subject</p> -</dd> -<dt><span class="term"><code class= -"literal">subjectseparator</code></span></dt> -<dd><a id="idp9850080" class="indexterm" name="idp9850080"></a> -<p class="simpara">Separator between title of subject and -subject</p> -</dd> -<dt><span class="term"><code class= -"literal">title</code></span></dt> -<dd><a id="idp9854032" class="indexterm" name="idp9854032"></a> -<p class="simpara">Letter title</p> -</dd> -<dt><span class="term"><code class= -"literal">toname</code></span></dt> -<dd><a id="idp9857936" class="indexterm" name="idp9857936"></a> -<p class="simpara">Complete name of recipient</p> -</dd> -<dt><span class="term"><code class= -"literal">toaddress</code></span></dt> -<dd><a id="idp9861856" class="indexterm" name="idp9861856"></a> -<p class="simpara">Address of recipient without its name</p> -</dd> -<dt><span class="term"><code class= -"literal">yourmail</code></span></dt> -<dd><a id="idp9865776" class="indexterm" name="idp9865776"></a> -<p class="simpara">Date of recipient's mail</p> -</dd> -<dt><span class="term"><code class= -"literal">yourref</code></span></dt> -<dd><a id="idp9869696" class="indexterm" name="idp9869696"></a> -<p class="simpara">Recipient's reference</p> -</dd> -</dl> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\setkomavar{name}[description]{content}</code>,</span> -<span class="term"><code class= -"literal">\setkomavar*{name}{description}</code></span></dt> -<dd><a id="idp9875216" class="indexterm" name="idp9875216"></a> -<p class="simpara"><code class="literal">\setkomavar</code> sets -the content of the variable <code class="literal">name</code>. The -optional argument sets the <code class="literal">description</code> -of the variable.</p> -<p class="simpara"><code class="literal">\setkomavar*</code> only -sets the <code class="literal">description</code>.</p> -</dd> -</dl> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\usekomavar[command]{name}</code>,</span> <span class= -"term"><code class= -"literal">\usekomavar*[command]{name}</code></span></dt> -<dd><a id="idp9884544" class="indexterm" name="idp9884544"></a> -<p class="simpara"><code class="literal">\usekomavar</code> gives -you access to the content of the variable <code class= -"literal">name</code>.</p> -<p class="simpara"><code class="literal">\usekomavar*</code> gives -you access to the <code class="literal">description</code> of the -variable <code class="literal">name</code>.</p> -</dd> -</dl> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\ifkomavarempty{name}{true}{false}</code>,</span> -<span class="term"><code class= -"literal">\ifkomavarempty*{name}{true}{false}</code></span></dt> -<dd><a id="idp9893824" class="indexterm" name="idp9893824"></a> -<p class="simpara">The <code class="literal">true</code> argument -will be executed if the content or description is empty. Otherwise -the <code class="literal">false</code> argument will be -executed.</p> -<p class="simpara">The starred version handles the description of a -variable, the variant without star the content.</p> -</dd> -</dl> -</div> -<h5 class="title"><a id="idp9898704" name="idp9898704"></a>Pseudo -Lengths</h5> -<a id="idp9899392" class="indexterm" name="idp9899392"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\@newplength{name}</code></span></dt> -<dd>Defines a new pseudo length</dd> -<dt><span class="term"><code class= -"literal">\useplength{name}</code></span></dt> -<dd>Access value of pseudo length <code class= -"literal">name</code></dd> -<dt><span class="term"><code class= -"literal">\setlengthtoplength[factor]{length}{pseudo length}</code> -,</span> <span class="term"><code class= -"literal">\addtolengthplength[factor]{length}{pseudo -length}</code></span></dt> -<dd>Assign a multiple of <code class="literal">pseudo length</code> -to a real <code class="literal">length</code>. Adds a multiple of -<code class="literal">pseudo length</code> to <code class= -"literal">length</code>.</dd> -<dt><span class="term"><code class= -"literal">\@setplength[factor]{pseudo length}{value}</code> -,</span> <span class="term"><code class= -"literal">\@addtoplength[factor]{pseudo -length}{value}</code></span></dt> -<dd>Assign a multiple of a <code class="literal">value</code> to a -<code class="literal">pseudo length</code>. Adds <code class= -"literal">value</code> to <code class="literal">pseudo -length</code>.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9919360" name="idp9919360"></a>Letter -Declaration</h5> -<a id="idp9920048" class="indexterm" name="idp9920048"></a> -<h5 class="title"><a id="idp9921952" name= -"idp9921952"></a>Letterhead</h5> -<a id="idp9922640" class="indexterm" name="idp9922640"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">firstheadvpos</code></span></dt> -<dd>Distance between the top of the sheet and the letterhead.</dd> -<dt><span class="term"><code class= -"literal">firstheadwidth</code></span></dt> -<dd>Width of the letterhead.</dd> -<dt><span class="term"><code class= -"literal">fromname</code>,</span> <span class="term"><code class= -"literal">fromaddress</code>,</span> <span class= -"term"><code class="literal">fromphone</code>,</span> <span class= -"term"><code class="literal">fromfax</code>,</span> <span class= -"term"><code class="literal">fromemail</code>,</span> <span class= -"term"><code class="literal">fromurl</code>,</span> <span class= -"term"><code class="literal">fromlogo</code></span></dt> -<dd>This variables give all statements concerning the sender -necessary to create the letterhead.</dd> -<dt><span class="term"><code class= -"literal">phoneseparator</code>,</span> <span class= -"term"><code class="literal">faxseparator</code>,</span> -<span class="term"><code class= -"literal">emailseparator</code>,</span> <span class= -"term"><code class="literal">urlseparator</code></span></dt> -<dd>Separators for variables in letterhead.</dd> -<dt><span class="term"><code class= -"literal">\firsthead{construction}</code></span></dt> -<dd>Create letterhead freely.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9942880" name= -"idp9942880"></a>Footer</h5> -<a id="idp9943568" class="indexterm" name="idp9943568"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">firstfootvpos</code></span></dt> -<dd>Distance between footer and upper border of the sheet.</dd> -<dt><span class="term"><code class= -"literal">firstfootwidth</code></span></dt> -<dd>Width of letter's firstpage footer.</dd> -<dt><span class="term"><code class= -"literal">\firstfoot{Construction}</code></span></dt> -<dd>Set definition for first page's footer</dd> -</dl> -</div> -<h5 class="title"><a id="idp9952336" name= -"idp9952336"></a>Address</h5> -<a id="idp9953024" class="indexterm" name="idp9953024"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">toaddrvpos</code>,</span> <span class="term"><code class= -"literal">toaddrhpos</code></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"><code class= -"literal">toaddrwidth</code></span></dt> -<dd>Width of the address window.</dd> -<dt><span class="term"><code class= -"literal">toaddrindent</code></span></dt> -<dd>Value of indentation for the address from the left border.</dd> -<dt><span class="term"><code class= -"literal">backaddress</code>,</span> <span class= -"term"><code class="literal">backaddressseparator</code>,</span> -<span class="term"><code class= -"literal">backaddrheight</code></span></dt> -<dd>Double backslashes within return address will be exchanged with -<code class="literal">backaddressseparator</code>. Height of the -return address field.</dd> -<dt><span class="term"><code class= -"literal">specialmail</code>,</span> <span class= -"term"><code class="literal">specialmailindent</code>,</span> -<span class="term"><code class= -"literal">specialmailrightindent</code></span></dt> -<dd>Optionally set between return address and addressee. -<code class="literal">specialmailindent</code> and <code class= -"literal">specialmailrightindent</code> determine left and right -indentation.</dd> -<dt><span class="term"><code class="literal">toname</code>,</span> -<span class="term"><code class= -"literal">toaddress</code></span></dt> -<dd>Usually not set directly by the user.</dd> -<dt><span class="term"><code class= -"literal">\begin{letter}[options]{address}</code></span></dt> -<dd>Major point of the letter class.</dd> -<dt><span class="term"><code class= -"literal">\AtBeginLetter{command}</code></span></dt> -<dd>Hook for commands run at begin of a letter.</dd> -</dl> -</div> -<h5 class="title"><a id="idp9979184" name="idp9979184"></a>Sender's -Extension</h5> -<a id="idp9979872" class="indexterm" name="idp9979872"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">locwidth</code></span></dt> -<dd>Declares width of sender's extensions.</dd> -<dt><span class="term"><code class= -"literal">location</code></span></dt> -<dd>Content of sender's extension.</dd> -</dl> -</div> -<h5 class="title"><a id="scrlttr-business-line" name= -"scrlttr-business-line"></a>Business Line</h5> -<a id="idp9987696" class="indexterm" name="idp9987696"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">refvpos</code></span></dt> -<dd>Distance between upper border of sheet and business line.</dd> -<dt><span class="term"><code class= -"literal">refwidth</code></span></dt> -<dd>Available width for the business line.</dd> -<dt><span class="term"><code class= -"literal">refaftervskip</code></span></dt> -<dd>Vertical space to be inserted beneath business line.</dd> -<dt><span class="term"><code class="literal">place</code>,</span> -<span class="term"><code class= -"literal">placeseparator</code></span></dt> -<dd>If all variables for business line are empty, the content of -<code class="literal">place</code> and <code class= -"literal">placeseparator</code> will be set, followed by content of -<code class="literal">date</code>.</dd> -<dt><span class="term"><code class="literal">yourref</code>,</span> -<span class="term"><code class="literal">yourmail</code>,</span> -<span class="term"><code class="literal">myref</code>,</span> -<span class="term"><code class="literal">customer</code>,</span> -<span class="term"><code class="literal">invoice</code>,</span> -<span class="term"><code class="literal">date</code></span></dt> -<dd>Typical fields for business lines.</dd> -</dl> -</div> -<h5 class="title"><a id="idp10007648" name="idp10007648"></a>Title -and Subject Line</h5> -<a id="idp10008336" class="indexterm" name="idp10008336"></a><a id= -"idp10010240" class="indexterm" name="idp10010240"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">title</code></span></dt> -<dd>Additional tile. Set centered beneath the business line.</dd> -<dt><span class="term"><code class="literal">subject</code>,</span> -<span class="term"><code class= -"literal">subjectseparator</code></span></dt> -<dd>Set the subject of the letter, optional prefixed by a -label.</dd> -</dl> -</div> -<h5 class="title"><a id="idp10017824" name= -"idp10017824"></a>Further Issues</h5> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">tfoldmarkvpos</code>,</span> <span class= -"term"><code class="literal">bfoldmarkvpos</code></span></dt> -<dd>Position of upper and lower fold mark.</dd> -<dt><span class="term"><code class= -"literal">foldmarkhpos</code></span></dt> -<dd>Distance between fold marks and the sheet's left border.</dd> -<dt><span class="term"><code class= -"literal">frombank</code></span></dt> -<dd>Internally not used yet.</dd> -<dt><span class="term"><code class= -"literal">\nexthead{construction}</code>,</span> <span class= -"term"><code class= -"literal">\nextfoot{construction}</code></span></dt> -<dd>Create letter head or foot for the following pages freely.</dd> -</dl> -</div> -<h5 class="title"><a id="idp10029040" name="idp10029040"></a>The -Text</h5> -<a id="idp10029728" class="indexterm" name="idp10029728"></a> -<h5 class="title"><a id="idp10031632" name= -"idp10031632"></a>Opening</h5> -<a id="idp10032320" class="indexterm" name="idp10032320"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\opening{opening}</code></span></dt> -<dd>Set the opening of the letter.</dd> -</dl> -</div> -<h5 class="title"><a id="idp10037008" name= -"idp10037008"></a>Footnotes</h5> -<a id="idp10037696" class="indexterm" name="idp10037696"></a> -<p>See section <span class="emphasis"><em>Footnotes</em></span> in -KOMA-Script (still to be written).</p> -<h5 class="title"><a id="idp10040560" name= -"idp10040560"></a>Lists</h5> -<a id="idp10041184" class="indexterm" name="idp10041184"></a> -<p>See section <span class="emphasis"><em>Lists</em></span> in -KOMA-Script (still to be written).</p> -<h5 class="title"><a id="idp10044048" name="idp10044048"></a>Margin -Notes</h5> -<a id="idp10044672" class="indexterm" name="idp10044672"></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="idp10047536" name="idp10047536"></a>Text -Emphasis</h5> -<a id="idp10048160" class="indexterm" name="idp10048160"></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="idp10051024" name= -"idp10051024"></a>Closing Part</h5> -<a id="idp10051648" class="indexterm" name="idp10051648"></a> -<h5 class="title"><a id="idp10053552" name= -"idp10053552"></a>Closing</h5> -<a id="idp10054240" class="indexterm" name="idp10054240"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">signature</code></span></dt> -<dd>Inlcudes an explanation for the inscription. Defaults to -<code class="literal">\usekomavar{fromname}</code>.</dd> -<dt><span class="term"><code class="literal">\closing{closing -phrase}</code></span></dt> -<dd>Typesets the colsing phrase follwoed by a vertical space and -the contents fo variable <code class= -"literal">signature</code>.</dd> -<dt><span class="term"><code class= -"literal">sigindent</code>,</span> <span class="term"><code class= -"literal">sigbeforevskip</code>,</span> <span class= -"term"><code class="literal">\raggedsignature</code></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="idp10066320" name= -"idp10066320"></a>Postscript, Carbon Copy, and Enclosures</h5> -<a id="idp10067024" class="indexterm" name="idp10067024"></a><a id= -"idp10068928" class="indexterm" name="idp10068928"></a><a id= -"idp10070832" class="indexterm" name="idp10070832"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\ps</code></span></dt> -<dd>Set a postscript.</dd> -<dt><span class="term"><code class="literal">\cc{distribution -list}</code>,</span> <span class="term"><code class= -"literal">ccseparator</code></span></dt> -<dd>Set a ddistribution list. If the contents of <code class= -"literal">ccseparator</code> isn't empty then the name and the -content of the variable is inserted prior to distribution -list.</dd> -<dt><span class="term"><code class= -"literal">\encl{enclosures}</code>,</span> <span class= -"term"><code class="literal">enclseparator</code></span></dt> -<dd>Same structur as the distribution list.</dd> -</dl> -</div> -<h5 class="title"><a id="idp10081984" name= -"idp10081984"></a>Language Support</h5> -<a id="idp10082672" class="indexterm" name="idp10082672"></a> -<h5 class="title"><a id="idp10084576" name= -"idp10084576"></a>Language Selection</h5> -<a id="idp10085264" class="indexterm" name="idp10085264"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\captionenglish</code>,</span> <span class= -"term"><code class="literal">\captionUSenglish</code>,</span> -<span class="term"><code class= -"literal">\captionamerican</code>,</span> <span class= -"term"><code class="literal">\captionbritish</code>,</span> -<span class="term"><code class= -"literal">\captionUKenglish</code>,</span> <span class= -"term"><code class="literal">\captiongerman</code>,</span> -<span class="term"><code class= -"literal">\captionngerman</code>,</span> <span class= -"term"><code class="literal">\captionaustrian</code>,</span> -<span class="term"><code class= -"literal">\captionfrench</code>,</span> <span class= -"term"><code class="literal">\captionitalian</code>,</span> -<span class="term"><code class= -"literal">\captionspanish</code>,</span> <span class= -"term"><code class="literal">\captiondutch</code>,</span> -<span class="term"><code class= -"literal">\captioncroatian</code></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"><code class= -"literal">\dateenglish</code>,</span> <span class= -"term"><code class="literal">\dateUSenglish</code>,</span> -<span class="term"><code class= -"literal">\dateamerican</code>,</span> <span class= -"term"><code class="literal">\datebritish</code>,</span> -<span class="term"><code class= -"literal">\dateUKenglish</code>,</span> <span class= -"term"><code class="literal">\dategerman</code>,</span> -<span class="term"><code class= -"literal">\datengerman</code>,</span> <span class= -"term"><code class="literal">\dateaustrian</code>,</span> -<span class="term"><code class="literal">\datefrench</code>,</span> -<span class="term"><code class= -"literal">\dateitalian</code>,</span> <span class= -"term"><code class="literal">\datespanish</code>,</span> -<span class="term"><code class="literal">\datedutch</code>,</span> -<span class="term"><code class= -"literal">\datecrotian</code></span></dt> -<dd>Numerical date representation.</dd> -</dl> -</div> -<h5 class="title"><a id="idp10111648" name= -"idp10111648"></a>Language-Dependent Terms</h5> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\yourrefname</code>,</span> <span class= -"term"><code class="literal">\youremailname</code>,</span> -<span class="term"><code class="literal">\myrefname</code>,</span> -<span class="term"><code class= -"literal">\customername</code>,</span> <span class= -"term"><code class="literal">\invoicename</code>,</span> -<span class="term"><code class= -"literal">\subjectname</code>,</span> <span class= -"term"><code class="literal">\ccname</code>,</span> <span class= -"term"><code class="literal">\enclname</code>,</span> <span class= -"term"><code class="literal">\headtoname</code>,</span> -<span class="term"><code class= -"literal">\headfromname</code>,</span> <span class= -"term"><code class="literal">\datename</code>,</span> <span class= -"term"><code class="literal">\pagename</code>,</span> <span class= -"term"><code class="literal">\phonename</code>,</span> <span class= -"term"><code class="literal">\faxname</code>,</span> <span class= -"term"><code class="literal">\emailname</code>,</span> <span class= -"term"><code class="literal">\wwwname</code>,</span> <span class= -"term"><code class="literal">\bankname</code></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="idp10128272" name= -"idp10128272"></a>Defining Language Terms</h5> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\providecaptioname{language}{term}{definition}</code>,</span> -<span class="term"><code class= -"literal">\newcaptioname{language}{term}{defintion}</code>,</span> -<span class="term"><code class= -"literal">\renewcaptionname{language}{term}{definition}</code></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="idp10134800" name= -"idp10134800"></a>Address Files and Circular Letters</h5> -<a id="idp10135504" class="indexterm" name="idp10135504"></a><a id= -"idp10137408" class="indexterm" name="idp10137408"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\adrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{Comment}{Key}</code></span></dt> -<dd>Address entry for address files. The file extension has to be -<code class="literal">.adr</code>!</dd> -<dt><span class="term"><code class= -"literal">\addrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{F3}{F4}{Key}</code></span></dt> -<dd>This command supports four freely definable parameters for an -address entry.</dd> -<dt><span class="term"><code class="literal">\adrchar{initial -letter}</code>,</span> <span class="term"><code class= -"literal">\addrchar{initial letter}</code></span></dt> -<dd>Separator for address entries. Ignored by <code class= -"literal">scrlttr2</code>.</dd> -</dl> -</div> -</div> -<div class="section" title="3.9.4 Address Files with scraddr"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="komascript-scraddr" name= -"komascript-scraddr"></a>3.9.4 Address Files with <code class= -"literal">scraddr</code></h4> -</div> -</div> -</div> -<a id="idp10151008" class="indexterm" name="idp10151008"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\InputAddressFile{file -name}</code></span></dt> -<dd><a id="idp10154304" class="indexterm" name="idp10154304"></a> -<p class="simpara">Read the contents of the given address file. -Filename extension has to be <code class="literal">.adr</code> and -has to be omitted in the argument.</p> -</dd> -<dt><span class="term"><code class= -"literal">\Name{Key}</code>,</span> <span class="term"><code class= -"literal">\FirstName{Key}</code>,</span> <span class= -"term"><code class="literal">\LastName{Key}</code>,</span> -<span class="term"><code class= -"literal">\Address{Key}</code>,</span> <span class= -"term"><code class="literal">\Telephone{Key}</code>,</span> -<span class="term"><code class="literal">\FreeI{Key}</code>,</span> -<span class="term"><code class= -"literal">\FreeII{Key}</code>,</span> <span class= -"term"><code class="literal">\Comment{Key}</code>,</span> -<span class="term"><code class= -"literal">\FreeIII{Key}</code>,</span> <span class= -"term"><code class="literal">\FreeIV{Key}</code></span></dt> -<dd><a id="idp10166368" class="indexterm" name= -"idp10166368"></a><a id="idp10168272" class="indexterm" name= -"idp10168272"></a><a id="idp10170176" class="indexterm" name= -"idp10170176"></a><a id="idp10172080" class="indexterm" name= -"idp10172080"></a><a id="idp10173984" class="indexterm" name= -"idp10173984"></a><a id="idp10175888" class="indexterm" name= -"idp10175888"></a><a id="idp10177792" class="indexterm" name= -"idp10177792"></a><a id="idp10179696" class="indexterm" name= -"idp10179696"></a><a id="idp10181600" class="indexterm" name= -"idp10181600"></a><a id="idp10183504" class="indexterm" name= -"idp10183504"></a> -<p class="simpara">Access to the data in address file. <code class= -"literal">\Name</code> is a concatenation of <code class= -"literal">\FirstName</code> and <code class= -"literal">\LastName</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">AdrFreeIVempty</code>,</span> <span class= -"term"><code class="literal">AdrFreeIVshow</code>,</span> -<span class="term"><code class= -"literal">AdrFreeIVwarn</code>,</span> <span class= -"term"><code class="literal">AdrFreeIVstop</code></span></dt> -<dd>Package warning options. Defaults to <code class= -"literal">AdrFreeIVshow</code>.</dd> -</dl> -</div> -</div> -</div> -<div class="section" title="3.10 mathpazo"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="mathpazo" name="mathpazo"></a>3.10 -<code class="filename">mathpazo</code></h3> -</div> -</div> -</div> -<a id="idp10196240" class="indexterm" name="idp10196240"></a><a id= -"idp10197056" class="indexterm" name="idp10197056"></a> -<p>Math fonts for the use with the Palatino font.</p> -<div class="section" title="3.10.1 \upDelta / \upOmega"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="upDelta-upOmega" name= -"upDelta-upOmega"></a>3.10.1 \upDelta / \upOmega</h4> -</div> -</div> -</div> -<a id="idp10200624" class="indexterm" name="idp10200624"></a><a id= -"idp10201440" class="indexterm" name="idp10201440"></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"><code class= -"literal">[slantedGreek]</code></span></dt> -<dd> -<p>Uppercase Greek will be typeset slanted.</p> -</dd> -<dt><span class="term"><code class= -"literal">[noBBpl]</code></span></dt> -<dd> -<p>Do not use PazoMathBlackboardBold as (partial) blackboard bold -font (e.g with <code class="literal">\mathbb{R}</code>).</p> -</dd> -<dt><span class="term"><code class= -"literal">[osf]</code></span></dt> -<dd> -<p>Make the font family <code class="literal">pplj</code> (Palatino -with old style numerals) the default roman font, and use an -alternative version of the virtual math italic fonts (<code class= -"literal">zplmrj7m</code> and <code class= -"literal">zplmbj7m</code>) with upright Palatino old style numerals -for use with the <code class="literal">\oldstylenums</code> -command.</p> -</dd> -<dt><span class="term"><code class= -"literal">[osfeqnnum]</code></span></dt> -<dd> -<p>Use old style numerals for equation numbering.</p> -</dd> -</dl> -</div> -</div> -</div> -<div class="section" title="3.11 varioref"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="varioref" name="varioref"></a>3.11 -<code class="filename">varioref</code></h3> -</div> -</div> -</div> -<a id="idp10217888" class="indexterm" name="idp10217888"></a><a id= -"idp10218704" class="indexterm" name="idp10218704"></a> -<p>Smarter version of the original latex2e <a class="link" 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" name= -"cmd-vref"></a><code class="literal">\vref</code>,</span> -<span class="term"><a id="cmd-vpageref" name= -"cmd-vpageref"></a><code class= -"literal">\vpageref</code></span></dt> -<dd><a id="idp10225120" class="indexterm" name= -"idp10225120"></a><a id="idp10226192" class="indexterm" name= -"idp10226192"></a> -<p><code class="literal">\vref</code> is similar to <code class= -"literal">\ref</code> 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 class="link" href="#cmd-label-title" title= -"2.3.2. \label{key}"><code class="filename">\label</code></a> -is not on the same page.</p> -<p><code class="literal">\vpageref</code> is a variation of -<code class="literal">\pageref</code> with similar -functionality.</p> -</dd> -<dt><span class="term"><code class= -"literal">\vrefrange</code>,</span> <span class="term"><code class= -"literal">\vpagerefrange</code></span></dt> -<dd><a id="idp10235552" class="indexterm" name= -"idp10235552"></a><a id="idp10236624" class="indexterm" name= -"idp10236624"></a> -<p>The <code class="literal">\v...range</code> 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"><code class="literal">\vref*</code>,</span> -<span class="term"><code class="literal">\vpageref*</code>,</span> -<span class="term"><code class= -"literal">\vpagerefrange*</code></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" title="3.12 Several Small Packages"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="small-packages" name= -"small-packages"></a>3.12 Several Small Packages</h3> -</div> -</div> -</div> -<a id="idp10245536" class="indexterm" name="idp10245536"></a><a id= -"idp10246352" class="indexterm" name="idp10246352"></a><a id= -"idp10247168" class="indexterm" name="idp10247168"></a> -<p>Must be loaded with the usual <a class="link" href= -"#usepackage-linkend"><code class="literal">\usepackage</code></a> -command. Further info for a package to be found in the -documentation (dvi, pdf, ps) or in the <code class= -"literal">sty</code>-file itself.</p> -<div class="section" title="3.12.1 bm"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bm-package" name="bm-package"></a>3.12.1 -<code class="filename">bm</code></h4> -</div> -</div> -</div> -<a id="idp10253488" class="indexterm" name="idp10253488"></a><a id= -"idp10254528" class="indexterm" name="idp10254528"></a><a id= -"idp10255984" class="indexterm" name="idp10255984"></a> -<p>Bold math symbols or equations with better spacing then the -<code class="literal">\boldsymbold</code> command. <a id= -"idp10258528" class="indexterm" name="idp10258528"></a> If possible -load after other packages which redefine the fonts. When no bold -font is available for a certain char <code class= -"literal">bm</code> will use <span class="emphasis"><em>poor man's -bold</em></span> <a class="link" href="#pmb-linkend"><code class= -"literal">\pmb</code></a>.</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><a id="cmd-bm" name= -"cmd-bm"></a><code class="literal">\bm</code></span></dt> -<dd><a id="idp10264528" class="indexterm" name="idp10264528"></a> -<p>Produces bold math symbol or equation.</p> -</dd> -<dt><span class="term"><code class= -"literal">\unboldmath</code></span></dt> -<dd><a id="idp10267584" class="indexterm" name="idp10267584"></a> -<p>Can be used to set parts of an equation unbold.</p> -</dd> -</dl> -</div> -</div> -<div class="section" title="3.12.2 url"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="url-package" name="url-package"></a>3.12.2 -<code class="filename">url</code></h4> -</div> -</div> -</div> -<a id="idp10272016" class="indexterm" name="idp10272016"></a><a id= -"idp10273056" class="indexterm" name="idp10273056"></a> -<p>Defines line breakable hyperlinked (uses <a class="link" href= -"#hyperref" title="3.7 hyperref">hyperref</a> package) verbatim -input for urls and e-mail addresses.</p> -<p>Example: <code class="literal">\url{http://example.org}</code> -outputs <code class="literal">http://example.org</code>.</p> -<p>Related commands are <a class="link" href="#href"><code class= -"literal">\href</code></a> and <a class="link" href= -"#cmd-nolinkurl"><code class="literal">\nolinkurl</code></a>.</p> -</div> -</div> -</div> -<div class="section" title="4 Generic Packages"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="generic-packages" -name="generic-packages"></a>4 Generic Packages</h2> -</div> -</div> -</div> -<div class="section" title="4.1 PiCTeX (tbd.)"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pictex" name="pictex"></a>4.1 PiCTeX -(tbd.)</h3> -</div> -</div> -</div> -<a id="idp10284000" class="indexterm" name="idp10284000"></a> -<p>tbd.</p> -</div> -<div class="section" title="4.2 PSTricks"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pstricks" name="pstricks"></a>4.2 -PSTricks</h3> -</div> -</div> -</div> -<a id="idp10287792" class="indexterm" name="idp10287792"></a> -<div class="section" title="4.2.1 Overview"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="pstricks-ovw" name= -"pstricks-ovw"></a>4.2.1 Overview</h4> -</div> -</div> -</div> -<p>The idea behind the PSTricks package of Timothy van Zandt <a id= -"idp10288208" class="indexterm" name="idp10288208"></a> is to -provide most of the PostScript language in LaTeX and TeX -syntax.</p> -</div> -<div class="section" title="4.2.2 Commands and Parameters"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="pstricks-commands" name= -"pstricks-commands"></a>4.2.2 Commands and Parameters</h4> -</div> -</div> -</div> -<div class="section" title="4.2.2.1 Color"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-color" name= -"pstricks-color"></a>4.2.2.1 Color</h5> -</div> -</div> -</div> -<a id="idp10296496" class="indexterm" name="idp10296496"></a><a id= -"idp10298576" class="indexterm" name="idp10298576"></a><a id= -"idp10300416" class="indexterm" name="idp10300416"></a><a id= -"idp10302320" class="indexterm" name="idp10302320"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\newgray{color}{num}</code> ,</span> <span class= -"term"><code class="literal">\newrgbcolor{color}{num1 num2 -num3}</code> ,</span> <span class="term"><code class= -"literal">\newhsbcolor{color}{num1 num2 num3}</code> ,</span> -<span class="term"><code class="literal">\newcmykcolor{color}{num1 -num2 num3 num4}</code></span></dt> -</dl> -</div> -<p>Note that these commands are obsolete for LaTeX. Load PSTricks -with <code class="literal">\usepackage{pstcol}</code> and use the -standard LaTeX color commands instead.</p> -</div> -<div class="section" title="4.2.2.2 Setting graphics parameters"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-setting" name= -"pstricks-setting"></a>4.2.2.2 Setting graphics parameters</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\psset{par1=value1,par2=value2,...}</code></span></dt> -<dd><a id="idp10315824" class="indexterm" name= -"idp10315824"></a></dd> -</dl> -</div> -</div> -<div class="section" title= -"4.2.2.3 Dimensions, coordinates and angles"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-dimensions" name= -"pstricks-dimensions"></a>4.2.2.3 Dimensions, coordinates and -angles</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pssetlength{cmd}{dim}</code></span></dt> -<dd><a id="idp10321808" class="indexterm" name= -"idp10321808"></a></dd> -<dt><span class="term"><code class="literal">unit=dim, xunit=dim, -yunit=dim, yunit=dim</code></span></dt> -<dd><a id="idp10325584" class="indexterm" name= -"idp10325584"></a><a id="idp10327536" class="indexterm" name= -"idp10327536"></a><a id="idp10329440" class="indexterm" name= -"idp10329440"></a><a id="idp10331344" class="indexterm" name= -"idp10331344"></a> -<p>Default: <code class="literal">1cm</code></p> -</dd> -<dt><span class="term"><code class= -"literal">\degrees[num]</code></span></dt> -<dd><a id="idp10336160" class="indexterm" name= -"idp10336160"></a></dd> -<dt><span class="term"><code class= -"literal">\radians</code></span></dt> -<dd><a id="idp10339904" class="indexterm" name= -"idp10339904"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.4 Basic graphics parameters"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-basic" name= -"pstricks-basic"></a>4.2.2.4 Basic graphics parameters</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">linewidth=dim</code></span></dt> -<dd><a id="idp10345760" class="indexterm" name="idp10345760"></a> -<p>Default: <code class="literal">.8pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">linecolor=color</code></span></dt> -<dd><a id="idp10350608" class="indexterm" name="idp10350608"></a> -<p>Default: <code class="literal">black</code></p> -</dd> -<dt><span class="term"><code class= -"literal">showpoints=true/false</code></span></dt> -<dd><a id="idp10355456" class="indexterm" name="idp10355456"></a> -<p>Default: <code class="literal">false</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.5 Lines and polygons"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-lines" name= -"pstricks-lines"></a>4.2.2.5 Lines and polygons</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">linearc=dim</code></span></dt> -<dd><a id="idp10362448" class="indexterm" name="idp10362448"></a> -<p>Default: <code class="literal">0pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">framearc=num</code></span></dt> -<dd><a id="idp10367152" class="indexterm" name="idp10367152"></a> -<p>Default: <code class="literal">0</code></p> -</dd> -<dt><span class="term"><code class= -"literal">cornersize=relative/absolute</code></span></dt> -<dd><a id="idp10371984" class="indexterm" name="idp10371984"></a> -<p>Default: <code class="literal">relative</code></p> -</dd> -<dt><span class="term"><code class= -"literal">\psline*[par]{arrows}(x0,y0)(x1,y1)...(xn,yn)</code></span></dt> -<dd><a id="idp10376864" class="indexterm" name= -"idp10376864"></a></dd> -<dt><span class="term"><code class= -"literal">\qline(coor0)(coor1)</code></span></dt> -<dd><a id="idp10380656" class="indexterm" name= -"idp10380656"></a></dd> -<dt><span class="term"><code class= -"literal">\pspolygon*[par](x0,y0)(x1,y1)(x2,y2)...(xn,yn)</code></span></dt> -<dd><a id="idp10384480" class="indexterm" name= -"idp10384480"></a></dd> -<dt><span class="term"><code class= -"literal">\psframe*[par](x0,y0)(x1,y1)</code></span></dt> -<dd><a id="idp10388240" class="indexterm" name= -"idp10388240"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.6 Arcs, circles and ellipses"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-arcs" name= -"pstricks-arcs"></a>4.2.2.6 Arcs, circles and ellipses</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pscircle*[par](x0,y0){radius}</code></span></dt> -<dd><a id="idp10394160" class="indexterm" name= -"idp10394160"></a></dd> -<dt><span class="term"><code class= -"literal">\qdisk(coor){radius}</code></span></dt> -<dd><a id="idp10397904" class="indexterm" name= -"idp10397904"></a></dd> -<dt><span class="term"><code class= -"literal">\pswedge*[par](x0,y0){radius}{angle1}{angle2}</code></span></dt> -<dd><a id="idp10401680" class="indexterm" name= -"idp10401680"></a></dd> -<dt><span class="term"><code class= -"literal">\psellipse*[par](x0,y0)(x1,y1)</code></span></dt> -<dd><a id="idp10405440" class="indexterm" name= -"idp10405440"></a></dd> -<dt><span class="term"><code class= -"literal">\psarc*[par]{arrows}(x,y){radius}{angleA}{angleB}</code></span></dt> -<dd><a id="idp10409216" class="indexterm" name= -"idp10409216"></a></dd> -<dt><span class="term"><code class= -"literal">\psarcn*[par]{arrows}(x,y){radius}{angleA}{angleB}</code></span></dt> -<dd><a id="idp10412992" class="indexterm" name= -"idp10412992"></a></dd> -<dt><span class="term"><code class="literal">arcsep=dim, -arcsepA=dim, arcsepB=dim</code></span></dt> -<dd><a id="idp10416800" class="indexterm" name= -"idp10416800"></a><a id="idp10418704" class="indexterm" name= -"idp10418704"></a><a id="idp10420608" class="indexterm" name= -"idp10420608"></a> -<p>Default: <code class="literal">0pt</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.7 Curves"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-curves" name= -"pstricks-curves"></a>4.2.2.7 Curves</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\psbezier*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)(x3,y3)</code></span></dt> -<dd><a id="idp10427600" class="indexterm" name= -"idp10427600"></a></dd> -<dt><span class="term"><code class= -"literal">\parabola*[par]{arrows}(x0,y0)(x1,y1)</code></span></dt> -<dd><a id="idp10431360" class="indexterm" name= -"idp10431360"></a></dd> -<dt><span class="term"><code class= -"literal">\pscurve*[par]{arrows}(x1,y1)...(xn,yn)</code></span></dt> -<dd><a id="idp10435120" class="indexterm" name= -"idp10435120"></a></dd> -<dt><span class="term"><code class= -"literal">\psecurve*[par]{arrows}(x1,y1)...(xn,yn)</code></span></dt> -<dd><a id="idp10438896" class="indexterm" name= -"idp10438896"></a></dd> -<dt><span class="term"><code class= -"literal">\psccurve*[par]{arrows}(x1,y1)...(xn,yn)</code></span></dt> -<dd><a id="idp10442672" class="indexterm" name= -"idp10442672"></a></dd> -<dt><span class="term"><code class="literal">curvature=num1 num2 -num3</code></span></dt> -<dd><a id="idp10446480" class="indexterm" name="idp10446480"></a> -<p>Default: <code class="literal">1 .1 0</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.8 Dots"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-dots" name= -"pstricks-dots"></a>4.2.2.8 Dots</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\psdots*[par](x1,y1)(x2,y2)...(xn,yn)</code></span></dt> -<dd><a id="idp10453424" class="indexterm" name= -"idp10453424"></a></dd> -<dt><span class="term"><code class= -"literal">dotstyle=style</code></span></dt> -<dd><a id="idp10457168" class="indexterm" name="idp10457168"></a> -<p class="simpara">Default: <code class="literal">*</code></p> -<p class="simpara">Dots: <code class="literal">*, o, +, triangle, -triangle*, square, square*, pentagon, pentagon*, |</code></p> -</dd> -<dt><span class="term"><code class="literal">dotscale=num1 -num2</code></span></dt> -<dd><a id="idp10463024" class="indexterm" name="idp10463024"></a> -<p>Default: <code class="literal">1</code></p> -</dd> -<dt><span class="term"><code class= -"literal">dotangle=angle</code></span></dt> -<dd><a id="idp10467840" class="indexterm" name="idp10467840"></a> -<p>Default: <code class="literal">0</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.9 Grids"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-grids" name= -"pstricks-grids"></a>4.2.2.9 Grids</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\psgrid(x0,y0)(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp10474768" class="indexterm" name= -"idp10474768"></a></dd> -<dt><span class="term"><code class= -"literal">gridwidth=dim</code></span></dt> -<dd><a id="idp10478512" class="indexterm" name="idp10478512"></a> -<p class="simpara">Default: <code class="literal">.8pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gridcolor=color</code></span></dt> -<dd><a id="idp10483232" class="indexterm" name="idp10483232"></a> -<p class="simpara">Default: <code class="literal">black</code></p> -</dd> -<dt><span class="term"><code class= -"literal">griddots=num</code></span></dt> -<dd><a id="idp10487952" class="indexterm" name="idp10487952"></a> -<p class="simpara">Default: <code class="literal">0</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gridlabels=dim</code></span></dt> -<dd><a id="idp10492640" class="indexterm" name="idp10492640"></a> -<p class="simpara">Default: <code class="literal">10pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gridlabelcolor=color</code></span></dt> -<dd><a id="idp10497360" class="indexterm" name="idp10497360"></a> -<p class="simpara">Default: <code class="literal">black</code></p> -</dd> -<dt><span class="term"><code class= -"literal">subgriddiv=int</code></span></dt> -<dd><a id="idp10502080" class="indexterm" name="idp10502080"></a> -<p class="simpara">Default: <code class="literal">5</code></p> -</dd> -<dt><span class="term"><code class= -"literal">subgridwidth=dim</code></span></dt> -<dd><a id="idp10506768" class="indexterm" name="idp10506768"></a> -<p class="simpara">Default: <code class="literal">.4pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">subgridcolor=color</code></span></dt> -<dd><a id="idp10511488" class="indexterm" name="idp10511488"></a> -<p class="simpara">Default: <code class="literal">gray</code></p> -</dd> -<dt><span class="term"><code class= -"literal">subgriddots=num</code></span></dt> -<dd><a id="idp10516208" class="indexterm" name="idp10516208"></a> -<p class="simpara">Default: <code class="literal">0</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.10 Plots"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-plots" name= -"pstricks-plots"></a>4.2.2.10 Plots</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\fileplot*[par]{file}</code></span></dt> -<dd><a id="idp10522928" class="indexterm" name= -"idp10522928"></a></dd> -<dt><span class="term"><code class= -"literal">\dataplot*[par]{commands}</code></span></dt> -<dd><a id="idp10526688" class="indexterm" name= -"idp10526688"></a></dd> -<dt><span class="term"><code class= -"literal">\savedata{command}[data]</code></span></dt> -<dd><a id="idp10530448" class="indexterm" name= -"idp10530448"></a></dd> -<dt><span class="term"><code class= -"literal">\readdata{command}{file}</code></span></dt> -<dd><a id="idp10534208" class="indexterm" name= -"idp10534208"></a></dd> -<dt><span class="term"><code class= -"literal">\listplot*[par]{list}</code></span></dt> -<dd><a id="idp10537952" class="indexterm" name= -"idp10537952"></a></dd> -<dt><span class="term"><code class= -"literal">\psplot*[par]{xmin}{xmax}{function}</code></span></dt> -<dd><a id="idp10541712" class="indexterm" name= -"idp10541712"></a></dd> -<dt><span class="term"><code class= -"literal">\parametricplot*[par]{tmin}{tmax}{function}</code></span></dt> -<dd><a id="idp10545488" class="indexterm" name= -"idp10545488"></a></dd> -<dt><span class="term"><code class= -"literal">plotstyle=style</code></span></dt> -<dd><a id="idp10549232" class="indexterm" name="idp10549232"></a> -<p class="simpara">Default: <code class="literal">line</code></p> -</dd> -<dt><span class="term"><code class= -"literal">plotpoints=int</code></span></dt> -<dd><a id="idp10553952" class="indexterm" name="idp10553952"></a> -<p class="simpara">Default: <code class="literal">50</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.11 Coordinate systems"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-coordinate" name= -"pstricks-coordinate"></a>4.2.2.11 Coordinate systems</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">origin={coor}</code></span></dt> -<dd><a id="idp10561008" class="indexterm" name="idp10561008"></a> -<p class="simpara">Default: <code class= -"literal">0pt,0pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">swapaxes=true</code></span></dt> -<dd><a id="idp10565728" class="indexterm" name="idp10565728"></a> -<p class="simpara">Default: <code class="literal">false</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.12 Line styles"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-line-styles" name= -"pstricks-line-styles"></a>4.2.2.12 Line styles</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">linestyle=style</code></span></dt> -<dd><a id="idp10572624" class="indexterm" name="idp10572624"></a> -<p class="simpara">Default: <code class="literal">solid</code></p> -</dd> -<dt><span class="term"><code class="literal">dash=dim1 -dim2</code></span></dt> -<dd><a id="idp10577344" class="indexterm" name="idp10577344"></a> -<p class="simpara">Default: <code class="literal">5pt -3pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">dotsep=dim</code></span></dt> -<dd><a id="idp10582064" class="indexterm" name="idp10582064"></a> -<p class="simpara">Default: <code class="literal">3pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">border=dim</code></span></dt> -<dd><a id="idp10586752" class="indexterm" name="idp10586752"></a> -<p class="simpara">Default: <code class="literal">0pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">bordercolor=color</code></span></dt> -<dd><a id="idp10591440" class="indexterm" name="idp10591440"></a> -<p class="simpara">Default: <code class="literal">white</code></p> -</dd> -<dt><span class="term"><code class= -"literal">doubleline=true/false</code></span></dt> -<dd><a id="idp10596160" class="indexterm" name="idp10596160"></a> -<p class="simpara">Default: <code class="literal">false</code></p> -</dd> -<dt><span class="term"><code class= -"literal">doublesep=dim</code></span></dt> -<dd><a id="idp10600880" class="indexterm" name="idp10600880"></a> -<p class="simpara">Default: <code class= -"literal">1.25\pslinewidth</code></p> -</dd> -<dt><span class="term"><code class= -"literal">doublecolor=color</code></span></dt> -<dd><a id="idp10605600" class="indexterm" name="idp10605600"></a> -<p class="simpara">Default: <code class="literal">white</code></p> -</dd> -<dt><span class="term"><code class= -"literal">shadow=true/false</code></span></dt> -<dd><a id="idp10610320" class="indexterm" name="idp10610320"></a> -<p class="simpara">Default: <code class="literal">false</code></p> -</dd> -<dt><span class="term"><code class= -"literal">shadowsize=dim</code></span></dt> -<dd><a id="idp10615040" class="indexterm" name="idp10615040"></a> -<p class="simpara">Default: <code class="literal">3pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">shadowangle=angle</code></span></dt> -<dd><a id="idp10619728" class="indexterm" name="idp10619728"></a> -<p class="simpara">Default: <code class="literal">-45</code></p> -</dd> -<dt><span class="term"><code class= -"literal">shadowcolor=color</code></span></dt> -<dd><a id="idp10624416" class="indexterm" name="idp10624416"></a> -<p class="simpara">Default: <code class= -"literal">darkgray</code></p> -</dd> -<dt><span class="term"><code class= -"literal">dimen=outer/inner/middle</code></span></dt> -<dd><a id="idp10629152" class="indexterm" name="idp10629152"></a> -<p class="simpara">Default: <code class="literal">outer</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.13 Fill styles"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-fill-styles" name= -"pstricks-fill-styles"></a>4.2.2.13 Fill styles</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">fillstyle=style</code></span></dt> -<dd><a id="idp10636048" class="indexterm" name="idp10636048"></a> -<p class="simpara">Default: <code class="literal">none</code></p> -</dd> -<dt><span class="term"><code class= -"literal">fillcolor=color</code></span></dt> -<dd><a id="idp10640768" class="indexterm" name="idp10640768"></a> -<p class="simpara">Default: <code class="literal">white</code></p> -</dd> -<dt><span class="term"><code class= -"literal">hatchwidth=dim</code></span></dt> -<dd><a id="idp10645488" class="indexterm" name="idp10645488"></a> -<p class="simpara">Default: <code class="literal">.8pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">hatchsep=dim</code></span></dt> -<dd><a id="idp10650208" class="indexterm" name="idp10650208"></a> -<p class="simpara">Default: <code class="literal">4pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">hatchcolor=color</code></span></dt> -<dd><a id="idp10654944" class="indexterm" name="idp10654944"></a> -<p class="simpara">Default: <code class="literal">black</code></p> -</dd> -<dt><span class="term"><code class= -"literal">hatchangle=rot</code></span></dt> -<dd><a id="idp10659664" class="indexterm" name="idp10659664"></a> -<p class="simpara">Default: <code class="literal">45</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.14 Arrowheads and such"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-arrowheads" name= -"pstricks-arrowheads"></a>4.2.2.14 Arrowheads and such</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">arrows=style</code></span></dt> -<dd><a id="idp10666624" class="indexterm" name="idp10666624"></a> -<p class="simpara">Default: <code class="literal">-</code></p> -<p class="simpara">Arrows: <code class="literal">-, <->, ->-<, <<->>, >>-<<, |-|, |*-|*, [-], -(-), o-o, *-*, oo-oo, **-**, c-c, cc-cc, C-C</code></p> -</dd> -<dt><span class="term"><code class="literal">arrowsize=dim -num</code></span></dt> -<dd><a id="idp10672640" class="indexterm" name="idp10672640"></a> -<p class="simpara">Default: <code class="literal">2pt 3</code></p> -</dd> -<dt><span class="term"><code class= -"literal">arrowlength=num</code></span></dt> -<dd><a id="idp10677360" class="indexterm" name="idp10677360"></a> -<p class="simpara">Default: <code class="literal">1.4</code></p> -</dd> -<dt><span class="term"><code class= -"literal">arrowinset=num</code></span></dt> -<dd><a id="idp10682048" class="indexterm" name="idp10682048"></a> -<p class="simpara">Default: <code class="literal">.4</code></p> -</dd> -<dt><span class="term"><code class="literal">tbarsize=dim -num</code></span></dt> -<dd><a id="idp10686736" class="indexterm" name="idp10686736"></a> -<p class="simpara">Default: <code class="literal">2pt 5</code></p> -</dd> -<dt><span class="term"><code class="literal">bracketlength=num, -rbracketlength=num</code></span></dt> -<dd><a id="idp10691472" class="indexterm" name= -"idp10691472"></a><a id="idp10693376" class="indexterm" name= -"idp10693376"></a> -<p class="simpara">Default: <code class="literal">.15</code></p> -</dd> -<dt><span class="term"><code class="literal">dotsize=dim -num</code></span></dt> -<dd><a id="idp10698112" class="indexterm" name="idp10698112"></a> -<p class="simpara">Default: <code class="literal">.5pt -2.5</code></p> -</dd> -<dt><span class="term"><code class="literal">arrowscale=num1 -num2</code></span></dt> -<dd><a id="idp10702832" class="indexterm" name="idp10702832"></a> -<p class="simpara">Default: <code class="literal">1</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.15 Custom styles"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-custom" name= -"pstricks-custom"></a>4.2.2.15 Custom styles</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\newpsobject{name}{object}{par1=value1,...}</code></span></dt> -<dd><a id="idp10709648" class="indexterm" name= -"idp10709648"></a></dd> -<dt><span class="term"><code class= -"literal">\newpsstyle{name}{par1=value1,...}</code></span></dt> -<dd><a id="idp10713456" class="indexterm" name= -"idp10713456"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.16 The basics"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-basics" name= -"pstricks-basics"></a>4.2.2.16 The basics</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pscustom*[par]{commands}</code></span></dt> -<dd><a id="idp10719232" class="indexterm" name= -"idp10719232"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.17 Parameters"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-parameters" name= -"pstricks-parameters"></a>4.2.2.17 Parameters</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">linetype=int</code></span></dt> -<dd><a id="idp10725200" class="indexterm" name="idp10725200"></a> -<p class="simpara">Default: <code class="literal">0</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.18 Graphics objects"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-graphics-objects" name= -"pstricks-graphics-objects"></a>4.2.2.18 Graphics objects</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">liftpen=0/1/2</code></span></dt> -<dd><a id="idp10732144" class="indexterm" name="idp10732144"></a> -<p class="simpara">Default: <code class="literal">0</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.19 Safe tricks"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="safe-tricks" name= -"safe-tricks"></a>4.2.2.19 Safe tricks</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\newpath</code></span></dt> -<dd><a id="idp10738960" class="indexterm" name= -"idp10738960"></a></dd> -<dt><span class="term"><code class= -"literal">\moveto(coor)</code></span></dt> -<dd><a id="idp10742704" class="indexterm" name= -"idp10742704"></a></dd> -<dt><span class="term"><code class= -"literal">\closepath</code></span></dt> -<dd><a id="idp10746448" class="indexterm" name= -"idp10746448"></a></dd> -<dt><span class="term"><code class= -"literal">\stroke[par]</code></span></dt> -<dd><a id="idp10750192" class="indexterm" name= -"idp10750192"></a></dd> -<dt><span class="term"><code class= -"literal">\fill[par]</code></span></dt> -<dd><a id="idp10753936" class="indexterm" name= -"idp10753936"></a></dd> -<dt><span class="term"><code class= -"literal">\gsave</code></span></dt> -<dd><a id="idp10757680" class="indexterm" name= -"idp10757680"></a></dd> -<dt><span class="term"><code class= -"literal">\grestore</code></span></dt> -<dd><a id="idp10761424" class="indexterm" name= -"idp10761424"></a></dd> -<dt><span class="term"><code class= -"literal">\translate(coor)</code></span></dt> -<dd><a id="idp10765168" class="indexterm" name= -"idp10765168"></a></dd> -<dt><span class="term"><code class="literal">\scale{num1 -num2}</code></span></dt> -<dd><a id="idp10768912" class="indexterm" name= -"idp10768912"></a></dd> -<dt><span class="term"><code class= -"literal">\rotate{angle}</code></span></dt> -<dd><a id="idp10772656" class="indexterm" name= -"idp10772656"></a></dd> -<dt><span class="term"><code class= -"literal">\swapaxes</code></span></dt> -<dd><a id="idp10776400" class="indexterm" name= -"idp10776400"></a></dd> -<dt><span class="term"><code class= -"literal">\msave</code></span></dt> -<dd><a id="idp10780144" class="indexterm" name= -"idp10780144"></a></dd> -<dt><span class="term"><code class= -"literal">\mrestore</code></span></dt> -<dd><a id="idp10783888" class="indexterm" name= -"idp10783888"></a></dd> -<dt><span class="term"><code class= -"literal">\openshadow[par]</code></span></dt> -<dd><a id="idp10787632" class="indexterm" name= -"idp10787632"></a></dd> -<dt><span class="term"><code class= -"literal">\closedshadow[par]</code></span></dt> -<dd><a id="idp10791376" class="indexterm" name= -"idp10791376"></a></dd> -<dt><span class="term"><code class= -"literal">\movepath(coor)</code></span></dt> -<dd><a id="idp10795120" class="indexterm" name= -"idp10795120"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.20 Pretty safe tricks"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pretty-safe-tricks" name= -"pretty-safe-tricks"></a>4.2.2.20 Pretty safe tricks</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\lineto(coor)</code></span></dt> -<dd><a id="idp10800848" class="indexterm" name= -"idp10800848"></a></dd> -<dt><span class="term"><code class= -"literal">\rlineto(coor)</code></span></dt> -<dd><a id="idp10804592" class="indexterm" name= -"idp10804592"></a></dd> -<dt><span class="term"><code class= -"literal">\curveto(x1,y1)(x2,y2)(x3,y3)</code></span></dt> -<dd><a id="idp10808352" class="indexterm" name= -"idp10808352"></a></dd> -<dt><span class="term"><code class= -"literal">\rcurveto(x1,y1)(x2,y2)(x3,y3)</code></span></dt> -<dd><a id="idp10812112" class="indexterm" name= -"idp10812112"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.21 For hackers only"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="hackers" name="hackers"></a>4.2.2.21 For -hackers only</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\code{code}</code></span></dt> -<dd><a id="idp10818000" class="indexterm" name= -"idp10818000"></a></dd> -<dt><span class="term"><code class= -"literal">\dim{dim}</code></span></dt> -<dd><a id="idp10821744" class="indexterm" name= -"idp10821744"></a></dd> -<dt><span class="term"><code class= -"literal">\coor(x1,y1)(x2,y2)...(xn,yn)</code></span></dt> -<dd><a id="idp10825504" class="indexterm" name= -"idp10825504"></a></dd> -<dt><span class="term"><code class= -"literal">\rcoor(x1,y1)(x2,y2)...(xn,yn)</code></span></dt> -<dd><a id="idp10829264" class="indexterm" name= -"idp10829264"></a></dd> -<dt><span class="term"><code class= -"literal">\file{file}</code></span></dt> -<dd><a id="idp10833008" class="indexterm" name= -"idp10833008"></a></dd> -<dt><span class="term"><code class= -"literal">\arrows{arrows}</code></span></dt> -<dd><a id="idp10836752" class="indexterm" name= -"idp10836752"></a></dd> -<dt><span class="term"><code class= -"literal">\setcolor{color}</code></span></dt> -<dd><a id="idp10840496" class="indexterm" name= -"idp10840496"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.22 Pictures"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pictures" name="pictures"></a>4.2.2.22 -Pictures</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pspicture*[baseline](x0,y0)(x1,y1)</code></span></dt> -<dd><a id="idp10846400" class="indexterm" name= -"idp10846400"></a></dd> -<dt><span class="term"><code class= -"literal">\endpspicture</code></span></dt> -<dd><a id="idp10850144" class="indexterm" name= -"idp10850144"></a></dd> -</dl> -</div> -</div> -<div class="section" title= -"4.2.2.23 Placing and rotating whatever"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="placing" name="placing"></a>4.2.2.23 -Placing and rotating whatever</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\rput*[refpoint]{rotation}(x,y){stuff}</code></span></dt> -<dd><a id="idp10856016" class="indexterm" name= -"idp10856016"></a></dd> -<dt><span class="term"><code class= -"literal">\uput*{labelsep}[refangle]{rotation}(x,y){stuff}</code></span></dt> -<dd><a id="idp10859792" class="indexterm" name= -"idp10859792"></a></dd> -<dt><span class="term"><code class= -"literal">\pslabelsep</code></span></dt> -<dd><a id="idp10863536" class="indexterm" name= -"idp10863536"></a></dd> -<dt><span class="term"><code class= -"literal">labelsep=dim</code></span></dt> -<dd><a id="idp10867280" class="indexterm" name="idp10867280"></a> -<p>Default: <code class="literal">5pt</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.24 Repetition"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-repetition" name= -"pstricks-repetition"></a>4.2.2.24 Repetition</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\multirput*[refpoint]{angle}(x0,y0)(x1,y1){int}{stuff}</code></span></dt> -<dd><a id="idp10874352" class="indexterm" name= -"idp10874352"></a></dd> -<dt><span class="term"><code class= -"literal">\multips{angle}(x0,y0)(x1,y1){int}{graphics}</code></span></dt> -<dd><a id="idp10878128" class="indexterm" name= -"idp10878128"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.25 Axes"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-axes" name= -"pstricks-axes"></a>4.2.2.25 Axes</h5> -</div> -</div> -</div> -<a id="idp10882176" class="indexterm" name="idp10882176"></a> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\psaxes*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)</code></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"><code class= -"literal">labels=all/x/y/none</code></span></dt> -<dd><a id="idp10902272" class="indexterm" name="idp10902272"></a> -<p>Default: <code class="literal">all</code></p> -</dd> -<dt><span class="term"><code class= -"literal">showorigin=true/false</code></span></dt> -<dd><a id="idp10907184" class="indexterm" name="idp10907184"></a> -<p>Default: <code class="literal">true</code></p> -</dd> -<dt><span class="term"><code class= -"literal">ticks=all/x/y/none</code></span></dt> -<dd><a id="idp10912032" class="indexterm" name="idp10912032"></a> -<p>Default: <code class="literal">all</code></p> -</dd> -<dt><span class="term"><code class= -"literal">tickstyle=full/top/bottom</code></span></dt> -<dd><a id="idp10916864" class="indexterm" name="idp10916864"></a> -<p>Default: <code class="literal">full</code></p> -</dd> -<dt><span class="term"><code class= -"literal">ticksize=dim</code></span></dt> -<dd><a id="idp10921760" class="indexterm" name="idp10921760"></a> -<p>Default: <code class="literal">3pt</code></p> -</dd> -<dt><span class="term"><code class="literal">\psxlabel, -\psylabel</code></span></dt> -<dd><a id="idp10926624" class="indexterm" name= -"idp10926624"></a><a id="idp10928528" class="indexterm" name= -"idp10928528"></a></dd> -<dt><span class="term"><code class= -"literal">axesstyle=axes/frame/none</code></span></dt> -<dd><a id="idp10932336" class="indexterm" name="idp10932336"></a> -<p>Default: <code class="literal">axes</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.26 Framed boxes"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-framed" name= -"pstricks-framed"></a>4.2.2.26 Framed boxes</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">framesep=dim</code></span></dt> -<dd><a id="idp10939376" class="indexterm" name="idp10939376"></a> -<p>Default: <code class="literal">3pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">boxsep=true/false</code></span></dt> -<dd><a id="idp10944192" class="indexterm" name="idp10944192"></a> -<p>Default: <code class="literal">true</code></p> -</dd> -<dt><span class="term"><code class= -"literal">\psframebox*[par]{stuff}</code></span></dt> -<dd><a id="idp10949104" class="indexterm" name= -"idp10949104"></a></dd> -<dt><span class="term"><code class= -"literal">\psdblframebox*[par]{stuff}</code></span></dt> -<dd><a id="idp10952912" class="indexterm" name= -"idp10952912"></a></dd> -<dt><span class="term"><code class= -"literal">\psshadowbox*[par]{stuff}</code></span></dt> -<dd><a id="idp10956672" class="indexterm" name= -"idp10956672"></a></dd> -<dt><span class="term"><code class= -"literal">\pscirclebox*[par]{stuff}</code></span></dt> -<dd><a id="idp10960432" class="indexterm" name= -"idp10960432"></a></dd> -<dt><span class="term"><code class= -"literal">\cput*[par]{angle}(x,y){stuff}</code></span></dt> -<dd><a id="idp10964192" class="indexterm" name= -"idp10964192"></a></dd> -<dt><span class="term"><code class= -"literal">\psovalbox*[par]{stuff}</code></span></dt> -<dd><a id="idp10967984" class="indexterm" name= -"idp10967984"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.27 Clipping"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-clipping" name= -"pstricks-clipping"></a>4.2.2.27 Clipping</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\clipbox[dim]{stuff}</code></span></dt> -<dd><a id="idp10973760" class="indexterm" name= -"idp10973760"></a></dd> -<dt><span class="term"><code class="literal">\psclip{graphics} ... -\endpsclip</code></span></dt> -<dd><a id="idp10977520" class="indexterm" name= -"idp10977520"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.28 Rotation and scaling boxes"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-rotation" name= -"pstricks-rotation"></a>4.2.2.28 Rotation and scaling boxes</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\rotateleft{stuff}</code></span></dt> -<dd><a id="idp10983360" class="indexterm" name= -"idp10983360"></a></dd> -<dt><span class="term"><code class= -"literal">\rotateright{stuff}</code></span></dt> -<dd><a id="idp10987104" class="indexterm" name= -"idp10987104"></a></dd> -<dt><span class="term"><code class= -"literal">\rotatedown{stuff}</code></span></dt> -<dd><a id="idp10990848" class="indexterm" name= -"idp10990848"></a></dd> -<dt><span class="term"><code class="literal">\scalebox{num1 -num2}{stuff}</code></span></dt> -<dd><a id="idp10994656" class="indexterm" name= -"idp10994656"></a></dd> -<dt><span class="term"><code class= -"literal">\scaleboxto(x,y){stuff}</code></span></dt> -<dd><a id="idp10998400" class="indexterm" name= -"idp10998400"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.29 Nodes"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-nodes" name= -"pstricks-nodes"></a>4.2.2.29 Nodes</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\rnode[refpoint]{name}{stuff}</code></span></dt> -<dd><a id="idp11004144" class="indexterm" name= -"idp11004144"></a></dd> -<dt><span class="term"><code class= -"literal">\Rnode(x,y){name}{stuff}</code></span></dt> -<dd><a id="idp11007904" class="indexterm" name= -"idp11007904"></a></dd> -<dt><span class="term"><code class= -"literal">\RnodeRef</code></span></dt> -<dd><a id="idp11011648" class="indexterm" name= -"idp11011648"></a></dd> -<dt><span class="term"><code class= -"literal">\pnode(x,y){name}</code></span></dt> -<dd><a id="idp11015392" class="indexterm" name= -"idp11015392"></a></dd> -<dt><span class="term"><code class= -"literal">\cnode*[par](x,y){radius}{name}</code></span></dt> -<dd><a id="idp11019152" class="indexterm" name= -"idp11019152"></a></dd> -<dt><span class="term"><code class= -"literal">\circlenode*[par]{name}{stuff}</code></span></dt> -<dd><a id="idp11022912" class="indexterm" name= -"idp11022912"></a></dd> -<dt><span class="term"><code class= -"literal">\cnodeput*[par]{angle}(x,y){name}{stuff}</code></span></dt> -<dd><a id="idp11026688" class="indexterm" name= -"idp11026688"></a></dd> -<dt><span class="term"><code class= -"literal">\ovalnode*[par]{name}{stuff}</code></span></dt> -<dd><a id="idp11030448" class="indexterm" name= -"idp11030448"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.30 Node connections"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-connections" name= -"pstricks-connections"></a>4.2.2.30 Node connections</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">nodesep=dim</code></span></dt> -<dd><a id="idp11036352" class="indexterm" name="idp11036352"></a> -<p>Default: <code class="literal">0</code></p> -</dd> -<dt><span class="term"><code class= -"literal">offset=dim</code></span></dt> -<dd><a id="idp11041216" class="indexterm" name="idp11041216"></a> -<p>Default: <code class="literal">0</code></p> -</dd> -<dt><span class="term"><code class= -"literal">arm=dim</code></span></dt> -<dd><a id="idp11046032" class="indexterm" name="idp11046032"></a> -<p>Default: <code class="literal">10pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">angle=angle</code></span></dt> -<dd><a id="idp11050848" class="indexterm" name="idp11050848"></a> -<p>Default: <code class="literal">0</code></p> -</dd> -<dt><span class="term"><code class= -"literal">arcangle=angle</code></span></dt> -<dd><a id="idp11055712" class="indexterm" name="idp11055712"></a> -<p>Default: <code class="literal">8</code></p> -</dd> -<dt><span class="term"><code class= -"literal">ncurv=num</code></span></dt> -<dd><a id="idp11060528" class="indexterm" name="idp11060528"></a> -<p>Default: <code class="literal">.67</code></p> -</dd> -<dt><span class="term"><code class= -"literal">loopsize=dim</code></span></dt> -<dd><a id="idp11065440" class="indexterm" name="idp11065440"></a> -<p>Default: <code class="literal">1cm</code></p> -</dd> -<dt><span class="term"><code class= -"literal">\ncline*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11070272" class="indexterm" name= -"idp11070272"></a></dd> -<dt><span class="term"><code class= -"literal">\ncLine*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11074032" class="indexterm" name= -"idp11074032"></a></dd> -<dt><span class="term"><code class= -"literal">\nccurve*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11077792" class="indexterm" name= -"idp11077792"></a></dd> -<dt><span class="term"><code class= -"literal">\ncarc*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11081552" class="indexterm" name= -"idp11081552"></a></dd> -<dt><span class="term"><code class= -"literal">\ncbar*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11085312" class="indexterm" name= -"idp11085312"></a></dd> -<dt><span class="term"><code class= -"literal">\ncdiag*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11089120" class="indexterm" name= -"idp11089120"></a></dd> -<dt><span class="term"><code class= -"literal">\ncdiagg*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11092880" class="indexterm" name= -"idp11092880"></a></dd> -<dt><span class="term"><code class= -"literal">\ncangle*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11096640" class="indexterm" name= -"idp11096640"></a></dd> -<dt><span class="term"><code class= -"literal">\ncangles*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11100400" class="indexterm" name= -"idp11100400"></a></dd> -<dt><span class="term"><code class= -"literal">\ncloop*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11104160" class="indexterm" name= -"idp11104160"></a></dd> -<dt><span class="term"><code class= -"literal">\nccircle*[par]{arrows}{node}{radius}</code></span></dt> -<dd><a id="idp11107920" class="indexterm" name= -"idp11107920"></a></dd> -<dt><span class="term"><code class= -"literal">\pcline*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11111728" class="indexterm" name= -"idp11111728"></a></dd> -<dt><span class="term"><code class= -"literal">\pccurve*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11115488" class="indexterm" name= -"idp11115488"></a></dd> -<dt><span class="term"><code class= -"literal">\pcarc*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11119248" class="indexterm" name= -"idp11119248"></a></dd> -<dt><span class="term"><code class= -"literal">\pcbar*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11123008" class="indexterm" name= -"idp11123008"></a></dd> -<dt><span class="term"><code class= -"literal">\pcdiag*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11126768" class="indexterm" name= -"idp11126768"></a></dd> -<dt><span class="term"><code class= -"literal">\pcangle*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11130528" class="indexterm" name= -"idp11130528"></a></dd> -<dt><span class="term"><code class= -"literal">\pcloop*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11134288" class="indexterm" name= -"idp11134288"></a></dd> -</dl> -</div> -</div> -<div class="section" title= -"4.2.2.31 Attaching labels to node connections"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-attaching" name= -"pstricks-attaching"></a>4.2.2.31 Attaching labels to node -connections</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\lput*[refpoint]{rotation}(pos){stuff}</code></span></dt> -<dd><a id="idp11140336" class="indexterm" name= -"idp11140336"></a></dd> -<dt><span class="term"><code class= -"literal">\aput*[labelsep]{angle}(pos){stuff}</code></span></dt> -<dd><a id="idp11144096" class="indexterm" name= -"idp11144096"></a></dd> -<dt><span class="term"><code class= -"literal">\bput*[labelsep]{angle}(pos){stuff}</code></span></dt> -<dd><a id="idp11147856" class="indexterm" name= -"idp11147856"></a></dd> -<dt><span class="term"><code class= -"literal">\mput*[refpoint]{stuff}</code></span></dt> -<dd><a id="idp11151600" class="indexterm" name= -"idp11151600"></a></dd> -<dt><span class="term"><code class= -"literal">\Aput*[labelsep]{stuff}</code></span></dt> -<dd><a id="idp11155344" class="indexterm" name= -"idp11155344"></a></dd> -<dt><span class="term"><code class= -"literal">\Bput*[labelsep]{stuff}</code></span></dt> -<dd><a id="idp11159088" class="indexterm" name= -"idp11159088"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.32 Coils and zigzags"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-coils" name= -"pstricks-coils"></a>4.2.2.32 Coils and zigzags</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pscoil*[par]{arrows}(x0,y0)(x1,y1)</code></span></dt> -<dd><a id="idp11164944" class="indexterm" name= -"idp11164944"></a></dd> -<dt><span class="term"><code class= -"literal">\psCoil*[par]{angle1}{angle2}</code></span></dt> -<dd><a id="idp11168704" class="indexterm" name= -"idp11168704"></a></dd> -<dt><span class="term"><code class= -"literal">\pszigzag*[par]{arrows}(x0,y0)(x1,y1)</code></span></dt> -<dd><a id="idp11172464" class="indexterm" name= -"idp11172464"></a></dd> -<dt><span class="term"><code class= -"literal">coilwidth=dim</code></span></dt> -<dd><a id="idp11176208" class="indexterm" name="idp11176208"></a> -<p>Default: <code class="literal">1cm</code></p> -</dd> -<dt><span class="term"><code class= -"literal">coilheight=num</code></span></dt> -<dd><a id="idp11181024" class="indexterm" name="idp11181024"></a> -<p>Default: <code class="literal">1</code></p> -</dd> -<dt><span class="term"><code class= -"literal">coilarm=dim</code></span></dt> -<dd><a id="idp11185840" class="indexterm" name="idp11185840"></a> -<p>Default: <code class="literal">.5cm</code></p> -</dd> -<dt><span class="term"><code class= -"literal">coilaspect=angle</code></span></dt> -<dd><a id="idp11190736" class="indexterm" name="idp11190736"></a> -<p>Default: <code class="literal">45</code></p> -</dd> -<dt><span class="term"><code class= -"literal">coilinc=angle</code></span></dt> -<dd><a id="idp11195552" class="indexterm" name="idp11195552"></a> -<p>Default: <code class="literal">10</code></p> -</dd> -<dt><span class="term"><code class= -"literal">\nccoil*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11200432" class="indexterm" name= -"idp11200432"></a></dd> -<dt><span class="term"><code class= -"literal">\nczigzag*[par]{arrows}{nodeA}{nodeB}</code></span></dt> -<dd><a id="idp11204192" class="indexterm" name= -"idp11204192"></a></dd> -<dt><span class="term"><code class= -"literal">\pccoil*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11208000" class="indexterm" name= -"idp11208000"></a></dd> -<dt><span class="term"><code class= -"literal">\pczigzag*[par]{arrows}(x1,y1)(x2,y2)</code></span></dt> -<dd><a id="idp11211760" class="indexterm" name= -"idp11211760"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.33 Special coordinates"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-coordinates" name= -"pstricks-coordinates"></a>4.2.2.33 Special coordinates</h5> -</div> -</div> -</div> -<p><code class="literal">\SpecialCoor</code></p> -<a id="idp11216848" class="indexterm" name="idp11216848"></a> -<div class="table"><a id="table-special-coordinates" name= -"table-special-coordinates"></a> -<p class="title"><strong>Table 1.12. Special coordinates -and angles</strong></p> -<div class="table-contents"> -<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> -</div> -<br class="table-break" /> -<p><code class="literal">\NormalCoor</code></p> -<a id="idp11251264" class="indexterm" name="idp11251264"></a></div> -<div class="section" title="4.2.2.34 Overlays"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-overlays" name= -"pstricks-overlays"></a>4.2.2.34 Overlays</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\overlaybox -stuff\endoverlaybox</code></span></dt> -<dd><a id="idp11256768" class="indexterm" name= -"idp11256768"></a></dd> -<dt><span class="term"><code class= -"literal">\psoverlay{string}</code></span></dt> -<dd><a id="idp11260512" class="indexterm" name= -"idp11260512"></a></dd> -<dt><span class="term"><code class= -"literal">\putoverlaybox{string}</code></span></dt> -<dd><a id="idp11264304" class="indexterm" name= -"idp11264304"></a></dd> -<dt><span class="term"><code class= -"literal">gradbegin=color</code></span></dt> -<dd><a id="idp11268048" class="indexterm" name="idp11268048"></a> -<p>Default: <code class="literal">gradbegin</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gradend=color</code></span></dt> -<dd><a id="idp11272896" class="indexterm" name="idp11272896"></a> -<p>Default: <code class="literal">gradend</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gradlines=int</code></span></dt> -<dd><a id="idp11277744" class="indexterm" name="idp11277744"></a> -<p>Default: <code class="literal">500</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gradmidpoint=num</code></span></dt> -<dd><a id="idp11282608" class="indexterm" name="idp11282608"></a> -<p>Default: <code class="literal">.9</code></p> -</dd> -<dt><span class="term"><code class= -"literal">gradangle=angle</code></span></dt> -<dd><a id="idp11287472" class="indexterm" name="idp11287472"></a> -<p>Default: <code class="literal">0</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title= -"4.2.2.35 Typesetting text along a path"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-path" name= -"pstricks-path"></a>4.2.2.35 Typesetting text along a path</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pstextpath[pos](x,y){graphics -object}{text}</code></span></dt> -<dd><a id="idp11294528" class="indexterm" name= -"idp11294528"></a></dd> -</dl> -</div> -</div> -<div class="section" title= -"4.2.2.36 Stroking and filling character paths"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-stroking" name= -"pstricks-stroking"></a>4.2.2.36 Stroking and filling character -paths</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class= -"literal">\pscharpath*[par]{text}</code></span></dt> -<dd><a id="idp11300480" class="indexterm" name= -"idp11300480"></a></dd> -<dt><span class="term"><code class= -"literal">\pscharclip*[par]{text} ... -\endpscharclip</code></span></dt> -<dd><a id="idp11304304" class="indexterm" name= -"idp11304304"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.37 Exporting EPS files"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-exporting" name= -"pstricks-exporting"></a>4.2.2.37 Exporting EPS files</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\TeXtoEPS ... -\endTeXtoEPS</code></span></dt> -<dd><a id="idp11310240" class="indexterm" name= -"idp11310240"></a></dd> -<dt><span class="term"><code class= -"literal">\PSTtoEPS[par]{file}{graphics objects}</code></span></dt> -<dd><a id="idp11314000" class="indexterm" name= -"idp11314000"></a></dd> -<dt><span class="term"><code class= -"literal">bbllx=dim</code></span></dt> -<dd><a id="idp11317744" class="indexterm" name="idp11317744"></a> -<p>Default: <code class="literal">-1pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">bblly=dim</code></span></dt> -<dd><a id="idp11322592" class="indexterm" name="idp11322592"></a> -<p>Default: <code class="literal">-1pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">bburx=dim</code></span></dt> -<dd><a id="idp11327440" class="indexterm" name="idp11327440"></a> -<p>Default: <code class="literal">1pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">bbury=dim</code></span></dt> -<dd><a id="idp11332304" class="indexterm" name="idp11332304"></a> -<p>Default: <code class="literal">1pt</code></p> -</dd> -<dt><span class="term"><code class= -"literal">headerfile=file</code></span></dt> -<dd><a id="idp11337120" class="indexterm" name="idp11337120"></a> -<p>Default: <code class="literal">s</code></p> -</dd> -<dt><span class="term"><code class= -"literal">headers=none/all/user</code></span></dt> -<dd><a id="idp11341936" class="indexterm" name="idp11341936"></a> -<p>Default: <code class="literal">none</code></p> -</dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.38 Boxes"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-boxes" name= -"pstricks-boxes"></a>4.2.2.38 Boxes</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\psmathboxtrue, -\psmathboxfalse</code></span></dt> -<dd><a id="idp11348944" class="indexterm" name= -"idp11348944"></a><a id="idp11350848" class="indexterm" name= -"idp11350848"></a></dd> -<dt><span class="term"><code class= -"literal">\everypsbox{commands}</code></span></dt> -<dd><a id="idp11354592" class="indexterm" name= -"idp11354592"></a></dd> -<dt><span class="term"><code class= -"literal">\pslongbox{name}{cmd}</code></span></dt> -<dd><a id="idp11358336" class="indexterm" name= -"idp11358336"></a></dd> -<dt><span class="term"><code class="literal">\psverbboxtrue, -\psverbboxfalse</code></span></dt> -<dd><a id="idp11362096" class="indexterm" name= -"idp11362096"></a><a id="idp11364000" class="indexterm" name= -"idp11364000"></a></dd> -</dl> -</div> -</div> -<div class="section" title="4.2.2.39 Tips and More Tricks"> -<div class="titlepage"> -<div> -<div> -<h5 class="title"><a id="pstricks-tricks" name= -"pstricks-tricks"></a>4.2.2.39 Tips and More Tricks</h5> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">\pslbrace, -\psrbrace</code></span></dt> -<dd><a id="idp11369824" class="indexterm" name= -"idp11369824"></a><a id="idp11371728" class="indexterm" name= -"idp11371728"></a></dd> -</dl> -</div> -</div> -</div> -<div class="section" title= -"4.2.3 List of Additional PSTricks Packages"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="pstricks-add-packages" name= -"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 class="ulink" href= -"ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/psgo/" -target="_top"><code class="literal">psgo</code></a></span></dt> -<dd>Draw Go diagrams</dd> -<dt><span class="term"><a class="ulink" href= -"ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-blur/" -target="_top"><code class="literal">pst-blur</code></a></span></dt> -<dd>PSTricks package for "blurred" shadows</dd> -<dt><span class="term"><a class="ulink" href= -"http://dominique.rodriguez.9online.fr/pst-eucl/" target= -"_top"><code class="literal">pst-euc</code></a></span></dt> -<dd>Géométrie en LaTeX et PSTricks</dd> -<dt><span class="term"><a class="ulink" href= -"http://www.tug.org/applications/PSTricks/More/pst-fr3d.tar.gz" -target="_top"><code class="literal">pst-fr3d</code></a></span></dt> -<dd>Three dimensional framed Boxes</dd> -<dt><span class="term"><a class="ulink" href= -"ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-ghsb/" -target="_top"><code class="literal">pst-ghsb</code></a></span></dt> -<dd>PSTricks package for HSB Gradients</dd> -<dt><span class="term"><a class="ulink" href= -"ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-gr3d/" -target="_top"><code class="literal">pst-gr3d</code></a></span></dt> -<dd>PSTricks package for 3D grids</dd> -<dt><span class="term"><a class="ulink" href= -"http://members.aol.com/ManuelLuque2/optique.htm" target= -"_top"><code class="literal">pst-lens</code></a></span></dt> -<dd>Optique géométrique</dd> -<dt><span class="term"><a class="ulink" href= -"ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/" target= -"_top"><code class="literal">pst-node</code></a></span></dt> -<dd>PSTricks package for nodes</dd> -<dt><span class="term"><a class="ulink" href= -"http://members.aol.com/Mluque5130/pst-ob3d.tar.gz" target= -"_top"><code class="literal">pst-ob3d</code></a></span></dt> -<dd>A PSTricks package for three dimensional basic objects</dd> -<dt><span class="term"><a class="ulink" href= -"http://www.tug.org/applications/PSTricks/Physics/Oscilloscopes/" -target="_top"><code class="literal">pst-osci</code></a></span></dt> -<dd>Oscilloscopes with PSTricks</dd> -<dt><span class="term"><a class="ulink" href= -"ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-poly/" -target="_top"><code class="literal">pst-poly</code></a></span></dt> -<dd>Polygons with PSTricks</dd> -<dt><span class="term"><a class="ulink" href= -"ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/" target= -"_top"><code class="literal">pst-tree</code></a></span></dt> -<dd>PSTricks package for trees</dd> -<dt><span class="term"><a class="ulink" href= -"http://www.ensta.fr/~diam/latex/pst-uml/" target= -"_top"><code class="literal">pst-uml</code></a></span></dt> -<dd>Draw easily diagrams with UML notation</dd> -<dt><span class="term"><a class="ulink" href= -"http://perso.enst.fr/~lombardy/Vauc/" target="_top"><code class= -"literal">vaucansom.sty</code></a></span></dt> -<dd>Drawing automata</dd> -</dl> -</div> -</div> -</div> -</div> -<div class="section" title="5 fontinst (tbd.)"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="fontinst" name= -"fontinst"></a>5 <code class="filename">fontinst</code> (tbd.)</h2> -</div> -</div> -</div> -<a id="idp11414640" class="indexterm" name="idp11414640"></a> -<p>tbd.</p> -</div> -<div class="section" title="6 ConTeXt (tbd.)"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="context" name= -"context"></a>6 ConTeXt (tbd.)</h2> -</div> -</div> -</div> -<a id="idp11417680" class="indexterm" name="idp11417680"></a><a id= -"idp11418688" class="indexterm" name="idp11418688"></a> -<div class="section" title="6.1 Overview"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="context-ovw" name="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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Inline XML (including MathML, ChemML, and -PhysML)</li> -<li class="listitem">really good XML support in general</li> -<li class="listitem">inline MetaPost</li> -</ul> -</div> -</div> -</div> -<div class="section" title="7 Texinfo (tbd.)"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="texinfo" name= -"texinfo"></a>7 Texinfo (tbd.)</h2> -</div> -</div> -</div> -<a id="idp11428560" class="indexterm" name="idp11428560"></a> -<p>tbd.</p> -</div> -</div> -<div xml:lang="en" class="chapter" title= -"Chapter 2. pdfTeX" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="pdftex" name= -"pdftex"></a>Chapter 2. pdfTeX</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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 <code class= -"filename">--file-line-error-style</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-fmt">1.2 -<code class="filename">--fmt format</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-help">1.3 -<code class="filename">--help</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-ini">1.4 -<code class="filename">--ini</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-interaction-mode">1.5 <code class= -"filename">--interaction mode</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-ipc">1.6 -<code class="filename">--ipc</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-ipc-start">1.7 -<code class="filename">--ipc-start</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-jobname-name">1.8 -<code class="filename">--jobname name</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-kpathsea-debug">1.9 <code class= -"filename">--kpathsea-debug bitmask</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-maketex">1.10 -<code class="filename">--maketex fmt</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-no-maketex">1.11 -<code class="filename">--no-maketex fmt</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-output-comment">1.12 <code class= -"filename">--output-comment string</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-parse-first-line">1.13 <code class= -"filename">--parse-first-line</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-progname">1.14 -<code class="filename">--progname name</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-recorder">1.15 -<code class="filename">--recorder</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-shell-escape">1.16 <code class= -"filename">--shell-escape</code></a></span></dt> -<dt><span class="section"><a href= -"#pdftex-option-translate-file">1.17 <code class= -"filename">--translate-file tcxname</code></a></span></dt> -<dt><span class="section"><a href="#pdftex-option-version">1.18 -<code class="filename">--version</code></a></span></dt> -</dl> -</dd> -<dt><span class="section"><a href="#pdftex-environment">2 -Environment</a></span></dt> -</dl> -</div> -<a id="idp11432784" class="indexterm" name="idp11432784"></a> -<div class="note" title="Note" style= -"margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Note</h3> -<p>The contents of this section was taken from <code class= -"filename">pdftex(1)</code>.</p> -</div> -<div class="section" title="1 Options"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="pdftex-options" name= -"pdftex-options"></a>1 Options</h2> -</div> -</div> -</div> -<a id="idp11436624" class="indexterm" name="idp11436624"></a> -<p>pdfTeX understands the following command line options.</p> -<div class="section" title="1.1 --file-line-error-style"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-file-line-error-style" name= -"pdftex-option-file-line-error-style"></a>1.1 <code class= -"filename">--file-line-error-style</code></h3> -</div> -</div> -</div> -<a id="idp11440816" class="indexterm" name="idp11440816"></a> -<p>Print error messages in the form <code class= -"literal">file:line:error</code> which is similar to the way many -compilers format them.</p> -</div> -<div class="section" title="1.2 --fmt format"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-fmt" name= -"pdftex-option-fmt"></a>1.2 <code class="filename">--fmt -format</code></h3> -</div> -</div> -</div> -<a id="idp11445776" class="indexterm" name="idp11445776"></a> -<p>Use <code class="literal">format</code> as the name of the -format to be used, instead of the name by which pdfTeX was called -or a <code class="literal">%&</code> line.</p> -</div> -<div class="section" title="1.3 --help"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-help" name= -"pdftex-option-help"></a>1.3 <code class= -"filename">--help</code></h3> -</div> -</div> -</div> -<a id="idp11452096" class="indexterm" name="idp11452096"></a> -<p>Print help message and exit.</p> -</div> -<div class="section" title="1.4 --ini"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-ini" name= -"pdftex-option-ini"></a>1.4 <code class= -"filename">--ini</code></h3> -</div> -</div> -</div> -<a id="idp11456384" class="indexterm" name="idp11456384"></a> -<p>Be <span class="command"><strong>pdfinitex</strong></span>, for -dumping formats; this is implicitly true if the program is called -as <span class="command"><strong>pdfinitex</strong></span>.</p> -</div> -<div class="section" title="1.5 --interaction mode"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-interaction-mode" name= -"pdftex-option-interaction-mode"></a>1.5 <code class= -"filename">--interaction mode</code></h3> -</div> -</div> -</div> -<a id="idp11462112" class="indexterm" name="idp11462112"></a> -<p>Sets the interaction mode. The mode can be one of <code class= -"literal">batchmode</code>, <code class= -"literal">nonstopmode</code>, <code class= -"literal">scrollmode</code>, and <code class= -"literal">errorstopmode</code>. The meaning of these modes is the -same as that of the corresponding <code class= -"literal">\commands</code>.</p> -</div> -<div class="section" title="1.6 --ipc"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-ipc" name= -"pdftex-option-ipc"></a>1.6 <code class= -"filename">--ipc</code></h3> -</div> -</div> -</div> -<a id="idp11469856" class="indexterm" name="idp11469856"></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" title="1.7 --ipc-start"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-ipc-start" name= -"pdftex-option-ipc-start"></a>1.7 <code class= -"filename">--ipc-start</code></h3> -</div> -</div> -</div> -<a id="idp11474208" class="indexterm" name="idp11474208"></a> -<p>As <code class="literal">--ipc</code>, 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" title="1.8 --jobname name"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-jobname-name" name= -"pdftex-option-jobname-name"></a>1.8 <code class= -"filename">--jobname name</code></h3> -</div> -</div> -</div> -<a id="idp11479360" class="indexterm" name="idp11479360"></a> -<p>Use <code class="literal">name</code> for the job name, instead -of deriving it from the name of the input file.</p> -</div> -<div class="section" title="1.9 --kpathsea-debug bitmask"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-kpathsea-debug" name= -"pdftex-option-kpathsea-debug"></a>1.9 <code class= -"filename">--kpathsea-debug bitmask</code></h3> -</div> -</div> -</div> -<a id="idp11484304" class="indexterm" name="idp11484304"></a> -<p>Sets path searching debugging flags according to the -<code class="literal">bitmask</code>. See the Kpathsea manual for -details.</p> -</div> -<div class="section" title="1.10 --maketex fmt"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-maketex" name= -"pdftex-option-maketex"></a>1.10 <code class="filename">--maketex -fmt</code></h3> -</div> -</div> -</div> -<a id="idp11489376" class="indexterm" name="idp11489376"></a> -<p>Enable <span class="command"><strong>mktexfmt</strong></span>, -where <code class="literal">fmt</code> must be one of <code class= -"literal">tex</code> or <code class="literal">tfm</code>.</p> -</div> -<div class="section" title="1.11 --no-maketex fmt"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-no-maketex" name= -"pdftex-option-no-maketex"></a>1.11 <code class= -"filename">--no-maketex fmt</code></h3> -</div> -</div> -</div> -<a id="idp11496608" class="indexterm" name="idp11496608"></a> -<p>Disable <span class="command"><strong>mktexfmt</strong></span>, -where <code class="literal">fmt</code> must be one of <code class= -"literal">tex</code> or <code class="literal">tfm</code>.</p> -</div> -<div class="section" title="1.12 --output-comment string"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-output-comment" name= -"pdftex-option-output-comment"></a>1.12 <code class= -"filename">--output-comment string</code></h3> -</div> -</div> -</div> -<a id="idp11503648" class="indexterm" name="idp11503648"></a> -<p>Use <code class="literal">string</code> for the DVI file comment -instead of the date.</p> -</div> -<div class="section" title="1.13 --parse-first-line"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-parse-first-line" name= -"pdftex-option-parse-first-line"></a>1.13 <code class= -"filename">--parse-first-line</code></h3> -</div> -</div> -</div> -<a id="idp11508704" class="indexterm" name="idp11508704"></a> -<p>If the first line of the main input file begins with -<code class="literal">%&</code> parse it to look for a dump -name or a <code class="literal">--translate-file</code> option.</p> -</div> -<div class="section" title="1.14 --progname name"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-progname" name= -"pdftex-option-progname"></a>1.14 <code class="filename">--progname -name</code></h3> -</div> -</div> -</div> -<a id="idp11514432" class="indexterm" name="idp11514432"></a> -<p>Pretend to be program <code class="literal">name</code>. This -affects both the format used and the search paths.</p> -</div> -<div class="section" title="1.15 --recorder"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-recorder" name= -"pdftex-option-recorder"></a>1.15 <code class= -"filename">--recorder</code></h3> -</div> -</div> -</div> -<a id="idp11519424" class="indexterm" name="idp11519424"></a> -<p>Enable the filename recorder. This leaves a trace of the files -opened for input and output in a file with extension <code class= -"literal">.fls</code>.</p> -</div> -<div class="section" title="1.16 --shell-escape"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-shell-escape" name= -"pdftex-option-shell-escape"></a>1.16 <code class= -"filename">--shell-escape</code></h3> -</div> -</div> -</div> -<a id="idp11524592" class="indexterm" name="idp11524592"></a> -<p>Enable the <code class="literal">\write18{command}</code> -construct. The command can be any Bourne shell command. This -construct is normally disallowed for security reasons.</p> -</div> -<div class="section" title="1.17 --translate-file tcxname"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-translate-file" name= -"pdftex-option-translate-file"></a>1.17 <code class= -"filename">--translate-file tcxname</code></h3> -</div> -</div> -</div> -<a id="idp11529696" class="indexterm" name="idp11529696"></a> -<p>Use the <code class="literal">tcxname</code> translation -table.</p> -</div> -<div class="section" title="1.18 --version"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="pdftex-option-version" name= -"pdftex-option-version"></a>1.18 <code class= -"filename">--version</code></h3> -</div> -</div> -</div> -<a id="idp11534720" class="indexterm" name="idp11534720"></a> -<p>Print version information and exit.</p> -</div> -</div> -<div class="section" title="2 Environment"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="pdftex-environment" -name="pdftex-environment"></a>2 Environment</h2> -</div> -</div> -</div> -<a id="idp11538416" class="indexterm" name="idp11538416"></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 class= -"command"><strong>kpsewhich</strong></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"><code class= -"literal">TEXMFOUTPUT</code></span></dt> -<dd><a id="idp11544928" class="indexterm" name="idp11544928"></a> -<p class="simpara">Normally, pdfTeX puts its output files in the -current directory. If any output file cannot be opened there, it -tries to open it in the directory specified in the environment -variable <code class="literal">TEXMFOUTPUT</code>. There is no -default value for that variable. For example, if you say -<span class="command"><strong>pdftex paper</strong></span> and the -current directory is not writable, if <code class= -"literal">TEXMFOUTPUT</code> has the value <code class= -"literal">/tmp</code>, pdfTeX attempts to create <code class= -"literal">/tmp/paper.log</code> (and <code class= -"literal">/tmp/paper.pdf</code>, if any output is produced.)</p> -</dd> -<dt><span class="term"><code class= -"literal">TEXINPUTS</code></span></dt> -<dd><a id="idp11555008" class="indexterm" name="idp11555008"></a> -<p class="simpara">Search path for <code class= -"literal">\input</code> and <code class="literal">\openin</code> -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 <code class= -"filename">texmf.cnf</code> file. For example, set <code class= -"literal">TEXINPUTS</code> to <code class= -"literal">".:/home/usr/tex:"</code> to prepend the current direcory -and <code class="literal">``/home/user/tex''</code> to the standard -search path.</p> -</dd> -<dt><span class="term"><code class= -"literal">TEXFONTS</code></span></dt> -<dd><a id="idp11563792" class="indexterm" name="idp11563792"></a> -<p class="simpara">earch path for font metric (<code class= -"literal">.tfm</code>) files.</p> -</dd> -<dt><span class="term"><code class= -"literal">TEXFORMATS</code></span></dt> -<dd><a id="idp11568720" class="indexterm" name="idp11568720"></a> -<p class="simpara">Search path for format files.</p> -</dd> -<dt><span class="term"><code class= -"literal">TEXPOOL</code></span></dt> -<dd><a id="idp11572928" class="indexterm" name="idp11572928"></a> -<p class="simpara">Search path for <span class= -"command"><strong>pdfinitex</strong></span> internal strings.</p> -</dd> -<dt><span class="term"><code class= -"literal">TEXEDIT</code></span></dt> -<dd><a id="idp11577856" class="indexterm" name="idp11577856"></a> -<p class="simpara">Command template for switching to editor. The -default, usually <span class="command"><strong>vi</strong></span>, -is set when pdfTeX is compiled.</p> -</dd> -</dl> -</div> -</div> -</div> -<div xml:lang="en" class="chapter" title= -"Chapter 3. Metafont (tbd.)" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="metafont" name= -"metafont"></a>Chapter 3. Metafont (tbd.)</h2> -</div> -</div> -</div> -<a id="idp11584672" class="indexterm" name="idp11584672"></a> -<p>tbd.</p> -</div> -<div xml:lang="en" class="chapter" title= -"Chapter 4. MetaPost" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="metapost" name= -"metapost"></a>Chapter 4. MetaPost</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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 <code class= -"filename">--file-line-error-style</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-help">1.2 -<code class="filename">--help</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-ini">1.3 -<code class="filename">--ini</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-intercation">1.4 <code class= -"filename">--interaction mode</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-jobname">1.5 -<code class="filename">--jobname name</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-kpathsea-debug">1.6 <code class= -"filename">--kpathsea-debug bitmask</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-mem">1.7 -<code class="filename">--mem mem</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-parse-first-line">1.8 <code class= -"filename">--parse-first-line</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-progname">1.9 -<code class="filename">--progname name</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-recorder">1.10 -<code class="filename">--recorder</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-T">1.11 -<code class="filename">-T</code></a></span></dt> -<dt><span class="section"><a href= -"#metapost-option-translate-file">1.12 <code class= -"filename">--translate-file tcxname</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-troff">1.13 -<code class="filename">--troff</code></a></span></dt> -<dt><span class="section"><a href="#metapost-option-version">1.14 -<code class="filename">--version</code></a></span></dt> -</dl> -</dd> -<dt><span class="section"><a href="#metapost-environment">2 -Environment</a></span></dt> -</dl> -</div> -<a id="idp11588048" class="indexterm" name="idp11588048"></a> -<div class="note" title="Note" style= -"margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Note</h3> -<p>The contents of this section was taken from <code class= -"filename">mpost(1)</code>.</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" title="1 Options"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="metapost-options" -name="metapost-options"></a>1 Options</h2> -</div> -</div> -</div> -<a id="idp11593248" class="indexterm" name="idp11593248"></a> -<p>MetaPost understands the following command line options.</p> -<div class="section" title="1.1 --file-line-error-style"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-file-line-error-style" -name="metapost-option-file-line-error-style"></a>1.1 <code class= -"filename">--file-line-error-style</code></h3> -</div> -</div> -</div> -<a id="idp11597104" class="indexterm" name="idp11597104"></a> -<p>Print error messages in the form <code class= -"literal">file:line:error</code> which is similar to the way many -compilers format them.</p> -</div> -<div class="section" title="1.2 --help"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-help" name= -"metapost-option-help"></a>1.2 <code class= -"filename">--help</code></h3> -</div> -</div> -</div> -<a id="idp11602064" class="indexterm" name="idp11602064"></a> -<p>Print help message and exit.</p> -</div> -<div class="section" title="1.3 --ini"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-ini" name= -"metapost-option-ini"></a>1.3 <code class= -"filename">--ini</code></h3> -</div> -</div> -</div> -<a id="idp11606304" class="indexterm" name="idp11606304"></a> -<p>Be <span class="command"><strong>inimpost</strong></span>, for -dumping bases; this is implicitly true if the program is called as -<span class="command"><strong>inimpost</strong></span>.</p> -</div> -<div class="section" title="1.4 --interaction mode"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-intercation" name= -"metapost-option-intercation"></a>1.4 <code class= -"filename">--interaction mode</code></h3> -</div> -</div> -</div> -<a id="idp11612032" class="indexterm" name="idp11612032"></a> -<p>Sets the interaction mode. The mode can be one of <code class= -"literal">batchmode</code>, <code class= -"literal">nonstopmode</code>, <code class= -"literal">scrollmode</code>, and <code class= -"literal">errorstopmode</code>. The meaning of these modes is the -same as that of the corresponding commands.</p> -</div> -<div class="section" title="1.5 --jobname name"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-jobname" name= -"metapost-option-jobname"></a>1.5 <code class="filename">--jobname -name</code></h3> -</div> -</div> -</div> -<a id="idp11619200" class="indexterm" name="idp11619200"></a> -<p>Use <code class="literal">name</code> for the job name, instead -of deriving it from the name of the input file.</p> -</div> -<div class="section" title="1.6 --kpathsea-debug bitmask"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-kpathsea-debug" name= -"metapost-option-kpathsea-debug"></a>1.6 <code class= -"filename">--kpathsea-debug bitmask</code></h3> -</div> -</div> -</div> -<a id="idp11624256" class="indexterm" name="idp11624256"></a> -<p>Sets path searching debugging flags according to the -<code class="literal">bitmask</code>. See the Kpathsea manual for -details.</p> -</div> -<div class="section" title="1.7 --mem mem"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-mem" name= -"metapost-option-mem"></a>1.7 <code class="filename">--mem -mem</code></h3> -</div> -</div> -</div> -<a id="idp11629312" class="indexterm" name="idp11629312"></a> -<p>Use <code class="literal">mem</code> as the name of the mem to -be used, instead of the name by which MetaPost was called or a -<code class="literal">%&</code> line.</p> -</div> -<div class="section" title="1.8 --parse-first-line"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-parse-first-line" name= -"metapost-option-parse-first-line"></a>1.8 <code class= -"filename">--parse-first-line</code></h3> -</div> -</div> -</div> -<a id="idp11635168" class="indexterm" name="idp11635168"></a> -<p>If the first line of the main input file begins with -<code class="literal">%&</code> parse it to look for a dump -name or a <code class="literal">--translate-file</code> option.</p> -</div> -<div class="section" title="1.9 --progname name"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-progname" name= -"metapost-option-progname"></a>1.9 <code class= -"filename">--progname name</code></h3> -</div> -</div> -</div> -<a id="idp11640976" class="indexterm" name="idp11640976"></a> -<p>Pretend to be program <code class="literal">name</code>. This -affects both the format used and the search paths.</p> -</div> -<div class="section" title="1.10 --recorder"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-recorder" name= -"metapost-option-recorder"></a>1.10 <code class= -"filename">--recorder</code></h3> -</div> -</div> -</div> -<a id="idp11645920" class="indexterm" name="idp11645920"></a> -<p>Enable the filename recorder. This leaves a trace of the files -opened for input and output in a file with extension <code class= -"literal">.fls.</code></p> -</div> -<div class="section" title="1.11 -T"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-T" name= -"metapost-option-T"></a>1.11 <code class="filename">-T</code></h3> -</div> -</div> -</div> -<a id="idp11650768" class="indexterm" name="idp11650768"></a> -<p>Produce TROFF output.</p> -</div> -<div class="section" title="1.12 --translate-file tcxname"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-translate-file" name= -"metapost-option-translate-file"></a>1.12 <code class= -"filename">--translate-file tcxname</code></h3> -</div> -</div> -</div> -<a id="idp11655008" class="indexterm" name="idp11655008"></a> -<p>Use the <code class="literal">tcxname</code> translation -table.</p> -</div> -<div class="section" title="1.13 --troff"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-troff" name= -"metapost-option-troff"></a>1.13 <code class= -"filename">--troff</code></h3> -</div> -</div> -</div> -<a id="idp11659968" class="indexterm" name="idp11659968"></a> -<p>As -T.</p> -</div> -<div class="section" title="1.14 --version"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="metapost-option-version" name= -"metapost-option-version"></a>1.14 <code class= -"filename">--version</code></h3> -</div> -</div> -</div> -<a id="idp11664192" class="indexterm" name="idp11664192"></a> -<p>Print version information and exit.</p> -</div> -</div> -<div class="section" title="2 Environment"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="metapost-environment" -name="metapost-environment"></a>2 Environment</h2> -</div> -</div> -</div> -<a id="idp11667936" class="indexterm" name="idp11667936"></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 class= -"command"><strong>kpsewhich</strong></span> utility can be used to -query the values of the variables.</p> -<p>If the environment variable <code class= -"literal">TEXMFOUTPUT</code> 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"><code class= -"literal">MPINPUTS</code></span></dt> -<dd><a id="idp11674064" class="indexterm" name="idp11674064"></a> -<p class="simpara">Search path for input files.</p> -</dd> -<dt><span class="term"><code class= -"literal">MFINPUTS</code></span></dt> -<dd><a id="idp11677984" class="indexterm" name="idp11677984"></a> -<p class="simpara">Auxiliary search path for input files with -<code class="literal">.mf</code> extensions.</p> -</dd> -<dt><span class="term"><code class= -"literal">MPSUPPORT</code></span></dt> -<dd><a id="idp11682656" class="indexterm" name="idp11682656"></a> -<p class="simpara">Directory for various tables for handling -included TeX and troff.</p> -</dd> -<dt><span class="term"><code class= -"literal">MPXCOMMAND</code></span></dt> -<dd><a id="idp11687056" class="indexterm" name="idp11687056"></a> -<p class="simpara">The name of a shell script that converts -embedded typesetting commands to a form that MetaPost understands. -Defaults: <code class="literal">makempx</code> for TeX and -<code class="literal">troffmpx</code> for troff.</p> -</dd> -<dt><span class="term"><code class="literal">TEX</code></span></dt> -<dd><a id="idp11692944" class="indexterm" name="idp11692944"></a> -<p class="simpara">The version of TeX - or LaTeX - to use when -processing <span class="command"><strong>btex</strong></span> and -<span class="command"><strong>verbatimtex</strong></span> commands. -Default TeX. This version of MetaPost allows you to use a -<code class="literal">`%&format'</code> line instead.</p> -</dd> -<dt><span class="term"><code class= -"literal">TROFF</code></span></dt> -<dd><a id="idp11700416" class="indexterm" name="idp11700416"></a> -<p class="simpara">The troff pipeline for <span class= -"command"><strong>btex</strong></span> and <span class= -"command"><strong>verbatimtex</strong></span> commands. Default -<code class="literal">eqn -d\$\$ | troff</code></p> -</dd> -<dt><span class="term"><code class= -"literal">MPEDIT</code></span></dt> -<dd><a id="idp11706336" class="indexterm" name="idp11706336"></a> -<p class="simpara">A command template for invoking an editor.</p> -</dd> -</dl> -</div> -<p>A <code class="literal">.mem</code> file is a binary file that -permits fast loading of macro packages. MetaPost reads the default -<code class="literal">plain.mem</code> unless another <code class= -"literal">.mem</code> file is specified at the start of the first -line with an <code class="literal">&</code> just before it. -There is also an <code class="literal">mfplain.mem</code> that -simulates plain Metafont so that MetaPost can read <code class= -"literal">.mf</code> fonts. (Plain Metafont is described in -<span class="emphasis"><em>The Metafontbook</em></span>).</p> -<p>Experts can create <code class="literal">.mem</code> files by -invoking <span class="command"><strong>inimpost</strong></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 xml:lang="en" class="chapter" title= -"Chapter 5. BibTeX" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="bibtex" name= -"bibtex"></a>Chapter 5. BibTeX</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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 -<code class="filename">@STRING</code> 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 -<code class="filename">ABBRV.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-alpha">4.2 -<code class="filename">ALPHA.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-plain">4.3 -<code class="filename">PLAIN.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-sample">4.4 -<code class="filename">SAMPLE.BST</code></a></span></dt> -<dt><span class="section"><a href="#bibtex-bst-unsrt">4.5 -<code class="filename">UNSRT.BST</code></a></span></dt> -</dl> -</dd> -</dl> -</div> -<a id="idp11719920" class="indexterm" name="idp11719920"></a> -<div class="note" title="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" title="1 Parameters"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="bibtex-parameters" -name="bibtex-parameters"></a>1 Parameters</h2> -</div> -</div> -</div> -<a id="idp11724784" class="indexterm" name="idp11724784"></a> -<p><code class="literal">bibliography-file-spec</code></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" title="2 Command Qualifiers"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id= -"bibtex-command-qualifiers" name="bibtex-command-qualifiers"></a>2 -Command Qualifiers</h2> -</div> -</div> -</div> -<a id="idp11729888" class="indexterm" name="idp11729888"></a> -<p><code class="literal">/BIBINPUTS -/BIBINPUTS=(name,...)</code></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 -<code class="literal">/BIBINPUTS</code> option.</p> -<p>Default is <code class="literal">/BIBINPUTS=(TEX_BIB:)</code>; -TeX looks in the directory associated with the logical name -<code class="literal">TEX_BIB.</code></p> -<p><code class="literal">/STATS /STATS /NOSTATS [D]</code></p> -<p>This qualifier is used while debugging <code class= -"literal">.BST</code> files to determine BIBTEX memory usage.</p> -<p><code class="literal">/TEXINPUTS -/TEXINPUTS=(name,...)</code></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 -<code class="literal">/TEXINPUTS</code> option.</p> -<p>Default is <code class="literal">/TEXINPUTS=(TEX_INPUTS)</code>; -TeX looks in the directory associated with the logical name -<code class="literal">TEX_INPUTS</code>.</p> -<p><code class="literal">/TRACE /TRACE /NOTRACE [D]</code></p> -<p>This qualifier is used while debugging <code class= -"literal">.BST</code> files to follow program flow.</p> -</div> -<div class="section" title="3 bib files"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="bibtex-bib-files" -name="bibtex-bib-files"></a>3 bib files</h2> -</div> -</div> -</div> -<a id="idp11746736" class="indexterm" name="idp11746736"></a> -<p>This help entry contains the same information as Appendix B of -the LaTeX manual. It describes the format of a bibliography -database (<code class="literal">.BIB</code>) 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" title="3.1 @STRING command"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-string-command" name= -"bibtex-string-command"></a>3.1 <code class= -"filename">@STRING</code> command</h3> -</div> -</div> -</div> -<a id="idp11752400" class="indexterm" name="idp11752400"></a> -<p>The <code class="literal">@STRING</code> 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 <code class="literal">@string</code> 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 <code class="literal">@string</code> commands is -at the beginning of the file. A <code class= -"literal">@string</code> 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" title="3.2 Entry Format"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-entry-format" name= -"bibtex-entry-format"></a>3.2 Entry Format</h3> -</div> -</div> -</div> -<a id="idp11762464" class="indexterm" name="idp11762464"></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 <code class="literal">@BOOK</code> 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 -<code class="literal">\cite</code> command referring to the -entry.</p> -<p>This entry has four fields, named <code class= -"literal">AUTHOR</code>, <code class="literal">TITLE</code>, -<code class="literal">PUBLISHER</code> and <code class= -"literal">ADDRESS</code>. 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 <code class="literal">\cite</code> 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" title="3.3 Entry Types"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-entry-types" name= -"bibtex-entry-types"></a>3.3 Entry Types</h3> -</div> -</div> -</div> -<a id="idp11779008" class="indexterm" name="idp11779008"></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" title="3.3.1 article entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-article" name= -"bibtex-entry-types-article"></a>3.3.1 article entry</h4> -</div> -</div> -</div> -<a id="idp11791424" class="indexterm" name="idp11791424"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-journal" title= -"3.5.10 journal field">journal</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-volume" title= -"3.5.22 volume field">volume</a>, <a class="link" href= -"#bibtex-field-types-number" title= -"3.5.14 number field">number</a>, <a class="link" href= -"#bibtex-field-types-pages" title="3.5.16 pages field">pages</a>, -<a class="link" href="#bibtex-field-types-month" title= -"3.5.12 month field">month</a>, <a class="link" href= -"#bibtex-field-types-note" title="3.5.13 note field">note</a>, -<a class="link" href="#bibtex-field-types-key" title= -"3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.2 book entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-book" name= -"bibtex-entry-types-book"></a>3.3.2 book entry</h4> -</div> -</div> -</div> -<a id="idp11806640" class="indexterm" name="idp11806640"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a> -or <a class="link" href="#bibtex-field-types-editor" title= -"3.5.7 editor field">editor</a>, <a class="link" href= -"#bibtex-field-types-title" title="3.5.20 title field">title</a>, -<a class="link" href="#bibtex-field-types-publisher" title= -"3.5.17 publisher field">publisher</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-volume" title= -"3.5.22 volume field">volume</a>, <a class="link" href= -"#bibtex-field-types-series" title= -"3.5.19 series field">series</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-edition" title= -"3.5.6 edition field">edition</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.3 booklet entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-booklet" name= -"bibtex-entry-types-booklet"></a>3.3.3 booklet entry</h4> -</div> -</div> -</div> -<a id="idp11823008" class="indexterm" name="idp11823008"></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 class="link" href= -"#bibtex-field-types-title" title= -"3.5.20 title field">title</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-howpublished" title= -"3.5.8 howpublished field">howpublished</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-year" title= -"3.5.23 year field">year</a>, <a class="link" href= -"#bibtex-field-types-note" title="3.5.13 note field">note</a>, -<a class="link" href="#bibtex-field-types-key" title= -"3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.4 conference entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-conference" name= -"bibtex-entry-types-conference"></a>3.3.4 conference entry</h4> -</div> -</div> -</div> -<a id="idp11835488" class="indexterm" name="idp11835488"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-booktitle" title= -"3.5.4 booktitle field">booktitle</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-editor" title="3.5.7 editor field">editor</a>, -<a class="link" href="#bibtex-field-types-pages" title= -"3.5.16 pages field">pages</a>, <a class="link" href= -"#bibtex-field-types-organization" title= -"3.5.15 organization field">organization</a>, <a class="link" href= -"#bibtex-field-types-publisher" title= -"3.5.17 publisher field">publisher</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.5 inbook entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-inbook" name= -"bibtex-entry-types-inbook"></a>3.3.5 inbook entry</h4> -</div> -</div> -</div> -<a id="idp11851600" class="indexterm" name="idp11851600"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a> -or <a class="link" href="#bibtex-field-types-editor" title= -"3.5.7 editor field">editor</a>, <a class="link" href= -"#bibtex-field-types-title" title="3.5.20 title field">title</a>, -<a class="link" href="#bibtex-field-types-chapter" title= -"3.5.5 chapter field">chapter</a> and/or <a class="link" href= -"#bibtex-field-types-pages" title="3.5.16 pages field">pages</a>, -<a class="link" href="#bibtex-field-types-publisher" title= -"3.5.17 publisher field">publisher</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-volume" title= -"3.5.22 volume field">volume</a>, <a class="link" href= -"#bibtex-field-types-series" title= -"3.5.19 series field">series</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-edition" title= -"3.5.6 edition field">edition</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.6 incollection entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-incollection" name= -"bibtex-entry-types-incollection"></a>3.3.6 incollection entry</h4> -</div> -</div> -</div> -<a id="idp11869248" class="indexterm" name="idp11869248"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-booktitle" title= -"3.5.4 booktitle field">booktitle</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-editor" title="3.5.7 editor field">editor</a>, -<a class="link" href="#bibtex-field-types-pages" title= -"3.5.16 pages field">pages</a>, <a class="link" href= -"#bibtex-field-types-organization" title= -"3.5.15 organization field">organization</a>, <a class="link" href= -"#bibtex-field-types-publisher" title= -"3.5.17 publisher field">publisher</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.7 inproceedings entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-inproceedings" name= -"bibtex-entry-types-inproceedings"></a>3.3.7 inproceedings -entry</h4> -</div> -</div> -</div> -<a id="idp11885024" class="indexterm" name="idp11885024"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-booktitle" title= -"3.5.4 booktitle field">booktitle</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-editor" title="3.5.7 editor field">editor</a>, -<a class="link" href="#bibtex-field-types-pages" title= -"3.5.16 pages field">pages</a>, <a class="link" href= -"#bibtex-field-types-organization" title= -"3.5.15 organization field">organization</a>, <a class="link" href= -"#bibtex-field-types-publisher" title= -"3.5.17 publisher field">publisher</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.8 manual entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-manual" name= -"bibtex-entry-types-manual"></a>3.3.8 manual entry</h4> -</div> -</div> -</div> -<a id="idp11900864" class="indexterm" name="idp11900864"></a> -<p>Technical documentation.</p> -<p>Format:</p> -<pre class="programlisting"> -@MANUAL{citation_key, - required_fields [, optional_fields] } -</pre> -<p>Required fields: <a class="link" href= -"#bibtex-field-types-title" title= -"3.5.20 title field">title</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-organization" title= -"3.5.15 organization field">organization</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-edition" title= -"3.5.6 edition field">edition</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-year" title= -"3.5.23 year field">year</a>, <a class="link" href= -"#bibtex-field-types-note" title="3.5.13 note field">note</a>, -<a class="link" href="#bibtex-field-types-key" title= -"3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.9 mastersthesis entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-mastersthesis" name= -"bibtex-entry-types-mastersthesis"></a>3.3.9 mastersthesis -entry</h4> -</div> -</div> -</div> -<a id="idp11914032" class="indexterm" name="idp11914032"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-school" title= -"3.5.18 school field">school</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.10 misc entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-misc" name= -"bibtex-entry-types-misc"></a>3.3.10 misc entry</h4> -</div> -</div> -</div> -<a id="idp11926432" class="indexterm" name="idp11926432"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-howpublished" title= -"3.5.8 howpublished field">howpublished</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-year" title= -"3.5.23 year field">year</a>, <a class="link" href= -"#bibtex-field-types-note" title="3.5.13 note field">note</a>, -<a class="link" href="#bibtex-field-types-key" title= -"3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.11 phdthesis entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-phdthesis" name= -"bibtex-entry-types-phdthesis"></a>3.3.11 phdthesis entry</h4> -</div> -</div> -</div> -<a id="idp11938032" class="indexterm" name="idp11938032"></a> -<p>A PhD thesis.</p> -<p>Format:</p> -<pre class="programlisting"> -@PHDTHESIS{citation_key, - required_fields [, optional_fields] } -</pre> -<p>Required fields: <a class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-school" title= -"3.5.18 school field">school</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.12 proceedings entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-proceedings" name= -"bibtex-entry-types-proceedings"></a>3.3.12 proceedings entry</h4> -</div> -</div> -</div> -<a id="idp11950336" class="indexterm" name="idp11950336"></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 class="link" href= -"#bibtex-field-types-title" title="3.5.20 title field">title</a>, -<a class="link" href="#bibtex-field-types-year" title= -"3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-editor" title="3.5.7 editor field">editor</a>, -<a class="link" href="#bibtex-field-types-publisher" title= -"3.5.17 publisher field">publisher</a>, <a class="link" href= -"#bibtex-field-types-organization" title= -"3.5.15 organization field">organization</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.13 techreport entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-techreport" name= -"bibtex-entry-types-techreport"></a>3.3.13 techreport entry</h4> -</div> -</div> -</div> -<a id="idp11963568" class="indexterm" name="idp11963568"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-institution" title= -"3.5.9 institution field">institution</a>, <a class="link" href= -"#bibtex-field-types-year" title="3.5.23 year field">year</a></p> -<p>Optional fields: <a class="link" href="#bibtex-field-types-type" -title="3.5.21 type field">type</a>, <a class="link" href= -"#bibtex-field-types-number" title= -"3.5.14 number field">number</a>, <a class="link" href= -"#bibtex-field-types-address" title= -"3.5.1 address field">address</a>, <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-note" title= -"3.5.13 note field">note</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -<div class="section" title="3.3.14 unpublished entry"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-entry-types-unpublished" name= -"bibtex-entry-types-unpublished"></a>3.3.14 unpublished entry</h4> -</div> -</div> -</div> -<a id="idp11978032" class="indexterm" name="idp11978032"></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 class="link" href= -"#bibtex-field-types-author" title="3.5.3 author field">author</a>, -<a class="link" href="#bibtex-field-types-title" title= -"3.5.20 title field">title</a>, <a class="link" href= -"#bibtex-field-types-note" title="3.5.13 note field">note</a></p> -<p>Optional fields: <a class="link" href= -"#bibtex-field-types-month" title="3.5.12 month field">month</a>, -<a class="link" href="#bibtex-field-types-year" title= -"3.5.23 year field">year</a>, <a class="link" href= -"#bibtex-field-types-key" title="3.5.11 key field">key</a></p> -</div> -</div> -<div class="section" title="3.4 Field Text"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-field-text" name= -"bibtex-field-text"></a>3.4 Field Text</h3> -</div> -</div> -</div> -<a id="idp11988768" class="indexterm" name="idp11988768"></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" title="3.4.1 Names"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-text-names" name= -"bibtex-field-text-names"></a>3.4.1 Names</h4> -</div> -</div> -</div> -<a id="idp11993216" class="indexterm" name="idp11993216"></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" title="3.4.2 Titles"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-text-titles" name= -"bibtex-field-text-titles"></a>3.4.2 Titles</h4> -</div> -</div> -</div> -<a id="idp12016768" class="indexterm" name="idp12016768"></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" title="3.4.3 Abbreviations"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-text-abbr" name= -"bibtex-field-text-abbr"></a>3.4.3 Abbreviations</h4> -</div> -</div> -</div> -<a id="idp12022560" class="indexterm" name="idp12022560"></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><code class="literal">" # % ' ( ) , = { }</code></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 -<code class="literal">@STRING</code> command.</p> -</div> -</div> -<div class="section" title="3.5 Field Types"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-field-types" name= -"bibtex-field-types"></a>3.5 Field Types</h3> -</div> -</div> -</div> -<a id="idp12031968" class="indexterm" name="idp12031968"></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" title="3.5.1 address field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-address" name= -"bibtex-field-types-address"></a>3.5.1 address field</h4> -</div> -</div> -</div> -<a id="idp12036352" class="indexterm" name="idp12036352"></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" title="3.5.2 annote field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-annote" name= -"bibtex-field-types-annote"></a>3.5.2 annote field</h4> -</div> -</div> -</div> -<a id="idp12041232" class="indexterm" name="idp12041232"></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" title="3.5.3 author field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-author" name= -"bibtex-field-types-author"></a>3.5.3 author field</h4> -</div> -</div> -</div> -<a id="idp12046016" class="indexterm" name="idp12046016"></a> -<p>The name(s) of the author(s).</p> -<p>Format:</p> -<pre class="programlisting"> -AUTHOR = field_text -</pre></div> -<div class="section" title="3.5.4 booktitle field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-booktitle" name= -"bibtex-field-types-booktitle"></a>3.5.4 booktitle field</h4> -</div> -</div> -</div> -<a id="idp12050720" class="indexterm" name="idp12050720"></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" title="3.5.5 chapter field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-chapter" name= -"bibtex-field-types-chapter"></a>3.5.5 chapter field</h4> -</div> -</div> -</div> -<a id="idp12055440" class="indexterm" name="idp12055440"></a> -<p>A chapter number.</p> -<p>Format:</p> -<pre class="programlisting"> -CHAPTER = field_text -</pre></div> -<div class="section" title="3.5.6 edition field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-edition" name= -"bibtex-field-types-edition"></a>3.5.6 edition field</h4> -</div> -</div> -</div> -<a id="idp12060128" class="indexterm" name="idp12060128"></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" title="3.5.7 editor field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-editor" name= -"bibtex-field-types-editor"></a>3.5.7 editor field</h4> -</div> -</div> -</div> -<a id="idp12064848" class="indexterm" name="idp12064848"></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" title="3.5.8 howpublished field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-howpublished" name= -"bibtex-field-types-howpublished"></a>3.5.8 howpublished field</h4> -</div> -</div> -</div> -<a id="idp12069696" class="indexterm" name="idp12069696"></a> -<p>How something strange has been published.</p> -<p>Format:</p> -<pre class="programlisting"> -HOWPUBLISHED = field_text -</pre></div> -<div class="section" title="3.5.9 institution field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-institution" name= -"bibtex-field-types-institution"></a>3.5.9 institution field</h4> -</div> -</div> -</div> -<a id="idp12074432" class="indexterm" name="idp12074432"></a> -<p>The institution that published the work.</p> -<p>Format:</p> -<pre class="programlisting"> -INSTITUTION = field_text -</pre></div> -<div class="section" title="3.5.10 journal field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-journal" name= -"bibtex-field-types-journal"></a>3.5.10 journal field</h4> -</div> -</div> -</div> -<a id="idp12079168" class="indexterm" name="idp12079168"></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" title="3.5.11 key field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-key" name= -"bibtex-field-types-key"></a>3.5.11 key field</h4> -</div> -</div> -</div> -<a id="idp12083904" class="indexterm" name="idp12083904"></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 <code class= -"literal">\cite</code> command and at the beginning of the -entry.</p> -<p>Format:</p> -<pre class="programlisting"> -KEY = field_text -</pre></div> -<div class="section" title="3.5.12 month field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-month" name= -"bibtex-field-types-month"></a>3.5.12 month field</h4> -</div> -</div> -</div> -<a id="idp12089520" class="indexterm" name="idp12089520"></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" title="3.5.13 note field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-note" name= -"bibtex-field-types-note"></a>3.5.13 note field</h4> -</div> -</div> -</div> -<a id="idp12094272" class="indexterm" name="idp12094272"></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" title="3.5.14 number field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-number" name= -"bibtex-field-types-number"></a>3.5.14 number field</h4> -</div> -</div> -</div> -<a id="idp12099008" class="indexterm" name="idp12099008"></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" title="3.5.15 organization field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-organization" name= -"bibtex-field-types-organization"></a>3.5.15 organization -field</h4> -</div> -</div> -</div> -<a id="idp12103920" class="indexterm" name="idp12103920"></a> -<p>The organization sponsoring a conference.</p> -<p>Format:</p> -<pre class="programlisting"> -ORGANIZATION = field_text -</pre></div> -<div class="section" title="3.5.16 pages field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-pages" name= -"bibtex-field-types-pages"></a>3.5.16 pages field</h4> -</div> -</div> -</div> -<a id="idp12108656" class="indexterm" name="idp12108656"></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" title="3.5.17 publisher field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-publisher" name= -"bibtex-field-types-publisher"></a>3.5.17 publisher field</h4> -</div> -</div> -</div> -<a id="idp12113744" class="indexterm" name="idp12113744"></a> -<p>The publisher's name.</p> -<p>Format:</p> -<pre class="programlisting"> -PUBLISHER = field_text -</pre></div> -<div class="section" title="3.5.18 school field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-school" name= -"bibtex-field-types-school"></a>3.5.18 school field</h4> -</div> -</div> -</div> -<a id="idp12118448" class="indexterm" name="idp12118448"></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" title="3.5.19 series field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-series" name= -"bibtex-field-types-series"></a>3.5.19 series field</h4> -</div> -</div> -</div> -<a id="idp12123168" class="indexterm" name="idp12123168"></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" title="3.5.20 title field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-title" name= -"bibtex-field-types-title"></a>3.5.20 title field</h4> -</div> -</div> -</div> -<a id="idp12128048" class="indexterm" name="idp12128048"></a> -<p>The work's title.</p> -<p>Format:</p> -<pre class="programlisting"> -TITLE = field_text -</pre></div> -<div class="section" title="3.5.21 type field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-type" name= -"bibtex-field-types-type"></a>3.5.21 type field</h4> -</div> -</div> -</div> -<a id="idp12132704" class="indexterm" name="idp12132704"></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" title="3.5.22 volume field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-volume" name= -"bibtex-field-types-volume"></a>3.5.22 volume field</h4> -</div> -</div> -</div> -<a id="idp12137440" class="indexterm" name="idp12137440"></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" title="3.5.23 year field"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="bibtex-field-types-year" name= -"bibtex-field-types-year"></a>3.5.23 year field</h4> -</div> -</div> -</div> -<a id="idp12142128" class="indexterm" name="idp12142128"></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" title="4 bst files"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="bibtex-bst-files" -name="bibtex-bst-files"></a>4 bst files</h2> -</div> -</div> -</div> -<a id="idp12147168" class="indexterm" name="idp12147168"></a> -<p>Bibliography style files define the style of a bibliography -source list.</p> -<p>The standard bibliography style files are <a class="link" href= -"#bibtex-bst-plain" title="4.3 PLAIN.BST"><code class= -"filename">PLAIN</code></a>, <a class="link" href= -"#bibtex-bst-unsrt" title="4.5 UNSRT.BST"><code class= -"filename">UNSRT</code></a>, <a class="link" href= -"#bibtex-bst-alpha" title="4.2 ALPHA.BST"><code class= -"filename">ALPHA</code></a> and <a class="link" href= -"#bibtex-bst-abbr" title="4.1 ABBRV.BST"><code class= -"filename">ABBRV</code></a>.</p> -<p>If you want to make a bibliography style of your own, look at -<a class="link" href="#bibtex-bst-sample" title= -"4.4 SAMPLE.BST"><code class="filename">SAMPLE.BST</code></a>.</p> -<div class="section" title="4.1 ABBRV.BST"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-bst-abbr" name= -"bibtex-bst-abbr"></a>4.1 <code class= -"filename">ABBRV.BST</code></h3> -</div> -</div> -</div> -<a id="idp12159760" class="indexterm" name="idp12159760"></a> -<p>This style is the same as the style defined in <code class= -"filename">PLAIN.BST</code>, except that entries are more compact -because first names, month names and journal names are -abbreviated.</p> -</div> -<div class="section" title="4.2 ALPHA.BST"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-bst-alpha" name= -"bibtex-bst-alpha"></a>4.2 <code class= -"filename">ALPHA.BST</code></h3> -</div> -</div> -</div> -<a id="idp12164832" class="indexterm" name="idp12164832"></a> -<p>This style is the same as the style defined in <code class= -"filename">PLAIN.BST</code> except that entry labels like "Knu66", -formed from the author's name and the year of publication, are -used.</p> -</div> -<div class="section" title="4.3 PLAIN.BST"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-bst-plain" name= -"bibtex-bst-plain"></a>4.3 <code class= -"filename">PLAIN.BST</code></h3> -</div> -</div> -</div> -<a id="idp12169904" class="indexterm" name="idp12169904"></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" title="4.4 SAMPLE.BST"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-bst-sample" name= -"bibtex-bst-sample"></a>4.4 <code class= -"filename">SAMPLE.BST</code></h3> -</div> -</div> -</div> -<a id="idp12174320" class="indexterm" name="idp12174320"></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" title="4.5 UNSRT.BST"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="bibtex-bst-unsrt" name= -"bibtex-bst-unsrt"></a>4.5 <code class= -"filename">UNSRT.BST</code></h3> -</div> -</div> -</div> -<a id="idp12182448" class="indexterm" name="idp12182448"></a> -<p>This style is that same as <code class= -"filename">PLAIN.BST</code> except that entries appear in the order -of their first citation.</p> -</div> -</div> -</div> -<div xml:lang="en" class="chapter" title= -"Chapter 6. Make-Index" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="makeindex" name= -"makeindex"></a>Chapter 6. Make-Index</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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 -<code class="filename">-c</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-g">1.2 -<code class="filename">-g</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-i">1.3 -<code class="filename">-i</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-l">1.4 -<code class="filename">-l</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-q">1.5 -<code class="filename">-q</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-r">1.6 -<code class="filename">-r</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-s-sty">1.7 -<code class="filename">-s sty</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-o-ind">1.8 -<code class="filename">-o ind</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-t-log">1.9 -<code class="filename">-t log</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-p-no">1.10 -<code class="filename">-p no</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-L">1.11 -<code class="filename">-L</code></a></span></dt> -<dt><span class="section"><a href="#makeindex-option-T">1.12 -<code class="filename">-T</code></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="idp12187760" class="indexterm" name="idp12187760"></a> -<div class="note" title="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 <code class="filename">makeindex(1L)</code>.</p> -<p>Additional information was taken from <code class= -"filename">makeindex(1L)</code> 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 <code class= -"literal">.idx</code> 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 (<code class="literal">idx0</code>) is used to determine -other related input/output files. The default input file type is -<code class="literal">.idx</code>.</p> -<div class="section" title="1 Options"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="makeindex-options" -name="makeindex-options"></a>1 Options</h2> -</div> -</div> -</div> -<a id="idp12198800" class="indexterm" name="idp12198800"></a> -<p>Make-Index is a Unix program, and therefore has a Unix-style -command line. Instead of qualifiers delimited with a slash -(<code class="literal">/</code>), Make-Index options are delimited -with a hyphen (<code class="literal">-</code>).</p> -<div class="section" title="1.1 -c"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-c" name= -"makeindex-option-c"></a>1.1 <code class="filename">-c</code></h3> -</div> -</div> -</div> -<a id="idp12204800" class="indexterm" name="idp12204800"></a> -<p>Enable blank compression. By default every blank counts in the -index key. The <code class="literal">-c</code> option ignores -leading and trailing blanks and tabs and compresses intermediate -ones to a single space.</p> -</div> -<div class="section" title="1.2 -g"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-g" name= -"makeindex-option-g"></a>1.2 <code class="filename">-g</code></h3> -</div> -</div> -</div> -<a id="idp12209856" class="indexterm" name="idp12209856"></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 <code class= -"literal">'+'</code>). If the quote character is not redefined, -Make-Index will produce an error message and abort.</p> -</div> -<div class="section" title="1.3 -i"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-i" name= -"makeindex-option-i"></a>1.3 <code class="filename">-i</code></h3> -</div> -</div> -</div> -<a id="idp12215424" class="indexterm" name="idp12215424"></a> -<p>Use <code class="literal">stdin</code> as the input file. When -this option is specified and the <code class="literal">-o</code> is -not, output is written to <code class="literal">stdout</code>.</p> -</div> -<div class="section" title="1.4 -l"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-l" name= -"makeindex-option-l"></a>1.4 <code class="filename">-l</code></h3> -</div> -</div> -</div> -<a id="idp12221792" class="indexterm" name="idp12221792"></a> -<p>Use letter ordering. Default is word ordering (explained in the -<a class="link" href="#makeindex-ordering" title= -"4 Ordering">Ordering</a> section).</p> -</div> -<div class="section" title="1.5 -q"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-q" name= -"makeindex-option-q"></a>1.5 <code class="filename">-q</code></h3> -</div> -</div> -</div> -<a id="idp12227040" class="indexterm" name="idp12227040"></a> -<p>Quiet mode, send no messages to <code class= -"literal">stderr</code>. By default progress and error messages are -sent to <code class="literal">stderr</code> as well as the -transcript file. The <code class="literal">-q</code> option -disables the <code class="literal">stderr</code> messages.</p> -</div> -<div class="section" title="1.6 -r"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-r" name= -"makeindex-option-r"></a>1.6 <code class="filename">-r</code></h3> -</div> -</div> -</div> -<a id="idp12234176" class="indexterm" name="idp12234176"></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 <code class="literal">-r</code> option disables it, -making the explicit range operators the only way to create page -ranges (see the <a class="link" href="#makeindex-special-effects" -title="5 Special Effects">Special Effects</a> section below).</p> -</div> -<div class="section" title="1.7 -s sty"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-s-sty" name= -"makeindex-option-s-sty"></a>1.7 <code class="filename">-s -sty</code></h3> -</div> -</div> -</div> -<a id="idp12240224" class="indexterm" name="idp12240224"></a> -<p>Take <code class="literal">sty</code> 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" title="1.8 -o ind"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-o-ind" name= -"makeindex-option-o-ind"></a>1.8 <code class="filename">-o -ind</code></h3> -</div> -</div> -</div> -<a id="idp12245328" class="indexterm" name="idp12245328"></a> -<p>Take <code class="literal">ind</code> as the output index file. -By default the file name base of the first input file <code class= -"literal">idx0</code> concatenated with the extension <code class= -"literal">.ind</code> is used as the output file name.</p> -</div> -<div class="section" title="1.9 -t log"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-t-log" name= -"makeindex-option-t-log"></a>1.9 <code class="filename">-t -log</code></h3> -</div> -</div> -</div> -<a id="idp12251840" class="indexterm" name="idp12251840"></a> -<p>Take <code class="literal">log</code> as the transcript file. By -default the file name base of the first input file <code class= -"literal">idx0</code> concatenated with the extension <code class= -"literal">.ilg</code> is used as the transcript file name.</p> -</div> -<div class="section" title="1.10 -p no"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-p-no" name= -"makeindex-option-p-no"></a>1.10 <code class="filename">-p -no</code></h3> -</div> -</div> -</div> -<a id="idp12258352" class="indexterm" name="idp12258352"></a> -<p>Set the starting page number of the output index file to be -<code class="literal">no</code>. This is useful when the index file -is to be formatted separately. Other than pure numbers, three -special cases are allowed for no: <code class="literal">any</code>, -<code class="literal">odd</code>, and <code class= -"literal">even</code>. 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 -(<code class="literal">idx0</code>) with the extension <code class= -"literal">.log</code>. The last source page is obtained by -searching backward in the log file for the first instance of a -number included in <code class="literal">[...]</code>. 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" title="1.11 -L"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-L" name= -"makeindex-option-L"></a>1.11 <code class="filename">-L</code></h3> -</div> -</div> -</div> -<a id="idp12273584" class="indexterm" name="idp12273584"></a> -<p>Sort based on locale settings. String comparisons for sorting -are done using <span class= -"command"><strong>strcoll(3)</strong></span>, which compares -strings according to the current locale category <code class= -"literal">LC_COLLATE</code>.</p> -<p>Not available on all systems (depends on compile time -settings).</p> -</div> -<div class="section" title="1.12 -T"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-option-T" name= -"makeindex-option-T"></a>1.12 <code class="filename">-T</code></h3> -</div> -</div> -</div> -<a id="idp12279792" class="indexterm" name="idp12279792"></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" title="2 Style File"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="makeindex-style-file" -name="makeindex-style-file"></a>2 Style File</h2> -</div> -</div> -</div> -<a id="idp12283920" class="indexterm" name="idp12283920"></a> -<p>The style file format is very simple. It is a list of -<code class="literal"><specifier, attribute></code> 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 -`<code class="literal">%</code>' is a comment. The following is a -list of all the specifiers and their respective arguments where -<code class="literal"><string></code> is an arbitrary string -delimited by double quotes (<code class="literal">"..."</code>), -<code class="literal"><char></code> is a single letter -embraced by single quotes (<code class="literal">'...'</code>), and -<code class="literal"><number></code> is a nonnegative -integer. The maximum length of a <code class= -"literal"><string></code> 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 -<code class="envar">INDEXSTYLE</code>.</p> -<div class="section" title="2.1 Input Style Specifiers"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-style" name= -"makeindex-style"></a>2.1 Input Style Specifiers</h3> -</div> -</div> -</div> -<a id="idp12293760" class="indexterm" name="idp12293760"></a> -<div class="section" title="2.1.1 actual <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-actual-char" name= -"makeindex-actual-char"></a>2.1.1 actual <char></h4> -</div> -</div> -</div> -<a id="idp12296400" class="indexterm" name="idp12296400"></a> -<p>Default: <code class="literal">@</code></p> -<p>The symbol which indicates that the next entry is to appear in -the actual index file.</p> -</div> -<div class="section" title="2.1.2 arg_close <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-arg-close" name= -"makeindex-arg-close"></a>2.1.2 arg_close <char></h4> -</div> -</div> -</div> -<a id="idp12301072" class="indexterm" name="idp12301072"></a> -<p>Default: <code class="literal">}</code></p> -<p>This is the closing delimiter for the index entry argument.</p> -</div> -<div class="section" title="2.1.3 arg_open <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-style-arg-open" name= -"makeindex-style-arg-open"></a>2.1.3 arg_open <char></h4> -</div> -</div> -</div> -<a id="idp12305792" class="indexterm" name="idp12305792"></a> -<p>Default: <code class="literal">{</code></p> -<p>This is the opening delimiter for the index entry argument.</p> -</div> -<div class="section" title="2.1.4 encap <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-encap-char" name= -"makeindex-encap-char"></a>2.1.4 encap <char></h4> -</div> -</div> -</div> -<a id="idp12310336" class="indexterm" name="idp12310336"></a> -<p>Default: <code class="literal">|</code></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" title="2.1.5 escape <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-escape-char" name= -"makeindex-escape-char"></a>2.1.5 escape <char></h4> -</div> -</div> -</div> -<a id="idp12315072" class="indexterm" name="idp12315072"></a> -<p>Default: <code class="literal">\\</code></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" title="2.1.6 keyword <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-style-string" name= -"makeindex-style-string"></a>2.1.6 keyword <string></h4> -</div> -</div> -</div> -<a id="idp12320288" class="indexterm" name="idp12320288"></a> -<p>Default: <code class="literal">"\\indexentry"</code></p> -<p>This is the command which tells Make-Index that its argument is -an index entry.</p> -</div> -<div class="section" title="2.1.7 level <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-level-char" name= -"makeindex-level-char"></a>2.1.7 level <char></h4> -</div> -</div> -</div> -<a id="idp12325360" class="indexterm" name="idp12325360"></a> -<p>Default: <code class="literal">!</code></p> -<p>The delimiter which denotes a new level of subitem.</p> -</div> -<div class="section" title="2.1.8 quote <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-quote-char" name= -"makeindex-quote-char"></a>2.1.8 quote <char></h4> -</div> -</div> -</div> -<a id="idp12329888" class="indexterm" name="idp12329888"></a> -<p>Default: <code class="literal">"</code></p> -<p><code class="literal">quote</code> 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" title="2.1.9 range_close <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-range-close" name= -"makeindex-range-close"></a>2.1.9 range_close <char></h4> -</div> -</div> -</div> -<a id="idp12335216" class="indexterm" name="idp12335216"></a> -<p>Default: <code class="literal">)</code></p> -<p>The closing delimiter indicating the end of an explicit page -range.</p> -</div> -<div class="section" title="2.1.10 range_open <char>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-range-open" name= -"makeindex-range-open"></a>2.1.10 range_open <char></h4> -</div> -</div> -</div> -<a id="idp12339680" class="indexterm" name="idp12339680"></a> -<p>Default: <code class="literal">(</code></p> -<p>The opening delimiter indicating the beginning of an explicit -page range.</p> -</div> -</div> -<div class="section" title="2.2 Output Style Specifiers"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="makeindex-output-style-specs" name= -"makeindex-output-style-specs"></a>2.2 Output Style Specifiers</h3> -</div> -</div> -</div> -<a id="idp12344320" class="indexterm" name="idp12344320"></a> -<div class="section" title="2.2.1 page_compositor <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-page-compositor" name= -"makeindex-page-compositor"></a>2.2.1 page_compositor -<string></h4> -</div> -</div> -</div> -<a id="idp12347008" class="indexterm" name="idp12347008"></a> -<p>Default: <code class="literal">"-"</code></p> -<p>This specifier is used to separate a range of page numbers.</p> -<p>Officially undocumented!</p> -</div> -<div class="section" title="2.2.2 preamble <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-preamble-string" name= -"makeindex-output-preamble-string"></a>2.2.2 preamble -<string></h4> -</div> -</div> -</div> -<a id="idp12352112" class="indexterm" name="idp12352112"></a> -<p>Default: <code class="literal">"\\begin{theindex}\n"</code></p> -<p>The preamble of actual index file.</p> -</div> -<div class="section" title="2.2.3 postamble <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-postamble-string" name= -"makeindex-output-postamble-string"></a>2.2.3 postamble -<string></h4> -</div> -</div> -</div> -<a id="idp12356736" class="indexterm" name="idp12356736"></a> -<p>Default: <code class= -"literal">"\n\n\\end{theindex}\n"</code></p> -<p>The postamble of actual index file.</p> -</div> -<div class="section" title="2.2.4 setpage_prefix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-setpage-prefix" name= -"makeindex-output-setpage-prefix"></a>2.2.4 setpage_prefix -<string></h4> -</div> -</div> -</div> -<a id="idp12361376" class="indexterm" name="idp12361376"></a> -<p>Default: <code class="literal">"\n -\\setcounter{page}{"</code></p> -<p>The prefix of the command which sets the starting page -number.</p> -</div> -<div class="section" title="2.2.5 setpage_suffix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-setpage-suffix" name= -"makeindex-output-setpage-suffix"></a>2.2.5 setpage_suffix -<string></h4> -</div> -</div> -</div> -<a id="idp12366064" class="indexterm" name="idp12366064"></a> -<p>Default: <code class="literal">"}\n"</code></p> -<p>The suffix of the command which sets the starting page -number.</p> -</div> -<div class="section" title="2.2.6 group_skip <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-group-skip" name= -"makeindex-output-group-skip"></a>2.2.6 group_skip -<string></h4> -</div> -</div> -</div> -<a id="idp12370736" class="indexterm" name="idp12370736"></a> -<p>Default: <code class="literal">"\n\n \\indexspace\n"</code></p> -<p>The vertical space to be inserted before a new group begins.</p> -</div> -<div class="section" title="2.2.7 heading_prefix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-heading-prefix-string" -name="makeindex-output-heading-prefix-string"></a>2.2.7 -heading_prefix <string></h4> -</div> -</div> -</div> -<a id="idp12375408" class="indexterm" name="idp12375408"></a> -<p>Default: <code class="literal">""</code></p> -<p>The header prefix to be inserted before a new letter begins.</p> -</div> -<div class="section" title="2.2.8 heading_suffix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-heading-suffix-string" -name="makeindex-output-heading-suffix-string"></a>2.2.8 -heading_suffix <string></h4> -</div> -</div> -</div> -<a id="idp12380048" class="indexterm" name="idp12380048"></a> -<p>Default: <code class="literal">""</code></p> -<p>The header suffix to be inserted before a new letter begins.</p> -</div> -<div class="section" title="2.2.9 headings_flag <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-headings-flag" name= -"makeindex-output-headings-flag"></a>2.2.9 headings_flag -<string></h4> -</div> -</div> -</div> -<a id="idp12384624" class="indexterm" name="idp12384624"></a> -<p>Default: <code class="literal">0</code></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" title= -"2.2.10 symhead_positive <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-symhead-positive" name= -"makeindex-output-symhead-positive"></a>2.2.10 symhead_positive -<string></h4> -</div> -</div> -</div> -<a id="idp12389376" class="indexterm" name="idp12389376"></a> -<p>Default: <code class="literal">"Symbols"</code></p> -<p>Heading for symbols to be inserted if <code class= -"literal">headings_flag</code> is positive.</p> -</div> -<div class="section" title= -"2.2.11 symhead_negative <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-symhead-negative" name= -"makeindex-output-symhead-negative"></a>2.2.11 symhead_negative -<string></h4> -</div> -</div> -</div> -<a id="idp12394752" class="indexterm" name="idp12394752"></a> -<p>Default: <code class="literal">"symbols"</code></p> -<p>Heading for symbols to be inserted if <code class= -"literal">headings_flag</code> is negative.</p> -</div> -<div class="section" title= -"2.2.12 numhead_positive <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-numhead-positive" name= -"makeindex-output-numhead-positive"></a>2.2.12 numhead_positive -<string></h4> -</div> -</div> -</div> -<a id="idp12400128" class="indexterm" name="idp12400128"></a> -<p>Default: <code class="literal">"Numbers"</code></p> -<p>Heading for numbers to be inserted if <code class= -"literal">headings_flag</code> is positive.</p> -</div> -<div class="section" title= -"2.2.13 numhead_negative <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-numhead-negative" name= -"makeindex-output-numhead-negative"></a>2.2.13 numhead_negative -<string></h4> -</div> -</div> -</div> -<a id="idp12405504" class="indexterm" name="idp12405504"></a> -<p>Default: <code class="literal">"numbers"</code></p> -<p>Heading for numbers to be inserted if <code class= -"literal">headings_flag</code> is negative.</p> -</div> -<div class="section" title="2.2.14 item_0 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-0" name= -"makeindex-output-item-0"></a>2.2.14 item_0 <string></h4> -</div> -</div> -</div> -<a id="idp12410784" class="indexterm" name="idp12410784"></a> -<p>Default: <code class="literal">"\n \\item "</code></p> -<p>The command to be inserted between two primary (level 0) -items.</p> -</div> -<div class="section" title="2.2.15 item_1 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-1" name= -"makeindex-output-item-1"></a>2.2.15 item_1 <string></h4> -</div> -</div> -</div> -<a id="idp12415360" class="indexterm" name="idp12415360"></a> -<p>Default: <code class="literal">"\n \\subitem "</code></p> -<p>The command to be inserted between two secondary (level 1) -items.</p> -</div> -<div class="section" title="2.2.16 item_2 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-2" name= -"makeindex-output-item-2"></a>2.2.16 item_2 <string></h4> -</div> -</div> -</div> -<a id="idp12419984" class="indexterm" name="idp12419984"></a> -<p>Default: <code class="literal">"\n \\subsubitem "</code></p> -<p>The command to be inserted between two level 2 items.</p> -</div> -<div class="section" title="2.2.17 item_01 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-01" name= -"makeindex-output-item-01"></a>2.2.17 item_01 <string></h4> -</div> -</div> -</div> -<a id="idp12424672" class="indexterm" name="idp12424672"></a> -<p>Default: <code class="literal">"\n \\subitem "</code></p> -<p>The command to be inserted between a level 0 item and a level 1 -item.</p> -</div> -<div class="section" title="2.2.18 item_x1 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-x1" name= -"makeindex-output-item-x1"></a>2.2.18 item_x1 <string></h4> -</div> -</div> -</div> -<a id="idp12429296" class="indexterm" name="idp12429296"></a> -<p>Default: <code class="literal">"\n \\subitem "</code></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" title="2.2.19 item_12 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-12" name= -"makeindex-output-item-12"></a>2.2.19 item_12 <string></h4> -</div> -</div> -</div> -<a id="idp12434080" class="indexterm" name="idp12434080"></a> -<p>Default: <code class="literal">"\n \\subsubitem "</code></p> -<p>The command to be inserted between a level 1 item and a level 2 -item.</p> -</div> -<div class="section" title="2.2.20 item_x2 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-item-x2" name= -"makeindex-output-item-x2"></a>2.2.20 item_x2 <string></h4> -</div> -</div> -</div> -<a id="idp12438704" class="indexterm" name="idp12438704"></a> -<p>Default: <code class="literal">"\n \\subsubitem "</code></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" title="2.2.21 delim_0 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-delim-0" name= -"makeindex-output-delim-0"></a>2.2.21 delim_0 <string></h4> -</div> -</div> -</div> -<a id="idp12443488" class="indexterm" name="idp12443488"></a> -<p>Default: <code class="literal">", "</code></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" title="2.2.22 delim_1 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-delim-1" name= -"makeindex-output-delim-1"></a>2.2.22 delim_1 <string></h4> -</div> -</div> -</div> -<a id="idp12448208" class="indexterm" name="idp12448208"></a> -<p>Default: <code class="literal">", "</code></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" title="2.2.23 delim_2 <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-delim-2" name= -"makeindex-output-delim-2"></a>2.2.23 delim_2 <string></h4> -</div> -</div> -</div> -<a id="idp12452928" class="indexterm" name="idp12452928"></a> -<p>Default: <code class="literal">", "</code></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" title="2.2.24 delim_n <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-delim-n" name= -"makeindex-output-delim-n"></a>2.2.24 delim_n <string></h4> -</div> -</div> -</div> -<a id="idp12457648" class="indexterm" name="idp12457648"></a> -<p>Default: <code class="literal">", "</code></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" title="2.2.25 delim_r <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-delim-r" name= -"makeindex-output-delim-r"></a>2.2.25 delim_r <string></h4> -</div> -</div> -</div> -<a id="idp12462480" class="indexterm" name="idp12462480"></a> -<p>Default: <code class="literal">"--"</code></p> -<p>The delimiter to be inserted between the starting and ending -page numbers of a range.</p> -</div> -<div class="section" title="2.2.26 delim_t <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-delim-t" name= -"makeindex-output-delim-t"></a>2.2.26 delim_t <string></h4> -</div> -</div> -</div> -<a id="idp12467104" class="indexterm" name="idp12467104"></a> -<p>Default: <code class="literal">""</code></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" title="2.2.27 encap_prefix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-encap-prefix" name= -"makeindex-output-encap-prefix"></a>2.2.27 encap_prefix -<string></h4> -</div> -</div> -</div> -<a id="idp12471824" class="indexterm" name="idp12471824"></a> -<p>Default: <code class="literal">"\\"</code></p> -<p>The prefix for the command which encapsulates the page -number.</p> -</div> -<div class="section" title="2.2.28 encap_infix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-encap-infox" name= -"makeindex-output-encap-infox"></a>2.2.28 encap_infix -<string></h4> -</div> -</div> -</div> -<a id="idp12476448" class="indexterm" name="idp12476448"></a> -<p>Default: <code class="literal">"{"</code></p> -<p>The prefix for the command which encapsulates the page -number.</p> -</div> -<div class="section" title="2.2.29 encap_suffix <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-encap-suffix" name= -"makeindex-output-encap-suffix"></a>2.2.29 encap_suffix -<string></h4> -</div> -</div> -</div> -<a id="idp12481040" class="indexterm" name="idp12481040"></a> -<p>Default: <code class="literal">"}"</code></p> -<p>The suffix for the command which encapsulates the page -number.</p> -</div> -<div class="section" title="2.2.30 line_max <number>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-line-max" name= -"makeindex-output-line-max"></a>2.2.30 line_max <number></h4> -</div> -</div> -</div> -<a id="idp12485664" class="indexterm" name="idp12485664"></a> -<p>Default: <code class="literal">72</code></p> -<p>The maximum length of a line in the output beyond which a line -wraps around.</p> -</div> -<div class="section" title="2.2.31 indent_space <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-indent-space" name= -"makeindex-output-indent-space"></a>2.2.31 indent_space -<string></h4> -</div> -</div> -</div> -<a id="idp12490368" class="indexterm" name="idp12490368"></a> -<p>Default: <code class="literal">"\t\t"</code></p> -<p>The space to be inserted in front of a wrapped line. Default is -two tabs.</p> -</div> -<div class="section" title="2.2.32 indent_length <number>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-indent-length" name= -"makeindex-output-indent-length"></a>2.2.32 indent_length -<number></h4> -</div> -</div> -</div> -<a id="idp12495056" class="indexterm" name="idp12495056"></a> -<p>Default: <code class="literal">16</code></p> -<p>The length of indent_space. In the default case this is 16 (for -2 tabs).</p> -</div> -<div class="section" title="2.2.33 suffix_2p <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-suffix-2p" name= -"makeindex-output-suffix-2p"></a>2.2.33 suffix_2p -<string></h4> -</div> -</div> -</div> -<a id="idp12499744" class="indexterm" name="idp12499744"></a> -<p>Default: <code class="literal">""</code></p> -<p>Delimiter to replace the range delimiter and the second page -number of a two page list. When present, it overrides <code class= -"literal">delim_r</code>.</p> -</div> -<div class="section" title="2.2.34 suffix_3p <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-suffix-3p" name= -"makeindex-output-suffix-3p"></a>2.2.34 suffix_3p -<string></h4> -</div> -</div> -</div> -<a id="idp12505072" class="indexterm" name="idp12505072"></a> -<p>Default: <code class="literal">""</code></p> -<p>Delimiter to replace the range delimiter and the second page -number of a three page list. When present, it overrides -<code class="literal">delim_r</code> and <code class= -"literal">suffix_mp</code>.</p> -</div> -<div class="section" title="2.2.35 suffix_mp <string>"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="makeindex-output-suffix-mp" name= -"makeindex-output-suffix-mp"></a>2.2.35 suffix_mp -<string></h4> -</div> -</div> -</div> -<a id="idp12511120" class="indexterm" name="idp12511120"></a> -<p>Default: <code class="literal">""</code></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 <code class="literal">delim_r</code>.</p> -</div> -</div> -</div> -<div class="section" title="3 Example"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="makeindex-example" -name="makeindex-example"></a>3 Example</h2> -</div> -</div> -</div> -<a id="idp12516768" class="indexterm" name="idp12516768"></a> -<p>The following example shows a style file called <code class= -"literal">book.isty</code> 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 <code class= -"literal">foo.idx</code> as the raw index file, the following -command line produces an index in file <code class= -"literal">foo-.ind</code>.</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 <code class= -"literal">foo.dvi</code>) because if the index is in file -<code class="literal">foo.ind</code>, its output will also be in -<code class="literal">foo.dvi</code> as a result of separate -formatting using . In the example the index is in <code class= -"literal">foo-.ind</code>, its output will be in <code class= -"literal">foo-.dvi</code> and thus introduces no confusion.</p> -</div> -<div class="section" title="4 Ordering"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="makeindex-ordering" -name="makeindex-ordering"></a>4 Ordering</h2> -</div> -</div> -</div> -<a id="idp12529104" class="indexterm" name="idp12529104"></a> -<p>By default <code class="literal">makeindex</code> assumes word -ordering. The <code class="literal">-l</code> 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" title="5 Special Effects"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id= -"makeindex-special-effects" name="makeindex-special-effects"></a>5 -Special Effects</h2> -</div> -</div> -</div> -<a id="idp12549376" class="indexterm" name="idp12549376"></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 (<code class="literal">!</code>) 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 (<code class="literal">@</code>) 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 -<code class="literal">@</code> 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 (<code class="literal">|</code>) -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 <code class="literal">\bold{n}</code> will expand to -<code class="literal">{\bf n}</code>. 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 <code class="literal">encap_prefix</code>, -<code class="literal">encap_infix</code>, and <code class= -"literal">encap_suffix</code> 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 <code class="literal">encap</code> -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 <code class= -"literal">range_open</code> (<code class="literal">|(</code>) and -with <code class="literal">range_close</code> (<code class= -"literal">|)</code>) 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 (<code class="literal">"</code>). -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 (<code class="literal">\</code>), 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 <code class="literal">u</code> -to the family of processors.</p> -</div> -</div> -<div xml:lang="en" class="chapter" title= -"Chapter 7. xindy" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="xindy" name= -"xindy"></a>Chapter 7. xindy</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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="idp12589264" class="indexterm" name="idp12589264"></a> -<div class="note" title="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 (<code class= -"filename">Doc/manual*.html</code>).</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" title="1 Command List"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="xindy-command-list" -name="xindy-command-list"></a>1 Command List</h2> -</div> -</div> -</div> -<a id="idp12596352" class="indexterm" name="idp12596352"></a> -<p>Here is the complete list of xindy's commands that may be used -in the index style. The symbol <code class="literal">name</code> -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 <code class="literal">[</code> and <code class= -"literal">]</code> denote optional parts of the syntax and -<code class="literal">{</code> and <code class="literal">}</code> -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" title="1.1 Processing Commands"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="xindy-command-list-processing" name= -"xindy-command-list-processing"></a>1.1 Processing Commands</h3> -</div> -</div> -</div> -<a id="idp12604208" class="indexterm" name="idp12604208"></a> -<div class="section" title="1.1.1 define-alphabet"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-alphabet" name= -"xindy-command-list-processing-define-alphabet"></a>1.1.1 -<code class="literal">define-alphabet</code></h4> -</div> -</div> -</div> -<a id="idp12607328" class="indexterm" name="idp12607328"></a> -<pre class="programlisting"> -(define-alphabet name string-list) -</pre> -<p>Defines <code class="literal">name</code> to be the alphabet -consisting of all elements of the <code class= -"literal">string-list</code>. 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: <code class= -"literal">succ("An")="Example"</code> and <code class= -"literal">succ("Example")="Alphabet"</code>. The built-in alphabet -<code class="literal">digits</code> 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" title="1.1.2 define-attributes"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-attributes" name= -"xindy-command-list-processing-define-attributes"></a>1.1.2 -<code class="literal">define-attributes</code></h4> -</div> -</div> -</div> -<a id="idp12617264" class="indexterm" name="idp12617264"></a> -<pre class="programlisting"> -(define-attributes attribute-list) -</pre> -<p>Defines all attributes the raw index may contain. Parameter -<code class="literal">attribute-list</code> is a list of list of -strings. The nesting level must not be more than 2. So <code class= -"literal">(..(..)..)</code> is allowed, whereas <code class= -"literal">(..(..(..)..)..)</code> 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 <code class="literal">("definition")</code> and -<code class="literal">( ("definition") )</code> 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><code class="literal">("definition" "usage")</code> defines two -attribute groups. The first one contains all references with the -attribute <code class="literal">definition</code> and the second -one all with the attribute <code class="literal">usage</code>.</p> -<p><code class="literal">(("definition" "important") -"usage")</code> defines two attribute groups. The first one -contains all references with the attributes <code class= -"literal">definition</code> or <code class= -"literal">important</code> and the second one all with the -attribute <code class="literal">usage</code>. In the attribute -group <code class="literal">("definition" "important")</code> the -attribute <code class="literal">definition</code> overrides -<code class="literal">important</code>.</p> -</div> -<div class="section" title="1.1.3 define-crossref-class"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-crossref-class" name= -"xindy-command-list-processing-define-crossref-class"></a>1.1.3 -<code class="literal">define-crossref-class</code></h4> -</div> -</div> -</div> -<a id="idp12635344" class="indexterm" name="idp12635344"></a> -<pre class="programlisting"> -(define-crossref-class name [:unverified]) -</pre> -<p>Defines <code class="literal">name</code> 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 <code class= -"literal">:unverified</code> can be used to suppress this -behaviour.</p> -</div> -<div class="section" title="1.1.4 define-letter-group"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-letter-group" name= -"xindy-command-list-processing-define-letter-group"></a>1.1.4 -<code class="literal">define-letter-group</code></h4> -</div> -</div> -</div> -<a id="idp12642592" class="indexterm" name="idp12642592"></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 <code class= -"literal">name</code>, 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 <code class= -"literal">name</code>. 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 <code class="literal">"a"</code>.</p> -<pre class="programlisting"> -(define-letter-group "c" :after "a") -</pre> -<p>defines a letter group containing all index entries beginning -with the string <code class="literal">"c"</code>. The letter group -appears behind the letter group <code class= -"literal">"a"</code></p> -<pre class="programlisting"> -(define-letter-group "b" :after "a" :before "c") -</pre> -<p>inserts letter group <code class="literal">"b"</code> between -letter group <code class="literal">"a"</code> and <code class= -"literal">"c"</code>. This allows incremental definition of letter -groups by extending already defined ones.</p> -<p>The arguments <code class="literal">:after</code> and -<code class="literal">:before</code> 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 <code class="literal">define-letter-groups</code> -(with an `s' at the end) is simply an abbreviation for a sequence -of <code class="literal">define-letter-group</code> 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 <code class= -"literal">markup-letter-group-list</code> and <code class= -"literal">markup-letter-group</code> for further information.</p> -</div> -<div class="section" title="1.1.5 define-location-class"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-location-class" name= -"xindy-command-list-processing-define-location-class"></a>1.1.5 -<code class="literal">define-location-class</code></h4> -</div> -</div> -</div> -<a id="idp12667920" class="indexterm" name="idp12667920"></a> -<pre class="programlisting"> -(define-location-class name layer-list - [:min-range-length num] - [:hierdepth depth] - [:var]) -</pre> -<p>Defines <code class="literal">name</code> 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 <code class= -"literal">:sep</code>. If the keyword <code class= -"literal">:min-range-length</code> is specified we define the -<span class="emphasis"><em>minimum range length</em></span> to be -used when building ranges. The argument <code class= -"literal">num</code> must be a positive integer number or the -keyword <code class="literal">none</code> in which case the -building of ranges is disallowed. If the switch <code class= -"literal">:var</code> 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 -<code class="literal">:var</code> and <code class= -"literal">:min-range-length</code> must not be used together. The -keyword argument <code class="literal">:hierdepth</code> can be -used to declare that the location references have to be tagged in a -hierarchical form. Its argument <code class="literal">depth</code> -must be an integer number indicating the number of layers the -hierarchy does contain. See command <code class= -"literal">markup-locref-list</code> 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 <code class= -"literal">page-numbers</code> consisting of one layer which is the -alphabet <code class="literal">arabic-numbers</code>. 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 <code class="literal">0, 1, ... -2313</code>, 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 -<code class="literal">1, 1.1, 1.2, 2, 2.4.5</code>, but none of -<code class="literal">2-3</code> (wrong separator), <code class= -"literal">1.2.3.4</code> (more than 3 layers), <code class= -"literal">2.3.iv</code> (roman number instead of arabic one).</p> -</div> -<div class="section" title="1.1.6 define-location-class-order"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-location-class-order" name= -"xindy-command-list-processing-define-location-class-order"></a>1.1.6 -<code class="literal">define-location-class-order</code></h4> -</div> -</div> -</div> -<a id="idp12689984" class="indexterm" name="idp12689984"></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 <code class="literal">list</code> 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" title="1.1.7 define-rule-set"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-rule-set" name= -"xindy-command-list-processing-define-rule-set"></a>1.1.7 -<code class="literal">define-rule-set</code></h4> -</div> -</div> -</div> -<a id="idp12696928" class="indexterm" name="idp12696928"></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 <code class="literal">sort-rule</code>. They do not add -new functionality that is not already present with <code class= -"literal">sort-rule</code>.</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 -<code class="literal">isolatin1-tolower</code> that inherits -definitions from rule set <code class= -"literal">latin-tolower</code>, overriding or adding the sort rules -in the list of <code class="literal">:rules</code>.</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 <code class= -"literal">use-rule-set</code>. For further descriptions on the -sorting model refer to the command <code class= -"literal">sort-rule</code>.</p> -</div> -<div class="section" title="1.1.8 define-sort-rule-orientations"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-define-sort-rule-orientations" name= -"xindy-command-list-processing-define-sort-rule-orientations"></a>1.1.8 -<code class="literal">define-sort-rule-orientations</code></h4> -</div> -</div> -</div> -<a id="idp12710496" class="indexterm" name="idp12710496"></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 <code class= -"literal">forward</code> and <code class="literal">backward</code>. -This command must precede all <code class= -"literal">sort-rule</code> 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 <code class="literal">sort-rule</code>.</p> -</div> -<div class="section" title="1.1.9 merge-rule"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="xindy-command-list-processing-merge-rule" -name="xindy-command-list-processing-merge-rule"></a>1.1.9 -<code class="literal">merge-rule</code></h4> -</div> -</div> -</div> -<a id="idp12719504" class="indexterm" name="idp12719504"></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 <code class="literal">pattern</code> 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 <code class="literal">:bregexp</code> to force -the interpretation of the pattern as a BRE, or <code class= -"literal">:eregexp</code> to interpret it as an ERE. If you want -xindy to interpret the pattern literally, use the switch -<code class="literal">:string</code>. 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 <code class="literal">replacement</code> must be a -string possibly containing the special characters <code class= -"literal">&</code> (substitutes for the complete match) and -<code class="literal">\1 ,..., \9</code> (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 <code class= -"literal">`A'</code> 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 <code class="literal">`\"A '</code> is -treated as an <code class="literal">`A'</code> afterwards.</p> -<p>The following sequences have a special meaning:</p> -<div class="variablelist"> -<dl> -<dt><span class="term"><code class="literal">` ~n -'</code></span></dt> -<dd> -<p>End of line symbol (<span class= -"emphasis"><em>linefeed</em></span>).</p> -</dd> -<dt><span class="term"><code class="literal">` ~b -'</code></span></dt> -<dd> -<p>The ISO-Latin character with the lowest ordinal number.</p> -</dd> -<dt><span class="term"><code class="literal">` ~e -'</code></span></dt> -<dd> -<p>The ISO-Latin character with the highest ordinal number.</p> -</dd> -<dt><span class="term"><code class="literal">` ~~ -'</code></span></dt> -<dd> -<p>The tilde character.</p> -</dd> -<dt><span class="term"><code class="literal">` ~" -'</code></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 <code class= -"literal">` ~b '</code> and <code class="literal">` ~e '</code> -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. <code class="literal">` m~e -'</code> is lexicographically placed between <code class= -"literal">`m'</code> and <code class="literal">`n'</code>.</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 <code class= -"literal">`alpha'</code> is checked before <code class= -"literal">`.*'</code>, but <code class="literal">`auto'</code> and -<code class="literal">`a.*'</code> 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 <code class= -"literal">:again</code> 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 -<code class="literal">`$ '</code> symbols from the input.</p> -<p>See also command <code class="literal">sort-rule</code>.</p> -</div> -<div class="section" title="1.1.10 merge-to"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="xindy-command-list-processing-merge-to" -name="xindy-command-list-processing-merge-to"></a>1.1.10 -<code class="literal">merge-to</code></h4> -</div> -</div> -</div> -<a id="idp12764048" class="indexterm" name="idp12764048"></a> -<pre class="programlisting"> -(merge-to attr-from attr-to [:drop]) -</pre> -<p>A merge rule says that the attribute <code class= -"literal">attr-from</code> can be used to build ranges in -<code class="literal">attr-to</code>. Both attributes must name -valid attribute names. The switch <code class= -"literal">:drop</code> indicates, that the original location -reference with attribute <code class="literal">attr-from</code> has -to be dropped (removed), if a successful range was built with -location references in attribute <code class= -"literal">attr-to</code>. A detailed description is given in the -section about processing phases.</p> -</div> -<div class="section" title="1.1.11 require"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="xindy-command-list-processing-require" -name="xindy-command-list-processing-require"></a>1.1.11 -<code class="literal">require</code></h4> -</div> -</div> -</div> -<a id="idp12772832" class="indexterm" name="idp12772832"></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 <code class="literal">filename</code> 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 <code class= -"literal">require</code> command is simply ignored and processing -continues without including this file twice. See also command -searchpath.</p> -</div> -<div class="section" title="1.1.12 searchpath"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="xindy-command-list-processing-searchpath" -name="xindy-command-list-processing-searchpath"></a>1.1.12 -<code class="literal">searchpath</code></h4> -</div> -</div> -</div> -<a id="idp12780560" class="indexterm" name="idp12780560"></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 <code class= -"literal">path-string</code> 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 -<code class="literal">path-list</code> must be a list of strings -and/or the keyword(s) <code class="literal">:default</code> and -<code class="literal">:last</code>. The keyword <code class= -"literal">:default</code> signifies that the default pathnames are -to be inserted at the specified position in the list. The keyword -<code class="literal">:last</code> 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" title="1.1.13 sort-rule"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="xindy-command-list-processing-sort-rule" -name="xindy-command-list-processing-sort-rule"></a>1.1.13 -<code class="literal">sort-rule</code></h4> -</div> -</div> -</div> -<a id="idp12792192" class="indexterm" name="idp12792192"></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 <code class="literal">:run</code> 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 -(<code class="literal">new-sort-rules</code>) that comes with this -distribution.</p> -<p>See command <code class="literal">merge-rule</code> for more -information about keyword rules.</p> -</div> -<div class="section" title="1.1.14 use-rule-set"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id= -"xindy-command-list-processing-use-rule-set" name= -"xindy-command-list-processing-use-rule-set"></a>1.1.14 -<code class="literal">use-rule-set</code></h4> -</div> -</div> -</div> -<a id="idp12801904" class="indexterm" name="idp12801904"></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 <code class="literal">phase</code>. The order of the -rule sets given with argument <code class= -"literal">:rule-set</code> 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 -<code class="literal">din5007</code> and <code class= -"literal">isolatin1-tolower</code> 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 <code class= -"literal">define-rule-set</code>.</p> -</div> -</div> -<div class="section" title="1.2 Markup Commands"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="xindy-command-list-markup" name= -"xindy-command-list-markup"></a>1.2 Markup Commands</h3> -</div> -</div> -</div> -<a id="idp12812464" class="indexterm" name="idp12812464"></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 <code class= -"literal">:open</code> and <code class="literal">:close</code>, -whereas the second group additionally supports the keyword argument -<code class="literal">:sep</code>. If one of these keyword -arguments is missing, the default markup tag is always the empty -tag. The <code class="literal">:open</code> tag is always printed -before the object itself and the <code class= -"literal">:close</code> tag is always printed after the object has -been printed. If a list is printed the <code class= -"literal">:sep</code> 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 <code class= -"literal">`-list'</code> 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 <code class="literal">markup-trace</code>.</p> -<p>Here follows the list of markup commands in alphabetical order -with some of the commands grouped together.</p> -<div class="section" title="1.2.1 markup-attribute-group-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-attribute-group-list" name= -"markup-attribute-group-list"></a>1.2.1 <code class= -"literal">markup-attribute-group-list</code></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 <code class= -"literal">markup-attribute-group-list</code>.</p> -<p>To allow different markup for different attribute groups the -command <code class="literal">markup-attribute-group</code> can be -specialized on the group number with the keyword argument -<code class="literal">:group</code> which must be an integer -number. E.g., given are the groups <code class= -"literal">("definition" "theorem")</code> and <code class= -"literal">("default")</code> 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" title="1.2.2 markup-crossref-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-crossref-list" name= -"markup-crossref-list"></a>1.2.2 <code class= -"literal">markup-crossref-list</code></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 -<code class="literal">(markup-locclass-list :sep)</code>-parameter. -A list of cross references can be tagged with the <code class= -"literal">command markup-crossref-list</code> that specializes on -the <code class="literal">:class</code> 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 <code class="literal">command -markup-crossref-layer-list</code> 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 <code class= -"literal">see</code> 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 <code class="literal">... see -house; garden,winter; greenhouse</code></p> -</div> -<div class="section" title="1.2.3 markup-index"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-index" name= -"markup-index"></a>1.2.3 <code class= -"literal">markup-index</code></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 -<code class="literal">:open</code> and <code class= -"literal">:close</code> 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 <code class="literal">:open</code> string is -printed before the rest of the index and the <code class= -"literal">:close</code> 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 -<code class="literal">:flat</code>, to generate a tree with the -<code class="literal">:tree</code> switch or any kind of mixture -between both by specifying the depth up to which trees shall be -built with the parameter <code class="literal">:hierdepth</code>. -Its argument depth is the number of layers that can be formed into -a tree. Therefore <code class="literal">:flat</code> is an -abbrevation of <code class="literal">:hierdepth 0</code> and -<code class="literal">:tree</code> is an abbrevation of -<code class="literal">:hierdepth max-depth</code>, with -<code class="literal">max-depth</code> 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 (<code class="literal">:flat</code> or <code class= -"literal">:hierdepth 0</code>)</p> -<pre class="programlisting"> -tree binary AVL -tree binary natural -</pre> -<p>with <code class="literal">:hierdepth 1</code></p> -<pre class="programlisting"> -tree - binary AVL - binary natural -</pre> -<p>and a tree (<code class="literal">:tree</code> or <code class= -"literal">:hierdepth > 1</code>)</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" title="1.2.4 markup-indexentry-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-indexentry-list" name= -"markup-indexentry-list"></a>1.2.4 <code class= -"literal">markup-indexentry-list</code></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 -<code class="literal">markup-indexentry-list</code> 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 <code class="literal">markup-indexentry</code> -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 -<code class="literal">:depth</code> 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" title="1.2.5 markup-keyword-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-keyword-list" name= -"markup-keyword-list"></a>1.2.5 <code class= -"literal">markup-keyword-list</code></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 -<code class="literal">markup-keyword-list</code>. The keyword -argument <code class="literal">:depth</code> 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 <code class="literal">markup-keyword</code>. 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" title="1.2.6 markup-letter-group-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-letter-group-list" name= -"markup-letter-group-list"></a>1.2.6 <code class= -"literal">markup-letter-group-list</code></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 <code class="literal">group-name</code>. 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 <code class= -"literal">:open-head</code> and <code class= -"literal">:close-head</code> 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, <code class="literal">transformer-of</code> 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 <code class="literal">:upcase</code>, -<code class="literal">:downcase</code> and <code class= -"literal">:capitalize</code> which result in the corresponding -string conversions. If none of them is specified no transformation -is done at all.</p> -<p>The command <code class="literal">markup-letter-group</code> -defines the markup of the list of letter groups.</p> -</div> -<div class="section" title="1.2.7 markup-locclass-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-locclass-list" name= -"markup-locclass-list"></a>1.2.7 <code class= -"literal">markup-locclass-list</code></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" title="1.2.8 markup-locref"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-locref" name= -"markup-locref"></a>1.2.8 <code class= -"literal">markup-locref</code></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 <code class="literal">:class</code>, -<code class="literal">:attr</code> and additionally, if -sub-references are used, <code class="literal">:depth</code>. Most -often one will only use a tag depending on the attribute. For -example, all location references with the attribute <code class= -"literal">definition</code> should appear in a font series like -bold, emphasizing the importance of this location reference; those -with the attribute <code class="literal">default</code> 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" title="1.2.9 markup-locref-class"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-locref-class" name= -"markup-locref-class"></a>1.2.9 <code class= -"literal">markup-locref-class</code></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 <code class= -"literal">:class</code>.</p> -</div> -<div class="section" title="1.2.10 markup-locref-layer"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-locref-layer" name= -"markup-locref-layer"></a>1.2.10 <code class= -"literal">markup-locref-layer</code></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 <code class="literal">:layer 0</code>, the next element with -<code class="literal">:layer 1</code>, etc. See the next example -for an example.</p> -</div> -<div class="section" title="1.2.11 markup-locref-list"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-locref-list" name= -"markup-locref-list"></a>1.2.11 <code class= -"literal">markup-locref-list</code></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 -<code class="literal">:class</code>, and on <code class= -"literal">:depth</code> 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 <code class= -"literal">A-1</code>, <code class="literal">B-5</code>, etc. The -keyword argument <code class="literal">:hierdepth 2</code> 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" title="1.2.12 markup-range"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-range" name= -"markup-range"></a>1.2.12 <code class= -"literal">markup-range</code></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 <code class="literal">:open</code> and -<code class="literal">:close</code> arguments and one separator -given by the argument <code class="literal">:sep</code>.</p> -<p>Since both location references are tagged with markup defined by -the command <code class="literal">markup-locref</code> 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 <code class="literal">:length</code> can -be used to define different markup for different lengths. In -conjunction with <code class="literal">:length</code> 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 -<code class="literal">:ignore-end</code>.</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 <code class= -"literal">page-numbers</code>) 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" title= -"1.2.13 (markup-trace [:on] [:open string] [:close string])"> -<div class="titlepage"> -<div> -<div> -<h4 class="title"><a id="markup-trace" name= -"markup-trace"></a>1.2.13 <code class="literal">(markup-trace [:on] -[:open string] [:close string])</code></h4> -</div> -</div> -</div> -<p>This command can be used to activate the tracing of all markup -commands xindy executes. The switch <code class= -"literal">:on</code> activates the trace. If <code class= -"literal">:on</code> is omitted, the command line flag <code class= -"literal">-t</code> 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 <code class= -"literal">:open</code> is <code class="literal">`<'</code> and -for <code class="literal">:close</code> is <code class= -"literal">`>'</code>. 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 <code class= -"literal"><LETTER-GROUP:OPEN ["a"]></code> 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" title="1.3 Raw Index Interface"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="xindy-command-list-raw-index" name= -"xindy-command-list-raw-index"></a>1.3 Raw Index Interface</h3> -</div> -</div> -</div> -<a id="idp12953120" class="indexterm" name="idp12953120"></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 class= -"command"><strong>perl</strong></span>, <span class= -"command"><strong>sed</strong></span> or <span class= -"command"><strong>awk</strong></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"><code class= -"literal">:key</code></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 -<code class="literal">("heap" "fibonacci")</code>.</p> -</dd> -<dt><span class="term"><code class= -"literal">:print</code></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"><code class= -"literal">:tkey</code></span></dt> -<dd> -<p>Another possibility to define the keys of an index entry is with -the <code class="literal">:tkey</code> keyword argument. It can be -used instead of the <code class="literal">:key</code> and -<code class="literal">:print</code> 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"><code class= -"literal">:locref</code></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 <code class= -"literal">:locref</code> describes a location reference. Its -optional arguments are <code class="literal">:open-range</code> and -<code class="literal">:close-range</code>. The <span class= -"emphasis"><em>string</em></span> that must be supplied must -somehow encode the location reference. It might look like the -string <code class="literal">"25"</code> representing the page -number 25, or <code class="literal">"Appendix-I"</code> -representing the first appendix numbered in uppercase roman -numerals.</p> -</dd> -<dt><span class="term"><code class= -"literal">:open-range,:close-range</code></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 <code class= -"literal">:locref</code>. If they are supplied, the location -reference may have influence on the way ranges are build.</p> -</dd> -<dt><span class="term"><code class= -"literal">:xref</code></span></dt> -<dd> -<p>These arguments choose the second alternative. The argument -<span class="emphasis"><em>string list</em></span> of parameter -<code class="literal">:xref</code> describes where the index entry -should point to.</p> -</dd> -<dt><span class="term"><code class= -"literal">:attr</code></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 -<code class="literal">default</code>.</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 -<code class="literal">default</code>.</p> -<pre class="programlisting"> -(indexentry :key ("house") :xref("building") :attr "see") -</pre> -<p>defines a cross reference with the key <code class= -"literal">house</code> pointing to the term <code class= -"literal">building</code>. This cross reference belongs to the -cross reference class <code class="literal">see</code>.</p> -<pre class="programlisting"> -(indexentry :key ("house") :xref("building") :open-range) -</pre> -<p>is an invalid specification, since <code class= -"literal">:open-range</code> mustn't be used together with cross -references.</p> -</div> -</div> -<div class="section" title="2 Invoking xindy"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="xindy-invoking" name= -"xindy-invoking"></a>2 Invoking xindy</h2> -</div> -</div> -</div> -<a id="idp13002048" class="indexterm" name="idp13002048"></a> -<div class="section" title="2.1 Command Line Options"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="xindy-invoking-cmdline" name= -"xindy-invoking-cmdline"></a>2.1 Command Line Options</h3> -</div> -</div> -</div> -<a id="idp13004688" class="indexterm" name="idp13004688"></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 <code class="literal">indexstyle</code> names a -file, containing the index style description. The argument -<code class="literal">raw-index</code> 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 <code class= -"literal">logfile</code>. 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 <code class= -"literal">output</code> file. If not given, the name of the -<code class="literal">raw-index</code> is used with its extension -changed to <code class="literal">.ind</code> (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 <code class= -"literal">markup-trace</code>.</p> -</dd> -<dt><span class="term">-L</span></dt> -<dd> -<p>Set the xindy logging-level to <code class= -"literal">n</code>.</p> -</dd> -<dt><span class="term">-f</span></dt> -<dd> -<p>Run <code class="literal">filterprog</code> on <code class= -"literal">raw-index</code> before reading. The program must act as -a filter reading from <code class="literal">stdin</code> and -writing to <code class="literal">stdout</code>. The most obvious -use of this option in conjunction with TeX is to run <code class= -"literal">-f tex2xindy</code> 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 <code class= -"literal">stdout</code> and additionally to the logfile if -<code class="literal">-l</code> was specified.</p> -</div> -<div class="section" title="2.2 Search Path"> -<div class="titlepage"> -<div> -<div> -<h3 class="title"><a id="xindy-search-path" name= -"xindy-search-path"></a>2.2 Search Path</h3> -</div> -</div> -</div> -<a id="idp13032720" class="indexterm" name="idp13032720"></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 <code class="envar">XINDY_SEARCHPATH</code> -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 class="link" href= -"#xindy-command-list-processing-searchpath" title= -"1.1.12 searchpath">searchpath</a> for further details.</p> -</div> -</div> -</div> -<div xml:lang="en" class="appendix" title= -"Appendix A. Appendices" lang="en"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="appendices" name= -"appendices"></a>Appendix A. Appendices</h2> -</div> -</div> -</div> -<div class="toc"> -<p><strong>Table of Contents</strong></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" title= -"1 Bugs / Known Issues / Missing Features"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="issues" name= -"issues"></a>1 Bugs / Known Issues / Missing Features</h2> -</div> -</div> -</div> -<a id="idp13040576" class="indexterm" name="idp13040576"></a> -<div class="variablelist"> -<dl> -<dt><span class="term">PDF</span></dt> -<dd> -<p>A PDF file is no longer supported.</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 class="ulink" 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 class="ulink" 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" title="2 About this Document"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="about" name= -"about"></a>2 About this Document</h2> -</div> -</div> -</div> -<a id="idp13051152" class="indexterm" name="idp13051152"></a> -<p>The source format of this document is <a class="ulink" 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 class="itemizedlist" type="disc"> -<li class="listitem"><a class="ulink" href= -"http://xmlsoft.org/XSLT/" target="_top">xsltproc -(libxml2-2.6.26/libxslt-1.1.26)</a> as XSLT processor</li> -<li class="listitem"><a class="ulink" href= -"http://sourceforge.net/projects/docbook" target="_top">DocBook XSL -Stylesheets (V1.77.1)</a> for HTML and Epub</li> -</ul> -</div> -<p>You'll always find the newest version of this document at -<a class="ulink" href="http://www.miwie.org/tex-refs/" target= -"_top">http://www.miwie.org/tex-refs/</a>.</p> -</div> -<div class="section" title="3 Release News"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="release-news" name= -"release-news"></a>3 Release News</h2> -</div> -</div> -</div> -<div class="variablelist"> -<dl> -<dt><span class="term">V0.4.1 12-12-03</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Removed obsolete file still referenced in -Makefile (no visible changes)</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.4.0 12-12-02</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Minor changes for Epub output</li> -<li class="listitem">Added missing IDs on some sections and -tables</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.3.9 05-05-14</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Consistent naming scheme of IDs to ease the -use of this reference for other projects</li> -<li class="listitem">Added new section <a class="link" href= -"#float" title="3.3 float">float</a> in chapter <a class="link" -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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Minor changes in <a class="link" 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Corrected typos and markup errors in chapter -<a class="link" href="#bibtex" title= -"Chapter 5. BibTeX">BibTeX</a></li> -<li class="listitem">Switched to DocBook XML V4.3</li> -<li class="listitem">Added new section <a class="link" href= -"#opt-latex" title="2.1 Options">Options</a> in chapter <a class= -"link" 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Added a note in chapter <a class="link" href= -"#latex" title="2 LaTeX">LaTeX</a> with the copyright and -permission notice of the original file <code class= -"filename">latex2.texi</code></li> -<li class="listitem">Corrected typos and added missing hyperlinks -in chapter <a class="link" href="#xindy" title= -"Chapter 7. xindy">xindy</a></li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Added content to chapters <a class="link" -href="#metapost" title="Chapter 4. MetaPost">MetaPost</a> -and <a class="link" href="#pdftex" title= -"Chapter 2. pdfTeX">pdfTeX</a></li> -<li class="listitem">Enhanced index for chapter <a class="link" -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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Version control system changed from CVS to -SVN</li> -<li class="listitem">Added missing entries to chapter <a class= -"link" 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Corrected again section <a class="link" href= -"#makeindex-output-style-specs" title= -"2.2 Output Style Specifiers">Output Style Specifiers</a> and -<a class="link" href="#makeindex-style" title= -"2.1 Input Style Specifiers">Input Style Specifiers</a> of chapter -<a class="link" href="#makeindex" title= -"Chapter 6. Make-Index">Make-Index</a></li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Corrected sections <a class="link" href= -"#makeindex-output-style-specs" title= -"2.2 Output Style Specifiers">Output Style Specifiers</a> and -<a class="link" href="#makeindex-style" title= -"2.1 Input Style Specifiers">Input Style Specifiers</a> of chapter -<a class="link" href="#makeindex" title= -"Chapter 6. Make-Index">Make-Index</a></li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">More work on PDF</li> -<li class="listitem">Modularized XSL stylesheet files</li> -<li class="listitem">Corrected some typos</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.3.0 03-12-25</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Changed document root to <span class= -"emphasis"><em>book</em></span></li> -<li class="listitem">More work on PDF version</li> -<li class="listitem">Using new XSL stylesheets V1.64.1</li> -<li class="listitem">Minor fixes</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.2.6 03-10-27</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Rearranged appendix</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Added contents of <a class="link" href="#gfdl" -title="4 GNU Free Documentation License">GNU FDL</a> in -appendix</li> -<li class="listitem">Using new XSL stylesheets V1.62.4</li> -<li class="listitem">Switched to <a class="ulink" href= -"http://xmlsoft.org/XSLT/" target="_top"><code class= -"literal">xsltproc</code></a> as XSLT-processor</li> -<li class="listitem">Reedited some deeply nested sections</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Added subsection <a class="link" href= -"#dcolumn" title="3.2 dcolumn"><code class= -"literal">dcolumn</code></a></li> -<li class="listitem">Subsection <a class="link" href="#fontenc" -title="3.4 fontenc"><code class="literal">fontenc</code></a> -translated into english</li> -<li class="listitem">Corrected typo in <a class="link" href= -"#cmd-sbox" title="2.3.17. \sbox"><code class= -"filename">\sbox</code></a></li> -</ul> -</div> -</dd> -<dt><span class="term">V0.2.3 03-04-12</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Provide PDF output using <a class="ulink" -href="http://www.pragma-ade.com/" target="_top">ConTeXt</a> and -<a class="ulink" href= -"http://www.hobby.nl/~scaprea/context/index.html" target= -"_top">DocBook In ConTeXt</a> (still experimental)</li> -<li class="listitem">Reedited (beautified) sections LaTeX / -Commands / <a class="link" href="#counters" title= -"2.3.1 Counters">Counters</a> | <a class="link" href= -"#cross-references" title="2.3.2 Cross References">Cross -References</a> | <a class="link" href="#definitions" title= -"2.3.3 Definitions">Definitions</a> | <a class="link" href= -"#layout" title="2.3.5 Layout">Layout</a> | <a class="link" href= -"#env-latex" title="2.3.6 Environments">Environments</a> | -<a class="link" 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Added bzip2 compressed version of source and -outfiles tarball</li> -<li class="listitem">Using new XSL stylesheets V1.60.1</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Using new XSL stylesheets V1.59.2</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Using new XSL stylesheets V1.58.1</li> -<li class="listitem">Minor changes to CSS file</li> -<li class="listitem">License changed to <a class="ulink" href= -"http://www.gnu.org/licenses/fdl.html" target="_top">GNU Free -Documentation License</a></li> -<li class="listitem">Added subsection <a class="link" href= -"#pstricks-commands" title="4.2.2 Commands and Parameters">Commands -and Parameters</a> to section <a class="link" href="#pstricks" -title="4.2 PSTricks">PSTricks</a></li> -<li class="listitem">Reworked <a class="link" 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Started rework of <a class="link" href= -"#komascript" title="3.9 KOMA-Script">KOMA-Script</a> section</li> -<li class="listitem">Added subsection <a class="link" href= -"#pstricks-add-packages" title= -"4.2.3 List of Additional PSTricks Packages">Additional PSTricks -Packages</a></li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Reworked <a class="link" 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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Added template sections for <a class="link" -href="#pictex" title="4.1 PiCTeX (tbd.)">PiCTeX</a> and <a class= -"link" href="#texinfo" title="7 Texinfo (tbd.)">Texinfo</a></li> -<li class="listitem">Added subsection <a class="link" href= -"#release-news" title="3 Release News">Release News</a> in appendix -<a class="link" href="#about" title="2 About this Document">About -this Document</a></li> -<li class="listitem">Using new XSL stylesheets V1.55.0</li> -<li class="listitem">Added missing CSS file to outfiles -tarball</li> -<li class="listitem">Corrected wrong FPI</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.1.0 02-08-20</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Eliminated trailing '.' in numbered -sections</li> -<li class="listitem">Minor markup errors corrected</li> -<li class="listitem">Reworked CSS file</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.0.5 02-08-10</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Switched to DocBook XML 4.2</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">Section 'Makeindex' completed</li> -</ul> -</div> -</dd> -<dt><span class="term">V0.0.3 02-07-13</span></dt> -<dd> -<div class="itemizedlist"> -<ul class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">New (template) sections 'fontinst', 'Bibtex', -'Makeindex', and 'xindy'</li> -<li class="listitem">New section 'Special Symbols'</li> -<li class="listitem">Added information for 'german' package</li> -<li class="listitem">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 class="itemizedlist" type="disc" compact="compact"> -<li class="listitem">First official announcement</li> -</ul> -</div> -</dd> -</dl> -</div> -</div> -<div class="section" title="4 GNU Free Documentation License"> -<div class="titlepage"> -<div> -<div> -<h2 class="title" style="clear: both"><a id="gfdl" name= -"gfdl"></a>4 GNU Free Documentation License</h2> -</div> -</div> -</div> -<h5 class="title"><a id="idp13212128" name= -"idp13212128"></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" title="Index"> -<div class="titlepage"> -<div> -<div> -<h2 class="title"><a id="tex-refs-idx" name= -"tex-refs-idx"></a>Index</h2> -</div> -</div> -</div> -<div class="index"> -<div class="indexdiv"> -<h3>Symbols</h3> -<dl> -<dt>$, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\!, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\' (tabbing), <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\(, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\), <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\+, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\,, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\- (hyphenation), <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\- (tabbing) , <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\;, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\< , <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\=, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\>, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\a, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\addcontentsline, <a class="indexterm" href= -"#table-of-contents">Table of Contents</a></dt> -<dt>\address, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\addtocontents, <a class="indexterm" href= -"#table-of-contents">Table of Contents</a></dt> -<dt>\addtocounter{counter}{value}, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\addtolength, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\addvspace, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -<dt>\alph, <a class="indexterm" href="#counters">Counters</a></dt> -<dt>\Alph, <a class="indexterm" href="#counters">Counters</a></dt> -<dt>\appendix, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>\arabic, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\areaset, <a class="indexterm" href= -"#komascript-page-layout">Page-Layout</a></dt> -<dt>\author, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\backslash, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>\begin, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\bfseries, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\bibitem, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\bibliography, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\bibliographystyle, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\bigskip, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\bm, <a class="indexterm" href="#bm-package">bm</a></dt> -<dt>\boldsymbol, <a class="indexterm" href= -"#amsmath">amsmath</a></dt> -<dt>\boldsymbold, <a class="indexterm" href= -"#bm-package">bm</a></dt> -<dt>\caption, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\cc, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\cdots, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\centering, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\chapter, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>\circle, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\cite, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\cleardoublepage, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\clearpage, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\cline, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\closing, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\COLON, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\dashbox, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\date, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\ddots, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\depth, <a class="indexterm" href="#lengths">Lengths</a></dt> -<dt>\documentclass, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>\dotfill, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\emph, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\encl, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\end, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\enlargethispage, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\ensuremath{}, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\fbox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\floatname, <a class="indexterm" href="#float">float</a></dt> -<dt>\floatplacement, <a class="indexterm" href= -"#float">float</a></dt> -<dt>\floatstyle, <a class="indexterm" href="#float">float</a></dt> -<dt>\flushbottom, <a class="indexterm" href= -"#layout">Layout</a></dt> -<dt>\fnsymbol, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\fontencoding, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\fontfamily, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\fontseries, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\fontshape, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\fontsize, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\footnote, <a class="indexterm" href= -"#footnotes">Footnotes</a></dt> -<dt>\footnotemark, <a class="indexterm" href= -"#footnotes">Footnotes</a></dt> -<dt>\footnotesize, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\footnotetext, <a class="indexterm" href= -"#footnotes">Footnotes</a></dt> -<dt>\frac, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\frame, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\framebox, <a class="indexterm" href= -"#env-latex">Environments</a>, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -<dt>\fussy, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\graphicspath, <a class="indexterm" href= -"#graphicspath">\graphicspath</a></dt> -<dt>\height, <a class="indexterm" href="#lengths">Lengths</a></dt> -<dt>\hfill, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\hline, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\hrulefill, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -<dt>\hspace, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\huge, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\Huge, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\hyphenation, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\include, <a class="indexterm" href= -"#splitting-the-input">Splitting the Input</a></dt> -<dt>\includegraphics, <a class="indexterm" href= -"#includegraphics">\includegraphics</a></dt> -<dt>\includeonly, <a class="indexterm" href= -"#splitting-the-input">Splitting the Input</a></dt> -<dt>\indent, <a class="indexterm" href="#making-paragraphs">Making -Paragraphs</a></dt> -<dt>\input, <a class="indexterm" href= -"#splitting-the-input">Splitting the Input</a></dt> -<dt>\item, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\itshape, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\kill, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\label, <a class="indexterm" href="#cross-references">Cross -References</a></dt> -<dt>\large, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\Large, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\LARGE, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\ldots, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\lefteqn, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\line, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\linebreak, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\linethickness, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\listof, <a class="indexterm" href="#float">float</a></dt> -<dt>\listoffigures, <a class="indexterm" href= -"#table-of-contents">Table of Contents</a></dt> -<dt>\listoftables, <a class="indexterm" href= -"#table-of-contents">Table of Contents</a></dt> -<dt>\location, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>\makebox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\makebox (picture), <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\makelabels, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>\maketitle, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\markboth, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\markright, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\mathbf, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathcal, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathit, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathnormal, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathrm, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathsf, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathtt, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mathversion, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\mbox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\mdseries, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\medskip, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\multicolumn, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\multiput, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\name, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\newcommand, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>\newcounter, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\newenvironment, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>\newfloat, <a class="indexterm" href="#float">float</a></dt> -<dt>\newfont, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>\newlength, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\newline, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\newpage, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\newsavebox, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -<dt>\newtheorem, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>\nocite, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\nofiles, <a class="indexterm" href="#table-of-contents">Table -of Contents</a></dt> -<dt>\noindent, <a class="indexterm" href= -"#making-paragraphs">Making Paragraphs</a></dt> -<dt>\nolinebreak, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\nopagebreak, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\normalfont, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\normalsize, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\onecolumn, <a class="indexterm" href="#layout">Layout</a></dt> -<dt>\opening, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\oval, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\overbrace, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\overline, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\pagebreak, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\pagenumbering, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\pageref, <a class="indexterm" href="#cross-references">Cross -References</a></dt> -<dt>\pagestyle, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\par, <a class="indexterm" href="#making-paragraphs">Making -Paragraphs</a></dt> -<dt>\paragraph, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>\parbox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\pmb, <a class="indexterm" href="#amsmath">amsmath</a></dt> -<dt>\poptabs, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\ps, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>\pushtabs, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\put, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\raggedbottom, <a class="indexterm" href= -"#layout">Layout</a></dt> -<dt>\raggedleft, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\raggedright, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\raisebox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\ref, <a class="indexterm" href="#cross-references">Cross -References</a></dt> -<dt>\refstepcounter, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\restylefloat, <a class="indexterm" href= -"#float">float</a></dt> -<dt>\rmfamily, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\roman, <a class="indexterm" href="#counters">Counters</a></dt> -<dt>\Roman, <a class="indexterm" href="#counters">Counters</a></dt> -<dt>\rule, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\samepage, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\savebox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\sbox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\scriptsize, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\scshape, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\selectfont, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\setcounter, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\setlength, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\settodepth, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\settoheight, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\settowidth, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\sffamily, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\shortstack, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\signature, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>\sloppy, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>\slshape, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\small, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\smallskip, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -<dt>\sqrt, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\startbreaks, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>\stepcounter, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\stopbreaks, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>\subparagraph, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>\subsection, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>\subsubsection, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>\symbol, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>\tableofcontents, <a class="indexterm" href= -"#table-of-contents">Table of Contents</a></dt> -<dt>\telephone, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>\textbf, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textit, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textmd, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textnormal, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textrm, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textsc, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textsf, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textsl, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\texttt, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\textup, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\thanks, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\thispagestyle, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\tiny, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\title, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>\today, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\totalheight, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>\ttfamily, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\twocolumn, <a class="indexterm" href="#layout">Layout</a></dt> -<dt>\typearea, <a class="indexterm" href= -"#komascript-page-layout">Page-Layout</a></dt> -<dt>\typein, <a class="indexterm" href= -"#terminal-input-slash-output">Terminal Input/Output</a></dt> -<dt>\typeout, <a class="indexterm" href= -"#terminal-input-slash-output">Terminal Input/Output</a></dt> -<dt>\unboldmath, <a class="indexterm" href= -"#bm-package">bm</a></dt> -<dt>\underbrace, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\underline, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\upDelta, <a class="indexterm" href="#upDelta-upOmega">\upDelta -/ \upOmega</a></dt> -<dt>\upOmega, <a class="indexterm" href="#upDelta-upOmega">\upDelta -/ \upOmega</a></dt> -<dt>\upshape, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\usebox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\usecounter, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>\usefont, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>\usepackage, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>\value, <a class="indexterm" href="#counters">Counters</a></dt> -<dt>\vdots, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\vector, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\verb, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\vfill, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\vline, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>\vpageref, <a class="indexterm" href= -"#varioref">varioref</a></dt> -<dt>\vpagerefrange, <a class="indexterm" href= -"#varioref">varioref</a></dt> -<dt>\vref, <a class="indexterm" href="#varioref">varioref</a></dt> -<dt>\vrefrange, <a class="indexterm" href= -"#varioref">varioref</a></dt> -<dt>\vspace, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>\width, <a class="indexterm" href="#lengths">Lengths</a></dt> -<dt>\[, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\\, <a class="indexterm" href="#line-and-page-breaking">Line -& Page Breaking</a></dt> -<dt>\], <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>\` (tabbing), <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>^, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>_, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>A</h3> -<dl> -<dt>About this Document, <a class="indexterm" href="#about">About -this Document</a></dt> -<dt>Accents, <a class="indexterm" href="#special-symbols">Special -Symbols</a></dt> -<dt>Accessing any character of a font, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>Aligning Equations, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>amsmath, <a class="indexterm" href="#amsmath">amsmath</a></dt> -<dt>ansinew, <a class="indexterm" href= -"#inputenc">inputenc</a></dt> -<dt>Appendix, creating, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>applemac, <a class="indexterm" href= -"#inputenc">inputenc</a></dt> -<dt>array, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Arrays, math, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Arrows, <a class="indexterm" href="#special-symbols">Special -Symbols</a></dt> -<dt>article class, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Author, for titlepage, <a class="indexterm" href= -"#page-styles">Page Styles</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>B</h3> -<dl> -<dt>BCOR, <a class="indexterm" href= -"#komascript-options">Options</a></dt> -<dt>Bibliography, creating (automatically), <a class="indexterm" -href="#env-latex">Environments</a></dt> -<dt>Bibliography, creating (manually), <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>BibTeX, <a class="indexterm" href="#bibtex">BibTeX</a></dt> -<dd> -<dl> -<dt>bib files, <a class="indexterm" href="#bibtex-bib-files">bib -files</a></dt> -<dd> -<dl> -<dt>@STRING command, <a class="indexterm" href= -"#bibtex-string-command">@STRING command</a></dt> -<dt>Entry Format, <a class="indexterm" href= -"#bibtex-entry-format">Entry Format</a></dt> -<dt>Entry Types, <a class="indexterm" href= -"#bibtex-entry-types">Entry Types</a></dt> -<dt>Field Text, <a class="indexterm" href= -"#bibtex-field-text">Field Text</a></dt> -<dt>Field Types, <a class="indexterm" href= -"#bibtex-field-types">Field Types</a></dt> -</dl> -</dd> -<dt>bst files, <a class="indexterm" href="#bibtex-bst-files">bst -files</a></dt> -<dd> -<dl> -<dt>ABBRV.BST, <a class="indexterm" href= -"#bibtex-bst-abbr">ABBRV.BST</a></dt> -<dt>ALPHA.BST, <a class="indexterm" href= -"#bibtex-bst-alpha">ALPHA.BST</a></dt> -<dt>PLAIN.BST, <a class="indexterm" href= -"#bibtex-bst-plain">PLAIN.BST</a></dt> -<dt>SAMPLE.BST, <a class="indexterm" href= -"#bibtex-bst-sample">SAMPLE.BST</a></dt> -<dt>UNSRT.BST, <a class="indexterm" href= -"#bibtex-bst-unsrt">UNSRT.BST</a></dt> -</dl> -</dd> -<dt>Command Qualifiers, <a class="indexterm" href= -"#bibtex-command-qualifiers">Command Qualifiers</a></dt> -<dt>Entry Types</dt> -<dd> -<dl> -<dt>article entry, <a class="indexterm" href= -"#bibtex-entry-types-article">article entry</a></dt> -<dt>book entry, <a class="indexterm" href= -"#bibtex-entry-types-book">book entry</a></dt> -<dt>booklet entry, <a class="indexterm" href= -"#bibtex-entry-types-booklet">booklet entry</a></dt> -<dt>conference entry, <a class="indexterm" href= -"#bibtex-entry-types-conference">conference entry</a></dt> -<dt>inbook entry, <a class="indexterm" href= -"#bibtex-entry-types-inbook">inbook entry</a></dt> -<dt>incollection entry, <a class="indexterm" href= -"#bibtex-entry-types-incollection">incollection entry</a></dt> -<dt>inproceedings entry, <a class="indexterm" href= -"#bibtex-entry-types-inproceedings">inproceedings entry</a></dt> -<dt>manual entry, <a class="indexterm" href= -"#bibtex-entry-types-manual">manual entry</a></dt> -<dt>mastersthesis entry, <a class="indexterm" href= -"#bibtex-entry-types-mastersthesis">mastersthesis entry</a></dt> -<dt>misc entry, <a class="indexterm" href= -"#bibtex-entry-types-misc">misc entry</a></dt> -<dt>phdthesis entry, <a class="indexterm" href= -"#bibtex-entry-types-phdthesis">phdthesis entry</a></dt> -<dt>proceedings entry, <a class="indexterm" href= -"#bibtex-entry-types-proceedings">proceedings entry</a></dt> -<dt>techreport entry, <a class="indexterm" href= -"#bibtex-entry-types-techreport">techreport entry</a></dt> -<dt>unpublished entry, <a class="indexterm" href= -"#bibtex-entry-types-unpublished">unpublished entry</a></dt> -</dl> -</dd> -<dt>Field Text</dt> -<dd> -<dl> -<dt>Abbreviations, <a class="indexterm" href= -"#bibtex-field-text-abbr">Abbreviations</a></dt> -<dt>Names, <a class="indexterm" href= -"#bibtex-field-text-names">Names</a></dt> -<dt>Titles, <a class="indexterm" href= -"#bibtex-field-text-titles">Titles</a></dt> -</dl> -</dd> -<dt>Field Types</dt> -<dd> -<dl> -<dt>address field, <a class="indexterm" href= -"#bibtex-field-types-address">address field</a></dt> -<dt>annote field, <a class="indexterm" href= -"#bibtex-field-types-annote">annote field</a></dt> -<dt>author field, <a class="indexterm" href= -"#bibtex-field-types-author">author field</a></dt> -<dt>booktitle field, <a class="indexterm" href= -"#bibtex-field-types-booktitle">booktitle field</a></dt> -<dt>chapter field, <a class="indexterm" href= -"#bibtex-field-types-chapter">chapter field</a></dt> -<dt>edition field, <a class="indexterm" href= -"#bibtex-field-types-edition">edition field</a></dt> -<dt>editor field, <a class="indexterm" href= -"#bibtex-field-types-editor">editor field</a></dt> -<dt>howpublished field, <a class="indexterm" href= -"#bibtex-field-types-howpublished">howpublished field</a></dt> -<dt>institution field, <a class="indexterm" href= -"#bibtex-field-types-institution">institution field</a></dt> -<dt>journal field, <a class="indexterm" href= -"#bibtex-field-types-journal">journal field</a></dt> -<dt>key field, <a class="indexterm" href= -"#bibtex-field-types-key">key field</a></dt> -<dt>month field, <a class="indexterm" href= -"#bibtex-field-types-month">month field</a></dt> -<dt>note field, <a class="indexterm" href= -"#bibtex-field-types-note">note field</a></dt> -<dt>number field, <a class="indexterm" href= -"#bibtex-field-types-number">number field</a></dt> -<dt>organization field, <a class="indexterm" href= -"#bibtex-field-types-organization">organization field</a></dt> -<dt>pages field, <a class="indexterm" href= -"#bibtex-field-types-pages">pages field</a></dt> -<dt>publisher field, <a class="indexterm" href= -"#bibtex-field-types-publisher">publisher field</a></dt> -<dt>school field, <a class="indexterm" href= -"#bibtex-field-types-school">school field</a></dt> -<dt>series field, <a class="indexterm" href= -"#bibtex-field-types-series">series field</a></dt> -<dt>title field, <a class="indexterm" href= -"#bibtex-field-types-title">title field</a></dt> -<dt>type field, <a class="indexterm" href= -"#bibtex-field-types-type">type field</a></dt> -<dt>volume field, <a class="indexterm" href= -"#bibtex-field-types-volume">volume field</a></dt> -<dt>year field, <a class="indexterm" href= -"#bibtex-field-types-year">year field</a></dt> -</dl> -</dd> -<dt>Parameters, <a class="indexterm" href= -"#bibtex-parameters">Parameters</a></dt> -<dt>using, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -</dl> -</dd> -<dt>Binary Operators, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -<dt>bm, <a class="indexterm" href="#bm-package">bm</a></dt> -<dt>book class, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Boxes, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>C</h3> -<dl> -<dt>Cc list, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>center, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Centering text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Centering text, environment for, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Characters, reserved, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>Characters, special, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>cite.sty, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Classes of document, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Commands, defining new ones, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>Computer programs, typesetting, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>ConTeXt, <a class="indexterm" href="#context">ConTeXt -(tbd.)</a></dt> -<dt>Counters, a list of, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>Counters, creating, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>Counters, getting the value of, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>Counters, setting, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>cp850, <a class="indexterm" href="#inputenc">inputenc</a></dt> -<dt>Creating letters, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>Creating pictures, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Creating tables, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Credits, <a class="indexterm" href="#credits">Credits</a></dt> -<dt>Cross referencing, <a class="indexterm" href= -"#cross-references">Cross References</a></dt> -<dt>Cross referencing using page number, <a class="indexterm" href= -"#cross-references">Cross References</a></dt> -<dt>Cross referencing using section number, <a class="indexterm" -href="#cross-references">Cross References</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>D</h3> -<dl> -<dt>Date, for titlepage, <a class="indexterm" href= -"#page-styles">Page Styles</a></dt> -<dt>dcolumn, <a class="indexterm" href="#dcolumn">dcolumn</a></dt> -<dt>Defining a new command, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>Defining new environments, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>Defining new fonts, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>Defining new theorems, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>Delimiters, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -<dt>description, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Displaying quoted text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Displaying quoted text with paragraph indentation, <a class= -"indexterm" href="#env-latex">Environments</a></dt> -<dt>DIV, <a class="indexterm" href= -"#komascript-options">Options</a></dt> -<dt>Document Classes, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>E</h3> -<dl> -<dt>Ellipsis, <a class="indexterm" href="#special-symbols">Special -Symbols</a></dt> -<dt>Enclosed material, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>Ending & Starting, <a class="indexterm" href= -"#starting-and-ending">Starting & Ending</a></dt> -<dt>Enlarge current page, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>enumerate, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Environments, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Environments, defining, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>eqnarray, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>equation, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Equations, aligning, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Equations, environment for, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>exponent, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>F</h3> -<dl> -<dt>figure, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Figures, footnotes in, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>float, <a class="indexterm" href="#float">float</a></dt> -<dd> -<dl> -<dt>\floatname, <a class="indexterm" href="#float">float</a></dt> -<dt>\floatplacement, <a class="indexterm" href= -"#float">float</a></dt> -<dt>\floatstyle, <a class="indexterm" href="#float">float</a></dt> -<dt>\listof, <a class="indexterm" href="#float">float</a></dt> -<dt>\newfloat, <a class="indexterm" href="#float">float</a></dt> -<dt>\restylefloat, <a class="indexterm" href= -"#float">float</a></dt> -</dl> -</dd> -<dt>Flushing a page, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>flushleft, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>flushright, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Font commands, low-level, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Font Sizes, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Font Styles, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>fontenc, <a class="indexterm" href="#fontenc">fontenc</a></dt> -<dt>fontinst, <a class="indexterm" href="#fontinst">fontinst -(tbd.)</a></dt> -<dt>Fonts, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Fonts, new commands for, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>footexclude, <a class="indexterm" href= -"#komascript-options">Options</a></dt> -<dt>footinclude, <a class="indexterm" href= -"#komascript-options">Options</a></dt> -<dt>Footnotes in figures, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Footnotes, creating, <a class="indexterm" href= -"#footnotes">Footnotes</a></dt> -<dt>Formatting Text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Formulae, environment for, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Formulae, maths, <a class="indexterm" href= -"#math-formulae">Math Formulae</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>G</h3> -<dl> -<dt>german, <a class="indexterm" href="#german">german</a></dt> -<dd> -<dl> -<dt>!-, <a class="indexterm" href="#german">german</a></dt> -<dt>"", <a class="indexterm" href="#german">german</a></dt> -<dt>"=, <a class="indexterm" href="#german">german</a></dt> -<dt>"a, <a class="indexterm" href="#german">german</a></dt> -<dt>"ck, <a class="indexterm" href="#german">german</a></dt> -<dt>"ff, <a class="indexterm" href="#german">german</a></dt> -<dt>"|, <a class="indexterm" href="#german">german</a></dt> -<dt>"~, <a class="indexterm" href="#german">german</a></dt> -<dt><, <a class="indexterm" href="#german">german</a></dt> -<dt>\-, <a class="indexterm" href="#german">german</a></dt> -<dt>\dq, <a class="indexterm" href="#german">german</a></dt> -<dt>\flq, <a class="indexterm" href="#german">german</a></dt> -<dt>\flqq, <a class="indexterm" href="#german">german</a></dt> -<dt>\frq, <a class="indexterm" href="#german">german</a></dt> -<dt>\frqq, <a class="indexterm" href="#german">german</a></dt> -<dt>\glq, <a class="indexterm" href="#german">german</a></dt> -<dt>\glqq, <a class="indexterm" href="#german">german</a></dt> -<dt>\grqq, <a class="indexterm" href="#german">german</a></dt> -</dl> -</dd> -<dt>Global options, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>graphics, <a class="indexterm" href= -"#graphics">graphics</a></dt> -<dt>Greek letters, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>Greek Letters, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>H</h3> -<dl> -<dt>headexclude, <a class="indexterm" href= -"#komascript-options">Options</a></dt> -<dt>headinclude, <a class="indexterm" href= -"#komascript-options">Options</a></dt> -<dt>hyperref, <a class="indexterm" href= -"#hyperref">hyperref</a></dt> -<dd> -<dl> -<dt>commands</dt> -<dd> -<dl> -<dt>\autoref, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\href, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\hyperbaseurl, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\hyperimage, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\hyperlink, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\hyperref, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\hypertarget, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\nolinkurl, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -<dt>\texorpdfstring, <a class="indexterm" href= -"#hyperref-commands">Commands</a></dt> -</dl> -</dd> -<dt>options</dt> -<dd> -<dl> -<dt>4, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>a4paper, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>a5paper, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>anchorcolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>b5paper, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>backref, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>baseurl, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>bookmarks, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>bookmarksnumbered, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>bookmarksopen, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>bookmarksopenlevel, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>bookmarkstype, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>breaklinks, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>citebordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>citecolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>colorlinks, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>debug, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>draft, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>dvipdf, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>dvipdfm, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>dvips, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>dvipsone, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>dviwindo, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>executivepaper, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>extension, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>filebordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>filecolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>frenchlinks, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>hyperfigures, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>hyperindex, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>hypertex, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>hypertexnames, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>implicit, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>latex2html, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>legalpaper, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>letterpaper, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>linkbordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>linkcolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>linktocpage, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>menubordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>menucolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>naturalnames, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>nesting, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pageanchor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pagebackref, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pagebordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pagecolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfauthor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfborder, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfcenterwindow, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfcreator, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdffitwindow, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfhighlight, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfkeywords, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfmenubar, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfnewwindow, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfpagelayout, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfpagemode, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfpagescrop, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfpagetransition, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfproducer, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfstartpage, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfstartview, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfsubject, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdftex, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdftitle, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdftoolbar, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfview, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>pdfwindowui, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>plainpages, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>raiselinks, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>runbordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>tex4ht, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>textures, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>unicode, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>urlbordercolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>urlcolor, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>verbose, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -<dt>vtex, <a class="indexterm" href= -"#hyperref-options">Options</a></dt> -</dl> -</dd> -</dl> -</dd> -<dt>Hyphenation, defining, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Hyphenation, forcing, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>I</h3> -<dl> -<dt>Indent, forcing, <a class="indexterm" href= -"#making-paragraphs">Making Paragraphs</a></dt> -<dt>Indent, suppressing, <a class="indexterm" href= -"#making-paragraphs">Making Paragraphs</a></dt> -<dt>Input file, splitting, <a class="indexterm" href= -"#splitting-the-input">Splitting the Input</a></dt> -<dt>Input/Output, <a class="indexterm" href= -"#terminal-input-slash-output">Terminal Input/Output</a></dt> -<dt>inputenc, <a class="indexterm" href= -"#inputenc">inputenc</a></dt> -<dt>Inserting figures, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>itemize, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>J</h3> -<dl> -<dt>Justification, ragged left, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Justification, ragged right, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>K</h3> -<dl> -<dt>Known Issues, <a class="indexterm" href="#issues">Bugs / Known -Issues / Missing Features</a></dt> -<dt>KOMA-Script, <a class="indexterm" href= -"#komascript">KOMA-Script</a></dt> -<dd> -<dl> -<dt>scraddr, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dd> -<dl> -<dt>\Address{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\Comment{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\FirstName{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\FreeIII{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\FreeII{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\FreeIV{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\FreeI{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\InputAddressFile, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\LastName{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\Name{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -<dt>\Telephone{}, <a class="indexterm" href= -"#komascript-scraddr">Address Files with scraddr</a></dt> -</dl> -</dd> -<dt>scrlttr2, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dd> -<dl> -<dt>address, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>address files, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>backaddress, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>backaddressseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>business line, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>carbon copy, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>ccseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>circular letters, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>Closing, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>Closing Part, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>customer, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>date, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>emailseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>enclosure, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>enclseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>faxseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>font options, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>font selection, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>footer, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>footnotes, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>format options, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromaddress, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>frombank, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromemail, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromfax, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromlogo, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromname, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromphone, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>fromurl, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>general document properties, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>invoice, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>language selection, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>language support, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>letter class option files, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>letter declaration, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>letterhead, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>lists, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>location, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>margin notes, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>myref, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>Opening, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>options, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>options for letterhead and address, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>other layout, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>page layout, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>page style, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>phoneseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>place, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>placeseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>postscript, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>pseudo lengths, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>sender's extension, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>signature, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>specialmail, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>subject, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>subject line, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>subjectseparator, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>text, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>text emphasis, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>title, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>title line, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>toaddress, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>toname, <a class="indexterm" href="#komascript-scrlttr2">Letter -Class scrlttr2</a></dt> -<dt>variables, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>yourmail, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>yourref, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>\addtoreffields, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>\ifkomavarempty, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>\KOMAoptions{}, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>\newkomavar, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>\setkomavar, <a class="indexterm" href= -"#komascript-scrlttr2">Letter Class scrlttr2</a></dt> -<dt>\usekomavar, <a class="indexterm" 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 class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>LaTeX</dt> -<dd> -<dl> -<dt>Options, <a class="indexterm" href= -"#opt-latex">Options</a></dt> -<dd> -<dl> -<dt>-file-line-error-style, <a class="indexterm" href= -"#opt-latex-file-line-error-style">-file-line-error-style</a></dt> -<dt>-fmt=FMTNAME, <a class="indexterm" href= -"#opt-latex-fmt">-fmt=FMTNAME</a></dt> -<dt>-help, <a class="indexterm" href= -"#opt-latex-help">-help</a></dt> -<dt>-ini, <a class="indexterm" href="#opt-latex-ini">-ini</a></dt> -<dt>-interaction=STRING, <a class="indexterm" href= -"#opt-latex-interaction-mode">-interaction=STRING</a></dt> -<dt>-ipc, <a class="indexterm" href="#opt-latex-ipc">-ipc</a></dt> -<dt>-ipc-start, <a class="indexterm" href= -"#opt-latex-ipc-start">-ipc-start</a></dt> -<dt>-jobname=STRING, <a class="indexterm" href= -"#opt-latex-jobname-name">-jobname=STRING</a></dt> -<dt>-kpathsea-debug=NUMBER, <a class="indexterm" href= -"#opt-latex-kpathsea-debug">-kpathsea-debug=NUMBER</a></dt> -<dt>-mltex, <a class="indexterm" href= -"#opt-latex-mltex">-mltex</a></dt> -<dt>-output-comment=STRING, <a class="indexterm" href= -"#opt-latex-output-comment">-output-comment=STRING</a></dt> -<dt>-parse-first-line, <a class="indexterm" href= -"#opt-latex-parse-first-line">-parse-first-line</a></dt> -<dt>-progname=STRING, <a class="indexterm" href= -"#opt-latex-progname">-progname=STRING</a></dt> -<dt>-recorder, <a class="indexterm" href= -"#opt-latex-recorder">-recorder</a></dt> -<dt>-shell-escape, <a class="indexterm" href= -"#opt-latex-shell-escape">-shell-escape</a></dt> -<dt>-src-specials, <a class="indexterm" href= -"#opt-latex-src-specials">-src-specials</a></dt> -<dt>-src-specials=WHERE, <a class="indexterm" href= -"#opt-latex-src-specials-where">-src-specials=WHERE</a></dt> -<dt>-translate-file=TCXNAME, <a class="indexterm" href= -"#opt-latex-translate-file-tcxname">-translate-file=TCXNAME</a></dt> -<dt>-version, <a class="indexterm" href= -"#opt-latex-version">-version</a></dt> -</dl> -</dd> -</dl> -</dd> -<dt>LaTeX overview, <a class="indexterm" href="#overview">Overview -of LaTeX and Local Guide</a></dt> -<dt>LaTeX Packages, <a class="indexterm" href= -"#latex-packages">LaTeX Packages</a></dt> -<dt>latin1, <a class="indexterm" href="#inputenc">inputenc</a></dt> -<dt>latin9, <a class="indexterm" href="#inputenc">inputenc</a></dt> -<dt>Layout commands, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Left-justifying text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Left-justifying text, environment for, <a class="indexterm" -href="#env-latex">Environments</a></dt> -<dt>Left-to-right mode, <a class="indexterm" href= -"#modes">Modes</a></dt> -<dt>Lengths, adding to, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>Lengths, defining a new, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>Lengths, defining and using, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>Lengths, predefined, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>Lengths, setting value of, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>letter, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>letter class, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Letters, <a class="indexterm" href="#letters">Letters</a></dt> -<dt>Letters, ending, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>Letters, starting, <a class="indexterm" href= -"#letters">Letters</a></dt> -<dt>Line Breaking, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Line breaks, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Lines in tables, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Lining text up in columns using tab stops, <a class="indexterm" -href="#env-latex">Environments</a></dt> -<dt>Lining text up in tables, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>list, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Lists of items, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Lists of items, generic, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Lists of items, numbered, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Loading additional packages, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Low-level font commands, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>LR mode, <a class="indexterm" href="#modes">Modes</a></dt> -<dt>lrbox, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>M</h3> -<dl> -<dt>Make-Index, <a class="indexterm" href= -"#makeindex">Make-Index</a></dt> -<dd> -<dl> -<dt>Example, <a class="indexterm" href= -"#makeindex-example">Example</a></dt> -<dt>Input Style Specifiers, <a class="indexterm" href= -"#makeindex-style">Input Style Specifiers</a></dt> -<dd> -<dl> -<dt>actual, <a class="indexterm" href= -"#makeindex-actual-char">actual <char></a></dt> -<dt>arg_close, <a class="indexterm" href= -"#makeindex-arg-close">arg_close <char></a></dt> -<dt>arg_open, <a class="indexterm" href= -"#makeindex-style-arg-open">arg_open <char></a></dt> -<dt>encap, <a class="indexterm" href="#makeindex-encap-char">encap -<char></a></dt> -<dt>escape, <a class="indexterm" href= -"#makeindex-escape-char">escape <char></a></dt> -<dt>keyword, <a class="indexterm" href= -"#makeindex-style-string">keyword <string></a></dt> -<dt>level, <a class="indexterm" href="#makeindex-level-char">level -<char></a></dt> -<dt>quote, <a class="indexterm" href="#makeindex-quote-char">quote -<char></a></dt> -<dt>range_close, <a class="indexterm" href= -"#makeindex-range-close">range_close <char></a></dt> -<dt>range_open, <a class="indexterm" href= -"#makeindex-range-open">range_open <char></a></dt> -</dl> -</dd> -<dt>Options, <a class="indexterm" href= -"#makeindex-options">Options</a></dt> -<dd> -<dl> -<dt>-c, <a class="indexterm" href="#makeindex-option-c">-c</a></dt> -<dt>-g, <a class="indexterm" href="#makeindex-option-g">-g</a></dt> -<dt>-i, <a class="indexterm" href="#makeindex-option-i">-i</a></dt> -<dt>-l, <a class="indexterm" href="#makeindex-option-l">-l</a></dt> -<dt>-L, <a class="indexterm" href="#makeindex-option-L">-L</a></dt> -<dt>-o ind, <a class="indexterm" href="#makeindex-option-o-ind">-o -ind</a></dt> -<dt>-p no, <a class="indexterm" href="#makeindex-option-p-no">-p -no</a></dt> -<dt>-q, <a class="indexterm" href="#makeindex-option-q">-q</a></dt> -<dt>-r, <a class="indexterm" href="#makeindex-option-r">-r</a></dt> -<dt>-s sty, <a class="indexterm" href="#makeindex-option-s-sty">-s -sty</a></dt> -<dt>-T, <a class="indexterm" href="#makeindex-option-T">-T</a></dt> -<dt>-t log, <a class="indexterm" href="#makeindex-option-t-log">-t -log</a></dt> -</dl> -</dd> -<dt>Ordering, <a class="indexterm" href= -"#makeindex-ordering">Ordering</a></dt> -<dt>Output Style Specifiers, <a class="indexterm" href= -"#makeindex-output-style-specs">Output Style Specifiers</a></dt> -<dd> -<dl> -<dt>delim_0, <a class="indexterm" href= -"#makeindex-output-delim-0">delim_0 <string></a></dt> -<dt>delim_1, <a class="indexterm" href= -"#makeindex-output-delim-1">delim_1 <string></a></dt> -<dt>delim_2, <a class="indexterm" href= -"#makeindex-output-delim-2">delim_2 <string></a></dt> -<dt>delim_n, <a class="indexterm" href= -"#makeindex-output-delim-n">delim_n <string></a></dt> -<dt>delim_r, <a class="indexterm" href= -"#makeindex-output-delim-r">delim_r <string></a></dt> -<dt>delim_t, <a class="indexterm" href= -"#makeindex-output-delim-t">delim_t <string></a></dt> -<dt>encap_infix, <a class="indexterm" href= -"#makeindex-output-encap-infox">encap_infix <string></a></dt> -<dt>encap_prefix, <a class="indexterm" href= -"#makeindex-output-encap-prefix">encap_prefix -<string></a></dt> -<dt>encap_suffix, <a class="indexterm" href= -"#makeindex-output-encap-suffix">encap_suffix -<string></a></dt> -<dt>group_skip, <a class="indexterm" href= -"#makeindex-output-group-skip">group_skip <string></a></dt> -<dt>headings_flag, <a class="indexterm" href= -"#makeindex-output-headings-flag">headings_flag -<string></a></dt> -<dt>heading_prefix, <a class="indexterm" href= -"#makeindex-output-heading-prefix-string">heading_prefix -<string></a></dt> -<dt>heading_suffix, <a class="indexterm" href= -"#makeindex-output-heading-suffix-string">heading_suffix -<string></a></dt> -<dt>indent_length, <a class="indexterm" href= -"#makeindex-output-indent-length">indent_length -<number></a></dt> -<dt>indent_space, <a class="indexterm" href= -"#makeindex-output-indent-space">indent_space -<string></a></dt> -<dt>item_0, <a class="indexterm" href= -"#makeindex-output-item-0">item_0 <string></a></dt> -<dt>item_01, <a class="indexterm" href= -"#makeindex-output-item-01">item_01 <string></a></dt> -<dt>item_1, <a class="indexterm" href= -"#makeindex-output-item-1">item_1 <string></a></dt> -<dt>item_12, <a class="indexterm" href= -"#makeindex-output-item-12">item_12 <string></a></dt> -<dt>item_2, <a class="indexterm" href= -"#makeindex-output-item-2">item_2 <string></a></dt> -<dt>item_x1, <a class="indexterm" href= -"#makeindex-output-item-x1">item_x1 <string></a></dt> -<dt>item_x2, <a class="indexterm" href= -"#makeindex-output-item-x2">item_x2 <string></a></dt> -<dt>line_max, <a class="indexterm" href= -"#makeindex-output-line-max">line_max <number></a></dt> -<dt>numhead_negative, <a class="indexterm" href= -"#makeindex-output-numhead-negative">numhead_negative -<string></a></dt> -<dt>numhead_positive, <a class="indexterm" href= -"#makeindex-output-numhead-positive">numhead_positive -<string></a></dt> -<dt>page_compositor, <a class="indexterm" href= -"#makeindex-page-compositor">page_compositor -<string></a></dt> -<dt>postamble, <a class="indexterm" href= -"#makeindex-output-postamble-string">postamble -<string></a></dt> -<dt>preamble, <a class="indexterm" href= -"#makeindex-output-preamble-string">preamble -<string></a></dt> -<dt>setpage_prefix, <a class="indexterm" href= -"#makeindex-output-setpage-prefix">setpage_prefix -<string></a></dt> -<dt>setpage_suffix, <a class="indexterm" href= -"#makeindex-output-setpage-suffix">setpage_suffix -<string></a></dt> -<dt>suffix_2p, <a class="indexterm" href= -"#makeindex-output-suffix-2p">suffix_2p <string></a></dt> -<dt>suffix_3p, <a class="indexterm" href= -"#makeindex-output-suffix-3p">suffix_3p <string></a></dt> -<dt>suffix_mp, <a class="indexterm" href= -"#makeindex-output-suffix-mp">suffix_mp <string></a></dt> -<dt>symhead_negative, <a class="indexterm" href= -"#makeindex-output-symhead-negative">symhead_negative -<string></a></dt> -<dt>symhead_positive, <a class="indexterm" href= -"#makeindex-output-symhead-positive">symhead_positive -<string></a></dt> -</dl> -</dd> -<dt>Special Effects, <a class="indexterm" href= -"#makeindex-special-effects">Special Effects</a></dt> -<dt>Style File, <a class="indexterm" href= -"#makeindex-style-file">Style File</a></dt> -</dl> -</dd> -<dt>Making a title page, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Making paragraphs, <a class="indexterm" href= -"#making-paragraphs">Making Paragraphs</a></dt> -<dt>Margin Notes, <a class="indexterm" href="#margin-notes">Margin -Notes</a></dt> -<dt>Math Formulae, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>Math Functions, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -<dt>Math Miscellany, <a class="indexterm" href= -"#math-formulae">Math Formulae</a></dt> -<dt>Math mode, <a class="indexterm" href="#modes">Modes</a></dt> -<dt>Math mode, entering, <a class="indexterm" href= -"#math-formulae">Math Formulae</a></dt> -<dt>Math mode, spacing, <a class="indexterm" href= -"#math-formulae">Math Formulae</a></dt> -<dt>Math Symbols, Variable Size, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -<dt>mathpazo, <a class="indexterm" href= -"#mathpazo">mathpazo</a></dt> -<dt>Maths symbols, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>Metafont, <a class="indexterm" href="#metafont">Metafont -(tbd.)</a></dt> -<dt>MetaPost, <a class="indexterm" href= -"#metapost">MetaPost</a></dt> -<dd> -<dl> -<dt>Environment, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dd> -<dl> -<dt>MFINPUTS, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dt>MPEDIT, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dt>MPINPUTS, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dt>MPSUPPORT, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dt>MPXCOMMAND, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dt>TEX, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -<dt>TROFF, <a class="indexterm" href= -"#metapost-environment">Environment</a></dt> -</dl> -</dd> -<dt>Options, <a class="indexterm" href= -"#metapost-options">Options</a></dt> -<dd> -<dl> -<dt>--file-line-error-style, <a class="indexterm" href= -"#metapost-option-file-line-error-style">--file-line-error-style</a></dt> -<dt>--help, <a class="indexterm" href= -"#metapost-option-help">--help</a></dt> -<dt>--ini, <a class="indexterm" href= -"#metapost-option-ini">--ini</a></dt> -<dt>--interaction mode, <a class="indexterm" href= -"#metapost-option-intercation">--interaction mode</a></dt> -<dt>--jobname name, <a class="indexterm" href= -"#metapost-option-jobname">--jobname name</a></dt> -<dt>--kpathsea-debug bitmask, <a class="indexterm" href= -"#metapost-option-kpathsea-debug">--kpathsea-debug bitmask</a></dt> -<dt>--mem mem, <a class="indexterm" href= -"#metapost-option-mem">--mem mem</a></dt> -<dt>--parse-first-line, <a class="indexterm" href= -"#metapost-option-parse-first-line">--parse-first-line</a></dt> -<dt>--progname name, <a class="indexterm" href= -"#metapost-option-progname">--progname name</a></dt> -<dt>--recorder, <a class="indexterm" href= -"#metapost-option-recorder">--recorder</a></dt> -<dt>--translate-file tcxname, <a class="indexterm" href= -"#metapost-option-translate-file">--translate-file tcxname</a></dt> -<dt>--troff, <a class="indexterm" href= -"#metapost-option-troff">--troff</a></dt> -<dt>--version, <a class="indexterm" href= -"#metapost-option-version">--version</a></dt> -<dt>-T, <a class="indexterm" href="#metapost-option-T">-T</a></dt> -</dl> -</dd> -</dl> -</dd> -<dt>minipage, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Minipage, creating a, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Modes, <a class="indexterm" href="#modes">Modes</a></dt> -<dt>Multicolumn text, <a class="indexterm" href= -"#layout">Layout</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>N</h3> -<dl> -<dt>New line, starting, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>New line, starting (paragraph mode), <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>New Page, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Notes in the margin, <a class="indexterm" href= -"#margin-notes">Margin Notes</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>O</h3> -<dl> -<dt>Operators</dt> -<dd> -<dl> -<dt>Binary, <a class="indexterm" href="#special-symbols">Special -Symbols</a></dt> -<dt>Relational, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -</dl> -</dd> -<dt>Options, global, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>overcite.sty, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Overview of LaTeX, <a class="indexterm" 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 class="indexterm" href="#amsmath">amsmath</a></dt> -<dt>bm, <a class="indexterm" href="#bm-package">bm</a></dt> -<dt>bm.sty, <a class="indexterm" href="#bm-package">bm</a></dt> -<dt>dcolumn, <a class="indexterm" href="#dcolumn">dcolumn</a></dt> -<dt>german, <a class="indexterm" href="#german">german</a></dt> -<dt>graphics, <a class="indexterm" href= -"#graphics">graphics</a></dt> -<dt>hyperref, <a class="indexterm" href= -"#hyperref">hyperref</a></dt> -<dt>KOMA-Script, <a class="indexterm" href= -"#komascript">KOMA-Script</a></dt> -<dt>mathpazo, <a class="indexterm" href= -"#mathpazo">mathpazo</a></dt> -<dt>Several Small Packages, <a class="indexterm" href= -"#small-packages">Several Small Packages</a></dt> -<dt>url, <a class="indexterm" href="#url-package">url</a></dt> -<dt>varioref, <a class="indexterm" href= -"#varioref">varioref</a></dt> -</dl> -</dd> -<dt>Packages, loading, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Page break, forcing, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Page Breaking, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Page Formatting, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Page numbering, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>Page styles, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>Paragraph mode, <a class="indexterm" href= -"#modes">Modes</a></dt> -<dt>Paragraph, starting a new, <a class="indexterm" href= -"#making-paragraphs">Making Paragraphs</a></dt> -<dt>Paragraphs, <a class="indexterm" href= -"#making-paragraphs">Making Paragraphs</a></dt> -<dt>Parameters, <a class="indexterm" href= -"#parameters">Parameters</a></dt> -<dt>pdfTeX, <a class="indexterm" href="#pdftex">pdfTeX</a></dt> -<dd> -<dl> -<dt>Environment, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -<dd> -<dl> -<dt>TEXEDIT, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -<dt>TEXFONTS, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -<dt>TEXFORMATS, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -<dt>TEXINPUTS, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -<dt>TEXMFOUTPUT, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -<dt>TEXPOOL, <a class="indexterm" href= -"#pdftex-environment">Environment</a></dt> -</dl> -</dd> -<dt>Options, <a class="indexterm" href= -"#pdftex-options">Options</a></dt> -<dd> -<dl> -<dt>--file-line-error-style, <a class="indexterm" href= -"#pdftex-option-file-line-error-style">--file-line-error-style</a></dt> -<dt>--fmt format, <a class="indexterm" href= -"#pdftex-option-fmt">--fmt format</a></dt> -<dt>--help, <a class="indexterm" href= -"#pdftex-option-help">--help</a></dt> -<dt>--ini, <a class="indexterm" href= -"#pdftex-option-ini">--ini</a></dt> -<dt>--interaction mode, <a class="indexterm" href= -"#pdftex-option-interaction-mode">--interaction mode</a></dt> -<dt>--ipc, <a class="indexterm" href= -"#pdftex-option-ipc">--ipc</a></dt> -<dt>--ipc-start, <a class="indexterm" href= -"#pdftex-option-ipc-start">--ipc-start</a></dt> -<dt>--jobname name, <a class="indexterm" href= -"#pdftex-option-jobname-name">--jobname name</a></dt> -<dt>--kpathsea-debug bitmask, <a class="indexterm" href= -"#pdftex-option-kpathsea-debug">--kpathsea-debug bitmask</a></dt> -<dt>--maketex fmt, <a class="indexterm" href= -"#pdftex-option-maketex">--maketex fmt</a></dt> -<dt>--no-maketex fmt, <a class="indexterm" href= -"#pdftex-option-no-maketex">--no-maketex fmt</a></dt> -<dt>--output-comment string, <a class="indexterm" href= -"#pdftex-option-output-comment">--output-comment string</a></dt> -<dt>--parse-first-line, <a class="indexterm" href= -"#pdftex-option-parse-first-line">--parse-first-line</a></dt> -<dt>--progname name, <a class="indexterm" href= -"#pdftex-option-progname">--progname name</a></dt> -<dt>--recorder, <a class="indexterm" href= -"#pdftex-option-recorder">--recorder</a></dt> -<dt>--shell-escape, <a class="indexterm" href= -"#pdftex-option-shell-escape">--shell-escape</a></dt> -<dt>--translate-file tcxname, <a class="indexterm" href= -"#pdftex-option-translate-file">--translate-file tcxname</a></dt> -<dt>--version, <a class="indexterm" href= -"#pdftex-option-version">--version</a></dt> -<dt>[-no]-maketex=FMT, <a class="indexterm" href= -"#opt-latex-no-maketex">[-no]-maketex=FMT</a></dt> -</dl> -</dd> -</dl> -</dd> -<dt>People</dt> -<dd> -<dl> -<dt>Bausum, David, <a class="indexterm" href= -"#plaintex-ovw">Overview</a></dt> -<dt>Berry, Karl, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Borgert, Wolfgang, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Casellas, Ramon, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Danielsson, Holger, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Devenish, James, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Gaesslein, Hubert, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Goossens, Michel, <a class="indexterm" href= -"#overview">Overview of LaTeX and Local Guide</a></dt> -<dt>Hagen, Hans, <a class="indexterm" href="#context">ConTeXt -(tbd.)</a></dt> -<dt>Karp, Peter, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Lamport, Leslie, <a class="indexterm" href="#overview">Overview -of LaTeX and Local Guide</a></dt> -<dt>Mittelbach, Frank, <a class="indexterm" href= -"#overview">Overview of LaTeX and Local Guide</a></dt> -<dt>Niepraschk, Rolf, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Nordhaug, Hans Fredrik, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Pepping, Simon, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>Samarin, Alexander, <a class="indexterm" href= -"#overview">Overview of LaTeX and Local Guide</a></dt> -<dt>Stayton, Bob, <a class="indexterm" href= -"#credits">Credits</a></dt> -<dt>van Zandt, Timothy, <a class="indexterm" href= -"#pstricks-ovw">Overview</a></dt> -<dt>Voss, Herbert, <a class="indexterm" href= -"#credits">Credits</a></dt> -</dl> -</dd> -<dt>PiCTeX, <a class="indexterm" href="#pictex">PiCTeX -(tbd.)</a></dt> -<dt>picture, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Pictures, creating, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>PlainTeX, <a class="indexterm" href= -"#plaintex">PlainTeX</a></dt> -<dt>Poetry, an environment for, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Predefined lengths, <a class="indexterm" href= -"#lengths">Lengths</a></dt> -<dt>Programs, typesetting, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>PSTricks, <a class="indexterm" href= -"#pstricks">PSTricks</a></dt> -<dd> -<dl> -<dt>commands</dt> -<dd> -<dl> -<dt>\aput, <a class="indexterm" href= -"#pstricks-attaching">Attaching labels to node connections</a></dt> -<dt>\Aput, <a class="indexterm" href= -"#pstricks-attaching">Attaching labels to node connections</a></dt> -<dt>\arrows, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\bput, <a class="indexterm" href= -"#pstricks-attaching">Attaching labels to node connections</a></dt> -<dt>\Bput, <a class="indexterm" href= -"#pstricks-attaching">Attaching labels to node connections</a></dt> -<dt>\circlenode, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\clipbox, <a class="indexterm" href= -"#pstricks-clipping">Clipping</a></dt> -<dt>\closedshadow, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\closepath, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\cnode, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\cnodeput, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\code, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\coor, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\cput, <a class="indexterm" href="#pstricks-framed">Framed -boxes</a></dt> -<dt>\curveto, <a class="indexterm" href= -"#pretty-safe-tricks">Pretty safe tricks</a></dt> -<dt>\dataplot, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\degrees, <a class="indexterm" href= -"#pstricks-dimensions">Dimensions, coordinates and angles</a></dt> -<dt>\dim, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\endpspicture, <a class="indexterm" href= -"#pictures">Pictures</a></dt> -<dt>\everypsbox, <a class="indexterm" href= -"#pstricks-boxes">Boxes</a></dt> -<dt>\file, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\fileplot, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\fill, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\grestore, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\gsave, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\lineto, <a class="indexterm" href="#pretty-safe-tricks">Pretty -safe tricks</a></dt> -<dt>\listplot, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\lput, <a class="indexterm" href= -"#pstricks-attaching">Attaching labels to node connections</a></dt> -<dt>\movepath, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\moveto, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\mput, <a class="indexterm" href= -"#pstricks-attaching">Attaching labels to node connections</a></dt> -<dt>\mrestore, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\msave, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\multips, <a class="indexterm" href= -"#pstricks-repetition">Repetition</a></dt> -<dt>\multirput, <a class="indexterm" href= -"#pstricks-repetition">Repetition</a></dt> -<dt>\ncangle, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\ncangles, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\ncarc, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\ncbar, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\nccircle, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\nccoil, <a class="indexterm" href="#pstricks-coils">Coils and -zigzags</a></dt> -<dt>\nccurve, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\ncdiag, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\ncdiagg, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\ncline, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\ncLine, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\ncloop, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\nczigzag, <a class="indexterm" href="#pstricks-coils">Coils -and zigzags</a></dt> -<dt>\newcmykcolor, <a class="indexterm" href= -"#pstricks-color">Color</a></dt> -<dt>\newgray, <a class="indexterm" href= -"#pstricks-color">Color</a></dt> -<dt>\newhsbcolor, <a class="indexterm" href= -"#pstricks-color">Color</a></dt> -<dt>\newpath, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\newpsobject, <a class="indexterm" href= -"#pstricks-custom">Custom styles</a></dt> -<dt>\newpsstyle, <a class="indexterm" href= -"#pstricks-custom">Custom styles</a></dt> -<dt>\newrgbcolor, <a class="indexterm" href= -"#pstricks-color">Color</a></dt> -<dt>\NormalCoor, <a class="indexterm" href= -"#pstricks-coordinates">Special coordinates</a></dt> -<dt>\openshadow, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\ovalnode, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\overlaybox, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>\parabola, <a class="indexterm" href= -"#pstricks-curves">Curves</a></dt> -<dt>\parametricplot, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\pcangle, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\pcarc, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\pcbar, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\pccoil, <a class="indexterm" href="#pstricks-coils">Coils and -zigzags</a></dt> -<dt>\pccurve, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>\pcdiag, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\pcline, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\pcloop, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>\pczigzag, <a class="indexterm" href="#pstricks-coils">Coils -and zigzags</a></dt> -<dt>\pnode, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\psarc, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>\psarcn, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>\psaxes, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>\psbezier, <a class="indexterm" href= -"#pstricks-curves">Curves</a></dt> -<dt>\psccurve, <a class="indexterm" href= -"#pstricks-curves">Curves</a></dt> -<dt>\pscharclip, <a class="indexterm" href= -"#pstricks-stroking">Stroking and filling character paths</a></dt> -<dt>\pscharpath, <a class="indexterm" href= -"#pstricks-stroking">Stroking and filling character paths</a></dt> -<dt>\pscircle, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>\pscirclebox, <a class="indexterm" href= -"#pstricks-framed">Framed boxes</a></dt> -<dt>\psclip, <a class="indexterm" href= -"#pstricks-clipping">Clipping</a></dt> -<dt>\pscoil, <a class="indexterm" href="#pstricks-coils">Coils and -zigzags</a></dt> -<dt>\psCoil, <a class="indexterm" href="#pstricks-coils">Coils and -zigzags</a></dt> -<dt>\pscurve, <a class="indexterm" href= -"#pstricks-curves">Curves</a></dt> -<dt>\pscustom, <a class="indexterm" href="#pstricks-basics">The -basics</a></dt> -<dt>\psdblframebox, <a class="indexterm" href= -"#pstricks-framed">Framed boxes</a></dt> -<dt>\psdots, <a class="indexterm" href= -"#pstricks-dots">Dots</a></dt> -<dt>\psecurve, <a class="indexterm" href= -"#pstricks-curves">Curves</a></dt> -<dt>\psellipse, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>\psframe, <a class="indexterm" href="#pstricks-lines">Lines and -polygons</a></dt> -<dt>\psframebox, <a class="indexterm" href= -"#pstricks-framed">Framed boxes</a></dt> -<dt>\psgrid, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>\pslabelsep, <a class="indexterm" href="#placing">Placing and -rotating whatever</a></dt> -<dt>\pslbrace, <a class="indexterm" href="#pstricks-tricks">Tips -and More Tricks</a></dt> -<dt>\psline, <a class="indexterm" href="#pstricks-lines">Lines and -polygons</a></dt> -<dt>\pslongbox, <a class="indexterm" href= -"#pstricks-boxes">Boxes</a></dt> -<dt>\psmathboxfalse, <a class="indexterm" href= -"#pstricks-boxes">Boxes</a></dt> -<dt>\psmathboxtrue, <a class="indexterm" href= -"#pstricks-boxes">Boxes</a></dt> -<dt>\psovalbox, <a class="indexterm" href="#pstricks-framed">Framed -boxes</a></dt> -<dt>\psoverlay, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>\pspicture, <a class="indexterm" href= -"#pictures">Pictures</a></dt> -<dt>\psplot, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\pspolygon, <a class="indexterm" href="#pstricks-lines">Lines -and polygons</a></dt> -<dt>\psrbrace, <a class="indexterm" href="#pstricks-tricks">Tips -and More Tricks</a></dt> -<dt>\psset, <a class="indexterm" href="#pstricks-setting">Setting -graphics parameters</a></dt> -<dt>\pssetlength, <a class="indexterm" href= -"#pstricks-dimensions">Dimensions, coordinates and angles</a></dt> -<dt>\psshadowbox, <a class="indexterm" href= -"#pstricks-framed">Framed boxes</a></dt> -<dt>\pstextpath, <a class="indexterm" href= -"#pstricks-path">Typesetting text along a path</a></dt> -<dt>\PSTtoEPS, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>\psverbboxfalse, <a class="indexterm" href= -"#pstricks-boxes">Boxes</a></dt> -<dt>\psverbboxtrue, <a class="indexterm" href= -"#pstricks-boxes">Boxes</a></dt> -<dt>\pswedge, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>\psxlabel, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>\psylabel, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>\pszigzag, <a class="indexterm" href="#pstricks-coils">Coils -and zigzags</a></dt> -<dt>\putoverlaybox, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>\qline, <a class="indexterm" href="#pstricks-lines">Lines and -polygons</a></dt> -<dt>\radians, <a class="indexterm" href= -"#pstricks-dimensions">Dimensions, coordinates and angles</a></dt> -<dt>\rcoor, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\rcurveto, <a class="indexterm" href= -"#pretty-safe-tricks">Pretty safe tricks</a></dt> -<dt>\readdata, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\rlineto, <a class="indexterm" href= -"#pretty-safe-tricks">Pretty safe tricks</a></dt> -<dt>\rnode, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\Rnode, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\RnodeRef, <a class="indexterm" href= -"#pstricks-nodes">Nodes</a></dt> -<dt>\rotate, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\rotatedown, <a class="indexterm" href= -"#pstricks-rotation">Rotation and scaling boxes</a></dt> -<dt>\rotateleft, <a class="indexterm" href= -"#pstricks-rotation">Rotation and scaling boxes</a></dt> -<dt>\rotateright, <a class="indexterm" href= -"#pstricks-rotation">Rotation and scaling boxes</a></dt> -<dt>\rput, <a class="indexterm" href="#placing">Placing and -rotating whatever</a></dt> -<dt>\savedata, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>\scale, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\scalebox, <a class="indexterm" href= -"#pstricks-rotation">Rotation and scaling boxes</a></dt> -<dt>\scaleboxto, <a class="indexterm" href= -"#pstricks-rotation">Rotation and scaling boxes</a></dt> -<dt>\setcolor, <a class="indexterm" href="#hackers">For hackers -only</a></dt> -<dt>\SpecialCoor, <a class="indexterm" href= -"#pstricks-coordinates">Special coordinates</a></dt> -<dt>\stroke, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\swapaxes, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\TeXtoEPS, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>\translate, <a class="indexterm" href="#safe-tricks">Safe -tricks</a></dt> -<dt>\uput, <a class="indexterm" href="#placing">Placing and -rotating whatever</a></dt> -</dl> -</dd> -<dt>parameter</dt> -<dd> -<dl> -<dt>angle, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>arcangle, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>arcsep, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>arcsepA, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>arcsepB, <a class="indexterm" href="#pstricks-arcs">Arcs, -circles and ellipses</a></dt> -<dt>arm, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>arrowinset, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>arrowlength, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>arrows, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>arrowscale, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>arrowsize, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>axesstyle, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>bbllx, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>bblly, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>bburx, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>bbury, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>border, <a class="indexterm" href="#pstricks-line-styles">Line -styles</a></dt> -<dt>bordercolor, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>boxsep, <a class="indexterm" href="#pstricks-framed">Framed -boxes</a></dt> -<dt>bracketlength, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>coilheight, <a class="indexterm" href="#pstricks-coils">Coils -and zigzags</a></dt> -<dt>coilinc, <a class="indexterm" href="#pstricks-coils">Coils and -zigzags</a></dt> -<dt>coilwidth, <a class="indexterm" href="#pstricks-coils">Coils -and zigzags</a></dt> -<dt>cornersize, <a class="indexterm" href="#pstricks-lines">Lines -and polygons</a></dt> -<dt>curvature, <a class="indexterm" href= -"#pstricks-curves">Curves</a></dt> -<dt>dash, <a class="indexterm" href="#pstricks-line-styles">Line -styles</a></dt> -<dt>dimen, <a class="indexterm" href="#pstricks-line-styles">Line -styles</a></dt> -<dt>dotangle, <a class="indexterm" href= -"#pstricks-dots">Dots</a></dt> -<dt>dotscale, <a class="indexterm" href= -"#pstricks-dots">Dots</a></dt> -<dt>dotsep, <a class="indexterm" href="#pstricks-line-styles">Line -styles</a></dt> -<dt>dotsize, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>dotstyle, <a class="indexterm" href= -"#pstricks-dots">Dots</a></dt> -<dt>doublecolor, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>doubleline, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>doublesep, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>fillcolor, <a class="indexterm" href= -"#pstricks-fill-styles">Fill styles</a></dt> -<dt>fillstyle, <a class="indexterm" href= -"#pstricks-fill-styles">Fill styles</a></dt> -<dt>framearc, <a class="indexterm" href="#pstricks-lines">Lines and -polygons</a></dt> -<dt>framesep, <a class="indexterm" href="#pstricks-framed">Framed -boxes</a></dt> -<dt>gradangle, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>gradbegin, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>gradend, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>gradlines, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>gradmidpoint, <a class="indexterm" href= -"#pstricks-overlays">Overlays</a></dt> -<dt>gridcolor, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>griddots, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>gridlabelcolor, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>gridlabels, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>gridwidth, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>hatchangle, <a class="indexterm" href= -"#pstricks-fill-styles">Fill styles</a></dt> -<dt>hatchcolor, <a class="indexterm" href= -"#pstricks-fill-styles">Fill styles</a></dt> -<dt>hatchsep, <a class="indexterm" href= -"#pstricks-fill-styles">Fill styles</a></dt> -<dt>hatchwidth, <a class="indexterm" href= -"#pstricks-fill-styles">Fill styles</a></dt> -<dt>headerfile, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>headers, <a class="indexterm" href= -"#pstricks-exporting">Exporting EPS files</a></dt> -<dt>labels, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>labelsep, <a class="indexterm" href="#placing">Placing and -rotating whatever</a></dt> -<dt>liftpen, <a class="indexterm" href= -"#pstricks-graphics-objects">Graphics objects</a></dt> -<dt>linearc, <a class="indexterm" href="#pstricks-lines">Lines and -polygons</a></dt> -<dt>linecolor, <a class="indexterm" href="#pstricks-basic">Basic -graphics parameters</a></dt> -<dt>linestyle, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>linetype, <a class="indexterm" href= -"#pstricks-parameters">Parameters</a></dt> -<dt>linewidth, <a class="indexterm" href="#pstricks-basic">Basic -graphics parameters</a></dt> -<dt>loopsize, <a class="indexterm" href= -"#pstricks-connections">Node connections</a></dt> -<dt>ncurv, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>nodesep, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>offset, <a class="indexterm" href="#pstricks-connections">Node -connections</a></dt> -<dt>origin, <a class="indexterm" href= -"#pstricks-coordinate">Coordinate systems</a></dt> -<dt>plotpoints, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>plotstyle, <a class="indexterm" href= -"#pstricks-plots">Plots</a></dt> -<dt>rbracketlength, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>runit, <a class="indexterm" href= -"#pstricks-dimensions">Dimensions, coordinates and angles</a></dt> -<dt>shadow, <a class="indexterm" href="#pstricks-line-styles">Line -styles</a></dt> -<dt>shadowangle, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>shadowcolor, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>shadowsize, <a class="indexterm" href= -"#pstricks-line-styles">Line styles</a></dt> -<dt>showorigin, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>showpoints, <a class="indexterm" href="#pstricks-basic">Basic -graphics parameters</a></dt> -<dt>subgriddots, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>subgridwidth, <a class="indexterm" href= -"#pstricks-grids">Grids</a></dt> -<dt>swapaxes, <a class="indexterm" href= -"#pstricks-coordinate">Coordinate systems</a></dt> -<dt>tbarsize, <a class="indexterm" href= -"#pstricks-arrowheads">Arrowheads and such</a></dt> -<dt>ticks, <a class="indexterm" href="#pstricks-axes">Axes</a></dt> -<dt>ticksize, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>tickstyle, <a class="indexterm" href= -"#pstricks-axes">Axes</a></dt> -<dt>unit, <a class="indexterm" href= -"#pstricks-dimensions">Dimensions, coordinates and angles</a></dt> -<dt>xunit, <a class="indexterm" href= -"#pstricks-dimensions">Dimensions, coordinates and angles</a></dt> -<dt>yunit, <a class="indexterm" 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 class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>quote, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Quoted text with paragraph indentation, displaying, <a class= -"indexterm" href="#env-latex">Environments</a></dt> -<dt>Quoted text, displaying, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>R</h3> -<dl> -<dt>Ragged left text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Ragged left text, environment for, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Ragged right text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Ragged right text, environment for, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Relational Operators, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -<dt>Remarks in the margin, <a class="indexterm" href= -"#margin-notes">Margin Notes</a></dt> -<dt>report class, <a class="indexterm" href= -"#document-classes">Document Classes</a></dt> -<dt>Reserved Characters, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>Right-justifying text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Right-justifying text, environment for, <a class="indexterm" -href="#env-latex">Environments</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>S</h3> -<dl> -<dt>Sectioning, <a class="indexterm" href= -"#sectioning">Sectioning</a></dt> -<dt>Several Small Packages, <a class="indexterm" href= -"#small-packages">Several Small Packages</a></dt> -<dt>Simulating typed text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Sizes of text, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Small Packages, <a class="indexterm" href= -"#small-packages">Several Small Packages</a></dt> -<dt>Space, inserting vertical, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -<dt>Spaces, <a class="indexterm" href="#spaces-and-boxes">Spaces -& Boxes</a></dt> -<dt>Spacing, within Math mode, <a class="indexterm" href= -"#math-formulae">Math Formulae</a></dt> -<dt>Special Characters, <a class="indexterm" href= -"#special-characters">Special Characters</a></dt> -<dt>Splitting the input file, <a class="indexterm" href= -"#splitting-the-input">Splitting the Input</a></dt> -<dt>Starting & Ending, <a class="indexterm" href= -"#starting-and-ending">Starting & Ending</a></dt> -<dt>Starting on a right-hand page, <a class="indexterm" href= -"#line-and-page-breaking">Line & Page Breaking</a></dt> -<dt>Styles of text, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Styles, page, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>Subscript, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>Superscript, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dt>Symbols, <a class="indexterm" href="#math-formulae">Math -Formulae</a></dt> -<dd> -<dl> -<dt>Miscellaneous, <a class="indexterm" href= -"#special-symbols">Special Symbols</a></dt> -<dt>Special, <a class="indexterm" href="#special-symbols">Special -Symbols</a></dt> -</dl> -</dd> -</dl> -</div> -<div class="indexdiv"> -<h3>T</h3> -<dl> -<dt>Tab stops, using, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>tabbing, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>table, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Table of Contents, creating, <a class="indexterm" href= -"#table-of-contents">Table of Contents</a></dt> -<dt>Tables, creating, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>tabular, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Terminal Input/Output, <a class="indexterm" href= -"#terminal-input-slash-output">Terminal Input/Output</a></dt> -<dt>Texinfo, <a class="indexterm" href="#texinfo">Texinfo -(tbd.)</a></dt> -<dt>Thanks, for titlepage, <a class="indexterm" href= -"#page-styles">Page Styles</a></dt> -<dt>thebibliography, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>theorem, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Theorems, defining, <a class="indexterm" href= -"#definitions">Definitions</a></dt> -<dt>Theorems, typesetting, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Title making, <a class="indexterm" href="#page-styles">Page -Styles</a></dt> -<dt>Title pages, creating, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Title, for titlepage, <a class="indexterm" href= -"#page-styles">Page Styles</a></dt> -<dt>titlepage, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Typed text, simulating, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Typeface Sizes, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Typeface Styles, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -<dt>Typefaces, <a class="indexterm" href= -"#typefaces">Typefaces</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>U</h3> -<dl> -<dt>url, <a class="indexterm" href="#url-package">url</a></dt> -<dt>Using BibTeX, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>V</h3> -<dl> -<dt>Variables, a list of, <a class="indexterm" href= -"#counters">Counters</a></dt> -<dt>varioref, <a class="indexterm" href= -"#varioref">varioref</a></dt> -<dt>verbatim, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Verbatim text, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>verse, <a class="indexterm" href= -"#env-latex">Environments</a></dt> -<dt>Vertical space, inserting, <a class="indexterm" href= -"#spaces-and-boxes">Spaces & Boxes</a></dt> -</dl> -</div> -<div class="indexdiv"> -<h3>X</h3> -<dl> -<dt>xindy, <a class="indexterm" href="#xindy">xindy</a></dt> -<dd> -<dl> -<dt>Command List, <a class="indexterm" href= -"#xindy-command-list">Command List</a></dt> -<dd> -<dl> -<dt>Markup Commands, <a class="indexterm" href= -"#xindy-command-list-markup">Markup Commands</a></dt> -<dt>Raw Index Interface, <a class="indexterm" href= -"#xindy-command-list-raw-index">Raw Index Interface</a></dt> -</dl> -</dd> -<dt>Invoking, <a class="indexterm" href="#xindy-invoking">Invoking -xindy</a></dt> -<dd> -<dl> -<dt>Command Line Options, <a class="indexterm" href= -"#xindy-invoking-cmdline">Command Line Options</a></dt> -<dt>Search Path, <a class="indexterm" href= -"#xindy-search-path">Search Path</a></dt> -</dl> -</dd> -<dt>Processing Commands, <a class="indexterm" href= -"#xindy-command-list-processing">Processing Commands</a></dt> -<dd> -<dl> -<dt>define-alphabet, <a class="indexterm" href= -"#xindy-command-list-processing-define-alphabet">define-alphabet</a></dt> -<dt>define-attributes, <a class="indexterm" href= -"#xindy-command-list-processing-define-attributes">define-attributes</a></dt> -<dt>define-crossref-class, <a class="indexterm" href= -"#xindy-command-list-processing-define-crossref-class">define-crossref-class</a></dt> -<dt>define-letter-group, <a class="indexterm" href= -"#xindy-command-list-processing-define-letter-group">define-letter-group</a></dt> -<dt>define-location-class, <a class="indexterm" href= -"#xindy-command-list-processing-define-location-class">define-location-class</a></dt> -<dt>define-location-class-order, <a class="indexterm" href= -"#xindy-command-list-processing-define-location-class-order">define-location-class-order</a></dt> -<dt>define-rule-set, <a class="indexterm" href= -"#xindy-command-list-processing-define-rule-set">define-rule-set</a></dt> -<dt>define-sort-rule-orientations, <a class="indexterm" href= -"#xindy-command-list-processing-define-sort-rule-orientations">define-sort-rule-orientations</a></dt> -<dt>merge-rule, <a class="indexterm" href= -"#xindy-command-list-processing-merge-rule">merge-rule</a></dt> -<dt>merge-to, <a class="indexterm" href= -"#xindy-command-list-processing-merge-to">merge-to</a></dt> -<dt>require, <a class="indexterm" href= -"#xindy-command-list-processing-require">require</a></dt> -<dt>searchpath, <a class="indexterm" href= -"#xindy-command-list-processing-searchpath">searchpath</a></dt> -<dt>sort-rule, <a class="indexterm" href= -"#xindy-command-list-processing-sort-rule">sort-rule</a></dt> -<dt>use-rule-set, <a class="indexterm" 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> diff --git a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.txt b/Master/texmf-dist/doc/generic/tex-refs/tex-refs.txt deleted file mode 100644 index 2aa806cb0b6..00000000000 --- a/Master/texmf-dist/doc/generic/tex-refs/tex-refs.txt +++ /dev/null @@ -1,8776 +0,0 @@ -References for TeX and Friends - -Michael Wiedmann - - <mw at miwie dot in-berlin dot de> - - Copyright © ? Stephen Gilmore - - Copyright © ? Torsten Martinsen - - Copyright © 1988, 1994 Free Software Foundation, Inc. - - Copyright © 1994 - 1996 Torsten Martinsen - - Copyright © 2002, 2003 Peter Karp, Michael Wiedmann - - Copyright © 2004 - 2012 Michael Wiedmann - - License - - 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. - Revision History - Revision 0.4.1 2012-12-03 - Removed obsolete file still referenced in Makefile (no visible - changes) - Revision 0.2.0 2003-01-11 - License changed to GNU Free Documentation License. - Revision 0.0.1 2002-06-21 - This version was adapted from the edition 1.6 of the LaTeX2e - documentation, converted to DocBook XML using texi2db, and - further edited manually. - __________________________________________________________ - - Table of Contents - - Preface - Credits - 1 TeX - - 1 PlainTeX - - 1.1 Overview - - 2 LaTeX - - 2.1 Options - 2.2 Overview of LaTeX and Local Guide - 2.3 Commands - 2.4 Parameters - - 3 LaTeX Packages - - 3.1 amsmath - 3.2 dcolumn - 3.3 float - 3.4 fontenc - 3.5 german - 3.6 graphics - 3.7 hyperref - 3.8 inputenc - 3.9 KOMA-Script - 3.10 mathpazo - 3.11 varioref - 3.12 Several Small Packages - - 4 Generic Packages - - 4.1 PiCTeX (tbd.) - 4.2 PSTricks - - 5 fontinst (tbd.) - 6 ConTeXt (tbd.) - - 6.1 Overview - - 7 Texinfo (tbd.) - - 2 pdfTeX - - 1 Options - - 1.1 --file-line-error-style - 1.2 --fmt format - 1.3 --help - 1.4 --ini - 1.5 --interaction mode - 1.6 --ipc - 1.7 --ipc-start - 1.8 --jobname name - 1.9 --kpathsea-debug bitmask - 1.10 --maketex fmt - 1.11 --no-maketex fmt - 1.12 --output-comment string - 1.13 --parse-first-line - 1.14 --progname name - 1.15 --recorder - 1.16 --shell-escape - 1.17 --translate-file tcxname - 1.18 --version - - 2 Environment - - 3 Metafont (tbd.) - 4 MetaPost - - 1 Options - - 1.1 --file-line-error-style - 1.2 --help - 1.3 --ini - 1.4 --interaction mode - 1.5 --jobname name - 1.6 --kpathsea-debug bitmask - 1.7 --mem mem - 1.8 --parse-first-line - 1.9 --progname name - 1.10 --recorder - 1.11 -T - 1.12 --translate-file tcxname - 1.13 --troff - 1.14 --version - - 2 Environment - - 5 BibTeX - - 1 Parameters - 2 Command Qualifiers - 3 bib files - - 3.1 @STRING command - 3.2 Entry Format - 3.3 Entry Types - 3.4 Field Text - 3.5 Field Types - - 4 bst files - - 4.1 ABBRV.BST - 4.2 ALPHA.BST - 4.3 PLAIN.BST - 4.4 SAMPLE.BST - 4.5 UNSRT.BST - - 6 Make-Index - - 1 Options - - 1.1 -c - 1.2 -g - 1.3 -i - 1.4 -l - 1.5 -q - 1.6 -r - 1.7 -s sty - 1.8 -o ind - 1.9 -t log - 1.10 -p no - 1.11 -L - 1.12 -T - - 2 Style File - - 2.1 Input Style Specifiers - 2.2 Output Style Specifiers - - 3 Example - 4 Ordering - 5 Special Effects - - 7 xindy - - 1 Command List - - 1.1 Processing Commands - 1.2 Markup Commands - 1.3 Raw Index Interface - - 2 Invoking xindy - - 2.1 Command Line Options - 2.2 Search Path - - A Appendices - - 1 Bugs / Known Issues / Missing Features - 2 About this Document - 3 Release News - 4 GNU Free Documentation License - Index - - List of Tables - - 1.1 Options for \newcommand - 1.2 Options for \newenvironment - 1.3 Options for \newtheorem - 1.4 Commands in a tabbing environment - 1.5 Commands used inside a tabular environment - 1.6 Standard styles distributed with BibTeX - 1.7 Three environments that put LaTeX in math mode - 1.8 Math Miscellany - 1.9 Typefaces - 1.10 Standard type size commands - 1.11 Low-level font commands - 1.12 Special coordinates and angles - -Preface - - LaTeX2e is a document preparation system implemented as a macro - package for Donald E. Knuth's TeX typesetting program. - - LaTeX was originally conceived by Leslie Lamport. - - 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. - - TUG (TeX User Group) and DANTE (German TeX User Group) 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. - - 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. - - The authors intend to extend this documentation to other TeX - related packages (e.g. ConTeXt, MetaPost, Metafont, etc.). - Contributions are very welcome! - -Credits - - The following people have contributed substantial parts to this - documentation project or helped in some other way (listed - alphabetically): - * Karl Berry - * Wolfgang Borgert - * Ramon Casellas - * Holger Danielsson - * James Devenish - * Hubert Gaesslein - * Peter Karp - * Rolf Niepraschk - * Hans Fredrik Nordhaug - * Simon Pepping - * Bob Stayton - * Herbert Voss - -Chapter 1. TeX - - Table of Contents - - 1 PlainTeX - - 1.1 Overview - - 2 LaTeX - - 2.1 Options - 2.2 Overview of LaTeX and Local Guide - 2.3 Commands - 2.4 Parameters - - 3 LaTeX Packages - - 3.1 amsmath - 3.2 dcolumn - 3.3 float - 3.4 fontenc - 3.5 german - 3.6 graphics - 3.7 hyperref - 3.8 inputenc - 3.9 KOMA-Script - 3.10 mathpazo - 3.11 varioref - 3.12 Several Small Packages - - 4 Generic Packages - - 4.1 PiCTeX (tbd.) - 4.2 PSTricks - - 5 fontinst (tbd.) - 6 ConTeXt (tbd.) - - 6.1 Overview - - 7 Texinfo (tbd.) - -1 PlainTeX - -1.1 Overview - - For a really excellent reference of all TeX primitive control - sequences see David Bausum's TeX Primitive Control Sequences. - -2 LaTeX - -Note - - The original file latex2e.texi contains the following copyright - and permission notice: - - “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.” - - “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.” - -2.1 Options - - LaTeX understands the following command line options. - -2.1.1 -file-line-error-style - - Print error messages in the form file:line:error. - -2.1.2 -fmt=FMTNAME - - Use FMTMAME instead of program name or a %& line. - -2.1.3 -ini - - Be initex, for dumping formats; this is implicitly true if the - program is called as initex. - -2.1.4 -interaction=STRING - - Set interaction mode - (STRING=batchmode/nonstopmode/scrollmode/errorstopmode). - -2.1.5 -ipc - - Send DVI output to a socket as well as the usual output file. - - Note: not available on all systems. - -2.1.6 -ipc-start - - As -ipc, and also start the server at the other end. - - Note: not available on all systems. - -2.1.7 -jobname=STRING - - Set the job name to STRING. - -2.1.8 -kpathsea-debug=NUMBER - - Sets path searching debugging flags according to the bits of - NUMBER. - -2.1.9 [-no]-maketex=FMT - - Disable/enable mktexFMT generation (FMT=tex/tfm). - -2.1.10 -mltex - - Enable MLTeX extensions such as \charsubdef. - -2.1.11 -output-comment=STRING - - use STRING for DVI file comment instead of date. - -2.1.12 -parse-first-line - - Parse of the first line of the input file. - -2.1.13 -progname=STRING - - Set program (and fmt) name to STRING. - -2.1.14 -recorder - - Enable filename recorder. - -2.1.15 -shell-escape - - Enable \write18{SHELL COMMAND}. - -2.1.16 -src-specials - - Insert source specials into the DVI file. - -2.1.17 -src-specials=WHERE - - Insert source specials in certain places of the DVI file. WHERE - is a comma-separated value list: cr display hbox math par - parend vbox. - -2.1.18 -translate-file=TCXNAME - - Use the TCX file TCXNAME. - -2.1.19 -help - - Display this help and exit. - -2.1.20 -version - - Output version information and exit. - -2.2 Overview of LaTeX and Local Guide - - 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: - 1. A Device Independent, or .dvi 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 xdvi, which actually uses the .dvi file. - 2. A transcript or .log file that contains summary information - and diagnostic messages for any errors discovered in the - input file. - 3. An auxiliary or .aux file. This is used by LaTeX itself, - for things such as sectioning. - - For a description of what goes on inside TeX, you should - consult The TeXbook by Donald E. Knuth, ISBN 0-201-13448-9, - published jointly by the American Mathematical Society and - Addison-Wesley Publishing Company. - - For a description of LaTeX, you should consult: - - LaTeX: A Document Preparation System, by Leslie Lamport, - Addison-Wesley Publishing Company, 2nd edition, 1994. - - The LaTeX Companion, by Michel Goossens, Frank Mittelbach, and - Alexander Samarin, Addison-Wesley, 1994. - -2.3 Commands - - A LaTeX command begins with the command name, which consists of - a \ followed by either (a) a string of letters or (b) a single - non-letter. Arguments contained in square brackets, [], are - optional while arguments contained in braces, {}, are required. - - NOTE: LaTeX is case sensitive. Enter all commands in lower case - unless explicitly directed to do otherwise. - -2.3.1 Counters - - 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 - \ (enumi - enumiv are used for the nested enumerate - environment). Below is a list of the counters used in LaTeX's - standard document classes to control numbering. -part paragraph figure enumi -chapter subparagraph table enumii -section page footnote enumiii -subsection equation mpfootnote enumiv -subsubsection - -\addtocounter - - The \addtocounter command increments the counter by the amount - specified by the value argument. The value argument can be - negative. - -\alph{counter} - - This command causes the value of the counter to be printed in - alphabetic characters. The \alph command uses lower case - alphabetic alphabetic characters, i.e., a, b, c... while the - \Alph command uses upper case alphabetic characters, i.e., A, - B, C.... - -\arabic{counter} - - The \arabic command causes the value of the counter to be - printed in Arabic numbers, i.e., 3. - -\fnsymbol{counter} - - The \fnsymbol command causes the value of the counter to be - printed in a specific sequence of nine symbols that can be used - for numbering footnotes. - - NB. counter must have a value between 1 and 9 inclusive. - -\newcounter{foo}[counter] - - The \newcounter command defines a new counter named foo. The - counter is initialized to zero. - - The optional argument [counter] causes the counter foo to be - reset whenever the counter named in the optional argument is - incremented. - -\refstepcounter{counter} - - The \refstepcounter command works like \stepcounter. See - \stepcounter, except it also defines the current \ref value to - be the result of \thecounter. - -\roman{counter} - - This command causes the value of the counter to be printed in - Roman numerals. The \roman command uses lower case Roman - numerals, i.e., i, ii, iii..., while the \Roman command uses - upper case Roman numerals, i.e., I, II, III.... - -\stepcounter{counter} - - The \stepcounter command adds one to the counter and resets all - subsidiary counters. - -\setcounter{counter}{value} - - The \setcounter command sets the value of the counter to that - specified by the value argument. - -\usecounter{counter} - - The \usecounter command is used in the second argument of the - list environment to allow the counter specified to be used to - number the list items. - -\value{counter} - - The \value command produces the value of the counter named in - the mandatory argument. It can be used where LaTeX expects an - integer or number, such as the second argument of a \setcounter - or \addtocounter command, or in: -\hspace{\value{foo}\parindent} - - It is useful for doing arithmetic with counters. - -2.3.2 Cross References - - One reason for numbering things like figures and equations is - to refer the reader to them, as in See Figure 3 for more - details. A smarter version of the cross reference commands is - available in the package varioref. - -\label{key} - - A \label command appearing in ordinary text assigns to the key - the number of the current sectional unit; one appearing inside - a numbered environment assigns that number to the key. - - A key can consist of any sequence of letters, digits, or - punctuation characters. Upper and lowercase letters are - different. - - 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 - * cha for chapters - * sec for lower-level sectioning commands - * fig for figures - * tab for tables - * eq for equations - - Thus, a label for a figure would look like fig:bandersnatch. - -\pageref{key} - - The \pageref command produces the page number of the place in - the text where the corresponding \label command appears. ie. - where \label{key} appears. For a smart version see \vpageref. - -\ref{key} - - The \ref command produces the number of the sectional unit, - equation number, ... of the corresponding \label command. For a - smart version see \vref. - -2.3.3 Definitions - -\newcommand - -\newcommand{cmd}[args]{definition} -\newcommand{cmd}[args][default]{definition} -\renewcommand{cmd}[args]{definition} -\renewcommand{cmd}[args][default]{definition} - - These commands define (or redefine) a command. - - Table 1.1. Options for \newcommand - cmd A command name beginning with a \. For \newcommand it must - not be already defined and must not begin with \end; for - \renewcommand it must already be defined. - args 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. - def If this optional parameter is present, it means that the - command's first argument is optional. The default value of the - optional argument is def. - definition The text to be substituted for every occurrence of - cmd; a parameter of the form #n in cmd is replaced by the text - of the nth argument when this substitution takes place. - -\newenvironment - -\newenvironment{nam}[args]{begdef}{enddef} -\newenvironment{nam}[args][default]{begdef}{enddef} -\renewenvironment{nam}[args]{begdef}{enddef} - - These commands define or redefine an environment. - - Table 1.2. Options for \newenvironment - nam The name of the environment. For \newenvironment there must - be no currently defined environment by that name, and the - command \nam must be undefined. For \renewenvironment the - environment must already be defined. - args 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 {begdef} part. - default If this is specified, the first argument is optional, - and default gives the default value for that argument. - begdef The text substituted for every occurrence of - \begin{nam}; a parameter of the form #n in cmd is replaced by - the text of the nth argument when this substitution takes - place. - enddef The text substituted for every occurrence of \end{nam}. - It may not contain any argument parameters. - -\newtheorem - -\newtheorem{env_name}{caption}[within] -\newtheorem{env_name}[numbered_like]{caption} - - This command defines a theorem-like environment. - - Table 1.3. Options for \newtheorem - env_name The name of the environment to be defined. A string of - letters. It must not be the name of an existing environment or - counter. - caption The text printed at the beginning of the environment, - right before the number. This may simply say Theorem, for - example. - within The name of an already defined counter, usually of a - sectional unit. Provides a means of resetting the new theorem - counter within the sectional unit. - numbered_like The name of an already defined theorem-like - environment. - - The \newtheorem command may have at most one optional argument. - -\newfont - - \newfont{cmd}{font_name} - - Defines the command name cmd, which must not be currently - defined, to be a declaration that selects the font named - font_name to be the current font. - -2.3.4 Document Classes - - Valid LaTeX document classes include: - * article - * report - * letter - * book - * slides - - Other document classes are often available. See Overview, for - details. They are selected with the following command: - - \documentclass [options] {class} - - All the standard classes (except slides) accept the following - options for selecting the typeface size (10pt is default): - - 10pt, 11pt, 12pt - - All classes accept these options for selecting the paper size - (default is letter): - - a4paper, a5paper, b5paper, letterpaper, legalpaper, - executivepaper - - Miscellaneous options: - * landscape --- selects landscape format. Default is - portrait. - * titlepage, notitlepage --- selects if there should be a - separate title page. - * leqno --- equation number on left side of equations. - Default is right side. - * fleqn --- displayed formulas flush left. Default is - centered. - * openbib --- use open bibliography format. - * draft, final --- mark/do not mark overfull boxes with a - rule. Default is final. - - These options are not available with the slides class: - * oneside, twoside --- selects one- or twosided layout. - Default is oneside, except for the book class. - * openright, openany --- determines if a chapter should start - on a right-hand page. Default is openright for book. - * onecolumn, twocolumn --- one or two columns. Defaults to - one column. - - The slides class offers the option clock for printing the time - at the bottom of each note. - - If you specify more than one option, they must be separated by - a comma. - - Additional packages are loaded by a - - \usepackage[options]{pkg} - - command. If you specify more than one package, they must be - separated by a comma. - - Any options given in the \documentclass command that are - unknown by the selected document class are passed on to the - packages loaded with \usepackage. - -2.3.5 Layout - - Miscellaneous commands for controlling the general layout of - the page. - -\flushbottom - - The \flushbottom declaration makes all text pages the same - height, adding extra vertical space when necessary to fill out - the page. - - This is the standard if twocolumn mode is selected. - -\onecolumn - - The \onecolumn declaration starts a new page and produces - single-column output. - -\raggedbottom - - The \raggedbottom declaration makes all pages the height of the - text on that page. No extra vertical space is added. - -\twocolumn - - \twocolumn[text] - - The \twocolumn declaration starts a new page and produces - two-column output. If the optional text argument is present, it - is typeset in one-column mode. - -2.3.6 Environments - - LaTeX provides a number of different paragraph-making - environments. Each environment begins and ends in the same - manner. -\begin{environment-name} - . - . - . -\end{environment-name} - -array - -\begin{array}{col1col2...coln} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{array} - - 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, coln, is specified by a - single letter that tells how items in that row should be - formatted. - * c --- for centered - * l --- for flush left - * r --- for flush right - - Column entries must be separated by an &. Column entries may - include other LaTeX commands. Each row of the array must be - terminated with the string \\. - - Note that the array environment can only be used in math mode, - so normally it is used inside an equation environment. - -center - -\begin{center} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{center} - - The center 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 \\. - -\centering - - This declaration corresponds to the center environment. This - declaration can be used inside an environment such as quote or - in a parbox. The text of a figure or table can be centered on - the page by putting a \centering command at the beginning of - the figure or table environment. - - Unlike the center environment, the \centering 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 \end command - (of an environment like quote) that ends the paragraph unit. - -description - -\begin{description} -\item [label] First item -\item [label] Second item - . - . - . -\end{description} - - The description environment is used to make labelled lists. The - label is bold face and flushed right. - -enumerate - -\begin{enumerate} -\item First item -\item Second item - . - . - . -\end{enumerate} - - The enumerate 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. - - Each item of an enumerated list begins with an \item command. - There must be at least one \item command within the - environment. - - The enumerate environment uses the enumi through enumiv - counters (see Counters). The type of numbering can be changed - by redefining \theenumi etc. - -eqnarray - -\begin{eqnarray} -math formula 1 \\ -math formula 2 \\ - . - . - . -\end{eqnarray} - - The eqnarray environment is used to display a sequence of - equations or inequalities. It is very much like a three-column - array environment, with consecutive rows separated by \\ and - consecutive items within a row separated by an &. - - An equation number is placed on every line unless that line has - a \nonumber command. - - The command \lefteqn is used for splitting long formulas across - lines. It typesets its argument in display style flush left in - a box of zero width. - -equation - -\begin{equation} - math formula -\end{equation} - - The equation environment centers your equation on the page and - places the equation number in the right margin. - -figure - -\begin{figure}[placement] - - body of the figure - -\caption{figure title} -\end{figure} - - Figures are objects that are not part of the normal text, and - are usually floated to a convenient place, like the top of a - page. Figures will not be split between two pages. - - The optional argument [placement] determines where LaTeX will - try to place your figure. There are four places where LaTeX can - possibly put a float: - 1. h (Here) - at the position in the text where the figure - environment appears. - 2. t (Top) - at the top of a text page. - 3. b (Bottom) - at the bottom of a text page. - 4. p (Page of floats) - on a separate float page, which is a - page containing no text, only floats. - - The standard report and article classes use the default - placement tbp. - - The body of the figure is made up of whatever text, LaTeX - commands, etc. you wish. The \caption command allows you to - title your figure. - -flushleft - -\begin{flushleft} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushleft} - - The flushleft 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 \\. - -\raggedright - - This declaration corresponds to the flushleft environment. This - declaration can be used inside an environment such as quote or - in a parbox. - - Unlike the flushleft environment, the \raggedright 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 \end command - (of an environment like quote) that ends the paragraph unit. - -flushright - -\begin{flushright} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushright} - - The flushright 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 \\. - -\raggedleft - - This declaration corresponds to the flushright environment. - This declaration can be used inside an environment such as - quote or in a parbox. - - Unlike the flushright environment, the \raggedleft 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 \end command - (of an environment like quote) that ends the paragraph unit. - -itemize - -\begin{itemize} -\item First item -\item Second item - . - . - . -\end{itemize} - - The itemize environment produces a bulleted list. Itemizations - can be nested within one another, up to four levels deep. They - can also be nested within other paragraph-making environments. - - Each item of an itemized list begins with an \item command. - There must be at least one \item command within the - environment. - - The itemize environment uses the itemi through itemiv counters - (see Counters). The type of numbering can be changed by - redefining \theitemi etc. - -letter - - This environment is used for creating letters. See Letters. - -list - - The list 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. -\begin{list}{label}{spacing} -\item First item -\item Second item - . - . - . -\end{list} - - The {label} 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. - - The {spacing} argument contains commands to change the spacing - parameters for the list. This argument will most often be null, - i.e., {}. This will select all default spacing which should - suffice for most cases. - -minipage - -\begin{minipage}[position][height][inner-pos]{width} - text -\end{minipage} - - The minipage environment is similar to a \parbox command. It - takes the same optional position argument and mandatory width - argument. You may use other paragraph-making environments - inside a minipage. - - Footnotes in a minipage environment are handled in a way that - is particularly useful for putting footnotes in figures or - tables. A \footnote or \footnotetext command puts the footnote - at the bottom of the minipage instead of at the bottom of the - page, and it uses the mpfootnote counter instead of the - ordinary footnote counter See Counters. - - NOTE: Don't put one minipage inside another if you are using - footnotes; they may wind up at the bottom of the wrong - minipage. - -picture - -\begin{picture}(width,height)(x offset,y offset) - . - . - picture commands - . - . -\end{picture} - - The picture 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 5, 2.3 - or -3.1416. A coordinate specifies a length in multiples of the - unit length \unitlength, so if \unitlength has been set to 1cm, - then the coordinate 2.54 specifies a length of 2.54 - centimetres. You can change the value of \unitlength anywhere - you want, using the \setlength command, but strange things will - happen if you try changing it inside the picture environment. - - A position is a pair of coordinates, such as (2.4,-5), - specifying the point with x-coordinate 2.4 and y-coordinate -5. - 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. - - The picture environment has one mandatory argument, which is a - position. 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. - - The picture environment also has an optional position argument, - following the size 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 - \unitlength has been set to 1mm, the command -\begin{picture}(100,200)(10,20) - - 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. - - 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. - - Everything that appears in a picture is drawn by the \put - command. The command -\put (11.3,-.3){...} - - puts the object specified by ... in the picture, with its - reference point at coordinates (11.3,-.3). The reference points - for various objects will be described below. - - The \put command creates an LR box. You can put anything in the - text argument of the \put command that you'd put into the - argument of an \mbox and related commands. When you do this, - the reference point will be the lower left corner of the box. - - Picture commands: - -\circle{diameter}, \circle*{diameter} - - The \circle command produces a circle with a diameter as close - to the specified one as possible. If the *-form of the command - is used, LaTeX draws a solid circle. - - Note that only circles up to 40 pt can be drawn. - -\dashbox - - Draws a box with a dashed line. - - \dashbox{dash_length}(width,height){...} - - The \dashbox has an extra argument which specifies the width of - each dash. A dashed box looks best when the width and height - are multiples of the dash_length. - -\frame{...} - - The \frame 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. - -\framebox(width,height)[position]{...} - - The \framebox command is exactly the same as the \makebox - command, except that it puts a frame around the outside of the - box that it creates. - - The framebox command produces a rule of thickness \fboxrule, - and leaves a space \fboxsep between the rule and the contents - of the box. - -\line(x slope,y slope){length} - - The \line command draws a line of the specified length and - slope. - - Note that LaTeX can only draw lines with slope = x/y, where x - and y have integer values from -6 through 6. - -\linethickness{dimension} - - Declares the thickness of horizontal and vertical lines in a - picture environment to be dimension, which must be a positive - length. It does not affect the thickness of slanted lines and - circles, or the quarter circles drawn by \oval to form the - corners of an oval. - -\makebox(width,height)[position]{...} - - The \makebox command for the picture environment is similar to - the normal \makebox command except that you must specify a - width and height in multiples of \unitlength. - - The optional argument, [position], specifies the quadrant that - your text appears in. You may select up to two of the - following: - * t - Moves the item to the top of the rectangle - * b - Moves the item to the bottom - * l - Moves the item to the left - * r - Moves the item to the right - - See \makebox. - -\multiput(x coord,y coord)(delta x,delta y){number of copies}{object} - - The \multiput command can be used when you are putting the same - object in a regular pattern across a picture. - -\oval(width,height)[portion] - - The \oval command produces a rectangle with rounded corners. - The optional argument, [portion], allows you to select part of - the oval. - * t - Selects the top portion - * b - Selects the bottom portion - * r - Selects the right portion - * l - Selects the left portion - - Note that the corners of the oval are made with quarter circles - with a maximum radius of 20 pt, so large ovals will look more - like boxes with rounded corners. - -\put(x coord,y coord){ ... } - - The \put command places the item specified by the mandatory - argument at the given coordinates. - -\shortstack[position]{... \\ ... \\ ...} - - The \shortstack command produces a stack of objects. The valid - positions are: - * r - Moves the objects to the right of the stack - * l - Moves the objects to the left of the stack - * c - Moves the objects to the centre of the stack (default) - -\vector(x slope,y slope){length} - - The \vector command draws a line with an arrow of the specified - length and slope. The x and y values must lie between -4 and - +4, inclusive. - -quotation - -\begin{quotation} - text -\end{quotation} - - The margins of the quotation 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. - -quote - -\begin{quote} - text -\end{quote} - - The margins of the quote 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. - -tabbing - -\begin{tabbing} -text \= more text \= still more text \= last text \\ -second row \> \> more \\ - . - . - . -\end{tabbing} - - The tabbing 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. - - It is best suited for cases where the width of each column is - constant and known in advance. - - This environment can be broken across pages, unlike the tabular - environment. - - The following commands can be used inside a tabbing - environment: - - Table 1.4. Commands in a tabbing environment - \= Sets a tab stop at the current position. - \> Advances to the next tab stop. - \< 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. - \+ Moves the left margin of the next and all the following - commands one tab stop to the right. - \- Moves the left margin of the next and all the following - commands one tab stop to the left. - \' Moves everything that you have typed so far in the current - column, i.e. everything from the most recent \>, \<, \', \\, or - \kill command, to the right of the previous column, flush - against the current column's tab stop. - \` 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 \` - command moves all the text that follows it, up to the \\ or - \end{tabbing} command that ends the line, to the right margin - of the tabbing environment. There must be no \> or \' command - between the \` and the command that ends the line. - \kill Sets tab stops without producing text. Works just like \\ - except that it throws away the current line instead of - producing output for it. The effect of any \=, \+ or \- - commands in that line remain in effect. - \pushtabs Saves all current tab stop positions. Useful for - temporarily changing tab stop positions in the middle of a - tabbing environment. - \poptabs Restores the tab stop positions saved by the last - \pushtabs. - \a In a tabbing environment, the commands \=, \' and \` do not - produce accents as normal. Instead, the commands \a=, \a' and - \a` are used. - - This example typesets a Pascal function in a traditional - format: -\begin{tabbing} -function \= fact(n : integer) : integer;\\ - \> begin \= \+ \\ - \> if \= n $>$ 1 then \+ \\ - fact := n * fact(n-1) \- \\ - else \+ \\ - fact := 1; \-\- \\ - end;\\ -\end{tabbing} - -table - -\begin{table}[placement] - - body of the table - -\caption{table title} -\end{table} - - Tables are objects that are not part of the normal text, and - are usually floated to a convenient place, like the top of a - page. Tables will not be split between two pages. - - The optional argument [placement] determines where LaTeX will - try to place your table. There are four places where LaTeX can - possibly put a float: - * h : Here - at the position in the text where the table - environment appears. - * t : Top - at the top of a text page. - * b : Bottom - at the bottom of a text page. - * p : Page of floats - on a separate float page, which is a - page containing no text, only floats. - - The standard report and article classes use the default - placement [tbp]. - - The body of the table is made up of whatever text, LaTeX - commands, etc., you wish. The \caption command allows you to - title your table. - -tabular - -\begin{tabular}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{tabular} - - or -\begin{tabular*}{width}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{tabular*} - - These environments produce a box consisting of a sequence of - rows of items, aligned vertically in columns. The mandatory and - optional arguments consist of: - - Table 1.5. Commands used inside a tabular environment - width Specifies the width of the tabular* environment. There - must be rubber space between columns that can stretch to fill - out the specified width. - pos Specifies the vertical position; default is alignment on - the centre of the environment. - * t - align on top row - * b - align on bottom row - - cols Specifies the column formatting. It consists of a sequence - of the following specifiers, corresponding to the sequence of - columns and intercolumn material. - * l - A column of left-aligned items. - * r - A column of right-aligned items. - * c - A column of centred items. - * | - A vertical line the full height and depth of the - environment. - * @{text} - This inserts text 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 - \extracolsep{wd} command in an @-expression causes an extra - space of width wd to appear to the left of all subsequent - columns, until countermanded by another \extracolsep - command. Unlike ordinary intercolumn space, this extra - space is not suppressed by an @-expression. An \extracolsep - command can be used only in an @-expression in the cols - argument. - * p{wd} - Produces a column with each item typeset in a - parbox of width wd, as if it were the argument of a - \parbox[t]{wd} command. However, a \\ may not appear in the - item, except in the following situations: - 1. inside an environment like minipage, array, or - tabular. - 2. inside an explicit \parbox. - 3. in the scope of a \centering, \raggedright, or - \raggedleft declaration. The latter declarations must - appear inside braces or an environment when used in a - p-column element. - * *{num}{cols} - Equivalent to num copies of cols, where num - is any positive integer and cols is any list of - column-specifiers, which may contain another *-expression. - - These commands can be used inside a tabular environment: - -\cline{i-j} - - The \cline command draws horizontal lines across the columns - specified, beginning in column i and ending in column j, which - are identified in the mandatory argument. - -\hline - - The \hline 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. - -\multicolumn - - \multicolumn{cols}{pos}{text} - - The \multicolumn is used to make an entry that spans several - columns. The first mandatory argument, cols, specifies the - number of columns to span. The second mandatory argument, pos, - specifies the formatting of the entry; c for centred, l for - flushleft, r for flushright. The third mandatory argument, - text, specifies what text is to make up the entry. - -\vline - - The \vline command will draw a vertical line extending the full - height and depth of its row. An \hfill command can be used to - move the line to the edge of the column. It can also be used in - an @-expression. - -thebibliography - -\begin{thebibliography}{widest-label} -\bibitem[label]{cite_key} - . - . - . -\end{thebibliography} - - The thebibliography environment produces a bibliography or - reference list. In the article class, this reference list is - labelled References; in the report class, it is labelled - Bibliography. - * widest-label: Text that, when printed, is approximately as - wide as the widest item label produces by the \bibitem - commands. - -\bibitem[label]{cite_key} - - The \bibitem command generates an entry labelled by label. If - the label argument is missing, a number is generated as the - label, using the enumi counter. The cite_key is any sequence of - letters, numbers, and punctuation symbols not containing a - comma. This command writes an entry on the .aux file containing - cite_key and the item's label. When this .aux file is read by - the \begin{document} command, the item's label is associated - with cite_key, causing the reference to cite_key by a \cite - command to produce the associated label. - -\cite[text]{key_list} - - The key_list argument is a list of citation keys. This command - generates an in-text citation to the references associated with - the keys in key_list by entries on the .aux file read by the - \begin{document} command. - - The optional text argument will appear after the citation, i.e. - \cite[p.~2f.]{knuth} might produce `[Knuth, p. 2]'. - - The package cite.sty allows a line break in the \cite reference - and can sort numerical entries. - - overcite.sty makes citations like footnotes. - -\nocite{key_list} - - The \nocite command produces no text, but writes key_list, - which is a list of one or more citation keys, on the .aux file. - \nocite{*} uses all entries from the BibTeX database. - -Using BibTeX - - 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 - thebibliography environment. Instead, you include the lines -\bibliographystyle{style} -\bibliography{bibfile} - - where style refers to a file style.bst, which defines how your - citations will look. - - Table 1.6. Standard styles distributed with BibTeX - alpha Sorted alphabetically. Labels are formed from name of - author and year of publication. - plain Sorted alphabetically. Labels are numeric. - unsrt Like plain, but entries are in order of citation. - abbrv Like plain, but more compact labels. - - In addition, numerous other BibTeX style files exist tailored - to the demands of various publications. - - The argument to \bibliography refers to the file bibfile.bib, - which should contain your database in BibTeX format. Only the - entries referred to via \cite and \nocite will be listed in the - bibliography. - -theorem - -\begin{theorem} - theorem text -\end{theorem} - - The theorem environment produces Theorem x in boldface followed - by your theorem text. - -titlepage - -\begin{titlepage} - text -\end{titlepage} - - The titlepage 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 \today command comes in handy for - title pages. - - Note that you can use the \maketitle (see \maketitle) command - to produce a standard title page. - -verbatim - -\begin{verbatim} - text -\end{verbatim} - - The verbatim 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. - -\verb char literal_text char \verb*char literal_text char - - Typesets literal_text exactly as typed, including special - characters and spaces, using a typewriter (\tt) type style. - There may be no space between \verb or \verb* and char (space - is shown here only for clarity). The *-form differs only in - that spaces are printed - -verse - -\begin{verse} - text -\end{verse} - - The verse environment is designed for poetry, though you may - find other uses for it. - - The margins are indented on the left and the right. Separate - the lines of each stanza with \\, and use one or more blank - lines to separate the stanzas. - -2.3.7 Footnotes - - Footnotes can be produced in one of two ways. They can be - produced with one command, the \footnote command. They can also - be produced with two commands, the \footnotemark and the - \footnotetext commands. See the specific command for - information on why you would use one over the other. - -\footnote[number]{text} - - The \footnote command places the numbered footnote text at the - bottom of the current page. The optional argument, number, 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 \chapter, in figures, tables or in - a tabular environment. - -\footnotemark - - The \footnotemark command puts the footnote number in the text. - This command can be used in inner paragraph mode. The text of - the footnote is supplied by the \footnotetext command. - - This command can be used to produce several consecutive - footnote markers referring to the same footnote by using - - \footnotemark[\value{footnote}] - - after the first \footnote command. - -\footnotetext[number]{text} - - The \footnotetext command produces the text to be placed at the - bottom of the page. This command can come anywhere after the - \footnotemark command. The \footnotetext command must appear in - outer paragraph mode. - - The optional argument, number, is used to change the default - footnote number. - -2.3.8 Lengths - - A length is a measure of distance. Many LaTeX commands take a - length as an argument. - -\newlength - - \newlength{\gnat} - - The \newlength command defines the mandatory argument, \gnat, - as a length command with a value of 0in. An error occurs if a - \gnat command already exists. - -\setlength - - \setlength{\gnat}{length} - - The \setlength command is used to set the value of a length - command. The length argument can be expressed in any terms of - length LaTeX understands, i.e., inches (in), millimetres (mm), - points (pt), etc. - -\addtolength - - \addtolength{\gnat}{length} - - The \addtolength command increments length command by the - amount specified in the length argument. It can be a negative - amount. - -\settodepth - - \settodepth{\gnat}{text} - - The \settodepth command sets the value of a length command - equal to the depth of the text argument. - -\settoheight - - \settoheight{\gnat}{text} - - The \settoheight command sets the value of a length command - equal to the height of the text argument. - -\settowidth - - \settowidth{\gnat}{text} - - The \settowidth command sets the value of a length command - equal to the width of the text argument. - -Predefined lengths - - \width - - \height - - \depth - - \totalheight - - These length parameters can be used in the arguments of the - box-making commands See Spaces & Boxes. They specify the - natural width etc. of the text in the box. \totalheight equals - \height + \depth. To make a box with the text stretched to - double the natural size, e.g., say - - \makebox[2\width]{Get a stretcher} - -2.3.9 Letters - - You can use LaTeX to typeset letters, both personal and - business. The letter document class is designed to make a - number of letters at once, although you can make just one if - you so desire. - - Your .tex source file has the same minimum commands as the - other document classes, i.e., you must have the following - commands as a minimum: -\documentclass{letter} -\begin{document} - ... letters ... -\end{document} - - Each letter is a letter environment, whose argument is the name - and address of the recipient. For example, you might have: -\begin{letter}{Mr. Joe Smith\\ 2345 Princess St.\\ Edinburgh, EH1 1AA} - ... -\end{letter} - - The letter itself begins with the \opening command. The text of - the letter follows. It is typed as ordinary LaTeX input. - Commands that make no sense in a letter, like \chapter, do not - work. The letter closes with a \closing command. - - After the closing, you can have additional material. The \cc - command produces the usual cc: .... There's also a similar - \encl command for a list of enclosures. With both these - commands, use \\ to separate the items. - - These commands are used with the letter class: - -\address - - \address{Return address} - - The return address, as it should appear on the letter and the - envelope. Separate lines of the address should be separated by - \\ commands. If you do not make an \address declaration, then - the letter will be formatted for copying onto your - organisation's standard letterhead. (See Overview, for details - on your local implementation). If you give an \address - declaration, then the letter will be formatted as a personal - letter. - -\cc - - \cc{Kate Schechter\\Rob McKenna} - - Generate a list of other persons the letter was sent to. Each - name is printed on a separate line. - -\closing - - \closing{text} - - The letter closes with a \closing command, i.e., -\closing{Best Regards,} - -\encl - - \encl{CV\\Certificates} - - Generate a list of enclosed material. - -\location - - \location{address} - - This modifies your organisation's standard address. This only - appears if the firstpage pagestyle is selected. - -\makelabels - - \makelabels{number} - - If you issue this command in the preamble, LaTeX will create a - sheet of address labels. This sheet will be output before the - letters. - -\name - - \name{June Davenport} - - Your name, used for printing on the envelope together with the - return address. - -\opening - - \opening{text} - - The letter begins with the \opening command. The mandatory - argument, text, is whatever text you wish to start your letter, - i.e., -\opening{Dear Joe,} - -\ps - - \ps - - Use this command before a postscript. - -\signature - - \signature{Harvey Swick} - - 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 \\ commands. - -\startbreaks - - \startbreaks - - Used after a \stopbreaks command to allow page breaks again. - -\stopbreaks - - \stopbreaks - - Inhibit page breaks until a \startbreaks command occurs. - -\telephone - - \telephone{number} - - This is your telephone number. This only appears if the - firstpage pagestyle is selected. - -2.3.10 Line & Page Breaking - - 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 \\ - command, but LaTeX usually does it for you. - -\\ - - \\[extra-space], \\*[extra-space] - - The \\ command tells LaTeX to start a new line. It has an - optional argument, extra-space, that specifies how much extra - vertical space is to be inserted before the next line. This can - be a negative amount. - - The \\* command is the same as the ordinary \\ command except - that it tells LaTeX not to start a new page after the line. - -\- - - The \- 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 \- command is - used for the exceptional cases. - - Note that when you insert \- 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. - -\cleardoublepage - - The \cleardoublepage 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. - -\clearpage - - The \clearpage command ends the current page and causes all - figures and tables that have so far appeared in the input to be - printed. - -\enlargethispage - - \enlargethispage{size} - - \enlargethispage*{size} - - Enlarge the \textheight for the current page by the specified - amount; e.g. \enlargethispage{\baselineskip} will allow one - additional line. - - The starred form tries to squeeze the material together on the - page as much as possible. This is normally used together with - an explicit \pagebreak. - -\samepage - - \samepage - - The object in the argument {} should be on the current page. - -\fussy - - \fussy - - 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. - - This command cancels the effect of a previous \sloppy command. - \sloppy - -\hyphenation - - \hyphenation{words} - - The \hyphenation command declares allowed hyphenation points, - where words is a list of words, separated by spaces, in which - each hyphenation point is indicated by a - character. - -\linebreak - - \linebreak[number] - - The \linebreak command tells LaTeX to break the current line at - the point of the command. With the optional argument, number, - you can convert the \linebreak 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. - - The \linebreak command causes LaTeX to stretch the line so it - extends to the right margin. - -\newline - - The \newline command breaks the line right where it is. It can - only be used in paragraph mode. - -\newpage - - The \newpage command ends the current page. In contrast to - \pagebreak it can produce a partly empty page, even when - \flushbottom is active. - -\nolinebreak - - \nolinebreak[number] - - The \nolinebreak command prevents LaTeX from breaking the - current line at the point of the command. With the optional - argument, number, you can convert the \nolinebreak 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. - -\nopagebreak - - \nopagebreak[number] - - The \nopagebreak command prevents LaTeX from breaking the - current page at the point of the command. With the optional - argument, number, you can convert the \nopagebreak 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. - -\pagebreak - - \pagebreak[number] - - The \pagebreak command tells LaTeX to break the current page at - the point of the command. With the optional argument, number, - you can convert the \pagebreak 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. - -\sloppy - - \sloppy - - This declaration makes TeX less fussy about line breaking. This - can prevent overfull boxes, but may leave too much space - between words. - - Lasts until a \fussy command is issued. \fussy. - -2.3.11 Making Paragraphs - - A paragraph is ended by one or more completely blank lines --- - lines not containing even a %. 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. - -\indent - - \indent - - 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. - -\noindent - - \noindent - - 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. - -\par - - Equivalent to a blank line; often used to make command or - environment definitions easier to read. - -2.3.12 Margin Notes - - The command \marginpar[left]{right} creates a note in the - margin. The first line will be at the same height as the line - in the text where the \marginpar occurs. - - When you only specify the mandatory argument right, the text - will be placed - * in the right margin for one-sided layout - * in the outside margin for two-sided layout - * in the nearest margin for two-column layout. - - By issuing the command \reversemarginpar, you can force the - marginal notes to go into the opposite (inside) margin. - - When you specify both arguments, left is used for the left - margin, and right is used for the right margin. - - The first word will normally not be hyphenated; you can enable - hyphenation by prefixing the first word with a \hspace{0pt} - command. - -2.3.13 Math Formulae - - Table 1.7. Three environments that put LaTeX in math mode - math For Formulae that appear right in the text. - displaymath For Formulae that appear on their own line. - equation The same as the displaymath environment except that it - adds an equation number in the right margin. - - The math environment can be used in both paragraph and LR mode, - but the displaymath and equation environments can be used only - in paragraph mode. The math and displaymath environments are - used so often that they have the following short forms: -\(...\) instead of \begin{math}...\end{math} - -\[...\] instead of \begin{displaymath}...\end{displaymath} - - In fact, the math environment is so common that it has an even - shorter form: -$ ... $ instead of \(...\) - -Subscripts & Superscripts - - To get an expression exp to appear as a subscript, you just - type _{exp} . To get exp to appear as a superscript, you type - ^{exp }. 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. - -Math Symbols - -Spacing in Math Mode - - In a math 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: - 1. \; - a thick space - 2. \: - a medium space - 3. \, - a thin space - 4. \! - a negative thin space - -Math Miscellany - - Table 1.8. Math Miscellany - \cdots Produces a horizontal ellipsis where the dots are raised - to the centre of the line. - \ddots Produces a diagonal ellipsis. - \frac{num}{den} Produces the fraction num divided by den. - \ldots Produces an ellipsis. This command works in any mode, - not just math mode. - \overbrace{text} Generates a brace over text. - \overline{text} Causes the argument text to be overlined. - \sqrt[root]{arg} Produces the square root of its argument. The - optional argument, root, determines what root to produce, i.e., - the cube root of x+y would be typed as $\sqrt[3]{x+y}$. - \underbrace{text} Generates text with a brace underneath. - \underline{text} Causes the argument text to be underlined. - This command can also be used in paragraph and LR modes. - \vdots Produces a vertical ellipsis. - \ensuremath{} It's argument is set in math mode. This is needed - for own definitions. - -2.3.14 Modes - - When LaTeX is processing your input text, it is always in one - of three modes: - * paragraph mode - * Math mode - * Left-to-right mode, called LR mode for short - - 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. - - Paragraph mode 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 - math mode when it's generating a mathematical formula. In LR - mode, 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 \mbox, 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. - - LaTeX is in LR mode when it starts making a box with an \mbox - 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 parbox. When LaTeX is in - paragraph mode while making a box, it is said to be in inner - paragraph mode. Its normal paragraph mode, which it starts out - in, is called outer paragraph mode. - -2.3.15 Page Styles - - The \documentclass command determines the size and position of - the page's head and foot. The page style determines what goes - in them. - -\maketitle - - \maketitle - - The \maketitle command generates a title on a separate title - page. In the article class, \maketitle will also switch to - pagestyle plain. See Page Styles for commands to change page - numbering. - - Information used to produce the title is obtained from the - following declarations: - - See Page Styles for the commands to give the information. - -\author - - \author{names} - - The \author command declares the author(s), where names is a - list of authors separated by \and commands. Use \\ to separate - lines within a single author's entry -- for example, to give - the author's institution or address. - -\date - - \date{text} - - The \date command declares text to be the document's date. With - no \date command, the current date is used. - -\thanks - - \thanks{text} - - The \thanks command produces a \footnote to the title. - -\title - - \title{text} - - The \title command declares text to be the title. Use \\ to - tell LaTeX where to start a new line in a long title. - -\pagenumbering - - \pagenumbering{num_style} - - Specifies the style of page numbers. Possible values of - num_style are: - * arabic - Arabic numerals - * roman - Lowercase Roman numerals - * Roman - Uppercase Roman numerals - * alph - Lowercase letters - * Alph - Uppercase letters - -\pagestyle - - \pagestyle{option} - - The \pagestyle command changes the style from the current page - on throughout the remainder of your document. - - The valid options are: - * plain - Just a plain page number. - * empty - Produces empty heads and feet - no page numbers. - * headings - Puts running headings on each page. The document - style specifies what goes in the headings. - * myheadings - You specify what is to go in the heading with - the \markboth or the \markright commands. - -\markboth - -\markboth{left head}{right head} - - The \markboth command is used in conjunction with the page - style myheadings for setting both the left and the right - heading. You should note that a left-hand heading is generated - by the last \markboth command before the end of the page, while - a right-hand heading is generated by the first \markboth or - \markright that comes on the page if there is one, otherwise by - the last one before the page. - -\markright - -\markright{right head} - - The \markright command is used in conjunction with the page - style myheadings for setting the right heading, leaving the - left heading unchanged. You should note that a left-hand - heading is generated by the last \markboth command before the - end of the page, while a right-hand heading is generated by the - first \markboth or \markright that comes on the page if there - is one, otherwise by the last one before the page. - -\thispagestyle - - \thispagestyle{option} - - The \thispagestyle command works in the same manner as the - \pagestyle command except that it changes the style for the - current page only. - -2.3.16 Sectioning - - Sectioning commands provide the means to structure your text - into units. - * \part - * \chapter (report and book class only) - * \section - * \subsection - * \subsubsection - * \paragraph - * \subparagraph - - All sectioning commands take the same general form, i.e., - - \chapter[optional]{title} - - In addition to providing the heading in the text, the mandatory - argument of the sectioning command can appear in two other - places: - 1. The table of contents - 2. The running head at the top of the page - - 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 optional argument - that provides the text for these other two purposes. - - All sectioning commands have *-forms that print a title, but do - not include a number and do not make an entry in the table of - contents. - - \appendix - - The \appendix command changes the way sectional units are - numbered. The \appendix command generates no text and does not - affect the numbering of parts. The normal use of this command - is something like -\chapter{The First Chapter} - ... -\appendix -\chapter{The First Appendix} - -2.3.17 Spaces & Boxes - - All the predefined length parameters See Predefined lengths can - be used in the arguments of the box-making commands. - -\dotfill - - The \dotfill command produces a rubber length that produces - dots instead of just spaces. - -\hfill - - The \hfill fill command produces a rubber length which can - stretch or shrink horizontally. It will be filled with spaces. - -\hrulefill - - The \hrulefill fill command produces a rubber length which can - stretch or shrink horizontally. It will be filled with a - horizontal rule. - -\hspace - - \hspace{length}, \hspace*{length} - - The \hspace 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 \hspace command. Adding negative space - is like backspacing. - - 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 * argument. Then the space is never removed. - -\addvspace - - \addvspace{length} - - The \addvspace 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 \addvspace command, - then this command will not add more space than needed to make - the natural length of the total vertical space equal to length. - -\bigskip - - The \bigskip command is equivalent to \vspace{bigskipamount} - where bigskipamount is determined by the document class. - -\medskip - - The \medskip command is equivalent to \vspace{medskipamount} - where medskipamount is determined by the document class. - -\smallskip - - \smallskip - - The \smallskip command is equivalent to - \vspace{smallskipamount} where smallskipamount is determined by - the document class. - -\vfill - - The \vfill fill command produces a rubber length which can - stretch or shrink vertically. - -\vspace - - \vspace{length}, \vspace*{length} - - The \vspace 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 \vspace command. - - 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 * argument. Then the space is never removed. - -\fbox - - \fbox{text} - - The \fbox command is exactly the same as the \mbox command, - except that it puts a frame around the outside of the box that - it creates. - -\framebox - - \framebox[width][position]{text} - - The \framebox command is exactly the same as the \makebox - command, except that it puts a frame around the outside of the - box that it creates. - - The framebox command produces a rule of thickness \fboxrule, - and leaves a space \fboxsep between the rule and the contents - of the box. - -lrbox - - \begin{lrbox}{cmd} text \end{lrbox} - - This is the environment form of \sbox. - - The text inside the environment is saved in the box cmd, which - must have been declared with \newsavebox. - -\makebox - - \makebox[width][position]{text} - - The \makebox command creates a box just wide enough to contain - the text specified. The width of the box is specified by the - optional width argument. The position of the text within the - box is determined by the optional position argument. - * c --- centred (default) - * l --- flushleft - * r --- flushright - * s --- stretch from left to right margin. The text must - contain stretchable space for this to work. - - See \makebox (picture). - -\mbox - - \mbox{text} - - The \mbox command creates a box just wide enough to hold the - text created by its argument. - - Use this command to prevent text from being split across lines. - -\newsavebox - - \newsavebox{cmd} - - Declares cmd, which must be a command name that is not already - defined, to be a bin for saving boxes. - -\parbox - - \parbox[position][height][inner-pos]{width}{text} - - A parbox is a box whose contents are created in paragraph mode. - The \parbox has two mandatory arguments: - * width - specifies the width of the parbox, and - * text - the text that goes inside the parbox. - - LaTeX will position a parbox so its centre lines up with the - centre of the text line. The optional position argument allows - you to line up either the top or bottom line in the parbox - (default is top). - - If the height argument is not given, the box will have the - natural height of the text. - - The inner-pos argument controls the placement of the text - inside the box. If it is not specified, position is used. - * t --- text is placed at the top of the box. - * c --- text is centred in the box. - * b --- text is placed at the bottom of the box. - * s --- stretch vertically. The text must contain vertically - stretchable space for this to work. - - A \parbox 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 - \parbox argument. For larger pieces of text, including ones - containing a paragraph-making environment, you should use a - minipage environment See minipage. - -\raisebox - - \raisebox{distance}[extend-above][extend-below]{text} - - The \raisebox 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 LR mode. - - 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 \raisebox command lets - you tell LaTeX how tall it is. - - The first optional argument, extend-above, makes LaTeX think - that the text extends above the line by the amount specified. - The second optional argument, extend-below, makes LaTeX think - that the text extends below the line by the amount specified. - -\rule - - \rule[raise-height]{width}{thickness} - - The \rule command is used to produce horizontal lines. The - arguments are defined as follows: - * raise-height - specifies how high to raise the rule - (optional) - * width - specifies the length of the rule (mandatory) - * thickness - specifies the thickness of the rule (mandatory) - -\savebox - - \savebox{cmd}[width][pos]{text} - - This command typeset text in a box just as for \makebox. - However, instead of printing the resulting box, it saves it in - bin cmd, which must have been declared with \newsavebox. - -\sbox - - \sbox{cmd}\{text} - - This commands typesets text in a box just as for \mbox. - However, instead of printing the resulting box, it saves it in - cmd, which must have been declared with \newsavebox. - -\usebox - - \usebox{cmd} - - Prints the box most recently saved in bin cmd by a \savebox - command. - -2.3.18 Special Characters - - The following characters play a special role in LaTeX and are - called special printing characters, or simply special - characters. -# $ % & ~ _ ^ \ { } - - 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 \ - in front of the character. For example, \$ will produce $ in - your output. - - One exception to this rule is the \ itself because \\ has its - own special meaning. A \ is produced by typing $\backslash$ in - your file. - - Also, \~ means `place a tilde accent over the following - letter', so you will probably want to use \verb instead. - - In addition, you can access any character of a font once you - know its number by using the \symbol command. For example, the - character used for displaying spaces in the \verb* command has - the code decimal 32, so it can be typed as \symbol{32}. - - You can also specify octal numbers with ' or hexadecimal - numbers with ", so the previous example could also be written - as \symbol{'40} or \symbol{"20}. - -2.3.19 Special Symbols - -Accents on Characters - - The rules differ somewhat depending whether you are in text - mode, math modes, or the tabbing environment. - -Text Mode - - The following accents may be placed on letters. Although o is - used in most of the example, the accents may be placed on any - letter. Accents may even be placed above a missing letter; for - example, \~{} produces a tilde over a blank space. - - The following commands may be used only in paragraph or LR - mode: - * \`{o} produces a grave accent, ò - * \'{o} produces an acute accent, ó - * \^{o} produces a circumflex, ô - * \"{o} produces an umlaut or dieresis, ö - * \H{o} produces a long Hungarian umlaut - * \~{o} produces a tilde, õ - * \c{c} produces a cedilla, ç - * \={o} produces a macron accent (a bar over the letter) - * \b{o} produces a bar under the letter - * \.{o} produces a dot over the letter - * \d{o} produces a dot under the letter - * \u{o} produces a breve over the letter - * \v{o} produces a v over the letter - * \t{oo} produces a tie (inverted u) over the two letters - - Note that the letters i and j 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 \i and - \j can be used to produce dotless letters. - - For example, - * \^{\i} should be used for i, circumflex, î - * \"{\i} should be used for i, umlaut, ï - -Math Mode - - Several of the above and some similar accents can also be - produced in math mode. The following commands may be used only - in math mode: - * \hat{o} is similar to the circumflex (cf. \^) - * \widehat{oo} is a wide version of \hat over several letters - * \check{o} is a vee or check (cf. \v) - * \tilde{o} is a tilde (cf. \~) - * \widetilde{oo} is a wide version of \tilde over several - letters - * \acute{o} is an acute accent (cf. \`) - * \grave{o} is a grave accent (cf. >\') - * \dot{o} is a dot over the letter (cf. \.) - * \ddot{o} is a double dot over the letter - * \breve{o} is a breve (cf. \u) - * \bar{o} is a macron (cf. \=) - * \vec{o} is a vector (arrow) over the letter - -Tabbing Environment - - Some of the accent marks used in running text have other uses - in the Tabbing Environment. In that case they can be created - with the following command: - * >\a' for an acute accent - * \a` for a grave accent - * \a= for a macron accent - -Arrows - - LaTeX provides commands for all sorts of arrows. The following - commands are used only in math mode. - - In general the command names are created from left, right, up, - or down. leftright gives a double headed arrow. Prefacing with - long gives a longer arrow. Capitalizing the first letter gives - a double-shanked arrow. - - Examples are: - * \leftarrow - * \Leftarrow - * \longleftarrow - * \Longleftarrow - * \rightarrow - * \Rightarrow - * \longrightarrow - * \Longrightarrow - * \leftrightarrow - * \Leftrightarrow - * \longleftrightarrow - * \uparrow - * \downarrow - * \Uparrow - * >\nearrow points from southwest to northeast - * \searrow points from northwest to southeast - * \swarrow points from northeast to southwest - * \nwarrow points from southeast to northwest - - The \stackrel command is useful for putting things over or - under your arrow. - - See also: - * Math Symbols - * Binary and Relational Operators - * Greek Letters - * Miscellaneous Symbols - * Variable Size Math Symbols - -Binary and Relational Operators - - Some math symbols are obtained by typing the corresponding - keyboard character. Examples include -+ - = < > - -Note - - 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). - - The following commands may be used only in math mode: - * \pm plus or minus sign - * \mp minus or plus sign - * \times times (an "x") - * \div divided by sign - * \ast an asterisk (centered) - * \star a five-point star (centered) - * \bullet a bullet - * \circ an open bullet - * \cdot a centered dot - * \leq less than or equal to - * \ll much less than - * \subset is a subset of - * \geq greater than or equal to - * \gg much greater than - * \equiv equivalence symbol - * \sim similar to - * \simeq similar or equal to - * \approx approximately equal to - * \neq not equal to - * \per "perpendicular to" symbols - * \propto proportional to - - Note that greater than and less than are obtained simply by - entering > and <. - - A slash, indicating not can be placed through a symbol (or a - letter) with the \not command. For example, not less than is - \not< and not less than or equal to is \not\leq. If the slash - isn't properly positioned it can be moved by putting a math - mode spacing command between the \notand the symbol. - -Delimiters - - Delimiters are objects which act logically like parentheses. - These can be used only in math mode. - - The delimiters recognized by LaTeX include: - * ( (left parenthesis) - * ) (right parenthesis) - * [ (left bracket) - * ] (right bracket) - * \{ (left brace) - * \} (right brace) - * | (vertical line) - * \vert (vertical line) - * \| (double vertical lines) - * \Vert (double vertical lines) - * / (slash) - * \backslash (backslash) - * \langle (left angle bracket) - * \rangle (right angle bracket) - * \uparrow (uparrow) - * \downarrow (down arrow) - * \updownarrow (up/down arrow) - -Making Delimiters the Right Size - - Delimiters in formulas should be big enough to fit around the - formulas they delimit (for example arround arrays). To obtain - stretchable delimiters (LaTeX makes them the appropriate size) - type a \left or \right command before the delimiter. \left and - \right commands must come in matching pairs, although the - delimiters themselves need not be the same. Thus, \left \{ ... - \right \[ produces a legal pair. In cases where only one - delimiter is desired, it is possible to make the matching - delimiter invisible by typing a period (.) after the command, - i.e., \left. or \right. - - In an eqnarray environment the matching \left and \right cannot - be split between lines and it may be necessary to use an - invisible \right. and \left. 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 local - part, so that the size of the visible left and right 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 \rule. It can also be - accomplished with the \vphantom command, which I have not found - documented, but which appears to work. - - \vphantom{construct} creates a zero-width object with the - height of construct. The argument can contain things such as - \frac or the variable size math symbols and should be chosen - according to what is in the section with the delimiter you want - to match. - -Some Examples - -A six-j symbol - -\[ \left\{ -\begin{array}{ccc} -a & b & c \\ -d & e & f \end{array} -\right>\} \] - - This should be displayed something like (insofar as it can be - rendered in "ascii art"): -( a b c ) -- - -( d e f ) - - Note that the \[ ... \] set this off as Display Math, and that - the Array Environment is used to generate the three centered - columns inside the braces. - -A "multiple choice" equation - -\[ f(x) = - \left\{ \begin{array}{l} - 0, x < 0 \\ 1, x = 0 \\ - 2, x > 0 \end{array} \right. \] - - will be displayed as - ( 0, x < 0 -f(x) = - 1, x = 0 - ( 2, x > 0 - - Note that the invisible \right delimiter is specified using a - period. - -Ellipsis - - Ellipses (three dots) can be produced by the following commands - * \ldots horizontally at bottom of line - * \cdots horizontally center of line (math mode only) - * \ddots diagonal (math mode only) - * \vdots vertical (math mode only) - -Greek Letters - - These commands may be used only in math mode: - * \alpha - * \beta - * \gamma - * \delta - * \epsilon - * \varepsilon (variation, script-like) - * \zeta - * \eta - * \theta - * \vartheta (variation, script-like) - * \iota - * \kappa - * \lambda - * \mu - * \nu - * \xi - * \pi - * \varpi (variation) - * \rho - * \varrho (variation, with the tail) - * \sigma - * \varsigma (variation, script-like) - * \tau - * \upsilon - * \phi - * \varphi (variation, script-like) - * \chi - * \psi - * \omega - - Capital letters: - * \Gamma - * \Delta - * \Theta - * \Lambda - * \Xi - * \Pi - * \Sigma - * \Upsilon - * \Phi - * \Psi - * \Omega - - See also: - * Math Symbols - * Accents - * Miscellaneous Symbols - -Miscellaneous Symbols - -Some symbols for math - - The following symbols are also used only in math mode - * \aleph Hebrew aleph - * \hbar h-bar, Planck's constant - * \imath variation on i; no dot - * \jmath variation on j; no dot - * \ell script (loop) l - * \wp fancy script lowercase P - * \Re script capital R (Real) - * \Im script capital I (Imaginary) - * \prime prime (also obtained by typing ') - * \nabla inverted capital Delta - * \surd radical (square root) symbol - * \angle angle symbol - * \forall for all (inverted A) - * \exists exists (left-facing E) - * \partial partial derivative symbol - * \infty infinity symbol - * \triangle open triangle symbol - * \Box open square - * \Diamond open diamond - * \flat music: flat symbol - * \natural music: natural symbol - * \clubsuit playing cards: club suit symbol - * \diamondsuit playing cards: diamond suit symbol - * \heartsuit playing cards: heart suit symbol - * \spadesuit playing cards: space suit symbol - -Some Other Symbols - - The following symbols can be used in any mode: - * \dag dagger - * >\ddag double dagger - * >\S section symbol - * >\P paragraph symbol - * >\copyright copyright symbol - * >\pounds British pound sterling symbol - -Calligraphic Style Letters - - Twenty-six calligraphic letters are provided (the upper case - alphabet). These can only be used in math mode. - - In LaTeX 2.09 they are produced with the \cal declaration: -${\cal A}$ - - In LaTeX2e they are obtained with the \mathcal command: -$\mathcal{CAL}$ - -Math Functions - - Functions like log or cos 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. - - Some of these commands are: - * \arccos - * \arcsin - * \arctan - * \cos - * \cosh - * \cot - * \coth - * \csc - * \deg - * \det - * \dim - * \exp - * \gcd - * \hom - * \inf - * \ker - * \lg - * \lim - * \liminf - * \limsup - * \ln - * \log - * \max - * \min - * \sec - * \sin - * \sinh - * \sup - * \tan - * \tanh - - Two commands are provided for the "modulus" function - * \bmod - * \pmod{} - - The former would be used to write "a mod b" as a \bmod b and - the latter, which requires an argument that is displayed in - parentheses, would be used to write "n = i (mod j)" as n = i - \pmod{j} - -Variable Size Math Symbols - - The size of some mathematical symbols, notably summation signs, - product signs, and integral signs, depends on the environment - in which they appear (i.e., displaymath as opposed to math - environments. - - These include: - * \sum a summation sign (capital sigma) - * \prod a product (capital pi) - * \coprod a coproduct (inverted capital pi) - * \int an integral sign - * \oint a surface (circular) integral sign - * \bigcup big "U" - * \bigcap big inverted "U" - * \bigvee big "V" - * \bigwedge big inverted "V" - * \bigodot big "O" with dot at center - * \bigotimes big "O" with cross inside - * \bigoplus big "O" with a + inside - * \biguplus big "U" with a + inside - - The \sqrt command also produces a variable size symbol - appropriate for the size of hte radicand argument. - - The "limits" associated with these symbols are entered as - subscripts for entries appearing below the symbol and as - superscripts for entries appearing above the symbol. For - example the sum from n=0 to infinity of x^n would be entered as -\sum_{n=0}^{\infty} x_{n} - - The actual placement of the limits depends on whether this is - in displaymath mode in which case they are placed below/above - or in math mode in running text in which case they are placed - as regular subscripts and superscripts. - - 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 \mathop command. - - Hats and tildes over symbols which stretch (as best they can) - to the correct size for their arguments are produced by - \widehat and \widetilde - -2.3.20 Splitting the Input - - 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. - -\include - - \include{file} - - The \include command is used in conjunction with the - \includeonly command for selective inclusion of files. The file - argument is the first name of a file, denoting file.tex. If - file is one the file names in the file list of the \includeonly - command or if there is no \includeonly command, the \include - command is equivalent to -\clearpage \input{file} \clearpage - - except that if the file file.tex does not exist, then a warning - message rather than an error is produced. If the file is not in - the file list, the \include command is equivalent to - \clearpage. - - The \include command may not appear in the preamble or in a - file read by another \include command. - -\includeonly - - \includeonly{file_list} - - The \includeonly command controls which files will be read in - by an \include command. file_list should be a comma-separated - list of filenames. Each filename must match exactly a filename - specified in a \include command. This command can only appear - in the preamble. - -\input - - \input{file} - - The \input command causes the indicated file 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 file.tex is used. - -2.3.21 Starting & Ending - - Your input file must contain the following commands as a - minimum: -\documentclass{class} -\begin{document} - ... your text goes here ... -\end{document} - - where the class selected is one of the valid classes for LaTeX. - See Document Classes (and see Overview), for details of the - various document classes available locally. - - You may include other LaTeX commands between the \documentclass - and the \begin{document} commands (i.e., in the `preamble'). - -2.3.22 Table of Contents - - A table of contents is produced with the \tableofcontents - 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 \newpage - command after the \tableofcontents command. - - There are similar commands \listoffigures and \listoftables for - producing a list of figures and a list of tables, respectively. - Everything works exactly the same as for the table of contents. - - NOTE: If you want any of these items to be generated, you - cannot have the \nofiles command in your document. - -\addcontentsline - - \addcontentsline{file}{sec_unit}{entry} - - The \addcontentsline command adds an entry to the specified - list or table where: - * file is the extension of the file on which information is - to be written: toc (table of contents), lof (list of - figures), or lot (list of tables). - * sec_unit controls the formatting of the entry. It should be - one of the following, depending upon the value of the file - argument: - 1. toc --- the name of the sectional unit, such as part - or subsection. - 2. lof --- figure - 3. lot --- table - * entry is the text of the entry. - -\addtocontents - - \addtocontents{file}{text} - - The \addtocontents command adds text (or formatting commands) - directly to the file that generates the table of contents or - list of figures or tables. - * file is the extension of the file on which information is - to be written: toc (table of contents), lof (list of - figures), or lot (list of tables). - * text is the information to be written. - -2.3.23 Terminal Input/Output - -\typein - - \typein[cmd]{msg} - - Prints msg on the terminal and causes LaTeX to stop and wait - for you to type a line of input, ending with return. If the cmd - argument is missing, the typed input is processed as if it had - been included in the input file in place of the \typein - command. If the cmd argument is present, it must be a command - name. This command name is then defined or redefined to be the - typed input. - -\typeout - - \typeout{msg} - - Prints msg on the terminal and in the log file. Commands in msg - that are defined with \newcommand or \renewcommand are replaced - by their definitions before being printed. - - LaTeX's usual rules for treating multiple spaces as a single - space and ignoring spaces after a command name apply to msg. A - \space command in msg causes a single space to be printed. A - ^^J in msg prints a newline. - -2.3.24 Typefaces - - The typeface is specified by giving the size and style. A - typeface is also called a font. - -\Styles - - The following type style commands are supported by LaTeX. - - These commands are used like \textit{italics text}. The - corresponding command in parenthesis is the declaration form, - which takes no arguments. The scope of the declaration form - lasts until the next type style command or the end of the - current group. - - The declaration forms are cumulative; i.e., you can say - \sffamily\bfseries to get sans serif boldface. - - You can also use the environment form of the declaration forms; - e.g. \begin{ttfamily}...\end{ttfamily}. - - Table 1.9. Typefaces - \textrm (\rmfamily) Roman. - \textit (\itshape) , \emph Emphasis (toggles between \textit - and \textrm). - \textmd (\mdseries) Medium weight (default). The opposite of - boldface. - \textbf (\bfseries) Boldface. - \textup (\upshape) Upright (default). The opposite of slanted. - \textsl (\slshape) Slanted. - \textsf (\sffamily) Sans serif. - \textsc (\scshape) Small caps. - \texttt (\ttfamily) Typewriter. - \textnormal (\normalfont) Main document font. - \mathrm Roman, for use in math mode. - \mathbf Boldface, for use in math mode. For bold symbols or - complete equations take a look at \boldsymbol and \bm. - \mathsf Sans serif, for use in math mode. - \mathtt Typewriter, for use in math mode. - \mathit Italics, for use in math mode, e.g. variable names with - several letters. - \mathnormal For use in math mode, e.g. inside another type - style declaration. - \mathcal `Calligraphic' letters, for use in math mode. - - In addition, the command \mathversion{bold} can be used for - switching to bold letters and symbols in formulas. - \mathversion{normal} restores the default. - -Sizes - - The following standard type size commands are supported by - LaTeX. - - 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. - - You can also use the environment form of these commands; e.g. - \begin{tiny}...\end{tiny}. - - Table 1.10. Standard type size commands - \tiny - \scriptsize - \footnotesize - \small - \normalsize (default) - \large - \Large - \LARGE - \huge - \Huge - -Low-level font commands - - 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 The LaTeX Companion. - - Table 1.11. Low-level font commands - \fontencoding{enc} Select font encoding. Valid encodings - include OT1 and T1. - \fontfamily{family} Select font family. Valid families include: - * cmr for Computer Modern Roman - * cmss for Computer Modern Sans Serif - * cmtt for Computer Modern Typewriter - - and numerous others. - \fontseries{series} Select font series. Valid series include: - * m Medium (normal) - * b Bold - * c Condensed - * bc Bold condensed - * bx Bold extended - - and various other combinations. - \fontshape{shape} Select font shape. Valid shapes are: - * n Upright (normal) - * it Italic - * sl Slanted (oblique) - * sc Small caps - * ui Upright italics - * ol Outline - - The two last shapes are not available for most font families. - \fontsize{size}{skip} Set font size. The first parameter is the - font size to switch to; the second is the \baselineskip 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. - \selectfont The changes made by calling the four font commands - described above do not come into effect until \selectfont is - called. - \usefont{enc}{family}{series}{shape} Equivalent to calling - \fontencoding, \fontfamily, \fontseries and \fontshape with the - given parameters, followed by \selectfont. - -2.4 Parameters - - The input file specification indicates the file to be - formatted; TeX uses .tex 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. - - latex \scrollmode\input foo.tex - - will process foo.tex without pausing after every error. - - 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 texput.log. - -3 LaTeX Packages - -3.1 amsmath - - amsmath consists of several packages to aid in typesetting - math. - - \boldsymbol - 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 \bm command which takes - better care of spacing. - - \pmb - 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! - -3.2 dcolumn - - \usepackage{dcolumn} - - Defines a system for defining columns of entries in an array or - tabular which are to be aligned on a decimal point. - - This package defines D to be a column specifier with three - arguments: -D{sep.tex}{sep.dvi}{decimal places} - - sep.tex should be a single character, this is used as the - separator in the .tex file. It will usually be '.' or ','. - - sep.dvi is used as the separator in the output. - - decimal places should be the maximum number of decimal places - in the column. - - \newcolumntype can be used to define own column types. - -3.3 float - -Note - - The contents of this section was taken from the documentation - of float v1.3d of 2001/11/08. - - “This style option improves the interface for defining objects - such as figures and tabels in LaTeX. It adds the notion of a - float style that governs the appearance of floats.” - - \newfloat{<placement>}{<ext>}[<within>] - Add a new class of floats. - - \floatstyle{<style>} - Sets a default float style. - - \floatname{<style>}{<name>} - Define the float name used in the caption of a float. - - \floatplacement{<>}{<placement>} - Resets the default placement specifier of a class of - floats. - - \restylefloat<style> - Change styles for the standard float types figure and - table. - - \listof{<type>}{<title>} - Produces a list of all floats of a given class. - -3.4 fontenc - - \usepackage[T1]{fontenc} - - chooses T1-fonts and allows correct automatic hyphenation. - -3.5 german - - Das german Paket muß geladen sein: - - "a - erzeugt ein ä - - entsprechend "o, "u, "A, "O, "U, "s (ß) - - "ck - wird bei Trennung zu k-k - - "ff - wird bei Trennung zu ff-f - - entsprechend "ll, "mm, "pp, "rr, "tt - - \glqq - oder "` erzeugt untere doppelte Anführungszeichen - - \grqq - oder "' erzeugt obere doppelte Anführungszeichen - - \glq - erzeugt untere einfache Anführungszeichen - - \flqq - oder "< doppelte linke französische Anführungszeichen - - \frqq - oder "> doppelte rechte französische Anführungszeichen - - \flq - einfache linke französische Anführungszeichen - - \frq - einfache rechte französische Anführungszeichen - - "| - verhindert eine Ligatur an der Stelle - - \- - markiert mögliche Trennstelle, im restlichen Wort ist - keine Trennung mehr möglich - - "- - Trennvorschlag, der Rest des Wortes kann noch - automatisch getrennt werden - - "" - Trennvorschlag, bei dem bei einer Trennung kein - Bindestrich eingefügt wird - - "~ - Bindestrich, an dem nicht getrennt werden darf - - "= - Bindestrich, an dem getrennt werden darf - - \dq - erzeugt ein nicht-typographisches gerades - Anführungszeichen - -\texttt{\dq} - - < - oder \dq ergibt das Zoll-Zeichen - -3.6 graphics - - Look up details in grfguide. - -3.6.1 \includegraphics - - \includegraphics[]{picture-name} - - File extensions of the graphics should be omitted, so it's - easier to change the format (for example for pdf or ps output). - -3.6.2 \graphicspath - - \graphicspath{dir-list} - - dir-list is a list of absolute or relative paths, where the - command \includegraphics{} searches for the graphic files: - - \graphicspath{{eps/}{tiff/}} would cause the system to look in - the subdirectories eps and tiff of the current directory. This - is unix syntax, on a Mac it would be: - - \graphicspath{{:eps:}{:tiff:}} - - Under Windows/DOS use also the slash / to separate directories. - Not all tex installations can handle filenames with spaces. So - it's better to avoid them. - -3.7 hyperref - - For more infos read in the book LaTeX Web Companion or Mit - LaTeX ins Web. - -3.7.1 Options - - 4 - use Acrobat 4 features (default: false). - - a4paper, a5paper, b5paper, legalpaper, letterpaper, - executivepaper - use the specified paper size. - - anchorcolor - set color of anchors (default: black). - - backref - do bibliographical back references (default: false). - - baseurl - set base URL for document (default: empty). - - bookmarks - make bookmarks (default: true). - - bookmarksnumbered - put section numbers in bookmarks (default: false). - - bookmarksopen - open up bookmark tree (default: false). - - bookmarksopenlevel - level to which bookmarks are open (default: \maxdimen). - - bookmarkstype - to specify which `toc' file to mimic toc. - - breaklinks - allow links to break over lines (default: false). - - citebordercolor - color of border around cites (default: 0 1 0). - - citecolor - color of citation links (default: green). - - colorlinks - color links (default: false). - - debug - provide details of anchors defined (same as verbose, - default: false). - - draft - do not do any hyper linking (default: false). - - dvipdf, dvipdfm, dvips, dvipsone, dviwindo, hypertex, - latex2html, pdftex, tex4ht, textures, ps2pdf, vtex - use the specified backend. - - extension - suffix of linked files (default: dvi). - - filebordercolor - color of border around file links (default: 0 .5 .5). - - filecolor - color of file links (default: cyan). - - frenchlinks - use small caps instead of color for links (default: - false). - - hyperfigures - make figures hyper links (default: false). - - hyperindex - set up hyperlinked indices (default: true). - - hypertexnames - use guessable names for links (default: true). - - implicit - redefine LaTeX internals (default: true). - - linkbordercolor - color of border around links (default: 1 0 0). - - linkcolor - color of links (default: red). - - linktocpage - make page number, not text, be link on TOC, LOF and LOT - (default: false). - - menubordercolor - color of border around menu links (default: 1 0 0). - - menucolor - color for menu links (default: red). - - naturalnames - use LaTeX-computed names for links (default: false). - - nesting - allow nesting of links (default: false). - - pageanchor - put an anchor on every page (default: true). - - pagebackref - backreference by page number (default: false). - - pagebordercolor - color of border around page links (default: 1 1 0). - - pagecolor - color of page links (default: red). - - pdfauthor - text for PDF Author field (default: empty). - - pdfborder - width of PDF link border (default: 0 0 1; 0 0 0 for - colorlinks) - - pdfcenterwindow - position the document window center of the screen - (default: false). - - pdfcreator - text for PDF Creator field (default: LaTeX with hyperref - package). - - pdffitwindow - resize document window to fit document size (default: - false). - - pdfhighlight - set highlighting of PDF links (default: /I). - - pdfkeywords - text for PDF Keywords field (default: empty). - - pdfmenubar - make PDF viewer's menu bar visible (default: true). - - pdfnewwindow - make links that open another PDF file start a new window - (default: false). - - pdfpagelayout - set layout of PDF pages (default: empty). - - pdfpagemode - set default mode of PDF display (default: empty). - - pdfpagescrop - set crop size of PDF document (default: empty). - - pdfpagetransition - set PDF page transition style (default: empty). - - pdfproducer - text for PDF Producer field (default: empty). - - pdfstartpage - page at which PDF document opens (default: 1). - - pdfstartview - starting view of PDF document (default: /Fit). - - pdfsubject - text for PDF Subject field (default: empty). - - pdftitle - text for PDF Title field(default: empty). - - pdftoolbar - make PDF toolbar visible (default: true). - - pdfview - PDF `view' when on link traversal (default: empty). - - pdfwindowui - make PDF user interface elements visible (default: - true). - - plainpages - do page number anchors as plain arabic (default: true). - - raiselinks - raise up links (for HyperTeX backend; default: false). - - runbordercolor - color of border around run links (default: 0 .7 .7). - - unicode - Unicode encoded pdf strings (default: true). - - urlbordercolor - color of border around URL links (default: 0 1 1). - - urlcolor - color of URL links (default: magenta). - - verbose - be chatty (default: false). - -3.7.2 Commands - - \texorpdfstring{TeX-string}{pdf-string} - allows different texts for PDF or TeX creation. - -\section{The role of \texorpdfstring{H$_2$O}{water}} - - \href{URL}{Text} - the text will be resolved into a URL. The URL must be - complete, according to a base-url which might be defined - in a \hyperbaseurl. - -\href{http://www.karpfenteich.net/pit/}{Peter's input tips} - - \hyperbaseurl{URL} - defines a base URL, which is preset to a given URL. This - helps to make portable documents. - - \hyperimage{image-URL} - includes the picture of the URL reference. - - \hyperref{URL}{category}{name}{text}, \hyperref[mark]{text} - text is activated as a hyperlink to the point which is - defined with a \label command with the symbolic name - mark. - - \hyperlink{name}{text}, \hyertarget{name}{text} - \hyperlink creates an internal link to an object which - is somewhere defined with a \hypertarget command. - - For HTML the command \hyperlink inserts a # character in - front of each link. Thus it'll refer to the topical - document, while \href will expect a complete URL. - - \autoref{marker} - \autoref is a substitution for the standard \ref - command. It inserts a context sensitive phrase. - -see \autoref{foo} - - for a \label in a section will output see section 3 for - an example. - - There are macros to change the default output with the - help of the \renewcommand: - -\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* - - \nolinkurl - Allows line breaks in a verbatim like environment like - \url, but without the hyperlink function. This is useful - to define own commands like this example: - -\newcommand*{\urlw}[1]{\href{http://www.#1}% - {\nolinkurl{www.#1}}} - - This new defined command \urlw allows the user to - typeset a linkable (this function is offered by \href) - www.example.org address in the latex source like this: - -\urlw{example.org} - - This will produce the string www.example.org which is - hyperlinked and breakable (when the driver like pdfTeX - allows line breaks in links). - -3.8 inputenc - - \usepackage[encoding name]{inputenc} - - Allows to specify an input encoding for direct input of - character codes > 127, e.g. accented characters. - - Important encodings are: - - latin9, latin1 - Linux, Unix, VMS - - ansinew - Windows (codepage 1252) - - cp850 - OS/2, MSDOS (codpage 850) - - applemac - Apple Macintosh - -3.9 KOMA-Script - - The KOMA-Script package has a very detailed and well written - documentation. Read the scrguide for further information! :-) - -3.9.1 Page-Layout - - \typearea[BCOR]{DIV} - - \areaset[BCOR]{Breite}{Höhe} - -3.9.2 Options - - headinclude, headexclude, footinclude, footexclude - 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. - - DIV - is a factor which determins how large the used page size - is. This method takes care of good typography. - - Try values between 10 and 15. Higher values will cause - smaller margins. An example would be: DIV12. - - BCOR - Binding correction. Takes care of the loss of the - visible paper size when the paper is cut and a book is - bound. - -3.9.3 Letter Class scrlttr2 - - This reference is based on the excellent scrguien.pdf from - 2002-09-06. - -Options - -Defining Options Later - - \KOMAoptions{options list} - Use this to change options after loading the class. List - single or multiple options, separated by commas. - -Page Layout Options - - paper=format - Defines the paper format. - - BCOR=length, DIV=value, headlines=count - Divisor, binding correction, and number of headlines. - - enlargefirstpage - If true some more text would fit on the first page - -Other Layout Options - - twoside - Activate possibilities of a double-sided document, but - stay with with the one-sided layout as far as possible. - - cleardoublepage=style - Inserted pages by \cleardoublepage get one of these page - styles: - - + empty - + plain - + standard - - headsepline, footsepline - Insert a separator line below the head or above the - foot. - - mpinclude, mpexclude - These two options of the typearea package should not be - used with scrlttr2. - - pagenumber=position - This option defines if and where a page number will be - placed. Possible values are: - - bot, foot - Page number in foot, horizontal position not - changed - - botcenter, botcentered, botmiddle, footcenter, - footcentered, footmiddle - Page number infoot,centered - - botleft, footleft - Page number in foot, left justified - - botrigth, footright - Page number in foot, right justified - - center, centered, middle - Page number centered horizontally, vertical - position not changed - - false, no, off - No page number - - head, top - Page number in head, horizontal position not - changed - - headcenter, headcentered, headmiddle, topcenter, - topcentered, topmiddle - Page number in head, centered - - headleft, topleft - Page number in head, left justified - - headright, topright - Page number in head, right justified - - left - Page number left, vertical position not changed - - right - Page number right, vertical position not changed - - Default is botcenter - - parskip=value - Mark paragraphs alternatively by vertical skip. Possible - values are: - - false, off - Paragraph indentation instead of verticalk space - - full, on, true - One line vertical space between paragraphs; at - least 1 em free space in the last line. - - full* - One line vertical space betwen paragraphs; at - least a quarter of a line free space at the end of - a paragraph. - - full+ - One line vertical space betwen paragraphs; at - least a third of aline free space at the end of a - paragraph. - - full- - One line vertical space betwen paragraphs; last - line of a paragraph may be arbitrarily filled. - - half - Half a line vertical space between paragraphs; at - least 1 em free space in the last line. - - half* - Half a line vertical space between paragraphs; at - least a quarter of a line free space at the end of - a paragraph. - - half+ - Half a line vertical space between paragraphs; at - least a third of a line free space at the end of a - paragraph. - - half- - One line vertical space between paragraphs; last - line may be arbitrarily filled. - - Default is false. - -Font Options - - fontsize=size - Font size of the document. Defaults to 12pt. - -Options for Letterhead and Address - - fromalign - Defines the placement of the from address in the - letterhead. Possible values are: - - center, centered, middle - Return address centered. - - false, no, off - Standard design for return address. - - left - Left justified return address. - - rigth - Right justified return address. - - Default is left - - fromrule - Allows to place a horizontal rule within return address. - Possible values are: - - afteraddress, below, true, yes - Line below return address - - aftername - Line right below sender's name - - false, no, off - No line. - - Default is false. - - fromphone - Defines whether the phone number will be part of the - return address. - - fromfax - Defines whether the facsimile number will be part of the - return address. - - fromemail - Defines whether the email address will be part of the - return address. - - fromurl - Defines whether the URL will be part of the return - address. - - fromlogo - Defines whether the logo will be part of the return - address. - - addrfield - Defines whether a return address field will be set. - - backaddress - Defines whether a return address for window envelopes - will be set. - - subject - Choose of your subject should have a title and if the - subject should be set before or after the opening. - Possible values are: - - afteropening - Set subject after opening. - - beforeopening - Set subject before opening. - - titled - Add title to subject. - - untitled - Do not add title to subject. - - Defaults are beforeopening and untitled. - - locfield - Toggle between presets for the field width of - additionbal sender attributes. - - narrow - Small sender supplement field. - - wide - Wide sender supplement field. - - Default is narrow. - - foldmarks - Activates fold marks. - - numericaldate - Toggles between standard, language-dependent date - presentation and a short, numerical one. - - refline - Defines that the reference line may extend beyond the - normal type area. - -Format Options - - draft - Toggles between the final and the draft version. - -Letter Class Option Files - - \LoadLetterOption{name} - Load a lco file. name is the filename without suffix. - - Predefined lco files: - - DIN - For A4 size paper, complying with DIN 676. - - DINmtext - For A4 size paper, complying with DIN 676, but - using an alternate layout with more text on the - first page. - - KOMAold - Fo AQ4 paper size using a layout close to the - obsolete scrlettr class. - - SN - For Swiss letters with address field on the right - side, according to SN 010 130 - - SNleft - For Swiss letters with address field on the left - side. - - \LetterOptionNeedsPaperSize{option name}{paper size} - Useful to be abel to emit warnings if the user selects a - different paper size from the one the lco file is based - on. - -General Document Properties - -Font Selection - - See also the section for Changing Fonts in KOMA-Script (still - to be written). - - backaddress - Back address for a window envelope - - descriptionlabel - Label in a description environment - - fromaddress - Sender's address in letterhead - - fromname - Sender's address in letterhead if different from - fromaddress - - pagefoot - Footer, sometimes header of a page - - pagehead - Header, sometimes footer of a page - - pagenumber - Page number in footer or header - - subject - Subject in the opening - - title - Headline in the opening - -Page Style - - See also the section for Page Style in KOMA-Script (still to be - written). - - empty - Entirely empty headers and footers - - plain - Empty head and and only page number in header or footer - - headings - Automatic page headings - - myheadings - Manual page headings - -Variables - - The main difference between a command and a variable is that a - command usually triggers an action whereas a variable only - consists of plain text. Furthermore a variable can have an - additional description. - - \newkomavar[description]{name}, - \newkomavar*[description]{name}, \addtoreffields{name} - \newkomavar defines a new variable, addressed with name. - - The command \addtoreffields adds the variable name to - the reference fields. See section Business Line. - - The command \newkomavar* works like \newkomavar with an - additional call of the command \addtoreffields. - - Overview of all variables: - - backaddress - Back address for window envelopes - - backaddressseparator - Separator within the back address - - ccseparator - Separator between title of additional recipients and - additional recipients - - customer - Customer number - - date - Date - - emailseparator - Separator between e-mail name and e-mail address - - enclseparator - Separator between title of enclosure and and enclosures - - faxseparator - Separator between title of fax and fax number - - fromaddress - Sender's address without its name - - frombank - Sender's bank account - - fromemail - Sender's e-mail - - fromfax - Sender's fax number - - fromlogo - Commands for inserting the sender's logo - - fromname - Complete name of the sender - - fromphone - Sender's telephone number - - fromurl - URL of the sender - - invoice - Invoice number - - location - More details of the sender - - myref - Sender's reference - - place - Place - - placeseparator - Separator between place and date - - phoneseparator - Separator between title of telephone and telephone - number - - signature - Signature beneath the ending of the letter - - specialmail - Special mail - - subject - Subject - - subjectseparator - Separator between title of subject and subject - - title - Letter title - - toname - Complete name of recipient - - toaddress - Address of recipient without its name - - yourmail - Date of recipient's mail - - yourref - Recipient's reference - - \setkomavar{name}[description]{content}, - \setkomavar*{name}{description} - \setkomavar sets the content of the variable name. The - optional argument sets the description of the variable. - - \setkomavar* only sets the description. - - \usekomavar[command]{name}, \usekomavar*[command]{name} - \usekomavar gives you access to the content of the - variable name. - - \usekomavar* gives you access to the description of the - variable name. - - \ifkomavarempty{name}{true}{false}, - \ifkomavarempty*{name}{true}{false} - The true argument will be executed if the content or - description is empty. Otherwise the false argument will - be executed. - - The starred version handles the description of a - variable, the variant without star the content. - -Pseudo Lengths - - \@newplength{name} - Defines a new pseudo length - - \useplength{name} - Access value of pseudo length name - - \setlengthtoplength[factor]{length}{pseudo length} , - \addtolengthplength[factor]{length}{pseudo length} - Assign a multiple of pseudo length to a real length. - Adds a multiple of pseudo length to length. - - \@setplength[factor]{pseudo length}{value} , - \@addtoplength[factor]{pseudo length}{value} - Assign a multiple of a value to a pseudo length. Adds - value to pseudo length. - -Letter Declaration - -Letterhead - - firstheadvpos - Distance between the top of the sheet and the - letterhead. - - firstheadwidth - Width of the letterhead. - - fromname, fromaddress, fromphone, fromfax, fromemail, fromurl, - fromlogo - This variables give all statements concerning the sender - necessary to create the letterhead. - - phoneseparator, faxseparator, emailseparator, urlseparator - Separators for variables in letterhead. - - \firsthead{construction} - Create letterhead freely. - -Footer - - firstfootvpos - Distance between footer and upper border of the sheet. - - firstfootwidth - Width of letter's firstpage footer. - - \firstfoot{Construction} - Set definition for first page's footer - -Address - - toaddrvpos, toaddrhpos - Distance between address window of a window envelope and - the upper and left border of the sheet. - - toaddrwidth - Width of the address window. - - toaddrindent - Value of indentation for the address from the left - border. - - backaddress, backaddressseparator, backaddrheight - Double backslashes within return address will be - exchanged with backaddressseparator. Height of the - return address field. - - specialmail, specialmailindent, specialmailrightindent - Optionally set between return address and addressee. - specialmailindent and specialmailrightindent determine - left and right indentation. - - toname, toaddress - Usually not set directly by the user. - - \begin{letter}[options]{address} - Major point of the letter class. - - \AtBeginLetter{command} - Hook for commands run at begin of a letter. - -Sender's Extension - - locwidth - Declares width of sender's extensions. - - location - Content of sender's extension. - -Business Line - - refvpos - Distance between upper border of sheet and business - line. - - refwidth - Available width for the business line. - - refaftervskip - Vertical space to be inserted beneath business line. - - place, placeseparator - If all variables for business line are empty, the - content of place and placeseparator will be set, - followed by content of date. - - yourref, yourmail, myref, customer, invoice, date - Typical fields for business lines. - -Title and Subject Line - - title - Additional tile. Set centered beneath the business line. - - subject, subjectseparator - Set the subject of the letter, optional prefixed by a - label. - -Further Issues - - tfoldmarkvpos, bfoldmarkvpos - Position of upper and lower fold mark. - - foldmarkhpos - Distance between fold marks and the sheet's left border. - - frombank - Internally not used yet. - - \nexthead{construction}, \nextfoot{construction} - Create letter head or foot for the following pages - freely. - -The Text - -Opening - - \opening{opening} - Set the opening of the letter. - -Footnotes - - See section Footnotes in KOMA-Script (still to be written). - -Lists - - See section Lists in KOMA-Script (still to be written). - -Margin Notes - - See section Margin Notes in KOMA-Script (still to be written). - -Text Emphasis - - See section Logical Markup of Text in KOMA-Script (still to be - written). - -Closing Part - -Closing - - signature - Inlcudes an explanation for the inscription. Defaults to - \usekomavar{fromname}. - - \closing{closing phrase} - Typesets the colsing phrase follwoed by a vertical space - and the contents fo variable signature. - - sigindent, sigbeforevskip, \raggedsignature - 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. - -Postscript, Carbon Copy, and Enclosures - - \ps - Set a postscript. - - \cc{distribution list}, ccseparator - Set a ddistribution list. If the contents of ccseparator - isn't empty then the name and the content of the - variable is inserted prior to distribution list. - - \encl{enclosures}, enclseparator - Same structur as the distribution list. - -Language Support - -Language Selection - - \captionenglish, \captionUSenglish, \captionamerican, - \captionbritish, \captionUKenglish, \captiongerman, - \captionngerman, \captionaustrian, \captionfrench, - \captionitalian, \captionspanish, \captiondutch, - \captioncroatian - If the used language selection scheme does not support - switching the language the above commands can be used - directly. - - \dateenglish, \dateUSenglish, \dateamerican, \datebritish, - \dateUKenglish, \dategerman, \datengerman, - \dateaustrian, \datefrench, \dateitalian, \datespanish, - \datedutch, \datecrotian - Numerical date representation. - -Language-Dependent Terms - - \yourrefname, \youremailname, \myrefname, \customername, - \invoicename, \subjectname, \ccname, \enclname, - \headtoname, \headfromname, \datename, \pagename, - \phonename, \faxname, \emailname, \wwwname, \bankname - These defintions can be modified to support a new - language of for private customization. - -Defining Language Terms - - \providecaptioname{language}{term}{definition}, - \newcaptioname{language}{term}{defintion}, - \renewcaptionname{language}{term}{definition} - Assign a definition for a language to a term. - -Address Files and Circular Letters - - \adrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{Comm - ent}{Key} - Address entry for address files. The file extension has - to be .adr! - - \addrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{F3} - {F4}{Key} - This command supports four freely definable parameters - for an address entry. - - \adrchar{initial letter}, \addrchar{initial letter} - Separator for address entries. Ignored by scrlttr2. - -3.9.4 Address Files with scraddr - - \InputAddressFile{file name} - Read the contents of the given address file. Filename - extension has to be .adr and has to be omitted in the - argument. - - \Name{Key}, \FirstName{Key}, \LastName{Key}, \Address{Key}, - \Telephone{Key}, \FreeI{Key}, \FreeII{Key}, - \Comment{Key}, \FreeIII{Key}, \FreeIV{Key} - Access to the data in address file. \Name is a - concatenation of \FirstName and \LastName. - - AdrFreeIVempty, AdrFreeIVshow, AdrFreeIVwarn, AdrFreeIVstop - Package warning options. Defaults to AdrFreeIVshow. - -3.10 mathpazo - - Math fonts for the use with the Palatino font. - -3.10.1 \upDelta / \upOmega - - Math fonts for the use with the Palatino font. - - Package options are: - - [slantedGreek] - Uppercase Greek will be typeset slanted. - - [noBBpl] - Do not use PazoMathBlackboardBold as (partial) - blackboard bold font (e.g with \mathbb{R}). - - [osf] - Make the font family pplj (Palatino with old style - numerals) the default roman font, and use an alternative - version of the virtual math italic fonts (zplmrj7m and - zplmbj7m) with upright Palatino old style numerals for - use with the \oldstylenums command. - - [osfeqnnum] - Use old style numerals for equation numbering. - -3.11 varioref - - Smarter version of the original latex2e cross reference - commands. Generated strings are customizable, Babel options are - recognized (further info in the package documentation). - - \vref, \vpageref - \vref is similar to \ref but adds an additional page - reference, like on the facing page or on page 27 - whenever the corresponding \label is not on the same - page. - - \vpageref is a variation of \pageref with similar - functionality. - - \vrefrange, \vpagerefrange - The \v...range 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. - - \vref*, \vpageref*, \vpagerefrange* - Star * variants do not add any space before the - generated text for situations like: - -(\vref{foo} ...) - -3.12 Several Small Packages - - Must be loaded with the usual \usepackage command. Further info - for a package to be found in the documentation (dvi, pdf, ps) - or in the sty-file itself. - -3.12.1 bm - - Bold math symbols or equations with better spacing then the - \boldsymbold command. If possible load after other packages - which redefine the fonts. When no bold font is available for a - certain char bm will use poor man's bold \pmb. - - \bm - Produces bold math symbol or equation. - - \unboldmath - Can be used to set parts of an equation unbold. - -3.12.2 url - - Defines line breakable hyperlinked (uses hyperref package) - verbatim input for urls and e-mail addresses. - - Example: \url{http://example.org} outputs http://example.org. - - Related commands are \href and \nolinkurl. - -4 Generic Packages - -4.1 PiCTeX (tbd.) - - tbd. - -4.2 PSTricks - -4.2.1 Overview - - The idea behind the PSTricks package of Timothy van Zandt is to - provide most of the PostScript language in LaTeX and TeX - syntax. - -4.2.2 Commands and Parameters - -4.2.2.1 Color - - \newgray{color}{num} , \newrgbcolor{color}{num1 num2 num3} , - \newhsbcolor{color}{num1 num2 num3} , - \newcmykcolor{color}{num1 num2 num3 num4} - - Note that these commands are obsolete for LaTeX. Load PSTricks - with \usepackage{pstcol} and use the standard LaTeX color - commands instead. - -4.2.2.2 Setting graphics parameters - - \psset{par1=value1,par2=value2,...} - -4.2.2.3 Dimensions, coordinates and angles - - \pssetlength{cmd}{dim} - - unit=dim, xunit=dim, yunit=dim, yunit=dim - Default: 1cm - - \degrees[num] - - \radians - -4.2.2.4 Basic graphics parameters - - linewidth=dim - Default: .8pt - - linecolor=color - Default: black - - showpoints=true/false - Default: false - -4.2.2.5 Lines and polygons - - linearc=dim - Default: 0pt - - framearc=num - Default: 0 - - cornersize=relative/absolute - Default: relative - - \psline*[par]{arrows}(x0,y0)(x1,y1)...(xn,yn) - - \qline(coor0)(coor1) - - \pspolygon*[par](x0,y0)(x1,y1)(x2,y2)...(xn,yn) - - \psframe*[par](x0,y0)(x1,y1) - -4.2.2.6 Arcs, circles and ellipses - - \pscircle*[par](x0,y0){radius} - - \qdisk(coor){radius} - - \pswedge*[par](x0,y0){radius}{angle1}{angle2} - - \psellipse*[par](x0,y0)(x1,y1) - - \psarc*[par]{arrows}(x,y){radius}{angleA}{angleB} - - \psarcn*[par]{arrows}(x,y){radius}{angleA}{angleB} - - arcsep=dim, arcsepA=dim, arcsepB=dim - Default: 0pt - -4.2.2.7 Curves - - \psbezier*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)(x3,y3) - - \parabola*[par]{arrows}(x0,y0)(x1,y1) - - \pscurve*[par]{arrows}(x1,y1)...(xn,yn) - - \psecurve*[par]{arrows}(x1,y1)...(xn,yn) - - \psccurve*[par]{arrows}(x1,y1)...(xn,yn) - - curvature=num1 num2 num3 - Default: 1 .1 0 - -4.2.2.8 Dots - - \psdots*[par](x1,y1)(x2,y2)...(xn,yn) - - dotstyle=style - Default: * - - Dots: *, o, +, triangle, triangle*, square, square*, - pentagon, pentagon*, | - - dotscale=num1 num2 - Default: 1 - - dotangle=angle - Default: 0 - -4.2.2.9 Grids - - \psgrid(x0,y0)(x1,y1)(x2,y2) - - gridwidth=dim - Default: .8pt - - gridcolor=color - Default: black - - griddots=num - Default: 0 - - gridlabels=dim - Default: 10pt - - gridlabelcolor=color - Default: black - - subgriddiv=int - Default: 5 - - subgridwidth=dim - Default: .4pt - - subgridcolor=color - Default: gray - - subgriddots=num - Default: 0 - -4.2.2.10 Plots - - \fileplot*[par]{file} - - \dataplot*[par]{commands} - - \savedata{command}[data] - - \readdata{command}{file} - - \listplot*[par]{list} - - \psplot*[par]{xmin}{xmax}{function} - - \parametricplot*[par]{tmin}{tmax}{function} - - plotstyle=style - Default: line - - plotpoints=int - Default: 50 - -4.2.2.11 Coordinate systems - - origin={coor} - Default: 0pt,0pt - - swapaxes=true - Default: false - -4.2.2.12 Line styles - - linestyle=style - Default: solid - - dash=dim1 dim2 - Default: 5pt 3pt - - dotsep=dim - Default: 3pt - - border=dim - Default: 0pt - - bordercolor=color - Default: white - - doubleline=true/false - Default: false - - doublesep=dim - Default: 1.25\pslinewidth - - doublecolor=color - Default: white - - shadow=true/false - Default: false - - shadowsize=dim - Default: 3pt - - shadowangle=angle - Default: -45 - - shadowcolor=color - Default: darkgray - - dimen=outer/inner/middle - Default: outer - -4.2.2.13 Fill styles - - fillstyle=style - Default: none - - fillcolor=color - Default: white - - hatchwidth=dim - Default: .8pt - - hatchsep=dim - Default: 4pt - - hatchcolor=color - Default: black - - hatchangle=rot - Default: 45 - -4.2.2.14 Arrowheads and such - - arrows=style - Default: - - - Arrows: -, <->, >-<, <<->>, >>-<<, |-|, |*-|*, [-], (-), - o-o, *-*, oo-oo, **-**, c-c, cc-cc, C-C - - arrowsize=dim num - Default: 2pt 3 - - arrowlength=num - Default: 1.4 - - arrowinset=num - Default: .4 - - tbarsize=dim num - Default: 2pt 5 - - bracketlength=num, rbracketlength=num - Default: .15 - - dotsize=dim num - Default: .5pt 2.5 - - arrowscale=num1 num2 - Default: 1 - -4.2.2.15 Custom styles - - \newpsobject{name}{object}{par1=value1,...} - - \newpsstyle{name}{par1=value1,...} - -4.2.2.16 The basics - - \pscustom*[par]{commands} - -4.2.2.17 Parameters - - linetype=int - Default: 0 - -4.2.2.18 Graphics objects - - liftpen=0/1/2 - Default: 0 - -4.2.2.19 Safe tricks - - \newpath - - \moveto(coor) - - \closepath - - \stroke[par] - - \fill[par] - - \gsave - - \grestore - - \translate(coor) - - \scale{num1 num2} - - \rotate{angle} - - \swapaxes - - \msave - - \mrestore - - \openshadow[par] - - \closedshadow[par] - - \movepath(coor) - -4.2.2.20 Pretty safe tricks - - \lineto(coor) - - \rlineto(coor) - - \curveto(x1,y1)(x2,y2)(x3,y3) - - \rcurveto(x1,y1)(x2,y2)(x3,y3) - -4.2.2.21 For hackers only - - \code{code} - - \dim{dim} - - \coor(x1,y1)(x2,y2)...(xn,yn) - - \rcoor(x1,y1)(x2,y2)...(xn,yn) - - \file{file} - - \arrows{arrows} - - \setcolor{color} - -4.2.2.22 Pictures - - \pspicture*[baseline](x0,y0)(x1,y1) - - \endpspicture - -4.2.2.23 Placing and rotating whatever - - \rput*[refpoint]{rotation}(x,y){stuff} - - \uput*{labelsep}[refangle]{rotation}(x,y){stuff} - - \pslabelsep - - labelsep=dim - Default: 5pt - -4.2.2.24 Repetition - - \multirput*[refpoint]{angle}(x0,y0)(x1,y1){int}{stuff} - - \multips{angle}(x0,y0)(x1,y1){int}{graphics} - -4.2.2.25 Axes - - \psaxes*[par]{arrows}(x0,y0)(x1,y1)(x2,y2) - - Horizontal Vertical Dflt Description - Ox=num Oy=num 0 Label at origin. - Dx=num Dy=num 1 Label increment. - dx=dim oy=dim 0pt Dist btwn labels. - - labels=all/x/y/none - Default: all - - showorigin=true/false - Default: true - - ticks=all/x/y/none - Default: all - - tickstyle=full/top/bottom - Default: full - - ticksize=dim - Default: 3pt - - \psxlabel, \psylabel - - axesstyle=axes/frame/none - Default: axes - -4.2.2.26 Framed boxes - - framesep=dim - Default: 3pt - - boxsep=true/false - Default: true - - \psframebox*[par]{stuff} - - \psdblframebox*[par]{stuff} - - \psshadowbox*[par]{stuff} - - \pscirclebox*[par]{stuff} - - \cput*[par]{angle}(x,y){stuff} - - \psovalbox*[par]{stuff} - -4.2.2.27 Clipping - - \clipbox[dim]{stuff} - - \psclip{graphics} ... \endpsclip - -4.2.2.28 Rotation and scaling boxes - - \rotateleft{stuff} - - \rotateright{stuff} - - \rotatedown{stuff} - - \scalebox{num1 num2}{stuff} - - \scaleboxto(x,y){stuff} - -4.2.2.29 Nodes - - \rnode[refpoint]{name}{stuff} - - \Rnode(x,y){name}{stuff} - - \RnodeRef - - \pnode(x,y){name} - - \cnode*[par](x,y){radius}{name} - - \circlenode*[par]{name}{stuff} - - \cnodeput*[par]{angle}(x,y){name}{stuff} - - \ovalnode*[par]{name}{stuff} - -4.2.2.30 Node connections - - nodesep=dim - Default: 0 - - offset=dim - Default: 0 - - arm=dim - Default: 10pt - - angle=angle - Default: 0 - - arcangle=angle - Default: 8 - - ncurv=num - Default: .67 - - loopsize=dim - Default: 1cm - - \ncline*[par]{arrows}{nodeA}{nodeB} - - \ncLine*[par]{arrows}{nodeA}{nodeB} - - \nccurve*[par]{arrows}{nodeA}{nodeB} - - \ncarc*[par]{arrows}{nodeA}{nodeB} - - \ncbar*[par]{arrows}{nodeA}{nodeB} - - \ncdiag*[par]{arrows}{nodeA}{nodeB} - - \ncdiagg*[par]{arrows}{nodeA}{nodeB} - - \ncangle*[par]{arrows}{nodeA}{nodeB} - - \ncangles*[par]{arrows}{nodeA}{nodeB} - - \ncloop*[par]{arrows}{nodeA}{nodeB} - - \nccircle*[par]{arrows}{node}{radius} - - \pcline*[par]{arrows}(x1,y1)(x2,y2) - - \pccurve*[par]{arrows}(x1,y1)(x2,y2) - - \pcarc*[par]{arrows}(x1,y1)(x2,y2) - - \pcbar*[par]{arrows}(x1,y1)(x2,y2) - - \pcdiag*[par]{arrows}(x1,y1)(x2,y2) - - \pcangle*[par]{arrows}(x1,y1)(x2,y2) - - \pcloop*[par]{arrows}(x1,y1)(x2,y2) - -4.2.2.31 Attaching labels to node connections - - \lput*[refpoint]{rotation}(pos){stuff} - - \aput*[labelsep]{angle}(pos){stuff} - - \bput*[labelsep]{angle}(pos){stuff} - - \mput*[refpoint]{stuff} - - \Aput*[labelsep]{stuff} - - \Bput*[labelsep]{stuff} - -4.2.2.32 Coils and zigzags - - \pscoil*[par]{arrows}(x0,y0)(x1,y1) - - \psCoil*[par]{angle1}{angle2} - - \pszigzag*[par]{arrows}(x0,y0)(x1,y1) - - coilwidth=dim - Default: 1cm - - coilheight=num - Default: 1 - - coilarm=dim - Default: .5cm - - coilaspect=angle - Default: 45 - - coilinc=angle - Default: 10 - - \nccoil*[par]{arrows}{nodeA}{nodeB} - - \nczigzag*[par]{arrows}{nodeA}{nodeB} - - \pccoil*[par]{arrows}(x1,y1)(x2,y2) - - \pczigzag*[par]{arrows}(x1,y1)(x2,y2) - -4.2.2.33 Special coordinates - - \SpecialCoor - - Table 1.12. Special coordinates and angles - Coordinate Example Description - (x,y) (3,4) Cartesian coordinate. - (r;a) (3;110) Polar coordinate. - (node) (A) Center of node. - ([par]node) ([angle=45]A) Relative to node. - (!ps) (!5 3.3 2 exp) Raw PostScript. - (coor1|coor2) (A|1in;30) Combination. - - Angle Example Description - num 45 Angle. - (coor) (-1,1) Coordinate (vector). - !ps !33 sqrt Raw PostScript. - - \NormalCoor - -4.2.2.34 Overlays - - \overlaybox stuff\endoverlaybox - - \psoverlay{string} - - \putoverlaybox{string} - - gradbegin=color - Default: gradbegin - - gradend=color - Default: gradend - - gradlines=int - Default: 500 - - gradmidpoint=num - Default: .9 - - gradangle=angle - Default: 0 - -4.2.2.35 Typesetting text along a path - - \pstextpath[pos](x,y){graphics object}{text} - -4.2.2.36 Stroking and filling character paths - - \pscharpath*[par]{text} - - \pscharclip*[par]{text} ... \endpscharclip - -4.2.2.37 Exporting EPS files - - \TeXtoEPS ... \endTeXtoEPS - - \PSTtoEPS[par]{file}{graphics objects} - - bbllx=dim - Default: -1pt - - bblly=dim - Default: -1pt - - bburx=dim - Default: 1pt - - bbury=dim - Default: 1pt - - headerfile=file - Default: s - - headers=none/all/user - Default: none - -4.2.2.38 Boxes - - \psmathboxtrue, \psmathboxfalse - - \everypsbox{commands} - - \pslongbox{name}{cmd} - - \psverbboxtrue, \psverbboxfalse - -4.2.2.39 Tips and More Tricks - - \pslbrace, \psrbrace - -4.2.3 List of Additional PSTricks Packages - - psgo - Draw Go diagrams - - pst-blur - PSTricks package for "blurred" shadows - - pst-euc - Géométrie en LaTeX et PSTricks - - pst-fr3d - Three dimensional framed Boxes - - pst-ghsb - PSTricks package for HSB Gradients - - pst-gr3d - PSTricks package for 3D grids - - pst-lens - Optique géométrique - - pst-node - PSTricks package for nodes - - pst-ob3d - A PSTricks package for three dimensional basic objects - - pst-osci - Oscilloscopes with PSTricks - - pst-poly - Polygons with PSTricks - - pst-tree - PSTricks package for trees - - pst-uml - Draw easily diagrams with UML notation - - vaucansom.sty - Drawing automata - -5 fontinst (tbd.) - - tbd. - -6 ConTeXt (tbd.) - -6.1 Overview - - 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. - - Some of the unique features of ConTeXt are: - * Inline XML (including MathML, ChemML, and PhysML) - * really good XML support in general - * inline MetaPost - -7 Texinfo (tbd.) - - tbd. - -Chapter 2. pdfTeX - - Table of Contents - - 1 Options - - 1.1 --file-line-error-style - 1.2 --fmt format - 1.3 --help - 1.4 --ini - 1.5 --interaction mode - 1.6 --ipc - 1.7 --ipc-start - 1.8 --jobname name - 1.9 --kpathsea-debug bitmask - 1.10 --maketex fmt - 1.11 --no-maketex fmt - 1.12 --output-comment string - 1.13 --parse-first-line - 1.14 --progname name - 1.15 --recorder - 1.16 --shell-escape - 1.17 --translate-file tcxname - 1.18 --version - - 2 Environment - -Note - - The contents of this section was taken from pdftex(1). - -1 Options - - pdfTeX understands the following command line options. - -1.1 --file-line-error-style - - Print error messages in the form file:line:error which is - similar to the way many compilers format them. - -1.2 --fmt format - - Use format as the name of the format to be used, instead of the - name by which pdfTeX was called or a %& line. - -1.3 --help - - Print help message and exit. - -1.4 --ini - - Be pdfinitex, for dumping formats; this is implicitly true if - the program is called as pdfinitex. - -1.5 --interaction mode - - Sets the interaction mode. The mode can be one of batchmode, - nonstopmode, scrollmode, and errorstopmode. The meaning of - these modes is the same as that of the corresponding \commands. - -1.6 --ipc - - 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. - -1.7 --ipc-start - - As --ipc, and starts the server at the other end as well. - Whether this option is available is the choice of the - installer. - -1.8 --jobname name - - Use name for the job name, instead of deriving it from the name - of the input file. - -1.9 --kpathsea-debug bitmask - - Sets path searching debugging flags according to the bitmask. - See the Kpathsea manual for details. - -1.10 --maketex fmt - - Enable mktexfmt, where fmt must be one of tex or tfm. - -1.11 --no-maketex fmt - - Disable mktexfmt, where fmt must be one of tex or tfm. - -1.12 --output-comment string - - Use string for the DVI file comment instead of the date. - -1.13 --parse-first-line - - If the first line of the main input file begins with %& parse - it to look for a dump name or a --translate-file option. - -1.14 --progname name - - Pretend to be program name. This affects both the format used - and the search paths. - -1.15 --recorder - - Enable the filename recorder. This leaves a trace of the files - opened for input and output in a file with extension .fls. - -1.16 --shell-escape - - Enable the \write18{command} construct. The command can be any - Bourne shell command. This construct is normally disallowed for - security reasons. - -1.17 --translate-file tcxname - - Use the tcxname translation table. - -1.18 --version - - Print version information and exit. - -2 Environment - - See the Kpathsearch library documentation (the `Path - specifications' node) for the details of how the environment - variables are used when searching. The kpsewhich utility can be - used to query the values of the variables. - - 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. - - TEXMFOUTPUT - 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 TEXMFOUTPUT. There is no default - value for that variable. For example, if you say pdftex - paper and the current directory is not writable, if - TEXMFOUTPUT has the value /tmp, pdfTeX attempts to - create /tmp/paper.log (and /tmp/paper.pdf, if any output - is produced.) - - TEXINPUTS - Search path for \input and \openin 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 texmf.cnf file. - For example, set TEXINPUTS to ".:/home/usr/tex:" to - prepend the current direcory and ``/home/user/tex'' to - the standard search path. - - TEXFONTS - earch path for font metric (.tfm) files. - - TEXFORMATS - Search path for format files. - - TEXPOOL - Search path for pdfinitex internal strings. - - TEXEDIT - Command template for switching to editor. The default, - usually vi, is set when pdfTeX is compiled. - -Chapter 3. Metafont (tbd.) - - tbd. - -Chapter 4. MetaPost - - Table of Contents - - 1 Options - - 1.1 --file-line-error-style - 1.2 --help - 1.3 --ini - 1.4 --interaction mode - 1.5 --jobname name - 1.6 --kpathsea-debug bitmask - 1.7 --mem mem - 1.8 --parse-first-line - 1.9 --progname name - 1.10 --recorder - 1.11 -T - 1.12 --translate-file tcxname - 1.13 --troff - 1.14 --version - - 2 Environment - -Note - - The contents of this section was taken from mpost(1). - - 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. - -1 Options - - MetaPost understands the following command line options. - -1.1 --file-line-error-style - - Print error messages in the form file:line:error which is - similar to the way many compilers format them. - -1.2 --help - - Print help message and exit. - -1.3 --ini - - Be inimpost, for dumping bases; this is implicitly true if the - program is called as inimpost. - -1.4 --interaction mode - - Sets the interaction mode. The mode can be one of batchmode, - nonstopmode, scrollmode, and errorstopmode. The meaning of - these modes is the same as that of the corresponding commands. - -1.5 --jobname name - - Use name for the job name, instead of deriving it from the name - of the input file. - -1.6 --kpathsea-debug bitmask - - Sets path searching debugging flags according to the bitmask. - See the Kpathsea manual for details. - -1.7 --mem mem - - Use mem as the name of the mem to be used, instead of the name - by which MetaPost was called or a %& line. - -1.8 --parse-first-line - - If the first line of the main input file begins with %& parse - it to look for a dump name or a --translate-file option. - -1.9 --progname name - - Pretend to be program name. This affects both the format used - and the search paths. - -1.10 --recorder - - Enable the filename recorder. This leaves a trace of the files - opened for input and output in a file with extension .fls. - -1.11 -T - - Produce TROFF output. - -1.12 --translate-file tcxname - - Use the tcxname translation table. - -1.13 --troff - - As -T. - -1.14 --version - - Print version information and exit. - -2 Environment - - See the Kpathsearch library documentation (the `Path - specifications' node) for the details of how the environment - variables are use when searching. The kpsewhich utility can be - used to query the values of the variables. - - If the environment variable TEXMFOUTPUT is set, MetaPost - attempts to put its output files in it, if they cannot be put - in the current directory. - - Here is a list of the environment variables which affect the - behavior of MetaPost: - - MPINPUTS - Search path for input files. - - MFINPUTS - Auxiliary search path for input files with .mf - extensions. - - MPSUPPORT - Directory for various tables for handling included TeX - and troff. - - MPXCOMMAND - The name of a shell script that converts embedded - typesetting commands to a form that MetaPost - understands. Defaults: makempx for TeX and troffmpx for - troff. - - TEX - The version of TeX - or LaTeX - to use when processing - btex and verbatimtex commands. Default TeX. This version - of MetaPost allows you to use a `%&format' line instead. - - TROFF - The troff pipeline for btex and verbatimtex commands. - Default eqn -d\$\$ | troff - - MPEDIT - A command template for invoking an editor. - - A .mem file is a binary file that permits fast loading of macro - packages. MetaPost reads the default plain.mem unless another - .mem file is specified at the start of the first line with an & - just before it. There is also an mfplain.mem that simulates - plain Metafont so that MetaPost can read .mf fonts. (Plain - Metafont is described in The Metafontbook). - - Experts can create .mem files by invoking inimpost and giving - macro definitions followed by a dump command. - - The MetaPost language is similar to Metafont, but the manual A - User's Manual for MetaPost assumes no knowledge of Metafont. - MetaPost does not have bitmap output commands or Metafont's - online display mechanism. - -Chapter 5. BibTeX - - Table of Contents - - 1 Parameters - 2 Command Qualifiers - 3 bib files - - 3.1 @STRING command - 3.2 Entry Format - 3.3 Entry Types - 3.4 Field Text - 3.5 Field Types - - 4 bst files - - 4.1 ABBRV.BST - 4.2 ALPHA.BST - 4.3 PLAIN.BST - 4.4 SAMPLE.BST - 4.5 UNSRT.BST - -Note - - The contents of this section was taken from the HTML helppages - for BibTeX of Norman Walsh (Version 1.0, 12 Apr 94). - - 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. - -1 Parameters - - bibliography-file-spec - - 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. - -2 Command Qualifiers - - /BIBINPUTS /BIBINPUTS=(name,...) - - 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 /BIBINPUTS option. - - Default is /BIBINPUTS=(TEX_BIB:); TeX looks in the directory - associated with the logical name TEX_BIB. - - /STATS /STATS /NOSTATS [D] - - This qualifier is used while debugging .BST files to determine - BIBTEX memory usage. - - /TEXINPUTS /TEXINPUTS=(name,...) - - 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 /TEXINPUTS option. - - Default is /TEXINPUTS=(TEX_INPUTS); TeX looks in the directory - associated with the logical name TEX_INPUTS. - - /TRACE /TRACE /NOTRACE [D] - - This qualifier is used while debugging .BST files to follow - program flow. - -3 bib files - - This help entry contains the same information as Appendix B of - the LaTeX manual. It describes the format of a bibliography - database (.BIB) file. - - A bibliography database file may contains two types of entry - - an abbreviation definition or a reference entry for citation. - -3.1 @STRING command - - The @STRING command is used to define abbreviations for use by - BibTeX within the bibliography database file. The command - @string{jgg1 = "Journal of Gnats and Gnus, Series~1"} - - 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. - - 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: - @STRING{JgG1 = "Journal of Gnats and Gnus, Series~1"} - - A @string 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 @string - commands is at the beginning of the file. A @string 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'. - -3.2 Entry Format - - A bibliography database file contains a series of reference - entries like the following: - @BOOK{kn:gnus, - AUTHOR = "Donald E. Knudson", - TITLE = "1966 World Gnus Almanac", - PUBLISHER = {Permafrost Press}, - ADDRESS = {Novisibirsk} } - - The @BOOK 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 \cite command referring - to the entry. - - This entry has four fields, named AUTHOR, TITLE, PUBLISHER and - ADDRESS. 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. - - 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: -@BOOK(kn:gnus, author = {Donald E. Knudson}, - TITLE = "1966 World Gnus Almanac", - PUBLISHER = {Permafrost Press}, - ADDRESS = {Novisibirsk} ) - - 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 \cite commands in the LaTeX input file. - - The quotes or braces can be omitted around text consisting - entirely of numerals. The following two fields are equivalent: -Volume = "27" Volume = 27 - -3.3 Entry Types - - 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. - - 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: - - Required - 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. - - Optional - 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. - - Ignored - 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. - - BibTeX ignores the case of letters in the entry type. - -3.3.1 article entry - - An article from a journal or magazine. - - Format: -@ARTICLE{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, journal, year - - Optional fields: volume, number, pages, month, note, key - -3.3.2 book entry - - A book with an explicit publisher. - - Format: -@BOOK{citation_key, - required_fields [, optional_fields] } - - Required fields: author or editor, title, publisher, year - - Optional fields: volume, series, address, edition, month, note, - key - -3.3.3 booklet entry - - A work that is printed and bound, but without a named publisher - or sponsoring institution. - - Format: -@BOOKLET{citation_key, - required_fields [, optional_fields] } - - Required fields: title - - Optional fields: author, howpublished, address, month, year, - note, key - -3.3.4 conference entry - - 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. - - Format: -@CONFERENCE{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, booktitle, year - - Optional fields: editor, pages, organization, publisher, - address, month, note, key - -3.3.5 inbook entry - - A part of a book, which may be a chapter and/or a range of - pages. - - Format: -@INBOOK{citation_key, - required_fields [, optional_fields] } - - Required fields: author or editor, title, chapter and/or pages, - publisher, year - - Optional fields: volume, series, address, edition, month, note, - key - -3.3.6 incollection entry - - A part of a book with its own title. - - Format: -@INCOLLECTION{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, booktitle, year - - Optional fields: editor, pages, organization, publisher, - address, month, note, key - -3.3.7 inproceedings entry - - An article in the proceedings of a conference. - - Format: -@INPROCEEDINGS{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, booktitle, year - - Optional fields: editor, pages, organization, publisher, - address, month, note, key - -3.3.8 manual entry - - Technical documentation. - - Format: -@MANUAL{citation_key, - required_fields [, optional_fields] } - - Required fields: title - - Optional fields: author, organization, address, edition, month, - year, note, key - -3.3.9 mastersthesis entry - - A Master's thesis. - - Format: -@MASTERSTHESIS{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, school, year - - Optional fields: address, month, note, key - -3.3.10 misc entry - - Use this type when nothing else seems appropriate. - - Format: -@MISC{citation_key, - required_fields [, optional_fields] } - - Required fields: none - - Optional fields: author, title, howpublished, month, year, - note, key - -3.3.11 phdthesis entry - - A PhD thesis. - - Format: -@PHDTHESIS{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, school, year - - Optional fields: address, month, note, key - -3.3.12 proceedings entry - - The proceedings of a conference. - - Format: -@PROCEEDINGS{citation_key, - required_fields [, optional_fields] } - - Required fields: title, year - - Optional fields: editor, publisher, organization, address, - month, note, key - -3.3.13 techreport entry - - A report published by a school or other institution, usually - numbered within a series. - - Format: -@TECHREPORT{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, institution, year - - Optional fields: type, number, address, month, note, key - -3.3.14 unpublished entry - - A document with an author and title, but not formally - published. - - Format: -@UNPUBLISHED{citation_key, - required_fields [, optional_fields] } - - Required fields: author, title, note - - Optional fields: month, year, key - -3.4 Field Text - - 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. - - BibTeX manipulates the case of letters in the field text as - described in the subtopics below. - -3.4.1 Names - - 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. - - 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.) - - Most names can be entered in the obvious way, either with or - without a comma, as in the following examples: - - "John Paul Jones" "Jones, John Paul" "Ludwig von Beethoven" - "von Beethoven, Ludwig" - - 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: - - "Brinch Hansen, Per" - - To understand why, you must understand how BibTeX handles names - (for what follows, a "name" corresponds to a person). - - 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 - - "Per Brinch Hansen" - - instead, BibTeX would erroneously think "Brinch" were a - First-part token, just as "Paul" is a First-part token in - "John~Paul Jones". - - Here's another example: - - "Charles Louis Xavier Joseph de la Vallee Poussin" - - 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. - - 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: - - "{Barnes and Noble, Inc.}" "{Barnes and} {Noble, Inc.}" - "{Barnes} {and} {Noble,} {Inc.}" - - 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. - - So the two names - - "von Beethoven, Ludwig" "{von Beethoven}, Ludwig" - - 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. - - "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: - - "Ford, Jr., Henry" - - However, a few people do not use a comma. They are handled by - considering the "Jr." to be part of the last Last token: - - "{Steele Jr.}, Guy L." "Guy L. {Steele Jr.}" - - This name has no Jr part. - - To summarize, you may type a name in one of three forms: - - "First von Last" "von Last, First" "von Last, Jr, First" - - 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. - - If there are multiple authors or editors, their names must be - separated by the word "and", surrounded by spaces, not enclosed - in braces: - - AUTHOR = "Ralph Alpher and Bethe, Hans and George Gamow" - - 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." - - BibTeX's rules are actually a bit more complicated than - indicated here, but this description will suffice for most - names. - -3.4.2 Titles - - 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): - - TITLE = "The Agony and the Ecstasy" - - 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. - - "The Gnats and Gnus of {Africa}" "The Gnats and Gnus of - {A}frica" - -3.4.3 Abbreviations - - 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: - - " # % ' ( ) , = { } - - The abbreviation is typed in place of the text field, with no - braces or quotation marks. If 'jgg1' is an abbreviation for - - Journal of Gnats and Gnus, Series~1 - - then the following are equivalent: - - JOURNAL = jgg1 JOURNAL = "Journal of Gnats and Gnus, Series~1" - - Some abbreviations are predefined by the bibliography style. - These always include the usual 3 letter abbreviations for the - month: jan, feb, mar etc. - - 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. - - You can define your own abbreviations by using BibTeX's @STRING - command. - -3.5 Field Types - - 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. - - BibTeX ignores the case of letters in the field names. - -3.5.1 address field - - 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. - - Format: -ADDRESS = field_text - -3.5.2 annote field - - An annotation, used only for annotated bibliography styles - (which are not among the standard ones). - - Format: -ANNOTE = field_text - -3.5.3 author field - - The name(s) of the author(s). - - Format: -AUTHOR = field_text - -3.5.4 booktitle field - - Title of a book, part of which is being cited. - - Format: -BOOKTITLE = field_text - -3.5.5 chapter field - - A chapter number. - - Format: -CHAPTER = field_text - -3.5.6 edition field - - The edition of a book - for example, "second". - - Format: -EDITION = field_text - -3.5.7 editor field - - 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. - - Format: -EDITOR = field_text - -3.5.8 howpublished field - - How something strange has been published. - - Format: -HOWPUBLISHED = field_text - -3.5.9 institution field - - The institution that published the work. - - Format: -INSTITUTION = field_text - -3.5.10 journal field - - A journal name. Abbreviations are provided for many journals; - see the Local Guide. - - Format: -JOURNAL = field_text - -3.5.11 key field - - 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 \cite - command and at the beginning of the entry. - - Format: -KEY = field_text - -3.5.12 month field - - The month in which the work was published or, for an - unpublished work, in which it was written. - - Format: -MONTH = field_text - -3.5.13 note field - - Any additional information that can help the reader. - - Format: -NOTE = field_text - -3.5.14 number field - - 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. - - Format: -NUMBER = field_text - -3.5.15 organization field - - The organization sponsoring a conference. - - Format: -ORGANIZATION = field_text - -3.5.16 pages field - - 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. > - - Format: -PAGES = field_text - -3.5.17 publisher field - - The publisher's name. - - Format: -PUBLISHER = field_text - -3.5.18 school field - - The name of the school where a thesis was written. - - Format: -SCHOOL = field_text - -3.5.19 series field - - 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. - - Format: -SERIES = field_text - -3.5.20 title field - - The work's title. - - Format: -TITLE = field_text - -3.5.21 type field - - The type of a technical report - for example, "Research Note". - - Format: -TYPE = field_text - -3.5.22 volume field - - The volume of a journal or multivolume book work. - - Format: -VOLUME = field_text - -3.5.23 year field - - The year of publication or, for an unpublished work, the year - it was written. This field's text should contain only numerals. - - Format: -YEAR = field_text - -4 bst files - - Bibliography style files define the style of a bibliography - source list. - - The standard bibliography style files are PLAIN, UNSRT, ALPHA - and ABBRV. - - If you want to make a bibliography style of your own, look at - SAMPLE.BST. - -4.1 ABBRV.BST - - This style is the same as the style defined in PLAIN.BST, - except that entries are more compact because first names, month - names and journal names are abbreviated. - -4.2 ALPHA.BST - - This style is the same as the style defined in PLAIN.BST except - that entry labels like "Knu66", formed from the author's name - and the year of publication, are used. - -4.3 PLAIN.BST - - 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. - -4.4 SAMPLE.BST - - 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: - - [Jones79] Jones, R. L. and Richards, P. Q. The Birds and the - Bees. {\it Journal of Irreproducible Results 4}, 2 (Jan. 1979), - 27-33. - - [Jones82a] Jones, P. G. The Bees and the Trees ... (1982). - - [Jones82b] Jones, R. L. The Trees and the Peas ... (1982). - - [Krist74] Kristofferson, R. P. Peopl and Places ... (1974) - - 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. - -4.5 UNSRT.BST - - This style is that same as PLAIN.BST except that entries appear - in the order of their first citation. - -Chapter 6. Make-Index - - Table of Contents - - 1 Options - - 1.1 -c - 1.2 -g - 1.3 -i - 1.4 -l - 1.5 -q - 1.6 -r - 1.7 -s sty - 1.8 -o ind - 1.9 -t log - 1.10 -p no - 1.11 -L - 1.12 -T - - 2 Style File - - 2.1 Input Style Specifiers - 2.2 Output Style Specifiers - - 3 Example - 4 Ordering - 5 Special Effects - -Note - - The contents of this section was taken from the HTML helppages - for Make-Index of Norman Walsh (Version 1.0, 12 Apr 94). - - Some obvious errors in this documentation have been corrected - according to makeindex(1L). - - Additional information was taken from makeindex(1L) and the - program source files as found in teTeX 2.0.2. - - 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 .idx 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 (idx0) is used to - determine other related input/output files. The default input - file type is .idx. - -1 Options - - Make-Index is a Unix program, and therefore has a Unix-style - command line. Instead of qualifiers delimited with a slash (/), - Make-Index options are delimited with a hyphen (-). - -1.1 -c - - Enable blank compression. By default every blank counts in the - index key. The -c option ignores leading and trailing blanks - and tabs and compresses intermediate ones to a single space. - -1.2 -g - - 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 '+'). If the quote - character is not redefined, Make-Index will produce an error - message and abort. - -1.3 -i - - Use stdin as the input file. When this option is specified and - the -o is not, output is written to stdout. - -1.4 -l - - Use letter ordering. Default is word ordering (explained in the - Ordering section). - -1.5 -q - - Quiet mode, send no messages to stderr. By default progress and - error messages are sent to stderr as well as the transcript - file. The -q option disables the stderr messages. - -1.6 -r - - Disable implicit page range formation. By default three or more - successive pages will be automatically abbreviated as a range - (e.g. 1--5). The -r option disables it, making the explicit - range operators the only way to create page ranges (see the - Special Effects section below). - -1.7 -s sty - - Take sty 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. - -1.8 -o ind - - Take ind as the output index file. By default the file name - base of the first input file idx0 concatenated with the - extension .ind is used as the output file name. - -1.9 -t log - - Take log as the transcript file. By default the file name base - of the first input file idx0 concatenated with the extension - .ilg is used as the transcript file name. - -1.10 -p no - - Set the starting page number of the output index file to be no. - This is useful when the index file is to be formatted - separately. Other than pure numbers, three special cases are - allowed for no: any, odd, and even. 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 (idx0) with the extension .log. The last source page - is obtained by searching backward in the log file for the first - instance of a number included in [...]. 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: - - any - The starting page is the last source page number plus 1. - - odd - The starting page is the first odd page following the - last source page number. - - even - The starting page is the first even page following the - last source page number. - -1.11 -L - - Sort based on locale settings. String comparisons for sorting - are done using strcoll(3), which compares strings according to - the current locale category LC_COLLATE. - - Not available on all systems (depends on compile time - settings). - -1.12 -T - - Special support for Thai documents. - - Not available on all systems (depends on compile time - settings). - -2 Style File - - The style file format is very simple. It is a list of - <specifier, attribute> 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 `%' is a comment. The - following is a list of all the specifiers and their respective - arguments where <string> is an arbitrary string delimited by - double quotes ("..."), <char> is a single letter embraced by - single quotes ('...'), and <number> is a nonnegative integer. - The maximum length of a <string> 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 INDEXSTYLE. - -2.1 Input Style Specifiers - -2.1.1 actual <char> - - Default: @ - - The symbol which indicates that the next entry is to appear in - the actual index file. - -2.1.2 arg_close <char> - - Default: } - - This is the closing delimiter for the index entry argument. - -2.1.3 arg_open <char> - - Default: { - - This is the opening delimiter for the index entry argument. - -2.1.4 encap <char> - - Default: | - - The symbol which indicates that the rest of the argument list - is to be used as the encapsulating command for the page number. - -2.1.5 escape <char> - - Default: \\ - - 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. - - Notice that the two symbols must be distinct. - -2.1.6 keyword <string> - - Default: "\\indexentry" - - This is the command which tells Make-Index that its argument is - an index entry. - -2.1.7 level <char> - - Default: ! - - The delimiter which denotes a new level of subitem. - -2.1.8 quote <char> - - Default: " - - quote 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. - -2.1.9 range_close <char> - - Default: ) - - The closing delimiter indicating the end of an explicit page - range. - -2.1.10 range_open <char> - - Default: ( - - The opening delimiter indicating the beginning of an explicit - page range. - -2.2 Output Style Specifiers - -2.2.1 page_compositor <string> - - Default: "-" - - This specifier is used to separate a range of page numbers. - - Officially undocumented! - -2.2.2 preamble <string> - - Default: "\\begin{theindex}\n" - - The preamble of actual index file. - -2.2.3 postamble <string> - - Default: "\n\n\\end{theindex}\n" - - The postamble of actual index file. - -2.2.4 setpage_prefix <string> - - Default: "\n \\setcounter{page}{" - - The prefix of the command which sets the starting page number. - -2.2.5 setpage_suffix <string> - - Default: "}\n" - - The suffix of the command which sets the starting page number. - -2.2.6 group_skip <string> - - Default: "\n\n \\indexspace\n" - - The vertical space to be inserted before a new group begins. - -2.2.7 heading_prefix <string> - - Default: "" - - The header prefix to be inserted before a new letter begins. - -2.2.8 heading_suffix <string> - - Default: "" - - The header suffix to be inserted before a new letter begins. - -2.2.9 headings_flag <string> - - Default: 0 - - 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. - -2.2.10 symhead_positive <string> - - Default: "Symbols" - - Heading for symbols to be inserted if headings_flag is - positive. - -2.2.11 symhead_negative <string> - - Default: "symbols" - - Heading for symbols to be inserted if headings_flag is - negative. - -2.2.12 numhead_positive <string> - - Default: "Numbers" - - Heading for numbers to be inserted if headings_flag is - positive. - -2.2.13 numhead_negative <string> - - Default: "numbers" - - Heading for numbers to be inserted if headings_flag is - negative. - -2.2.14 item_0 <string> - - Default: "\n \\item " - - The command to be inserted between two primary (level 0) items. - -2.2.15 item_1 <string> - - Default: "\n \\subitem " - - The command to be inserted between two secondary (level 1) - items. - -2.2.16 item_2 <string> - - Default: "\n \\subsubitem " - - The command to be inserted between two level 2 items. - -2.2.17 item_01 <string> - - Default: "\n \\subitem " - - The command to be inserted between a level 0 item and a level 1 - item. - -2.2.18 item_x1 <string> - - Default: "\n \\subitem " - - 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. - -2.2.19 item_12 <string> - - Default: "\n \\subsubitem " - - The command to be inserted between a level 1 item and a level 2 - item. - -2.2.20 item_x2 <string> - - Default: "\n \\subsubitem " - - 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. - -2.2.21 delim_0 <string> - - Default: ", " - - The delimiter to be inserted between a level 0 key and its - first page number. Default is a comma followed by a blank. - -2.2.22 delim_1 <string> - - Default: ", " - - The delimiter to be inserted between a level 1 key and its - first page number. Default is a comma followed by a blank. - -2.2.23 delim_2 <string> - - Default: ", " - - The delimiter to be inserted between a level 2 key and its - first page number. Default is a comma followed by a blank. - -2.2.24 delim_n <string> - - Default: ", " - - The delimiter to be inserted between two page numbers for the - same key in any level. Default is a comma followed by a blank. - -2.2.25 delim_r <string> - - Default: "--" - - The delimiter to be inserted between the starting and ending - page numbers of a range. - -2.2.26 delim_t <string> - - Default: "" - - 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. - -2.2.27 encap_prefix <string> - - Default: "\\" - - The prefix for the command which encapsulates the page number. - -2.2.28 encap_infix <string> - - Default: "{" - - The prefix for the command which encapsulates the page number. - -2.2.29 encap_suffix <string> - - Default: "}" - - The suffix for the command which encapsulates the page number. - -2.2.30 line_max <number> - - Default: 72 - - The maximum length of a line in the output beyond which a line - wraps around. - -2.2.31 indent_space <string> - - Default: "\t\t" - - The space to be inserted in front of a wrapped line. Default is - two tabs. - -2.2.32 indent_length <number> - - Default: 16 - - The length of indent_space. In the default case this is 16 (for - 2 tabs). - -2.2.33 suffix_2p <string> - - Default: "" - - Delimiter to replace the range delimiter and the second page - number of a two page list. When present, it overrides delim_r. - -2.2.34 suffix_3p <string> - - Default: "" - - Delimiter to replace the range delimiter and the second page - number of a three page list. When present, it overrides delim_r - and suffix_mp. - -2.2.35 suffix_mp <string> - - Default: "" - - Delimiter to replace the range delimiter and the second page - number of a multiple page list (three or more pages). When - present, it overrides delim_r. - -3 Example - - The following example shows a style file called book.isty which - defines a stand-alone index for a book. By stand-alone, we mean - it can be formatted independent of the main source. -preamble -"\\documentstyle[12pt]{book} -\\begin{document} -\\begin{theindex} -{\\small\n" - -postamble -"\n\n} -\\end{theindex} -\\end{document}\n" - - Suppose a particular book style requires the index (as well as - any chapters) to start from an odd page number. Given foo.idx - as the raw index file, the following command line produces an - index in file foo-.ind. -makeindex -s book.isty -o foo-.ind -p odd foo - - The reason to use a non-default output file name is to avoid - clobbering the source output (presumably foo.dvi) because if - the index is in file foo.ind, its output will also be in - foo.dvi as a result of separate formatting using . In the - example the index is in foo-.ind, its output will be in - foo-.dvi and thus introduces no confusion. - -4 Ordering - - By default makeindex assumes word ordering. The -l 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: - word order letter order - sea lion seal - seal seal lion - - Numbers are sorted in numeric order. For instance, - 9 (nine), 123 - 123 10 (ten), see Derek, Bo - - Letters are first sorted with uppercase and lowercase - considered identical; then, within identical words the - uppercase letter precedes its lowercase counterpart. - - 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. - -5 Special Effects - - In the normal case entries such as -\indexentry{alpha}{1} -\indexentry{alpha!beta}{3} -\indexentry{alpha!beta!gamma}{10} - - in the raw index file will be converted to -\item alpha, 1 - \subitem beta, 3 - \subsubitem gamma, 10 - - in the output index file by Make-Index. Notice that the level - symbol (!) is used to delimit levels of nesting. - - It is possible to make an item appear in a designated form by - using the actual (@) operator. For instance, -\indexentry{alpha@{\it alpha\/}}{1} - - will become -\item {\it alpha\/} 1 - - after the conversion. The idea is that the pattern preceding @ - 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. - - It is also possible to encapsulate a page number with a - designated command using the encap (|) operator. For example, - in the default case, -\indexentry{alpha|bold}{1} - - will be converted to -\item alpha \bold{1} - - where \bold{n} will expand to {\bf n}. 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 encap_prefix, encap_infix, - and encap_suffix correspond respectively to backslash, left - brace, and right brace. If this is to be formatted by languages - other than , they would be defined differently. - - By the same token, the encap operator can be used to make cross - references in the index. For instance, -\indexentry{alpha|see{beta}}{1} - - will become -\item alpha \see{beta}{1} - - in the output index file after the conversion, where -\see{beta}{1} - - will expand to -{\it see\/} beta - - Notice that in a cross reference like this the page number - disappears. Therefore, where to insert such a command in the - source is immaterial. - - A pair of encap concatenated with range_open (|() and with - range_close (|)) creates an explicit page range. That is, -\indexentry{alpha|(}{1} -\indexentry{alpha|)}{5} - - will become -\item alpha, 1--5 - - 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. - - This explicit page range formation can also include an extra - command to set the page range in a designated font. Thus -\indexentry{alpha|(bold}{1} -\indexentry{alpha|)}{5} - - will become -\item alpha, \bold{1--5} - - A couple of special cases are worth mentioning here. First, - entries like -\indexentry{alpha|(}{1} -\indexentry{alpha|bold}{3} -\indexentry{alpha|)}{5} - - will be interpreted as -\item alpha, \bold{3}, 1--5 - - 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, -\indexentry{alpha|(}{i} -\indexentry{alpha}{iv} -\indexentry{alpha}{3} -\indexentry{alpha|)}{7} - - will be turned into -\item alpha, 1--iv, 3--7 - - with a warning message in the transcript complaining about the - illegal range formation. - - Finally, every special symbol mentioned in this section may be - escaped by the quote operator ("). Thus -\indexentry{alpha"@beta}{1} - - will actually become -\item alpha@beta, 1 - - as a result of executing Make-Index. However, if quote is - preceded by escape (\), its following letter is not escaped. - That is, -\indexentry{f\"ur}{1} - - means -\item f\"ur, 1 - - which represents umlaut accented u to the family of processors. - -Chapter 7. xindy - - Table of Contents - - 1 Command List - - 1.1 Processing Commands - 1.2 Markup Commands - 1.3 Raw Index Interface - - 2 Invoking xindy - - 2.1 Command Line Options - 2.2 Search Path - -Note - - The content of this section was taken from the original - documentation of xindy V2.1 (Doc/manual*.html). - - xindy means flexible indexing system. 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. - -1 Command List - - Here is the complete list of xindy's commands that may be used - in the index style. The symbol name always refers to a string. - We separate the commands into the processing and markup - commands. The commands are listed in alphabetical order. - - The parenthesis [ and ] denote optional parts of the syntax and - { and } denote the grouping of elements. A vertical bar - indicates alternatives. However, the enclosing round braces are - part of the syntax and must be supplied. - -1.1 Processing Commands - -1.1.1 define-alphabet - -(define-alphabet name string-list) - - Defines name to be the alphabet consisting of all elements of - the string-list. Examples: -(define-alphabet "example-alphabet" ("An" "Example" "Alphabet")) - - defines an alphabet consisting of exactly three symbols. For - the successor relationship holds: succ("An")="Example" and - succ("Example")="Alphabet". The built-in alphabet digits is - defined as follows: -(define-alphabet "digits" - ("0" "1" "2" "3" "4" "5" "6" "7" "8" "9")) - -1.1.2 define-attributes - -(define-attributes attribute-list) - - Defines all attributes the raw index may contain. Parameter - attribute-list is a list of list of strings. The nesting level - must not be more than 2. So (..(..)..) is allowed, whereas - (..(..(..)..)..) is not. - - 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 ("definition") and ( ("definition") - ) are equivalent. All elements forming a list are a so-called - attribute group. The members of a group are written to the - output file before any member of the following groups are - written. - - Examples of valid attributes lists are: - - ("definition" "usage") defines two attribute groups. The first - one contains all references with the attribute definition and - the second one all with the attribute usage. - - (("definition" "important") "usage") defines two attribute - groups. The first one contains all references with the - attributes definition or important and the second one all with - the attribute usage. In the attribute group ("definition" - "important") the attribute definition overrides important. - -1.1.3 define-crossref-class - -(define-crossref-class name [:unverified]) - - Defines name to be a class of cross references. We distinguish - two types of cross reference classes. Verified 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 - :unverified can be used to suppress this behaviour. - -1.1.4 define-letter-group - -(define-letter-group name [:before lgname] [:after lgname] - [:prefixes list-of-prefixes]) - -(define-letter-groups list-of-letter-groups) - - This command defines a letter group with name name, which must - be a string value, grouping all index entries that have a sort - key beginning with the prefix name. The command -(define-letter-group "a") - - is equivalent to the command -(define-letter-group "a" :prefixes ("a")) - - 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. - - Example: -(define-letter-group "a") - - defines a letter group containing all index entries beginning - with the string "a". -(define-letter-group "c" :after "a") - - defines a letter group containing all index entries beginning - with the string "c". The letter group appears behind the letter - group "a" -(define-letter-group "b" :after "a" :before "c") - - inserts letter group "b" between letter group "a" and "c". This - allows incremental definition of letter groups by extending - already defined ones. - - The arguments :after and :before 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. - - The command define-letter-groups (with an `s' at the end) is - simply an abbreviation for a sequence of define-letter-group - definitions where the elements are ordered in the ordering - given by the list. Example: -(define-letter-groups ("a" "b" "c") - - equals the definitions -(define-letter-group "a") -(define-letter-group "b" :after "a") -(define-letter-group "c" :after "b") - - See also commands markup-letter-group-list and - markup-letter-group for further information. - -1.1.5 define-location-class - -(define-location-class name layer-list - [:min-range-length num] - [:hierdepth depth] - [:var]) - - Defines name 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 :sep. If the keyword :min-range-length is - specified we define the minimum range length to be used when - building ranges. The argument num must be a positive integer - number or the keyword none in which case the building of ranges - is disallowed. If the switch :var is specified the declared - class is of type variable, i.e. it is a var-location-class. - Since building of ranges is currently only allowed for standard - classes :var and :min-range-length must not be used together. - The keyword argument :hierdepth can be used to declare that the - location references have to be tagged in a hierarchical form. - Its argument depth must be an integer number indicating the - number of layers the hierarchy does contain. See command - markup-locref-list for more information. Examples: -(define-location-class "page-numbers" ("arabic-numbers") - :minimum-range-length 3) - - Defines the location class page-numbers consisting of one layer - which is the alphabet arabic-numbers. 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 0, 1, ... 2313, etc. -(define-location-class "sections" :var - ("arabic-numbers" :sep "." - "arabic-numbers" :sep "." - "arabic-numbers")) - - defines a variable location class. Valid instances are 1, 1.1, - 1.2, 2, 2.4.5, but none of 2-3 (wrong separator), 1.2.3.4 (more - than 3 layers), 2.3.iv (roman number instead of arabic one). - -1.1.6 define-location-class-order - -(define-location-class-order list) - - Defines the order in which the location classes are written to - the output file. The parameter list is a list of names of - location classes. Examples: -(define-location-class-order - ("page-numbers" "sections" "xrefs")) - - 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. - -1.1.7 define-rule-set - -(define-rule-set name - [ :inherit-from ("rule-set" "rule-set-2") ] - :rules (<rule>...) ) - - 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 sort-rule. They do not add new - functionality that is not already present with sort-rule. - - A rule can be of the form: -<rule> ::= ("pattern" "replacement" - [:string|:bregexp|:egegexp] [:again]) - - The following incomplete example defines a new rule set of name - isolatin1-tolower that inherits definitions from rule set - latin-tolower, overriding or adding the sort rules in the list - of :rules. -(define-rule-set "isolatin1-tolower" - - :inherit-from ("latin-tolower") - - :rules (("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ("?" "?" :string :again) - ... - ) -...) - - Rule sets can be instantiated with the command use-rule-set. - For further descriptions on the sorting model refer to the - command sort-rule. - -1.1.8 define-sort-rule-orientations - -(define-sort-rule-orientations (orientations...)) - - Defines the order for the different sorting phases. The - currently implemented orientations are forward and backward. - This command must precede all sort-rule commands in an index - style. It defines the orientations and implicitly sets the - maximum number of sorting phases performed. - - For further descriptions on the sorting model refer to the - command sort-rule. - -1.1.9 merge-rule - -(merge-rule pattern replacement [:again] - [:bregexp | :eregexp | :string]) - - Defines a keyword mapping rule that can be used to generate the - merge key from the main key 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. - - The parameter pattern 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 basic regular expressions (BREs) or extended regular - expressions (EREs). You can use the switch :bregexp to force - the interpretation of the pattern as a BRE, or :eregexp to - interpret it as an ERE. If you want xindy to interpret the - pattern literally, use the switch :string. 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. - - The parameter replacement must be a string possibly containing - the special characters & (substitutes for the complete match) - and \1 ,..., \9 (substituting for the n-th submatch. Examples: -(merge-rule "A" "a") - - replaces each occurrence of the uppercase letter `A' with its - lowercase counterpart. -(merge-rule "\~"([AEOUaeou])" "\1") - - transforms the TeX umlaut-letters into their stripped - counterparts, such that `\"A ' is treated as an `A' afterwards. - - The following sequences have a special meaning: - - ` ~n ' - End of line symbol (linefeed). - - ` ~b ' - The ISO-Latin character with the lowest ordinal number. - - ` ~e ' - The ISO-Latin character with the highest ordinal number. - - ` ~~ ' - The tilde character. - - ` ~" ' - The double quote character. - - Tilde characters and double quotes have to be quoted themselves - with a tilde character. The special characters ` ~b ' and ` ~e - ' 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. ` m~e ' is lexicographically - placed between `m' and `n'. - - 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 -(merge-rule "[A-Z]" "&") - - it is more efficient (though less comfortable) to use -(merge-rule "A" "Ax") -(merge-rule "B" "Bx") -... -(merge-rule "Z" "Zx") - - 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 `alpha' is checked - before `.*', but `auto' and `a.*' are checked in order of their - definition. - - 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. - - Sometimes it is necessary to apply rules anew to the result of - a transformation. By specifying the keyword argument :again 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 -(merge-rule "\$(.*)\$" "\1" :again) - - deletes all surrounding `$ ' symbols from the input. - - See also command sort-rule. - -1.1.10 merge-to - -(merge-to attr-from attr-to [:drop]) - - A merge rule says that the attribute attr-from can be used to - build ranges in attr-to. Both attributes must name valid - attribute names. The switch :drop indicates, that the original - location reference with attribute attr-from has to be dropped - (removed), if a successful range was built with location - references in attribute attr-to. A detailed description is - given in the section about processing phases. - -1.1.11 require - -(require filename) - - 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 filename 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: -(require "french/alphabet.xdy") -(require "french/sort-rules.xdy") -(require "tex/locations.xdy") -(require "tex/markup.xdy") - - Submodules can load other submodules as well. If a file is - required that was already loaded, the require command is simply - ignored and processing continues without including this file - twice. See also command searchpath. - -1.1.12 searchpath - -(searchpath {path-string | path-list}) - - This command adds the given paths to the list of paths, xindy - searches for index style files. The argument path-string 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: -(searchpath ".:/usr/local/lib/xindy:/usr/local/lib/xindy/english:") - - 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 -(searchpath ("." - "/usr/local/lib/xindy" - "/usr/local/lib/xindy/english" - :default)) - - yields exactly the same result as the example above. Here - path-list must be a list of strings and/or the keyword(s) - :default and :last. The keyword :default signifies that the - default pathnames are to be inserted at the specified position - in the list. The keyword :last 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. - -1.1.13 sort-rule - -(sort-rule pattern replacement [:run level] [:again]) - - Defines a keyword mapping rule that can be used to generate the - sort key of an index entry from the merge key. This key is used - to sort the index entries lexicographically after they have - been merged using the merge key. - - The argument :run indicates that this rule is only in effect a - the specified level (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 - (new-sort-rules) that comes with this distribution. - - See command merge-rule for more information about keyword - rules. - -1.1.14 use-rule-set - -(use-rule-set [:run phase] - [:rule-set ( <rule-set>... )) - - This command instantiates the gives rule sets to be in effect - at sorting phase phase. The order of the rule sets given with - argument :rule-set 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. - - The following example declares that in phase 0 the rule sets - din5007 and isolatin1-tolower should be active, whereas in - phase 2 the other rule sets have to be applied. -(use-rule-set :run 0 - :rule-set ("din5007" "isolatin1-tolower")) - -(use-rule-set :run 1 - :rule-set ("resolve-umlauts" - "resolve-sharp-s" - "isolatin1-tolower" - )) - - For a discussion on rule sets refer to command define-rule-set. - -1.2 Markup Commands - - 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 - environments, the syntax and naming scheme of all commands - follows a simple structure. - - The commands can be separated into environment and - list-environment commands. All commands of the first group - support the keyword arguments :open and :close, whereas the - second group additionally supports the keyword argument :sep. - If one of these keyword arguments is missing, the default - markup tag is always the empty tag. The :open tag is always - printed before the object itself and the :close tag is always - printed after the object has been printed. If a list is printed - the :sep 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 `-list' as part of - their command name. - - Since the number of commands and the heavy usage of default and - specialized 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 - markup-trace. - - Here follows the list of markup commands in alphabetical order - with some of the commands grouped together. - -1.2.1 markup-attribute-group-list - -(markup-attribute-group-list [:open string] [:close string] - [:sep string]) - -(markup-attribute-group [:open string] [:close string] - [:group group-num]) - - Location class groups consist of lists of attribute groups. The - markup of this list can be defined with the command - markup-attribute-group-list. - - To allow different markup for different attribute groups the - command markup-attribute-group can be specialized on the group - number with the keyword argument :group which must be an - integer number. E.g., given are the groups ("definition" - "theorem") and ("default") with group numbers 0 and 1, then -(markup-attribute-group :open "<group0>" :close </group0>" - :group 0) - -(markup-attribute-group :open "<group1>" :close "</group1>" - :group 1) - - can be used to assign different markup for both groups in a - SGML-based language. - -1.2.2 markup-crossref-list - -(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]) - - A crossref class group contains cross references of the same - class. The separator between the classes is defined with the - (markup-locclass-list :sep)-parameter. A list of cross - references can be tagged with the command markup-crossref-list - that specializes on the :class argument. - - 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 command - markup-crossref-layer-list can be used. - - Each layer of a cross reference can be assigned two tags that - specialize on the class of the reference, like all other - commands. - - A suitable markup for a cross reference class see within - LaTeX2e could look like that: -(markup-crossref-list :class "see" :open "\emph{see} " - :sep "; ") -(markup-crossref-layer-list :class "see" :sep ",") -(markup-crossref-layer :class "see" - :open "\textbf{" :close "}") - - An example output could look like ... see house; garden,winter; - greenhouse - -1.2.3 markup-index - -(markup-index [:open string] [:close string] - [ :flat | :tree | :hierdepth depth ]) - - Defines the markup tags that enclose the whole index via the - :open and :close parameters. Examples: -(markup-index :open "Here comes the index~n" - :close "That's all folks!~n") - - defines that the :open string is printed before the rest of the - index and the :close string appears after the index is printed. - - Additionally one can specify the form of the generated index. - It is possible to produce flat indexes by specifying the switch - :flat, to generate a tree with the :tree switch or any kind of - mixture between both by specifying the depth up to which trees - shall be built with the parameter :hierdepth. Its argument - depth is the number of layers that can be formed into a tree. - Therefore :flat is an abbrevation of :hierdepth 0 and :tree is - an abbrevation of :hierdepth max-depth, with max-depth being - the maximum number of layers a keyword has. An example: the - keywords -("tree" "binary" "AVL") -("tree" "binary" "natural") - - can be transformed in the following ways: - - A flat index (:flat or :hierdepth 0) -tree binary AVL -tree binary natural - - with :hierdepth 1 -tree - binary AVL - binary natural - - and a tree (:tree or :hierdepth > 1) -tree - binary - AVL - natural - - Most often one will create tree-like indexes or ones that are - flat. - -1.2.4 markup-indexentry-list - -(markup-indexentry-list [:open string] [:close string] - [:sep string] [:depth integer]) - -(markup-indexentry [:open string] [:close string] - [:depth integer]) - - Letter groups consists of a list of index entries. The command - markup-indexentry-list defines the markup of these lists. The - markup can be specialized on the depth if the index is - hierarchically organized. The command -(markup-indexentry-list :open "\begin{IdxentList}" - :close "\end{IdxentList}" - :sep "~n") - - defines that the index entries of all layers are wrapped into - the given markup tags. If additionally -(markup-indexentry-list :open "\begin{IdxentListII}" - :close "\end{IdxentListII}" - :sep "~n" - :depth 2) - - 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. - - The command markup-indexentry 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 :depth 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. -(markup-indexentry :open "\begin{Indexentry}" - :close "\end{Indexentry}") - - defines that the index entries of all layers are wrapped into - the given markup tags. If additionally -(markup-indexentry :open "\begin{IndexentryII}" - :close "\end{IndexentryII}" - :depth 2) - - 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. - -1.2.5 markup-keyword-list - -(markup-keyword-list [:open string] [:close string] - [:sep string] [:depth integer]) - -(markup-keyword [:open string] [:close string] - [:depth integer]) - - The print key of an index entry consists of a list of strings. - The markup of this list can be defined with the command - markup-keyword-list. The keyword argument :depth may be - specified to define the markup of the list at a particular - depth. - - 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 markup-keyword. Since we maybe need different - markup for different layers, the optional keyword argument can - be used to specialize this markup for some depth. - -1.2.6 markup-letter-group-list - -(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]) - - The first command defines the markup of the letter group with - name group-name. 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 :open-head and :close-head - is specified additional markup is added as can be described as - follows: -<OPEN> - IF (:open-head OR :close-head) - <OPEN-HEAD> - transformer-of(<GROUP-NAME>) - <CLOSE-HEAD> - FI - <INDEXENTRIES...> -<CLOSE> - - Here, transformer-of 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 :upcase, :downcase and :capitalize which result in the - corresponding string conversions. If none of them is specified - no transformation is done at all. - - The command markup-letter-group defines the markup of the list - of letter groups. - -1.2.7 markup-locclass-list - -(markup-locclass-list [:open string] [:close string] - [:sep string]) - - Each index entry contains a list of location class groups. This - markup command can be used to define the markup of this list. - -1.2.8 markup-locref - -(markup-locref [:open string] [:close string] - [:class locref-class] - [:attr attribute] - [:depth integer]) - - The markup tags of a location reference can be specialized on - the three arguments :class, :attr and additionally, if - sub-references are used, :depth. Most often one will only use a - tag depending on the attribute. For example, all location - references with the attribute definition should appear in a - font series like bold, emphasizing the importance of this - location reference; those with the attribute default 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. -(markup-locref :open "<B>" :close "</B>" :attr "definition") -(markup-locref :open "<I>" :close "</I>" :attr "default") - -1.2.9 markup-locref-class - -(markup-locref-class [:open string] [:close string] - [:class locref-class]) - - 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 :class. - -1.2.10 markup-locref-layer - -(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]) - - 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). - - The first command allows to tag the elements of a layer list - differently. The first element of this list can is - specialisable with :layer 0, the next element with :layer 1, - etc. See the next example for an example. - -1.2.11 markup-locref-list - -(markup-locref-list [:open string] [:close string] [:sep string] - [:depth integer] [:class locref-class]) - - 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 - :class, and on :depth that specializes on the different - subentry levels when using location references with - sub-references. - - Given is a list of location references that have the class - description -(define-location-class "Appendix" - ("ALPHA" :sep "-" "arabic-numbers") - :hierdepth 2) - - This location class has instances like A-1, B-5, etc. The - keyword argument :hierdepth 2 informs xindy to markup these - location references in a hierarchical form. With the commands -(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") - - we obtain a markup sequence for some example data that could - look like - \bf A} 1,2,5; {\bf B} 5,6,9; {\bf D} 1,5,8; ... - -1.2.12 markup-range - -(markup-range [:open string] [:close string] [:sep string] - [:class locref-class] - [:length num] [:ignore-end]) - - A range consists of two location references. Markup can be - specified with the :open and :close arguments and one separator - given by the argument :sep. - - Since both location references are tagged with markup defined - by the command markup-locref 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 - :length can be used to define different markup for different - lengths. In conjunction with :length 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 :ignore-end. - - The markup tags for a range (X,Y) can be described as follows: -<OPEN> - Markup of location reference X -<SEP> - IF (not :ignore-end) - Markup of location reference Y - FI -<CLOSE> - - The following tags can be used to define a range of page - numbers (given in a location class page-numbers) without - considering the open and close parameters: -(markup-range :sep "-" :class "page-numbers") - - Location ranges then appear separated by a hyphen in a form - like this: - ..., 5-8, 19-23, ... - -1.2.13 (markup-trace [:on] [:open string] [:close string]) - - This command can be used to activate the tracing of all markup - commands xindy executes. The switch :on activates the trace. If - :on is omitted, the command line flag -t 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 :open is `<' and for :close is `>'. The - beginning of an example output could look like: -<INDEX:OPEN> - <LETTER-GROUP-LIST:OPEN> - <LETTER-GROUP:OPEN ["a"]> - <INDEXENTRY-LIST:OPEN [0]> - <INDEXENTRY:OPEN [0]> - <KEYWORD-LIST:OPEN [0]> - <KEYWORD:OPEN [0]> - ... - - We use a simple indentation scheme to make the structure of the - tags visible. The symbolic tag <LETTER-GROUP:OPEN ["a"]> for - example indicates that the tag that can be specified with the - command -(markup-letter-group :open "XXX" :group "a" ... ) - - 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 -(markup-trace :open "%%" :close "~n") - - or a definition in the TeX document like -\def\ignore#1{} - - combined with the command -(markup-trace :open "\ignore{" :close "}") - -1.3 Raw Index Interface - - This section can be skipped if the reader is not interested in - adapting xindy to a new document preparation system. - - 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 - perl, sed or awk 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. - - The format of the raw index interface of xindy is defined as - follows: -(indexentry { :key string-list [:print string-list] - | :tkey list-of-layers } - [:attr string] - { :locref string [:open-range | :close-range] - | :xref string-list } ) - - The pseudo variable string is a sequence of characters - surrounded by double quotes, e.g. -"Hi, it's me" "one" "a string with two \"double quotes\"" - - 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 string list - is simply a list of strings separated by whitespaces and - surrounded by round braces. An example of a string list is -("This" "is" "a" "list" "of" "strings") - - So far about the syntax. The semantics of the different - elements are described here. - - :key - The argument string list defines the keyword of the - index entry. It must be a list of strings, since the - keyword may consist of different layers such as ("heap" - "fibonacci"). - - :print - The optional print key defines the way the keyword has - to be printed in the markup phase. - - :tkey - Another possibility to define the keys of an index entry - is with the :tkey keyword argument. It can be used - instead of the :key and :print 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 - -:tkey (("This") ("is") ("a") ("bang" "BANG !!!")) - - is equivalent to - -:key ("This" "is" "a" "bang") -:print ("This" "is" "a" "BANG !!!") - - :locref - The reference an index entry describes can be a location - reference or a cross reference. The switch :locref - describes a location reference. Its optional arguments - are :open-range and :close-range. The string that must - be supplied must somehow encode the location reference. - It might look like the string "25" representing the page - number 25, or "Appendix-I" representing the first - appendix numbered in uppercase roman numerals. - - :open-range,:close-range - These are switches that do not take any arguments. They - describe the beginning and ending of a range, starting - or ending from the location reference that is given by - the argument :locref. If they are supplied, the location - reference may have influence on the way ranges are - build. - - :xref - These arguments choose the second alternative. The - argument string list of parameter :xref describes where - the index entry should point to. - - :attr - 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 default. - - Some examples: -(indexentry :key ("airplane") :locref "25" :attr "default") - - defines an index entry with the key airplane' indexed on page - 25'. This index entry has the attribute default. -(indexentry :key ("house") :xref("building") :attr "see") - - defines a cross reference with the key house pointing to the - term building. This cross reference belongs to the cross - reference class see. -(indexentry :key ("house") :xref("building") :open-range) - - is an invalid specification, since :open-range mustn't be used - together with cross references. - -2 Invoking xindy - -2.1 Command Line Options - - The following command line options are accepted: -xindy [-h] [-t] [-v] [-l logfile] [-o outfile] - [-L n] [-f filterprog] - indexstyle raw-index - - The argument indexstyle names a file, containing the index - style description. The argument raw-index names a file, - containing the raw index. Both arguments are mandatory. - - -h - Gives a short summary of all command line options. - - -l - Writes helpful information into the specified logfile. - For example, the keyword mappings are written into this - file, so one can check if the intended mappings were - actually performed this way. - - -o - Explicitly defines the name of the output file. If not - given, the name of the raw-index is used with its - extension changed to .ind (or added, if it had no - extension at all). - - -t - Enters tracing mode of the symbolic markup tags. The - format of the emitted tags can be defined with the - command markup-trace. - - -L - Set the xindy logging-level to n. - - -f - Run filterprog on raw-index before reading. The program - must act as a filter reading from stdin and writing to - stdout. The most obvious use of this option in - conjunction with TeX is to run -f tex2xindy on the index - file prior to reading the entries into xindy. - - -v - Shows the version number of xindy. - - Errors and warnings are reported to stdout and additionally to - the logfile if -l was specified. - -2.2 Search Path - - 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 XINDY_SEARCHPATH 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 searchpath for further details. - -Appendix A. Appendices - - Table of Contents - - 1 Bugs / Known Issues / Missing Features - 2 About this Document - 3 Release News - 4 GNU Free Documentation License - Index - -1 Bugs / Known Issues / Missing Features - - PDF - A PDF file is no longer supported. - - Texinfo - 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 docbook2X - project at http://docbook2x.sourceforge.net. - - vim-help - Quite a few poeple are asking for a version in vim-help - format. Srinath Avadhanula has already done some work on - this. - -2 About this Document - - The source format of this document is DocBook XML (V4.3). - - The various output formats were generated using: - * xsltproc (libxml2-2.6.26/libxslt-1.1.26) as XSLT processor - * DocBook XSL Stylesheets (V1.77.1) for HTML and Epub - - You'll always find the newest version of this document at - http://www.miwie.org/tex-refs/. - -3 Release News - - V0.4.1 12-12-03 - - + Removed obsolete file still referenced in Makefile (no - visible changes) - - V0.4.0 12-12-02 - - + Minor changes for Epub output - + Added missing IDs on some sections and tables - - V0.3.9 05-05-14 - - + Consistent naming scheme of IDs to ease the use of - this reference for other projects - + Added new section float in chapter LaTeX - - V0.3.8 04-10-28 - - + Minor changes in \maketitle - - V0.3.7 04-08-26 - - + Corrected typos and markup errors in chapter BibTeX - + Switched to DocBook XML V4.3 - + Added new section Options in chapter LaTeX - - V0.3.6 04-06-21 - - + Added a note in chapter LaTeX with the copyright and - permission notice of the original file latex2.texi - + Corrected typos and added missing hyperlinks in - chapter xindy - + PDF file optimized/linearized and some finetuning - - V0.3.5 04-05-01 - - + Added content to chapters MetaPost and pdfTeX - + Enhanced index for chapter Make-Index - - V0.3.4 04-04-24 - - + Version control system changed from CVS to SVN - + Added missing entries to chapter Make-Index - - V0.3.3 04-01-26 - - + Corrected again section Output Style Specifiers and - Input Style Specifiers of chapter Make-Index - + Corrected some symbols in the index - - V0.3.2 04-01-16 - - + Corrected sections Output Style Specifiers and Input - Style Specifiers of chapter Make-Index - + Enhanced index in PDF - - V0.3.1 04-01-06 - - + More work on PDF - + Modularized XSL stylesheet files - + Corrected some typos - - V0.3.0 03-12-25 - - + Changed document root to book - + More work on PDF version - + Using new XSL stylesheets V1.64.1 - + Minor fixes - - V0.2.6 03-10-27 - - + Rearranged appendix - + Work on PDF version - - V0.2.5 03-10-17 - - + Added contents of GNU FDL in appendix - + Using new XSL stylesheets V1.62.4 - + Switched to xsltproc as XSLT-processor - + Reedited some deeply nested sections - + Changed colors in CSS - - V0.2.4 03-09-06 - - + Added subsection dcolumn - + Subsection fontenc translated into english - + Corrected typo in \sbox - - V0.2.3 03-04-12 - - + Provide PDF output using ConTeXt and DocBook In - ConTeXt (still experimental) - + Reedited (beautified) sections LaTeX / Commands / - Counters | Cross References | Definitions | Layout | - Environments | Footnotes - - V0.2.2 03-01-26 - - + Added bzip2 compressed version of source and outfiles - tarball - + Using new XSL stylesheets V1.60.1 - + Eliminated more spurious  characters in HTML - output - - V0.2.1 03-01-18 - - + Using new XSL stylesheets V1.59.2 - + Eliminated spurious  characters - - V0.2.0 03-01-11 - - + Using new XSL stylesheets V1.58.1 - + Minor changes to CSS file - + License changed to GNU Free Documentation License - + Added subsection Commands and Parameters to section - PSTricks - + Reworked inputenc section - - V0.1.3 02-10-17 - - + Started rework of KOMA-Script section - + Added subsection Additional PSTricks Packages - + Using new XSL stylesheets V1.56.1 - - V0.1.2 02-10-01 - - + Reworked hyperref section - - V0.1.1 02-09-19 - - + Added template sections for PiCTeX and Texinfo - + Added subsection Release News in appendix About this - Document - + Using new XSL stylesheets V1.55.0 - + Added missing CSS file to outfiles tarball - + Corrected wrong FPI - - V0.1.0 02-08-20 - - + Eliminated trailing '.' in numbered sections - + Minor markup errors corrected - + Reworked CSS file - - V0.0.5 02-08-10 - - + Switched to DocBook XML 4.2 - + Sections 'Bibindex' and 'xindy' completed - - V0.0.4 02-07-25 - - + Section 'Makeindex' completed - - V0.0.3 02-07-13 - - + New XSL stylesheets solve bug in creating index (no - other changes) - - V0.0.2 02-07-05 - - + New (template) sections 'fontinst', 'Bibtex', - 'Makeindex', and 'xindy' - + New section 'Special Symbols' - + Added information for 'german' package - + Registered as a new project (tex-refs) on - freshmeat.net - - V0.0.1 02-06-21 - - + First official announcement - -4 GNU Free Documentation License - -Version 1.2, November 2002 - - 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 documen -t - 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 LI -ST. - -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. - diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check index e6a15e38bea..dc764cc5c2d 100755 --- a/Master/tlpkg/bin/tlpkg-ctan-check +++ b/Master/tlpkg/bin/tlpkg-ctan-check @@ -846,7 +846,7 @@ my @TLP_working = qw( tetragonos teubner tex-ewd tex-font-errors-cheatsheet tex-gyre tex-gyre-math tex-ini-files tex-label tex-locale tex-nutshell tex-overview tex-ps - tex-refs tex-virtual-academy-pl tex-vpat + tex-virtual-academy-pl tex-vpat tex4ebook texaccents texapi texblend texbytopic texcount texdate texdef texdiff texdimens texdirflatten texdoc texdraw texfindpkg texfot texinfo texilikechaps texilikecover diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds index 8a0e481944d..327c988b8d2 100755 --- a/Master/tlpkg/libexec/ctan2tds +++ b/Master/tlpkg/libexec/ctan2tds @@ -1419,6 +1419,7 @@ chomp (my $ctan_root = `tlpkginfo --ctan-root`); 'tex-implementors', "die 'skipping, verbatim mail archive'", 'tex-in-practice', "die 'skipping, old book examples'", 'tex-it', "die 'skipping, old support'", + 'tex-refs', "die 'skipping, removed on CTAN'", 'tex_it', "die 'skipping, old support'", 'texdoc', "&MAKEflatten", 'texdoctk', "die 'skipping, moribund, only in tl'", diff --git a/Master/tlpkg/tlpsrc/collection-langenglish.tlpsrc b/Master/tlpkg/tlpsrc/collection-langenglish.tlpsrc index 675aa7a55d8..dabd77b9c47 100644 --- a/Master/tlpkg/tlpsrc/collection-langenglish.tlpsrc +++ b/Master/tlpkg/tlpsrc/collection-langenglish.tlpsrc @@ -64,7 +64,6 @@ depend tds depend tex-font-errors-cheatsheet depend tex-nutshell depend tex-overview -depend tex-refs depend tex-vpat depend texbytopic depend texonly diff --git a/Master/tlpkg/tlpsrc/scheme-tetex.tlpsrc b/Master/tlpkg/tlpsrc/scheme-tetex.tlpsrc index 2614f9a8c24..227688f9b05 100644 --- a/Master/tlpkg/tlpsrc/scheme-tetex.tlpsrc +++ b/Master/tlpkg/tlpsrc/scheme-tetex.tlpsrc @@ -33,7 +33,6 @@ depend subfigure depend supertabular depend tamethebeast depend tds -depend tex-refs depend tie depend web depend xpdfopen diff --git a/Master/tlpkg/tlpsrc/tex-refs.tlpsrc b/Master/tlpkg/tlpsrc/tex-refs.tlpsrc deleted file mode 100644 index f02f3e16858..00000000000 --- a/Master/tlpkg/tlpsrc/tex-refs.tlpsrc +++ /dev/null @@ -1 +0,0 @@ -catalogue tex-references |