diff options
Diffstat (limited to 'Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml')
-rw-r--r-- | Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml | 13614 |
1 files changed, 0 insertions, 13614 deletions
diff --git a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml b/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml deleted file mode 100644 index 71d4c8cf3b5..00000000000 --- a/Master/texmf-doc/source/english/tex-refs/tex-refs-chapter-tex.xml +++ /dev/null @@ -1,13614 +0,0 @@ -<?xml version='1.0' encoding='ISO-8859-1'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % tex-refs-ent SYSTEM "tex-refs.ent" > -%tex-refs-ent; -]> - -<!-- $Id: tex-refs-chapter-tex.xml 146 2005-05-14 15:34:22Z mw $ --> - -<chapter id="tex" lang="en"> - <title id="tex-title">&tex;</title> - - <section id="plaintex"> - <title id="plaintex-title">&plaintex;</title> - <indexterm><primary>PlainTeX</primary></indexterm> - - <section id="plaintex-ovw"> - - <title id="plaintex-ovw-title">&overview;</title> - <para>For a really excellent reference of all &tex; primitive - control sequences see David Bausum's<indexterm><primary>People</primary><secondary>Bausum, David</secondary></indexterm> - <ulink url="http://www.tug.org/utilities/plain/cseq.html"> - <emphasis>&tex; Primitive Control Sequences</emphasis></ulink>. - </para> - </section> - </section> - - - <section id="latex"><title>&latex;</title> - - <note> - <para>The original file <filename>latex2e.texi</filename> contains - the following copyright and permission notice: - </para> - <para> - <quote>Permission is granted to make and distribute - verbatim copies of this manual provided the copyright - notice and this permission notice are preserved on all - copies.</quote> - </para> - <para> - <quote>Permission is granted to copy and distribute modified - versions of this manual under the conditions for verbatim - copying, provided that the entire resulting derived work is - distributed under the terms of a permission notice identical - to this one.</quote> - </para> - </note> - - <section id="opt-latex"> - <title id="opt-latex-title">Options</title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - </indexterm> - - <para>&latex; understands the following command line options.</para> - - <section id="opt-latex-file-line-error-style"> - <title><filename role="nohyphenation">-file-line-error-style</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-file-line-error-style</tertiary> - </indexterm> - <para>Print error messages in the form - <literal>file:line:error</literal>. - </para> - </section> - - <section id="opt-latex-fmt"> - <title><filename role="nohyphenation">-fmt=FMTNAME</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-fmt=FMTNAME</tertiary> - </indexterm> - <para>Use <literal>FMTMAME</literal> instead of program name - or a %& line. - </para> - </section> - - <section id="opt-latex-ini"> - <title><filename role="nohyphenation">-ini</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-ini</tertiary> - </indexterm> - <para>Be <command>initex</command>, for dumping formats; this - is implicitly true if the program is called as - <command>initex</command>. - </para> - </section> - - <section id="opt-latex-interaction mode"> - <title><filename role="nohyphenation">-interaction=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-interaction=STRING</tertiary> - </indexterm> - <para>Set interaction mode - (<literal>STRING=batchmode/nonstopmode/scrollmode/errorstopmode</literal>). - </para> - </section> - - <section id="opt-latex-ipc"> - <title><filename role="nohyphenation">-ipc</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-ipc</tertiary> - </indexterm> - <para>Send DVI output to a socket as well as the usual output file. - </para> - <para>Note: not available on all systems.</para> - </section> - - <section id="opt-latex-ipc-start"> - <title><filename role="nohyphenation">-ipc-start</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-ipc-start</tertiary> - </indexterm> - <para>As <literal>-ipc</literal>, and also start the server at the - other end. - </para> - <para>Note: not available on all systems.</para> - </section> - - <section id="opt-latex-jobname-name"> - <title><filename role="nohyphenation">-jobname=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-jobname=STRING</tertiary> - </indexterm> - <para>Set the job name to <literal>STRING</literal>. - </para> - </section> - - <section id="opt-latex-kpathsea-debug"> - <title><filename role="nohyphenation">-kpathsea-debug=NUMBER</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-kpathsea-debug=NUMBER</tertiary> - </indexterm> - <para>Sets path searching debugging flags according to the - bits of <literal>NUMBER</literal>. - </para> - </section> - - <section id="opt-latex-no-maketex"> - <title><filename role="nohyphenation">[-no]-maketex=FMT</filename></title> - <indexterm> - <primary>pdfTeX</primary> - <secondary>Options</secondary> - <tertiary>[-no]-maketex=FMT</tertiary> - </indexterm> - <para>Disable/enable <command>mktexFMT</command> generation - (FMT=tex/tfm). - </para> - </section> - - <section id="opt-latex-mltex"> - <title><filename role="nohyphenation">-mltex</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-mltex</tertiary> - </indexterm> - <para>Enable MLTeX extensions such as <literal>\charsubdef</literal>. - </para> - </section> - - <section id="opt-latex-output-comment"> - <title><filename role="nohyphenation">-output-comment=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-output-comment=STRING</tertiary> - </indexterm> - <para> use <literal>STRING</literal> for DVI file comment instead of date. - </para> - </section> - - <section id="opt-latex-parse-first-line"> - <title><filename role="nohyphenation">-parse-first-line</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-parse-first-line</tertiary> - </indexterm> - <para>Parse of the first line of the input file. - </para> - </section> - - <section id="opt-latex-progname"> - <title><filename role="nohyphenation">-progname=STRING</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-progname=STRING</tertiary> - </indexterm> - <para>Set program (and fmt) name to <literal>STRING</literal>. - </para> - </section> - - <section id="opt-latex-recorder"> - <title><filename role="nohyphenation">-recorder</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-recorder</tertiary> - </indexterm> - <para>Enable filename recorder. - </para> - </section> - - <section id="opt-latex-shell-escape"> - <title><filename role="nohyphenation">-shell-escape</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-shell-escape</tertiary> - </indexterm> - <para>Enable <literal>\write18{SHELL COMMAND}</literal>. - </para> - </section> - - <section id="opt-latex-src-specials"> - <title><filename role="nohyphenation">-src-specials</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-src-specials</tertiary> - </indexterm> - <para>Insert source specials into the DVI file. - </para> - </section> - - <section id="opt-latex-src-specials-where"> - <title><filename role="nohyphenation">-src-specials=WHERE</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-src-specials=WHERE</tertiary> - </indexterm> - <para>Insert source specials in certain places of - the DVI file. <literal>WHERE</literal> is a comma-separated - value list: <literal>cr display hbox math par parend vbox</literal>. - </para> - </section> - - <section id="opt-latex-translate-file-tcxname"> - <title><filename role="nohyphenation">-translate-file=TCXNAME</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-translate-file=TCXNAME</tertiary> - </indexterm> - <para>Use the <literal>TCX</literal> file <literal>TCXNAME</literal>. - </para> - </section> - - <section id="opt-latex-help"> - <title><filename role="nohyphenation">-help</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-help</tertiary> - </indexterm> - <para>Display this help and exit. - </para> - </section> - - <section id="opt-latex-version"> - <title><filename role="nohyphenation">-version</filename></title> - <indexterm> - <primary>LaTeX</primary> - <secondary>Options</secondary> - <tertiary>-version</tertiary> - </indexterm> - <para>Output version information and exit. - </para> - </section> - - </section> - - - <section id="overview"> - <title id="overview-title">&overview; of &latex; and - Local Guide - </title> - <indexterm><primary>&overview; of LaTeX</primary></indexterm> - <indexterm><primary>LaTeX overview</primary></indexterm> - - <para>The &latex; command typesets a file of text using the &tex; - program and the &latex; Macro package for &tex;. To be more - specific, it processes an input file containing the text - of a document with interspersed commands that - describe how the text should be formatted. It produces at - least three files as output: - </para> - <orderedlist> - <listitem> - <para>A <emphasis>Device Independent</emphasis>, or - <filename>.dvi</filename> file. This contains - commands that can be translated into - commands for a variety of output devices. You - can view the output of &latex; by using a program such as - <literal>xdvi</literal>, - which actually uses the <filename>.dvi</filename> file. - </para> - </listitem> - <listitem> - <para>A <emphasis>transcript</emphasis> or - <filename>.log</filename> file - that contains summary information and - diagnostic messages for any errors discovered in the input file. - </para> - </listitem> - <listitem> - <para>An <emphasis>auxiliary</emphasis> or - <filename>.aux</filename> file. This is used by &latex; itself, for things such as sectioning. - </para> - </listitem> - </orderedlist> - - <para>For a description of what goes on inside &tex;, you should consult - <citetitle>The TeXbook</citetitle> by Donald E. Knuth, - ISBN 0-201-13448-9, published jointly by the American - Mathematical Society and Addison-Wesley Publishing Company. - </para> - <para>For a description of &latex;, you should consult: - </para> - <para><citetitle>&latex;: A Document Preparation System</citetitle>, - by Leslie Lamport,<indexterm><primary>People</primary><secondary>Lamport, Leslie</secondary></indexterm> Addison-Wesley Publishing Company, 2nd edition, 1994. - </para> - <para><citetitle>The &latex; Companion</citetitle>, - by Michel - Goossens,<indexterm><primary>People</primary><secondary>Goossens, Michel</secondary></indexterm> Frank Mittelbach, <indexterm><primary>People</primary><secondary>Mittelbach, Frank</secondary></indexterm> and Alexander Samarin,<indexterm><primary>People</primary><secondary>Samarin, Alexander</secondary></indexterm> Addison-Wesley, 1994. - </para> - - </section> - - - <section id="commands"> - <title id="commands-title">Commands</title> - - <para>A &latex; command begins with the command name, - which consists of a <literal>\</literal> followed by - either (a) a string of letters or (b) a single non-letter. - Arguments contained in square brackets, - <literal>[]</literal>, - are optional while arguments - contained in braces, <literal>{}</literal>, are required. - </para> - <para>NOTE: &latex; is case sensitive. Enter all commands - in lower case unless explicitly directed to do otherwise. - </para> - - - <section id="counters"> - <title id="counters-title">Counters</title> - <indexterm><primary>Counters, a list of</primary></indexterm> - <indexterm><primary>Variables, a list of</primary></indexterm> - - <para>Everything &latex; numbers for you has a counter associated - with it. The name of the counter is the same as the name of - the environment or command that produces the number, except - with no <literal>\</literal> (<literal>enumi</literal> - - <literal>enumiv</literal> are used for - the nested enumerate environment). Below is a list - of the counters used in &latex;'s standard document - classes to control numbering. - </para> - <programlisting> -part paragraph figure enumi -chapter subparagraph table enumii -section page footnote enumiii -subsection equation mpfootnote enumiv -subsubsection</programlisting> - - <bridgehead renderas="sect5" id="cmd-addtocounter"><literal>\addtocounter</literal></bridgehead> - <indexterm><primary>\addtocounter{counter}{value}</primary></indexterm> - - <para>The <literal>\addtocounter</literal> command increments - the <literal>counter</literal> by the - amount specified by the <literal>value</literal> argument. - The <literal>value</literal> argument can be negative. - </para> - - <bridgehead renderas="sect5" id="cmd-alph-title"><literal>\alph{counter}</literal></bridgehead> - <indexterm><primary>\alph</primary></indexterm> - <indexterm><primary>\Alph</primary></indexterm> - - <para>This command causes the value of the - <literal>counter</literal> to be printed in - alphabetic characters. The <literal>\alph</literal> command - uses lower case alphabetic alphabetic characters, i.e., - <literal>a, b, c...</literal> while the - <literal>\Alph</literal> command uses upper case alphabetic - characters, i.e., - <literal>A, B, C...</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-arabic-title"><literal>\arabic{counter}</literal></bridgehead> - <indexterm><primary>\arabic</primary></indexterm> - - <para>The <literal>\arabic</literal> command causes the - value of the <literal>counter</literal> to be - printed in Arabic numbers, i.e., <literal>3</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-fnsymbol-title"><literal>\fnsymbol{counter}</literal></bridgehead> - <indexterm><primary>\fnsymbol</primary></indexterm> - - <para>The <literal>\fnsymbol</literal> command causes the - value of the <literal>counter</literal> to - be printed in a specific sequence of nine symbols that - can be used for numbering footnotes. - </para> - - <para>NB. <literal>counter</literal> must have a value - between 1 and 9 inclusive. - </para> - - <bridgehead renderas="sect5" id="cmd-newcounter-title"><literal>\newcounter{foo}[counter]</literal></bridgehead> - <indexterm><primary>\newcounter</primary></indexterm> - <indexterm><primary>Counters, creating</primary></indexterm> - - <para>The <literal>\newcounter</literal> command defines a new - counter named <literal>foo</literal>. - The counter is initialized to zero. - </para> - <para>The optional argument <literal>[counter]</literal> - causes the counter <literal>foo</literal> to be reset - whenever the counter named in the optional argument is - incremented. - </para> - - <bridgehead renderas="sect5" id="cmd-refstepcounter-title"><literal>\refstepcounter{counter}</literal></bridgehead> - <indexterm><primary>\refstepcounter</primary></indexterm> - - <para>The <literal>\refstepcounter</literal> command works - like <literal>\stepcounter</literal>. - See <link linkend="cmd-stepcounter-title">\stepcounter</link>, - except it also defines the current <literal>\ref</literal> - value to be the result of <literal>\thecounter</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-roman-title"><literal>\roman{counter}</literal></bridgehead> - <indexterm><primary>\roman</primary></indexterm> - <indexterm><primary>\Roman</primary></indexterm> - - <para>This command causes the value of the - <literal>counter</literal> to be printed in - Roman numerals. The <literal>\roman</literal> command - uses lower case Roman - numerals, i.e., <literal>i, ii, iii...</literal>, while - the <literal>\Roman</literal> command - uses upper case Roman numerals, i.e., - <literal>I, II, III...</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-stepcounter-title"><literal>\stepcounter{counter}</literal></bridgehead> - <indexterm><primary>\stepcounter</primary></indexterm> - - <para>The <literal>\stepcounter</literal> command adds - one to the <literal>counter</literal> and - resets all subsidiary counters. - </para> - - <bridgehead renderas="sect5" id="cmd-setcounter-title"><literal>\setcounter{counter}{value}</literal></bridgehead> - <indexterm><primary>\setcounter</primary></indexterm> - <indexterm><primary>Counters, setting</primary></indexterm> - - <para>The <literal>\setcounter</literal> command sets the - value of the <literal>counter</literal> to - that specified by the <literal>value</literal> argument. - </para> - - <bridgehead renderas="sect5" id="cmd-usecounter-title"><literal>\usecounter{counter}</literal></bridgehead> - <indexterm><primary>\usecounter</primary></indexterm> - - <para>The <literal>\usecounter</literal> command is used in - the second argument of the - <literal>list</literal> environment to allow the counter - specified to be used to number the list items. - </para> - - <bridgehead renderas="sect5" id="cmd-value-title"><literal>\value{counter}</literal></bridgehead> - <indexterm><primary>\value</primary></indexterm> - <indexterm><primary>Counters, getting the value of</primary></indexterm> - - <para>The <literal>\value</literal> command produces the - value of the <literal>counter</literal> named - in the mandatory argument. It can be used where &latex; - expects an integer or number, such as the second - argument of a <literal>\setcounter</literal> - or <literal>\addtocounter</literal> command, or in: - </para> -<programlisting> -\hspace{\value{foo}\parindent}</programlisting> - - <para>It is useful for doing arithmetic with counters.</para> - - </section> - - <section id="cross-references"> - <title id="cross-references-title">Cross References</title> - <indexterm><primary>Cross referencing</primary></indexterm> - - <para>One reason for numbering things like figures and - equations is to refer the reader to them, as in - <emphasis>See Figure 3 for more details.</emphasis> - A smarter version of the cross reference commands - is available in the package - <link linkend="varioref"><literal>varioref</literal></link>. - </para> - - <bridgehead renderas="sect5" id="cmd-label-title"><literal>\label{key}</literal></bridgehead> - <indexterm><primary>\label</primary></indexterm> - - <para>A <literal>\label</literal> command appearing in - ordinary text assigns to the - <literal>key</literal> the number of the current sectional - unit; one appearing - inside a numbered environment assigns that number to the - <literal>key</literal>. - </para> - <para>A <literal>key</literal> can consist of any sequence - of letters, digits, or punctuation characters. - Upper and lowercase letters are different. - </para> - <para>To avoid accidentally creating two labels with the same - name, it is common to use labels consisting of a prefix and - a suffix separated by a colon. The prefixes - conventionally used are - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>cha</literal> for chapters</simpara> - </listitem> - <listitem> - <simpara><literal>sec</literal> - for lower-level sectioning commands - </simpara> - </listitem> - <listitem> - <simpara><literal>fig</literal> for figures - </simpara> - </listitem> - <listitem> - <simpara><literal>tab</literal> for tables - </simpara> - </listitem> - <listitem> - <simpara><literal>eq</literal> for equations - </simpara> - </listitem> - </itemizedlist> - - <para>Thus, a label for a figure would look like - <literal>fig:bandersnatch</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-pageref"><literal>\pageref{key}</literal></bridgehead> - <indexterm><primary>\pageref</primary></indexterm> - <indexterm><primary>Cross referencing using page number</primary></indexterm> - - <para>The <literal>\pageref</literal> command produces the - page number of the place in the - text where the corresponding <literal>\label</literal> - command appears. ie. where - <literal>\label{key}</literal> appears. - For a smart version see - <link linkend="cmd-vpageref"><literal>\vpageref</literal></link>. - </para> - - - <bridgehead renderas="sect5" id="cmd-ref-title"><literal>\ref{key}</literal></bridgehead> - <indexterm><primary>\ref</primary></indexterm> - <indexterm><primary>Cross referencing using section number</primary></indexterm> - - <para>The <literal>\ref</literal> command produces the - number of the sectional unit, - equation number, ... of the corresponding - <literal>\label</literal> command. For a smart - version see <link linkend="cmd-vref">\vref</link>. - </para> - - </section> - - <section id="definitions"> - <title id="definitions-title">Definitions</title> - - <!-- FIXME: workaround for following bridgehead--> - - <bridgehead renderas="sect5" id="cmd-newcommand-title"><literal>\newcommand</literal></bridgehead> - <indexterm><primary>\newcommand</primary></indexterm> - <indexterm><primary>Commands, defining new ones</primary></indexterm> - <indexterm><primary>Defining a new command</primary></indexterm> - -<programlisting> -\newcommand{cmd}[args]{definition} -\newcommand{cmd}[args][default]{definition} -\renewcommand{cmd}[args]{definition} -\renewcommand{cmd}[args][default]{definition}</programlisting> - - <para>These commands define (or redefine) a command.</para> - <table frame="none"> - <title>Options for <literal>\newcommand</literal></title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>cmd</entry> - <entry>A command name beginning with a - <literal>\</literal>. For - <literal>\newcommand</literal> it - must not be already defined and must not begin - with <literal>\end</literal>; for - <literal>\renewcommand</literal> it must already - be defined. - </entry> - </row> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>args</entry> - <entry>An integer from 1 to 9 denoting the number of - arguments of the command being defined. - The default is for the command to have no arguments. - </entry> - </row> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>def</entry> - <entry>If this optional parameter is present, it - means that the command's first argument is - optional. The default value of the optional - argument is <literal>def</literal>. - </entry> - </row> - <row role="db2latex:rowvspace" rowsep="0"> - <entry>definition</entry> - <entry>The text to be substituted for every - occurrence of <literal>cmd</literal>; a - parameter of the form <literal>#n</literal> in - <literal>cmd</literal> is replaced by the text of - the nth argument when this substitution takes place. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <bridgehead renderas="sect5" id="cmd-newenvironment-title"><literal>\newenvironment</literal></bridgehead> - <indexterm><primary>\newenvironment</primary></indexterm> - <indexterm><primary>Environments, defining</primary></indexterm> - <indexterm><primary>Defining new environments</primary></indexterm> - -<programlisting> -\newenvironment{nam}[args]{begdef}{enddef} -\newenvironment{nam}[args][default]{begdef}{enddef} -\renewenvironment{nam}[args]{begdef}{enddef}</programlisting> - - <para>These commands define or redefine an environment.</para> - <table frame="none"> - <title>Options for <literal>\newenvironment</literal></title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry>nam</entry> - <entry>The name of the environment. For - <literal>\newenvironment</literal> there must be - no currently defined environment by that name, - and the command - <literal>\nam</literal> must be undefined. - For <literal>\renewenvironment</literal> the - environment must already be defined. - </entry> - </row> - <row rowsep="0"> - <entry>args</entry> - <entry>An integer from 1 to 9 denoting the number - of arguments of the newly-defined environment. - The default is no arguments. Arguments can only - be used in te <literal>{begdef}</literal> part. - </entry> - </row> - <row rowsep="0"> - <entry>default</entry> - <entry>If this is specified, the first argument is - optional, and <literal>default</literal> - gives the default value for that argument. - </entry> - </row> - <row rowsep="0"> - <entry>begdef</entry> - <entry>The text substituted for every occurrence of - <literal>\begin{nam}</literal>; a - parameter of the form <literal>#n</literal> in - <literal>cmd</literal> is replaced by the text of - the nth argument when this substitution takes place. - </entry> - </row> - <row rowsep="0"> - <entry>enddef</entry> - <entry>The text substituted for every occurrence - of <literal>\end{nam}</literal>. It may - not contain any argument parameters. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <bridgehead renderas="sect5" id="cmd-newtheorem-title"><literal>\newtheorem</literal></bridgehead> - <indexterm><primary>\newtheorem</primary></indexterm> - <indexterm><primary>Theorems, defining</primary></indexterm> - <indexterm><primary>Defining new theorems</primary></indexterm> - - <programlisting>\newtheorem{env_name}{caption}[within] -\newtheorem{env_name}[numbered_like]{caption}</programlisting> - - <para>This command defines a theorem-like environment.</para> - <table frame="none"> - <title>Options for <literal>\newtheorem</literal></title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry>env_name</entry> - <entry>The name of the environment to be defined. - A string of letters. It must - not be the name of an existing environment or counter. - </entry> - </row> - <row rowsep="0"> - <entry>caption</entry> - <entry>The text printed at the beginning of the - environment, right before the - number. This may simply say - <emphasis>Theorem</emphasis>, for example. - </entry> - </row> - <row rowsep="0"> - <entry>within</entry> - <entry>The name of an already defined counter, usually - of a sectional unit. Provides a means of - resetting the new theorem counter - <emphasis role="bold">within</emphasis> - the sectional unit. - </entry> - </row> - <row rowsep="0"> - <entry>numbered_like</entry> - <entry>The name of an already defined theorem-like environment. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>The <literal>\newtheorem</literal> command may have at - most one optional argument. - </para> - - <bridgehead renderas="sect5" id="cmd-newfont-title"><literal>\newfont</literal></bridgehead> - <indexterm><primary>\newfont</primary></indexterm> - <indexterm><primary>Fonts, new commands for</primary></indexterm> - <indexterm><primary>Defining new fonts</primary></indexterm> - - <para><literal>\newfont{cmd}{font_name}</literal> - </para> - <para>Defines the command name <literal>cmd</literal>, which - must not be currently - defined, to be a declaration that selects the font named - <literal>font_name</literal> to be the current font. - </para> - - </section> - - <section id="document-classes"> - <title id="document-classes-title">Document Classes</title> - <indexterm><primary>Document Classes</primary></indexterm> - <indexterm><primary>Classes of document</primary></indexterm> - <indexterm><primary>article class</primary></indexterm> - <indexterm><primary>report class</primary></indexterm> - <indexterm><primary>book class</primary></indexterm> - <indexterm><primary>letter class</primary></indexterm> - <indexterm><primary>\documentclass</primary></indexterm> - - <para>Valid &latex; document classes include: - </para> - <itemizedlist spacing="compact"> - <listitem><simpara>article</simpara> - </listitem> - <listitem><simpara>report</simpara> - </listitem> - <listitem><simpara>letter</simpara> - </listitem> - <listitem><simpara>book</simpara> - </listitem> - <listitem><simpara>slides</simpara> - </listitem> - </itemizedlist> - - <para>Other document classes are often available. - See <link linkend="overview">&overview;</link>, for details. - They are selected with the following command: - </para> - <para><literal>\documentclass [options] {class}</literal> - </para> - <para>All the standard classes (except slides) accept the - following options - for selecting the typeface size - (<literal>10pt</literal> is default): - </para> - <para><literal>10pt, 11pt, 12pt</literal></para> - <para>All classes accept these options for selecting the - paper size (default is letter): - </para> - <para>a4paper, a5paper, b5paper, letterpaper, legalpaper, - executivepaper - </para> - <para>Miscellaneous options: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>landscape --- selects landscape format. - Default is portrait. - </simpara> - </listitem> - <listitem> - <simpara>titlepage, notitlepage --- selects if there should - be a separate title page. - </simpara> - </listitem> - <listitem> - <simpara>leqno --- equation number on left side of equations. - Default is right side. - </simpara> - </listitem> - <listitem> - <simpara>fleqn --- displayed formulas flush left. - Default is centered. - </simpara> - </listitem> - <listitem> - <simpara>openbib --- use <emphasis>open</emphasis> - bibliography format. - </simpara> - </listitem> - <listitem> - <simpara>draft, final --- mark/do not mark overfull - boxes with a rule. Default is final. - </simpara> - </listitem> - </itemizedlist> - - <para>These options are not available with the slides class: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>oneside, twoside --- selects one- or twosided - layout. Default is - oneside, except for the book class. - </simpara> - </listitem> - <listitem> - <simpara>openright, openany --- determines if a chapter - should start on a - right-hand page. Default is openright for book. - </simpara> - </listitem> - <listitem> - <simpara>onecolumn, twocolumn --- one or two columns. - Defaults to one column. - </simpara> - </listitem> - </itemizedlist> - - <para>The slides class offers the option - <literal>clock</literal> for printing the time at - the bottom of each note. - </para> - <para>If you specify more than one option, they must be - separated by a comma. - </para> - <para>Additional packages are loaded by a - </para> - <para id="usepackage-linkend"> - <literal>\usepackage[options]{pkg}</literal> - <indexterm><primary>\usepackage</primary></indexterm> - </para> - <para>command. If you specify more than one package, they - must be separated by a comma. - <indexterm><primary>Packages, loading</primary></indexterm> - <indexterm><primary>Loading additional packages</primary></indexterm> - </para> - <para>Any options given in the <literal>\documentclass</literal> - command that are unknown - by the selected document class are passed on to the packages - loaded with <literal>\usepackage</literal>. - <indexterm><primary>Global options</primary></indexterm> - <indexterm><primary>Options, global</primary></indexterm> - </para> - - <indexterm><primary>Layout commands</primary></indexterm> - - </section> - - <section id="layout"> - <title id="layout-title">Layout</title> - - <para>Miscellaneous commands for controlling the general - layout of the page. - </para> - - <bridgehead renderas="sect5" id="cmd-flushbottom-title"><literal>\flushbottom</literal></bridgehead> - <indexterm><primary>\flushbottom</primary></indexterm> - - <para>The <literal>\flushbottom</literal> declaration makes - all text pages the same - height, adding extra vertical space when necessary to fill - out the page. - </para> - <para>This is the standard if twocolumn mode is selected. - </para> - - <bridgehead renderas="sect5" id="cmd-onecolumn-title"><literal>\onecolumn</literal></bridgehead> - <indexterm><primary>\onecolumn</primary></indexterm> - - <para>The <literal>\onecolumn</literal> declaration starts - a new page and produces single-column output. - </para> - - <bridgehead renderas="sect5" id="cmd-raggedbottom-title"><literal>\raggedbottom</literal></bridgehead> - <indexterm><primary>\raggedbottom</primary></indexterm> - - <para>The <literal>\raggedbottom</literal> declaration - makes all pages the height of the - text on that page. No extra vertical space is added. - </para> - - <bridgehead renderas="sect5" id="cmd-twocolumn-title"><literal>\twocolumn</literal></bridgehead> - <indexterm><primary>\twocolumn</primary></indexterm> - <indexterm><primary>Multicolumn text</primary></indexterm> - - <para><literal>\twocolumn[text]</literal> - </para> - <para>The <literal>\twocolumn</literal> declaration starts - a new page and produces - two-column output. If the optional <literal>text</literal> - argument is present, it - is typeset in one-column mode. - </para> - - </section> - - <!-- FIXME --> - - <section id="env-latex"> - <title id="env-latex-title">Environments</title> - <indexterm><primary>Environments</primary></indexterm> - <indexterm><primary>\begin</primary></indexterm> - <indexterm><primary>\end</primary></indexterm> - - <para>&latex; provides a number of different paragraph-making - environments. - Each environment begins and ends in the same manner. - </para> - <programlisting> -\begin{environment-name} - . - . - . -\end{environment-name}</programlisting> - - <bridgehead renderas="sect5" id="env-array">array</bridgehead> - <indexterm><primary>Arrays, math</primary></indexterm> - <indexterm><primary>array</primary></indexterm> - - <programlisting> -\begin{array}{col1col2...coln} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{array}</programlisting> - - <para>Math arrays are produced with the array environment. - It has a single - mandatory argument describing the number of columns and - the alignment within them. Each column, - <literal>coln</literal>, is specified by a single letter - that tells how items in that row should be formatted. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>c</literal> --- for centered - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> --- for flush left - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> --- for flush right - </simpara> - </listitem> - </itemizedlist> - - <para>Column entries must be separated by an - <literal>&</literal>. Column entries may - include other &latex; commands. Each row of the array - must be terminated - with the string <literal>\\</literal>. - </para> - <para>Note that the <literal>array</literal> environment - can only be used in math mode, so - normally it is used inside an <literal>equation</literal> - environment. - </para> - - <bridgehead renderas="sect5" id="env-center"><literal>center</literal></bridgehead> - <indexterm><primary>center</primary></indexterm> - <indexterm><primary>Centering text, environment for</primary></indexterm> - - <programlisting> -\begin{center} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{center}</programlisting> - - <para>The <literal>center</literal> environment allows you to - create a paragraph consisting of lines that are - centered within the left and right margins on - the current page. Each line must be terminated with the string - <literal>\\</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-centering"><literal>\centering</literal></bridgehead> - <indexterm><primary>\centering</primary></indexterm> - <indexterm><primary>Centering text</primary></indexterm> - <indexterm><primary>Formatting Text</primary></indexterm> - - <para>This declaration corresponds to the - <literal>center</literal> environment. This - declaration can be used inside an environment such as - <literal>quote</literal> or in - a <literal>parbox</literal>. The text of a figure or - table can be centered on the - page by putting a <literal>\centering</literal> command - at the beginning of the - figure or table environment. - </para> - <para>Unlike the <literal>center</literal> environment, - the <literal>\centering</literal> command does - not start a new paragraph; it simply changes how &latex; - formats paragraph - units. To affect a paragraph unit's format, the scope of the - declaration must contain the blank line or - <literal>\end</literal> command (of an - environment like quote) that ends the paragraph unit. - </para> - - - <bridgehead renderas="sect5" id="env-description"><literal>description</literal></bridgehead> - <indexterm><primary>description</primary></indexterm> - <indexterm><primary>Labelled lists, creating</primary></indexterm> - - <programlisting> -\begin{description} -\item [label] First item -\item [label] Second item - . - . - . -\end{description}</programlisting> - - <para>The <literal>description</literal> environment is - used to make labelled lists. The - <literal>label</literal> is bold face and flushed right. - </para> - - <bridgehead renderas="sect5" id="env-enumerate"><literal>enumerate</literal></bridgehead> - <indexterm><primary>enumerate</primary></indexterm> - <indexterm><primary>Lists of items, numbered</primary></indexterm> - - <programlisting> -\begin{enumerate} -\item First item -\item Second item - . - . - . -\end{enumerate}</programlisting> - - <para>The <literal>enumerate</literal> environment produces - a numbered list. Enumerations can be nested within - one another, up to four levels deep. They can also be - nested within other paragraph-making environments. - </para> - <para>Each item of an enumerated list begins with an - <literal>\item</literal> command. - There must be at least one <literal>\item</literal> - command within the environment. - </para> - <para>The <literal>enumerate</literal> environment uses the - <literal>enumi</literal> through - <literal>enumiv</literal> counters - (see <link linkend="counters">Counters</link>). - The type of numbering can be - changed by redefining <literal>\theenumi</literal> etc. - </para> - - <bridgehead renderas="sect5" id="env-eqnarray"><literal>eqnarray</literal></bridgehead> - <indexterm><primary>eqnarray</primary></indexterm> - <indexterm><primary>Equations, aligning</primary></indexterm> - <indexterm><primary>Aligning Equations</primary></indexterm> - - <programlisting> -\begin{eqnarray} -math formula 1 \\ -math formula 2 \\ - . - . - . -\end{eqnarray}</programlisting> - - <para>The <literal>eqnarray</literal> environment is used - to display a sequence of - equations or inequalities. It is very much like a three-column - <literal>array</literal> environment, with consecutive - rows separated by <literal>\\</literal> - and consecutive items within a row separated by an - <literal>&</literal>. - </para> - <para>An equation number is placed on every line unless that - line has a <literal>\nonumber</literal> command. - </para> - <indexterm><primary>\lefteqn</primary></indexterm> - - <para>The command <literal>\lefteqn</literal> is used for - splitting long formulas across - lines. It typesets its argument in display style flush - left in a box of zero width. - </para> - - <bridgehead renderas="sect5" id="env-equation"><literal>equation</literal></bridgehead> - <indexterm><primary>equation</primary></indexterm> - <indexterm><primary>Equations, environment for</primary></indexterm> - <indexterm><primary>Formulae, environment for</primary></indexterm> - - <programlisting> -\begin{equation} - math formula -\end{equation}</programlisting> - - <para>The <literal>equation</literal> environment centers - your equation on the page and places - the equation number in the right margin. - </para> - - <bridgehead renderas="sect5" id="env-figure"><literal>figure</literal></bridgehead> - <indexterm><primary>figure</primary></indexterm> - <indexterm><primary>Inserting figures</primary></indexterm> - - <programlisting> -\begin{figure}[placement] - - body of the figure - -\caption{figure title} -\end{figure}</programlisting> - - <indexterm><primary>\caption</primary></indexterm> - <para>Figures are objects that are not part of the - normal text, and are - usually <emphasis>floated</emphasis> to a convenient - place, like the top of a page. - Figures will not be split between two pages. - </para> - <para>The optional argument <literal>[placement]</literal> - determines where &latex; will try - to place your figure. There are four places where - &latex; can possibly put a float: - </para> - <orderedlist> - <listitem> - <para><literal>h</literal> (Here) - at the position - in the text where the figure - environment appears. - </para> - </listitem> - <listitem> - <para><literal>t</literal> (Top) - at the top of a text page. - </para> - </listitem> - <listitem> - <para><literal>b</literal> (Bottom) - at the bottom - of a text page. - </para> - </listitem> - <listitem> - <para><literal>p</literal> (Page of floats) - on a - separate float page, which is a page - containing no text, only floats. - </para> - </listitem> - </orderedlist> - - <para>The standard report and article classes use the - default placement <literal>tbp</literal>. - </para> - <para>The body of the figure is made up of whatever text, - &latex; commands, etc. - you wish. The <literal>\caption</literal> command - allows you to title your figure. - </para> - - <bridgehead renderas="sect5" id="env-flushleft"><literal>flushleft</literal></bridgehead> - <indexterm><primary>flushleft</primary></indexterm> - <indexterm><primary>Left-justifying text, environment for</primary></indexterm> - <indexterm><primary>Ragged right text, environment for</primary></indexterm> - - <programlisting> -\begin{flushleft} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushleft}</programlisting> - - <para>The <literal>flushleft</literal> environment allows - you to create a paragraph - consisting of lines that are flushed left, to the - left-hand margin. - Each line must be terminated with the string - <literal>\\</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-raggedright"><literal>\raggedright</literal></bridgehead> - <indexterm><primary>\raggedright</primary></indexterm> - <indexterm><primary>Ragged right text</primary></indexterm> - <indexterm><primary>Left-justifying text</primary></indexterm> - <indexterm><primary>Justification, ragged right</primary></indexterm> - - <para>This declaration corresponds to the - <literal>flushleft</literal> environment. This - declaration can be used inside an environment such - as <literal>quote</literal> or in - a <literal>parbox</literal>. - </para> - <para>Unlike the <literal>flushleft</literal> - environment, the <literal>\raggedright</literal> command - does not start a new paragraph; it simply changes - how &latex; formats - paragraph units. To affect a paragraph unit's format, - the scope of the - declaration must contain the blank line or - <literal>\end</literal> command (of an - environment like quote) that ends the paragraph unit. - </para> - - <bridgehead renderas="sect5" id="env-flushright"><literal>flushright</literal></bridgehead> - <indexterm><primary>flushright</primary></indexterm> - <indexterm><primary>Ragged left text, environment for</primary></indexterm> - <indexterm><primary>Right-justifying text, environment for</primary></indexterm> - - <programlisting> -\begin{flushright} -Text on line 1 \\ -Text on line 2 \\ - . - . - . -\end{flushright}</programlisting> - - <para>The <literal>flushright</literal> environment allows - you to create a paragraph - consisting of lines that are flushed right, to the - right-hand margin. Each line must be terminated with - the string <literal>\\</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-raggedleft"><literal>\raggedleft</literal></bridgehead> - <indexterm><primary>\raggedleft</primary></indexterm> - <indexterm><primary>Ragged left text</primary></indexterm> - <indexterm><primary>Justification, ragged left</primary></indexterm> - <indexterm><primary>Right-justifying text</primary></indexterm> - - <para>This declaration corresponds to the - <literal>flushright</literal> environment. This - declaration can be used inside an environment such as - <literal>quote</literal> or in - a <literal>parbox</literal>. - </para> - <para>Unlike the <literal>flushright</literal> - environment, the <literal>\raggedleft</literal> command - does not start a new paragraph; it simply changes - how &latex; formats - paragraph units. To affect a paragraph unit's format, - the scope of the - declaration must contain the blank line or - <literal>\end</literal> command (of an - environment like quote) that ends the paragraph unit. - </para> - - <bridgehead renderas="sect5" id="env-itemize"><literal>itemize</literal></bridgehead> - <indexterm><primary>itemize</primary></indexterm> - <indexterm><primary>\item</primary></indexterm> - <indexterm><primary>Lists of items</primary></indexterm> - - <programlisting> -\begin{itemize} -\item First item -\item Second item - . - . - . -\end{itemize}</programlisting> - - <para>The <literal>itemize</literal> environment produces - a <emphasis>bulleted</emphasis> list. Itemizations - can be nested within one another, up to four levels deep. - They can also - be nested within other paragraph-making environments. - </para> - <para>Each item of an <literal>itemized</literal> list - begins with an <literal>\item</literal> command. - There must be at least one <literal>\item</literal> - command within the environment. - </para> - <para>The <literal>itemize</literal> environment uses the - <literal>itemi</literal> through - <literal>itemiv</literal> counters (see - <link linkend="counters">Counters</link>). The type of - numbering can be - changed by redefining <literal>\theitemi</literal> etc. - </para> - - <bridgehead renderas="sect5" id="env-letter"><literal>letter</literal></bridgehead> - <indexterm><primary>letter</primary></indexterm> - - <para>This environment is used for creating letters. - See <link linkend="letters">Letters</link>. - </para> - - <bridgehead renderas="sect5" id="env-list"><literal>list</literal></bridgehead> - <indexterm><primary>list</primary></indexterm> - <indexterm><primary>Lists of items, generic</primary></indexterm> - - <para>The <literal>list</literal> environment is a generic - environment which is used for - defining many of the more specific environments. It is - seldom used in documents, but often in macros. - </para> - <programlisting> -\begin{list}{label}{spacing} -\item First item -\item Second item - . - . - . -\end{list}</programlisting> - - <para>The <literal>{label}</literal> argument specifies how - items should be labelled. - This argument is a piece of text that is inserted in a box - to form the label. This argument can and usually does - contain other &latex; commands. - </para> - <para>The <literal>{spacing}</literal> argument contains - commands to change the spacing - parameters for the list. This argument will most often - be null, i.e., - <literal>{}</literal>. This will select all default - spacing which should suffice - for most cases. - </para> - - <bridgehead renderas="sect5" id="env-minipage"><literal>minipage</literal></bridgehead> - <indexterm><primary>minipage</primary></indexterm> - <indexterm><primary>Footnotes in figures</primary></indexterm> - <indexterm><primary>Figures, footnotes in</primary></indexterm> - <indexterm><primary>Minipage, creating a</primary></indexterm> - - <programlisting> -\begin{minipage}[position][height][inner-pos]{width} - text -\end{minipage}</programlisting> - - <para>The <literal>minipage</literal> environment is similar - to a <literal>\parbox</literal> command. - It takes the same optional <literal>position</literal> - argument and mandatory - <literal>width</literal> argument. You may use other - paragraph-making environments - inside a minipage. - </para> - <para>Footnotes in a <literal>minipage</literal> environment - are handled in a way that is - particularly useful for putting footnotes in figures or - tables. - A <literal>\footnote</literal> or - <literal>\footnotetext</literal> command puts the footnote at - the bottom of the minipage instead of at the bottom of the - page, and it - uses the <literal>mpfootnote</literal> counter instead of - the ordinary - <literal>footnote</literal> counter See - <link linkend="counters">Counters</link>. - </para> - <para>NOTE: Don't put one minipage inside another if you are - using footnotes; - they may wind up at the bottom of the wrong minipage. - </para> - - <bridgehead renderas="sect5" id="env-picture"><literal>picture</literal></bridgehead> - <indexterm><primary>picture</primary></indexterm> - <indexterm><primary>Creating pictures</primary></indexterm> - <indexterm><primary>Pictures, creating</primary></indexterm> - - <programlisting> -\begin{picture}(width,height)(x offset,y offset) - . - . - picture commands - . - . -\end{picture}</programlisting> - - <para>The <literal>picture</literal> environment allows you - to create just about any kind - of picture you want containing text, lines, arrows and - circles. You tell &latex; where to put things in the picture - by specifying their coordinates. A coordinate is a number - that may have a decimal point and a minus sign --- a number - like <literal>5</literal>, <literal>2.3</literal> or - <literal>-3.1416</literal>. A coordinate specifies a length - in multiples of the unit length - <literal>\unitlength</literal>, so if - <literal>\unitlength</literal> has been set to - <literal>1cm</literal>, - then the coordinate 2.54 specifies a length of - 2.54 centimetres. You can change the value of - <literal>\unitlength</literal> anywhere you want, using the - <literal>\setlength</literal> command, but strange things - will happen if you try - changing it inside the picture environment. - </para> - <para>A position is a pair of coordinates, such as - <literal>(2.4,-5)</literal>, specifying - the point with x-coordinate <literal>2.4</literal> - and y-coordinate <literal>-5</literal>. - Coordinates are specified in the usual way with - respect to an origin, which is normally at the - lower-left corner of the picture. Note that - when a position appears as an argument, it is - not enclosed in braces; - the parentheses serve to delimit the argument. - </para> - <para>The <literal>picture</literal> environment has one - mandatory argument, which is a - <literal>position</literal>. It specifies the size of - the picture. The environment - produces a rectangular box with width and height determined - by this argument's x- and y-coordinates. - </para> - <para>The <literal>picture</literal> environment also has - an optional <literal>position</literal> - argument, following the <literal>size</literal> argument, - that can change the - origin. (Unlike ordinary optional arguments, this argument - is not contained in square brackets.) The optional - argument gives the coordinates of the point at the - lower-left corner of the picture (thereby determining - the origin). For example, if <literal>\unitlength</literal> - has been set to <literal>1mm</literal>, the command - <programlisting> -\begin{picture}(100,200)(10,20)</programlisting> - produces a picture of width 100 millimetres and height 200 - millimetres, whose lower-left corner is the point (10,20) - and whose upper-right corner is therefore the point - (110,220). When you first draw a picture, you will - omit the optional argument, leaving the origin - at the lower-left corner. If you then want to modify - your picture by shifting everything, you just add the - appropriate optional argument. - </para> - <para>The environment's mandatory argument determines the - nominal size of the picture. This need bear no relation - to how large the picture really is; - &latex; will happily allow you to put things outside the - picture, or even off the page. The picture's nominal - size is used by &latex; in determining - how much room to leave for it. - </para> - <para>Everything that appears in a picture is drawn by - the <literal>\put</literal> - command. The command - <programlisting> -\put (11.3,-.3){...}</programlisting> - puts the object specified by <literal>...</literal> - in the picture, with its - reference point at coordinates (11.3,-.3). - The reference points for - various objects will be described below. - </para> - <para>The <literal>\put</literal> command creates an - <emphasis role="bold">LR box</emphasis>. You can put anything - in the text argument of the <literal>\put</literal> - command that you'd put into the - argument of an <literal>\mbox</literal> and related - commands. When you do this, the - reference point will be the lower left corner of the box. - </para> - <para>Picture commands: - </para> - - <bridgehead renderas="sect5" id="cmd-circle"><literal>\circle{diameter}, \circle*{diameter}</literal></bridgehead> - <indexterm><primary>\circle</primary></indexterm> - - <para>The <literal>\circle</literal> command produces a - circle with a diameter as close to - the specified one as possible. If the - <literal>*</literal>-form of the command is - used, &latex; draws a solid circle. - </para> - <para>Note that only circles up to 40 pt can be drawn. - </para> - - <bridgehead renderas="sect5" id="cmd-dashbox"><literal>\dashbox</literal></bridgehead> - <indexterm><primary>\dashbox</primary></indexterm> - - <para>Draws a box with a dashed line. - </para> - <para><literal>\dashbox{dash_length}(width,height){...}</literal> - </para> - <para>The <literal>\dashbox</literal> has an extra - argument which specifies the width of - each dash. A dashed box looks best when the - <literal>width</literal> and - <literal>height</literal> are multiples of the - <literal>dash_length</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-frame"><literal>\frame{...}</literal></bridgehead> - <indexterm><primary>\frame</primary></indexterm> - - <para>The <literal>\frame</literal> command puts a - rectangular frame around the object - specified in the argument. The reference point - is the bottom left corner of the frame. No extra - space is put between the frame and the object. - </para> - - <bridgehead renderas="sect5" id="cmd-framebox-op-picture-cp"><literal>\framebox(width,height)[position]{...}</literal></bridgehead> - <indexterm><primary>\framebox</primary></indexterm> - - <para>The <literal>\framebox</literal> command is exactly - the same as the <literal>\makebox</literal> - command, except that it puts a frame around the - outside of the box that it creates. - </para> - <para>The <literal>framebox</literal> command produces - a rule of thickness - <literal>\fboxrule</literal>, and leaves a space - <literal>\fboxsep</literal> between the rule - and the contents of the box. - </para> - - <bridgehead renderas="sect5" id="cmd-line"><literal>\line(x slope,y slope){length}</literal></bridgehead> - <indexterm><primary>\line</primary></indexterm> - - <para>The <literal>\line</literal> command draws a - line of the specified <literal>length</literal> and - <literal>slope</literal>. - </para> - <para>Note that &latex; can only draw lines with - slope = x/y, where x and y - have integer values from -6 through 6. - </para> - - <bridgehead renderas="sect5" id="cmd-linethickness"><literal>\linethickness{dimension}</literal></bridgehead> - <indexterm><primary>\linethickness</primary></indexterm> - - <para>Declares the thickness of horizontal and vertical - lines in a picture - environment to be <literal>dimension</literal>, - which must be a positive length. It - does not affect the thickness of slanted lines - and circles, or the quarter circles drawn by - <literal>\oval</literal> to form the corners of an oval. - </para> - - <bridgehead renderas="sect5" id="cmd-makebox-op-picture-cp"><literal>\makebox(width,height)[position]{...}</literal></bridgehead> - <indexterm><primary>\makebox (picture)</primary></indexterm> - - <para>The <literal>\makebox</literal> command for the - picture environment is similar to - the normal <literal>\makebox</literal> command except - that you must specify a - <literal>width</literal> and <literal>height</literal> - in multiples of <literal>\unitlength</literal>. - </para> - <para>The optional argument, <literal>[position]</literal>, - specifies the quadrant that your text appears in. - You may select up to two of the following: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> - Moves the item to the - top of the rectangle - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> - Moves the item to the bottom - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> - Moves the item to the left - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> - Moves the item to the right - </simpara> - </listitem> - </itemizedlist> - - <para>See <link linkend="cmd-makebox">\makebox</link>. - </para> - - <bridgehead renderas="sect5" id="cmd-multiput"><literal>\multiput(x coord,y coord)(delta x,delta y){number of copies}{object}</literal></bridgehead> - <indexterm><primary>\multiput</primary></indexterm> - - <para>The <literal>\multiput</literal> command can be - used when you are putting the same - object in a regular pattern across a picture. - </para> - - <bridgehead renderas="sect5" id="cmd-oval"><literal>\oval(width,height)[portion]</literal></bridgehead> - <indexterm><primary>\oval</primary></indexterm> - - <para>The <literal>\oval</literal> command produces - a rectangle with rounded corners. The - optional argument, <literal>[portion]</literal>, - allows you to select part of the - oval. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> - Selects the top portion - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> - Selects the bottom portion - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> - Selects the right portion - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> - Selects the left portion - </simpara> - </listitem> - </itemizedlist> - - <para>Note that the <emphasis>corners</emphasis> of - the oval are made - with quarter circles with - a maximum radius of 20 pt, so large - <emphasis>ovals</emphasis> will - look more like boxes with rounded corners. - </para> - - <bridgehead renderas="sect5" id="cmd-put"><literal>\put(x coord,y coord){ ... }</literal></bridgehead> - <indexterm><primary>\put</primary></indexterm> - - <para>The <literal>\put</literal> command places the - item specified by the mandatory - argument at the given coordinates. - </para> - - <bridgehead renderas="sect5" id="cmd-shortstack"><literal>\shortstack[position]{... \\ ... \\ ...}</literal></bridgehead> - <indexterm><primary>\shortstack</primary></indexterm> - - <para>The <literal>\shortstack</literal> command produces - a stack of objects. The valid - positions are: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>r</literal> - Moves the objects to the - right of the stack - </simpara> - </listitem> - <listitem> - <simpara><literal>l</literal> - Moves the objects to - the left of the stack - </simpara> - </listitem> - <listitem> - <simpara><literal>c</literal> - Moves the objects to - the centre of the stack (default) - </simpara> - </listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-vector"><literal>\vector(x slope,y slope){length}</literal></bridgehead> - <indexterm><primary>\vector</primary></indexterm> - - <para>The <literal>\vector</literal> command draws a - line with an arrow of the specified - length and slope. The <literal>x</literal> and - <literal>y</literal> values must lie between -4 - and +4, inclusive. - </para> - - <bridgehead renderas="sect5" id="env-quotation"><literal>quotation</literal></bridgehead> - <indexterm><primary>quotation</primary></indexterm> - <indexterm><primary>Quoted text with paragraph indentation, displaying</primary></indexterm> - <indexterm><primary>Displaying quoted text with paragraph indentation</primary></indexterm> - - <programlisting> -\begin{quotation} - text -\end{quotation}</programlisting> - - <para>The margins of the <literal>quotation</literal> - environment are indented on the left - and the right. The text is justified at both margins - and there is paragraph indentation. Leaving a blank - line between text produces a new paragraph. - </para> - - <bridgehead renderas="sect5" id="env-quote"><literal>quote</literal></bridgehead> - <indexterm><primary>quote</primary></indexterm> - <indexterm><primary>Quoted text, displaying</primary></indexterm> - <indexterm><primary>Displaying quoted text</primary></indexterm> - - <programlisting> -\begin{quote} - text -\end{quote}</programlisting> - - <para>The margins of the <literal>quote</literal> - environment are indented on the left and - the right. The text is justified at both margins. - Leaving a blank line between text produces a new paragraph. - </para> - - <bridgehead renderas="sect5" id="env-tabbing"><literal>tabbing</literal></bridgehead> - <indexterm><primary>tabbing</primary></indexterm> - <indexterm><primary>Tab stops, using</primary></indexterm> - <indexterm><primary>Lining text up in columns using tab stops</primary></indexterm> - - <programlisting>\begin{tabbing} -text \= more text \= still more text \= last text \\ -second row \> \> more \\ - . - . - . -\end{tabbing}</programlisting> - - <para>The <literal>tabbing</literal> environment provides - a way to align text in columns. - It works by setting tab stops and tabbing to them much - the way you do - with an ordinary typewriter. - </para> - <para>It is best suited for cases where the width of each - column is constant and known in advance. - </para> - <para>This environment can be broken across pages, - unlike the <literal>tabular</literal> - environment. - </para> - <para>The following commands can be used inside a - <literal>tabbing</literal> environment: - </para> - <table frame="none"> - <title>Commands in a <literal>tabbing</literal> environment</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>\= - <indexterm><primary>\=</primary></indexterm> - </entry> - <entry> - Sets a tab stop at the current position. - </entry> - </row> - <row rowsep="0"><entry>\> - <indexterm><primary>\></primary></indexterm> - </entry> - <entry> - Advances to the next tab stop. - </entry> - </row> - <row rowsep="0"><entry>\< - <indexterm><primary>\< </primary></indexterm> - </entry> - <entry> - This command allows you to put something to the - left of the - local margin without changing the margin. - Can only be used at the start of the line. - </entry> - </row> - <row rowsep="0"><entry>\+ - <indexterm><primary>\+</primary></indexterm> - </entry> - <entry> - Moves the left margin of the next and all the - following commands one tab stop to the right. - </entry> - </row> - <row rowsep="0"><entry>\- - <indexterm><primary>\- (tabbing) </primary></indexterm> - </entry> - <entry> - Moves the left margin of the next and all the - following commands one tab stop to the left. - </entry> - </row> - <row rowsep="0"><entry>\' - <indexterm><primary>\' (tabbing)</primary></indexterm> - </entry> - <entry> - Moves everything that you have typed so far in the - current column, i.e. everything from the most recent - <literal>\></literal>, - <literal>\<</literal>, <literal>\'</literal>, - <literal>\\</literal>, or <literal>\kill</literal> - command, to the right - of the previous column, flush against the current - column's tab stop. - </entry> - </row> - <row rowsep="0"><entry>\` - <indexterm><primary>\` (tabbing)</primary></indexterm> - </entry> - <entry> - Allows you to put text flush right against any - tab stop, including tab - stop 0. However, it can't move text to the right - of the last column - because there's no tab stop there. - The <literal>\`</literal> command moves all the - text that follows it, up to the - <literal>\\</literal> or <literal>\end{tabbing}</literal> - command that ends the line, to the right - margin of the tabbing environment. - There must be no <literal>\></literal> or - <literal>\'</literal> command between - the <literal>\`</literal> and the command that - ends the line. - </entry> - </row> - <row rowsep="0"><entry>\kill - <indexterm><primary>\kill</primary></indexterm> - </entry> - <entry> - Sets tab stops without producing - text. Works just like <literal>\\</literal> - except that it throws away the - current line instead of producing output for it. - The effect of any - <literal>\=</literal>, <literal>\+</literal> or - <literal>\-</literal> commands in that line remain in - effect. - </entry> - </row> - <row rowsep="0"><entry>\pushtabs - <indexterm><primary>\pushtabs</primary></indexterm> - </entry> - <entry> - Saves all current tab stop positions. Useful for - temporarily changing tab stop positions in the - middle of a - <literal>tabbing</literal> environment. - </entry> - </row> - <row rowsep="0"><entry>\poptabs - <indexterm><primary>\poptabs</primary></indexterm> - </entry> - <entry> - Restores the tab stop positions saved by the - last <literal>\pushtabs</literal>. - </entry> - </row> - <row rowsep="0"><entry>\a - <indexterm><primary>\a</primary></indexterm> - </entry> - <entry> - In a <literal>tabbing</literal> environment, - the commands <literal>\=</literal>, - <literal>\'</literal> and - <literal>\`</literal> do not produce accents as - normal. Instead, the commands - <literal>\a=</literal>, <literal>\a'</literal> - and <literal>\a`</literal> are used. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>This example typesets a Pascal function in a - traditional format: - </para> - <programlisting>\begin{tabbing} -function \= fact(n : integer) : integer;\\ - \> begin \= \+ \\ - \> if \= n $>$ 1 then \+ \\ - fact := n * fact(n-1) \- \\ - else \+ \\ - fact := 1; \-\- \\ - end;\\ -\end{tabbing}</programlisting> - - <bridgehead renderas="sect5" id="env-table"><literal>table</literal></bridgehead> - <indexterm><primary>table</primary></indexterm> - <indexterm><primary>Tables, creating</primary></indexterm> - <indexterm><primary>Creating tables</primary></indexterm> - - <programlisting> -\begin{table}[placement] - - body of the table - -\caption{table title} -\end{table}</programlisting> - - <para>Tables are objects that are not part of the - normal text, and are - usually <emphasis>floated</emphasis> to a - convenient place, - like the top of a page. - Tables will not be split between two pages. - </para> - <para>The optional argument <literal>[placement]</literal> - determines where &latex; will try - to place your table. There are four places where - &latex; can possibly put a float: - </para> - - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>h</literal> : Here - at the position - in the text where the table environment appears. - </simpara> - </listitem> - <listitem> - <simpara><literal>t</literal> : Top - at the top of a text page. - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> : Bottom - at the bottom of - a text page. - </simpara> - </listitem> - <listitem> - <simpara><literal>p</literal> : Page of floats - on - a separate float page, which is a page - containing no text, only floats. - </simpara> - </listitem> - </itemizedlist> - - <para>The standard <literal>report</literal> and - <literal>article</literal> classes use the default - placement <literal>[tbp]</literal>. - </para> - <para>The body of the table is made up of whatever - text, &latex; commands, etc., - you wish. The <literal>\caption</literal> command - allows you to title your table. - </para> - - <bridgehead renderas="sect5" id="env-tabular"><literal>tabular</literal></bridgehead> - <indexterm><primary>tabular</primary></indexterm> - <indexterm><primary>Lines in tables</primary></indexterm> - <indexterm><primary>Lining text up in tables</primary></indexterm> - - <programlisting> -\begin{tabular}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{tabular}</programlisting> - - <para> or - </para> - <programlisting> -\begin{tabular*}{width}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ - . - . - . -\end{tabular*}</programlisting> - - <para>These environments produce a box consisting of a - sequence of rows of - items, aligned vertically in columns. The mandatory and optional - arguments consist of: - </para> - <table frame="none"> - <title>Commands used inside a <literal>tabular</literal> environment</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>width - </entry> - <entry>Specifies the width of the - <literal>tabular*</literal> environment. There must be - rubber space between columns that can stretch - to fill out the specified width. - </entry> - </row> - <row rowsep="0"><entry>pos - </entry> - <entry>Specifies the vertical position; default - is alignment on the centre of the environment. - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> - align on top row - </simpara> - </listitem> - <listitem> - <simpara><literal>b</literal> - align on bottom row - </simpara> - </listitem> - </itemizedlist> - </entry> - </row> - <row rowsep="0"><entry>cols - </entry> - <entry>Specifies the column formatting. - It consists of a sequence of the - following specifiers, corresponding to the - sequence of columns and intercolumn material. - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>l</literal> - A column of - left-aligned items. - </simpara> - </listitem> - <listitem> - <simpara><literal>r</literal> - A column of - right-aligned items. - </simpara> - </listitem> - <listitem> - <simpara><literal>c</literal> - A column of - centred items. - </simpara> - </listitem> - <listitem> - <simpara><literal>|</literal> - A vertical line - the full height and depth of the environment. - </simpara> - </listitem> - <listitem> - <simpara><literal>@{text}</literal> - This inserts - <literal>text</literal> in every row. - An @-expression suppresses the intercolumn - space normally inserted between columns; any - desired space between the inserted text and - the adjacent items must be included in text. - An <literal>\extracolsep{wd}</literal> - command in an - @-expression causes an extra space of width - <literal>wd</literal> to appear to the - left of all subsequent columns, until - countermanded by another - <literal>\extracolsep</literal> command. - Unlike ordinary intercolumn space, this - extra space is not suppressed by an - @-expression. An - <literal>\extracolsep</literal> - command can be used only in an @-expression in the - <literal>cols</literal> argument. - </simpara> - </listitem> - <listitem> - <simpara><literal>p{wd}</literal> - Produces a - column with each item typeset in a parbox of - width <literal>wd</literal>, as if it were - the argument of a <literal>\parbox[t]{wd}</literal> - command. However, a <literal>\\</literal> - may not appear in the item, except in the - following situations: - </simpara> - <orderedlist> - <listitem> - <simpara>inside an environment like - <literal>minipage</literal>, - <literal>array</literal>, or - <literal>tabular</literal>. - </simpara> - </listitem> - <listitem> - <simpara>inside an explicit - <literal>\parbox</literal>. - </simpara> - </listitem> - <listitem> - <simpara>in the scope of a - <literal>\centering</literal>, - <literal>\raggedright</literal>, or - <literal>\raggedleft</literal> - declaration. The latter declarations - must appear inside braces or an - environment when used in a - <literal>p</literal>-column element. - </simpara> - </listitem> - </orderedlist> - </listitem> - <listitem> - <simpara><literal>*{num}{cols}</literal> - - Equivalent to <literal>num</literal> copies of - <literal>cols</literal>, where - <literal>num</literal> is any positive - integer and <literal>cols</literal> is - any list of column-specifiers, which may - contain another - <literal>*-expression</literal>. - </simpara> - </listitem> - </itemizedlist> - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>These commands can be used inside a - <literal>tabular</literal> environment: - </para> - - <bridgehead renderas="sect5" id="cmd-cline"><literal>\cline{i-j}</literal></bridgehead> - <indexterm><primary>\cline</primary></indexterm> - - <para>The <literal>\cline</literal> command draws horizontal - lines across the columns - specified, beginning in column <literal>i</literal> - and ending in column <literal>j</literal>, - which are identified in the mandatory argument. - </para> - - <bridgehead renderas="sect5" id="cmd-hline"><literal>\hline</literal></bridgehead> - <indexterm><primary>\hline</primary></indexterm> - - <para>The <literal>\hline</literal> command will draw - a horizontal line the width of the - table. It's most commonly used to draw a line at - the top, bottom, and - between the rows of the table. - </para> - - <bridgehead renderas="sect5" id="cmd-multicolumn"><literal>\multicolumn</literal></bridgehead> - <indexterm><primary>\multicolumn</primary></indexterm> - - <para><literal>\multicolumn{cols}{pos}{text}</literal> - </para> - - <para>The <literal>\multicolumn</literal> is used to - make an entry that spans several - columns. The first mandatory argument, - <literal>cols</literal>, specifies the - number of columns to span. The second mandatory - argument, <literal>pos</literal>, - specifies the formatting of the entry; - <literal>c</literal> for centred, <literal>l</literal> - for flushleft, <literal>r</literal> for flushright. - The third mandatory argument, - <literal>text</literal>, specifies what text is to make - up the entry. - </para> - - <bridgehead renderas="sect5" id="cmd-vline"><literal>\vline</literal></bridgehead> - <indexterm><primary>\vline</primary></indexterm> - - <para>The <literal>\vline</literal> command will draw - a vertical line extending the full - height and depth of its row. An <literal>\hfill</literal> - command can be used to - move the line to the edge of the column. - It can also be used in an @-expression. - </para> - - <bridgehead renderas="sect5" id="env-thebibliography"><literal>thebibliography</literal></bridgehead> - <indexterm><primary>thebibliography</primary></indexterm> - <indexterm><primary>Bibliography, creating (manually)</primary></indexterm> - - <programlisting> -\begin{thebibliography}{widest-label} -\bibitem[label]{cite_key} - . - . - . -\end{thebibliography}</programlisting> - - <para>The <literal>thebibliography</literal> environment - produces a bibliography or reference list. - In the <literal>article</literal> class, this reference - list is labelled <emphasis>References</emphasis>; - in the - <literal>report</literal> class, it is labelled - <emphasis>Bibliography</emphasis>. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>widest-label</literal>: Text that, - when printed, is approximately as wide - as the widest item label produces by the - <literal>\bibitem</literal> commands. - </simpara> - </listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-bibitem"><literal>\bibitem[label]{cite_key}</literal></bridgehead> - <indexterm><primary>\bibitem</primary></indexterm> - - <para>The <literal>\bibitem</literal> command generates - an entry labelled by <literal>label</literal>. - If the <literal>label</literal> argument is - missing, a number is generated as the - <literal>label</literal>, using the - <literal>enumi</literal> counter. - The <literal>cite_key</literal> is - any sequence of letters, numbers, and punctuation - symbols not containing a comma. - This command writes an entry on the - <filename>.aux</filename> file containing - <literal>cite_key</literal> and the item's - <literal>label</literal>. When this - <filename>.aux</filename> file is read by the - <literal>\begin{document}</literal> command, the - item's <literal>label</literal> is associated - with <literal>cite_key</literal>, causing the - reference to <literal>cite_key</literal> by a - <literal>\cite</literal> command to produce the - associated <literal>label</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-cite"><literal>\cite[text]{key_list}</literal></bridgehead> - <indexterm><primary>\cite</primary></indexterm> - - <para>The <literal>key_list</literal> argument - is a list of citation keys. This command - generates an in-text citation to the references - associated with the keys - in <literal>key_list</literal> by entries on - the <filename>.aux</filename> file read by the - <literal>\begin{document}</literal> command. - </para> - <para>The optional <literal>text</literal> argument - will appear after the citation, - i.e. <literal>\cite[p.~2f.]{knuth}</literal> might - produce `[Knuth, p. 2]'. - </para> - <para> - <indexterm> - <primary>cite.sty</primary> - </indexterm> - The package <literal>cite.sty</literal> - allows a line break in the <literal>\cite</literal> - reference and can sort numerical entries. - </para> - <para> - <indexterm> - <primary>overcite.sty</primary> - </indexterm> - <literal>overcite.sty</literal> makes - citations like footnotes. - </para> - - <bridgehead renderas="sect5" id="cmd-nocite"><literal>\nocite{key_list}</literal></bridgehead> - <indexterm><primary>\nocite</primary></indexterm> - - <para>The <literal>\nocite</literal> command produces - no text, but writes <literal>key_list</literal>, - which is a list of one or more citation keys, on - the <filename>.aux</filename> file. - <literal>\nocite{*}</literal> uses all entries from - the &bibtex; database. - </para> - - <bridgehead renderas="sect5" id="using-bibtex">Using BibTeX</bridgehead> - <indexterm><primary>Using BibTeX</primary></indexterm> - <indexterm> - <primary>BibTeX</primary> - <secondary>using</secondary> - </indexterm> - <indexterm><primary>Bibliography, creating (automatically)</primary></indexterm> - <indexterm><primary>\bibliographystyle</primary></indexterm> - <indexterm><primary>\bibliography</primary></indexterm> - - <para>If you use the BibTeX program by Oren Patashnik - (highly recommended if you need a bibliography of - more than a couple of titles) to maintain - your bibliography, you don't use the - <literal>thebibliography</literal> - environment. Instead, you include the lines - </para> - <programlisting> -\bibliographystyle{style} -\bibliography{bibfile}</programlisting> - - <para>where <literal>style</literal> refers to a - file <literal>style.bst</literal>, which defines how - your citations will look. - </para> - <table frame="none"> - <title>Standard styles distributed with BibTeX</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>alpha - </entry> - <entry>Sorted alphabetically. Labels are - formed from name of author and year of publication. - </entry> - </row> - <row rowsep="0"><entry>plain - </entry> - <entry>Sorted alphabetically. Labels are numeric. - </entry> - </row> - <row rowsep="0"><entry>unsrt - </entry> - <entry>Like <literal>plain</literal>, but entries - are in order of citation. - </entry> - </row> - <row rowsep="0"><entry>abbrv - </entry> - <entry>Like <literal>plain</literal>, but more - compact labels. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>In addition, numerous other BibTeX style - files exist tailored to the - demands of various publications. - </para> - <para>The argument to <literal>\bibliography</literal> - refers to the file - <literal>bibfile.bib</literal>, which should contain - your database in BibTeX - format. Only the entries referred to via - <literal>\cite</literal> and <literal>\nocite</literal> - will be listed in the bibliography. - </para> - - <bridgehead renderas="sect5" id="env-theorem"><literal>theorem</literal></bridgehead> - <indexterm><primary>theorem</primary></indexterm> - <indexterm><primary>Theorems, typesetting</primary></indexterm> - - <programlisting> -\begin{theorem} - theorem text -\end{theorem}</programlisting> - - <para>The <literal>theorem</literal> environment - produces <emphasis>Theorem x</emphasis> in - boldface followed by your theorem text. - </para> - - <bridgehead renderas="sect5" id="env-titlepage"><literal>titlepage</literal></bridgehead> - <indexterm><primary>titlepage</primary></indexterm> - <indexterm><primary>Making a title page</primary></indexterm> - <indexterm><primary>Title pages, creating</primary></indexterm> - - <programlisting> -\begin{titlepage} - text -\end{titlepage}</programlisting> - - <para>The <literal>titlepage</literal> environment creates - a title page, i.e. a page with no - printed page number or heading. It also causes the following - page to be numbered page one. Formatting the title page - is left to you. The - <literal>\today</literal> command comes in handy for title pages. - <indexterm><primary>\today</primary></indexterm> - </para> - <para>Note that you can use the - <literal>\maketitle</literal> (see - <link linkend="cmd-maketitle">\maketitle</link>) command to - produce a standard title page. - </para> - - <bridgehead renderas="sect5" id="env-verbatim"><literal>verbatim</literal></bridgehead> - <indexterm><primary>verbatim</primary></indexterm> - <indexterm><primary>Simulating typed text</primary></indexterm> - <indexterm><primary>Typed text, simulating</primary></indexterm> - <indexterm><primary>Programs, typesetting</primary></indexterm> - <indexterm><primary>Computer programs, typesetting</primary></indexterm> - - <programlisting> -\begin{verbatim} - text -\end{verbatim}</programlisting> - - <para>The <literal>verbatim</literal> environment is a - paragraph-making environment that - gets &latex; to print exactly what you type in. - It turns &latex; into a - typewriter with carriage returns and blanks having the - same effect that - they would on a typewriter. - </para> - - <bridgehead renderas="sect5" id="cmd-verb"><literal>\verb char literal_text char</literal> <literal>\verb*char literal_text char</literal></bridgehead> - <indexterm><primary>\verb</primary></indexterm> - <indexterm><primary>Verbatim text</primary></indexterm> - - <para>Typesets <literal>literal_text</literal> - exactly as typed, including special - characters and spaces, using a typewriter - (<literal>\tt</literal>) type style. - There may be no space between - <literal>\verb</literal> or <literal>\verb*</literal> and - <literal>char</literal> (space is shown here only - for clarity). The <literal>*-form</literal> - differs only in that spaces are printed - </para> - - <bridgehead renderas="sect5" id="env-verse"><literal>verse</literal></bridgehead> - <indexterm><primary>verse</primary></indexterm> - <indexterm><primary>Poetry, an environment for</primary></indexterm> - - <programlisting> -\begin{verse} - text -\end{verse}</programlisting> - - <para>The <literal>verse</literal> environment is designed - for poetry, though you may find - other uses for it. - </para> - <para>The margins are indented on the left and the right. - Separate the lines - of each stanza with <literal>\\</literal>, and use one or - more blank lines to - separate the stanzas. - </para> - - </section> - - <!-- FIXME --> - - <section id="footnotes"> - <title id="footnotes-title">Footnotes</title> - <indexterm><primary>Footnotes, creating</primary></indexterm> - - <para>Footnotes can be produced in one of two ways. They can be - produced with one command, the <literal>\footnote</literal> - command. They can also - be produced with two commands, the - <literal>\footnotemark</literal> and the - <literal>\footnotetext</literal> commands. - See the specific command for information - on why you would use one over the other. - </para> - - <bridgehead renderas="sect5" id="cmd-cmd-footnote"><literal>\footnote[number]{text}</literal></bridgehead> - <indexterm><primary>\footnote</primary></indexterm> - - <para>The <literal>\footnote</literal> command places - the numbered footnote <literal>text</literal> at - the bottom of the current page. The optional argument, - <literal>number</literal>, - is used to change the default footnote number. - This command can only be - used in outer paragraph mode; i.e., you cannot use - it in sectioning - commands like <literal>\chapter</literal>, in figures, - tables or in a <literal>tabular</literal> environment. - </para> - - <bridgehead renderas="sect5" id="cmd-footnotemark"><literal>\footnotemark</literal></bridgehead> - <indexterm><primary>\footnotemark</primary></indexterm> - - <para>The <literal>\footnotemark</literal> command puts - the footnote <literal>number</literal> in the - text. This command can be used in inner paragraph mode. - The text of the footnote is supplied by the - <literal>\footnotetext</literal> command. - </para> - <para>This command can be used to produce several - consecutive footnote markers - referring to the same footnote by using - </para> - <para><literal>\footnotemark[\value{footnote}]</literal> - </para> - <para>after the first <literal>\footnote</literal> command. - </para> - - <bridgehead renderas="sect5" id="cmd-footnotetext"><literal>\footnotetext[number]{text}</literal></bridgehead> - <indexterm><primary>\footnotetext</primary></indexterm> - - <para>The <literal>\footnotetext</literal> command - produces the <literal>text</literal> to be placed - at the bottom of the page. This command can come - anywhere after the - <literal>\footnotemark</literal> command. - The <literal>\footnotetext</literal> command must - appear in outer paragraph mode. - </para> - <para>The optional argument, <literal>number</literal>, - is used to change the default - footnote number. - </para> - - </section> - - - <section id="lengths"> - <title id="lengths-title">Lengths</title> - <indexterm><primary>Lengths, defining and using</primary></indexterm> - - <para>A <literal>length</literal> is a measure of distance. Many - &latex; commands take a length as an argument. - </para> - - - <bridgehead renderas="sect5" id="cmd-newlength"><literal>\newlength</literal></bridgehead> - <indexterm><primary>\newlength</primary></indexterm> - <indexterm><primary>Lengths, defining a new</primary></indexterm> - - <para><literal>\newlength{\gnat}</literal> - </para> - <para>The <literal>\newlength</literal> command defines the - mandatory argument, <literal>\gnat</literal>, as a - <literal>length</literal> command with a value of - <literal>0in</literal>. An error occurs if a - <literal>\gnat</literal> command already exists. - </para> - - <bridgehead renderas="sect5" id="cmd-setlength"><literal>\setlength</literal></bridgehead> - <indexterm><primary>\setlength</primary></indexterm> - <indexterm><primary>Lengths, setting value of</primary></indexterm> - - <para><literal>\setlength{\gnat}{length}</literal></para> - <para>The <literal>\setlength</literal> command is used to set - the value of a <literal>length</literal> command. The - <literal>length</literal> argument can be expressed in any - terms of length &latex; understands, i.e., inches - (<literal>in</literal>), millimetres - (<literal>mm</literal>), points (<literal>pt</literal>), - etc. - </para> - - <bridgehead renderas="sect5" id="cmd-addtolength"><literal>\addtolength</literal></bridgehead> - <indexterm><primary>\addtolength</primary></indexterm> - <indexterm><primary>Lengths, adding to</primary></indexterm> - - <para><literal>\addtolength{\gnat}{length}</literal></para> - <para>The <literal>\addtolength</literal> command increments - <emphasis>length command</emphasis> by the amount - specified in the - <literal>length</literal> argument. - It can be a negative amount. - </para> - - <bridgehead renderas="sect5" id="cmd-settodepth"><literal>\settodepth</literal></bridgehead> - <indexterm><primary>\settodepth</primary></indexterm> - - <para><literal>\settodepth{\gnat}{text}</literal></para> - <para>The <literal>\settodepth</literal> command sets the - value of a <literal>length</literal> command equal to the - depth of the <literal>text</literal> argument. - </para> - - <bridgehead renderas="sect5" id="cmd-settoheight"><literal>\settoheight</literal></bridgehead> - <indexterm><primary>\settoheight</primary></indexterm> - - <para><literal>\settoheight{\gnat}{text}</literal></para> - <para>The <literal>\settoheight</literal> command sets the - value of a <literal>length</literal> command equal to the - height of the <literal>text</literal> argument. - </para> - - <bridgehead renderas="sect5" id="cmd-settowidth"><literal>\settowidth</literal></bridgehead> - <indexterm><primary>\settowidth</primary></indexterm> - - <para><literal>\settowidth{\gnat}{text}</literal></para> - <para>The <literal>\settowidth</literal> command sets the - value of a <literal>length</literal> command equal to the - width of the <literal>text</literal> argument. - </para> - - <bridgehead renderas="sect5" id="predefined-lengths-title"><literal>Predefined lengths</literal></bridgehead> - <indexterm><primary>Lengths, predefined</primary></indexterm> - <indexterm><primary>Predefined lengths</primary></indexterm> - - <para id="cmd-length-pre-width"><literal>\width</literal> - <indexterm><primary>\width</primary></indexterm> - </para> - <para id="cmd-length-pre-height"><literal>\height</literal> - <indexterm><primary>\height</primary></indexterm> - </para> - <para id="cmd-length-pre-depth"><literal>\depth</literal> - <indexterm><primary>\depth</primary></indexterm> - </para> - <para id="cmd-length-pre-totalheight"><literal>\totalheight</literal> - <indexterm><primary>\totalheight</primary></indexterm> - </para> - <para>These length parameters can be used in the arguments of - the box-making commands See - <link linkend="spaces-and-boxes">Spaces & - Boxes</link>. - They - specify the natural width etc. of the text in the box. - <literal>\totalheight</literal> equals - <literal>\height</literal> + <literal>\depth</literal>. To - make a box with the text stretched to double the natural - size, e.g., say - </para> - <para><literal>\makebox[2\width]{Get a stretcher}</literal> - </para> - - </section> - - <section id="letters"> - <title id="letters-title">Letters</title> - <indexterm><primary>Letters</primary></indexterm> - <indexterm><primary>Creating letters</primary></indexterm> - - <para>You can use &latex; to typeset letters, both personal and - business. The <literal>letter</literal> document class is - designed to make a number of letters at once, although you can - make just one if you so desire. - </para> - <para>Your <filename>.tex</filename> source file has the same - minimum commands as the other document classes, i.e., you must - have the following commands as a minimum: - </para> - <programlisting> -\documentclass{letter} -\begin{document} - ... letters ... -\end{document}</programlisting> - - <para>Each letter is a <literal>letter</literal> environment, - whose argument is the name and address of the recipient. For - example, you might have: - </para> - <programlisting> -\begin{letter}{Mr. Joe Smith\\ 2345 Princess St.\\ Edinburgh, EH1 1AA} - ... -\end{letter}</programlisting> - - <para>The letter itself begins with the - <literal>\opening</literal> command. The text of the letter - follows. It is typed as ordinary &latex; input. Commands that - make no sense in a letter, like <literal>\chapter</literal>, - do not work. The letter closes with a - <literal>\closing</literal> command. - </para> - <para>After the <literal>closing</literal>, you can have - additional material. The <literal>\cc</literal> command - produces the usual <emphasis>cc: ...</emphasis>. - There's also a similar - <literal>\encl</literal> command for a list of enclosures. - With both these commands, use <literal>\\</literal> to - separate the items. - </para> - <para>These commands are used with the - <literal>letter</literal> class: - </para> - - <bridgehead renderas="sect5" id="cmd-address">\address</bridgehead> - <indexterm><primary>\address</primary></indexterm> - - <para><literal>\address{Return address}</literal> - </para> - <para>The return address, as it should appear on the letter - and the envelope. Separate lines of the address should be - separated by <literal>\\</literal> commands. If you do not - make an <literal>\address</literal> declaration, then the - letter will be formatted for copying onto your - organisation's standard letterhead. (See - <link linkend="overview">&overview;</link>, for details on your - local implementation). If you give an - <literal>\address</literal> declaration, then the letter - will be formatted as a personal letter. - </para> - - <bridgehead renderas="sect5" id="cmd-cc">\cc</bridgehead> - <indexterm><primary>\cc</primary></indexterm> - <indexterm><primary>Cc list</primary></indexterm> - - <para><literal>\cc{Kate Schechter\\Rob McKenna}</literal> - </para> - <para>Generate a list of other persons the letter was sent to. - Each name is printed on a separate line. - </para> - - <bridgehead renderas="sect5" id="cmd-closing">\closing</bridgehead> - <indexterm><primary>\closing</primary></indexterm> - <indexterm><primary>Letters, ending</primary></indexterm> - - <para><literal>\closing{text}</literal> - </para> - <para>The letter closes with a <literal>\closing</literal> - command, i.e., - <programlisting>\closing{Best Regards,}</programlisting> - </para> - - <bridgehead renderas="sect5" id="cmd-encl">\encl</bridgehead> - <indexterm><primary>\encl</primary></indexterm> - <indexterm><primary>Enclosed material</primary></indexterm> - - <para><literal>\encl{CV\\Certificates}</literal> - </para> - <para>Generate a list of enclosed material. - </para> - - <bridgehead renderas="sect5" id="cmd-location">\location</bridgehead> - <indexterm><primary>\location</primary></indexterm> - - <para><literal>\location{address}</literal> - </para> - <para>This modifies your organisation's standard address. - This only appears if the <literal>firstpage</literal> - pagestyle is selected. - </para> - - <bridgehead renderas="sect5" id="cmd-makelabels">\makelabels</bridgehead> - <indexterm><primary>\makelabels</primary></indexterm> - - <para><literal>\makelabels{number}</literal> - </para> - <para>If you issue this command in the preamble, &latex; will - create a sheet of address labels. This sheet will be output - before the letters. - </para> - - <bridgehead renderas="sect5" id="cmd-name">\name</bridgehead> - <indexterm><primary>\name</primary></indexterm> - - <para><literal>\name{June Davenport}</literal> - </para> - <para>Your name, used for printing on the envelope together - with the return address. - </para> - - <bridgehead renderas="sect5" id="cmd-opening">\opening</bridgehead> - <indexterm><primary>\opening</primary></indexterm> - <indexterm><primary>Letters, starting</primary></indexterm> - - <para><literal>\opening{text}</literal> - </para> - <para>The letter begins with the <literal>\opening</literal> - command. The mandatory argument, <literal>text</literal>, - is whatever text you wish to start your letter, i.e., - <programlisting>\opening{Dear Joe,} </programlisting> - </para> - - <bridgehead renderas="sect5" id="cmd-ps">\ps</bridgehead> - <indexterm><primary>\ps</primary></indexterm> - - <para><literal>\ps</literal> - </para> - <para>Use this command before a postscript. - </para> - - <bridgehead renderas="sect5" id="cmd-signature">\signature</bridgehead> - <indexterm><primary>\signature</primary></indexterm> - - <para><literal>\signature{Harvey Swick}</literal> - </para> - <para>Your name, as it should appear at the end of the letter - underneath the space for your signature. Items that should - go on separate lines should be separated by - <literal>\\</literal> commands. - </para> - - <bridgehead renderas="sect5" id="cmd-startbreaks">\startbreaks</bridgehead> - <indexterm><primary>\startbreaks</primary></indexterm> - - <para><literal>\startbreaks</literal> - </para> - <para>Used after a <literal>\stopbreaks</literal> command to - allow page breaks again. - </para> - - <bridgehead renderas="sect5" id="cmd-stopbreaks">\stopbreaks</bridgehead> - <indexterm><primary>\stopbreaks</primary></indexterm> - - <para><literal>\stopbreaks</literal> - </para> - <para>Inhibit page breaks until a - <literal>\startbreaks</literal> command occurs. - </para> - - <bridgehead renderas="sect5" id="cmd-telephone">\telephone</bridgehead> - <indexterm><primary>\telephone</primary></indexterm> - - <para><literal>\telephone{number}</literal> - </para> - <para>This is your telephone number. This only appears if the - <literal>firstpage</literal> pagestyle is selected. - </para> - - </section> - - <section id="line-and-page-breaking"> - <title id="line-and-page-breaking-title">Line & Page Breaking</title> - <indexterm><primary>Page Breaking</primary></indexterm> - <indexterm><primary>Line Breaking</primary></indexterm> - <indexterm><primary>Page Formatting</primary></indexterm> - - <para>The first thing &latex; does when processing ordinary text - is to translate your input file into a string of glyphs and - spaces. To produce a printed document, this string must be - broken into lines, and these lines must be broken into pages. - In some environments, you do the line breaking yourself with - the <literal>\\</literal> command, but &latex; usually does it - for you. - </para> - - <bridgehead renderas="sect5" id="cmd-bslash">\\</bridgehead> - <indexterm><primary>\\</primary></indexterm> - <indexterm><primary>New line, starting</primary></indexterm> - - <para><literal>\\[extra-space], \\*[extra-space]</literal> - </para> - <para>The <literal>\\</literal> command tells &latex; to start a - new line. It has an optional argument, - <literal>extra-space</literal>, that specifies how much - extra vertical space is to be inserted before the next line. - This can be a negative amount. - </para> - <para>The <literal>\\*</literal> command is the same as the - ordinary <literal>\\</literal> command except that it tells - &latex; not to start a new page after the line. - </para> - - <bridgehead renderas="sect5" id="cmd-dash-op-hyphenation-cp">\-</bridgehead> - <indexterm><primary>\- (hyphenation)</primary></indexterm> - <indexterm><primary>Hyphenation, forcing</primary></indexterm> - - <para>The <literal>\-</literal> command tells &latex; that it - may hyphenate the word at that point. &latex; is very good at - hyphenating, and it will usually find all correct - hyphenation points. The <literal>\-</literal> command is - used for the exceptional cases. - </para> - <para>Note that when you insert <literal>\-</literal> commands - in a word, the word will only be hyphenated at those points - and not at any of the hyphenation points that &latex; might - otherwise have chosen. - </para> - - <bridgehead renderas="sect5" id="cmd-cleardoublepage">\cleardoublepage</bridgehead> - <indexterm><primary>\cleardoublepage</primary></indexterm> - <indexterm><primary>Starting on a right-hand page</primary></indexterm> - - <para>The <literal>\cleardoublepage</literal> command ends the - current page and causes all figures and tables that have so - far appeared in the input to be printed. In a two-sided - printing style, it also makes the next page a right-hand - (odd-numbered) page, producing a blank page if necessary. - </para> - - <bridgehead renderas="sect5" id="cmd-clearpage">\clearpage</bridgehead> - <indexterm><primary>\clearpage</primary></indexterm> - <indexterm><primary>Flushing a page</primary></indexterm> - - <para>The <literal>\clearpage</literal> command ends the - current page and causes all figures and tables that have so - far appeared in the input to be printed. - </para> - - <bridgehead renderas="sect5" id="cmd-enlargethispage">\enlargethispage</bridgehead> - <indexterm><primary>\enlargethispage</primary></indexterm> - <indexterm><primary>Enlarge current page</primary></indexterm> - - <para><literal>\enlargethispage{size}</literal> - </para> - <para><literal>\enlargethispage*{size}</literal> - </para> - <para>Enlarge the <literal>\textheight</literal> for the - current page by the specified amount; e.g. - <literal>\enlargethispage{\baselineskip}</literal> will - allow one additional line. - </para> - <para>The starred form tries to squeeze the material together - on the page as much as possible. This is normally used - together with an explicit <literal>\pagebreak</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-samepage">\samepage</bridgehead> - <indexterm><primary>\samepage</primary></indexterm> - - <para><literal>\samepage</literal> - </para> - <para>The object in the argument <literal>{}</literal> - should be on the current page. - </para> - - <bridgehead renderas="sect5" id="cmd-fussy">\fussy</bridgehead> - <indexterm><primary>\fussy</primary></indexterm> - - <para><literal>\fussy</literal> - </para> - <para>This declaration (which is the default) makes &tex; more - fussy about line breaking. This can avoids too much space - between words, but may produce overfull boxes. - </para> - <para>This command cancels the effect of a previous - <literal>\sloppy</literal> command. - <link linkend="cmd-sloppy">\sloppy</link> - </para> - - <bridgehead renderas="sect5" id="cmd-hyphenation">\hyphenation</bridgehead> - <indexterm><primary>\hyphenation</primary></indexterm> - <indexterm><primary>Hyphenation, defining</primary></indexterm> - - <para><literal>\hyphenation{words}</literal> - </para> - <para>The <literal>\hyphenation</literal> command declares - allowed hyphenation points, where <literal>words</literal> - is a list of words, separated by spaces, in which each - hyphenation point is indicated by a <literal>-</literal> - character. - </para> - - <bridgehead renderas="sect5" id="cmd-linebreak">\linebreak</bridgehead> - <indexterm><primary>\linebreak</primary></indexterm> - <indexterm><primary>Line breaks</primary></indexterm> - - <para><literal>\linebreak[number]</literal> - </para> - <para>The <literal>\linebreak</literal> command tells &latex; to - break the current line at the point of the command. With - the optional argument, <literal>number</literal>, you can - convert the <literal>\linebreak</literal> command from a - demand to a request. The number must be a number from 0 to - 4. The higher the number, the more insistent the request is. - </para> - <para>The <literal>\linebreak</literal> command causes &latex; - to stretch the line so it extends to the right margin. - </para> - - <bridgehead renderas="sect5" id="cmd-newline">\newline</bridgehead> - <indexterm><primary>\newline</primary></indexterm> - <indexterm><primary>New line, starting (paragraph mode)</primary></indexterm> - - <para>The <literal>\newline</literal> command breaks the line - right where it is. It can only be used in paragraph mode. - </para> - - <bridgehead renderas="sect5" id="cmd-newpage">\newpage</bridgehead> - <indexterm><primary>\newpage</primary></indexterm> - <indexterm><primary>New Page</primary></indexterm> - - <para>The <literal>\newpage</literal> command ends the - current page. In contrast to - <link linkend="cmd-pagebreak">\pagebreak</link> - it can produce a partly empty page, even when - <link linkend="cmd-flushbottom-title">\flushbottom</link> - is active. - </para> - - <bridgehead renderas="sect5" id="cmd-nolinebreak">\nolinebreak</bridgehead> - <indexterm><primary>\nolinebreak</primary></indexterm> - - <para><literal>\nolinebreak[number]</literal> - </para> - <para>The <literal>\nolinebreak</literal> command prevents - &latex; from breaking the current line at the point of the - command. With the optional argument, - <literal>number</literal>, you can convert the - <literal>\nolinebreak</literal> command from a demand to a - request. The number must be a number from 0 to 4. The - higher the number, the more insistent the request is. - </para> - - <bridgehead renderas="sect5" id="cmd-nopagebreak">\nopagebreak</bridgehead> - <indexterm><primary>\nopagebreak</primary></indexterm> - - <para><literal>\nopagebreak[number]</literal> - </para> - <para>The <literal>\nopagebreak</literal> command prevents - &latex; from breaking the current page at the point of the - command. With the optional argument, - <literal>number</literal>, you can convert the - <literal>\nopagebreak</literal> command from a demand to a - request. The number must be a number from 0 to 4. The - higher the number, the more insistent the request is. - </para> - - <bridgehead renderas="sect5" id="cmd-pagebreak">\pagebreak</bridgehead> - <indexterm><primary>\pagebreak</primary></indexterm> - <indexterm><primary>Page break, forcing</primary></indexterm> - - <para><literal>\pagebreak[number]</literal> - </para> - <para>The <literal>\pagebreak</literal> command tells &latex; to - break the current page at the point of the command. With - the optional argument, <literal>number</literal>, you can - convert the <literal>\pagebreak</literal> command from a - demand to a request. The number must be a number from 0 to - 4. The higher the number, the more insistent the request - is. - </para> - - <bridgehead renderas="sect5" id="cmd-sloppy">\sloppy</bridgehead> - <indexterm><primary>\sloppy</primary></indexterm> - - <para><literal>\sloppy</literal> - </para> - <para>This declaration makes &tex; less fussy about line - breaking. This can prevent overfull boxes, but may leave too - much space between words. - </para> - <para>Lasts until a <literal>\fussy</literal> command is - issued. <link linkend="cmd-fussy">\fussy</link>. - </para> - - </section> - - - <section id="making-paragraphs"> - <title id="making-paragraphs-title">Making Paragraphs</title> - <indexterm><primary>Making paragraphs</primary></indexterm> - <indexterm><primary>Paragraphs</primary></indexterm> - - <para>A paragraph is ended by one or more completely blank lines - --- lines not containing even a <literal>%</literal>. A blank - line should not appear where a new paragraph cannot be - started, such as in math mode or in the argument of a - sectioning command. - </para> - - <bridgehead renderas="sect5" id="cmd-indent">\indent</bridgehead> - <indexterm><primary>\indent</primary></indexterm> - <indexterm><primary>Indent, forcing</primary></indexterm> - - <para><literal>\indent</literal> - </para> - <para>This produces a horizontal space whose width equals the - width of the paragraph indentation. It is used to add - paragraph indentation where it would otherwise be - suppressed. - </para> - - <bridgehead renderas="sect5" id="cmd-noindent">\noindent</bridgehead> - <indexterm><primary>\noindent</primary></indexterm> - <indexterm><primary>Indent, suppressing</primary></indexterm> - - <para><literal>\noindent</literal> - </para> - <para>When used at the beginning of the paragraph, it - suppresses the paragraph indentation. It has no effect when - used in the middle of a paragraph. - </para> - - <bridgehead renderas="sect5" id="cmd-par">\par</bridgehead> - <indexterm><primary>\par</primary></indexterm> - <indexterm><primary>Paragraph, starting a new</primary></indexterm> - - <para>Equivalent to a blank line; often used to make command - or environment definitions easier to read. - </para> - - </section> - - - <section id="margin-notes"> - <title id="margin-notes-title">Margin Notes</title> - <indexterm><primary>Margin Notes</primary></indexterm> - <indexterm><primary>Notes in the margin</primary></indexterm> - <indexterm><primary>Remarks in the margin</primary></indexterm> - - <para>The command <literal>\marginpar[left]{right}</literal> - creates a note in the margin. The first line will be at the - same height as the line in the text where the - <literal>\marginpar</literal> occurs. - </para> - <para>When you only specify the mandatory argument - <literal>right</literal>, the text will be placed - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>in the right margin for one-sided layout - </simpara></listitem> - <listitem> - <simpara>in the outside margin for two-sided layout - </simpara></listitem> - <listitem> - <simpara>in the nearest margin for two-column layout. - </simpara></listitem> - </itemizedlist> - - <para>By issuing the command - <literal>\reversemarginpar</literal>, you can force the - marginal notes to go into the opposite (inside) margin. - </para> - <para>When you specify both arguments, <literal>left</literal> - is used for the left margin, and <literal>right</literal> is - used for the right margin. - </para> - <para>The first word will normally not be hyphenated; you can - enable hyphenation by prefixing the first word with a - <literal>\hspace{0pt}</literal> command. - </para> - - </section> - - - <section id="math-formulae"> - <title id="math-formulae-title">Math Formulae</title> - <indexterm><primary>Math Formulae</primary></indexterm> - <indexterm><primary>Formulae, maths</primary></indexterm> - <indexterm><primary>Math mode, entering</primary></indexterm> - <indexterm><primary>\(</primary></indexterm> - <indexterm><primary>\)</primary></indexterm> - <indexterm><primary>\[</primary></indexterm> - <indexterm><primary>\]</primary></indexterm> - <indexterm><primary>$</primary></indexterm> - - <table frame="none"> - <title>Three environments that put &latex; in math mode</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>math - </entry> - <entry>For Formulae that appear right in the text. - </entry> - </row> - <row rowsep="0"><entry>displaymath - </entry> - <entry>For Formulae that appear on their own line. - </entry> - </row> - <row rowsep="0"><entry>equation - </entry> - <entry>The same as the displaymath environment except - that it adds an equation number in the right margin. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>The <literal>math</literal> environment can be used in - both paragraph and LR mode, but the - <literal>displaymath</literal> and <literal>equation</literal> - environments can be used only in paragraph mode. The - <literal>math</literal> and <literal>displaymath</literal> - environments are used so often that they have the following - short forms: - </para> - <programlisting> -\(...\) instead of \begin{math}...\end{math} - -\[...\] instead of \begin{displaymath}...\end{displaymath}</programlisting> - - <para>In fact, the <literal>math</literal> environment is so - common that it has an even shorter form: - </para> - <programlisting> -$ ... $ instead of \(...\)</programlisting> - - <indexterm><primary>exponent</primary></indexterm> - - <bridgehead renderas="sect5" id="subscripts-and-superscripts-title">Subscripts & Superscripts</bridgehead> - <indexterm><primary>Superscript</primary></indexterm> - <indexterm><primary>Subscript</primary></indexterm> - <indexterm><primary>_</primary></indexterm> - <indexterm><primary>^</primary></indexterm> - - <para>To get an expression <emphasis>exp</emphasis> to appear - as a subscript, you just type - <literal>_{</literal><emphasis>exp</emphasis><literal>} - </literal>. - To get <emphasis>exp</emphasis> to appear as a superscript, - you type - <literal>^{</literal><emphasis>exp</emphasis> - <literal>}</literal>. - &latex; handles superscripted superscripts and all of that - stuff in the natural way. It even does the right thing when - something has both a subscript and a superscript. - </para> - - <bridgehead renderas="sect5" id="math-symbols-title">Math Symbols</bridgehead> - <indexterm><primary>Maths symbols</primary></indexterm> - <indexterm><primary>Symbols</primary></indexterm> - <indexterm><primary>Greek letters</primary></indexterm> - - <bridgehead renderas="sect5" id="spacing-in-math-mode-title">Spacing in Math Mode</bridgehead> - <indexterm><primary>Spacing, within Math mode</primary></indexterm> - <indexterm><primary>Math mode, spacing</primary></indexterm> - - <para>In a <literal>math</literal> environment, &latex; ignores - the spaces you type and puts in the spacing that it thinks - is best. &latex; formats mathematics the way it's done in - mathematics texts. If you want different spacing, &latex; - provides the following four commands for use in math mode: - </para> - <indexterm><primary>\;</primary></indexterm> - <indexterm><primary>\COLON</primary></indexterm> - <indexterm><primary>\,</primary></indexterm> - <indexterm><primary>\!</primary></indexterm> - - <orderedlist><listitem> - <para><literal>\;</literal> - a thick space - </para></listitem> - <listitem> - <para><literal>\:</literal> - a medium space - </para></listitem> - <listitem> - <para><literal>\,</literal> - a thin space - </para></listitem> - <listitem> - <para><literal>\!</literal> - a negative thin space - </para></listitem> - </orderedlist> - - <bridgehead renderas="sect5" id="math-miscellany-title">Math Miscellany</bridgehead> - <indexterm><primary>Math Miscellany</primary></indexterm> - - <table frame="none"> - <title>Math Miscellany</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry id="cmd-math-misc-cdots">\cdots<indexterm> - <primary>\cdots</primary> - </indexterm> - </entry> - <entry>Produces a horizontal ellipsis where the dots - are raised to the centre of the line. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-ddots">\ddots - <indexterm><primary>\ddots</primary></indexterm> - </entry> - <entry>Produces a diagonal ellipsis. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-frac">\frac{num}{den} - <indexterm><primary>\frac</primary></indexterm> - </entry> - <entry>Produces the fraction <literal>num</literal> - divided by <literal>den</literal>. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-ldots">\ldots - <indexterm><primary>\ldots</primary></indexterm> - </entry> - <entry>Produces an ellipsis. This command works in - any mode, not just math mode. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-overbrace">\overbrace{text} - <indexterm><primary>\overbrace</primary></indexterm> - </entry> - <entry>Generates a brace over text. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-overline">\overline{text} - <indexterm><primary>\overline</primary></indexterm> - </entry> - <entry>Causes the argument text to be overlined. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-sqrt">\sqrt[root]{arg} - <indexterm><primary>\sqrt</primary></indexterm> - </entry> - <entry>Produces the square root of its argument. The - optional argument, <literal>root</literal>, - determines what root to produce, i.e., the cube root - of <literal>x+y</literal> would be typed as - <literal>$\sqrt[3]{x+y}$</literal>. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-underbrace">\underbrace{text} - <indexterm><primary>\underbrace</primary></indexterm> - </entry> - <entry>Generates text with a brace underneath. - </entry> - </row> - <row rowsep="0"><entry id="cmd-math-misc-underline">\underline{text} - <indexterm><primary>\underline</primary></indexterm> - </entry> - <entry>Causes the argument text to be underlined. This - command can also be used in paragraph and LR modes. - </entry> - </row> - <row rowsep="0"> - <entry id="cmd-math-misc-vdots">\vdots - <indexterm><primary>\vdots</primary></indexterm> - </entry> - <entry>Produces a vertical ellipsis. - </entry> - </row> - <row rowsep="0"> - <entry id="cmd-math-misc-ensuremath">\ensuremath{} - <indexterm><primary>\ensuremath{}</primary></indexterm> - </entry> - <entry>It's argument is set in math mode. This - is needed for own definitions. - </entry> - </row> - </tbody> - </tgroup> - </table> - - </section> - - <section id="modes"> - <title id="modes-title">Modes</title> - <indexterm><primary>Modes</primary></indexterm> - <indexterm><primary>Paragraph mode</primary></indexterm> - <indexterm><primary>Math mode</primary></indexterm> - <indexterm><primary>Left-to-right mode</primary></indexterm> - <indexterm><primary>LR mode</primary></indexterm> - - <para>When &latex; is processing your input text, it is always in - one of three modes: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara>paragraph mode - </simpara></listitem> - <listitem> - <simpara>Math mode - </simpara></listitem> - <listitem> - <simpara>Left-to-right mode, called LR mode for short - </simpara></listitem> - </itemizedlist> - - <para>&latex; changes mode only when it goes up or down a - staircase to a different level, though not all level changes - produce mode changes. Mode changes occur only when entering or - leaving an environment, or when &latex; is processing the - argument of certain text-producing commands. - </para> - <para><emphasis>Paragraph mode</emphasis> is the most - common; it's the one &latex; - is in when processing ordinary text. In that mode, &latex; - breaks your text into lines and breaks the lines into pages. - &latex; is in <emphasis>math mode</emphasis> when it's - generating a mathematical - formula. In <emphasis>LR mode</emphasis>, as in - paragraph mode, &latex; - considers the output that it produces to be a string of words - with spaces between them. However, unlike paragraph mode, - &latex; keeps going from left to right; it never starts a new - line in LR mode. Even if you put a hundred words into an - <literal>\mbox</literal>, &latex; would keep typesetting them - from left to right inside a single box, and then complain - because the resulting box was too wide to fit on the line. - </para> - <para>&latex; is in LR mode when it starts making a box with an - <literal>\mbox</literal> command. You can get it to enter a - different mode inside the box - for example, you can make it - enter math mode to put a formula in the box. There are also - several text-producing commands and environments for making a - box that put &latex; in paragraph mode. The box make by one of - these commands or environments will be called a - <literal>parbox</literal>. When &latex; is in paragraph mode - while making a box, it is said to be in <emphasis>inner paragraph - mode</emphasis>. Its normal paragraph mode, which it - starts out in, is - called <emphasis>outer paragraph mode</emphasis>. - </para> - - </section> - - - <section id="page-styles"> - <title id="page-styles-title">Page Styles</title> - <indexterm><primary>Styles, page</primary></indexterm> - <indexterm><primary>Page styles</primary></indexterm> - - <para>The <literal>\documentclass</literal> command determines - the size and position of the page's head and foot. The page - style determines what goes in them. - </para> - - <bridgehead renderas="sect5" id="cmd-maketitle">\maketitle</bridgehead> - <indexterm><primary>Title making</primary></indexterm> - <indexterm><primary>\maketitle</primary></indexterm> - - <para><literal>\maketitle</literal> - </para> - <para>The <literal>\maketitle</literal> command generates a - title on a separate title page. In the - <literal>article</literal> class, - <literal>\maketitle</literal> - will also switch to pagestyle <literal>plain</literal>. - See <link linkend="page-styles">Page Styles</link> for - commands to change page numbering. - </para> - <para> - Information used to produce the title is obtained from - the following declarations: - </para> - <para>See <link linkend="page-styles">Page Styles</link> for - the commands to give the information. - </para> - - <bridgehead renderas="sect5" id="cmd-author">\author</bridgehead> - <indexterm><primary>\author</primary></indexterm> - <indexterm><primary>Author, for titlepage</primary></indexterm> - - <para><literal>\author{names}</literal> - </para> - <para>The <literal>\author</literal> command declares the - author(s), where <literal>names</literal> is a list of - authors separated by <literal>\and</literal> commands. Use - <literal>\\</literal> to separate lines within a single - author's entry -- for example, to give the author's - institution or address. - </para> - - <bridgehead renderas="sect5" id="cmd-date">\date</bridgehead> - <indexterm><primary>\date</primary></indexterm> - <indexterm><primary>Date, for titlepage</primary></indexterm> - - <para><literal>\date{text}</literal> - </para> - <para>The <literal>\date</literal> command declares - <emphasis>text</emphasis> to be the document's date. With - no <literal>\date</literal> command, the current date is - used. - </para> - - <bridgehead renderas="sect5" id="cmd-thanks">\thanks</bridgehead> - <indexterm><primary>\thanks</primary></indexterm> - <indexterm><primary>Thanks, for titlepage</primary></indexterm> - - <para><literal>\thanks{text}</literal> - </para> - <para>The <literal>\thanks</literal> command produces a - <literal>\footnote</literal> to the title. - </para> - - <bridgehead renderas="sect5" id="cmd-title">\title</bridgehead> - <indexterm><primary>\title</primary></indexterm> - <indexterm><primary>Title, for titlepage</primary></indexterm> - - <para><literal>\title{text}</literal> - </para> - - <para>The <literal>\title</literal> command declares - <literal>text</literal> to be the title. Use - <literal>\\</literal> to tell &latex; where to start a new - line in a long title. - </para> - - <bridgehead renderas="sect5" id="cmd-pagenumbering">\pagenumbering</bridgehead> - <indexterm><primary>\pagenumbering</primary></indexterm> - <indexterm><primary>Page numbering</primary></indexterm> - - <para><literal>\pagenumbering{num_style}</literal> - </para> - <para>Specifies the style of page numbers. Possible values of - <literal>num_style</literal> are: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>arabic</literal> - Arabic numerals - </simpara></listitem> - <listitem> - <simpara><literal>roman</literal> - Lowercase Roman numerals - </simpara></listitem> - <listitem> - <simpara><literal>Roman</literal> - Uppercase Roman numerals - </simpara></listitem> - <listitem> - <simpara><literal>alph</literal> - Lowercase letters - </simpara></listitem> - <listitem> - <simpara><literal>Alph</literal> - Uppercase letters - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-pagestyle">\pagestyle</bridgehead> - <indexterm><primary>\pagestyle</primary></indexterm> - - <para><literal>\pagestyle{option}</literal> - </para> - <para>The <literal>\pagestyle</literal> command changes the - style from the current page on throughout the remainder of - your document. - </para> - <para>The valid options are: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>plain</literal> - Just a plain page number. - </simpara></listitem> - <listitem> - <simpara><literal>empty</literal> - Produces empty heads and - feet - no page numbers. - </simpara></listitem> - <listitem> - <simpara><literal>headings</literal> - Puts running headings - on each page. The document style specifies what goes in - the headings. - </simpara></listitem> - <listitem> - <simpara><literal>myheadings</literal> - You specify what is - to go in the heading with the - <literal>\markboth</literal> or the - <literal>\markright</literal> commands. - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-markboth">\markboth</bridgehead> - <indexterm><primary>\markboth</primary></indexterm> - - <programlisting> -\markboth{left head}{right head}</programlisting> - - <para>The <literal>\markboth</literal> command is used in - conjunction with the page style - <literal>myheadings</literal> for setting both the left and - the right heading. You should note that a <emphasis>left-hand - heading</emphasis> is generated by the last - <literal>\markboth</literal> command before the end of the - page, while a <emphasis>right-hand heading</emphasis> - is generated by the - first <literal>\markboth</literal> or - <literal>\markright</literal> that comes on the page if - there is one, otherwise by the last one before the page. - </para> - - <bridgehead renderas="sect5" id="cmd-markright">\markright</bridgehead> - <indexterm><primary>\markright</primary></indexterm> - - <programlisting> -\markright{right head}</programlisting> - - <para>The <literal>\markright</literal> command is used in - conjunction with the page style - <literal>myheadings</literal> for setting the right heading, - leaving the left heading unchanged. You should note that a - <emphasis>left-hand heading</emphasis> - is generated by the last - <literal>\markboth</literal> command before the end of the - page, while a <emphasis>right-hand heading</emphasis> - is generated by the - first <literal>\markboth</literal> or - <literal>\markright</literal> that comes on the page if - there is one, otherwise by the last one before the page. - </para> - - <bridgehead renderas="sect5" id="cmd-thispagestyle">\thispagestyle</bridgehead> - <indexterm><primary>\thispagestyle</primary></indexterm> - - <para><literal>\thispagestyle{option}</literal> - </para> - <para>The <literal>\thispagestyle</literal> command works in - the same manner as the <literal>\pagestyle</literal> command - except that it changes the style for the current page only. - </para> - - </section> - - <section id="sectioning"> - <title id="sectioning-title">Sectioning</title> - <indexterm><primary>Sectioning</primary></indexterm> - <indexterm><primary>\chapter</primary></indexterm> - <indexterm><primary>\subsubsection</primary></indexterm> - <indexterm><primary>\subsection</primary></indexterm> - <indexterm><primary>\paragraph</primary></indexterm> - <indexterm><primary>\subparagraph</primary></indexterm> - - <para>Sectioning commands provide the means to structure your - text into units. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-sectioning-part"><literal>\part</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-chapter"><literal>\chapter</literal> (report and book class - only) - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-section"><literal>\section</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-subsection"><literal>\subsection</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-subsubsection"><literal>\subsubsection</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-paragraph"><literal>\paragraph</literal> - </simpara></listitem> - <listitem> - <simpara id="cmd-sectioning-subparagraph"><literal>\subparagraph</literal> - </simpara></listitem> - </itemizedlist> - - <para>All sectioning commands take the same general form, i.e., - </para> - <para><literal>\chapter[optional]{title}</literal> - </para> - <para>In addition to providing the heading in the text, the - mandatory argument of the sectioning command can appear in two - other places: - </para> - <orderedlist><listitem> - <para>The table of contents - </para></listitem> - <listitem> - <para>The running head at the top of the page - </para></listitem> - </orderedlist> - - <para>You may not want the same thing to appear in these other - two places as appears in the text heading. To handle this - situation, the sectioning commands have an - <literal>optional</literal> argument that provides the text - for these other two purposes. - </para> - <para>All sectioning commands have <literal>*</literal>-forms - that print a <emphasis>title</emphasis>, but do not include a - number and do not make an entry in the table of contents. - </para> - <indexterm><primary>\appendix</primary></indexterm> - <indexterm><primary>Appendix, creating</primary></indexterm> - - <para id="cmd-sectioning-appendix"><literal>\appendix</literal> - </para> - <para>The <literal>\appendix</literal> command changes the way - sectional units are numbered. The - <literal>\appendix</literal> command generates no text and - does not affect the numbering of parts. The normal use of this - command is something like - </para> - <programlisting> -\chapter{The First Chapter} - ... -\appendix -\chapter{The First Appendix}</programlisting> - - </section> - - - <section id="spaces-and-boxes"> - <title id="spaces-and-boxes-title">Spaces & Boxes</title> - <indexterm><primary>Spaces</primary></indexterm> - <indexterm><primary>Boxes</primary></indexterm> - - <para>All the predefined length parameters See - <link linkend="predefined-lengths-title">Predefined lengths</link> can - be used in the arguments of the box-making commands. - </para> - - - <bridgehead renderas="sect5" id="cmd-dotfill">\dotfill</bridgehead> - <indexterm><primary>\dotfill</primary></indexterm> - - <para>The <literal>\dotfill</literal> command produces a - <emphasis>rubber length</emphasis> that produces dots - instead of just spaces. - </para> - - <bridgehead renderas="sect5" id="cmd-hfill">\hfill</bridgehead> - <indexterm><primary>\hfill</primary></indexterm> - - <para>The <literal>\hfill</literal> fill command produces a - <emphasis>rubber length</emphasis> which can stretch - or shrink horizontally. It will be filled with spaces. - </para> - - <bridgehead renderas="sect5" id="cmd-hrulefill">\hrulefill</bridgehead> - <indexterm><primary>\hrulefill</primary></indexterm> - - <para>The <literal>\hrulefill</literal> fill command produces - a <emphasis>rubber length</emphasis> which can stretch - or shrink horizontally. It will be filled with a horizontal rule. - </para> - - <bridgehead renderas="sect5" id="cmd-hspace">\hspace</bridgehead> - <indexterm><primary>\hspace</primary></indexterm> - - <para><literal>\hspace{length}, \hspace*{length}</literal> - </para> - - <para>The <literal>\hspace</literal> command adds horizontal - space. The length of the space can be expressed in any - terms that &latex; understands, i.e., points, inches, etc. - You can add negative as well as positive space with an - <literal>\hspace</literal> command. Adding negative space - is like backspacing. - </para> - <para>&latex; removes horizontal space that comes at the end of - a line. If you don't want &latex; to remove this space, - include the optional <literal>*</literal> argument. Then - the space is never removed. - </para> - - <bridgehead renderas="sect5" id="cmd-addvspace">\addvspace</bridgehead> - <indexterm><primary>\addvspace</primary></indexterm> - <indexterm><primary>Vertical space, inserting</primary></indexterm> - <indexterm><primary>Space, inserting vertical</primary></indexterm> - - <para><literal>\addvspace{length}</literal> - </para> - <para>The <literal>\addvspace</literal> command normally adds - a vertical space of height length. However, if vertical - space has already been added to the same point in the - output by a previous <literal>\addvspace</literal> - command, then this command will not add more space than - needed to make the natural length of the total vertical - space equal to <literal>length</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-bigskip">\bigskip</bridgehead> - <indexterm><primary>\bigskip</primary></indexterm> - - <para>The <literal>\bigskip</literal> command is equivalent to - <literal>\vspace{bigskipamount}</literal> where - <literal>bigskipamount</literal> is determined by the - document class. - </para> - - <bridgehead renderas="sect5" id="cmd-medskip">\medskip</bridgehead> - <indexterm><primary>\medskip</primary></indexterm> - - <para>The <literal>\medskip</literal> command is - equivalent to <literal>\vspace{medskipamount}</literal> - where <literal>medskipamount</literal> is determined by - the document class. - </para> - - <bridgehead renderas="sect5" id="cmd-smallskip">\smallskip</bridgehead> - <indexterm><primary>\smallskip</primary></indexterm> - - <para><literal>\smallskip</literal> - </para> - <para>The <literal>\smallskip</literal> command is equivalent - to <literal>\vspace{smallskipamount}</literal> where - <literal>smallskipamount</literal> is determined by the - document class. - </para> - - <bridgehead renderas="sect5" id="cmd-vfill">\vfill</bridgehead> - <indexterm><primary>\vfill</primary></indexterm> - - <para>The <literal>\vfill</literal> fill command produces a - rubber length which can stretch or shrink vertically. - </para> - - <bridgehead renderas="sect5" id="cmd-vspace">\vspace</bridgehead> - <indexterm><primary>\vspace</primary></indexterm> - - <para><literal>\vspace{length}, \vspace*{length}</literal> - </para> - <para>The <literal>\vspace</literal> command adds vertical - space. The length of the space can be expressed in any - terms that &latex; understands, i.e., points, inches, - etc. You can add negative as well as positive space with - an <literal>\vspace</literal> command. - </para> - <para>&latex; removes vertical space that comes at the end - of a page. If you don't want &latex; to remove this - space, include the optional <literal>*</literal> - argument. Then the space is never removed. - </para> - - <bridgehead renderas="sect5" id="cmd-fbox">\fbox</bridgehead> - <indexterm><primary>\fbox</primary></indexterm> - - <para><literal>\fbox{text}</literal> - </para> - <para>The <literal>\fbox</literal> command is exactly the - same as the <literal>\mbox</literal> command, except - that it puts a frame around the outside of the box that - it creates. - </para> - - <bridgehead id="cmd-framebox">\framebox</bridgehead> - <indexterm><primary>\framebox</primary></indexterm> - - <para><literal>\framebox[width][position]{text}</literal> - </para> - <para>The <literal>\framebox</literal> command is exactly the - same as the <literal>\makebox</literal> command, except - that it puts a frame around the outside of the box that - it creates. - </para> - <para>The framebox command produces a rule of thickness - <literal>\fboxrule</literal>, and leaves a space - <literal>\fboxsep</literal> between the rule and the - contents of the box. - </para> - - <bridgehead renderas="sect5" id="env-lrbox">lrbox</bridgehead> - <indexterm><primary>lrbox</primary></indexterm> - - <para><literal>\begin{lrbox}{cmd} text \end{lrbox}</literal> - </para> - <para>This is the environment form of <literal>\sbox</literal>. - </para> - <para>The text inside the environment is saved in the box - <literal>cmd</literal>, which must have been declared with - <literal>\newsavebox</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-makebox">\makebox</bridgehead> - <indexterm><primary>\makebox</primary></indexterm> - - <para><literal>\makebox[width][position]{text}</literal> - </para> - <para>The <literal>\makebox</literal> command creates a - box just wide enough to contain the - <literal>text</literal> specified. The width of the box - is specified by the optional <literal>width</literal> - argument. The position of the text within the box is - determined by the optional <literal>position</literal> - argument. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>c</literal> --- centred (default) - </simpara></listitem> - <listitem> - <simpara><literal>l</literal> --- flushleft - </simpara></listitem> - <listitem> - <simpara><literal>r</literal> --- flushright - </simpara></listitem> - <listitem> - <simpara><literal>s</literal> --- stretch from left to right - margin. The text must contain stretchable space for this - to work. - </simpara></listitem> - </itemizedlist> - - <para>See <link linkend="cmd-makebox-op-picture-cp">\makebox - (picture)</link>. - </para> - - <bridgehead renderas="sect5" id="cmd-mbox">\mbox</bridgehead> - <indexterm><primary>\mbox</primary></indexterm> - - <para><literal>\mbox{text}</literal> - </para> - <para>The <literal>\mbox</literal> command creates a box just - wide enough to hold the text created by its argument. - </para> - <para>Use this command to prevent text from being split - across lines. - </para> - - <bridgehead renderas="sect5" id="cmd-newsavebox">\newsavebox</bridgehead> - <indexterm><primary>\newsavebox</primary></indexterm> - - <para><literal>\newsavebox{cmd}</literal> - </para> - <para>Declares <literal>cmd</literal>, which must be a command - name that is not already defined, to be a bin for saving - boxes. - </para> - - <bridgehead renderas="sect5" id="cmd-parbox">\parbox</bridgehead> - <indexterm><primary>\parbox</primary></indexterm> - - <para><literal>\parbox[position][height][inner-pos]{width}{text}</literal> - </para> - <para>A <literal>parbox</literal> is a box whose contents are - created in <literal>paragraph</literal> mode. The - <literal>\parbox</literal> has two mandatory arguments: - </para> - <itemizedlist spacing="compact" - ><listitem> - <simpara><literal>width</literal> - specifies the width of - the parbox, and - </simpara></listitem> - <listitem> - <simpara><literal>text</literal> - the text that goes inside - the parbox. - </simpara></listitem> - </itemizedlist> - - <para>&latex; will position a <literal>parbox</literal> so - its centre lines up with the centre of the text line. - The optional <emphasis>position</emphasis> argument - allows you to line up either the top or bottom line in - the parbox (default is top). - </para> - <para>If the <emphasis>height</emphasis> argument is not - given, the box will have the natural height of the text. - </para> - <para>The <emphasis>inner-pos</emphasis> argument controls the - placement of the text inside the box. If it is not - specified, <emphasis>position</emphasis> is used. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>t</literal> --- text is placed at the top - of the box. - </simpara></listitem> - <listitem> - <simpara><literal>c</literal> --- text is centred in the box. - </simpara></listitem> - <listitem> - <simpara><literal>b</literal> --- text is placed at the - bottom of the box. - </simpara></listitem> - <listitem> - <simpara><literal>s</literal> --- stretch vertically. The - text must contain vertically stretchable space for this - to work. - </simpara></listitem> - </itemizedlist> - - <para>A <literal>\parbox</literal> command is used for a - parbox containing a small piece of text, with nothing - fancy inside. In particular, you shouldn't use any of - the paragraph-making environments inside a - <literal>\parbox</literal> argument. For larger pieces - of text, including ones containing a paragraph-making - environment, you should use a - <literal>minipage</literal> environment See - <link linkend="env-minipage">minipage</link>. - </para> - - <bridgehead renderas="sect5" id="cmd-raisebox">\raisebox</bridgehead> - <indexterm><primary>\raisebox</primary></indexterm> - - <para><literal>\raisebox{distance}[extend-above][extend-below]{text}</literal> - </para> - <para>The <literal>\raisebox</literal> command is used to - raise or lower text. The first mandatory argument - specifies how high the text is to be raised (or lowered - if it is a negative amount). The text itself is - processed in <literal>LR mode</literal>. - </para> - - <para>Sometimes it's useful to make &latex; think - something has a different size than it really does - or - a different size than &latex; would normally think it - has. The <literal>\raisebox</literal> command lets you - tell &latex; how tall it is. - </para> - <para>The first optional argument, - <literal>extend-above</literal>, makes &latex; think - that the text extends above the line by the amount - specified. The second optional argument, - <literal>extend-below</literal>, makes &latex; think - that the text extends below the line by the amount - specified. - </para> - - <bridgehead renderas="sect5" id="cmd-rule">\rule</bridgehead> - <indexterm><primary>\rule</primary></indexterm> - - <para><literal>\rule[raise-height]{width}{thickness}</literal> - </para> - <para>The <literal>\rule</literal> command is used to produce - horizontal lines. The arguments are defined as follows: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>raise-height</literal> - specifies how high - to raise the rule (optional) - </simpara></listitem> - <listitem> - <simpara><literal>width</literal> - specifies the length of - the rule (mandatory) - </simpara></listitem> - <listitem> - <simpara><literal>thickness</literal> - specifies the - thickness of the rule (mandatory) - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-savebox">\savebox</bridgehead> - <indexterm><primary>\savebox</primary></indexterm> - - <para><literal>\savebox{cmd}[width][pos]{text}</literal></para> - - <para>This command typeset <literal>text</literal> in a box just as - for <literal>\makebox</literal>. However, instead of - printing the resulting box, it saves it in bin - <literal>cmd</literal>, which must have been declared with - <literal>\newsavebox</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-sbox">\sbox</bridgehead> - <indexterm><primary>\sbox</primary></indexterm> - - <para><literal>\sbox{cmd}\{text}</literal> - </para> - <para>This commands typesets <literal>text</literal> in a box - just as for <literal>\mbox</literal>. However, instead of - printing the resulting box, it saves it in - <literal>cmd</literal>, which must have been declared with - <literal>\newsavebox</literal>. - </para> - - <bridgehead renderas="sect5" id="cmd-usebox">\usebox</bridgehead> - <indexterm><primary>\usebox</primary></indexterm> - - <para><literal>\usebox{cmd}</literal> - </para> - <para>Prints the box most recently saved in bin - <literal>cmd</literal> by a <literal>\savebox</literal> - command. - </para> - - </section> - - - <section id="special-characters"> - <title id="special-characters-title">Special Characters</title> - <indexterm><primary>Special Characters</primary></indexterm> - <indexterm><primary>Characters, special</primary></indexterm> - <indexterm><primary>Reserved Characters</primary></indexterm> - <indexterm><primary>Characters, reserved</primary></indexterm> - - <para>The following characters play a special role in &latex; and - are called - <emphasis>special printing characters</emphasis>, or simply - <emphasis>special characters</emphasis>. - </para> - <programlisting> -# $ % & ~ _ ^ \ { }</programlisting> - - <para>Whenever you put one of these special characters into - your file, you are doing something special. If you simply - want the character to be printed just as any other letter, - include a <literal>\</literal> in front of the character. - For example, <literal>\$</literal> will produce - <literal>$</literal> in your output. - </para> - <para>One exception to this rule is the <literal>\</literal> - itself because <literal>\\</literal> has its own special - meaning. A <literal>\</literal> is produced by typing - <literal>$\backslash$</literal> in your file. - </para> - <para>Also, <literal>\~</literal> means `place a tilde - accent over the following letter', so you will probably - want to use <literal>\verb</literal> instead. - </para> - <indexterm><primary>\backslash</primary></indexterm> - <indexterm><primary>\symbol</primary></indexterm> - <indexterm><primary>Accessing any character of a font</primary></indexterm> - - <para>In addition, you can access any character of a font - once you know its number by using the - <literal>\symbol</literal> command. For example, the - character used for displaying spaces in the - <literal>\verb*</literal> command has the code decimal 32, - so it can be typed as <literal>\symbol{32}</literal>. - </para> - <para>You can also specify octal numbers with - <literal>'</literal> or hexadecimal numbers with - <literal>"</literal>, so the previous example could also - be written as <literal>\symbol{'40}</literal> or - <literal>\symbol{"20}</literal>. - </para> - - </section> - - <section id="special-symbols"> - <title id="special-symbols-title">Special Symbols</title> - <indexterm> - <primary>Symbols</primary> - <secondary>Special</secondary> - </indexterm> - <para></para> - - <bridgehead renderas="sect5" id="accents-on-chars-title">Accents on Characters</bridgehead> - <indexterm> - <primary>Accents</primary> - </indexterm> - <para>The rules differ somewhat depending whether you are - in <link linkend="modes">text mode</link>, - <link linkend="modes">math modes</link>, or the - <link linkend="env-tabbing">tabbing environment</link>. - </para> - - <bridgehead renderas="sect5">Text Mode</bridgehead> - <para>The following accents may be placed on letters. - Although <emphasis>o</emphasis> is used in - most of the example, the accents may be placed on - any letter. Accents may even be placed above a - <emphasis>missing</emphasis> letter; for example, - <literal>\~{}</literal> produces a tilde over a - blank space. - </para> - <para>The following commands may be used only in - paragraph or LR mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\`{o}</literal> - produces a grave accent, - <emphasis>ò</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\'{o}</literal> - produces an acute accent, - <emphasis>ó</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\^{o}</literal> - produces a circumflex, - <emphasis>ô</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\"{o}</literal> - produces an umlaut or dieresis, - <emphasis>ö</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\H{o}</literal> - produces a long Hungarian umlaut - </simpara> - </listitem> - <listitem> - <simpara><literal>\~{o}</literal> - produces a tilde, - <emphasis>õ</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\c{c}</literal> - produces a cedilla, - <emphasis> ç</emphasis></simpara> - </listitem> - <listitem> - <simpara><literal>\={o}</literal> - produces a macron accent (a bar over the letter) - </simpara> - </listitem> - <listitem> - <simpara><literal>\b{o}</literal> - produces a bar under the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\.{o}</literal> - produces a dot over the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\d{o}</literal> - produces a dot under the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\u{o}</literal> - produces a breve over the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\v{o}</literal> - produces a <emphasis>v</emphasis> over - the letter</simpara> - </listitem> - <listitem> - <simpara><literal>\t{oo}</literal> - produces a <emphasis>tie</emphasis> - (inverted u) over the two letters - </simpara> - </listitem> - </itemizedlist> - </para> - <para>Note that the letters <emphasis>i</emphasis> - and <emphasis>j</emphasis> require special - treatment when they are given accents because - it is often desirable to replace the - dot with the accent. For this purpose, the commands - <literal>\i</literal> and <literal>\j</literal> - can be used to produce dotless letters. - </para> - <para>For example, - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\^{\i}</literal> - should be used for i, circumflex, î - </simpara> - </listitem> - <listitem> - <simpara><literal>\"{\i}</literal> - should be used for i, umlaut, ï</simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="accents-chars-math">Math Mode</bridgehead> - <para>Several of the above and some similar accents - can also be produced in math mode. The following - commands may be used <emphasis>only</emphasis> - in math mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\hat{o}</literal> - is similar to the circumflex - (cf. <literal>\^</literal>)</simpara> - </listitem> - <listitem> - <simpara><literal>\widehat{oo}</literal> - is a wide version of - <emphasis>\hat</emphasis> - over several letters - </simpara> - </listitem> - <listitem> - <simpara><literal>\check{o}</literal> - is a vee or check (cf. <literal>\v</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\tilde{o}</literal> - is a tilde (cf. <literal>\~</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\widetilde{oo}</literal> - is a wide version of - <literal>\tilde</literal> - over several letters - </simpara> - </listitem> - <listitem> - <simpara><literal>\acute{o}</literal> - is an acute accent (cf. <literal>\`</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\grave{o}</literal> - is a grave accent (cf. <literal>>\'</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\dot{o}</literal> - is a dot over the letter - (cf. <literal>\.</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\ddot{o}</literal> - is a double dot over the letter - </simpara> - </listitem> - <listitem> - <simpara><literal>\breve{o}</literal> - is a breve (cf. <literal>\u</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\bar{o}</literal> - is a macron (cf. <literal>\=</literal>) - </simpara> - </listitem> - <listitem> - <simpara><literal>\vec{o}</literal> - is a vector (arrow) over the letter - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="accents-chars-tabbing">Tabbing Environment</bridgehead> - <para>Some of the accent marks used in running - text have other uses in the - <link linkend="env-tabbing">Tabbing Environment</link>. - In that case they can be created with the - following command: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>>\a'</literal> - for an acute accent</simpara> - </listitem> - <listitem> - <simpara><literal>\a`</literal> - for a grave accent</simpara> - </listitem> - <listitem> - <simpara><literal>\a=</literal> - for a macron accent</simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="arrows-title">Arrows</bridgehead> - <indexterm> - <primary>Arrows</primary> - </indexterm> - <para>&latex; provides commands for all sorts of arrows. - The following commands are used only in math mode. - </para> - <para>In general the command names are created from - <literal>left</literal>, <literal>right</literal>, - <literal>up</literal>, or <literal>down</literal>. - <literal>leftright</literal> gives a double headed - arrow. Prefacing with <literal>long</literal> gives - a longer arrow. Capitalizing the - first letter gives a double-shanked arrow. - </para> - <para>Examples are: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\leftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Leftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\longleftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Longleftarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\rightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Rightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\longrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Longrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\leftrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Leftrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\longleftrightarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\uparrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\downarrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Uparrow</literal></simpara> - </listitem> - <listitem> - <simpara><literal>>\nearrow</literal> points from - southwest to northeast</simpara> - </listitem> - <listitem> - <simpara><literal>\searrow</literal> points from - northwest to southeast</simpara> - </listitem> - <listitem> - <simpara><literal>\swarrow</literal> points from - northeast to southwest</simpara> - </listitem> - <listitem> - <simpara><literal>\nwarrow</literal> points from - southeast to northwest</simpara> - </listitem> - </itemizedlist> - </para> - <para>The <literal>\stackrel</literal> command is - useful for putting things over or under your arrow. - </para> - <para>See also: - <itemizedlist spacing="compact"> - <listitem> - <simpara><link linkend="math-symbols-title">Math Symbols</link></simpara> - </listitem> - <listitem> - <simpara> - <link linkend="binary-and-relational-ops-title"> - Binary and Relational Operators</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="greek-letters-title">Greek Letters</link> - </simpara> - </listitem> - <listitem> - <simpara><link linkend="misc-symbols-title"> - Miscellaneous Symbols</link> - </simpara> - </listitem> - <listitem> - <simpara> - <link linkend="variable-math-size-symbols-title"> - Variable Size Math Symbols</link> - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="binary-and-relational-ops-title">Binary and Relational Operators</bridgehead> - <indexterm> - <primary>Binary Operators</primary> - </indexterm> - <indexterm> - <primary>Relational Operators</primary> - </indexterm> - <indexterm> - <primary>Operators</primary> - <secondary>Binary</secondary> - </indexterm> - <indexterm> - <primary>Operators</primary> - <secondary>Relational</secondary> - </indexterm> - <para>Some <emphasis>math</emphasis> symbols are - obtained by typing the corresponding keyboard - character. Examples include - <programlisting>+ - = < > </programlisting> - <note> - <para>plus, minus, and equal sign may be used in - either text or math mode, but < and > are - math mode only (they produce inverted exclamation - and question marks, respectively, - in text mode). - </para> - </note> - </para> - <para>The following commands may be used only in math mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\pm</literal> - plus or minus sign</simpara> - </listitem> - <listitem> - <simpara><literal>\mp</literal> - minus or plus sign</simpara> - </listitem> - <listitem> - <simpara><literal>\times</literal> - times (an "x")</simpara> - </listitem> - <listitem> - <simpara><literal>\div</literal> - divided by sign</simpara> - </listitem> - <listitem> - <simpara><literal>\ast</literal> - an asterisk (centered)</simpara> - </listitem> - <listitem> - <simpara><literal>\star</literal> - a five-point star (centered)</simpara> - </listitem> - <listitem> - <simpara><literal>\bullet</literal> - a bullet</simpara> - </listitem> - <listitem> - <simpara><literal>\circ</literal> - an open bullet</simpara> - </listitem> - <listitem> - <simpara><literal>\cdot</literal> - a centered dot</simpara> - </listitem> - <listitem> - <simpara><literal>\leq</literal> - less than or equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\ll</literal> - much less than</simpara> - </listitem> - <listitem> - <simpara><literal>\subset</literal> - is a subset of</simpara> - </listitem> - <listitem> - <simpara><literal>\geq</literal> - greater than or equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\gg</literal> - much greater than</simpara> - </listitem> - <listitem> - <simpara><literal>\equiv</literal> - equivalence symbol</simpara> - </listitem> - <listitem> - <simpara><literal>\sim</literal> - similar to</simpara> - </listitem> - <listitem> - <simpara><literal>\simeq</literal> - similar or equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\approx</literal> - approximately equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\neq</literal> - not equal to</simpara> - </listitem> - <listitem> - <simpara><literal>\per</literal> - "perpendicular to" symbols</simpara> - </listitem> - <listitem> - <simpara><literal>\propto</literal> - proportional to</simpara> - </listitem> - </itemizedlist> - </para> - <para>Note that <emphasis>greater than</emphasis> - and <emphasis>less than</emphasis> are obtained - simply by entering <literal>></literal> and - <literal><</literal>. - </para> - <para>A slash, indicating <emphasis>not</emphasis> - can be placed through a symbol (or a letter) with the - <literal>\not</literal> command. For example, - not less than is <literal>\not<</literal> - and not less than or equal to is - <literal>\not\leq</literal>. - If the slash isn't properly positioned it can be - moved by putting a math mode spacing command - between the <literal>\not</literal>and the symbol. - </para> - - <bridgehead renderas="sect5" id="delimiters-title">Delimiters</bridgehead> - <indexterm> - <primary>Delimiters</primary> - </indexterm> - <para>Delimiters are objects which act logically like - parentheses. These can be used only in math mode. - </para> - <para>The delimiters recognized by &latex; include: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>(</literal> - (left parenthesis) - </simpara> - </listitem> - <listitem> - <simpara><literal>)</literal> - (right parenthesis) - </simpara> - </listitem> - <listitem> - <simpara><literal>[</literal> - (left bracket) - </simpara> - </listitem> - <listitem> - <simpara><literal>]</literal> - (right bracket)</simpara> - </listitem> - <listitem> - <simpara><literal>\{</literal> - (left brace) - </simpara> - </listitem> - <listitem> - <simpara><literal>\}</literal> - (right brace) - </simpara> - </listitem> - <listitem> - <simpara><literal>|</literal> - (vertical line) - </simpara> - </listitem> - <listitem> - <simpara><literal>\vert</literal> - (vertical line) - </simpara> - </listitem> - <listitem> - <simpara><literal>\|</literal> - (double vertical lines) - </simpara> - </listitem> - <listitem> - <simpara><literal>\Vert</literal> - (double vertical lines) - </simpara> - </listitem> - <listitem> - <simpara><literal>/</literal> - (slash) - </simpara> - </listitem> - <listitem> - <simpara><literal>\backslash</literal> - (backslash) - </simpara> - </listitem> - <listitem> - <simpara><literal>\langle</literal> - (left angle bracket) - </simpara> - </listitem> - <listitem> - <simpara><literal>\rangle</literal> - (right angle bracket) - </simpara> - </listitem> - <listitem> - <simpara><literal>\uparrow</literal> - (uparrow) - </simpara> - </listitem> - <listitem> - <simpara><literal>\downarrow</literal> - (down arrow) - </simpara> - </listitem> - <listitem> - <simpara><literal>\updownarrow</literal> - (up/down arrow) - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5">Making Delimiters the Right Size</bridgehead> - <para>Delimiters in formulas should be big enough - to <emphasis>fit</emphasis> around the formulas - they delimit (for example arround arrays). - To obtain <emphasis>stretchable</emphasis> - delimiters (&latex; makes them the appropriate size) - type a <literal>\left</literal> or - <literal>\right</literal> command before - the delimiter. <literal>\left</literal> and - <literal>\right</literal> commands must come in - matching pairs, although the delimiters themselves - need not be the same. Thus, - <literal> \left \{ ... \right \[ </literal> - produces a legal pair. - In cases where only one delimiter is desired, it - is possible to make the matching delimiter - <emphasis>invisible</emphasis> by typing a - period (<literal>.</literal>) after the command, - i.e., <literal>\left.</literal> or - <literal>\right.</literal> - </para> - <para>In an <link linkend="env-eqnarray">eqnarray</link> - environment the matching - <literal>\left</literal> and <literal>\right</literal> - cannot be split between lines and it may be necessary - to use an <emphasis>invisible</emphasis> - <literal>\right.</literal> and <literal>\left.</literal> - to terminate and begin parts on different lines. - In this case a second problem may arise, since the - size of the delimiters will be chosen only for the - <emphasis>local part</emphasis>, so that the size of - the <emphasis>visible</emphasis> - <emphasis>left</emphasis> - and <emphasis>right</emphasis> delimiters might - not match. The solution is to trick &latex; into thinking - that both parts have the same vertical height. This - can be done by placing a strut, that is a zero-width - <literal>\rule</literal>. It can also be accomplished - with the <literal>\vphantom</literal> command, which - I have not found documented, but which appears to work. - </para> - <para><literal>\vphantom{construct}</literal> - creates a zero-width object with the height of - <literal>construct</literal>. - The argument can contain things such as - <literal>\frac</literal> or the - <emphasis>variable size math symbols</emphasis> - and should be chosen according to what is in the - section with the delimiter you want to match. - </para> - - <bridgehead renderas="sect5">Some Examples</bridgehead> - - <bridgehead renderas="sect5">A six-j symbol</bridgehead> - <para> - <programlisting> -\[ \left\{ -\begin{array}{ccc} -a & b & c \\ -d & e & f \end{array} -\right>\} \]</programlisting> - This should be displayed something like - (insofar as it can be rendered in - "ascii art"): - <programlisting> -( a b c ) -- - -( d e f ) -</programlisting> - Note that the <literal>\[ ... \]</literal> - set this off as <emphasis>Display Math</emphasis>, - and that the <emphasis>Array Environment</emphasis> - is used to generate the three centered columns - inside the braces. - </para> - - <bridgehead renderas="sect5">A "multiple choice" equation</bridgehead> - <para> - <programlisting> -\[ f(x) = - \left\{ \begin{array}{l} - 0, x < 0 \\ 1, x = 0 \\ - 2, x > 0 \end{array} \right. \]</programlisting> - will be displayed as - <programlisting> - ( 0, x < 0 -f(x) = - 1, x = 0 - ( 2, x > 0</programlisting> - Note that the <emphasis>invisible</emphasis> - <literal>\right</literal> delimiter is specified - using a <emphasis>period</emphasis>. - </para> - - <bridgehead renderas="sect5" id="ellipsis-title">Ellipsis</bridgehead> - <indexterm> - <primary>Ellipsis</primary> - </indexterm> - <para>Ellipses (three dots) can be produced by the - following commands - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\ldots</literal> - horizontally at bottom of line - </simpara> - </listitem> - <listitem> - <simpara><literal>\cdots</literal> - horizontally center of line - (math mode only) - </simpara> - </listitem> - <listitem> - <simpara><literal>\ddots</literal> - diagonal (math mode only) - </simpara> - </listitem> - <listitem> - <simpara><literal>\vdots</literal> - vertical (math mode only) - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="greek-letters-title">Greek Letters</bridgehead> - <indexterm> - <primary>Greek Letters</primary> - </indexterm> - <para>These commands may be used only in math mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\alpha</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\beta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\gamma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\delta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\epsilon</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varepsilon</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\zeta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\eta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\theta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\vartheta</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\iota</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\kappa</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\lambda</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\mu</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\nu</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\xi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\pi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varpi</literal> (variation)</simpara> - </listitem> - <listitem> - <simpara><literal>\rho</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varrho</literal> (variation, - with the tail)</simpara> - </listitem> - <listitem> - <simpara><literal>\sigma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varsigma</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\tau</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\upsilon</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\phi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\varphi</literal> (variation, - script-like)</simpara> - </listitem> - <listitem> - <simpara><literal>\chi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\psi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\omega</literal></simpara> - </listitem> - </itemizedlist> - </para> - <para> - Capital letters: - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>\Gamma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Delta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Theta</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Lambda</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Xi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Pi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Sigma</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Upsilon</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Phi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Psi</literal></simpara> - </listitem> - <listitem> - <simpara><literal>\Omega</literal></simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also: - <itemizedlist spacing="compact"> - <listitem> - <simpara><link linkend="math-symbols-title">Math Symbols</link> - </simpara> - </listitem> - <listitem> - <simpara><link linkend="accents-on-chars-title">Accents</link> - </simpara> - </listitem> - <listitem> - <simpara><link linkend="misc-symbols-title">Miscellaneous Symbols</link> - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5" id="misc-symbols-title">Miscellaneous Symbols</bridgehead> - <indexterm> - <primary>Symbols</primary> - <secondary>Miscellaneous</secondary> - </indexterm> - - <bridgehead renderas="sect5">Some symbols for math</bridgehead> - <para>The following symbols are also used only in math mode - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-misc-symbol-aleph"><literal>\aleph</literal> - Hebrew aleph</simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-hbar"><literal>\hbar</literal> - h-bar, Planck's constant</simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-imath"><literal>\imath</literal> - variation on <emphasis>i</emphasis>; no dot - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-jmath"><literal>\jmath</literal> - variation on <emphasis>j</emphasis>; no dot - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-ell"><literal>\ell</literal> - script (loop) <emphasis>l</emphasis> - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-wp"><literal>\wp</literal> - fancy script lowercase <emphasis>P</emphasis> - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-re"><literal>\Re</literal> - script capital <emphasis>R</emphasis> - (<emphasis>Real</emphasis>) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-im"><literal>\Im</literal> - script capital <emphasis>I</emphasis> - (<emphasis>Imaginary</emphasis>) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-prime"><literal>\prime</literal> - prime (also obtained by typing - <literal>'</literal>) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-nabla"><literal>\nabla</literal> - inverted capital Delta - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-surd"><literal>\surd</literal> - radical (square root) symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-angle"><literal>\angle</literal> - angle symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-forall"><literal>\forall</literal> - <emphasis>for all</emphasis> (inverted A) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-exists"><literal>\exists</literal> - <emphasis>exists</emphasis> (left-facing E) - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-partial"><literal>\partial</literal> - partial derivative symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-infty"><literal>\infty</literal> - infinity symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-triangle"><literal>\triangle</literal> - open triangle symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-box"><literal>\Box</literal> - open square - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-diamond"><literal>\Diamond</literal> - open diamond - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-flat"><literal>\flat</literal> - music: flat symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-natural"><literal>\natural</literal> - music: natural symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-clubsuit"><literal>\clubsuit</literal> - playing cards: club suit symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-diamondsuit"><literal>\diamondsuit</literal> - playing cards: diamond suit symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-heartsuit"><literal>\heartsuit</literal> - playing cards: heart suit symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-misc-symbol-spadsuit"><literal>\spadesuit</literal> - playing cards: space suit symbol - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5">Some Other Symbols</bridgehead> - <para>The following symbols can be used in any mode: - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-other-symbol-dag"><literal>\dag</literal> - dagger - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-ddag">><literal>\ddag</literal> - double dagger - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-s">><literal>\S</literal> - section symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-p">><literal>\P</literal> - paragraph symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-copyright">><literal>\copyright</literal> - copyright symbol - </simpara> - </listitem> - <listitem> - <simpara id="cmd-other-symbol-pounds">><literal>\pounds</literal> - British pound sterling symbol - </simpara> - </listitem> - </itemizedlist> - </para> - - <bridgehead renderas="sect5">Calligraphic Style Letters</bridgehead> - <para>Twenty-six calligraphic letters are - provided (the upper case alphabet). These - can only be used in math mode. - </para> - <para>In &latex; 2.09 they are produced with the - <literal>\cal</literal> declaration: - <programlisting>${\cal A}$</programlisting> - In &latex2e; they are obtained with the - <literal>\mathcal</literal> command: - <programlisting>$\mathcal{CAL}$</programlisting> - </para> - - <bridgehead renderas="sect5" id="math-functions-title">Math Functions</bridgehead> - <indexterm> - <primary>Math Functions</primary> - </indexterm> - <para>Functions like <emphasis>log</emphasis> or - <emphasis>cos</emphasis> are normally used in - math mode. However, inmath mode strings of letters - are treated as a product of variables, which - would normally be displayed in math italics rather - than a text font which would be appropriate for - these functions. To get proper display of such functions - they are generated with &latex; commands. - </para> - <para>Some of these commands are: - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-math-func-arccos"><literal>\arccos</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-arcsin"><literal>\arcsin</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-arctan"><literal>\arctan</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-cos"><literal>\cos</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-cosh"><literal>\cosh</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-cot"><literal>\cot</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-coth"><literal>\coth</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-csc"><literal>\csc</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-deg"><literal>\deg</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-det"><literal>\det</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-dim"><literal>\dim</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-exp"><literal>\exp</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-gcd"><literal>\gcd</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-hom"><literal>\hom</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-inf"><literal>\inf</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-ker"><literal>\ker</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-lg"><literal>\lg</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-lim"><literal>\lim</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-liminf"><literal>\liminf</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-limsup"><literal>\limsup</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-ln"><literal>\ln</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-log"><literal>\log</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-max"><literal>\max</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-min"><literal>\min</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sec"><literal>\sec</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sin"><literal>\sin</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sinh"><literal>\sinh</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-sup"><literal>\sup</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-tan"><literal>\tan</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-tanh"><literal>\tanh</literal></simpara> - </listitem> - </itemizedlist> - </para> - <para>Two commands are provided for the "modulus" function - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-math-func-bmod"><literal>\bmod</literal></simpara> - </listitem> - <listitem> - <simpara id="cmd-math-func-pmod"><literal>\pmod{}</literal></simpara> - </listitem> - </itemizedlist> - The former would be used to write "a mod b" as - <literal>a \bmod b</literal> - and the latter, which requires an argument that is - displayed in parentheses, would be used to write - "n = i (mod j)" as <literal>n = i \pmod{j}</literal> - </para> - - <bridgehead renderas="sect5" id="variable-math-size-symbols-title">Variable Size Math Symbols</bridgehead> - <indexterm> - <primary>Math Symbols, Variable Size</primary> - </indexterm> - <para>The size of some mathematical symbols, notably - summation signs, product signs, and - integral signs, depends on the environment in which they - appear (i.e., <literal>displaymath</literal> - as opposed to <literal>math</literal> environments. - </para> - <para>These include: - <itemizedlist spacing="compact"> - <listitem> - <simpara id="cmd-math-symbol-sum"><literal>\sum</literal> - a summation sign (capital sigma)</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-prod"><literal>\prod</literal> - a product (capital pi)</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-coprod"><literal>\coprod</literal> - a coproduct (inverted capital pi)</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-int"><literal>\int</literal> - an integral sign</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-oint"><literal>\oint</literal> - a surface (circular) integral sign</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigcup"><literal>\bigcup</literal> - big "U"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigcap"><literal>\bigcap</literal> - big inverted "U"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigvee"><literal>\bigvee</literal> - big "V"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigwedge"><literal>\bigwedge</literal> - big inverted "V"</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigodot"><literal>\bigodot</literal> - big "O" with dot at center</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigotimes"><literal>\bigotimes</literal> - big "O" with cross inside</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-bigoplus"><literal>\bigoplus</literal> - big "O" with a + inside</simpara> - </listitem> - <listitem> - <simpara id="cmd-math-symbol-biguplus"><literal>\biguplus</literal> - big "U" with a + inside</simpara> - </listitem> - </itemizedlist> - </para> - <para>The <literal>\sqrt</literal> command also - produces a variable size symbol appropriate for - the size of hte radicand argument. - </para> - <para>The "limits" associated with these symbols are entered - as <emphasis>subscripts</emphasis> for entries appearing - below the symbol and as <emphasis>superscripts</emphasis> - for entries appearing above the symbol. - For example the sum from n=0 to infinity of - x<superscript>n</superscript> would be entered as - <programlisting>\sum_{n=0}^{\infty} x_{n}</programlisting> - The actual placement of the limits depends on whether - this is in <literal>displaymath</literal> mode in which - case they are placed below/above - or in <emphasis>math</emphasis> mode in running text - in which case they are placed as regular - subscripts and superscripts. - </para> - <para>Note that it is possible to treat several of - these symbols (a common example would be a double sum) - as a single symbol for placing limits above and/or - below by using the <literal>\mathop</literal> command. - </para> - <para><emphasis>Hats</emphasis> and - <emphasis>tildes</emphasis> over symbols which stretch - (as best they can) to the correct size for their - arguments are produced by <literal>\widehat</literal> - and <literal>\widetilde</literal> - </para> - - </section> - - - <section id="splitting-the-input"> - <title id="splitting-the-input-title">Splitting the Input</title> - <indexterm><primary>Splitting the input file</primary></indexterm> - <indexterm><primary>Input file, splitting</primary></indexterm> - - <para>A large document requires a lot of input. Rather than - putting the whole input in a single large file, it's more - efficient to split it into several smaller ones. - Regardless of how many separate files you use, there is - one that is the root file; it is the one whose name you - type when you run &latex;. - </para> - - <bridgehead renderas="sect5" id="cmd-include-title">\include</bridgehead> - <indexterm><primary>\include</primary></indexterm> - - <para><literal>\include{file}</literal> - </para> - <para>The <literal>\include</literal> command is used in - conjunction with the <literal>\includeonly</literal> - command for selective inclusion of files. The - <literal>file</literal> argument is the first name of a - file, denoting <filename>file.tex</filename>. If - <literal>file</literal> is one the file names in the - file list of the <literal>\includeonly</literal> command - or if there is no <literal>\includeonly</literal> - command, the <literal>\include</literal> command is - equivalent to - </para> - <programlisting> -\clearpage \input{file} \clearpage</programlisting> - - <para>except that if the file - <filename>file.tex</filename> does not exist, then a - warning message rather than an error is produced. If - the file is not in the file list, the - <literal>\include</literal> command is equivalent to - <literal>\clearpage</literal>. - </para> - <para>The <literal>\include</literal> command may not appear - in the preamble or in a file read by another - <literal>\include</literal> command. - </para> - - <bridgehead renderas="sect5" id="cmd-includeonly-title">\includeonly</bridgehead> - <indexterm><primary>\includeonly</primary></indexterm> - - <para><literal>\includeonly{</literal><emphasis>file_list</emphasis><literal>}</literal> - </para> - <para>The <literal>\includeonly</literal> command controls - which files will be read in by an - <literal>\include</literal> command. - <emphasis>file_list</emphasis> should be a - comma-separated list of filenames. Each filename must - match exactly a filename specified in a - <literal>\include</literal> command. This command can - only appear in the preamble. - </para> - - <bridgehead renderas="sect5" id="cmd-input-title">\input</bridgehead> - <indexterm><primary>\input</primary></indexterm> - - <para><literal>\input{file}</literal> - </para> - <para>The <literal>\input</literal> command causes the - indicated <literal>file</literal> to be read and processed, - exactly as if its contents had been inserted in the current - file at that point. The file name may be a complete file - name with extension or just a first name, in which case the - file <filename>file.tex</filename> is used. - </para> - - </section> - - - <section id="starting-and-ending"> - <title id="starting-and-ending-title">Starting & Ending</title> - <indexterm><primary>Starting & Ending</primary></indexterm> - <indexterm><primary>Ending & Starting</primary></indexterm> - - <para>Your input file must contain the following commands as a minimum: - </para> - <programlisting> -\documentclass{class} -\begin{document} - ... your text goes here ... -\end{document}</programlisting> - - <para>where the <literal>class</literal> selected is one of the - valid classes for &latex;. See <link linkend="document-classes">Document Classes</link> (and see - <link linkend="overview">&overview;</link>), for details of the - various document classes available locally. - </para> - <para>You may include other &latex; commands between the - <literal>\documentclass</literal> and the - <literal>\begin{document}</literal> commands (i.e., in the - `preamble'). - </para> - - </section> - - - <section id="table-of-contents"> - <title id="table-of-contents-title">Table of Contents</title> - <indexterm><primary>Table of Contents, creating</primary></indexterm> - - <para>A table of contents is produced with the - <literal>\tableofcontents</literal> - <indexterm><primary>\tableofcontents</primary></indexterm> - command. You put the command right where you want the table of - contents to go; &latex; does the rest for you. It produces a - heading, but it does not automatically start a new page. If - you want a new page after the table of contents, include a - <literal>\newpage</literal> command after the - <literal>\tableofcontents</literal> command. - </para> - <para>There are similar commands - <literal>\listoffigures</literal> - <indexterm><primary>\listoffigures</primary></indexterm> and - <literal>\listoftables</literal> - <indexterm><primary>\listoftables</primary></indexterm> for - producing a list of figures and a list of tables, - respectively. Everything works exactly the same as for the - table of contents. </para> - <para>NOTE: If you want any of - these items to be generated, you cannot have the - <literal>\nofiles</literal> - <indexterm><primary>\nofiles</primary></indexterm> command in - your document. - </para> - - <bridgehead renderas="sect5" id="cmd-addcontentsline-title">\addcontentsline</bridgehead> - <indexterm><primary>\addcontentsline</primary></indexterm> - - <para><literal>\addcontentsline{file}{sec_unit}{entry}</literal> - </para> - <para>The <literal>\addcontentsline</literal> command adds an - entry to the specified list or table where: - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>file</literal> is the extension of the file - on which information is to be written: - <literal>toc</literal> (table of contents), - <literal>lof</literal> (list of figures), or - <literal>lot</literal> (list of tables). - </simpara></listitem> - <listitem> - <simpara><literal>sec_unit</literal> controls the formatting - of the entry. It should be one of the following, - depending upon the value of the file argument: - </simpara><orderedlist><listitem> - <simpara><literal>toc</literal> --- the name of the - sectional unit, such as part or subsection. - </simpara></listitem> - <listitem> - <simpara><literal>lof</literal> --- figure - </simpara></listitem> - <listitem> - <simpara><literal>lot</literal> --- table - </simpara></listitem> - </orderedlist> - </listitem> - <listitem> - <simpara><literal>entry</literal> is the text of the entry. - </simpara></listitem> - </itemizedlist> - - <bridgehead renderas="sect5" id="cmd-addtocontents-title">\addtocontents</bridgehead> - <indexterm><primary>\addtocontents</primary></indexterm> - - <para><literal>\addtocontents{file}{text}</literal> - </para> - <para>The <literal>\addtocontents</literal> command adds text - (or formatting commands) directly to the file that generates - the table of contents or list of figures or tables. - </para> - <itemizedlist spacing="compact"> - <listitem> - <simpara><literal>file</literal> is the extension of the file - on which information is to be written: - <literal>toc</literal> (table of contents), - <literal>lof</literal> (list of figures), or - <literal>lot</literal> (list of tables). - </simpara></listitem> - <listitem> - <simpara><literal>text</literal> is the information to be - written. - </simpara></listitem> - </itemizedlist> - - </section> - - <section id="terminal-input-slash-output"> - <title id="terminal-input-slash-output-title">Terminal Input/Output</title> - <indexterm><primary>Input/Output</primary></indexterm> - <indexterm><primary>Terminal Input/Output</primary></indexterm> - - <bridgehead renderas="sect5" id="cmd-typein-title">\typein</bridgehead> - <indexterm><primary>\typein</primary></indexterm> - - <para><literal>\typein[cmd]{msg}</literal> - </para> - - <para>Prints <literal>msg</literal> on the terminal and - causes &latex; to stop and wait for you to type a line - of input, ending with return. If the - <literal>cmd</literal> argument is missing, the typed - input is processed as if it had been included in the - input file in place of the <literal>\typein</literal> - command. If the <literal>cmd</literal> argument is - present, it must be a command name. This command name - is then defined or redefined to be the typed input. - </para> - - <bridgehead renderas="sect5" id="cmd-typeout-title">\typeout</bridgehead> - <indexterm><primary>\typeout</primary></indexterm> - - <para><literal>\typeout{msg}</literal> - </para> - <para>Prints <literal>msg</literal> on the terminal and in the - <literal>log</literal> file. Commands in - <literal>msg</literal> that are defined with - <literal>\newcommand</literal> or - <literal>\renewcommand</literal> are replaced by their - definitions before being printed. - </para> - - <para>&latex;'s usual rules for treating multiple spaces - as a single space and ignoring spaces after a command - name apply to <literal>msg</literal>. A - <literal>\space</literal> command in - <literal>msg</literal> causes a single space to be - printed. A <literal>^^J</literal> in - <literal>msg</literal> prints a newline. - </para> - - </section> - - <section id="typefaces"> - <title id="typefaces-title">Typefaces</title> - <indexterm><primary>Typefaces</primary></indexterm> - <indexterm><primary>Fonts</primary></indexterm> - - <para>The <literal>typeface</literal> is specified by giving the - <emphasis>size</emphasis> and <emphasis>style</emphasis>. - A typeface is also called a <emphasis>font</emphasis>. - </para> - - <bridgehead renderas="sect5" id="styles-title">\Styles</bridgehead> - <indexterm><primary>Font Styles</primary></indexterm> - <indexterm><primary>Typeface Styles</primary></indexterm> - <indexterm><primary>Styles of text</primary></indexterm> - - <para>The following type style commands are supported by - &latex;. - </para> - <para>These commands are used like <literal>\textit{italics - text}</literal>. The corresponding command in parenthesis - is the <emphasis>declaration form</emphasis>, which - takes no arguments. The - scope of the declaration form lasts until the next type - style command or the end of the current group. - </para> - <para>The declaration forms are cumulative; i.e., you can say - <literal>\sffamily\bfseries</literal> to get sans serif - boldface. - </para> - <para>You can also use the environment form of the declaration - forms; e.g. - <literal>\begin{ttfamily}...\end{ttfamily}</literal>. - </para> - <table frame="none"> - <title>Typefaces</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>\textrm (\rmfamily) - <indexterm><primary>\textrm</primary></indexterm> - <indexterm><primary>\rmfamily</primary></indexterm> - </entry> - <entry>Roman. - </entry> - </row> - <row rowsep="0"><entry>\textit (\itshape) - <indexterm><primary>\textit</primary></indexterm> - <indexterm><primary>\itshape</primary></indexterm>, - \emph - <indexterm><primary>\emph</primary></indexterm> - </entry> - <entry>Emphasis (toggles between \textit and \textrm). - </entry> - </row> - <row rowsep="0"><entry>\textmd (\mdseries) - <indexterm><primary>\textmd</primary></indexterm> - <indexterm><primary>\mdseries</primary></indexterm> - </entry> - <entry>Medium weight (default). The opposite of - boldface. - </entry> - </row> - <row rowsep="0"><entry>\textbf (\bfseries) - <indexterm><primary>\textbf</primary></indexterm> - <indexterm><primary>\bfseries</primary></indexterm> - </entry> - <entry>Boldface. - </entry> - </row> - <row rowsep="0"><entry>\textup (\upshape) - <indexterm><primary>\textup</primary></indexterm> - <indexterm><primary>\upshape</primary></indexterm> - </entry> - <entry>Upright (default). The opposite of slanted. - </entry> - </row> - <row rowsep="0"><entry>\textsl (\slshape) - <indexterm><primary>\textsl</primary></indexterm> - <indexterm><primary>\slshape</primary></indexterm> - </entry> - <entry>Slanted. - </entry> - </row> - <row rowsep="0"><entry>\textsf (\sffamily) - <indexterm><primary>\textsf</primary></indexterm> - <indexterm><primary>\sffamily</primary></indexterm> - </entry> - <entry>Sans serif. - </entry> - </row> - <row rowsep="0"><entry>\textsc (\scshape) - <indexterm><primary>\textsc</primary></indexterm> - <indexterm><primary>\scshape</primary></indexterm> - </entry> - <entry>Small caps. - </entry> - </row> - <row rowsep="0"><entry>\texttt (\ttfamily) - <indexterm><primary>\texttt</primary></indexterm> - <indexterm><primary>\ttfamily</primary></indexterm> - </entry> - <entry>Typewriter. - </entry> - </row> - <row rowsep="0"><entry>\textnormal (\normalfont) - <indexterm><primary>\textnormal</primary></indexterm> - <indexterm><primary>\normalfont</primary></indexterm> - </entry> - <entry>Main document font. - </entry> - </row> - <row rowsep="0"><entry>\mathrm - <indexterm><primary>\mathrm</primary></indexterm> - </entry> - <entry>Roman, for use in math mode. - </entry> - </row> - <row rowsep="0"><entry>\mathbf - <indexterm><primary>\mathbf</primary></indexterm> - </entry> - <entry>Boldface, for use in math mode. - For bold symbols or complete equations take a look at - <link linkend="boldsymbol-linkend"><literal>\boldsymbol</literal></link> - and <link linkend="cmd-bm"><literal>\bm</literal></link>. - </entry> - </row> - <row rowsep="0"><entry>\mathsf - <indexterm><primary>\mathsf</primary></indexterm> - </entry> - <entry>Sans serif, for use in math mode. - </entry> - </row> - <row rowsep="0"><entry>\mathtt - <indexterm><primary>\mathtt</primary></indexterm> - </entry> - <entry>Typewriter, for use in math mode. - </entry> - </row> - <row rowsep="0"><entry>\mathit - <indexterm><primary>\mathit</primary></indexterm> - </entry> - <entry>Italics, for use in math mode, e.g. variable - names with several letters. - </entry> - </row> - <row rowsep="0"><entry>\mathnormal - <indexterm><primary>\mathnormal</primary></indexterm> - </entry> - <entry>For use in math mode, e.g. inside another type - style declaration. - </entry> - </row> - <row rowsep="0"><entry>\mathcal - <indexterm><primary>\mathcal</primary></indexterm> - </entry> - <entry>`Calligraphic' letters, for use in math mode. - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>In addition, the command - <literal>\mathversion{bold}</literal> - <indexterm><primary>\mathversion</primary></indexterm> can - be used for switching to bold letters and symbols in - formulas. <literal>\mathversion{normal}</literal> restores - the default. - </para> - - <bridgehead renderas="sect5" id="sizes-title">Sizes</bridgehead> - <indexterm><primary>Font Sizes</primary></indexterm> - <indexterm><primary>Typeface Sizes</primary></indexterm> - <indexterm><primary>Sizes of text</primary></indexterm> - - <para>The following standard type size commands are supported - by &latex;. - </para> - <para>The commands as listed here are "declaration forms". The - scope of the declaration form lasts until the next type - style command or the end of the current group. - </para> - <para>You can also use the environment form of these commands; - e.g. <literal>\begin{tiny}...\end{tiny}</literal>. - </para> - <table frame="none"> - <title>Standard type size commands</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry>\tiny<indexterm> - <primary>\tiny</primary> - </indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\scriptsize - <indexterm><primary>\scriptsize</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\footnotesize - <indexterm><primary>\footnotesize</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\small - <indexterm><primary>\small</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\normalsize - <indexterm><primary>\normalsize</primary></indexterm> - </entry> - <entry>(default)</entry> - </row> - <row rowsep="0"> - <entry>\large - <indexterm><primary>\large</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\Large - <indexterm><primary>\Large</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\LARGE - <indexterm><primary>\LARGE</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\huge - <indexterm><primary>\huge</primary></indexterm> - </entry> - <entry> - </entry> - </row> - <row rowsep="0"> - <entry>\Huge - <indexterm><primary>\Huge</primary></indexterm> - </entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - - <bridgehead renderas="sect5" id="low-dash-level-font-commands-title">Low-level font commands</bridgehead> - <indexterm><primary>Low-level font commands</primary></indexterm> - <indexterm><primary>Font commands, low-level</primary></indexterm> - - <para>These commands are primarily intended for writers of - macros and packages. The commands listed here are only a - subset of the available ones. For full details, you - should consult Chapter 7 of <citetitle>The &latex; - Companion</citetitle>. - </para> - - <table frame="none"> - <title>Low-level font commands</title> - <tgroup cols="2"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"><entry>\fontencoding{enc} - <indexterm><primary>\fontencoding</primary></indexterm> - </entry> - <entry>Select font encoding. Valid encodings include - <literal>OT1</literal> and <literal>T1</literal>. - </entry> - </row> - <row rowsep="0"><entry>\fontfamily{family} - <indexterm><primary>\fontfamily</primary></indexterm> - </entry> - <entry>Select font family. Valid families include: - <itemizedlist spacing="compact"> - <listitem><simpara><literal>cmr</literal> for - Computer Modern Roman - </simpara> - </listitem> - <listitem><simpara><literal>cmss</literal> for - Computer Modern Sans Serif - </simpara> - </listitem> - <listitem><simpara><literal>cmtt</literal> for - Computer Modern Typewriter - </simpara> - </listitem> - </itemizedlist> and numerous others. - </entry> - </row> - <row rowsep="0"><entry>\fontseries{series} - <indexterm><primary>\fontseries</primary></indexterm> - </entry> - <entry>Select font series. Valid series include: - - <itemizedlist spacing="compact"> - <listitem><simpara><literal>m</literal> Medium - (normal) - </simpara> - </listitem> - <listitem><simpara><literal>b</literal> Bold - </simpara> - </listitem> - <listitem><simpara><literal>c</literal> Condensed - </simpara> - </listitem> - <listitem><simpara><literal>bc</literal> Bold - condensed - </simpara> - </listitem> - <listitem><simpara><literal>bx</literal> Bold - extended - </simpara> - </listitem> - </itemizedlist> and various other combinations. - </entry> - </row> - <row rowsep="0"><entry>\fontshape{shape} - <indexterm><primary>\fontshape</primary></indexterm> - </entry> - <entry>Select font shape. Valid shapes are: - <itemizedlist spacing="compact"> - <listitem><simpara><literal>n</literal> Upright - (normal) - </simpara> - </listitem> - <listitem><simpara><literal>it</literal> Italic - </simpara> - </listitem> - <listitem><simpara><literal>sl</literal> Slanted - (oblique) - </simpara> - </listitem> - <listitem><simpara><literal>sc</literal> Small caps - </simpara> - </listitem> - <listitem><simpara><literal>ui</literal> Upright - italics - </simpara> - </listitem> - <listitem><simpara><literal>ol</literal> Outline - </simpara> - </listitem> - </itemizedlist> The two last shapes are not - available for most font families. - </entry> - </row> - <row rowsep="0"><entry>\fontsize{size}{skip} - <indexterm><primary>\fontsize</primary></indexterm> - </entry> - <entry>Set font size. The first parameter is the font - size to switch to; the second is the - <literal>\baselineskip</literal> to use. The unit of - both parameters defaults to pt. A rule of thumb is - that the baselineskip should be 1.2 times the font - size. - </entry> - </row> - <row rowsep="0"><entry>\selectfont - <indexterm><primary>\selectfont</primary></indexterm> - </entry> - <entry>The changes made by calling the four font - commands described above do not come into effect - until <literal>\selectfont</literal> is called. - </entry> - </row> - <row rowsep="0"><entry>\usefont{enc}{family}{series}{shape} - <indexterm><primary>\usefont</primary></indexterm> - </entry> - <entry>Equivalent to calling - <literal>\fontencoding</literal>, - <literal>\fontfamily</literal>, - <literal>\fontseries</literal> and - <literal>\fontshape</literal> with the given - parameters, followed by - <literal>\selectfont</literal>. - </entry> - </row> - </tbody> - </tgroup> - </table> - - </section> - - </section> - - <section id="parameters"> - <title id="parameters-title">Parameters</title> - <indexterm><primary>Parameters</primary></indexterm> - - <para>The input file specification indicates the file to be - formatted; &tex; uses <filename>.tex</filename> as a default file - extension. If you omit the input file entirely, &tex; accepts - input from the terminal. You specify command options by - supplying a string as a parameter to the command; e.g. - </para> - <para><literal>latex \scrollmode\input foo.tex</literal> - </para> - <para>will process <filename>foo.tex</filename> without pausing - after every error. - </para> - <para>Output files are always created in the current directory. - When you fail to specify an input file name, &tex; bases the - output names on the file specification associated with the - logical name TEX_OUTPUT, typically - <literal>texput.log</literal>. - </para> - - </section> - - </section> - - - <section id="latex-packages"> - <title id="latex-packages-title">&latex; Packages</title> - <indexterm><primary>LaTeX Packages</primary></indexterm> - - <section id="amsmath"> - <title id="amsmath-title"><filename role="nohyphenation">amsmath</filename></title> - <indexterm><primary>amsmath</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>amsmath</secondary> - </indexterm> - <para><literal>amsmath</literal> consists of several packages - to aid in typesetting math. - </para> - <para> - <variablelist id="boldsymbol-linkend" role="db2latex:compact"> - <varlistentry> - <term><literal>\boldsymbol</literal></term> - <listitem> - <indexterm> - <primary>\boldsymbol</primary> - </indexterm> - <para>Produces a bold math symbol. When not only - a single symbol, but a complete equation has to - be bold you might consider using the superior - <link linkend="cmd-bm"><literal>\bm</literal></link> - command which takes - better care of spacing.</para> - </listitem> - </varlistentry> - <varlistentry id="pmb-linkend"> - <term><literal>\pmb</literal></term> - <listitem> - <indexterm> - <primary>\pmb</primary> - </indexterm> - <para>Can be used for mathematic symbols, when no - bold version is available. It prints the standard - symbol several times slightly shifted and is - inferior to a real bold font! - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="dcolumn"> - <title id="dcolumn-title"><filename role="nohyphenation">dcolumn</filename></title> - <indexterm><primary>dcolumn</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>dcolumn</secondary> - </indexterm> - <para><literal>\usepackage{dcolumn}</literal></para> - <para>Defines a system for defining columns of entries in an - <literal>array</literal> or <literal>tabular</literal> - which are to be aligned on a - <emphasis>decimal point</emphasis>. - </para> - <para> - This package defines <literal>D</literal> to be a column - specifier with three arguments: - <programlisting>D{sep.tex}{sep.dvi}{decimal places}</programlisting> - </para> - <para><literal>sep.tex</literal> should be a single character, - this is used as the separator in the <literal>.tex</literal> - file. It will usually be '<literal>.</literal>' or - '<literal>,</literal>'. - </para> - <para><literal>sep.dvi</literal> is used as the separator in the - output. - </para> - <para><literal>decimal places</literal> should be the maximum - number of decimal places in the column. - </para> - <para><literal>\newcolumntype</literal> can be used to define - own column types. - </para> - </section> - - - - <section id="float"> - <title id="float-title"><filename role="nohyphenation">float</filename></title> - <indexterm><primary>float</primary></indexterm> - <note> - <para>The contents of this section was taken from - the documentation of <filename>float</filename> v1.3d of 2001/11/08. - </para> - </note> - - <para><quote>This style option improves the interface for defining - objects such as figures and tabels in &latex;. It adds the - notion of a <emphasis>float style</emphasis> that governs the - appearance of floats.</quote> - </para> - - <variablelist role="db2latex:compact"> - - <varlistentry> - <term><literal>\newfloat{<placement>}{<ext>}[<within>]</literal></term> - <listitem> - <indexterm><primary>\newfloat</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\newfloat</secondary> - </indexterm> - <para>Add a new class of floats.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\floatstyle{<style>}</literal></term> - <listitem> - <indexterm><primary>\floatstyle</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\floatstyle</secondary> - </indexterm> - <para>Sets a default float style.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\floatname{<style>}{<name>}</literal></term> - <listitem> - <indexterm><primary>\floatname</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\floatname</secondary> - </indexterm> - <para>Define the <emphasis>float name</emphasis> used - in the caption of a float.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\floatplacement{<>}{<placement>}</literal></term> - <listitem> - <indexterm><primary>\floatplacement</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\floatplacement</secondary> - </indexterm> - <para>Resets the default placement specifier of a class of floats.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\restylefloat<style></literal></term> - <listitem> - <indexterm><primary>\restylefloat</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\restylefloat</secondary> - </indexterm> - <para>Change styles for the standard float types - <literal>figure</literal> and <literal>table</literal>.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><literal>\listof{<type>}{<title>}</literal></term> - <listitem> - <indexterm><primary>\listof</primary></indexterm> - <indexterm> - <primary>float</primary> - <secondary>\listof</secondary> - </indexterm> - <para>Produces a list of all floats of a given class.</para> - </listitem> - </varlistentry> - </variablelist> - - </section> - - - <section id="fontenc"> - <title id="fontenc-title"><filename role="nohyphenation">fontenc</filename></title> - <indexterm><primary>fontenc</primary></indexterm> - - <para><literal>\usepackage[T1]{fontenc}</literal> - </para> - <para> - chooses T1-fonts and allows correct automatic hyphenation. - </para> - </section> - - <section id="german"> - <title id="german-title"><filename role="nohyphenation">german</filename></title> - <indexterm><primary>german</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>german</secondary> - </indexterm> - <para>Das <literal>german</literal> Paket muß geladen sein:</para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>"a</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"a</secondary> - </indexterm> - <para>erzeugt ein <emphasis>ä</emphasis></para> - <para>entsprechend <literal>"o</literal>, - <literal>"u</literal>, <literal>"A</literal>, - <literal>"O</literal>, <literal>"U</literal>, - <literal>"s (ß)</literal></para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"ck</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"ck</secondary> - </indexterm> - <para>wird bei Trennung zu <literal>k-k</literal></para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"ff</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"ff</secondary> - </indexterm> - <para>wird bei Trennung zu <literal>ff-f</literal> - </para> - <para>entsprechend <literal>"ll</literal>, - <literal>"mm</literal>, <literal>"pp</literal>, - <literal>"rr</literal>, <literal>"tt</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\glqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\glqq</secondary> - </indexterm> - <para>oder <literal>"`</literal> - erzeugt untere doppelte Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry id="cmd-grqq"> - <term><literal>\grqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\grqq</secondary> - </indexterm> - <para>oder <literal>"'</literal> - erzeugt obere doppelte Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\glq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\glq</secondary> - </indexterm> - <para>erzeugt untere einfache Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\flqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\flqq</secondary> - </indexterm> - <para>oder <literal>"<</literal> - doppelte linke französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\frqq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\frqq</secondary> - </indexterm> - <para>oder <literal>"></literal> - doppelte rechte französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\flq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\flq</secondary> - </indexterm> - <para>einfache linke französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\frq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\frq</secondary> - </indexterm> - <para>einfache rechte französische Anführungszeichen - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"|</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"|</secondary> - </indexterm> - <para>verhindert eine Ligatur an der Stelle</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\-</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\-</secondary> - </indexterm> - <para>markiert mögliche Trennstelle, im restlichen - Wort ist keine Trennung mehr möglich - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"-</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>!-</secondary> - </indexterm> - <para>Trennvorschlag, der Rest des Wortes kann - noch automatisch getrennt werden - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>""</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>""</secondary> - </indexterm> - <para>Trennvorschlag, bei dem bei einer Trennung - kein Bindestrich eingefügt wird - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"~</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"~</secondary> - </indexterm> - <para>Bindestrich, an dem nicht getrennt werden darf</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>"=</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>"=</secondary> - </indexterm> - <para>Bindestrich, an dem getrennt werden darf</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\dq</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary>\dq</secondary> - </indexterm> - <para>erzeugt ein nicht-typographisches gerades - Anführungszeichen - </para> - <programlisting>\texttt{\dq}</programlisting> - </listitem> - </varlistentry> - <varlistentry> - <term><literal><</literal></term> - <listitem> - <indexterm> - <primary>german</primary> - <secondary><</secondary> - </indexterm> - <para>oder <literal>\dq</literal> ergibt das - Zoll-Zeichen - </para> - </listitem> - </varlistentry> - </variablelist> - - </para> - </section> - - <section id="graphics"> - <title id="graphics-title"><filename role="nohyphenation">graphics</filename></title> - <indexterm><primary>graphics</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>graphics</secondary> - </indexterm> - <para>Look up details in <filename>grfguide</filename>.</para> - - <section id="includegraphics"> - <title id="includegraphics-title">\includegraphics</title> - <indexterm><primary>\includegraphics</primary></indexterm> - <para><literal>\includegraphics[]{picture-name}</literal> - </para> - <para> - File extensions of the graphics should be omitted, so it's - easier to change the format (for example for pdf or ps - output). - </para> - </section> - - <section id="graphicspath"> - <title id="graphicspath-title">\graphicspath</title> - <indexterm><primary>\graphicspath</primary></indexterm> - <para><literal>\graphicspath{dir-list}</literal> - </para> - <para><literal>dir-list</literal> is a list of absolute or - relative paths, where the command - <link linkend="includegraphics"><literal>\includegraphics{}</literal></link> - searches for the graphic files: - </para> - <para><literal>\graphicspath{{eps/}{tiff/}}</literal> would - cause the system to look in the subdirectories - <literal>eps</literal> and <literal>tiff</literal> of the - current directory. This is unix syntax, on a Mac it would - be: - </para> - <para><literal>\graphicspath{{:eps:}{:tiff:}}</literal> - </para> - <para>Under Windows/DOS use also the slash - <literal>/</literal> to separate directories. Not all tex - installations can handle filenames with spaces. So it's - better to avoid them. - </para> - </section> - - </section> - - <section id="hyperref"> - <title id="hyperref-title"><filename role="nohyphenation">hyperref</filename></title> - <indexterm> - <primary>hyperref</primary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>hyperref</secondary> - </indexterm> - <para>For more infos read in the book - <emphasis>&latex; Web Companion</emphasis> - or <emphasis>Mit &latex; ins Web</emphasis>. - </para> - - <section id="hyperref-options"> - <title id="hyperref-options-title">Options</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term>4</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>4</tertiary> - </indexterm> - <para> - use Acrobat 4 features (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>a4paper, a5paper, b5paper, legalpaper, letterpaper, - executivepaper - </term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>a4paper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>a5paper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>b5paper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>legalpaper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>letterpaper</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>executivepaper</tertiary> - </indexterm> - <para> - use the specified paper size. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>anchorcolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>anchorcolor</tertiary> - </indexterm> - <para> - set color of anchors (default: <literal>black</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>backref</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>backref</tertiary> - </indexterm> - <para> - do bibliographical back references (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>baseurl</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>baseurl</tertiary> - </indexterm> - <para> - set base URL for document - (default: <literal>empty</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarks</tertiary> - </indexterm> - <para> - make bookmarks (default: <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarksnumbered</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarksnumbered</tertiary> - </indexterm> - <para> - put section numbers in bookmarks (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarksopen</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarksopen</tertiary> - </indexterm> - <para> - open up bookmark tree (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarksopenlevel</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarksopenlevel</tertiary> - </indexterm> - <para> - level to which bookmarks are open - (default: <literal>\maxdimen</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>bookmarkstype</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>bookmarkstype</tertiary> - </indexterm> - <para> - to specify which `toc' file to mimic toc. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>breaklinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>breaklinks</tertiary> - </indexterm> - <para> - allow links to break over lines (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>citebordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>citebordercolor</tertiary> - </indexterm> - <para> - color of border around cites (default: - <literal>0 1 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>citecolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>citecolor</tertiary> - </indexterm> - <para> - color of citation links (default: <literal>green</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>colorlinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>colorlinks</tertiary> - </indexterm> - <para> - color links (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>debug</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>debug</tertiary> - </indexterm> - <para> - provide details of anchors defined - (same as verbose, default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>draft</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>draft</tertiary> - </indexterm> - <para> - do not do any hyper linking (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>dvipdf, dvipdfm, dvips, dvipsone, dviwindo, hypertex</term> - <term>latex2html, pdftex, tex4ht, textures, ps2pdf, vtex</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvipdf</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvipdfm</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvips</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dvipsone</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>dviwindo</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hypertex</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>latex2html</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdftex</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>tex4ht</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>vtex</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>textures</tertiary> - </indexterm> - <para> - use the specified backend. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>extension</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>extension</tertiary> - </indexterm> - <para> - suffix of linked files (default: <literal>dvi</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>filebordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>filebordercolor</tertiary> - </indexterm> - <para> - color of border around file links (default: - <literal>0 .5 .5</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>filecolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>filecolor</tertiary> - </indexterm> - <para> - color of file links (default: <literal>cyan</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>frenchlinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>frenchlinks</tertiary> - </indexterm> - <para> - use small caps instead of color for links (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyperfigures</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hyperfigures</tertiary> - </indexterm> - <para> - make figures hyper links (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hyperindex</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hyperindex</tertiary> - </indexterm> - <para> - set up hyperlinked indices (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hypertexnames</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>hypertexnames</tertiary> - </indexterm> - <para> - use guessable names for links (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>implicit</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>implicit</tertiary> - </indexterm> - <para> - redefine &latex; internals (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linkbordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>linkbordercolor</tertiary> - </indexterm> - <para> - color of border around links (default: - <literal>1 0 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linkcolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>linkcolor</tertiary> - </indexterm> - <para> - color of links (default: <literal>red</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>linktocpage</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>linktocpage</tertiary> - </indexterm> - <para> - make page number, not text, be link on TOC, LOF and LOT - (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>menubordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>menubordercolor</tertiary> - </indexterm> - <para> - color of border around menu links (default: - <literal>1 0 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>menucolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>menucolor</tertiary> - </indexterm> - <para> - color for menu links (default: <literal>red</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>naturalnames</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>naturalnames</tertiary> - </indexterm> - <para> - use &latex;-computed names for links (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>nesting</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>nesting</tertiary> - </indexterm> - <para> - allow nesting of links (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pageanchor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pageanchor</tertiary> - </indexterm> - <para> - put an anchor on every page (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pagebackref</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pagebackref</tertiary> - </indexterm> - <para> - backreference by page number (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pagebordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pagebordercolor</tertiary> - </indexterm> - <para> - color of border around page links (default: - <literal>1 1 0</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pagecolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pagecolor</tertiary> - </indexterm> - <para> - color of page links (default: <literal>red</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfauthor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfauthor</tertiary> - </indexterm> - <para> - text for PDF Author field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfborder</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfborder</tertiary> - </indexterm> - <para> - width of PDF link border - (default: <literal>0 0 1</literal>; - <literal>0 0 0</literal> for <literal>colorlinks</literal>) - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfcenterwindow</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfcenterwindow</tertiary> - </indexterm> - <para> - position the document window center of the screen - (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfcreator</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfcreator</tertiary> - </indexterm> - <para> - text for PDF Creator field - (default: &latex; with hyperref package). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdffitwindow</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdffitwindow</tertiary> - </indexterm> - <para> - resize document window to fit document size (default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfhighlight</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfhighlight</tertiary> - </indexterm> - <para> - set highlighting of PDF links (default: - <literal>/I</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfkeywords</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfkeywords</tertiary> - </indexterm> - <para> - text for PDF Keywords field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfmenubar</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfmenubar</tertiary> - </indexterm> - <para> - make PDF viewer's menu bar visible (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfnewwindow</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfnewwindow</tertiary> - </indexterm> - <para> - make links that open another PDF file start a new window - (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagelayout</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagelayout</tertiary> - </indexterm> - <para> - set layout of PDF pages (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagemode</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagemode</tertiary> - </indexterm> - <para> - set default mode of PDF display (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagescrop</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagescrop</tertiary> - </indexterm> - <para> - set crop size of PDF document (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfpagetransition</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfpagetransition</tertiary> - </indexterm> - <para> - set PDF page transition style (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfproducer</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfproducer</tertiary> - </indexterm> - <para> - text for PDF Producer field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfstartpage</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfstartpage</tertiary> - </indexterm> - <para> - page at which PDF document opens (default: - <literal>1</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfstartview</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfstartview</tertiary> - </indexterm> - <para> - starting view of PDF document (default: - <literal>/Fit</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfsubject</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfsubject</tertiary> - </indexterm> - <para> - text for PDF Subject field (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdftitle</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdftitle</tertiary> - </indexterm> - <para> - text for PDF Title field(default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdftoolbar</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdftoolbar</tertiary> - </indexterm> - <para> - make PDF toolbar visible (default: <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfview</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfview</tertiary> - </indexterm> - <para> - PDF `view' when on link traversal (default: empty). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pdfwindowui</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>pdfwindowui</tertiary> - </indexterm> - <para> - make PDF user interface elements visible (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>plainpages</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>plainpages</tertiary> - </indexterm> - <para> - do page number anchors as plain arabic (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>raiselinks</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>raiselinks</tertiary> - </indexterm> - <para> - raise up links (for HyperTeX backend; default: - <literal>false</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>runbordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>runbordercolor</tertiary> - </indexterm> - <para> - color of border around run links (default: - <literal>0 .7 .7</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>unicode</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>unicode</tertiary> - </indexterm> - <para> - Unicode encoded pdf strings (default: - <literal>true</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>urlbordercolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>urlbordercolor</tertiary> - </indexterm> - <para> - color of border around URL links (default: - <literal>0 1 1</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>urlcolor</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>urlcolor</tertiary> - </indexterm> - <para> - color of URL links (default: <literal>magenta</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>verbose</term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>options</secondary> - <tertiary>verbose</tertiary> - </indexterm> - <para> - be chatty (default: <literal>false</literal>). - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="hyperref-commands"> - <title id="hyperref-commands-title">Commands</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\texorpdfstring{TeX-string}{pdf-string}</literal> - </term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\texorpdfstring</tertiary> - </indexterm> - <para>allows different texts for PDF or &tex; creation. - <programlisting>\section{The role of \texorpdfstring{H$_2$O}{water}}</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry id="href"> - <term><literal>\href{URL}{Text}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\href</tertiary> - </indexterm> - <para>the text will be resolved into a URL. - The URL must be complete, according to a - base-url which might be defined in a - <link linkend="cmd-hyperbaseurl"><literal>\hyperbaseurl</literal></link>. - <programlisting> -\href{http://www.karpfenteich.net/pit/}{Peter's input tips}</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term id="cmd-hyperbaseurl"><literal>\hyperbaseurl{URL}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperbaseurl</tertiary> - </indexterm> - <para>defines a base URL, which is preset to a given URL. - This helps to make portable documents. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\hyperimage{image-URL}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperimage</tertiary> - </indexterm> - <para>includes the picture of the URL reference. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\hyperref{URL}{category}{name}{text}</literal></term> - <term><literal>\hyperref[mark]{text}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperref</tertiary> - </indexterm> - <para><literal>text</literal> is activated as a - hyperlink to the point which is defined with a - <link linkend="cmd-label-title"><filename role="nohyphenation">\label</filename></link> - command with the symbolic name <literal>mark</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\hyperlink{name}{text}</literal></term> - <term><literal>\hyertarget{name}{text}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hyperlink</tertiary> - </indexterm> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\hypertarget</tertiary> - </indexterm> - <para><literal>\hyperlink</literal> creates an internal - link to an object which is somewhere defined with - a <literal>\hypertarget</literal> command. - </para> - <para>For HTML the command <literal>\hyperlink</literal> - inserts a <literal>#</literal> character in - front of each link. Thus it'll refer to the - topical document, - while <literal>\href</literal> will expect a complete URL. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\autoref{marker}</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\autoref</tertiary> - </indexterm> - <para><literal>\autoref</literal> is a substitution - for the standard <literal>\ref</literal> command. - It inserts a context sensitive phrase. - <programlisting>see \autoref{foo}</programlisting> - </para> - <para>for a <literal>\label</literal> in a section - will output <emphasis>see section 3</emphasis> for an example. - </para> - <para>There are macros to change the default output - with the help of the <literal>\renewcommand</literal>: - <programlisting> -\figurename *\figurename* -\tablename *\tablename* -\partname *\partname* -\appendixname *\appendixname* -\equationname *\equationname* -\Itemname *\Itemname* -\chaptername *\chaptername* -\sectionname *\sectionname* -\subsectionname *\subsesctionname* -\subsubsectionname *\subsubsectionname* -\paragraphname *\paragraphname* -\Hfootnotename *\Hfootnotename* -\AMSname *\AMSname* -\theoremname *\theoremname*</programlisting> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term id="cmd-nolinkurl"><literal>\nolinkurl</literal></term> - <listitem> - <indexterm> - <primary>hyperref</primary> - <secondary>commands</secondary> - <tertiary>\nolinkurl</tertiary> - </indexterm> - <para>Allows line breaks in a verbatim like - environment like <literal>\url</literal>, but - without the hyperlink function. This is - useful to define own commands like this example: - <programlisting> -\newcommand*{\urlw}[1]{\href{http://www.#1}% - {\nolinkurl{www.#1}}}</programlisting> - </para> - <para>This new defined command <literal>\urlw</literal> - allows the user to typeset a linkable (this - function is offered by - <literal>\href</literal>) - <literal>www.example.org</literal> address in the - latex source like this: - <programlisting> -\urlw{example.org}</programlisting> - </para> - <para>This will produce the string - <literal>www.example.org</literal> which - is hyperlinked and breakable (when the driver like - &pdftex; allows line breaks in links). - </para> - </listitem> - </varlistentry> - </variablelist> - - </section> - </section> - - <section id="inputenc"> - <title id="inputenc-title"><filename role="nohyphenation">inputenc</filename></title> - <indexterm><primary>inputenc</primary></indexterm> - - <para><literal>\usepackage[encoding name]{inputenc}</literal> - </para> - <para>Allows to specify an input encoding for direct input of - character codes > 127, e.g. accented characters. - </para> - <para>Important encodings are: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>latin9, latin1</literal></term> - <listitem> - <simpara>Linux, Unix, VMS</simpara> - <indexterm><primary>latin1</primary></indexterm> - <indexterm><primary>latin9</primary></indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>ansinew</literal></term> - <listitem> - <simpara>Windows (codepage 1252)</simpara> - <indexterm><primary>ansinew</primary></indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>cp850</literal></term> - <listitem> - <simpara>OS/2, MSDOS (codpage 850)</simpara> - <indexterm><primary>cp850</primary></indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>applemac</literal></term> - <listitem> - <simpara>Apple Macintosh</simpara> - <indexterm><primary>applemac</primary></indexterm> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="komascript"> - <title id="komascript-title"><filename role="nohyphenation">&komascript;</filename></title> - <indexterm><primary>&komascript;</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>&komascript;</secondary> - </indexterm> - <para>The <literal>&komascript;</literal> package has a - very detailed and well written documentation. - Read the <literal>scrguide</literal> for further information! :-) - </para> - - <!-- --> - <section id="komascript-page-layout"> - <title id="komascript-page-layout-title">Page-Layout</title> - <para><literal>\typearea[BCOR]{DIV}</literal></para> - <indexterm> - <primary>\typearea</primary> - </indexterm> - <para><literal>\areaset[BCOR]{Breite}{Höhe}</literal></para> - <indexterm> - <primary>\areaset</primary> - </indexterm> - </section> - - <section id="komascript-options"> - <title id="komascript-options-title">Options</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term>headinclude, headexclude</term> - <term>footinclude, footexclude</term> - <listitem> - <indexterm> - <primary>headinclude</primary> - </indexterm> - <indexterm> - <primary>headexclude</primary> - </indexterm> - <indexterm> - <primary>footinclude</primary> - </indexterm> - <indexterm> - <primary>footexclude</primary> - </indexterm> - <para>will determine if headers and footers are used in the - calculation of the page size. Default is exclude. - Include will make the text area smaller. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>DIV</term> - <listitem> - <indexterm> - <primary>DIV</primary> - </indexterm> - <para>is a factor which determins how large the used page - size is. This method takes care of good - typography. - </para> - <para>Try values between 10 and 15. Higher values - will cause smaller margins. An example would be: - <literal>DIV12</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>BCOR</term> - <listitem> - <indexterm> - <primary>BCOR</primary> - </indexterm> - <para>Binding correction. Takes care of the loss of the - visible paper size when the paper is cut and a book is - bound. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="komascript-scrlttr2"> - <title id="komascript-scrlttr2-title">Letter Class <literal>scrlttr2</literal></title> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - </indexterm> - - <para>This reference is based on the excellent - <literal>scrguien.pdf</literal> from 2002-09-06. - </para> - - <bridgehead renderas="sect5">Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>options</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Defining Options Later</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\KOMAoptions{}</tertiary> - </indexterm> - <para> - <variablelist> - <varlistentry> - <term><literal>\KOMAoptions{options list}</literal></term> - <listitem> - <simpara>Use this to change options after loading the - class. List single or multiple options, - separated by commas. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Page Layout Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>page layout</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>paper=format</literal></term> - <listitem> - <simpara>Defines the paper format.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>BCOR=length</literal></term> - <term><literal>DIV=value</literal></term> - <term><literal>headlines=count</literal></term> - <listitem> - <simpara>Divisor, binding correction, and number - of headlines.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>enlargefirstpage</literal></term> - <listitem> - <simpara>If <emphasis>true</emphasis> some more - text would fit on the first page - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Other Layout Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>other layout</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>other layout</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>twoside</literal></term> - <listitem> - <simpara>Activate possibilities of a double-sided - document, but stay with with the one-sided - layout as far as possible.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>cleardoublepage=style</literal></term> - <listitem> - <simpara>Inserted pages by - <literal>\cleardoublepage</literal> get one of - these page styles: - </simpara> - <para> - <itemizedlist> - <listitem> - <simpara><literal>empty</literal></simpara> - </listitem> - <listitem> - <simpara><literal>plain</literal></simpara> - </listitem> - <listitem> - <simpara><literal>standard</literal></simpara> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headsepline</literal></term> - <term><literal>footsepline</literal></term> - <listitem> - <simpara>Insert a separator line below the head or - above the foot.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>mpinclude</literal></term> - <term><literal>mpexclude</literal></term> - <listitem> - <simpara>These two options of the - <literal>typearea</literal> package should not - be used with <literal>scrlttr2</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagenumber=position</literal></term> - <listitem> - <simpara>This option defines if and where a page - number will be placed. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>bot</literal></term> - <term><literal>foot</literal></term> - <listitem> - <simpara>Page number in foot, horizontal - position not changed</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>botcenter</literal></term> - <term><literal>botcentered</literal></term> - <term><literal>botmiddle</literal></term> - <term><literal>footcenter</literal></term> - <term><literal>footcentered</literal></term> - <term><literal>footmiddle</literal></term> - <listitem> - <simpara>Page number infoot,centered</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>botleft</literal></term> - <term><literal>footleft</literal></term> - <listitem> - <simpara>Page number in foot, left - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>botrigth</literal></term> - <term><literal>footright</literal></term> - <listitem> - <simpara>Page number in foot, right - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>center</literal></term> - <term><literal>centered</literal></term> - <term><literal>middle</literal></term> - <listitem> - <simpara>Page number centered - horizontally, vertical position not - changed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>no</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>No page number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>head</literal></term> - <term><literal>top</literal></term> - <listitem> - <simpara>Page number in head, horizontal - position not changed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headcenter</literal></term> - <term><literal>headcentered</literal></term> - <term><literal>headmiddle</literal></term> - <term><literal>topcenter</literal></term> - <term><literal>topcentered</literal></term> - <term><literal>topmiddle</literal></term> - <listitem> - <simpara>Page number in head, centered</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headleft</literal></term> - <term><literal>topleft</literal></term> - <listitem> - <simpara>Page number in head, left - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headright</literal></term> - <term><literal>topright</literal></term> - <listitem> - <simpara>Page number in head, right - justified - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>left</literal></term> - <listitem> - <simpara>Page number left, vertical - position not changed</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>right</literal></term> - <listitem> - <simpara>Page number right, vertical - position not changed - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>botcenter</literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>parskip=value</literal></term> - <listitem> - <simpara>Mark paragraphs alternatively by vertical - skip. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>Paragraph indentation instead of - verticalk space</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full</literal></term> - <term><literal>on</literal></term> - <term><literal>true</literal></term> - <listitem> - <simpara>One line vertical space between - paragraphs; at least 1 em free space in - the last line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full*</literal></term> - <listitem> - <simpara>One line vertical space betwen - paragraphs; at least a quarter of a line - free space at the end of a paragraph. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full+</literal></term> - <listitem> - <simpara>One line vertical space betwen - paragraphs; at least a third of aline free - space at the end of a paragraph.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>full-</literal></term> - <listitem> - <simpara>One line vertical space betwen - paragraphs; last line of a paragraph may - be arbitrarily filled.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half</literal></term> - <listitem> - <simpara>Half a line vertical space - between paragraphs; at least 1 em free - space in the last line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half*</literal></term> - <listitem> - <simpara>Half a line vertical space - between paragraphs; at least a quarter of - a line free space at the end of a - paragraph. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half+</literal></term> - <listitem> - <simpara>Half a line vertical space - between paragraphs; at least a third of - a line free space at the end of a - paragraph. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>half-</literal></term> - <listitem> - <simpara>One line vertical space between - paragraphs; last line may be arbitrarily - filled.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>false</literal>.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Font Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>font options</tertiary> - </indexterm> - <para> - <variablelist> - <varlistentry> - <term><literal>fontsize=size</literal></term> - <listitem> - <simpara>Font size of the document. Defaults - to <literal>12pt</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Options for Letterhead and Address</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>options for letterhead and address</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>fromalign</literal></term> - <listitem> - <simpara>Defines the placement of the from address - in the letterhead. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>center</literal></term> - <term><literal>centered</literal></term> - <term><literal>middle</literal></term> - <listitem> - <simpara>Return address centered.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>no</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>Standard design for return - address. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>left</literal></term> - <listitem> - <simpara>Left justified return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>rigth</literal></term> - <listitem> - <simpara>Right justified return address. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>left</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromrule</literal></term> - <listitem> - <simpara>Allows to place a horizontal rule within - return address. Possible values are: - </simpara> - <para><variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>afteraddress</literal></term> - <term><literal>below</literal></term> - <term><literal>true</literal></term> - <term><literal>yes</literal></term> - <listitem> - <simpara>Line below return address</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>aftername</literal></term> - <listitem> - <simpara>Line right below sender's name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>false</literal></term> - <term><literal>no</literal></term> - <term><literal>off</literal></term> - <listitem> - <simpara>No line.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>false</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromphone</literal></term> - <listitem> - <simpara>Defines whether the phone number will be - part of the return address. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromfax</literal></term> - <listitem> - <simpara>Defines whether the facsimile number will - be part of the return address. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromemail</literal></term> - <listitem> - <simpara>Defines whether the email address will - be part of the return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromurl</literal></term> - <listitem> - <simpara>Defines whether the URL will - be part of the return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromlogo</literal></term> - <listitem> - <simpara>Defines whether the logo will - be part of the return address.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>addrfield</literal></term> - <listitem> - <simpara>Defines whether a return address field - will be set. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>backaddress</literal></term> - <listitem> - <simpara>Defines whether a return address for - window envelopes will be set. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <listitem> - <simpara>Choose of your subject should have a - title and if the subject should be set before or - after the opening. Possible values are: - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>afteropening</literal></term> - <listitem> - <simpara>Set subject after opening.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>beforeopening</literal></term> - <listitem> - <simpara>Set subject before opening.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>titled</literal></term> - <listitem> - <simpara>Add title to subject.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>untitled</literal></term> - <listitem> - <simpara>Do not add title to subject.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Defaults are - <literal>beforeopening</literal> and - <literal>untitled</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>locfield</literal></term> - <listitem> - <simpara>Toggle between presets for the field - width of additionbal sender attributes. - </simpara> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>narrow</literal></term> - <listitem> - <simpara>Small sender supplement field. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>wide</literal></term> - <listitem> - <simpara>Wide sender supplement field. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <simpara>Default is <literal>narrow</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>foldmarks</literal></term> - <listitem> - <simpara>Activates fold marks.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>numericaldate</literal></term> - <listitem> - <simpara>Toggles between standard, - language-dependent date presentation and a - short, numerical one.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>refline</literal></term> - <listitem> - <simpara>Defines that the reference line may - extend beyond the normal type area. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Format Options</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>format options</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>draft</literal></term> - <listitem> - <simpara>Toggles between the final and the draft - version. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Letter Class Option Files</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>letter class option files</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\LoadLetterOption{name}</literal></term> - <listitem> - <simpara>Load a <literal>lco</literal> - file. <literal>name</literal> is the filename - without suffix. - </simpara> - <para> - Predefined <literal>lco</literal> files: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>DIN</literal></term> - <listitem> - <simpara>For A4 size paper, complying with - DIN 676. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>DINmtext</literal></term> - <listitem> - <simpara>For A4 size paper, complying with - DIN 676, but using an alternate layout - with more text on the first page. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>KOMAold</literal></term> - <listitem> - <simpara>Fo AQ4 paper size using a layout - close to the obsolete - <literal>scrlettr</literal> class. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>SN</literal></term> - <listitem> - <simpara>For Swiss letters with address - field on the right side, according to - SN 010 130 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>SNleft</literal></term> - <listitem> - <simpara>For Swiss letters with address - field on the left side. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\LetterOptionNeedsPaperSize{option - name}{paper size}</literal></term> - <listitem> - <simpara>Useful to be abel to emit warnings if the - user selects a different paper size from the one - the <literal>lco</literal> file is based on. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <!-- FIXME: bridgehead --> - <bridgehead renderas="sect5">General Document Properties</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>general document properties</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Font Selection</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>font selection</tertiary> - </indexterm> - <para>See also the section for - <emphasis>Changing Fonts</emphasis> in &komascript; - (still to be written). - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>backaddress</literal></term> - <listitem> - <simpara>Back address for a window envelope</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>descriptionlabel</literal></term> - <listitem> - <simpara>Label in a - <literal>description</literal> environment - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromaddress</literal></term> - <listitem> - <simpara>Sender's address in letterhead</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromname</literal></term> - <listitem> - <simpara>Sender's address in letterhead - if different from <literal>fromaddress</literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagefoot</literal></term> - <listitem> - <simpara>Footer, sometimes header of a page</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagehead</literal></term> - <listitem> - <simpara>Header, sometimes footer of a page</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>pagenumber</literal></term> - <listitem> - <simpara>Page number in footer or header</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <listitem> - <simpara>Subject in the opening</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>title</literal></term> - <listitem> - <simpara>Headline in the opening</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Page Style</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>page style</tertiary> - </indexterm> - <para>See also the section for - <emphasis>Page Style</emphasis> in &komascript; - (still to be written). - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>empty</literal></term> - <listitem> - <simpara>Entirely empty headers and footers</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>plain</literal></term> - <listitem> - <simpara>Empty head and and only page number - in header or footer - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>headings</literal></term> - <listitem> - <simpara>Automatic page headings</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>myheadings</literal></term> - <listitem> - <simpara>Manual page headings - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Variables</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>variables</tertiary> - </indexterm> - <para>The main difference between a - <emphasis>command</emphasis> and a - <emphasis>variable</emphasis> is that a - command usually triggers an action whereas a variable - only consists of plain text. Furthermore a variable - can have an additional description. - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\newkomavar[description]{name}</literal></term> - <term><literal>\newkomavar*[description]{name}</literal></term> - <term><literal>\addtoreffields{name}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\newkomavar</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\addtoreffields</tertiary> - </indexterm> - <simpara><literal>\newkomavar</literal> defines - a new variable, addressed with - <literal>name</literal>. - </simpara> - <simpara>The command - <literal>\addtoreffields</literal> adds the - variable <literal>name</literal> to the - reference fields. See section - <link linkend="scrlttr-business-line">Business Line</link>. - </simpara> - <simpara>The command <literal>\newkomavar*</literal> - works like <literal>\newkomavar</literal> with an - additional call of the command - <literal>\addtoreffields</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - Overview of all variables: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>backaddress</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>backaddress</tertiary> - </indexterm> - <simpara>Back address for window envelopes</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>backaddressseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>backaddressseparator</tertiary> - </indexterm> - <simpara>Separator within the back address</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>ccseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>ccseparator</tertiary> - </indexterm> - <simpara>Separator between title of additional - recipients and additional recipients - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>customer</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>customer</tertiary> - </indexterm> - <simpara>Customer number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>date</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>date</tertiary> - </indexterm> - <simpara>Date</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>emailseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>emailseparator</tertiary> - </indexterm> - <simpara>Separator between e-mail name and e-mail - address - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>enclseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>enclseparator</tertiary> - </indexterm> - <simpara>Separator between title of enclosure and - and enclosures</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>faxseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>faxseparator</tertiary> - </indexterm> - <simpara>Separator between title of fax and fax - number - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromaddress</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromaddress</tertiary> - </indexterm> - <simpara>Sender's address without its name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>frombank</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>frombank</tertiary> - </indexterm> - <simpara>Sender's bank account</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromemail</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromemail</tertiary> - </indexterm> - <simpara>Sender's e-mail</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromfax</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromfax</tertiary> - </indexterm> - <simpara>Sender's fax number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromlogo</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromlogo</tertiary> - </indexterm> - <simpara>Commands for inserting the sender's logo - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromname</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromname</tertiary> - </indexterm> - <simpara>Complete name of the sender</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromphone</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromphone</tertiary> - </indexterm> - <simpara>Sender's telephone number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromurl</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>fromurl</tertiary> - </indexterm> - <simpara>URL of the sender</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>invoice</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>invoice</tertiary> - </indexterm> - <simpara>Invoice number</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>location</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>location</tertiary> - </indexterm> - <simpara>More details of the sender</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>myref</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>myref</tertiary> - </indexterm> - <simpara>Sender's reference</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>place</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>place</tertiary> - </indexterm> - <simpara>Place</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>placeseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>placeseparator</tertiary> - </indexterm> - <simpara>Separator between place and date</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>phoneseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>phoneseparator</tertiary> - </indexterm> - <simpara>Separator between title of telephone and - telephone number - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>signature</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>signature</tertiary> - </indexterm> - <simpara>Signature beneath the ending of the - letter - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>specialmail</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>specialmail</tertiary> - </indexterm> - <simpara>Special mail</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>subject</tertiary> - </indexterm> - <simpara>Subject</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subjectseparator</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>subjectseparator</tertiary> - </indexterm> - <simpara>Separator between title of subject and - subject - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>title</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>title</tertiary> - </indexterm> - <simpara>Letter title</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toname</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>toname</tertiary> - </indexterm> - <simpara>Complete name of recipient</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toaddress</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>toaddress</tertiary> - </indexterm> - <simpara>Address of recipient without its name</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>yourmail</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>yourmail</tertiary> - </indexterm> - <simpara>Date of recipient's mail</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>yourref</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>yourref</tertiary> - </indexterm> - <simpara>Recipient's reference</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\setkomavar{name}[description]{content}</literal></term> - <term><literal>\setkomavar*{name}{description}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\setkomavar</tertiary> - </indexterm> - - <simpara><literal>\setkomavar</literal> sets the - content of the variable <literal>name</literal>. - The optional argument sets the - <literal>description</literal> of the variable. - </simpara> - <simpara><literal>\setkomavar*</literal> - only sets the <literal>description</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\usekomavar[command]{name}</literal></term> - <term><literal>\usekomavar*[command]{name}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\usekomavar</tertiary> - </indexterm> - <simpara><literal>\usekomavar</literal> gives you - access to the content of the variable - <literal>name</literal>. - </simpara> - <simpara><literal>\usekomavar*</literal> gives you - access to the <literal>description</literal> - of the variable <literal>name</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\ifkomavarempty{name}{true}{false}</literal></term> - <term><literal>\ifkomavarempty*{name}{true}{false}</literal></term> - <listitem> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>\ifkomavarempty</tertiary> - </indexterm> - <simpara>The <literal>true</literal> argument will - be executed if the content or description is - empty. Otherwise the <literal>false</literal> - argument will be executed. - </simpara> - <simpara>The starred version handles the - description of a variable, the variant without - star the content. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Pseudo Lengths</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>pseudo lengths</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\@newplength{name}</literal></term> - <listitem> - <simpara>Defines a new pseudo length</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\useplength{name}</literal></term> - <listitem> - <simpara>Access value of pseudo length - <literal>name</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\setlengthtoplength[factor]{length}{pseudo - length}</literal> - </term> - <term><literal>\addtolengthplength[factor]{length}{pseudo - length}</literal> - </term> - <listitem> - <simpara>Assign a multiple of - <literal>pseudo length</literal> to a real - <literal>length</literal>. Adds a multiple of - <literal>pseudo length</literal> to - <literal>length</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\@setplength[factor]{pseudo - length}{value}</literal> - </term> - <term> - <literal>\@addtoplength[factor]{pseudo - length}{value} - </literal></term> - <listitem> - <simpara>Assign a multiple of a - <literal>value</literal> to a - <literal>pseudo length</literal>. - Adds <literal>value</literal> to - <literal>pseudo length</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <!-- - <bridgehead renderas="sect5">General Structure of a Letter Document</bridgehead> - <para>&tbd;</para> - --> - - <bridgehead renderas="sect5">Letter Declaration</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>letter declaration</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Letterhead</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>letterhead</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>firstheadvpos</literal></term> - <listitem> - <simpara>Distance between the top of the sheet and - the letterhead. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>firstheadwidth</literal></term> - <listitem> - <simpara>Width of the letterhead.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>fromname</literal></term> - <term><literal>fromaddress</literal></term> - <term><literal>fromphone</literal></term> - <term><literal>fromfax</literal></term> - <term><literal>fromemail</literal></term> - <term><literal>fromurl</literal></term> - <term><literal>fromlogo</literal></term> - <listitem> - <simpara>This variables give all statements - concerning the sender necessary to create the - letterhead. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>phoneseparator</literal></term> - <term><literal>faxseparator</literal></term> - <term><literal>emailseparator</literal></term> - <term><literal>urlseparator</literal></term> - <listitem> - <simpara>Separators for variables in letterhead. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\firsthead{construction}</literal></term> - <listitem> - <simpara>Create letterhead freely.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Footer</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>footer</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>firstfootvpos</literal></term> - <listitem> - <simpara>Distance between footer and upper border - of the sheet.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>firstfootwidth</literal></term> - <listitem> - <simpara>Width of letter's firstpage footer.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\firstfoot{Construction}</literal></term> - <listitem> - <simpara>Set definition for first page's footer</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Address</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>address</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>toaddrvpos</literal></term> - <term><literal>toaddrhpos</literal></term> - <listitem> - <simpara>Distance between address window of a - window envelope and the upper and left border of - the sheet. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toaddrwidth</literal></term> - <listitem> - <simpara>Width of the address window.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toaddrindent</literal></term> - <listitem> - <simpara>Value of indentation for the address from - the left border. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>backaddress</literal></term> - <term><literal>backaddressseparator</literal></term> - <term><literal>backaddrheight</literal></term> - <listitem> - <simpara>Double backslashes within return address - will be exchanged with - <literal>backaddressseparator</literal>. - Height of the return address field. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>specialmail</literal></term> - <term><literal>specialmailindent</literal></term> - <term><literal>specialmailrightindent</literal></term> - <listitem> - <simpara>Optionally set between return address and - addressee. <literal>specialmailindent</literal> - and <literal>specialmailrightindent</literal> - determine left and right indentation. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>toname</literal></term> - <term><literal>toaddress</literal></term> - <listitem> - <simpara>Usually not set directly by the user. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\begin{letter}[options]{address}</literal></term> - <listitem> - <simpara>Major point of the letter class. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\AtBeginLetter{command}</literal></term> - <listitem> - <simpara>Hook for commands run at begin of a - letter. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Sender's Extension</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>sender's extension</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>locwidth</literal></term> - <listitem> - <simpara>Declares width of sender's extensions.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>location</literal></term> - <listitem> - <simpara>Content of sender's extension.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead id ="scrlttr-business-line" renderas="sect5">Business Line</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>business line</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>refvpos</literal></term> - <listitem> - <simpara>Distance between upper border of sheet - and business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>refwidth</literal></term> - <listitem> - <simpara>Available width for the business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>refaftervskip</literal></term> - <listitem> - <simpara>Vertical space to be inserted beneath - business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>place</literal></term> - <term><literal>placeseparator</literal></term> - <listitem> - <simpara>If all variables for business line - are empty, the content of - <literal>place</literal> and - <literal>placeseparator</literal> will be set, - followed by content of <literal>date</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>yourref</literal></term> - <term><literal>yourmail</literal></term> - <term><literal>myref</literal></term> - <term><literal>customer</literal></term> - <term><literal>invoice</literal></term> - <term><literal>date</literal></term> - <listitem> - <simpara>Typical fields for business lines. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Title and Subject Line</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>title line</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>subject line</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>title</literal></term> - <listitem> - <simpara>Additional tile. Set centered beneath the - business line.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>subject</literal></term> - <term><literal>subjectseparator</literal></term> - <listitem> - <simpara>Set the subject of the letter, optional - prefixed by a label.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Further Issues</bridgehead> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>tfoldmarkvpos</literal></term> - <term><literal>bfoldmarkvpos</literal></term> - <listitem> - <simpara>Position of upper and lower fold mark.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>foldmarkhpos</literal></term> - <listitem> - <simpara>Distance between fold marks and the - sheet's left border.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>frombank</literal></term> - <listitem> - <simpara>Internally not used yet.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\nexthead{construction}</literal></term> - <term><literal>\nextfoot{construction}</literal></term> - <listitem> - <simpara>Create letter head or foot for the - following pages freely.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">The Text</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>text</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Opening</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>Opening</tertiary> - </indexterm> - <para> - <variablelist> - <varlistentry> - <term><literal>\opening{opening}</literal></term> - <listitem> - <simpara>Set the opening of the letter.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Footnotes</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>footnotes</tertiary> - </indexterm> - - <para>See section <emphasis>Footnotes</emphasis> in - &komascript; (still to be written).</para> - - <bridgehead renderas="sect5">Lists</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>lists</tertiary> - </indexterm> - <para>See section <emphasis>Lists</emphasis> in - &komascript; (still to be written).</para> - - <bridgehead renderas="sect5">Margin Notes</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>margin notes</tertiary> - </indexterm> - <para>See section <emphasis>Margin Notes</emphasis> in - &komascript; (still to be written).</para> - - <bridgehead renderas="sect5">Text Emphasis</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>text emphasis</tertiary> - </indexterm> - <para>See section <emphasis>Logical Markup of Text</emphasis> - in &komascript; (still to be written). - </para> - - <bridgehead renderas="sect5">Closing Part</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>Closing Part</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Closing</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>Closing</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>signature</literal></term> - <listitem> - <simpara>Inlcudes an explanation for the - inscription. Defaults to - <literal>\usekomavar{fromname}</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\closing{closing phrase}</literal></term> - <listitem> - <simpara>Typesets the colsing phrase follwoed by a - vertical space and the contents fo variable - <literal>signature</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>sigindent</literal></term> - <term><literal>sigbeforevskip</literal></term> - <term><literal>\raggedsignature</literal></term> - <listitem> - <simpara>Indentation of the box for closing - phrase, inscription and signature (defaults to 0mm). - Vertical space between closing phrase - and signature (defaults to two lines). - Alignment inside the box.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Postscript, Carbon Copy, and Enclosures</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>postscript</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>carbon copy</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>enclosure</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\ps</literal></term> - <listitem> - <simpara>Set a postscript.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\cc{distribution list}</literal></term> - <term><literal>ccseparator</literal></term> - <listitem> - <simpara>Set a ddistribution list. If the contents - of <literal>ccseparator</literal> isn't empty then - the name and the content of the variable is - inserted prior to distribution list.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\encl{enclosures}</literal></term> - <term><literal>enclseparator</literal></term> - <listitem> - <simpara>Same structur as the distribution list. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Language Support</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>language support</tertiary> - </indexterm> - - <bridgehead renderas="sect5">Language Selection</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>language selection</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\captionenglish</literal></term> - <term><literal>\captionUSenglish</literal></term> - <term><literal>\captionamerican</literal></term> - <term><literal>\captionbritish</literal></term> - <term><literal>\captionUKenglish</literal></term> - <?db2latex \newline?> - <term><literal>\captiongerman</literal></term> - <term><literal>\captionngerman</literal></term> - <term><literal>\captionaustrian</literal></term> - <term><literal>\captionfrench</literal></term> - <term><literal>\captionitalian</literal></term> - <?db2latex \newline?> - <term><literal>\captionspanish</literal></term> - <term><literal>\captiondutch</literal></term> - <term><literal>\captioncroatian</literal></term> - <listitem> - <simpara>If the used language selection scheme - does not support switching the language the above - commands can be used directly.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\dateenglish</literal></term> - <term><literal>\dateUSenglish</literal></term> - <term><literal>\dateamerican</literal></term> - <term><literal>\datebritish</literal></term> - <term><literal>\dateUKenglish</literal></term> - <term><literal>\dategerman</literal></term> - <term><literal>\datengerman</literal></term> - <term><literal>\dateaustrian</literal></term> - <term><literal>\datefrench</literal></term> - <term><literal>\dateitalian</literal></term> - <term><literal>\datespanish</literal></term> - <term><literal>\datedutch</literal></term> - <term><literal>\datecrotian</literal></term> - <listitem> - <simpara>Numerical date representation.</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Language-Dependent Terms</bridgehead> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\yourrefname</literal></term> - <term><literal>\youremailname</literal></term> - <term><literal>\myrefname</literal></term> - <term><literal>\customername</literal></term> - <term><literal>\invoicename</literal></term> - <term><literal>\subjectname</literal></term> - <term><literal>\ccname</literal></term> - <term><literal>\enclname</literal></term> - <term><literal>\headtoname</literal></term> - <term><literal>\headfromname</literal></term> - <term><literal>\datename</literal></term> - <term><literal>\pagename</literal></term> - <term><literal>\phonename</literal></term> - <term><literal>\faxname</literal></term> - <term><literal>\emailname</literal></term> - <term><literal>\wwwname</literal></term> - <term><literal>\bankname</literal></term> - <listitem> - <simpara>These defintions can be modified to - support a new language of for private - customization. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Defining Language Terms</bridgehead> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\providecaptioname{language}{term}{definition}</literal></term> - <term><literal>\newcaptioname{language}{term}{defintion}</literal></term> - <term><literal>\renewcaptionname{language}{term}{definition}</literal></term> - <listitem> - <simpara>Assign a <emphasis>definition</emphasis> - for a <emphasis>language</emphasis> to a - <emphasis>term</emphasis>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <bridgehead renderas="sect5">Address Files and Circular Letters</bridgehead> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>address files</tertiary> - </indexterm> - <indexterm> - <primary>&komascript;</primary> - <secondary>scrlttr2</secondary> - <tertiary>circular letters</tertiary> - </indexterm> - <para> - <variablelist role="db2latex:nonoindent;db2latex:compact"> - <varlistentry> - <term><literal>\adrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{Comment}{Key}</literal></term> - <listitem> - <simpara>Address entry for address files. The file - extension has to be <literal>.adr</literal>!</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\addrentry{Lastname}{Firstname}{Address}{Telephone}{F1}{F2}{F3}{F4}{Key}</literal></term> - <listitem> - <simpara>This command supports four freely definable - parameters for an address entry.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\adrchar{initial letter}</literal></term> - <term><literal>\addrchar{initial letter}</literal></term> - <listitem> - <simpara>Separator for address entries. Ignored by - <literal>scrlttr2</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - </section> - - <section id="komascript-scraddr"> - <title id="komascript-scraddr-title">Address Files with <literal>scraddr</literal></title> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - </indexterm> - - <para> - <variablelist role="db2latex:multiterm"> - <varlistentry> - <term><literal>\InputAddressFile{file name}</literal></term> - <listitem> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\InputAddressFile</tertiary> - </indexterm> - <simpara>Read the contents of the given address file. - Filename extension has to be <literal>.adr</literal> - and has to be omitted in the argument. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\Name{Key}</literal></term> - <term><literal>\FirstName{Key}</literal></term> - <term><literal>\LastName{Key}</literal></term> - <term><literal>\Address{Key}</literal></term> - <term><literal>\Telephone{Key}</literal></term> - <term><literal>\FreeI{Key}</literal></term> - <term><literal>\FreeII{Key}</literal></term> - <term><literal>\Comment{Key}</literal></term> - <term><literal>\FreeIII{Key}</literal></term> - <term><literal>\FreeIV{Key}</literal></term> - <listitem> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Name{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FirstName{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\LastName{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Address{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Telephone{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeI{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeII{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\Comment{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeIII{}</tertiary> - </indexterm> - <indexterm> - <primary>KOMA-Script</primary> - <secondary>scraddr</secondary> - <tertiary>\FreeIV{}</tertiary> - </indexterm> - <simpara>Access to the data in address file. - <literal>\Name</literal> is a concatenation of - <literal>\FirstName</literal> and <literal>\LastName</literal>. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>AdrFreeIVempty</literal></term> - <term><literal>AdrFreeIVshow</literal></term> - <term><literal>AdrFreeIVwarn</literal></term> - <term><literal>AdrFreeIVstop</literal></term> - <listitem> - <simpara>Package warning options. Defaults to - <literal>AdrFreeIVshow</literal>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - </section> - - <section id="mathpazo"> - <title id="mathpazo-title"><filename role="nohyphenation">mathpazo</filename></title> - <indexterm><primary>mathpazo</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>mathpazo</secondary> - </indexterm> - <para>Math fonts for the use with the Palatino font.</para> - - <section id="upDelta-upOmega"> - <title id="upDelta-upOmega-title">\upDelta / \upOmega</title> - <indexterm><primary>\upDelta</primary></indexterm> - <indexterm><primary>\upOmega</primary></indexterm> - - <para>Math fonts for the use with the Palatino font.</para> - - <para>Package options are: - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>[slantedGreek]</literal></term> - <listitem> - <para>Uppercase Greek will be typeset slanted.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>[noBBpl]</literal></term> - <listitem> - <para>Do not use PazoMathBlackboardBold as - (partial) blackboard bold - font (e.g with <literal>\mathbb{R}</literal>). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>[osf]</literal></term> - <listitem> - <para>Make the font family <literal>pplj</literal> - (Palatino with old style numerals) the default - roman font, and use an - alternative version of the virtual math italic fonts - (<literal>zplmrj7m</literal> and - <literal>zplmbj7m</literal>) with upright Palatino old - style numerals for use with the - <literal>\oldstylenums</literal> command. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>[osfeqnnum]</literal></term> - <listitem> - <para>Use old style numerals for equation numbering.</para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - </section> - - <section id="varioref"> - <title id="varioref-title"><filename role="nohyphenation">varioref</filename></title> - <indexterm><primary>varioref</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>varioref</secondary> - </indexterm> - <para>Smarter version of the original latex2e - <link linkend="cross-references">cross reference commands</link>. - Generated strings are customizable, Babel options are recognized - (further info in the package documentation). - </para> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term id="cmd-vref"><literal>\vref</literal></term> - <term id="cmd-vpageref"><literal>\vpageref</literal></term> - <listitem> - <indexterm> - <primary>\vref</primary> - </indexterm> - <indexterm> - <primary>\vpageref</primary> - </indexterm> - <para><literal>\vref</literal> is similar to - <literal>\ref</literal> but adds an additional page - reference, like <emphasis>on the facing page</emphasis> - or - <emphasis>on page 27</emphasis> whenever the corresponding - <link linkend="cmd-label-title"><filename role="nohyphenation">\label</filename></link> - is not on the same page. - </para> - <para><literal>\vpageref</literal> is a variation - of <literal>\pageref</literal> with similar - functionality. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\vrefrange</literal></term> - <term><literal>\vpagerefrange</literal></term> - <listitem> - <indexterm> - <primary>\vrefrange</primary> - </indexterm> - <indexterm> - <primary>\vpagerefrange</primary> - </indexterm> - <para>The <literal>\v...range</literal> commands - take two labels as arguments and - produce strings which depend on wether or not these labels - fall onto a single page or on different pages. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\vref*</literal></term> - <term><literal>\vpageref*</literal></term> - <term><literal>\vpagerefrange*</literal></term> - <listitem> - <para>Star * variants do not add any space before - the generated text for situations like: - <programlisting> -(\vref{foo} ...)</programlisting> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="small-packages"> - <title id="small-packages-title">Several Small Packages</title> - <indexterm><primary>Several Small Packages</primary></indexterm> - <indexterm><primary>Small Packages</primary></indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>Several Small Packages</secondary> - </indexterm> - <para>Must be loaded with the usual - <link linkend="usepackage-linkend"><literal>\usepackage</literal></link> - command. Further info for a package to be found in the - documentation (dvi, pdf, ps) or in the - <literal>sty</literal>-file itself. - </para> - - <section id="bm-package"> - <title id="bm-package-title"><filename role="nohyphenation">bm</filename></title> - <indexterm> - <primary>bm</primary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>bm</secondary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>bm.sty</secondary> - </indexterm> - <para>Bold math symbols or equations with better spacing - then the <literal>\boldsymbold</literal> command. - <indexterm> - <primary>\boldsymbold</primary> - </indexterm> - If possible load after other packages - which redefine the fonts. When no bold font - is available for a certain char <literal>bm</literal> - will use <emphasis>poor man's bold</emphasis> - <link linkend="pmb-linkend"><literal>\pmb</literal></link>. - </para> - - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term id="cmd-bm"><literal>\bm</literal></term> - <listitem> - <indexterm> - <primary>\bm</primary> - </indexterm> - <para>Produces bold math symbol or equation.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>\unboldmath</literal></term> - <listitem> - <indexterm> - <primary>\unboldmath</primary> - </indexterm> - <para>Can be used to set parts of an equation unbold.</para> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - - <section id="url-package"> - <title id="url-package-title"><filename role="nohyphenation">url</filename></title> - <indexterm> - <primary>url</primary> - </indexterm> - <indexterm> - <primary>Packages</primary> - <secondary>url</secondary> - </indexterm> - <para>Defines line breakable hyperlinked - (uses <link linkend="hyperref">hyperref</link> package) - verbatim input for urls and e-mail addresses. - </para> - <para>Example: <literal>\url{http://example.org}</literal> - outputs <literal>http://example.org</literal>. - </para> - <para>Related commands are - <link linkend="href"><literal>\href</literal></link> - and <link linkend="cmd-nolinkurl"><literal>\nolinkurl</literal></link>. - </para> - </section> - - </section> - - </section> - - - <section id="generic-packages"> - <title id="generic-packages-title">Generic Packages</title> - - <section id="pictex"> - <title id="pictex-title">&pictex; (&tbd;)</title> - <indexterm><primary>PiCTeX</primary></indexterm> - <para>&tbd;</para> - </section> - - <section id="pstricks"> - <title id="pstricks-title">&pstricks;</title> - <indexterm><primary>&pstricks;</primary></indexterm> - - <section id="pstricks-ovw"> - <title id="pstricks-ovw-title">&overview;</title> - <para>The idea behind the &pstricks; package of - Timothy van Zandt - <indexterm> - <primary>People</primary> - <secondary>van Zandt, Timothy</secondary> - </indexterm> - is to provide most of the PostScript language in - &latex; and &tex; syntax. - </para> - </section> - - <section id="pstricks-commands"> - <title id="pstricks-commands-title">Commands and Parameters</title> - - <section id="pstricks-color"> - <title id="pstricks-color-title">Color</title> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newgray</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newrgbcolor</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newhsbcolor</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newcmykcolor</tertiary> - </indexterm> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\newgray{color}{num}</literal> - </term> - <term> - <literal>\newrgbcolor{color}{num1 num2 num3}</literal> - </term> - <term> - <literal>\newhsbcolor{color}{num1 num2 num3}</literal> - </term> - <term> - <literal>\newcmykcolor{color}{num1 num2 num3 num4}</literal> - </term> - <listitem> - <simpara></simpara> - </listitem> - </varlistentry> - </variablelist> - <para> - Note that these commands are obsolete for &latex;. Load - &pstricks; with <literal>\usepackage{pstcol}</literal> - and use the standard &latex; color commands instead. - </para> - </section> - - <section id="pstricks-setting"> - <title id="pstricks-setting-title"> - Setting graphics parameters</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psset{par1=value1,par2=value2,...}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psset</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-dimensions"> - <title id="pstricks-dimensions-title"> - Dimensions, coordinates and angles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pssetlength{cmd}{dim}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pssetlength</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>unit=dim, xunit=dim, yunit=dim, yunit=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>unit</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>xunit</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>yunit</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>runit</tertiary> - </indexterm> - <para> - Default: <literal>1cm</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\degrees[num]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\degrees</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\radians</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\radians</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-basic"> - <title id="pstricks-basic-title"> - Basic graphics parameters</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linewidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linewidth</tertiary> - </indexterm> - <para> - Default: <literal>.8pt</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>linecolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linecolor</tertiary> - </indexterm> - <para> - Default: <literal>black</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>showpoints=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>showpoints</tertiary> - </indexterm> - <para> - Default: <literal>false</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-lines"> - <title id="pstricks-lines-title">Lines and polygons</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linearc=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linearc</tertiary> - </indexterm> - <para> - Default: <literal>0pt</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>framearc=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>framearc</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>cornersize=relative/absolute</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>cornersize</tertiary> - </indexterm> - <para> - Default: <literal>relative</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psline*[par]{arrows}(x0,y0)(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psline</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\qline(coor0)(coor1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\qline</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pspolygon*[par](x0,y0)(x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pspolygon</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psframe*[par](x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psframe</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-arcs"> - <title id="pstricks-arcs-title"> - Arcs, circles and ellipses</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pscircle*[par](x0,y0){radius}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscircle</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\qdisk(coor){radius}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscircle</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pswedge*[par](x0,y0){radius}{angle1}{angle2}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pswedge</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psellipse*[par](x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psellipse</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psarc*[par]{arrows}(x,y){radius}{angleA}{angleB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psarc</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psarcn*[par]{arrows}(x,y){radius}{angleA}{angleB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psarcn</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arcsep=dim, arcsepA=dim, arcsepB=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcsep</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcsepA</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcsepB</tertiary> - </indexterm> - <para> - Default: <literal>0pt</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-curves"> - <title id="pstricks-curves-title">Curves</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psbezier*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)(x3,y3)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psbezier</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\parabola*[par]{arrows}(x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\parabola</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pscurve*[par]{arrows}(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psecurve*[par]{arrows}(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psecurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psccurve*[par]{arrows}(x1,y1)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psccurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>curvature=num1 num2 num3</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>curvature</tertiary> - </indexterm> - <para> - Default: <literal>1 .1 0</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-dots"> - <title id="pstricks-dots-title">Dots</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psdots*[par](x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psdots</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotstyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotstyle</tertiary> - </indexterm> - <simpara> Default: <literal>*</literal></simpara> - <simpara> Dots: - <literal> - *, o, +, triangle, triangle*, square, square*, - pentagon, pentagon*, | - </literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotscale=num1 num2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotscale</tertiary> - </indexterm> - <para> - Default: <literal>1</literal> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotangle</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-grids"> - <title id="pstricks-grids-title">Grids</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\psgrid(x0,y0)(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psgrid</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridwidth</tertiary> - </indexterm> - <simpara> Default: <literal>.8pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridcolor</tertiary> - </indexterm> - <simpara> Default: <literal>black</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>griddots=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>griddots</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridlabels=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabels</tertiary> - </indexterm> - <simpara> Default: <literal>10pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>gridlabelcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabelcolor</tertiary> - </indexterm> - <simpara> Default: <literal>black</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgriddiv=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabelcolor</tertiary> - </indexterm> - <simpara> Default: <literal>5</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgridwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>subgridwidth</tertiary> - </indexterm> - <simpara> Default: <literal>.4pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgridcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gridlabelcolor</tertiary> - </indexterm> - <simpara> Default: <literal>gray</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>subgriddots=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>subgriddots</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-plots"> - <title id="pstricks-plots-title">Plots</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\fileplot*[par]{file}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\fileplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\dataplot*[par]{commands}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\dataplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\savedata{command}[data]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\savedata</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\readdata{command}{file}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\readdata</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\listplot*[par]{list}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\listplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\psplot*[par]{xmin}{xmax}{function}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\parametricplot*[par]{tmin}{tmax}{function}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\parametricplot</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>plotstyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>plotstyle</tertiary> - </indexterm> - <simpara> Default: <literal>line</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>plotpoints=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>plotpoints</tertiary> - </indexterm> - <simpara> Default: <literal>50</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-coordinate"> - <title id="pstricks-coordinate-title">Coordinate systems</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>origin={coor}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>origin</tertiary> - </indexterm> - <simpara> Default: <literal>0pt,0pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>swapaxes=true</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>swapaxes</tertiary> - </indexterm> - <simpara> Default: <literal>false</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-line-styles"> - <title id="pstricks-line-styles-title">Line styles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linestyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linestyle</tertiary> - </indexterm> - <simpara> Default: <literal>solid</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dash=dim1 dim2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dash</tertiary> - </indexterm> - <simpara> Default: <literal>5pt 3pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotsep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotsep</tertiary> - </indexterm> - <simpara> Default: <literal>3pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>border=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>border</tertiary> - </indexterm> - <simpara> Default: <literal>0pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>bordercolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bordercolor</tertiary> - </indexterm> - <simpara> Default: <literal>white</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>doubleline=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>doubleline</tertiary> - </indexterm> - <simpara> Default: <literal>false</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>doublesep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>doublesep</tertiary> - </indexterm> - <simpara> Default: <literal>1.25\pslinewidth</literal></simpara> </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>doublecolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>doublecolor</tertiary> - </indexterm> - <simpara> Default: <literal>white</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadow=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadow</tertiary> - </indexterm> - <simpara> Default: <literal>false</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadowsize=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadowsize</tertiary> - </indexterm> - <simpara> Default: <literal>3pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadowangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadowangle</tertiary> - </indexterm> - <simpara> Default: <literal>-45</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>shadowcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>shadowcolor</tertiary> - </indexterm> - <simpara> Default: <literal>darkgray</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dimen=outer/inner/middle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dimen</tertiary> - </indexterm> - <simpara> Default: <literal>outer</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-fill-styles"> - <title id="pstricks-fill-styles-title">Fill styles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>fillstyle=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>fillstyle</tertiary> - </indexterm> - <simpara> Default: <literal>none</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>fillcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>fillcolor</tertiary> - </indexterm> - <simpara> Default: <literal>white</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchwidth</tertiary> - </indexterm> - <simpara> Default: <literal>.8pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchsep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchsep</tertiary> - </indexterm> - <simpara> Default: <literal>4pt</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchcolor=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchcolor</tertiary> - </indexterm> - <simpara> Default: <literal>black</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>hatchangle=rot</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>hatchangle</tertiary> - </indexterm> - <simpara> Default: <literal>45</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-arrowheads"> - <title id="pstricks-arrowheads-title">Arrowheads and such</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>arrows=style</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrows</tertiary> - </indexterm> - <simpara> Default: <literal>-</literal></simpara> - <simpara> Arrows: - <literal> - -, <->, >-<, <<->>, - >>-<<, |-|, |*-|*, [-], - (-), o-o, *-*, oo-oo, **-**, c-c, cc-cc, C-C - </literal> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowsize=dim num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowsize</tertiary> - </indexterm> - <simpara> Default: <literal>2pt 3</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowlength=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowlength</tertiary> - </indexterm> - <simpara> Default: <literal>1.4</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowinset=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowinset</tertiary> - </indexterm> - <simpara>Default: <literal>.4</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>tbarsize=dim num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>tbarsize</tertiary> - </indexterm> - <simpara> Default: <literal>2pt 5</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>bracketlength=num, rbracketlength=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bracketlength</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>rbracketlength</tertiary> - </indexterm> - <simpara> Default: <literal>.15</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>dotsize=dim num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>dotsize</tertiary> - </indexterm> - <simpara> Default: <literal>.5pt 2.5</literal></simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>arrowscale=num1 num2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arrowscale</tertiary> - </indexterm> - <simpara> Default: <literal>1</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-custom"> - <title id="pstricks-custom-title">Custom styles</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\newpsobject{name}{object}{par1=value1,...}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newpsobject</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\newpsstyle{name}{par1=value1,...}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newpsstyle</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-basics"> - <title id="pstricks-basics-title">The basics</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pscustom*[par]{commands}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscustom</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-parameters"> - <title id="pstricks-parameters-title">Parameters</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>linetype=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>linetype</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-graphics-objects"> - <title id="pstricks-graphics-objects-title">Graphics objects</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>liftpen=0/1/2</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>liftpen</tertiary> - </indexterm> - <simpara> Default: <literal>0</literal></simpara> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="safe-tricks"> - <title id="pstricks-safe-tricks-title">Safe tricks</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\newpath</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\newpath</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\moveto(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\moveto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\closepath</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\closepath</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\stroke[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\stroke</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\fill[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\fill</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\gsave</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\gsave</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\grestore</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\grestore</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\translate(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\translate</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\scale{num1 num2}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\scale</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rotate{angle}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotate</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\swapaxes</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\swapaxes</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\msave</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\msave</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\mrestore</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\mrestore</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\openshadow[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\openshadow</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\closedshadow[par]</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\closedshadow</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\movepath(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\movepath</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pretty-safe-tricks"> - <title id="pstricks-pretty-safe-tricks-title"> - Pretty safe tricks</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\lineto(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\lineto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rlineto(coor)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rlineto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\curveto(x1,y1)(x2,y2)(x3,y3)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\curveto</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rcurveto(x1,y1)(x2,y2)(x3,y3)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rcurveto</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="hackers"> - <title id="pstricks-hackers-title">For hackers only</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\code{code}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\code</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\dim{dim}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\dim</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\coor(x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\coor</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\rcoor(x1,y1)(x2,y2)...(xn,yn)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rcoor</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\file{file}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\file</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\arrows{arrows}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\arrows</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\setcolor{color}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\setcolor</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pictures"> - <title id="pstricks-pictures-title">Pictures</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\pspicture*[baseline](x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pspicture</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\endpspicture</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\endpspicture</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="placing"> - <title id="pstricks-placing-title">Placing and rotating whatever</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\rput*[refpoint]{rotation}(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rput</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\uput*{labelsep}[refangle]{rotation}(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\uput</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\pslabelsep</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pslabelsep</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>labelsep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>labelsep</tertiary> - </indexterm> - <para> - Default: <literal>5pt</literal> - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-repetition"> - <title id="pstricks-repetition-title">Repetition</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal> - \multirput*[refpoint]{angle}(x0,y0)(x1,y1){int}{stuff} - </literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\multirput</tertiary> - </indexterm> - </listitem> - </varlistentry> - <varlistentry> - <term> - <literal>\multips{angle}(x0,y0)(x1,y1){int}{graphics}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\multips</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-axes"> - <title id="pstricks-axes-title">Axes</title> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psaxes</tertiary> - </indexterm> - - <variablelist role="db2latex:compact"> - <varlistentry> - <term><literal>\psaxes*[par]{arrows}(x0,y0)(x1,y1)(x2,y2)</literal></term> - <listitem> - <informaltable frame="none"> - <!-- <title>Axes label parameters</title> --> - <tgroup cols="4"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry><emphasis>Horizontal</emphasis></entry> - <entry><emphasis>Vertical</emphasis></entry> - <entry><emphasis>Dflt</emphasis></entry> - <entry><emphasis>Description</emphasis></entry> - </row> - <row rowsep="0"> - <entry>Ox=num</entry> - <entry>Oy=num</entry> - <entry>0</entry> - <entry>Label at origin.</entry> - </row> - <row rowsep="0"> - <entry>Dx=num</entry> - <entry>Dy=num</entry> - <entry>1</entry> - <entry>Label increment.</entry> - </row> - <row rowsep="0"> - <entry>dx=dim</entry> - <entry>oy=dim</entry> - <entry>0pt</entry> - <entry>Dist btwn labels.</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>labels=all/x/y/none</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>labels</tertiary> - </indexterm> - <para> - Default: <literal>all</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>showorigin=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>showorigin</tertiary> - </indexterm> - <para> - Default: <literal>true</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>ticks=all/x/y/none</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>ticks</tertiary> - </indexterm> - <para> - Default: <literal>all</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>tickstyle=full/top/bottom</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>tickstyle</tertiary> - </indexterm> - <para> - Default: <literal>full</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>ticksize=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>ticksize</tertiary> - </indexterm> - <para> - Default: <literal>3pt</literal> - </para> - - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psxlabel, \psylabel</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psxlabel</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psylabel</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>axesstyle=axes/frame/none</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>axesstyle</tertiary> - </indexterm> - <para> - Default: <literal>axes</literal> - </para> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-framed"> - <title id="pstricks-framed-title">Framed boxes</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>framesep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>framesep</tertiary> - </indexterm> - <para> - Default: <literal>3pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>boxsep=true/false</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>boxsep</tertiary> - </indexterm> - <para> - Default: <literal>true</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psframebox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psframebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psdblframebox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psdblframebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psshadowbox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psshadowbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pscirclebox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscirclebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\cput*[par]{angle}(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\cput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psovalbox*[par]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psovalbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-clipping"> - <title id="pstricks-clipping-title">Clipping</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\clipbox[dim]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\clipbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psclip{graphics} ... \endpsclip</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psclip</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-rotation"> - <title id="pstricks-rotation-title">Rotation and scaling boxes</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\rotateleft{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotateleft</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\rotateright{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotateright</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\rotatedown{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rotatedown</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\scalebox{num1 num2}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\scalebox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\scaleboxto(x,y){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\scaleboxto</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-nodes"> - <title id="pstricks-nodes-title">Nodes</title> - <variablelist role="db2latex:compact"> - <varlistentry> - <term> - <literal>\rnode[refpoint]{name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\rnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\Rnode(x,y){name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\Rnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\RnodeRef</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\RnodeRef</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pnode(x,y){name}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\cnode*[par](x,y){radius}{name}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\cnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\circlenode*[par]{name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\circlenode</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\cnodeput*[par]{angle}(x,y){name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\cnodeput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ovalnode*[par]{name}{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ovalnode</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-connections"> - <title id="pstricks-connections-title">Node connections</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>nodesep=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>nodesep</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>offset=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>offset</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>arm=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arm</tertiary> - </indexterm> - <para> - Default: <literal>10pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>angle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>angle</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>arcangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>arcangle</tertiary> - </indexterm> - <para> - Default: <literal>8</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>ncurv=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>ncurv</tertiary> - </indexterm> - <para> - Default: <literal>.67</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>loopsize=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>loopsize</tertiary> - </indexterm> - <para> - Default: <literal>1cm</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncline*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncline</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncLine*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncLine</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nccurve*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nccurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncarc*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncarc</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncbar*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncbar</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncdiag*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncdiag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncdiagg*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncdiagg</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncangle*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncangle</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncangles*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncangles</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\ncloop*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\ncloop</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nccircle*[par]{arrows}{node}{radius}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nccircle</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcline*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcline</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pccurve*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pccurve</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcarc*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcarc</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcbar*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcbar</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcdiag*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcdiag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcangle*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcangle</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pcloop*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pcloop</tertiary> - </indexterm> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section id="pstricks-attaching"> - <title id="pstricks-attaching-title">Attaching labels to node connections</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\lput*[refpoint]{rotation}(pos){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\lput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\aput*[labelsep]{angle}(pos){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\aput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\bput*[labelsep]{angle}(pos){stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\bput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\mput*[refpoint]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\mput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\Aput*[labelsep]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\Aput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\Bput*[labelsep]{stuff}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\Bput</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-coils"> - <title id="pstricks-coils-title">Coils and zigzags</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pscoil*[par]{arrows}(x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psCoil*[par]{angle1}{angle2}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psCoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pszigzag*[par]{arrows}(x0,y0)(x1,y1)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pszigzag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilwidth=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilwidth</tertiary> - </indexterm> - <para> - Default: <literal>1cm</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilheight=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilheight</tertiary> - </indexterm> - <para> - Default: <literal>1</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilarm=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilwidth</tertiary> - </indexterm> - <para> - Default: <literal>.5cm</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilaspect=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilwidth</tertiary> - </indexterm> - <para> - Default: <literal>45</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>coilinc=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>coilinc</tertiary> - </indexterm> - <para> - Default: <literal>10</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nccoil*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nccoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\nczigzag*[par]{arrows}{nodeA}{nodeB}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\nczigzag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pccoil*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pccoil</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pczigzag*[par]{arrows}(x1,y1)(x2,y2)</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pczigzag</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-coordinates"> - <title id="pstricks-coordinates-title">Special coordinates</title> - - <para><literal>\SpecialCoor</literal></para> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\SpecialCoor</tertiary> - </indexterm> - - <table frame="none"> - <title>Special coordinates and angles</title> - <tgroup cols="3"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <tbody> - <row rowsep="0"> - <entry><emphasis>Coordinate</emphasis></entry> - <entry><emphasis>Example</emphasis></entry> - <entry><emphasis>Description</emphasis></entry> - </row> - <row rowsep="0"> - <entry>(x,y)</entry> - <entry>(3,4)</entry> - <entry>Cartesian coordinate.</entry> - </row> - <row rowsep="0"> - <entry>(r;a)</entry> - <entry>(3;110)</entry> - <entry>Polar coordinate.</entry> - </row> - <row rowsep="0"> - <entry>(node)</entry> - <entry>(A)</entry> - <entry>Center of node.</entry> - </row> - <row rowsep="0"> - <entry>([par]node)</entry> - <entry>([angle=45]A)</entry> - <entry>Relative to node.</entry> - </row> - <row rowsep="0"> - <entry>(!ps)</entry> - <entry>(!5 3.3 2 exp)</entry> - <entry>Raw PostScript.</entry> - </row> - <row rowsep="0"> - <entry>(coor1|coor2)</entry> - <entry>(A|1in;30)</entry> - <entry>Combination.</entry> - </row> - </tbody> - </tgroup> - - <tgroup cols="3"> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="left"/> - <colspec colsep="0" align="justify"/> - <spanspec namest="1" nameend="3" spanname="3"/> - <tbody> - - <row rowsep="0"> - <entry spanname="3"/> - </row> - - <row rowsep="0"> - <entry><emphasis>Angle</emphasis></entry> - <entry><emphasis>Example</emphasis></entry> - <entry><emphasis>Description</emphasis></entry> - </row> - <row rowsep="0"> - <entry>num</entry> - <entry>45</entry> - <entry>Angle.</entry> - </row> - <row rowsep="0"> - <entry>(coor)</entry> - <entry>(-1,1)</entry> - <entry>Coordinate (vector).</entry> - </row> - <row rowsep="0"> - <entry>!ps</entry> - <entry>!33 sqrt</entry> - <entry>Raw PostScript.</entry> - </row> - </tbody> - </tgroup> - </table> - - <para><literal>\NormalCoor</literal></para> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\NormalCoor</tertiary> - </indexterm> - - </section> - - <section id="pstricks-overlays"> - <title id="pstricks-overlays-title">Overlays</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\overlaybox stuff\endoverlaybox</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\overlaybox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psoverlay{string}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psoverlay</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\putoverlaybox{string}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\putoverlaybox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradbegin=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradbegin</tertiary> - </indexterm> - <para> - Default: <literal>gradbegin</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradend=color</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradend</tertiary> - </indexterm> - <para> - Default: <literal>gradend</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradlines=int</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradlines</tertiary> - </indexterm> - <para> - Default: <literal>500</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradmidpoint=num</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradmidpoint</tertiary> - </indexterm> - <para> - Default: <literal>.9</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>gradangle=angle</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>gradangle</tertiary> - </indexterm> - <para> - Default: <literal>0</literal> - </para> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-path"> - <title id="pstricks-path-title">Typesetting text along a path</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pstextpath[pos](x,y){graphics object}{text}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pstextpath</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-stroking"> - <title id="pstricks-stroking-title">Stroking and filling character paths</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pscharpath*[par]{text}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscharpath</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pscharclip*[par]{text} ... \endpscharclip</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pscharclip</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-exporting"> - <title id="pstricks-exporting-title">Exporting EPS files</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\TeXtoEPS ... \endTeXtoEPS</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\TeXtoEPS</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\PSTtoEPS[par]{file}{graphics objects}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\PSTtoEPS</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bbllx=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bbllx</tertiary> - </indexterm> - <para> - Default: <literal>-1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bblly=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bblly</tertiary> - </indexterm> - <para> - Default: <literal>-1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bburx=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bburx</tertiary> - </indexterm> - <para> - Default: <literal>1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>bbury=dim</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>bbury</tertiary> - </indexterm> - <para> - Default: <literal>1pt</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>headerfile=file</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>headerfile</tertiary> - </indexterm> - <para> - Default: <literal>s</literal> - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>headers=none/all/user</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>parameter</secondary> - <tertiary>headers</tertiary> - </indexterm> - <para> - Default: <literal>none</literal> - </para> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-boxes"> - <title id="pstricks-boxes-title">Boxes</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\psmathboxtrue, \psmathboxfalse</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psmathboxtrue</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psmathboxfalse</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\everypsbox{commands}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\everypsbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\pslongbox{name}{cmd}</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pslongbox</tertiary> - </indexterm> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <literal>\psverbboxtrue, \psverbboxfalse</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psverbboxtrue</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psverbboxfalse</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - <section id="pstricks-tricks"> - <title id="pstricks-tricks-title">Tips and More Tricks</title> - <variablelist role="db2latex:compact"> - - <varlistentry> - <term> - <literal>\pslbrace, \psrbrace</literal> - </term> - <listitem> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\pslbrace</tertiary> - </indexterm> - <indexterm> - <primary>&pstricks;</primary> - <secondary>commands</secondary> - <tertiary>\psrbrace</tertiary> - </indexterm> - </listitem> - </varlistentry> - - </variablelist> - </section> - - </section> - - <section id="pstricks-add-packages"> - <title id="pstricks-add-packages-title"> - List of Additional &pstricks; Packages</title> - <para> - <variablelist role="db2latex:compact"> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/psgo/"><literal>psgo</literal></ulink></term> - <listitem> - <simpara>Draw Go diagrams</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-blur/"><literal>pst-blur</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for "blurred" shadows</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://dominique.rodriguez.9online.fr/pst-eucl/"><literal>pst-euc</literal></ulink></term> - <listitem> - <simpara>Géométrie en &latex; et &pstricks;</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.tug.org/applications/PSTricks/More/pst-fr3d.tar.gz"><literal>pst-fr3d</literal></ulink></term> - <listitem> - <simpara>Three dimensional framed Boxes</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-ghsb/"><literal>pst-ghsb</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for HSB Gradients</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-gr3d/"><literal>pst-gr3d</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for 3D grids</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://members.aol.com/ManuelLuque2/optique.htm"><literal>pst-lens</literal></ulink></term> - <listitem> - <simpara>Optique géométrique</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/"><literal>pst-node</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for nodes</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://members.aol.com/Mluque5130/pst-ob3d.tar.gz"><literal>pst-ob3d</literal></ulink></term> - <listitem> - <simpara>A &pstricks; package for three dimensional - basic objects - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.tug.org/applications/PSTricks/Physics/Oscilloscopes/"><literal>pst-osci</literal></ulink></term> - <listitem> - <simpara>Oscilloscopes with &pstricks;</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/pub/tex/graphics/pstricks/contrib/pst-poly/"><literal>pst-poly</literal></ulink></term> - <listitem> - <simpara>Polygons with &pstricks;</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="ftp://ftp.dante.de/tex-archive/graphics/pstricks/generic/"><literal>pst-tree</literal></ulink></term> - <listitem> - <simpara>&pstricks; package for trees</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.ensta.fr/~diam/latex/pst-uml/"><literal>pst-uml</literal></ulink></term> - <listitem> - <simpara>Draw easily diagrams with UML notation</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://perso.enst.fr/~lombardy/Vauc/"><literal>vaucansom.sty</literal></ulink></term> - <listitem> - <simpara>Drawing automata</simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - </section> - </section> - </section> - - <section id="fontinst"> - <title id="fontinst-title"> - <filename role="nohyphenation">fontinst</filename> (&tbd;)</title> - <indexterm> - <primary>fontinst</primary> - </indexterm> - <para>&tbd;</para> - </section> - - <section id="context"> - <title id="context-title">&context; (&tbd;)</title> - <indexterm><primary>&context;</primary></indexterm> - <indexterm> - <primary>People</primary> - <secondary>Hagen, Hans</secondary> - </indexterm> - <section id="context-ovw"> - <title id="context-ovw-title">&overview;</title> - <para>&context; is based on &plaintex; and &metapost; and gets - controlled with some Perl scripts. It's mainly targeted towards - layout oriented users and especially useful for presentations. - It's extensible by the use of modules and has in it's base - distribution already a large amount of functionality. - The preferred output format is PDF, but DVI is possible too. - </para> - <para>Some of the unique features of &context; are: - <itemizedlist spacing="compact"> - <listitem> - <simpara>Inline XML (including MathML, ChemML, and PhysML)</simpara> - </listitem> - <listitem> - <simpara>really good XML support in general</simpara> - </listitem> - <listitem> - <simpara>inline &metapost;</simpara> - </listitem> - </itemizedlist> - </para> - </section> - </section> - - <section id="texinfo"> - <title id="texinfo-title">&texinfo; (&tbd;)</title> - <indexterm><primary>&texinfo;</primary></indexterm> - <para>&tbd;</para> - </section> - -</chapter> - |