From a74c16d06af04f22a53debd1a1ef211416c3a6f6 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 13 May 2012 22:58:34 +0000 Subject: latex2e-help-texinfo (11may12) git-svn-id: svn://tug.org/texlive/trunk@26333 c570f23f-e606-0410-a88d-b1316a301751 --- .../doc/latex/latex2e-help-texinfo/latex2e.dbk | 5079 ++++++++++++-------- 1 file changed, 2976 insertions(+), 2103 deletions(-) (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk') diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk index 7dcf8aa18db..6d42c9c12d1 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk @@ -3,49 +3,46 @@ ]> - -@LaTeX{}2e reference manual (May 2011) + +&latex;2e reference manual (May 2012) - + - - - - - - - - - - - - + + + + + + + + + + + - - -This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2011. +This document is an unofficial reference manual for &latex;, a +document preparation system, version of May 2012. -This was originally translated from LATEX.HLP v1.0a in the VMS -Help Library. The pre-translation version was written by -George D. Greenwade of Sam Houston State University. The -&latex; 2.09 version was written by Stephen Gilmore. The +This manual was originally translated from LATEX.HLP v1.0a in +the VMS Help Library. The pre-translation version was written by +George D. Greenwade of Sam Houston State University. The +&latex; 2.09 version was written by Stephen Gilmore. The &latex;2e version was adapted from this by Torsten Martinsen. Karl Berry made further updates and additions, and gratefully acknowledges using Hypertext Help with &latex;, by Sheldon Green, and the -&latex; Command Summary (for &latex; 2.09) by L. Botway -and C. Biemesderfer (published by the &tex; Users Group as +&latex; Command Summary (for &latex; 2.09) by L. Botway +and C. Biemesderfer (published by the &tex; Users Group as &tex;niques number 10), as reference material (no text was directly copied). -Copyright © 2007, 2008, 2009, 2010, 2011 Karl Berry. +Copyright © 2007, 2008, 2009, 2010, 2011, 2012 Karl Berry. -Copyright © 1988, 1994, 2007 Stephen Gilmore. +Copyright © 1988, 1994, 2007 Stephen Gilmore. -Copyright © 1994, 1995, 1996 Torsten Martinsen. +Copyright © 1994, 1995, 1996 Torsten Martinsen. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -59,21 +56,50 @@ notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions. - - + + -* Menu: -* LaTeX2e: (latex2e). Unofficial LaTeX reference manual. +This document is an unofficial reference manual for &latex;, a +document preparation system, version of May 2012. + +This manual was originally translated from LATEX.HLP v1.0a in +the VMS Help Library. The pre-translation version was written by +George D. Greenwade of Sam Houston State University. The +&latex; 2.09 version was written by Stephen Gilmore. The +&latex;2e version was adapted from this by Torsten Martinsen. Karl +Berry made further updates and additions, and gratefully acknowledges +using Hypertext Help with &latex;, by Sheldon Green, and the +&latex; Command Summary (for &latex; 2.09) by L. Botway +and C. Biemesderfer (published by the &tex; Users Group as +&tex;niques number 10), as reference material (no text was +directly copied). + +Copyright © 2007, 2008, 2009, 2010, 2011, 2012 Karl Berry. +Copyright © 1988, 1994, 2007 Stephen Gilmore. +Copyright © 1994, 1995, 1996 Torsten Martinsen. + +Permission is granted to make and distribute verbatim copies of +this manual provided the copyright notice and this permission notice +are preserved on all copies. + +Permission is granted to copy and distribute modified versions of this +manual under the conditions for verbatim copying, provided that the entire +resulting derived work is distributed under the terms of a permission +notice identical to this one. + +Permission is granted to copy and distribute translations of this manual +into another language, under the above conditions for modified versions. + - + &latex;2e This document is an unofficial reference manual for &latex;, a -document preparation system, version as of May 2011. It is +document preparation system, version as of May 2012. It is intended to cover &latex;2e, which has been the standard version of &latex; for many years. @@ -81,16 +107,22 @@ intended to cover &latex;2e, which has been the standard version of -Overview of &latex; +About this document -Knuth, Donald E.Lamport, Leslie&latex; Project teamThe &latex; document preparation system is implemented as a macro -package for Donald E. Knuth's &tex; typesetting program. +Knuth, Donald E. +Lamport, Leslie +&latex; Project team +The &latex; document preparation system is implemented as a macro +package for Donald E. Knuth’s &tex; typesetting program. &latex; was originally created by Leslie Lamport; it is now maintained by a group of volunteers (http://latex-project.org). The official documentation written by the &latex; project is available from their web site. -bug reportingreporting bugslatexrefman-discuss@gna.org email addressThe present document is completely unofficial and has not been +bug reporting +reporting bugs +latexrefman-discuss@gna.org email address +The present document is completely unofficial and has not been reviewed by the &latex; maintainers. Do not send bug reports or anything else about this document to them. Instead, please send all comments to latexrefman-discuss@gna.org. @@ -100,6 +132,22 @@ comments to latexrefman-discuss@gna.org. current output in various formats, sources, mailing lists, and other infrastructure. +Of course, there are many, many other sources of information about +&latex;. Here are a few: + + +Two pages of recommended references to &latex; documentation. + + +Writing your first document, with a bit of both text and math. + + +The guide for document authors maintained as part of &latex;; there +are several others. + + +Introduction to the &tex; system, including &latex;. + @@ -107,72 +155,88 @@ infrastructure. What is &latex;? -overview of &latex;basics of &latex;&latex; overview&latex; typesets a file of text using the &tex; program and the -&latex; “macro package” for &tex;. That is, it processes an input +overview of &latex; +basics of &latex; +&latex; overview +&latex; typesets a file of text using the &tex; program and the +&latex; “macro package” for &tex;. That is, it processes an input file containing the text of a document with interspersed commands that describe how the text should be formatted. &latex; files are plain text that can be written in any reasonable editor. It produces at least three files as output: - -The main output file, which is one of: +The main output file, which is one of: -.dvi -.dvi filelatex commandIf invoked as latex, a “Device Independent” (.dvi) +.dvi +.dvi file +latex command +If invoked as latex, a “Device Independent” (.dvi) file is produced. This contains commands that can be translated into commands for virtually any output device. You can view such .dvi output of &latex; by using a program such as xdvi (display directly), dvips (convert to PostScript), or dvipdfmx (convert to PDF). -.pdf -.pdf filepdf&tex;pdflatex commandIf invoked as pdflatex, a “Portable Document Format” +.pdf +.pdf file +pdf&tex; +pdflatex command +If invoked as pdflatex, a “Portable Document Format” (.pdf) file. Typically, this is a self-contained file, with all fonts and images embedded. This can be very useful, but it does make the output much larger than the .dvi produced from the same document. -lualatex commandLua&tex;If invoked as lualatex, a .pdf file is created using +lualatex command +Lua&tex; +If invoked as lualatex, a .pdf file is created using the Lua&tex; engine (http://luatex.org). -xelatex commandXe&tex;If invoked as xelatex, a .pdf file is created using +xelatex command +Xe&tex; +If invoked as xelatex, a .pdf file is created using the Xe&tex; engine (http://tug.org/xetex). - Many other less-common variants of &latex; (and &tex;) exist, which can produce HTML, XML, and other things. - - -transcript filelog file.log fileThe “transcript” or .log file that contains summary +transcript file +log file +.log file +The “transcript” or .log file that contains summary information and diagnostic messages for any errors discovered in the input file. - - -auxiliary file.aux fileAn “auxiliary” or .aux file. This is used by &latex; itself, +auxiliary file +.aux file +An “auxiliary” or .aux file. This is used by &latex; itself, for things such as cross-references. - - -An open-ended list of other files might be created. We won't try to + +An open-ended list of other files might be created. We won’t try to list them all. Xxx components? -\ character starting commands[...] for optional arguments{...} for required argumentsIn the &latex; input file, a command name starts with a \, -followed by either (a) a string of letters or (b) a single +\ character starting commands +[...] for optional arguments +{...} for required arguments +In the &latex; input file, a command name starts with a \, +followed by either (a) a string of letters or (b) a single non-letter. Arguments contained in square brackets, [], are optional while arguments contained in braces, {}, are required. -case sensitivity of &latex;&latex; is case sensitive. Enter all commands in lower case unless +case sensitivity of &latex; +&latex; is case sensitive. Enter all commands in lower case unless explicitly directed to do otherwise. - + Starting & ending -starting & endingending & starting +starting & ending +ending & starting + A minimal input file looks like the following: \documentclass{class} @@ -181,10 +245,11 @@ explicitly directed to do otherwise. \end{document} where the class is a valid document class for &latex;. -See , for details of the various document classes +See Document classes, for details of the various document classes available locally. -preamble, definedYou may include other &latex; commands between the \documentclass +preamble, defined +You may include other &latex; commands between the \documentclass and the \begin{document} commands (this area is called the preamble). @@ -193,7 +258,10 @@ and the \begin{document} commands (this area is called the Document classes -document classesclasses of documents\documentclass +document classes +classes of documents +\documentclass + The class of a given document is defined with the command: \documentclass[options]{class} @@ -201,8 +269,13 @@ and the \begin{document} commands (this area is called the The \documentclass command must be the first command in a &latex; source file. -article classreport classbook classletter classslides classBuilt-in &latex; document class names are (many other document -classes are available as add-ons; see ): +article class +report class +book class +letter class +slides class +Built-in &latex; document class names are (many other document +classes are available as add-ons; see Overview): article report book letter slides @@ -215,7 +288,11 @@ classes are available as add-ons; see ): Document class options -document class optionsoptions, document classclass optionsglobal options +document class options +options, document class +class options +global options + You can specify so-called global options or class options to the \documentclass command by enclosing them in square brackets as usual. To specify more than one option, separate @@ -225,69 +302,98 @@ them with a comma: Here is the list of the standard class options. -10pt option11pt option12pt optionAll of the standard classes except slides accept the following +10pt option +11pt option +12pt option +All of the standard classes except slides accept the following options for selecting the typeface size (default is 10pt): 10pt 11pt 12pt -a4paper optiona5paper optionb5paper optionexecutivepaper optionlegalpaper optionletterpaper optionAll of the standard classes accept these options for selecting the paper +a4paper option +a5paper option +b5paper option +executivepaper option +legalpaper option +letterpaper option +All of the standard classes accept these options for selecting the paper size (default is letterpaper): a4paper a5paper b5paper executivepaper legalpaper letterpaper -draft optionfinal optionfleqn optionlandscape optionleqno optionopenbib optiontitlepage optionnotitlepage optionMiscellaneous other options: - -draft, final -black boxes, omittingmark/do not mark overfull boxes with a big black box; default is final. -fleqn -Put displayed formulas flush left; default is centered. -landscape -Selects landscape format; default is portrait. -leqno -Put equation numbers on the left side of equations; default is the right side. -openbib -Use “open” bibliography format. -titlepage, notitlepage -Specifies whether the title page is separate; default depends on the class. +draft option +final option +fleqn option +landscape option +leqno option +openbib option +titlepage option +notitlepage option +Miscellaneous other options: + +draft, final +black boxes, omitting +mark/do not mark overfull boxes with a big black box; default is final. +fleqn +Put displayed formulas flush left; default is centered. +landscape +Selects landscape format; default is portrait. +leqno +Put equation numbers on the left side of equations; default is the right side. +openbib +Use “open” bibliography format. +titlepage, notitlepage +Specifies whether the title page is separate; default depends on the class. - These options are not available with the slides class: -onecolumn optiontwocolumn optiononeside optiontwoside optionopenright optionopenany optiononecolumn -twocolumn -Typeset in one or two columns; default is onecolumn. - -oneside -twoside -\evensidemargin\oddsidemarginSelects one- or two-sided layout; default is oneside, except +onecolumn option +twocolumn option +oneside option +twoside option +openright option +openany option +onecolumn +twocolumn +Typeset in one or two columns; default is onecolumn. + +oneside +twoside +\evensidemargin +\oddsidemargin +Selects one- or two-sided layout; default is oneside, except for the book class. The \evensidemargin (\oddsidemargin parameter determines the distance on even (odd) numbered pages between the left side of the -page and the text's left margin. The defaults vary with the paper +page and the text’s left margin. The defaults vary with the paper size and whether one- or two-side layout is selected. For one-sided printing the text is centered, for two-sided, \oddsidemargin is 40% of the difference between \paperwidth and \textwidth, with \evensidemargin the remainder. -openright -openany -Determines if a chapter should start on a +openright +openany +Determines if a chapter should start on a right-hand page; default is openright for book. - The slides class offers the option clock for printing the time at the bottom of each note. -packages, loadingloading additional packages\usepackageAdditional packages are loaded like this: +packages, loading +loading additional packages +\usepackage +Additional packages are loaded like this: \usepackage[options]{pkg} To specify more than one pkg, you can separate them with a comma, or use multiple \usepackage commands. -global optionsoptions, globalAny options given in the \documentclass command that are unknown +global options +options, global +Any options given in the \documentclass command that are unknown by the selected document class are passed on to the packages loaded with \usepackage. @@ -297,7 +403,9 @@ by the selected document class are passed on to the packages loaded with Typefaces -typefacesfonts +typefaces +fonts + Two important aspects of selecting a font are specifying a size and a style. The &latex; commands for doing this are described here. @@ -306,69 +414,102 @@ and a style. The &latex; commands for doing this are described here. Font styles -font stylestypeface stylesstyles of text +font styles +typeface styles +styles of text + The following type style commands are supported by &latex;. -These commands are used like \textit{italic text}. The -corresponding command in parenthesis is the “declaration form”, which -takes no arguments. The scope of the declaration form lasts until the -next type style command or the end of the current group. +This first group of commands is typically used like +\textit{italic text}. The corresponding command in +parenthesis is the “declaration form”, which takes no arguments. The +scope of the declaration form lasts until the next type style command +or the end of the current group. The declaration forms are cumulative; i.e., you can say either \sffamily\bfseries or \bfseries\sffamily to get bold sans serif. -You can also use the environment form of the declaration forms; for instance, -\begin{ttfamily}...\end{ttfamily}. - -\textrm (\rmfamily) -\textrm\rmfamilyRoman. - -\textit (\itshape) -\textit\itshapeItalics. - -\emph -\emphemphasisEmphasis (switches between \textit and \textrm). - -\textmd (\mdseries) -\textmd\mdseriesMedium weight (default). - -\textbf (\bfseries) -\textbf\bfseriesBoldface. -\textup (\upshape) -\textup\upshapeUpright (default). The opposite of slanted. -\textsl (\slshape) -\textsl\slshapeSlanted. -\textsf (\sffamily) -\textsf\sffamilySans serif. -\textsc (\scshape) -\textsc\scshapeSmall caps. -\texttt (\ttfamily) -\texttt\ttfamilyTypewriter. -\textnormal (\normalfont) -\textnormal\normalfontMain document font. -\mathrm -\mathrmRoman, for use in math mode. -\mathbf -\mathbfBoldface, for use in math mode. -\mathsf -\mathsfSans serif, for use in math mode. -\mathtt -\mathttTypewriter, for use in math mode. - -\mathit -(\mit) -Italics, for use in math mode. - -\mathnormal -\mathnormalFor use in math mode, e.g. inside another type style declaration. -\mathcal -\mathcal`Calligraphic' letters, for use in math mode. +You can alternatively use an environment form of the declarations; for +instance, \begin{ttfamily}...\end{ttfamily}. + +These commands automatically supply an italic correction if the +\textrm (\rmfamily) +\textrm +\rmfamily +Roman. + +\textit (\itshape) +\textit +\itshape +Italics. + +\emph +\emph +emphasis +Emphasis (switches between \textit and \textrm). + +\textmd (\mdseries) +\textmd +\mdseries +Medium weight (default). + +\textbf (\bfseries) +\textbf +\bfseries +Boldface. +\textup (\upshape) +\textup +\upshape +Upright (default). The opposite of slanted. +\textsl (\slshape) +\textsl +\slshape +Slanted. +\textsf (\sffamily) +\textsf +\sffamily +Sans serif. +\textsc (\scshape) +\textsc +\scshape +Small caps. +\texttt (\ttfamily) +\texttt +\ttfamily +Typewriter. +\textnormal (\normalfont) +\textnormal +\normalfont +Main document font. +\mathrm +\mathrm +Roman, for use in math mode. +\mathbf +\mathbf +Boldface, for use in math mode. +\mathsf +\mathsf +Sans serif, for use in math mode. +\mathtt +\mathtt +Typewriter, for use in math mode. + +\mathit +(\mit) +Italics, for use in math mode. + +\mathnormal +\mathnormal +For use in math mode, e.g. inside another type style declaration. +\mathcal +\mathcal +‘Calligraphic’ letters, for use in math mode. - In addition, the command \mathversion{bold} -\mathversioncan be used for switching to bold letters and symbols in +\mathversion +can be used for switching to bold letters and symbols in formulas. \mathversion{normal} restores the default. &latex; also provides these commands, which unconditionally switch to @@ -377,183 +518,214 @@ differently than the above commands, too: {\cmd\cmd{...}. These are two very different things. -\bf -bold fontSwitch to bold face. +\bf\bf +bold font +Switch to bold face. -\cal -script letters for mathcalligraphic letters for mathSwitch to calligraphic letters for math. +\cal\cal +script letters for math +calligraphic letters for math +Switch to calligraphic letters for math. -\em -emphasisEmphasis (italics within roman, roman within italics). +\em\em +emphasis +Emphasis (italics within roman, roman within italics). -\it -italic fontItalics. +\it\it +italic font +Italics. -\rm -roman fontRoman. +\rm\rm +roman font +Roman. -\sc -small caps fontSmall caps. +\sc\sc +small caps font +Small caps. -\sf -sans serif fontSans serif. +\sf\sf +sans serif font +Sans serif. -\sl -slanted fontoblique fontSlanted (oblique). +\sl\sl +slanted font +oblique font +Slanted (oblique). -\tt -typewriter fontmonospace fontfixed-width fontTypewriter (monospace, fixed-width). +\tt\tt +typewriter font +monospace font +fixed-width font +Typewriter (monospace, fixed-width). - Font sizes -font sizestypeface sizessizes of text +font sizes +typeface sizes +sizes of text + The following standard type size commands are supported by &latex;. The table shows the command name and the corresponding actual font -size used (in points) with the ‘10pt’, ‘11pt’, and -‘12pt’ document size options, respectively (see ). - -\tiny\scriptsize\footnotesize\small\normalsize\large\Large\LARGE\huge\Huge - Command 10pt 11pt 12pt - \tiny - 5 6 6 - \scriptsize - 7 8 8 - \footnotesize - 8 9 10 - \small - 9 10 10.95 - \normalsize (default) - 10 10.95 12 - \large - 12 12 14.4 - \Large - 14.4 14.4 17.28 - \LARGE - 17.28 17.28 20.74 - \huge - 20.74 20.74 24.88 - \Huge - 24.88 24.88 24.88 - -The commands as listed here are “declaration forms”. The scope of +size used (in points) with the ‘10pt’, ‘11pt’, and +‘12pt’ document size options, respectively (see Document class +options). + +\tiny +\scriptsize +\footnotesize +\small +\normalsize +\large +\Large +\LARGE +\huge +\Huge + +Command 10pt 11pt 12pt +\tiny +5 6 6 +\scriptsize +7 8 8 +\footnotesize +8 9 10 +\small +9 10 10.95 +\normalsize (default) +10 10.95 12 +\large +12 12 14.4 +\Large +14.4 14.4 17.28 +\LARGE +17.28 17.28 20.74 +\huge +20.74 20.74 24.88 +\Huge +24.88 24.88 24.88 + +The commands as listed here are “declaration forms”. The scope of the declaration form lasts until the next type style command or the end of the current group. You can also use the environment form of these commands; for instance, \begin{tiny}...\end{tiny}. - + Low-level font commands -low-level font commandsfont commands, low-level +low-level font commands +font commands, low-level + These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones. -\fontencoding{enc} -\fontencodingSelect font encoding. Valid encodings include OT1 and T1. +\fontencoding{enc} +\fontencoding +Select font encoding. Valid encodings include OT1 and T1. -\fontfamily{family} -\fontfamilySelect font family. Valid families include: +\fontfamily{family} +\fontfamily +Select font family. Valid families include: - cmr for Computer Modern Roman - - cmss for Computer Modern Sans Serif - - cmtt for Computer Modern Typewriter - - +cmr for Computer Modern Roman +cmss for Computer Modern Sans Serif +cmtt for Computer Modern Typewriter + and numerous others. -\fontseries{series} -\fontseriesSelect font series. Valid series include: - - m Medium (normal) - - b Bold - - c Condensed - - bc Bold condensed - - bx Bold extended - - +\fontseries{series} +\fontseries +Select font series. Valid series include: + +m Medium (normal) +b Bold +c Condensed +bc Bold condensed +bx Bold extended + and various other combinations. -\fontshape{shape} -\fontshapeSelect font shape. Valid shapes are: - - n Upright (normal) - - it Italic - - sl Slanted (oblique) - - sc Small caps - - ui Upright italics - - ol Outline - - +\fontshape{shape} +\fontshape +Select font shape. Valid shapes are: + +n Upright (normal) +it Italic +sl Slanted (oblique) +sc Small caps +ui Upright italics +ol Outline + The two last shapes are not available for most font families. -\fontsize{size}{skip} -\fontsize\baselineskipSet font size. The first parameter is the font size to switch to and +\fontsize{size}{skip} +\fontsize +\baselineskip +Set font size. The first parameter is the font size to switch to and the second is the line spacing to use; this is stored in a parameter named \baselineskip. The unit of both parameters defaults to pt. The default \baselineskip for the Computer Modern typeface is 1.2 times the \fontsize. -\baselinestretchsetspace packagedouble spacingThe line spacing is also multiplied by the value of the +\baselinestretch +setspace package +double spacing +The line spacing is also multiplied by the value of the \baselinestretch parameter when the type size changes; the -default is 1. However, the best way to “double space” a document, +default is 1. However, the best way to “double space” a document, if you should be unlucky enough to have to produce such, is to use the setspace package; see http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace. -\linespread\linespread{factor} -Equivalent to +\linespread +\linespread{factor} +Equivalent to \renewcommand{\baselinestretch}{factor}, and therefore must be followed by \selectfont to have any effect. Best specified in the preamble, or use the setspace package, as described just above. -\selectfontThe changes made by calling the font commands described above do +\selectfont +The changes made by calling the font commands described above do not come into effect until \selectfont is called. -\usefont{enc}{family}{series}{shape} -\usefontThe same as invoking \fontencoding, \fontfamily, +\usefont{enc}{family}{series}{shape} +\usefont +The same as invoking \fontencoding, \fontfamily, \fontseries and \fontshape with the given parameters, followed by \selectfont. - Layout layout commands + Miscellaneous commands for controlling the general layout of the page. - + <literal>\onecolumn</literal> -\onecolumnone-column output +\onecolumn +one-column output + The \onecolumn declaration starts a new page and produces single-column output. This is the default. - + <literal>\twocolumn</literal> -\twocolumnmulticolumn texttwo-column output +\twocolumn +multicolumn text +two-column output + Synopsis: \twocolumn[text1col] @@ -565,58 +737,59 @@ starts. These parameters control typesetting in two-column output: -\columnsep -The distance between columns (35pt by default). +\columnsep\columnsep +The distance between columns (35pt by default). -\columnseprule -The width of the rule between columns; the default is 0pt, so there is no rule. +\columnseprule\columnseprule +The width of the rule between columns; the default is 0pt, so there is no rule. -\columnwidth -The width of the current column; this is equal to \textwidth in +\columnwidth\columnwidth +The width of the current column; this is equal to \textwidth in single-column text. - These parameters control float behavior in two-column output: -\dbltopfraction -Maximum fraction at the top of a two-column page that may be occupied -by floats. Default ‘.7’, can be usefully redefined to (say) -‘.9’ to avoid going to float pages so soon. +\dbltopfraction\dbltopfraction +Maximum fraction at the top of a two-column page that may be occupied +by floats. Default ‘.7’, can be usefully redefined to (say) +‘.9’ to avoid going to float pages so soon. -\dblfloatpagefraction -The minimum fraction of a float page that must be occupied by floats, -for a two-column float page. Default ‘.5’. +\dblfloatpagefraction\dblfloatpagefraction +The minimum fraction of a float page that must be occupied by floats, +for a two-column float page. Default ‘.5’. -\dblfloatsep -Distance between floats at the top or bottom of a two-column float -page. Default ‘12pt plus2pt minus2pt’ for ‘10pt’ and -‘11pt’ documents, ‘14pt plus2pt minus4pt’ for ‘12pt’. +\dblfloatsep\dblfloatsep +Distance between floats at the top or bottom of a two-column float +page. Default ‘12pt plus2pt minus2pt’ for ‘10pt’ and +‘11pt’ documents, ‘14pt plus2pt minus4pt’ for ‘12pt’. -\dbltextfloatsep -Distance between a multi-column float at the top or bottom of a page -and the main text. Default ‘20pt plus2pt minus4pt’. +\dbltextfloatsep\dbltextfloatsep +Distance between a multi-column float at the top or bottom of a page +and the main text. Default ‘20pt plus2pt minus4pt’. - - + <literal>\flushbottom</literal> \flushbottom + The \flushbottom declaration makes all text pages the same height, adding extra vertical space where necessary to fill out the page. This is the default if twocolumn mode is selected -(see ). +(see Document class options). - + <literal>\raggedbottom</literal> -\raggedbottomstretch, omitting vertical +\raggedbottom +stretch, omitting vertical + The \raggedbottom declaration makes all pages the natural height of the material on that page. No rubber lengths will be stretched. @@ -626,96 +799,102 @@ stretched. Page layout parameters -page layout parametersparameters, page layoutlayout, page parameters forheader, parameters forfooter, parameters forrunning header and footer -\headheight -Height of the box that contains the running head. Default is -‘30pt’, except in the book class, where it varies with the +page layout parameters +parameters, page layout +layout, page parameters for +header, parameters for +footer, parameters for +running header and footer + +\headheight\headheight +Height of the box that contains the running head. Default is +‘30pt’, except in the book class, where it varies with the type size. -\headsep -Vertical distance between the bottom of the header line and the top of -the main text. Default is ‘25pt’, except in the book +\headsep\headsep +Vertical distance between the bottom of the header line and the top of +the main text. Default is ‘25pt’, except in the book class, where it varies with the type size. -\footskip -Distance from the baseline of the last line of text to the baseline of -the page footer. Default is ‘30pt’, except in the book +\footskip\footskip +Distance from the baseline of the last line of text to the baseline of +the page footer. Default is ‘30pt’, except in the book class, where it varies with the type size. -\linewidth -Width of the current line, decreased for each nested list -(see ). Specifically, it is smaller than \textwidth by +\linewidth\linewidth +Width of the current line, decreased for each nested list +(see list). Specifically, it is smaller than \textwidth by the sum of \leftmargin and \rightmargin -(see ). The default varies with the font size, paper +(see itemize). The default varies with the font size, paper width, two-column mode, etc. For an article document in -‘10pt’, it's set to ‘345pt’; in two-column mode, that -becomes ‘229.5pt’. +‘10pt’, it’s set to ‘345pt’; in two-column mode, that +becomes ‘229.5pt’. -\textheight -The normal vertical height of the page body; the default varies with +\textheight\textheight +The normal vertical height of the page body; the default varies with the font size, document class, etc. For an article or -report document in ‘10pt’, it's set to -‘43\baselineskip’; for book, it's ‘41\baselineskip’. -For ‘11pt’, it's ‘38\baselineskip’ and for ‘12pt’, -‘36\baselineskip’. - -\textwidth -The full horizontal width of the entire page body; the default varies -as usual. For an article or report document, it's -‘345pt’ at ‘10pt’, ‘360pt’ at ‘11pt’, and -‘390pt’ at ‘12pt’. For a book document, it's -‘4.5in’ at ‘10pt’, and ‘5in’ at ‘11pt’ or -‘12pt’. +report document in ‘10pt’, it’s set to +‘43\baselineskip’; for book, it’s ‘41\baselineskip’. +For ‘11pt’, it’s ‘38\baselineskip’ and for ‘12pt’, +‘36\baselineskip’. + +\textwidth\textwidth +The full horizontal width of the entire page body; the default varies +as usual. For an article or report document, it’s +‘345pt’ at ‘10pt’, ‘360pt’ at ‘11pt’, and +‘390pt’ at ‘12pt’. For a book document, it’s +‘4.5in’ at ‘10pt’, and ‘5in’ at ‘11pt’ or +‘12pt’. In multi-column output, \textwidth remains the width of the entire page body, while \columnwidth is the width of one column -(see ). +(see \twocolumn). -In lists (see ), \textwidth remains the width of the +In lists (see list), \textwidth remains the width of the entire page body (and \columnwidth the width of the entire column), while \linewidth may decrease for nested lists. -Inside a minipage (see ) or \parbox -(see ), all the width-related parameters are set to the +Inside a minipage (see minipage) or \parbox +(see \parbox), all the width-related parameters are set to the specified width, and revert to their normal values at the end of the minipage or \parbox. -\hsizeFor completeness: \hsize is the &tex; primitive parameter used +\hsize +For completeness: \hsize is the &tex; primitive parameter used when text is broken into lines. It should not be used in normal &latex; documents. -\topmargin -Space between the top of the &tex; page (one inch from the top of the +\topmargin\topmargin +Space between the top of the &tex; page (one inch from the top of the paper, by default) and the top of the header. The default is computed -based on many other parameters: \paperheight − 2in − -\headheight − \headsep − \textheight − \footskip, and +based on many other parameters: \paperheight − 2in − +\headheight − \headsep − \textheight − \footskip, and then divided by two. -\topskip -Minimum distance between the top of the page body and the baseline of +\topskip\topskip +Minimum distance between the top of the page body and the baseline of the first line of text. For the standard clases, the default is the -same as the font size, e.g., ‘10pt’ at ‘10pt’. +same as the font size, e.g., ‘10pt’ at ‘10pt’. - Sectioning sectioning + Sectioning commands provide the means to structure your text into units: -\part -\chapter -(report and book class only) -\section -\subsection -\subsubsection -\paragraph -\subparagraph - - +\part\part +\chapter\chapter +(report and book class only) +\section\section +\subsection\subsection +\subsubsection\subsubsection +\paragraph\paragraph +\subparagraph\subparagraph + All sectioning commands take the same general form, e.g., \chapter[toctitle]{title} @@ -723,55 +902,58 @@ same as the font size, e.g., ‘10pt’ at ‘
  • In addition to providing the heading title in the main text, the section title can appear in two other places: - -The table of contents. - - -The running head at the top of the page. - - +The table of contents. +The running head at the top of the page. + You may not want the same text in these places as in the main text. To handle this, the sectioning commands have an optional argument toctitle that, when given, specifies the text for these other places. -*-form of sectioning commandsAlso, all sectioning commands have *-forms that print +*-form of sectioning commands +Also, all sectioning commands have *-forms that print title as usual, but do not include a number and do not make an entry in the table of contents. For instance: \section*{Preamble} -\appendixappendix, creatingThe \appendix command changes the way following sectional units +\appendix +appendix, creating +The \appendix command changes the way following sectional units are numbered. The \appendix command itself generates no text and does not affect the numbering of parts. The normal use of this command is something like \chapter{A Chapter} -… +… \appendix \chapter{The First Appendix} -secnumdepth countersection numbers, printingThe secnumdepth counter controls printing of section numbers. +secnumdepth counter +section numbers, printing +The secnumdepth counter controls printing of section numbers. The setting \setcounter{secnumdepth}{level} -suppresses heading numbers at any depth > level, where -chapter is level zero. (See .) +suppresses heading numbers at any depth > level, where +chapter is level zero. (See \setcounter.) Cross references cross references + One reason for numbering things like figures and equations is to refer -the reader to them, as in “See Figure 3 for more details.” +the reader to them, as in “See Figure 3 for more details.” - + <literal>\label</literal> \label + Synopsis: \label{key} @@ -787,26 +969,28 @@ punctuation characters. Upper and lowercase letters are distinguished. common to use labels consisting of a prefix and a suffix separated by a colon or period. Some conventionally-used prefixes: -ch -for chapters -sec -for lower-level sectioning commands -fig -for figures -tab -for tables -eq -for equations +ch +for chapters +sec +for lower-level sectioning commands +fig +for figures +tab +for tables +eq +for equations - Thus, a label for a figure would look like fig:snark or fig.snark. - + <literal>\pageref{<replaceable>key</replaceable>}</literal> -\pagerefcross referencing with page numberpage number, cross referencing +\pageref +cross referencing with page number +page number, cross referencing + Synopsis: \pageref{key} @@ -817,17 +1001,23 @@ the place in the text where the corresponding - + <literal>\ref{<replaceable>key</replaceable>}</literal> -\refcross referencing, symbolicsection number, cross referencingequation number, cross referencingfigure number, cross referencingfootnote number, cross referencing +\ref +cross referencing, symbolic +section number, cross referencing +equation number, cross referencing +figure number, cross referencing +footnote number, cross referencing + Synopsis: \ref{key} The \ref command produces the number of the sectional unit, -equation, footnote, figure, …, of the corresponding -\label command (see ). It does not produce any text, -such as the word `Section' or `Figure', just the bare number itself. +equation, footnote, figure, …, of the corresponding +\label command (see \label). It does not produce any text, +such as the word ‘Section’ or ‘Figure’, just the bare number itself. @@ -835,7 +1025,10 @@ such as the word `Section' or `Figure', just the bare number itself. Environments environments -\begin\end + +\begin +\end + &latex; provides many environments for marking off certain text. Each environment begins and ends in the same manner: @@ -845,10 +1038,12 @@ Each environment begins and ends in the same manner: - + <literal>abstract</literal> -abstract environmentabstracts +abstract environment +abstracts + Synopsis: \begin{abstract} ... @@ -858,9 +1053,11 @@ Each environment begins and ends in the same manner: - + <literal>array</literal> -array environmentarrays, math +array environment +arrays, math + Synopsis: \begin{array}{template} @@ -869,28 +1066,29 @@ Each environment begins and ends in the same manner: \end{array} Math arrays are produced with the array environment, normally -within an equation environment (see ). It has a +within an equation environment (see equation). It has a single mandatory template argument describing the number of columns and the alignment within them. Each column col is specified by a single letter that tells how items in that row should be formatted, as follows: -c -centered -l -flush left -r -flush right +c +centered +l +flush left +r +flush right - -\\ (for array)Column entries are separated by &. Column entries may include +\\ (for array) +Column entries are separated by &. Column entries may include other &latex; commands. Each row of the array is terminated with \\. -@{...}In the template, the construct @{text} puts text +@{...} +In the template, the construct @{text} puts text between columns in each row. -Here's an example: +Here’s an example: \begin{equation} \begin{array}{lrc} @@ -899,8 +1097,9 @@ between columns in each row. \end{array} \end{equation} -\arraycolsepThe \arraycolsep parameter defines half the width of the space -separating columns; the default is ‘5pt’. See , for other +\arraycolsep +The \arraycolsep parameter defines half the width of the space +separating columns; the default is ‘5pt’. See tabular, for other parameters which affect formatting in array environments, namely \arrayrulewidth and \arraystretch. @@ -908,10 +1107,12 @@ namely \arrayrulewidth and \arraystretch. - + <literal>center</literal> -center environmentcentering text, environment for +center environment +centering text, environment for + Synopsis: \begin{center} @@ -919,17 +1120,20 @@ namely \arrayrulewidth and \arraystretch. line2 \\ \end{center} -\\ (for center)The center environment allows you to create a paragraph +\\ (for center) +The center environment allows you to create a paragraph consisting of lines that are centered within the left and right margins on the current page. Each line is terminated with the string \\. - + <literal>\centering</literal> -\centeringcentering text, declaration for +\centering +centering text, declaration for + The \centering declaration corresponds to the center environment. This declaration can be used inside an environment such as quote or in a parbox. Thus, the text of a figure or @@ -938,11 +1142,11 @@ command at the beginning of the figure or table environment. Unlike the center environment, the \centering command does not start a new paragraph; it simply changes how &latex; formats -paragraph units. To affect a paragraph unit's format, the scope of +paragraph units. To affect a paragraph unit’s format, the scope of the declaration must contain the blank line or \end command (of an environment such as quote) that ends the paragraph unit. -Here's an example: +Here’s an example: \begin{quote} \centering @@ -953,10 +1157,13 @@ second line \\ - + <literal>description</literal> -description environmentlabelled lists, creatingdescription lists, creating +description environment +labelled lists, creating +description lists, creating + Synopsis: \begin{description} @@ -965,25 +1172,29 @@ second line \\ ... \end{description} -\itemThe description environment is used to make labelled lists. Each +\item +The description environment is used to make labelled lists. Each label is typeset in bold, flush right. The item text may contain multiple paragraphs. -bold typewriter, avoidingtypewriter labels in listsAnother variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using \texttt, you'll get +bold typewriter, avoiding +typewriter labels in lists +Another variation: since the bold style is applied to the labels, if +you typeset a label in typewriter using \texttt, you’ll get bold typewriter: \item[\texttt{bold and typewriter}]. This may be too bold, among other issues. To get just typewriter, use \tt, which resets all other style variations: \item[{\tt plain typewriter}]. -For details about list spacing, see . +For details about list spacing, see itemize. - + <literal>displaymath</literal> -displaymath environment +displaymath environment + Synopsis: \begin{displaymath} @@ -997,26 +1208,29 @@ plain typewriter}]. The displaymath environment (\[...\] is a synonym) typesets the math text on its own line, centered by default. The global fleqn option makes equations flush left; see -. +Document class options. No equation number is added to displaymath text; to get an -equation number, use the equation environment (see ). +equation number, use the equation environment (see equation). - + <literal>document</literal> -document environment +document environment + The document environment encloses the body of a document. -It is required in every &latex; document. See . +It is required in every &latex; document. See Starting & ending. - + <literal>enumerate</literal> -enumerate environmentlists of items, numbered +enumerate environment +lists of items, numbered + Synopsis: \begin{enumerate} @@ -1028,72 +1242,102 @@ It is required in every &latex; document. See ) and description -(see ). +itemize (see itemize) and description +(see description). -\itemEach item of an enumerated list begins with an \item command. +\item +Each item of an enumerated list begins with an \item command. There must be at least one \item command within the environment. By default, the numbering at each level is done like this: - 1., 2., … - - (a), (b), … - - i., ii., … - - A., B., … - - -\enumi\enumii\enumiii\enumivThe enumerate environment uses the counters \enumi -through \enumiv counters (see ). If the optional +1., 2., … +(a), (b), … +i., ii., … +A., B., … + +\enumi +\enumii +\enumiii +\enumiv +The enumerate environment uses the counters \enumi +through \enumiv counters (see Counters). If the optional argument to \item is given, the counter is not incremented for that item. -\labelenumi\labelenumii\labelenumiii\labelenumivThe enumerate environment uses the commands \labelenumi +\labelenumi +\labelenumii +\labelenumiii +\labelenumiv +The enumerate environment uses the commands \labelenumi through \labelenumiv to produce the default label. So, you can -use \renewcommand to change the labels (see ). For instance, to have the first level use uppercase +use \renewcommand to change the labels (see \newcommand & +\renewcommand). For instance, to have the first level use uppercase letters: -\Alph example\renewcommand{\labelenumi}{\Alph{enumi}} +\Alph example +\renewcommand{\labelenumi}{\Alph{enumi}} - + <literal>eqnarray</literal> -eqnarray environmentequations, aligningaligning Equations +eqnarray environment +equations, aligning +aligning equations + +align environment, from amsmath +amsmath package, replacing eqnarray +Madsen, Lars +First, a caveat: the eqnarray environment has some infelicities +which cannot be overcome; the article “Avoid eqnarray!” by Lars +Madsen describes them in detail +(http://tug.org/TUGboat/tb33-1/tb103madsen.pdf). The bottom +line is that it is better to use the align environment (and +others) from the amsmath package. + +Nevertheless, here is a description of eqnarray: + \begin{eqnarray} (or eqnarray*) formula1 \\ formula2 \\ ... \end{eqnarray} -\\ (for eqnarray)The eqnarray environment is used to display a sequence of +\\ (for eqnarray) +The eqnarray environment is used to display a sequence of equations or inequalities. It is very much like a three-column array environment, with consecutive rows separated by \\ and consecutive items within a row separated by an &. -\\* (for eqnarray)\\* can also be used to separate equations, with its normal +\\* (for eqnarray) +\\* can also be used to separate equations, with its normal meaning of not allowing a page break at that line. -\nonumberequation numbers, omittingAn equation number is placed on every line unless that line has a +\nonumber +equation numbers, omitting +An equation number is placed on every line unless that line has a \nonumber command. Alternatively, The *-form of the environment (\begin{eqnarray*} ... \end{eqnarray*}) will omit equation numbering entirely, while otherwise being the same as eqnarray. -\lefteqnThe command \lefteqn is used for splitting long formulas across +\lefteqn +The command \lefteqn is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. - + <literal>equation</literal> -equation environmentequations, environment forformulas, environment for +equation environment +equations, environment for +formulas, environment for + Synopsis: \begin{equation} @@ -1101,14 +1345,17 @@ zero width. \end{equation} The equation environment starts a displaymath -environment (see ), e.g., centering the math text +environment (see displaymath), e.g., centering the math text on the page, and also places an equation number in the right margin. - + <literal>figure</literal> -figureinserting figuresfigures, inserting +figure +inserting figures +figures, inserting + \begin{figure[*]}[placement] figbody \label{label} @@ -1116,149 +1363,204 @@ on the page, and also places an equation number in the right margin. \end{figure} Figures are objects that are not part of the normal text, and are -instead “floated” to a convenient place, such as the top of a page. +instead “floated” to a convenient place, such as the top of a page. Figures will not be split between two pages. When typesetting in double-columns, the starred form produces a full-width figure (across both columns). +placement of floats +specifier, float placement The optional argument [placement] determines where &latex; will try to place your figure. There are four places where &latex; can possibly put a float: -t -(Top)—at the top of a text page. +t +(Top)—at the top of a text page. -b -(Bottom)—at the bottom of a text page. However, b is not +b +(Bottom)—at the bottom of a text page. However, b is not allowed for full-width floats (figure*) with double-column output. To ameliorate this, use the stfloats or dblfloatfix package, but see the discussion at caveats in the FAQ: http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat. -h -float package(Here)—at the position in the text where the figure environment -appears. However, this is not allowed by itself, t is -automatically added. To absolutely force a figure to appear “here”, -use the float and use its H placement letter. (That -package also provides other options.) - -p -(Page of floats)—on a separate float page, which is a page +h +float package +(Here)—at the position in the text where the figure environment +appears. However, this is not allowed by itself; t is +automatically added. + +here, putting floats +float package +To absolutely force a figure to appear “here”, you can +\usepackage{float} and use the H specifier which it +defines. For further discussion, see the FAQ entry at +http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere. + +p +(Page of floats)—on a separate float page, which is a page containing no text, only floats. +! +Used in addition to one of the above; for this float only, &latex; +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The ! specifier does not mean “put the float here”; +see above. + - The standard report and article classes use the default placement tbp. -The body of the figure is made up of whatever text, &latex; commands, etc. -you wish. +The body of the figure is made up of whatever text, &latex; commands, +etc. you wish. -\captionThe \caption command specifies caption text for the +\caption +The \caption command specifies caption text for the figure. The caption is numbered by default. If loftitle is present, it is used in the list of figures instead of text -(see ). +(see Tables of contents). - -\bottomfractionThe maximum fraction of the page allowed to be occuped by floats at -the bottom; default ‘.3’. +Parameters relating to fractions of pages occupied by float and +non-float text: -\floatpagefraction -The minimum fraction of a float page that must be occupied by floats; -default ‘.5’. +\bottomfraction +The maximum fraction of the page allowed to be occuped by floats at +the bottom; default ‘.3’. -\floatsep -Space between floats at the top or bottom of a page; default -‘12pt plus2pt minus2pt’. +\floatpagefraction\floatpagefraction +The minimum fraction of a float page that must be occupied by floats; +default ‘.5’. -\intextsep -Space above and below a float in the middle of the main text; default -‘12pt plus2pt minus2pt’ for ‘10pt’ and ‘11pt’ styles, -‘14pt plus4pt minus4pt’ for ‘12pt’. +\textfraction\textfraction +Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is ‘.2’. -\textfloatsep -Space between the last (first) float at the top (bottom) of a page; -default ‘20pt plus2pt minus4pt’. +\topfraction\topfraction +Maximum fraction at the top of a page that may be occupied before +floats; default ‘.7’. + +Parameters relating to vertical space around floats: -\textfraction -Minimum fraction of a page that must be text; if floats take up too -much space to preserve this much text, floats will be moved to a -different page. The default is ‘.2’. +\floatsep\floatsep +Space between floats at the top or bottom of a page; default +‘12pt plus2pt minus2pt’. -\topfraction -Maximum fraction at the top of a page that may be occupied before -floats; default is ‘.7’. +\intextsep\intextsep +Space above and below a float in the middle of the main text; default +‘12pt plus2pt minus2pt’ for ‘10pt’ and ‘11pt’ styles, +‘14pt plus4pt minus4pt’ for ‘12pt’. + +\textfloatsep\textfloatsep +Space between the last (first) float at the top (bottom) of a page; +default ‘20pt plus2pt minus4pt’. + +Parameters relating to the number of floats on a page: + +\bottomnumber\bottomnumber +Maximum number of floats that can appear at the bottom of a text page; +default 1. + +\topnumber\topnumber +Maximum number of floats that can appear at the top of a text page; +default 2. + +\totalnumber\totalnumber +Maximum number of floats that can appear on a text page; default 3. + +The principal &tex; FAQ entry relating to floats: +http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats. - - - + <literal>flushleft</literal> -flushleft environmentleft-justifying text, environment forragged right text, environment for +flushleft environment +left-justifying text, environment for +ragged right text, environment for + \begin{flushleft} line1 \\ line2 \\ ... \end{flushleft} -\\ for flushleftThe flushleft environment allows you to create a paragraph +\\ for flushleft +The flushleft environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged right Each line must be terminated with the string \\. - + <literal>\raggedright</literal> -\raggedrightragged right textleft-justifying textjustification, ragged right +\raggedright +ragged right text +left-justifying text +justification, ragged right + The \raggedright declaration corresponds to the flushleft environment. This declaration can be used inside an environment such as quote or in a parbox. Unlike the flushleft environment, the \raggedright command does not start a new paragraph; it only changes how &latex; -formats paragraph units. To affect a paragraph unit's format, the +formats paragraph units. To affect a paragraph unit’s format, the scope of the declaration must contain the blank line or \end command that ends the paragraph unit. - + <literal>flushright</literal> -flushright environmentragged left text, environment forright-justifying text, environment for +flushright environment +ragged left text, environment for +right-justifying text, environment for + \begin{flushright} line1 \\ line2 \\ ... \end{flushright} -\\ (for flushright)The flushright environment allows you to create a paragraph +\\ (for flushright) +The flushright environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged left. Each line must be terminated with the string \\. - + <literal>\raggedleft</literal> -\raggedleftragged left textjustification, ragged leftright-justifying text +\raggedleft +ragged left text +justification, ragged left +right-justifying text + The \raggedleft declaration corresponds to the flushright environment. This declaration can be used inside an environment such as quote or in a parbox. Unlike the flushright environment, the \raggedleft command does not start a new paragraph; it only changes how &latex; -formats paragraph units. To affect a paragraph unit's format, the +formats paragraph units. To affect a paragraph unit’s format, the scope of the declaration must contain the blank line or \end command that ends the paragraph unit. - + <literal>itemize</literal> -itemize environment\itemlists of itemsunordered listsbulleted lists +itemize environment +\item +lists of items +unordered lists +bulleted lists + Synopsis: \begin{itemize} @@ -1267,40 +1569,47 @@ command that ends the paragraph unit. ... \end{itemize} -The itemize environment produces an “unordered”, “bulleted” +The itemize environment produces an “unordered”, “bulleted” list. Itemizations can be nested within one another, up to four levels deep. They can also be nested within other paragraph-making -environments, such as enumerate (see ). +environments, such as enumerate (see enumerate). Each item of an itemize list begins with an \item command. There must be at least one \item command within the environment. By default, the marks at each level look like this: - • (bullet) - - -- (bold en-dash) - - * (asterisk) - - . (centered dot, rendered here as a period) - - -\labelitemi\labelitemii\labelitemiii\labelitemivThe itemize environment uses the commands \labelitemi +• (bullet) +-- (bold en-dash) +* (asterisk) +. (centered dot, rendered here as a period) + +\labelitemi +\labelitemii +\labelitemiii +\labelitemiv +The itemize environment uses the commands \labelitemi through \labelitemiv to produce the default label. So, you can use \renewcommand to change the labels. For instance, to have the first level use diamonds: \renewcommand{\labelitemi}{$\diamond$} -\leftmargin\leftmargini\leftmarginii\leftmarginiii\leftmarginiv\leftmarginv\leftmarginviThe \leftmargini through \leftmarginvi parameters define +\leftmargin +\leftmargini +\leftmarginii +\leftmarginiii +\leftmarginiv +\leftmarginv +\leftmarginvi +The \leftmargini through \leftmarginvi parameters define the distance between the left margin of the enclosing environment and the left margin of the list. By convention, \leftmargin is set to the appropriate \leftmarginN when a new level of nesting is entered. -The defaults vary from ‘.5em’ (highest levels of nesting) to -‘2.5em’ (first level), and are a bit reduced in two-column mode. +The defaults vary from ‘.5em’ (highest levels of nesting) to +‘2.5em’ (first level), and are a bit reduced in two-column mode. This example greatly reduces the margin space for outermost lists: \setlength{\leftmargini}{1.25em} % default 2.5em @@ -1308,59 +1617,58 @@ This example greatly reduces the margin space for outermost lists: Some parameters that affect list formatting: -\itemindent -Extra indentation before each item in a list; default zero. +\itemindent\itemindent +Extra indentation before each item in a list; default zero. -\labelsep -Space between the label and text of an item; default ‘.5em’. +\labelsep\labelsep +Space between the label and text of an item; default ‘.5em’. -\labelwidth -Width of the label; default ‘2em’, or ‘1.5em’ in two-column mode. +\labelwidth\labelwidth +Width of the label; default ‘2em’, or ‘1.5em’ in two-column mode. -\listparindent -Extra indentation added to second and subsequent paragraphs within a -list item; default ‘0pt’. +\listparindent\listparindent +Extra indentation added to second and subsequent paragraphs within a +list item; default ‘0pt’. -\rightmargin -Horizontal distance between the right margin of the list and the -enclosing environment; default ‘0pt’, except in the quote, +\rightmargin\rightmargin +Horizontal distance between the right margin of the list and the +enclosing environment; default ‘0pt’, except in the quote, quotation, and verse environments, where it is set equal to \leftmargin. - Parameters affecting vertical spacing between list items (rather loose, by default). -\itemsep -Vertical space between items. The default is 2pt plus1pt +\itemsep\itemsep +Vertical space between items. The default is 2pt plus1pt minus1pt for 10pt documents, 3pt plus2pt minus1pt for 11pt, and 4.5pt plus2pt minus1pt for 12pt. -\parsep -Extra vertical space between paragraphs within a list item. Defaults +\parsep\parsep +Extra vertical space between paragraphs within a list item. Defaults are the same as \itemsep. -\topsep -Vertical space between the first item and the preceding paragraph. +\topsep\topsep +Vertical space between the first item and the preceding paragraph. For top-level lists, the default is 8pt plus2pt minus4pt for 10pt documents, 9pt plus3pt minus5pt for 11pt, and 10pt plus4pt minus6pt for 12pt. These are reduced for nested lists. -\partopsep -Extra space added to \topsep when the list environment starts a +\partopsep\partopsep +Extra space added to \topsep when the list environment starts a paragraph. The default is 2pt plus1pt minus1pt for 10pt documents, 3pt plus1pt minus1pt for 11pt, and 3pt plus2pt minus2pt for 12pt. - -\parskip exampleEspecially for lists with short items, it may be desirable to elide +\parskip example +Especially for lists with short items, it may be desirable to elide space between items. Here is an example defining an itemize* environment with no extra spacing between items, or between paragraphs within a single item (\parskip is not list-specific, -see ): +see \parskip): \newenvironment{itemize*}% {\begin{itemize}% @@ -1371,16 +1679,19 @@ see ): - + <literal>letter</literal> environment: writing letters letter -This environment is used for creating letters. See . + +This environment is used for creating letters. See Letters. - + <literal>list</literal> -listlists of items, generic +list +lists of items, generic + The list environment is a generic environment which is used for defining many of the more specific environments. It is seldom used in documents, but often in macros. @@ -1401,14 +1712,16 @@ spacing parameters for the list. This argument will most often be empty, i.e., {}, which leaves the default spacing. The width used for typesetting the list items is specified by -\linewidth (see ). +\linewidth (see Page layout parameters). - + <literal>math</literal> -math environmentin-line formulas +math environment +in-line formulas + Synopsis: \begin{math} @@ -1417,55 +1730,66 @@ empty, i.e., {}, which leaves the default spacing. The math environment inserts the given math within the running text. \(...\)) and $...$ are synonyms. -See . +See Math formulas. - + <literal>minipage</literal> -minipage environmentminipage, creating a +minipage environment +minipage, creating a + \begin{minipage}[position][height][inner-pos]{width} text \end{minipage} The minipage environment typesets its body text in a block that will not be broken across pages. This is similar to the -\parbox command (see ), but unlike \parbox, +\parbox command (see \parbox), but unlike \parbox, other paragraph-making environments can be used inside a minipage. -The arguments are the same as for \parbox (see ). +The arguments are the same as for \parbox (see \parbox). -indentation of paragraphs, in minipageparagraph indentation, in minipage\parindentBy default, paragraphs are not indented in the minipage +indentation of paragraphs, in minipage +paragraph indentation, in minipage +\parindent +By default, paragraphs are not indented in the minipage environment. You can restore indentation with a command such as \setlength{\parindent}{1pc} command. -footnotes in figuresfigures, footnotes inFootnotes in a minipage environment are handled in a way that is +footnotes in figures +figures, footnotes in +Footnotes in a minipage environment are handled in a way that is particularly useful for putting footnotes in figures or tables. A \footnote or \footnotetext command puts the footnote at the bottom of the minipage instead of at the bottom of the page, and it uses the \mpfootnote counter instead of the ordinary -footnote counter (see ). +footnote counter (see Counters). -However, don't put one minipage inside another if you are using +However, don’t put one minipage inside another if you are using footnotes; they may wind up at the bottom of the wrong minipage. - + <literal>picture</literal> -picturecreating picturespictures, creating +picture +creating pictures +pictures, creating + \begin{picture}(width,height)(x offset,y offset) -… picture commands … +… picture commands … \end{picture} -\unitlengthThe picture environment allows you to create just about any +\unitlength +The picture environment allows you to create just about any kind of picture you want containing text, lines, arrows and circles. You tell &latex; where to put things in the picture by specifying their coordinates. A coordinate is a number that may have a decimal -point and a minus sign—a number like 5, 0.3 or +point and a minus sign—a number like 5, 0.3 or -3.1416. A coordinate specifies a length in multiples of the unit length \unitlength, so if \unitlength has been set to 1cm, then the coordinate 2.54 specifies a length of 2.54 @@ -1483,7 +1807,7 @@ the parentheses serve to delimit the argument. The picture environment has one mandatory argument, which is a position. It specifies the size of the picture. The environment produces a rectangular box with width and height determined by this -argument's x- and y-coordinates. +argument’s x- and y-coordinates. The picture environment also has an optional position argument, following the size argument, that can change the @@ -1503,10 +1827,10 @@ origin at the lower-left corner. If you then want to modify your picture by shifting everything, you can just add the appropriate optional argument. -The environment's mandatory argument determines the nominal size of the +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 +off the page. The picture’s nominal size is used by &latex; in determining how much room to leave for it. Everything that appears in a picture is drawn by the \put @@ -1515,11 +1839,12 @@ command. The command \put (11.3,-.3){...} puts the object specified by ... in the -picture, with its reference point at coordinates (11.3,-.3). +picture, with its reference point at coordinates (11.3,-.3). The reference points for various objects will be described below. -lR boxThe \put command creates an LR box. You can put anything -that can go in an \mbox (see ) in the text argument of +lR box +The \put command creates an LR box. You can put anything +that can go in an \mbox (see \mbox) in the text argument of the \put command. When you do this, the reference point will be the lower left corner of the box. @@ -1527,9 +1852,10 @@ be the lower left corner of the box. - + <literal>\circle</literal> \circle + \circle[*]{diameter} The \circle command produces a circle with a diameter as close @@ -1540,9 +1866,10 @@ draws a solid circle. - + <literal>\makebox</literal> \makebox (picture) + \makebox(width,height)[position]{...} The \makebox command for the picture environment is similar to @@ -1552,27 +1879,27 @@ the normal \makebox command except that you must specify a The optional argument, [position], specifies the quadrant that your text appears in. You may select up to two of the following: -t -Moves the item to the top of the rectangle. +t +Moves the item to the top of the rectangle. -b -Moves the item to the bottom. +b +Moves the item to the bottom. -l -Moves the item to the left. +l +Moves the item to the left. -r -Moves the item to the right. +r +Moves the item to the right. - -See . +See \makebox. - + <literal>\framebox</literal> \framebox + Synopsis: \framebox(width,height)[pos]{...} @@ -1581,16 +1908,19 @@ your text appears in. You may select up to two of the following: section), except that it puts a frame around the outside of the box that it creates. -\fboxrule\fboxsepThe \framebox command produces a rule of thickness +\fboxrule +\fboxsep +The \framebox command produces a rule of thickness \fboxrule, and leaves a space \fboxsep between the rule and the contents of the box. - + <literal>\dashbox</literal> \dashbox + Draws a box with a dashed line. Synopsis: \dashbox{dlen}(rwidth,rheight)[pos]{text} @@ -1605,9 +1935,10 @@ multiples of the dlen. - + <literal>\frame</literal> \frame + Synopsis: \frame{text} @@ -1618,9 +1949,10 @@ space is put between the frame and the object. - + <literal>\line</literal> \line + Synopsis: \line(xslope,yslope){length} @@ -1628,16 +1960,17 @@ space is put between the frame and the object. The \line command draws a line with the given length and slope xslope/yslope. -Standard &latex; can only draw lines with slope = x/y, -where x and y have integer values from −6 -through 6. For lines of any slope, not to mention other shapes, +Standard &latex; can only draw lines with slope = x/y, +where x and y have integer values from −6 +through 6. For lines of any slope, not to mention other shapes, see the curve2e and many many other packages on CTAN. - + <literal>\linethickness</literal> \linethickness + The \linethickness{dim} command declares the thickness of horizontal and vertical lines in a picture environment to be dim, which must be a positive length. @@ -1647,40 +1980,44 @@ circles, or the quarter circles drawn by \oval. - + <literal>\thicklines</literal> \thicklines + The \thicklines command is an alternate line thickness for horizontal and vertical lines in a picture environment; -cf.  and . +cf. \linethickness and \thinlines. - + <literal>\thinlines</literal> \thinlines + The \thinlines command is the default line thickness for horizontal and vertical lines in a picture environment; -cf.  and . +cf. \linethickness and \thicklines. - + <literal>\multiput</literal> \multiput + Synopsis: \multiput(x,y)(delta_x,delta_y){n}{obj} The \multiput command copies the object obj in a regular pattern across a picture. obj is first placed at position -(x,y), then at (x+\delta x,y+\delta y), and so on, +(x,y), then at (x+\delta x,y+\delta y), and so on, n times. - + <literal>\oval</literal> \oval + Synopsis: \oval(width,height)[portion] @@ -1689,26 +2026,26 @@ pattern across a picture. obj is first placed at pos The optional argument portion allows you to select part of the oval via the following: -t -selects the top portion; -b -selects the bottom portion; -r -selects the right portion; -l -selects the left portion. +t +selects the top portion; +b +selects the bottom portion; +r +selects the right portion; +l +selects the left portion. - -The “corners” of the oval are made with quarter circles with a -maximum radius of 20pt, so large “ovals” will look more like +The “corners” of the oval are made with quarter circles with a +maximum radius of 20pt, so large “ovals” will look more like boxes with rounded corners. - + <literal>\put</literal> \put + \put(x coord,y coord){ ... } The \put command places the item specified by the mandatory @@ -1716,9 +2053,10 @@ argument at the given coordinates. - + <literal>\shortstack</literal> \shortstack + Synopsis: \shortstack[position]{...\\...\\...} @@ -1726,36 +2064,41 @@ argument at the given coordinates. The \shortstack command produces a stack of objects. The valid positions are: -r -Move the objects to the right of the stack. -l -Move the objects to the left of the stack -c -Move the objects to the centre of the stack (default) +r +Move the objects to the right of the stack. +l +Move the objects to the left of the stack +c +Move the objects to the centre of the stack (default) - -\\ (for \shortstack objects)Objects are separated with \\. +\\ (for \shortstack objects) +Objects are separated with \\. - + <literal>\vector</literal> \vector + Synopsis: \vector(x-slope,y-slope){length} The \vector command draws a line with an arrow of the specified -length and slope. The x and y values must lie between -−4 and +4, inclusive. +length and slope. The x and y values must lie between +−4 and +4, inclusive. - + <literal>quotation</literal> -quotationquoted text with paragraph indentation, displayingdisplaying quoted text with paragraph indentationparagraph indentations in quoted text +quotation +quoted text with paragraph indentation, displaying +displaying quoted text with paragraph indentation +paragraph indentations in quoted text + Synopsis: \begin{quotation} @@ -1771,10 +2114,14 @@ normally. - + <literal>quote</literal> -quotequoted text without paragraph indentation, displayingdisplaying quoted text without paragraph indentationparagraph indentations in quoted text, omitting +quote +quoted text without paragraph indentation, displaying +displaying quoted text without paragraph indentation +paragraph indentations in quoted text, omitting + Snyopsis: \begin{quote} @@ -1789,10 +2136,14 @@ blank line between text produces a new paragraph. - + <literal>tabbing</literal> -tabbing environmenttab stops, usinglining text up in columns using tab stopsalignment via tabbing +tabbing environment +tab stops, using +lining text up using tab stops +alignment via tabbing + Synopsis: \begin{tabbing} @@ -1811,67 +2162,71 @@ environment. The following commands can be used inside a tabbing enviroment: -\\ (tabbing) -End a line. +\\ (tabbing)\\ (tabbing) +End a line. -\= (tabbing) -Sets a tab stop at the current position. +\= (tabbing)\= (tabbing) +Sets a tab stop at the current position. -\> (tabbing) -\>Advances to the next tab stop. +\> (tabbing)\> (tabbing) +\> +Advances to the next tab stop. -\< -Put following text to the left of the local margin (without changing +\<\< +Put following text to the left of the local margin (without changing the margin). Can only be used at the start of the line. -\+ -Moves the left margin of the next and all the +\+\+ +Moves the left margin of the next and all the following commands one tab stop to the right, beginning tabbed line if necessary. -\- -Moves the left margin of the next and all the +\-\- +Moves the left margin of the next and all the following commands one tab stop to the left, beginning tabbed line if necessary. -\' (tabbing) -Moves everything that you have typed so far in the +\’ (tabbing)\' (tabbing) +Moves everything that you have typed so far in the current column, i.e. everything from the most recent \>, \<, \', \\, or \kill command, to the right -of the previous column, flush against the current column's tab stop. +of the previous column, flush against the current column’s tab stop. -\` (tabbing) -Allows you to put text flush right against any tab stop, including tab -stop 0. However, it can't move text to the right of the last column -because there's no tab stop there. The \` command moves all the +\‘ (tabbing)\` (tabbing) +Allows you to put text flush right against any tab stop, including tab +stop 0. However, it can’t move text to the right of the last column +because there’s no tab stop there. The \` command moves all the text that follows it, up to the \\ or \end{tabbing} command that ends the line, to the right margin of the tabbing environment. There must be no \> or \' command between the \` and the command that ends the line. -\a (tabbing) -\a' (acute accent in tabbing)\a` (grave accent in tabbing)\a= (macron accent in tabbing)In a tabbing environment, the commands \=, \' and -\` do not produce accents as usual (see ). Instead, +\a (tabbing)\a (tabbing) +\a’ (acute accent in tabbing) +\a‘ (grave accent in tabbing) +\a= (macron accent in tabbing) +In a tabbing environment, the commands \=, \' and +\` do not produce accents as usual (see Accents). Instead, the commands \a=, \a' and \a` are used. -\kill -Sets tab stops without producing text. Works just like \\ +\kill\kill +Sets tab stops without producing text. Works just like \\ except that it throws away the current line instead of producing output for it. The effect of any \=, \+ or \- commands in that line remain in effect. -\poptabs -\poptabsRestores the tab stop positions saved by the last \pushtabs. +\poptabs\poptabs +\poptabs +Restores the tab stop positions saved by the last \pushtabs. -\pushtabs -Saves all current tab stop positions. Useful for temporarily changing +\pushtabs\pushtabs +Saves all current tab stop positions. Useful for temporarily changing tab stop positions in the middle of a tabbing environment. -\tabbingsep -Distance to left of tab stop moved by \'. +\tabbingsep\tabbingsep +Distance to left of tab stop moved by \'. - This example typesets a Pascal function in a traditional format: \begin{tabbing} @@ -1886,10 +2241,13 @@ function \= fact(n : integer) : integer;\\ - + <literal>table</literal> -tabletables, creatingcreating tables +table +tables, creating +creating tables + Synopsis: \begin{table}[placement] @@ -1900,13 +2258,13 @@ function \= fact(n : integer) : integer;\\ \end{table} Tables are objects that are not part of the normal text, and are -usually “floated” to a convenient place, like the top of a page. +usually “floated” to a convenient place, like the top of a page. Tables will not be split between two pages. The optional argument [placement] determines where &latex; will try to place your table. There are four places where &latex; can possibly put a float; these are the same as that used with the figure -environment, and described there (see ). +environment, and described there (see figure). The standard report and article classes use the default placement [tbp]. @@ -1916,9 +2274,12 @@ you wish. The \caption command allows you to title your tabl - + <literal>tabular</literal> -tabular environmentlines in tableslining text up in tables +tabular environment +lines in tables +lining text up in tables + Synopsis: \begin{tabular}[pos]{cols} @@ -1926,7 +2287,7 @@ column 1 entry & column 2 entry ... & column n entry \\ ... \end{tabular} - or +or \begin{tabular*}{width}[pos]{cols} column 1 entry & column 2 entry ... & column n entry \\ @@ -1936,109 +2297,110 @@ column 1 entry & column 2 entry ... & column n entry \\ These environments produce a box consisting of a sequence of rows of items, aligned vertically in columns. -\\ for tabular\\ must be used to specify the end of each row of the table, -except for the last, where it is optional—unless an \hline +\\ for tabular +\\ must be used to specify the end of each row of the table, +except for the last, where it is optional—unless an \hline command (to put a rule below the table) follows. The mandatory and optional arguments consist of: -width -Specifies the width of the tabular* environment. There must be +width +Specifies the width of the tabular* environment. There must be rubber space between columns that can stretch to fill out the specified width. -pos -Specifies the vertical position; default is alignment on the centre of +pos +Specifies the vertical position; default is alignment on the centre of the environment. -t -align on top row -b -align on bottom row +t +align on top row + +b +align on bottom row - -cols -Specifies the column formatting. It consists of a sequence of the +cols +Specifies the column formatting. It consists of a sequence of the following specifiers, corresponding to the sequence of columns and intercolumn material. -l -A column of left-aligned items. +l +A column of left-aligned items. -r -A column of right-aligned items. +r +A column of right-aligned items. -c -A column of centered items. +c +A column of centered items. -| -A vertical line the full height and depth of the environment. +| +A vertical line the full height and depth of the environment. -@{text} -This inserts text in every row. An @-expression suppresses the +@{text} +This inserts text in every row. An @-expression suppresses the intercolumn space normally inserted between columns; any desired space -between the inserted text and the adjacent items must be included in -text. An \extracolsep{wd} command in an @-expression -causes an extra space of width wd to appear to the left of all -subsequent columns, until countermanded by another \extracolsep -command. Unlike ordinary intercolumn space, this extra space is not -suppressed by an @-expression. An \extracolsep command can be -used only in an @-expression in the cols argument. - -p{wd} -Produces a column with each item typeset in a parbox of width +before the adjacent item must be included in text. + +To insert commands that are automatically executed before a given +column, you have to load the array package and use the +>{...} specifier. + + +\extracolsep +An \extracolsep{wd} command in an @-expression causes an +extra space of width wd to appear to the left of all subsequent +columns, until countermanded by another \extracolsep command. +Unlike ordinary intercolumn space, this extra space is not suppressed +by an @-expression. An \extracolsep command can be used only +in an @-expression in the cols argument. + +p{wd} +Produces a column with each item typeset in a parbox of width wd, as if it were the argument of a \parbox[t]{wd} command. However, a \\ may not appear in the item, except in the following situations: - -inside an environment like minipage, array, or tabular. - - -inside an explicit \parbox. - - -in the scope of a \centering, \raggedright, or \raggedleft +inside an environment like minipage, array, or tabular. +inside an explicit \parbox. +in the scope of a \centering, \raggedright, or \raggedleft declaration. The latter declarations must appear inside braces or an environment when used in a p-column element. - - -*{num}{cols} -Equivalent to num copies of cols, where num is a + +*{num}{cols} +Equivalent to num copies of cols, where num is a positive integer and cols is any list of column-specifiers, which may contain another *-expression. - - - + Parameters that control formatting: -\arrayrulewidth -Thickness of the rule created by |, \hline, and +\arrayrulewidth\arrayrulewidth +Thickness of the rule created by |, \hline, and \vline in the tabular and array environments; the -default is ‘.4pt’. +default is ‘.4pt’. -\arraystretch -Scaling of spacing between rows in the tabular and array -environments; default is ‘1’, for no scaling. +\arraystretch\arraystretch +Scaling of spacing between rows in the tabular and array +environments; default is ‘1’, for no scaling. -\doublerulesep -Horizontal distance between the vertical rules produced by || -in the tabular and array environments; default is ‘2pt’. +\doublerulesep\doublerulesep +Horizontal distance between the vertical rules produced by || +in the tabular and array environments; default is ‘2pt’. -\tabcolsep -Half the width of the space between columns; default is ‘6pt’. +\tabcolsep\tabcolsep +Half the width of the space between columns; default is ‘6pt’. - -These commands can be used inside a tabular environment: +The following commands can be used inside a tabular +environment: - + <literal>\multicolumn</literal> \multicolumn + Synopsis: \multicolumn{cols}{pos}{text} @@ -2049,7 +2411,7 @@ specifies the formatting of the entry; c for centered, r for flushright. The third mandatory argument, text, specifies what text to put in the entry. -Here's an example showing two columns separated by an en-dash; +Here’s an example showing two columns separated by an en-dash; \multicolumn is used for the heading: \begin{tabular}{r@{--}l} @@ -2061,9 +2423,10 @@ for flushleft, r for flushright. The third mandatory argumen - + <literal>\cline</literal> \cline + Synopsis: \cline{i-j} @@ -2074,19 +2437,21 @@ which are specified in the mandatory argument. - + <literal>\hline</literal> \hline + The \hline command draws a horizontal line the width of the -enclosing tabular or array environment. It's most +enclosing tabular or array environment. It’s most commonly used to draw a line at the top, bottom, and between the rows of a table. - + <literal>\vline</literal> \vline + The \vline command will draw a vertical line extending the full height and depth of its row. An \hfill command can be used to move the line to the edge of the column. It can also be used in an @@ -2095,10 +2460,12 @@ move the line to the edge of the column. It can also be used in an - + <literal>thebibliography</literal> -thebibliographybibliography, creating (manually) +thebibliography +bibliography, creating (manually) + Synopsis: \begin{thebibliography}{widest-label} @@ -2110,8 +2477,8 @@ move the line to the edge of the column. It can also be used in an reference list. In the article class, this reference list is labelled -“References”; in the report class, it is labelled -“Bibliography”. You can change the label (in the standard classes) +“References”; in the report class, it is labelled +“Bibliography”. You can change the label (in the standard classes) by redefining the command \refname. For instance, this eliminates it entirely: @@ -2124,10 +2491,11 @@ less than 10 references, 99 for ones with less than 100, etc. - + <literal>\bibitem</literal> \bibitem + Synopsis: \bibitem[label]{cite_key} @@ -2138,18 +2506,19 @@ automatically generated using the enumi counter. The symbols not containing a comma. This command writes an entry to the .aux file containing the -item's cite_key and label. When the .aux file is read by -the \begin{document} command, the item's label is +item’s cite_key and label. When the .aux file is read by +the \begin{document} command, the item’s label is associated with cite_key, causing references to cite_key with a \cite command (see next section) to produce the associated label. - + <literal>\cite</literal> \cite + Synopsis: \cite[subcite]{keys @@ -2161,13 +2530,14 @@ the references associated with keys by entries in the The text of the optional subcite argument appears after the citation. For example, \cite[p.~314]{knuth} might produce -`[Knuth, p. 314]'. +‘[Knuth, p. 314]’. - + <literal>\nocite</literal> \nocite + \nocite{key_list} The \nocite command produces no text, but writes key_list, @@ -2178,11 +2548,16 @@ which is a list of one or more citation keys, on the .aux f Using Bib&tex; -using Bib&tex;bib&tex;, usingbibliography, creating (automatically)\bibliographystyle\bibliography +using Bib&tex; +bib&tex;, using +bibliography, creating (automatically) +\bibliographystyle +\bibliography + If you use the Bib&tex; program by Oren Patashnik (highly recommended if you need a bibliography of more than a couple of -titles) to maintain your bibliography, you don't use the -thebibliography environment (see ). Instead, +titles) to maintain your bibliography, you don’t use the +thebibliography environment (see thebibliography). Instead, you include the lines \bibliographystyle{bibstyle} @@ -2194,17 +2569,16 @@ be produced: bibstyle refers to a file bibstyle.bst, which defines how your citations will look. The standard style names distributed with Bib&tex; are: -alpha -Sorted alphabetically. Labels are formed from name of author and year of +alpha +Sorted alphabetically. Labels are formed from name of author and year of publication. -plain -Sorted alphabetically. Labels are numeric. -unsrt -Like plain, but entries are in order of citation. -abbrv -Like plain, but more compact labels. +plain +Sorted alphabetically. Labels are numeric. +unsrt +Like plain, but entries are in order of citation. +abbrv +Like plain, but more compact labels. - In addition, numerous other Bib&tex; style files exist tailored to the demands of various publications. See http://www.ctan.org/tex-archive/biblio/bibtex/contrib. @@ -2218,27 +2592,32 @@ Bib&tex; format. Only the entries referred to via \cite and - + <literal>theorem</literal> -theorem environmenttheorems, typesetting +theorem environment +theorems, typesetting + Synopsis: \begin{theorem} theorem-text \end{theorem} -The theorem environment produces “Theorem n” in +The theorem environment produces “Theorem n” in boldface followed by theorem-text, where the numbering possibilities for n are described under \newtheorem -(see ). +(see \newtheorem). - + <literal>titlepage</literal> -titlepage environmentmaking a title pagetitle pages, creating +titlepage environment +making a title page +title pages, creating + Synopsis: \begin{titlepage} @@ -2249,17 +2628,23 @@ possibilities for n are described under \new with no printed page number or heading. It also causes the following page to be numbered page one. Formatting the title page is left to you. The \today command may be useful on title pages -(see ). +(see \today). -You can use the \maketitle command (see ) to +You can use the \maketitle command (see \maketitle) to produce a standard title page without a titlepage environment. - + <literal>verbatim</literal> -verbatim environmentverbatim textsimulating typed texttyped text, simulatingcode, typesettingcomputer programs, typesetting +verbatim environment +verbatim text +simulating typed text +typed text, simulating +code, typesetting +computer programs, typesetting + Synopsis: \begin{verbatim} @@ -2268,17 +2653,19 @@ produce a standard title page without a titlepage environment The verbatim environment is a paragraph-making environment in which &latex; produces exactly what you type in; for instance the -\ character produces a printed ‘\’. It turns &latex; +\ character produces a printed ‘\’. It turns &latex; into a typewriter with carriage returns and blanks having the same effect that they would on a typewriter. The verbatim uses a monospaced typewriter-like font (\tt). - + <literal>\verb</literal> -\verbverbatim text, inline +\verb +verbatim text, inline + Synopsis: \verbcharliteral-textchar @@ -2290,16 +2677,19 @@ including special characters and spaces, using the typewriter \verb* and the delimiter char, which begins and ends the verbatim text. The delimiter must not appear in literal-text. -visible spaceThe *-form differs only in that spaces are printed with a -“visible space” character. +visible space +The *-form differs only in that spaces are printed with a +“visible space” character. - + <literal>verse</literal> -verse environmentpoetry, an environment for +verse environment +poetry, an environment for + Synopsis: \begin{verse} @@ -2311,7 +2701,8 @@ verbatim text. The delimiter must not appear in literal-textThe verse environment is designed for poetry, though you may find other uses for it. -\\ for verseThe margins are indented on the left and the right, paragraphs are not +\\ for verse +The margins are indented on the left and the right, paragraphs are not indented, and the text is not justified. Separate the lines of each stanza with \\, and use one or more blank lines to separate the stanzas. @@ -2321,7 +2712,9 @@ stanzas. Line breaking -line breakingbreaking lines +line breaking +breaking lines + The first thing &latex; does when processing ordinary text is to translate your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines @@ -2333,9 +2726,12 @@ some environments, you do the line breaking yourself with the - + <literal>\\</literal>[*][<replaceable>morespace</replaceable>] -\\ force line breaknew line, startingline break, forcing +\\ force line break +new line, starting +line break, forcing + The \\ command tells &latex; to start a new line. It has an optional argument, morespace, that specifies how much extra vertical space is to be inserted before the next line. This can be a @@ -2346,11 +2742,14 @@ except that it tells &latex; not to start a new page after the line. - + <literal>\obeycr</literal> & <literal>\restorecr</literal> -\obeycr\restorecrnew line, output as input +\obeycr +\restorecr +new line, output as input + The \obeycr command makes a return in the input file -(‘^^M’, internally) the same as \\ (followed by +(‘^^M’, internally) the same as \\ (followed by \relax). So each new line in the input will also be a new line in the output. @@ -2358,18 +2757,22 @@ in the output. - + <literal>\newline</literal> -\newlinenew line, starting (paragraph mode) +\newline +new line, starting (paragraph mode) + The \newline command breaks the line at the present point, with no stretching of the text before it. It can only be used in paragraph mode. - + <literal>\-</literal> (discretionary hyphen) -\- (hyphenation)hyphenation, forcing +\- (hyphenation) +hyphenation, forcing + The \- command tells &latex; that it may hyphenate the word at that point. &latex; is very good at hyphenating, and it will usually find most of the correct hyphenation points, and almost never use an @@ -2383,32 +2786,35 @@ that &latex; might otherwise have chosen. - + <literal>\fussy</literal> \fussy + The declaration \fussy (which is the default) makes &tex; picky about line breaking. This usually avoids too much space between words, at the cost of an occasional overfull box. This command cancels the effect of a previous \sloppy command -(see . +(see \sloppy. - + <literal>\sloppy</literal> The declaration \sloppy makes &tex; less fussy about line breaking. This will avoid overfull boxes, at the cost of loose interword spacing. -Lasts until a \fussy command is issued (see ). +Lasts until a \fussy command is issued (see \fussy). - + <literal>\hyphenation</literal> -\hyphenationhyphenation, defining +\hyphenation +hyphenation, defining + Synopsis: \hyphenation{word-one word-two} @@ -2424,9 +2830,13 @@ misses the hyphenations in these words): - + <literal>\linebreak</literal> & <literal>\nolinebreak</literal> -\linebreak\nolinebreakline breaks, forcingline breaks, preventing +\linebreak +\nolinebreak +line breaks, forcing +line breaks, preventing + Synopses: \linebreak[priority] @@ -2439,24 +2849,28 @@ extends to the right margin as usual. With the optional argument priority, you can convert the command from a demand to a request. The priority must be a number from -0 to 4. The higher the number, the more insistent the request. +0 to 4. The higher the number, the more insistent the request. Page breaking -page breakingbreaking pages +page breaking +breaking pages + &latex; starts new pages asynchronously, when enough material has accumulated to fill up a page. Usually this happens automatically, but sometimes you may want to influence the breaks. - + <literal>\cleardoublepage</literal> -\cleardoublepagestarting on a right-hand page +\cleardoublepage +starting on a right-hand page + The \cleardoublepage command ends the current page and causes all figures and tables that have so far appeared in the input to be printed. In a two-sided printing style, it also makes the next page a right-hand @@ -2464,25 +2878,33 @@ In a two-sided printing style, it also makes the next page a right-hand - + <literal>\clearpage</literal> -\clearpageflushing floats and starting a pagestarting a new page and clearing floats +\clearpage +flushing floats and starting a page +starting a new page and clearing floats + The \clearpage command ends the current page and causes all figures and tables that have so far appeared in the input to be printed. - + <literal>\newpage</literal> -\newpagenew page, startingstarting a new page +\newpage +new page, starting +starting a new page + The \newpage command ends the current page, but does not clear floats (see \clearpage above). - + <literal>\enlargethispage</literal> -\enlargethispageenlarge current page +\enlargethispage +enlarge current page + \enlargethispage{size} \enlargethispage*{size} @@ -2497,22 +2919,26 @@ much as possible. This is normally used together with an explicit - + <literal>\pagebreak</literal> & <literal>\nopagebreak</literal> -\pagebreak\nopagebreakpage break, forcingpage break, preventing +\pagebreak +\nopagebreak +page break, forcing +page break, preventing + Synopses: \pagebreak[priority] \nopagebreak[priority] By default, the \pagebreak (\nopagebreak) command forces -(prevents) a page break at the current position. For -\linebreak, the vertical space on the page is stretched out +(prevents) a page break at the current position. With +\pagebreak, the vertical space on the page is stretched out where possible so that it extends to the normal bottom margin. With the optional argument priority, you can convert the \pagebreak command from a demand to a request. The number must -be a number from 0 to 4. The higher the number, the more +be a number from 0 to 4. The higher the number, the more insistent the request is. @@ -2521,6 +2947,7 @@ insistent the request is. Footnotes footnotes, creating + Footnotes can be produced in one of two ways. They can be produced with one command, the \footnote command. They can also be produced with two commands, the \footnotemark and the @@ -2528,9 +2955,10 @@ produced with two commands, the \footnotemark and the - + <literal>\footnote</literal> \footnote + Synopsis: \footnote[number]{text} @@ -2546,9 +2974,10 @@ tables or in a tabular environment. (See following sections. - + <literal>\footnotemark</literal> \footnotemark + With no optional argument, the \footnotemark command puts the current footnote number in the text. This command can be used in inner paragraph mode. You give the text of the footnote separately, @@ -2563,9 +2992,10 @@ markers referring to the same footnote with - + <literal>\footnotetext</literal> \footnotetext + Synopsis: \footnotetext[number]{text} @@ -2582,14 +3012,17 @@ appear in outer paragraph mode. Symbolic footnotes -footnotes, symbolic instead of numberedIf you want to use symbols for footnotes, rather than increasing +footnotes, symbolic instead of numbered +If you want to use symbols for footnotes, rather than increasing numbers, redefine \thefootnote like this: \renewcommand{\thefootnote}{\fnsymbol{footnote}} -\fnsymbol, and footnotes\@fnsymbolThe \fnsymbol command produces a predefined series of symbols -(see ). If you want to -use a different symbol as your footnote mark, you'll need to also +\fnsymbol, and footnotes +\@fnsymbol +The \fnsymbol command produces a predefined series of symbols +(see \alph \Alph \arabic \roman \Roman \fnsymbol). If you want to +use a different symbol as your footnote mark, you’ll need to also redefine \@fnsymbol. @@ -2597,37 +3030,43 @@ redefine \@fnsymbol. Footnote parameters -footnote parametersparameters, for footnotes -\footnoterule -Produces the rule separating the main text on a page from the page's +footnote parameters +parameters, for footnotes + +\footnoterule\footnoterule +Produces the rule separating the main text on a page from the page’s footnotes. Default dimensions: 0.4pt thick (or wide), and 0.4\columnwidth long in the standard document classes (except slides, where it does not appear). -\footnotesep -The height of the strut placed at the beginning of the footnote. By +\footnotesep\footnotesep +The height of the strut placed at the beginning of the footnote. By default, this is set to the normal strut for \footnotesize -fonts (see ), therefore there is no extra space between -footnotes. This is ‘6.65pt’ for ‘10pt’, ‘7.7pt’ for -‘11pt’, and ‘8.4pt’ for ‘12pt’. +fonts (see Font sizes), therefore there is no extra space between +footnotes. This is ‘6.65pt’ for ‘10pt’, ‘7.7pt’ for +‘11pt’, and ‘8.4pt’ for ‘12pt’. - Definitions definitions + &latex; has support for making new commands of many different kinds. - + <literal>\newcommand</literal> & <literal>\renewcommand</literal> -\newcommandcommands, defining new onesdefining a new commandnew commands, defining +\newcommand +commands, defining new ones +defining a new command +new commands, defining + \newcommand and \renewcommand define and redefine a command, respectively. Synopses: @@ -2637,35 +3076,36 @@ command, respectively. Synopses: \renewcommand{cmd}[nargs][default]{defn} -cmd -The command name beginning with \. For \newcommand, it +cmd +The command name beginning with \. For \newcommand, it must not be already defined and must not begin with \end; for \renewcommand, it must already be defined. -nargs -An optional integer from 1 to 9 specifying the number of arguments +nargs +An optional integer from 1 to 9 specifying the number of arguments that the command will take. The default is for the command to have no arguments. -default -If this optional parameter is present, it means that the command's +default +If this optional parameter is present, it means that the command’s first argument is optional. When the new command is called, the default value of the optional argument (i.e., if it is not specified -in the call) is the string ‘def’. +in the call) is the string ‘def’. -defn -The text to be substituted for every occurrence of cmd; a +defn +The text to be substituted for every occurrence of cmd; a construct of the form #n in defn is replaced by the text of the nth argument. - - + <literal>\newcounter</literal> -\newcountercounters, defining new +\newcounter +counters, defining new + Synopsis: \newcounter{cnt}[countername] @@ -2676,13 +3116,15 @@ The new counter is initialized to zero. Given the optional argument [countername], cnt will be reset whenever countername is incremented. -See , for more information about counters. +See Counters, for more information about counters. - + <literal>\newlength</literal> -\newlengthlengths, defining new +\newlength +lengths, defining new + Synopsis: \newlength{\arg} @@ -2692,14 +3134,15 @@ will be reset whenever countername is incremented. be a control sequence, as in \newlength{\foo}. An error occurs if \foo is already defined. -See , for how to set the new length to a nonzero value, and +See Lengths, for how to set the new length to a nonzero value, and for more information about lengths in general. - + <literal>\newsavebox</literal> \newsavebox + Synopsis: \newsavebox{cmd} @@ -2709,9 +3152,14 @@ defined, to refer to a new bin for storing boxes. - + <literal>\newenvironment</literal> & <literal>\renewenvironment</literal> -\newenvironment\renewenvironmentenvironments, definingdefining new environmentsredefining environments +\newenvironment +\renewenvironment +environments, defining +defining new environments +redefining environments + Synopses: \newenvironment{env}[nargs]{begdef}{enddef} @@ -2719,70 +3167,74 @@ defined, to refer to a new bin for storing boxes. \renewenvironment{env}[nargs]{begdef}{enddef} These commands define or redefine an environment env, that is, -\begin{env} … \end{env}. +\begin{env} … \end{env}. -env -The name of the environment. For \newenvironment, env +env +The name of the environment. For \newenvironment, env must not be an existing environment, and the command \env must be undefined. For \renewenvironment, env must be the name of an existing environment. -nargs -An integer from 1 to 9 denoting the number of arguments of +nargs +An integer from 1 to 9 denoting the number of arguments of the newly-defined environment. The default is no arguments. -default -If this is specified, the first argument is optional, and default +default +If this is specified, the first argument is optional, and default gives the default value for that argument. -begdef -The text expanded at every occurrence of \begin{env}; a +begdef +The text expanded at every occurrence of \begin{env}; a construct of the form #n in begdef is replaced by the text of the nth argument. -enddef -The text expanded at every occurrence of \end{env}. It +enddef +The text expanded at every occurrence of \end{env}. It may not contain any argument parameters. - - + <literal>\newtheorem</literal> -\newtheoremtheorems, definingdefining new theorems +\newtheorem +theorems, defining +defining new theorems + \newtheorem{newenv}{label}[within] \newtheorem{newenv}[numbered_like]{label} This command defines a theorem-like environment. Arguments: -newenv -The name of the environment to be defined; must not be the name of an +newenv +The name of the environment to be defined; must not be the name of an existing environment or otherwise defined. -label -The text printed at the beginning of the environment, before the -number. For example, ‘Theorem’. +label +The text printed at the beginning of the environment, before the +number. For example, ‘Theorem’. -numbered_like -(Optional.) The name of an already defined theorem-like environment; +numbered_like +(Optional.) The name of an already defined theorem-like environment; the new environment will be numbered just like numbered_like. -within -(Optional.) The name of an already defined counter, a sectional unit. +within +(Optional.) The name of an already defined counter, a sectional unit. The new theorem counter will be reset at the same time as the within counter. - At most one of numbered_like and within can be specified, not both. - + <literal>\newfont</literal> -\newfontfonts, new commands fordefining new fonts +\newfont +fonts, new commands for +defining new fonts + Synopsis: \newfont{cmd}{fontname} @@ -2796,28 +3248,32 @@ More commonly, fonts are defined in families through .fd fi - + <literal>\protect</literal> \protect -fragile commandsmoving argumentsFootnotes, line breaks, any command that has an optional argument, and + +fragile commands +moving arguments +Footnotes, line breaks, any command that has an optional argument, and many more are so-called fragile commands. When a fragile command is used in certain contexts, called moving arguments, it must be preceded by \protect. In addition, any fragile commands within the arguments must have their own \protect. Some examples of moving arguments are \caption -(see ), \thanks (see ), and +(see figure), \thanks (see \maketitle), and expressions in tabular and array environments -(see ). +(see tabular). -robust commandsCommands which are not fragile are called robust. They must not +robust commands +Commands which are not fragile are called robust. They must not be preceded by \protect. See also: -http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html -http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect - +http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html +http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect + @@ -2825,12 +3281,14 @@ be preceded by \protect. Counters -counters, a list ofvariables, a list of +counters, a list of +variables, a list of + Everything &latex; numbers for you has a counter associated with it. The name of the counter is the same as the name of the environment or command that produces the number, except with no \. -(enumi–enumiv are used for the nested enumerate -environment.) Below is a list of the counters used in &latex;'s +(enumi–enumiv are used for the nested enumerate +environment.) Below is a list of the counters used in &latex;’s standard document classes to control numbering. part paragraph figure enumi @@ -2841,43 +3299,45 @@ subsubsection - + <literal>\alph \Alph \arabic \roman \Roman \fnsymbol</literal>: Printing counters All of these commands take a single counter as an argument, for instance, \alph{enumi}. -\alph -prints counter using lowercase letters: `a', `b', …. +\alph\alph +prints counter using lowercase letters: ‘a’, ‘b’, ... -\Alph -uses uppercase letters: `A', `B', …. +\Alph\Alph +uses uppercase letters: ‘A’, ‘B’, ... -\arabic -uses Arabic numbers: `1', `2', …. +\arabic\arabic +uses Arabic numbers: ‘1’, ‘2’, ... -\roman -uses lowercase roman numerals: `i', `ii', …. +\roman\roman +uses lowercase roman numerals: ‘i’, ‘ii’, ... -\roman -uses uppercase roman numerals: `I', `II', …. +\roman\roman +uses uppercase roman numerals: ‘I’, ‘II’, ... -\fnsymbol -prints the value of counter in a specific sequence of nine +\fnsymbol\fnsymbol +prints the value of counter in a specific sequence of nine symbols (conventionally used for labeling footnotes). The value of -counter must be between 1 and 9, inclusive. +counter must be between 1 and 9, inclusive. -The symbols mostly aren't supported in Info, but here are the names: +The symbols mostly aren’t supported in Info, but here are the names: asterix(*) dagger ddagger section-sign paragraph-sign parallel double-asterix(**) double-dagger double-ddagger - - + <literal>\usecounter{<replaceable>counter</replaceable>}</literal> -\usecounterlist items, specifying counternumbered items, specifying counter +\usecounter +list items, specifying counter +numbered items, specifying counter + Synopsis: \usecounter{counter} @@ -2888,9 +3348,11 @@ the list items. - + <literal>\value{<replaceable>counter</replaceable>}</literal> -\valuecounters, getting value of +\value +counters, getting value of + Synopsis: \value{counter} @@ -2904,9 +3366,12 @@ be used anywhere &latex; expects a number, for example: - + <literal>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal> -\setcountercounters, settingsetting counters +\setcounter +counters, setting +setting counters + Synopsis: \setcounter{\counter}{value} @@ -2916,42 +3381,48 @@ be used anywhere &latex; expects a number, for example: - + <literal>\addtocounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal> \addtocounter + The \addtocounter command increments counter by the amount specified by the value argument, which may be negative. - + <literal>\refstepcounter{<replaceable>counter</replaceable>}</literal> \refstepcounter + The \refstepcounter command works in the same way as -\stepcounter See , except it also defines the +\stepcounter See \stepcounter, except it also defines the current \ref value to be the result of \thecounter. - + <literal>\stepcounter{<replaceable>counter</replaceable>}</literal> \stepcounter + The \stepcounter command adds one to counter and resets all subsidiary counters. - + <literal>\day \month \year</literal>: Predefined counters -\day\month\year +\day +\month +\year + &latex; defines counters for the day of the month (\day, -1–31), month of the year (\month, 1–12), and year +1–31), month of the year (\month, 1–12), and year (\year, Common Era). When &tex; starts up, they are set to the current values on the system where &tex; is running. They are not updated as the job progresses. The related command \today produces a string representing the -current day (see ). +current day (see \today). @@ -2959,14 +3430,17 @@ current day (see ). Lengths lengths, defining and using + A length is a measure of distance. Many &latex; commands take a length as an argument. - + <literal>\setlength{\<replaceable>len</replaceable>}{<replaceable>value</replaceable>}</literal> -\setlengthlengths, setting +\setlength +lengths, setting + The \setlength sets the value of \len to the value argument, which can be expressed in any units that &latex; understands, i.e., inches (in), millimeters (mm), points @@ -2974,18 +3448,21 @@ understands, i.e., inches (in), millimeters (mm - + \addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>} -\addtolengthlengths, adding to -The \addtolength command increments a “length command” +\addtolength +lengths, adding to + +The \addtolength command increments a “length command” \len by the amount specified in the amount argument, which may be negative. - + <literal>\settodepth</literal> \settodepth + \settodepth{\gnat}{text} The \settodepth command sets the value of a length command @@ -2993,9 +3470,10 @@ equal to the depth of the text argument. - + <literal>\settoheight</literal> \settoheight + \settoheight{\gnat}{text} The \settoheight command sets the value of a length command @@ -3004,29 +3482,35 @@ equal to the height of the text argument. - + <literal>\settowidth{\<replaceable>len</replaceable>}{<replaceable>text</replaceable>}</literal> \settowidth + The \settowidth command sets the value of the command \len to the width of the text argument. - Predefined lengths -lengths, predefinedpredefined lengths +lengths, predefined +predefined lengths + \width -\width +\width + \height -\height +\height + \depth -\depth +\depth + \totalheight -\totalheight +\totalheight + These length parameters can be used in the arguments of the box-making -commands (see ). They specify the natural width etc. of the -text in the box. \totalheight equals \height + +commands (see Boxes). They specify the natural width, etc., of +the text in the box. \totalheight equals \height + \depth. To make a box with the text stretched to double the natural size, e.g., say @@ -3037,17 +3521,22 @@ natural size, e.g., say Making paragraphs -making paragraphsparagraphs -A paragraph is ended by one or more completely blank lines—lines not +making paragraphs +paragraphs + +A paragraph is ended by one or more completely blank lines—lines not containing even a %. A blank line should not appear where a new paragraph cannot be started, such as in math mode or in the argument of a sectioning command. - + <literal>\indent</literal> -\indent\parindentindent, forcing +\indent +\parindent +indent, forcing + \indent produces a horizontal space whose width equals the width of the \parindent length, the normal paragraph indentation. It is used to add paragraph indentation where it would @@ -3059,18 +3548,22 @@ mode, otherwise 15pt for 10pt documents, < - + <literal>\noindent</literal> -\noindentindent, suppressing +\noindent +indent, suppressing + When used at the beginning of the paragraph, \noindent suppresses any paragraph indentation. It has no effect when used in the middle of a paragraph. - + <literal>\parskip</literal> -\parskipvertical space before paragraphs +\parskip +vertical space before paragraphs + \parskip is a rubber length defining extra vertical space added before each paragraph. The default is 0pt plus1pt. @@ -3078,7 +3571,11 @@ before each paragraph. The default is 0pt plus1pt. Marginal notes -marginal notesnotes in the marginremarks in the margin\marginpar +marginal notes +notes in the margin +remarks in the margin +\marginpar + Synopsis: \marginpar[left]{right} @@ -3090,17 +3587,13 @@ where the \marginpar occurs. When you only specify the mandatory argument right, the text will be placed - -in the right margin for one-sided layout; - - -in the outside margin for two-sided layout; - - -in the nearest margin for two-column layout. - - -\reversemarginpar\normalmarginparThe command \reversemarginpar places subsequent marginal notes +in the right margin for one-sided layout; +in the outside margin for two-sided layout; +in the nearest margin for two-column layout. + +\reversemarginpar +\normalmarginpar +The command \reversemarginpar places subsequent marginal notes in the opposite (inside) margin. \normalmarginpar places them in the default position. @@ -3112,22 +3605,21 @@ hyphenation there by beginning the node with \hspace{0pt}. These parameters affect the formatting of the note: -\marginparpush -Minimum vertical space between notes; default ‘7pt’ for -‘12pt’ documents, ‘5pt’ else. +\marginparpush\marginparpush +Minimum vertical space between notes; default ‘7pt’ for +‘12pt’ documents, ‘5pt’ else. -\marginparsep -Horizontal space between the main text and the note; default -‘11pt’ for ‘10pt’ documents, ‘10pt’ else. +\marginparsep\marginparsep +Horizontal space between the main text and the note; default +‘11pt’ for ‘10pt’ documents, ‘10pt’ else. -\marginparwidth -Width of the note itself; default for a one-sided ‘10pt’ document -is ‘90pt’, ‘83pt’ for ‘11pt’, and ‘68pt’ for -‘12pt’; ‘17pt’ more in each case for a two-sided document. -In two column mode, the default is ‘48pt’. +\marginparwidth\marginparwidth +Width of the note itself; default for a one-sided ‘10pt’ document +is ‘90pt’, ‘83pt’ for ‘11pt’, and ‘68pt’ for +‘12pt’; ‘17pt’ more in each case for a two-sided document. +In two column mode, the default is ‘48pt’. - The standard &latex; routine for marginal notes does not prevent notes from falling off the bottom of the page. @@ -3139,19 +3631,28 @@ notes from falling off the bottom of the page. Math formulas -math formulasformulas, mathmath mode, entering -math environmentdisplaymath environmentequation environmentThere are three environments that put &latex; in math mode: - -math -For formulas that appear right in the text. -displaymath -For formulas that appear on their own line. -equation -The same as the displaymath environment except that it adds an equation +math formulas +formulas, math +math mode, entering + +math environment +displaymath environment +equation environment +There are three environments that put &latex; in math mode: + +math +For formulas that appear right in the text. +displaymath +For formulas that appear on their own line. +equation +The same as the displaymath environment except that it adds an equation number in the right margin. - -\(\)\[\]The math environment can be used in both paragraph and LR mode, +\( +\) +\[ +\] +The math environment can be used in both paragraph and LR mode, but the displaymath and equation environments can be used only in paragraph mode. The math and displaymath environments are used so often that they have the following short forms: @@ -3159,18 +3660,22 @@ environments are used so often that they have the following short forms: \(...\) instead of \begin{math}...\end{math} \[...\] instead of \begin{displaymath}...\end{displaymath} -$In fact, the math environment is so common that it has an even +$ +In fact, the math environment is so common that it has an even shorter form: $ ... $ instead of \(...\) -\boldmath\unboldmathThe \boldmath command changes math letters and symbols to be in +\boldmath +\unboldmath +The \boldmath command changes math letters and symbols to be in a bold font. It is used outside of math mode. Conversely, the \unboldmath command changes math glyphs to be in a normal font; it too is used outside of math mode. -\displaystyleThe \displaystyle declaration forces the size and style of the +\displaystyle +The \displaystyle declaration forces the size and style of the formula to be that of displaymath, e.g., with limits above and below summations. For example $\displaystyle \sum_{n=0}^\infty x_n $ @@ -3179,12 +3684,17 @@ below summations. For example - + Subscripts & superscripts -superscriptsubscriptexponent_^ -To get an expression exp to appear as a subscript, you just type -_{exp}. To get exp to appear as a -superscript, you type ^{exp}. &latex; handles +superscript +subscript +exponent +_ +^ + +To get an expression exp to appear as a subscript, you just type +_{exp}. To get exp to appear as a +superscript, you type ^{exp}. &latex; handles superscripted superscripts and all of that stuff in the natural way. It even does the right thing when something has both a subscript and a superscript. @@ -3193,915 +3703,953 @@ superscript. Math symbols -math symbolssymbols, mathgreek letters -&latex; provides almost any mathematical symbol you're likely to +math symbols +symbols, math +greek letters + +&latex; provides almost any mathematical symbol you’re likely to need. The commands for generating them can be used only in math mode. For example, if you include $\pi$ in your source, you will get -the pi symbol (\pi) in your output. +the pi symbol (\pi) in your output. -\| -\| +\|\| +\| -\aleph -\aleph +\aleph\aleph +\aleph -\alpha -\alpha +\alpha\alpha +\alpha -\amalg -\amalg (binary operation) +\amalg\amalg +\amalg (binary operation) -\angle -\angle +\angle\angle +\angle -\approx -\approx (relation) +\approx\approx +\approx (relation) -\ast -\ast (binary operation) +\ast\ast +\ast (binary operation) -\asymp -\asymp (relation) +\asymp\asymp +\asymp (relation) -\backslash -\ (delimiter) +\backslash\backslash +\ (delimiter) -\beta -\beta +\beta\beta +\beta -\bigcap -\bigcap +\bigcap\bigcap +\bigcap -\bigcirc -\bigcirc (binary operation) +\bigcirc\bigcirc +\bigcirc (binary operation) -\bigcup -\bigcup +\bigcup\bigcup +\bigcup -\bigodot -\bigodot +\bigodot\bigodot +\bigodot -\bigoplus -\bigoplus +\bigoplus\bigoplus +\bigoplus -\bigotimes -\bigotimes +\bigotimes\bigotimes +\bigotimes -\bigtriangledown -\bigtriangledown (binary operation) +\bigtriangledown\bigtriangledown +\bigtriangledown (binary operation) -\bigtriangleup -\bigtriangleup (binary operation) +\bigtriangleup\bigtriangleup +\bigtriangleup (binary operation) -\bigsqcup -\bigsqcup +\bigsqcup\bigsqcup +\bigsqcup -\biguplus -\biguplus +\biguplus\biguplus +\biguplus -\bigcap -\bigvee +\bigcap\bigcap +\bigvee -\bigwedge -\bigwedge +\bigwedge\bigwedge +\bigwedge -\bot -\bot +\bot\bot +\bot -\bowtie -\bowtie (relation) +\bowtie\bowtie +\bowtie (relation) -\Box -(square open box symbol) +\Box\Box +(square open box symbol) -\bullet -bullet symbol\bullet (binary operation) +\bullet\bullet +bullet symbol +\bullet (binary operation) -\cap -\cap (binary operation) +\cap\cap +\cap (binary operation) -\cdot -\cdot (binary operation) +\cdot\cdot +\cdot (binary operation) -\chi -\chi +\chi\chi +\chi -\circ -\circ (binary operation) +\circ\circ +\circ (binary operation) -\clubsuit -\clubsuit +\clubsuit\clubsuit +\clubsuit -\cong -\cong (relation) +\cong\cong +\cong (relation) -\coprod -\coprod +\coprod\coprod +\coprod -\cup -\cup (binary operation) +\cup\cup +\cup (binary operation) -\dagger -\dagger (binary operation) +\dagger\dagger +\dagger (binary operation) -\dashv -\dashv (relation) +\dashv\dashv +\dashv (relation) -\ddagger -\dagger (binary operation) +\ddagger\ddagger +\dagger (binary operation) -\Delta -\Delta +\Delta\Delta +\Delta -\delta -\delta +\delta\delta +\delta -\Diamond -bigger \diamond +\Diamond\Diamond +bigger \diamond -\diamond -\diamond (binary operation) +\diamond\diamond +\diamond (binary operation) -\diamondsuit -\diamondsuit +\diamondsuit\diamondsuit +\diamondsuit -\div -\div (binary operation) +\div\div +\div (binary operation) -\doteq -\doteq (relation) +\doteq\doteq +\doteq (relation) -\downarrow -\downarrow (delimiter) +\downarrow\downarrow +\downarrow (delimiter) -\Downarrow -\Downarrow (delimiter) +\Downarrow\Downarrow +\Downarrow (delimiter) -\ell -\ell +\ell\ell +\ell -\emptyset -\emptyset +\emptyset\emptyset +\emptyset -\epsilon -\epsilon +\epsilon\epsilon +\epsilon -\equiv -\equiv (relation) +\equiv\equiv +\equiv (relation) -\eta -\eta +\eta\eta +\eta -\exists -\exists +\exists\exists +\exists -\flat -\flat +\flat\flat +\flat -\forall -\forall +\forall\forall +\forall -\frown -\frown (relation) +\frown\frown +\frown (relation) -\Gamma -\Gamma +\Gamma\Gamma +\Gamma -\gamma -\gamma +\gamma\gamma +\gamma -\ge -\ge +\ge\ge +\ge -\geq -\geq (relation) +\geq\geq +\geq (relation) -\gets -\gets +\gets\gets +\gets -\gg -\gg (relation) +\gg\gg +\gg (relation) -\hbar -\hbar +\hbar\hbar +\hbar -\heartsuit -\heartsuit +\heartsuit\heartsuit +\heartsuit -\hookleftarrow -\hookleftarrow +\hookleftarrow\hookleftarrow +\hookleftarrow -\hookrightarrow -\hookrightarrow +\hookrightarrow\hookrightarrow +\hookrightarrow -\iff -\iff +\iff\iff +\iff -\Im -\Im +\Im\Im +\Im -\in -\in (relation) +\in\in +\in (relation) -\infty -\infty +\infty\infty +\infty -\int -\int +\int\int +\int -\iota -\iota +\iota\iota +\iota -\Join -condensed bowtie symbol (relation) +\Join\Join +condensed bowtie symbol (relation) -\kappa -\kappa +\kappa\kappa +\kappa -\Lambda -\Lambda +\Lambda\Lambda +\Lambda -\lambda -\lambda +\lambda\lambda +\lambda -\land -\land +\land\land +\land -\langle -\langle (delimiter) +\langle\langle +\langle (delimiter) -\lbrace -\lbrace (delimiter) +\lbrace\lbrace +\lbrace (delimiter) -\lbrack -\lbrack (delimiter) +\lbrack\lbrack +\lbrack (delimiter) -\lceil -\lceil (delimiter) +\lceil\lceil +\lceil (delimiter) -\le -\le +\le\le +\le -\leadsto - +\leadsto\leadsto + -\Leftarrow -\Leftarrow +\Leftarrow\Leftarrow +\Leftarrow -\leftarrow -\leftarrow +\leftarrow\leftarrow +\leftarrow -\leftharpoondown -\leftharpoondown +\leftharpoondown\leftharpoondown +\leftharpoondown -\leftharpoonup -\leftharpoonup +\leftharpoonup\leftharpoonup +\leftharpoonup -\Leftrightarrow -\Leftrightarrow +\Leftrightarrow\Leftrightarrow +\Leftrightarrow -\leftrightarrow -\leftrightarrow +\leftrightarrow\leftrightarrow +\leftrightarrow -\leq -\leq (relation) +\leq\leq +\leq (relation) -\lfloor -\lfloor (delimiter) +\lfloor\lfloor +\lfloor (delimiter) -\lhd -(left-pointing arrow head) +\lhd\lhd +(left-pointing arrow head) -\ll -\ll (relation) +\ll\ll +\ll (relation) -\lnot -\lnot +\lnot\lnot +\lnot -\longleftarrow -\longleftarrow +\longleftarrow\longleftarrow +\longleftarrow -\longleftrightarrow -\longleftrightarrow +\longleftrightarrow\longleftrightarrow +\longleftrightarrow -\longmapsto -\longmapsto +\longmapsto\longmapsto +\longmapsto -\longrightarrow -\longrightarrow +\longrightarrow\longrightarrow +\longrightarrow -\lor -\lor +\lor\lor +\lor -\mapsto -\mapsto +\mapsto\mapsto +\mapsto -\mho - +\mho\mho + -\mid -\mid (relation) +\mid\mid +\mid (relation) -\models -\models (relation) +\models\models +\models (relation) -\mp -\mp (binary operation) +\mp\mp +\mp (binary operation) -\mu -\mu +\mu\mu +\mu -\nabla -\nabla +\nabla\nabla +\nabla -\natural -\natural +\natural\natural +\natural -\ne -\ne +\ne\ne +\ne -\nearrow -\nearrow +\nearrow\nearrow +\nearrow -\neg -\neg +\neg\neg +\neg -\neq -\neq (relation) +\neq\neq +\neq (relation) -\ni -\ni (relation) +\ni\ni +\ni (relation) -\not -Overstrike a following operator with a /, as in \not=. +\not\not +Overstrike a following operator with a /, as in \not=. -\notin -\ni +\notin\notin +\ni -\nu -\nu +\nu\nu +\nu -\nwarrow -\nwarrow +\nwarrow\nwarrow +\nwarrow -\odot -\odot (binary operation) +\odot\odot +\odot (binary operation) -\oint -\oint +\oint\oint +\oint -\Omega -\Omega +\Omega\Omega +\Omega -\omega -\omega +\omega\omega +\omega -\ominus -\ominus (binary operation) +\ominus\ominus +\ominus (binary operation) -\oplus -\oplus (binary operation) +\oplus\oplus +\oplus (binary operation) -\oslash -\oslash (binary operation) +\oslash\oslash +\oslash (binary operation) -\otimes -\otimes (binary operation) +\otimes\otimes +\otimes (binary operation) -\owns -\owns +\owns\owns +\owns -\parallel -\parallel (relation) +\parallel\parallel +\parallel (relation) -\partial -\partial +\partial\partial +\partial -\perp -\perp (relation) +\perp\perp +\perp (relation) -\phi -\phi +\phi\phi +\phi -\Pi -\Pi +\Pi\Pi +\Pi -\pi -\pi +\pi\pi +\pi -\pm -\pm (binary operation) +\pm\pm +\pm (binary operation) -\prec -\prec (relation) +\prec\prec +\prec (relation) -\preceq -\preceq (relation) +\preceq\preceq +\preceq (relation) -\prime -\prime +\prime\prime +\prime -\prod -\prod +\prod\prod +\prod -\propto -\propto (relation) +\propto\propto +\propto (relation) -\Psi -\Psi +\Psi\Psi +\Psi -\psi -\psi +\psi\psi +\psi -\rangle -\rangle (delimiter) +\rangle\rangle +\rangle (delimiter) -\rbrace -\rbrace (delimiter) +\rbrace\rbrace +\rbrace (delimiter) -\rbrack -\rbrack (delimiter) +\rbrack\rbrack +\rbrack (delimiter) -\rceil -\rceil (delimiter) +\rceil\rceil +\rceil (delimiter) -\Re -\Re +\Re\Re +\Re -\rfloor -\rfloor +\rfloor\rfloor +\rfloor -\rhd -(binary operation) +\rhd\rhd +(binary operation) -\rho -\rho +\rho\rho +\rho -\Rightarrow -\Rightarrow +\Rightarrow\Rightarrow +\Rightarrow -\rightarrow -\rightarrow +\rightarrow\rightarrow +\rightarrow -\rightharpoondown -\rightharpoondown +\rightharpoondown\rightharpoondown +\rightharpoondown -\rightharpoonup -\rightharpoonup +\rightharpoonup\rightharpoonup +\rightharpoonup -\rightleftharpoons -\rightleftharpoons +\rightleftharpoons\rightleftharpoons +\rightleftharpoons -\searrow -\searrow +\searrow\searrow +\searrow -\setminus -\setminus (binary operation) +\setminus\setminus +\setminus (binary operation) -\sharp -\sharp +\sharp\sharp +\sharp -\Sigma -\Sigma +\Sigma\Sigma +\Sigma -\sigma -\sigma +\sigma\sigma +\sigma -\sim -\sim (relation) +\sim\sim +\sim (relation) -\simeq -\simeq (relation) +\simeq\simeq +\simeq (relation) -\smallint -\smallint +\smallint\smallint +\smallint -\smile -\smile (relation) +\smile\smile +\smile (relation) -\spadesuit -\spadesuit +\spadesuit\spadesuit +\spadesuit -\sqcap -\sqcap (binary operation) +\sqcap\sqcap +\sqcap (binary operation) -\sqcup -\sqcup (binary operation) +\sqcup\sqcup +\sqcup (binary operation) -\sqsubset -(relation) +\sqsubset\sqsubset +(relation) -\sqsubseteq -\sqsubseteq (relation) +\sqsubseteq\sqsubseteq +\sqsubseteq (relation) -\sqsupset -(relation) +\sqsupset\sqsupset +(relation) -\sqsupseteq -\sqsupseteq (relation) +\sqsupseteq\sqsupseteq +\sqsupseteq (relation) -\star -\star (binary operation) +\star\star +\star (binary operation) -\subset -\subset (relation) +\subset\subset +\subset (relation) -\subseteq -\subseteq (relation) +\subseteq\subseteq +\subseteq (relation) -\succ -\succ (relation) +\succ\succ +\succ (relation) -\succeq -\succeq (relation) +\succeq\succeq +\succeq (relation) -\sum -\sum +\sum\sum +\sum -\supset -\supset (relation) +\supset\supset +\supset (relation) -\supseteq -\supseteq (relation) +\supseteq\supseteq +\supseteq (relation) -\surd -\surd +\surd\surd +\surd -\swarrow -\swarrow +\swarrow\swarrow +\swarrow -\tau -\tau +\tau\tau +\tau -\theta -\theta +\theta\theta +\theta -\times -\times (binary operation) +\times\times +\times (binary operation) -\to -\to +\to\to +\to -\top -\top +\top\top +\top -\triangle -\triangle +\triangle\triangle +\triangle -\triangleleft -\triangleleft (binary operation) +\triangleleft\triangleleft +\triangleleft (binary operation) -\triangleright -\triangleright (binary operation) +\triangleright\triangleright +\triangleright (binary operation) -\unlhd -left-pointing arrowhead with line under (binary operation) +\unlhd\unlhd +left-pointing arrowhead with line under (binary operation) -\unrhd -right-pointing arrowhead with line under (binary operation) +\unrhd\unrhd +right-pointing arrowhead with line under (binary operation) -\Uparrow -\Uparrow (delimiter) +\Uparrow\Uparrow +\Uparrow (delimiter) -\uparrow -\uparrow (delimiter) +\uparrow\uparrow +\uparrow (delimiter) -\Updownarrow -\Updownarrow (delimiter) +\Updownarrow\Updownarrow +\Updownarrow (delimiter) -\updownarrow -\updownarrow (delimiter) +\updownarrow\updownarrow +\updownarrow (delimiter) -\uplus -\uplus (binary operation) +\uplus\uplus +\uplus (binary operation) -\Upsilon -\Upsilon +\Upsilon\Upsilon +\Upsilon -\upsilon -\upsilon +\upsilon\upsilon +\upsilon -\varepsilon -\varepsilon +\varepsilon\varepsilon +\varepsilon -\varphi -\varphi +\varphi\varphi +\varphi -\varpi -\varpi +\varpi\varpi +\varpi -\varrho -\varrho +\varrho\varrho +\varrho -\varsigma -\varsigma +\varsigma\varsigma +\varsigma -\vartheta -\vartheta +\vartheta\vartheta +\vartheta -\vdash -\vdash (relation) +\vdash\vdash +\vdash (relation) -\vee -\vee (binary operation) +\vee\vee +\vee (binary operation) -\Vert -\Vert (delimiter) +\Vert\Vert +\Vert (delimiter) -\vert -\vert (delimiter) +\vert\vert +\vert (delimiter) -\wedge -\wedge (binary operation) +\wedge\wedge +\wedge (binary operation) -\wp -\wp +\wp\wp +\wp -\wr -\wr (binary operation) +\wr\wr +\wr (binary operation) -\Xi -\Xi +\Xi\Xi +\Xi -\xi -\xi +\xi\xi +\xi -\zeta -\zeta +\zeta\zeta +\zeta - Math functions -math functionsfunctions, math +math functions +functions, math + These commands produce roman function names in math mode with proper spacing. -\arccos -\arccos +\arccos\arccos +\arccos -\arcsin -\arcsin +\arcsin\arcsin +\arcsin -\arctan -\arctan +\arctan\arctan +\arctan -\arg -\arg +\arg\arg +\arg -\bmod -Binary modulo operator (x \bmod y) +\bmod\bmod +Binary modulo operator (x \bmod y) -\cos -\cos +\cos\cos +\cos -\cosh -\cosh +\cosh\cosh +\cosh -\cot -\cos +\cot\cot +\cos -\coth -\cosh +\coth\coth +\cosh -\csc -\csc +\csc\csc +\csc -\deg -\deg +\deg\deg +\deg -\det -\deg +\det\det +\deg -\dim -\dim +\dim\dim +\dim -\exp -\exp +\exp\exp +\exp -\gcd -\gcd +\gcd\gcd +\gcd -\hom -\hom +\hom\hom +\hom -\inf -\inf +\inf\inf +\inf -\ker -\ker +\ker\ker +\ker -\lg -\lg +\lg\lg +\lg -\lim -\lim +\lim\lim +\lim -\liminf -\liminf +\liminf\liminf +\liminf -\limsup -\limsup +\limsup\limsup +\limsup -\ln -\ln +\ln\ln +\ln -\log -\log +\log\log +\log -\max -\max +\max\max +\max -\min -\min +\min\min +\min -\pmod -parenthesized modulus, as in (\pmod 2^n - 1) +\pmod\pmod +parenthesized modulus, as in (\pmod 2^n - 1) -\Pr -\Pr +\Pr\Pr +\Pr -\sec -\sec +\sec\sec +\sec -\sin -\sin +\sin\sin +\sin -\sinh -\sinh +\sinh\sinh +\sinh -\sup -\sup +\sup\sup +\sup -\tan -\tan +\tan\tan +\tan -\tanh -\tanh +\tanh\tanh +\tanh - Math accents -math accentsaccents, mathematical +math accents +accents, mathematical + &latex; provides a variety of commands for producing accented letters in math. These are different from accents in normal text -(see ). +(see Accents). + +\acute\acute +acute accent, math +Math acute accent: \acute{x}. -\acute -acute accent, mathMath acute accent: \acute{x}. +\bar\bar +bar-over accent, math +macron accent, math +Math bar-over accent: \bar{x}. -\bar -bar-over accent, mathmacron accent, mathMath bar-over accent: \bar{x}. +\breve\breve +breve accent, math +Math breve accent: \breve{x}. -\breve -breve accent, mathMath breve accent: \breve{x}. +\check\check +check accent, math +háček accent, math +Math háček (check) accent: \check{x}. -\check -check accent, mathhác<ek accent, mathMath hác<ek (check) accent: \check{x}. +\ddot\ddot +double dot accent, math +Math dieresis accent: \ddot{x}. -\ddot -double dot accent, mathMath dieresis accent: \ddot{x}. +\dot\dot +overdot accent, math +dot over accent, math +Math dot accent: \dot{x}. -\dot -overdot accent, mathdot over accent, mathMath dot accent: \dot{x}. +\grave\grave +grave accent, math +Math grave accent: \grave{x}. -\grave -grave accent, mathMath grave accent: \grave{x}. +\hat\hat +hat accent, math +circumflex accent, math +Math hat (circumflex) accent: \hat{x}. -\hat -hat accent, mathcircumflex accent, mathMath hat (circumflex) accent: \hat{x}. +\imath\imath +dotless i, math +Math dotless i. -\imath -dotless i, mathMath dotless i. +\jmath\jmath +dotless j, math +Math dotless j. -\jmath -dotless j, mathMath dotless j. +\mathring\mathring +ring accent, math +Math ring accent: x*. -\tilde -tilde accent, mathMath tilde accent: \tilde{x}. +\tilde\tilde +tilde accent, math +Math tilde accent: \tilde{x}. -\vec -vector symbol, mathMath vector symbol: \vec{x}. +\vec\vec +vector symbol, math +Math vector symbol: \vec{x}. -\widehat -wide hat accent, mathMath wide hat accent: \widehat{x+y}. +\widehat\widehat +wide hat accent, math +Math wide hat accent: \widehat{x+y}. -\widehat -wide tile accent, mathMath wide tilde accent: \widetilde{x+y}. +\widehat\widehat +wide tile accent, math +Math wide tilde accent: \widetilde{x+y}. - Spacing in math mode -spacing within math modemath mode, spacing +spacing within math mode +math mode, spacing + In a math environment, &latex; ignores the spaces you type and puts in the spacing according to the normal rules for mathematics texts. If you want different spacing, &latex; provides the following commands for use in math mode: -\; -\;A thick space (5\over18\,quad). -\: -\> -\:\>Both of these produce a medium space (2\over9\,quad). -\, -\,A thin space (1\over6\,quad); not restricted to math mode. -\! -A negative thin space (-{1\over6}\,quad). +\; +\; +A thick space (5\over18\,quad). +\: +\> +\: +\> +Both of these produce a medium space (2\over9\,quad). +\, +\, +A thin space (1\over6\,quad); not restricted to math mode. +\! +A negative thin space (-{1\over6}\,quad). - Math miscellany math miscellany -\* -discretionary multiplicationmultiplication symbol, discretionary line breakA “discretionary” multiplication symbol, at which a line break is + + +\*\* +discretionary multiplication +multiplication symbol, discretionary line break +A “discretionary” multiplication symbol, at which a line break is allowed. -\cdots -A horizontal ellipsis with the dots raised to the center of the line. +\cdots\cdots +A horizontal ellipsis with the dots raised to the center of the line. -\ddots -A diagonal ellipsis: \ddots. +\ddots\ddots +A diagonal ellipsis: \ddots. -\frac{num}{den} -\fracProduces the fraction num divided by den. +\frac{num}{den}\frac{num}{den} +\frac +Produces the fraction num divided by den. -\left delim1 ... \right delim2 -\rightnull delimiterThe two delimiters need not match; ‘.’ acts as a null delimiter, +\left delim1 ... \right delim2\left delim1 ... \right delim2 +\right +null delimiter +The two delimiters need not match; ‘.’ acts as a null delimiter, producing no output. The delimiters are sized according to the math in between. Example: \left( \sum_i=1^10 a_i \right]. -\overbrace{text} -Generates a brace over text. -For example, \overbrace{x+\cdots+x}^{k \rm\;times}. +\overbrace{text}\overbrace{text} +Generates a brace over text. +For example, \overbrace{x+\cdots+x}^{k \rm\;times}. -\overline{text} -Generates a horizontal line over tex. -For exampe, \overline{x+y}. +\overline{text}\overline{text} +Generates a horizontal line over tex. +For exampe, \overline{x+y}. -\sqrt[root]{arg} -Produces the representation of the square root of arg. The +\sqrt[root]{arg}\sqrt[root]{arg} +Produces the representation of the square root of arg. The optional argument root determines what root to produce. For example, the cube root of x+y would be typed as $\sqrt[3]{x+y}$. -\stackrel{text}{relation} -Puts text above relation. For example, +\stackrel{text}{relation}\stackrel{text}{relation} +Puts text above relation. For example, \stackrel{f}{\longrightarrow}. -\underbrace{math} -Generates math with a brace underneath. +\underbrace{math}\underbrace{math} +Generates math with a brace underneath. -\underline{text} -Causes text, which may be either math mode or not, to be +\underline{text}\underline{text} +Causes text, which may be either math mode or not, to be underlined. The line is always below the text, taking account of descenders. -\vdots -\vdotsProduces a vertical ellipsis. +\vdots\vdots +\vdots +Produces a vertical ellipsis. - Modes -modesparagraph modemath modeleft-to-right modelR mode +modes +paragraph mode +math mode +left-to-right mode +lR mode + When &latex; is processing your input text, it is always in one of three modes: - -Paragraph mode - - -Math mode - - -Left-to-right mode, called LR mode for short - - +Paragraph mode +Math mode +Left-to-right mode, called LR mode for short + &latex; changes mode only when it goes up or down a staircase to a different level, though not all level changes produce mode changes. Mode changes occur only when entering or leaving an environment, or when &latex; is processing the argument of certain text-producing commands. -“Paragraph mode” is the most common; it's the one &latex; is in +“Paragraph mode” is the most common; it’s the one &latex; is in when processing ordinary text. In that mode, &latex; breaks your text into lines and breaks the lines into pages. &latex; is in -“math mode” when it's generating a mathematical formula. In “LR -mode”, as in paragraph mode, &latex; considers the output that it +“math mode” when it’s generating a mathematical formula. In “LR +mode”, as in paragraph mode, &latex; considers the output that it produces to be a string of words with spaces between them. However, unlike paragraph mode, &latex; keeps going from left to right; it never starts a new line in LR mode. Even if you put a hundred words @@ -4116,76 +4664,92 @@ There are also several text-producing commands and environments for making a box that put &latex; in paragraph mode. The box make by one of these commands or environments will be called a parbox. When &latex; is in paragraph mode while making a box, it is said to be in -“inner paragraph mode”. Its normal paragraph mode, which it starts out -in, is called “outer paragraph mode”. +“inner paragraph mode”. Its normal paragraph mode, which it starts out +in, is called “outer paragraph mode”. Page styles -styles, pagepage styles +styles, page +page styles + The \documentclass command determines the size and position of -the page's head and foot. The page style determines what goes in them. +the page’s head and foot. The page style determines what goes in them. - + <literal>\maketitle</literal> -titles, making\maketitle +titles, making +\maketitle + The \maketitle command generates a title on a separate title -page—except in the article class, where the title is placed +page—except in the article class, where the title is placed at the top of the first page. Information used to produce the title is obtained from the following declarations: -\author{name \and name2} -author, for titlepage\\ for \author\and for \authorThe \author command declares the document author(s), where the +\author{name \and name2}\author{name \and name2} +author, for titlepage +\\ for \author +\and for \author +The \author command declares the document author(s), where the argument is a list of authors separated by \and commands. Use -\\ to separate lines within a single author's entry—for -example, to give the author's institution or address. +\\ to separate lines within a single author’s entry—for +example, to give the author’s institution or address. -\date{text} -date, for titlepageThe \date command declares text to be the document's -date. With no \date command, the current date (see ) +\date{text}\date{text} +date, for titlepage +The \date command declares text to be the document’s +date. With no \date command, the current date (see \today) is used. -\thanks{text} -thanks, for titlepagecredit footnoteThe \thanks command produces a \footnote to the title, +\thanks{text}\thanks{text} +thanks, for titlepage +credit footnote +The \thanks command produces a \footnote to the title, usually used for credit acknowledgements. -\title{text} -title, for titlepage\\ for \titleThe \title command declares text to be the title of the +\title{text}\title{text} +title, for titlepage +\\ for \title +The \title command declares text to be the title of the document. Use \\ to force a line break, as usual. - - + <literal>\pagenumbering</literal> -\pagenumberingpage numbering style +\pagenumbering +page numbering style + Synopsis: \pagenumbering{style} Specifies the style of page numbers, according to style: -arabic -arabic numerals -roman -lowercase Roman numerals -Roman -uppercase Roman numerals -alph -lowercase letters -Alph -uppercase letters +arabic +arabic numerals +roman +lowercase Roman numerals +Roman +uppercase Roman numerals +alph +lowercase letters +Alph +uppercase letters - - + <literal>\pagestyle</literal> -\pagestyleheader stylefooter stylerunning header and footer style +\pagestyle +header style +footer style +running header and footer style + Synopsis: \pagestyle{style} @@ -4193,42 +4757,41 @@ document. Use \\ to force a line break, as usual. The \pagestyle command specifies how the headers and footers are typeset from the current page onwards. Values for style: -plain -Just a plain page number. +plain +Just a plain page number. -empty -Empty headers and footers, e.g., no page numbers. +empty +Empty headers and footers, e.g., no page numbers. -headings -Put running headers on each page. The document style specifies what +headings +Put running headers on each page. The document style specifies what goes in the headers. -myheadings -Custom headers, specified via the \markboth or the +myheadings +Custom headers, specified via the \markboth or the \markright commands. - Here are the descriptions of \markboth and \markright: -\markboth{left}{right} -Sets both the left and the right heading. A “left-hand heading” +\markboth{left}{right}\markboth{left}{right} +Sets both the left and the right heading. A “left-hand heading” (left) is generated by the last \markboth command before -the end of the page, while a “right-hand heading” (right is +the end of the page, while a “right-hand heading” (right is generated by the first \markboth or \markright that comes on the page if there is one, otherwise by the last one before the page. -\markright{right} -Sets the right heading, leaving the left heading unchanged. +\markright{right}\markright{right} +Sets the right heading, leaving the left heading unchanged. - - + <literal>\thispagestyle{<replaceable>style</replaceable>}</literal> \thispagestyle + The \thispagestyle command works in the same manner as the \pagestyle command (see previous section) except that it changes to style for the current page only. @@ -4239,17 +4802,19 @@ changes to style for the current page only. Spaces spaces + &latex; has many ways to produce white (or filled) space. -Another space-producing command is \, to produce a “thin” +Another space-producing command is \, to produce a “thin” space (usually 1/6quad). It can be used in text mode, but is -more often useful in math mode (see ). +more often useful in math mode (see Spacing in math mode). - + <literal>\hspace</literal> \hspace + Synopsis: \hspace[*]{length} @@ -4266,24 +4831,29 @@ form. - + <literal>\hfill</literal> -\hfillThe \hfill fill command produces a “rubber length” which has +\hfill +The \hfill fill command produces a “rubber length” which has no natural space but can stretch or shrink horizontally as far as needed. -\fillThe \fill parameter is the rubber length itself (technically, -the glue value ‘0pt plus1fill’); thus, \hspace\fill is +\fill +The \fill parameter is the rubber length itself (technically, +the glue value ‘0pt plus1fill’); thus, \hspace\fill is equivalent to \hfill. - + <literal>\SPACE</literal> -\SPACE\TAB\NEWLINE -The \ (space) command produces a normal interword space. It's -useful after punctuation which shouldn't end a sentence. For example +\SPACE +\TAB +\NEWLINE + +The \ (space) command produces a normal interword space. It’s +useful after punctuation which shouldn’t end a sentence. For example Knuth's article in Proc.\ Amer.\ Math\. Soc.\ is fundamental. It is also often used after control sequences, as in \TeX\ is a nice system. @@ -4293,79 +4863,86 @@ are equivalent to \ . - + <literal>\@</literal> \@ + The \@ command makes the following punctuation character end a sentence even if it normally would not. This is typically used after a capital letter. Here are side-by-side examples with and without \@: -… in C\@. Pascal, though … -… in C. Pascal, though … +… in C\@. Pascal, though … +… in C. Pascal, though … produces -
    … in C. Pascal, though … -… in C. Pascal, though … +
    … in C. Pascal, though … +… in C. Pascal, though …
    - - + <literal>\thinspace</literal> \thinspace + \thinspace produces an unbreakable and unstretchable space that is 1/6 of an em. This is the proper space to use in nested quotes, as -in '”. +in ’”. - + <literal>\/</literal> \/ + The \/ command produces an italic correction. This is a small space defined by the font designer for a given character, to avoid the character colliding with whatever follows. The italic -f character typically has a large italic correction value. +f character typically has a large italic correction value. -If the following character is a period or comma, it's not necessary to +If the following character is a period or comma, it’s not necessary to insert an italic correction, since those punctuation symbols have a very small height. However, with semicolons or colons, as well as normal letters, it can help. Compare -f: f; (in the &tex; output, the `f's are nicely separated) -with f: f;. +f: f; (in the &tex; output, the ‘f’s are nicely separated) +with f: f;. Despite the name, roman characters can also have an italic correction. Compare -pdf&tex; (in the &tex; output, there is a small space after the `f') +pdf&tex; (in the &tex; output, there is a small space after the ‘f’) with pdf&tex;. - + <literal>\hrulefill</literal> \hrulefill -The \hrulefill fill command produces a “rubber length” which can + +The \hrulefill fill command produces a “rubber length” which can stretch or shrink horizontally. It will be filled with a horizontal rule. - + <literal>\dotfill</literal> \dotfill -The \dotfill command produces a “rubber length” that fills + +The \dotfill command produces a “rubber length” that fills with dots instead of just white space. - + <literal>\addvspace</literal> -\addvspacevertical spacespace, inserting vertical +\addvspace +vertical space +space, inserting vertical + \addvspace{length} The \addvspace command normally adds a vertical space of height @@ -4376,41 +4953,48 @@ of the total vertical space equal to length. - + <literal>\bigskip \medskip \smallskip</literal> These commands produce a given amount of space. -\bigskip -\bigskip\bigskipamountThe same as \vspace{bigskipamount}, ordinarily about one line +\bigskip +\bigskip +\bigskipamount +The same as \vspace{bigskipamount}, ordinarily about one line space (with stretch and shrink). -\medskip -\medskip\medskipamountThe same as \vspace{medskipamount}, ordinarily +\medskip +\medskip +\medskipamount +The same as \vspace{medskipamount}, ordinarily about half of a line space (with stretch and shrink). -\smallskip -\smallskip\smallskipamountThe same as \vspace{smallskipamount}, ordinarily about a +\smallskip +\smallskip +\smallskipamount +The same as \vspace{smallskipamount}, ordinarily about a quarter of a line space (with stretch and shrink). - The \...amount parameters are determined by the document class. - + <literal>\vfill</literal> \vfill + The \vfill fill command produces a rubber length (glue) which -can stretch or shrink vertically as far as needed. It's equivalent to -\vspace{\fill} (see ). +can stretch or shrink vertically as far as needed. It’s equivalent to +\vspace{\fill} (see \hfill). - + <literal>\vspace[*]{<replaceable>length</replaceable>}</literal> \vspace + Synopsis: \vspace[*]{length} @@ -4429,24 +5013,29 @@ space is not removed. Boxes boxes -All the predefined length parameters (see ) can be + +All the predefined length parameters (see Predefined lengths) can be used in the arguments of the box-making commands. - + <literal>\mbox{<replaceable>text}</replaceable></literal> \mbox -hyphenation, preventingThe \mbox command creates a box just wide enough to hold the + +hyphenation, preventing +The \mbox command creates a box just wide enough to hold the text created by its argument. The text is not broken into lines, so it can be used to prevent hyphenation. - + <literal>\fbox</literal> and <literal>\framebox</literal> -\fbox\framebox +\fbox +\framebox + Synopses: \fbox{text} @@ -4460,18 +5049,21 @@ specification of the box width with the optional widthposition argument. -\fboxrule\fboxsepBoth commands produce a rule of thickness \fboxrule (default -‘.4pt’), and leave a space of \fboxsep (default -‘3pt’) between the rule and the contents of the box. +\fboxrule +\fboxsep +Both commands produce a rule of thickness \fboxrule (default +‘.4pt’), and leave a space of \fboxsep (default +‘3pt’) between the rule and the contents of the box. -See , for the \framebox command in the +See \framebox (picture), for the \framebox command in the picture environment. - + <literal>lrbox</literal> lrbox + \begin{lrbox}{cmd} text \end{lrbox} This is the environment form of \sbox. @@ -4481,9 +5073,10 @@ must have been declared with \newsavebox. - + <literal>\makebox</literal> \makebox + Synopsis: \makebox[width][position]{text} @@ -4494,25 +5087,25 @@ optional width argument. The position of the text wi is determined by the optional position argument, which may take the following values:     -c -Centered (default). -l -Flush left. -r -Flush right. -s -Stretch (justify) across entire width; text must contain +c +Centered (default). +l +Flush left. +r +Flush right. +s +Stretch (justify) across entire width; text must contain stretchable space for this to work. - \makebox is also used within the picture environment -see . +see \makebox (picture). - + <literal>\parbox</literal> \parbox + Synopsis: \parbox[position][height][inner-pos]{width}{text} @@ -4520,19 +5113,18 @@ see . The \parbox command produces a box whose contents are created in paragraph mode. It should be used to make a box small pieces of text, with nothing fancy inside. In particular, you -shouldn't use any paragraph-making environments inside a +shouldn’t use any paragraph-making environments inside a \parbox argument. For larger pieces of text, including ones containing a paragraph-making environment, you should use a -minipage environment (see ). +minipage environment (see minipage). \parbox has two mandatory arguments: -width -the width of the parbox; -text -the text that goes inside the parbox. +width +the width of the parbox; +text +the text that goes inside the parbox. - The optional position argument allows you to align either the top or bottom line in the parbox with the baseline of the surrounding text (default is top). @@ -4542,22 +5134,22 @@ text (default is top). The inner-pos argument controls the placement of the text inside the box, as follows; if it is not specified, position is used. -t -text is placed at the top of the box. -c -text is centered in the box. -b -text is placed at the bottom of the box. -s -stretch vertically; the text must contain vertically stretchable space +t +text is placed at the top of the box. +c +text is centered in the box. +b +text is placed at the bottom of the box. +s +stretch vertically; the text must contain vertically stretchable space for this to work. - - + <literal>\raisebox</literal> \raisebox + Synopsis: \raisebox{distance}[height][depth]{text} @@ -4574,44 +5166,47 @@ ignoring its natural height and depth. - + <literal>\savebox</literal> \savebox + Synopsis: \savebox{\boxcmd}[width][pos]{text} This command typeset text in a box just as with \makebox -(see ), except that instead of printing the resulting box, +(see \makebox), except that instead of printing the resulting box, it saves it in the box labeled \boxcmd, which must have been -declared with \newsavebox (see ). +declared with \newsavebox (see \newsavebox). - + <literal>\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}</literal> \sbox + Synopsis: \sbox{\boxcmd}{text} \sbox types text in a box just as with \mbox -(see ) except that instead of the resulting box being +(see \mbox) except that instead of the resulting box being included in the normal output, it is saved in the box labeled \boxcmd. \boxcmd must have been previously declared with -\newsavebox (see ). +\newsavebox (see \newsavebox). - + <literal>\usebox{<replaceable>\boxcmd</replaceable></literal> \usebox + Synopsis: \usebox{\boxcmd} \usebox producesthe box most recently saved in the bin -\boxcmd by a \savebox command (see ). +\boxcmd by a \savebox command (see \savebox). @@ -4626,28 +5221,42 @@ special meaning do not correspond to simple characters you can type. Reserved characters -reserved characterscharacters, reserved +reserved characters +characters, reserved + The following characters play a special role in &latex; and are called -“reserved characters” or “special characters”. +“reserved characters” or “special characters”. # $ % & ~ _ ^ \ { } -\#\$\%\&\_\{\}Whenever you write one of these characters into your file, &latex; +\# +\$ +\% +\& +\_ +\{ +\} +Whenever you write one of these characters into your file, &latex; will do something special. If you simply want the character to be printed as itself, include a \ in front of the character. For example, \$ will produce $ in your output. -\backslashOne exception to this rule is \ itself, because \\ has +\backslash +One exception to this rule is \ itself, because \\ has its own special (context-dependent) meaning. A roman \ is produced by typing $\backslash$ in your file, and a typewriter \ is -produced by using ‘\’ in a verbatim command (see ). +produced by using ‘\’ in a verbatim command (see verbatim). -\~\^Also, \~ and \^ place tilde and circumflex accents over -the following letter, as in õ and ô (see ); to get +\~ +\^ +Also, \~ and \^ place tilde and circumflex accents over +the following letter, as in õ and ô (see Accents); to get a standalone ~ or ^, you can again use a verbatim command. -\symbolaccessing any character of a font +\symbol +accessing any character of a font + Finally, you can access any character of the current font once you know its number by using the \symbol command. For example, the visible space character used in the \verb* command has the code @@ -4662,187 +5271,286 @@ with ", so the previous example could also be written as Text symbols -text symbolstextcomp package&latex; provides commands to generate a number of non-letter symbols +text symbols +textcomp package +&latex; provides commands to generate a number of non-letter symbols in running text. Some of these, especially the more obscure ones, are not available in OT1; you may need to load the textcomp package. -\copyright -\textcopyright -copyright symbolThe copyright symbol, ©. - -\dag -dagger, in textThe dagger symbol (in text). - -\ddag -double dagger, in textThe double dagger symbol (in text). - -\LaTeX -&latex; logologo, &latex;The &latex; logo. - -\guillemotleft («) -\guillemotright (») -\guilsinglleft (<) -\guilsinglright (>) -double guillemetssingle guillemetsleft angle quotation marksright angle quotation marksdouble angle quotation markssingle angle quotation marksFrench quotation marksquotation marks, FrenchDouble and single angle quotation marks, commonly used in French: -«, », <, >. - -\ldots -\dots -\textellipsis -ellipsisAn ellipsis (three dots at the baseline): `…'. \ldots + +\copyright\copyright +\textcopyright\textcopyright +copyright symbol +The copyright symbol, ©. + +\dag\dag +dagger, in text +The dagger symbol (in text). + +\ddag\ddag +double dagger, in text +The double dagger symbol (in text). + +\LaTeX\LaTeX +&latex; logo +logo, &latex; +The &latex; logo. + +\guillemotleft («)\guillemotleft («) +\guillemotright (»)\guillemotright (») +\guilsinglleft (‹)\guilsinglleft (‹) +\guilsinglright (›)\guilsinglright (›) +double guillemets +single guillemets +left angle quotation marks +right angle quotation marks +double angle quotation marks +single angle quotation marks +French quotation marks +quotation marks, French +Double and single angle quotation marks, commonly used in French: +«, », ‹, ›. + +\ldots\ldots +\dots\dots +\textellipsis\textellipsis +ellipsis +An ellipsis (three dots at the baseline): ‘…’. \ldots and \dots also work in math mode. -\lq -left quoteopening quoteLeft (opening) quote: `. - -\P -\textparagraph -paragraph symbolpilcrowParagraph sign (pilcrow). - -\pounds -\textsterling -pounds symbolsterling symbolEnglish pounds sterling: £. - -\quotedblbase („) -\quotesinglbase (‚) -double low-9 quotation marksingle low-9 quotation marklow-9 quotation marks, single and doubleDouble and single quotation marks on the baseline: -„ and ‚. - -\rq -right quoteclosing quoteRight (closing) quote: '. - -\S -section symbolSection symbol. - -\TeX -&tex; logologo, &tex;The &tex; logo. - -\textasciicircum -circumflex, ASCII, in textASCII circumflex, in textASCII circumflex: ^. - -\textasciitilde -tilde, ASCII, in textASCII tilde, in textASCII tilde: ~. - -\textasteriskcentered -asterisk, centered, in textcentered asterisk, in textCentered asterisk: *. - -\textbackslash -backslash, in textBackslash: \. - -\textbar -vertical bar, in textbar, vertical, in textVertical bar: |. - -\textbardbl -vertical bar, double, in textbar, double vertical, in textdouble vertical bar, in textDouble vertical bar. - -\textbigcircle -big circle symbols, in textcircle symbol, big, in textBig circle symbol. - -\textbraceleft -left brace, in textbrace, left, in textLeft brace: {. - -\textbraceright -right brace, in textbrace, right, in textRight brace: }. - -\textbullet -bullet, in textBullet: •. - -\textcircled{letter} -circled letter, in textletter in a circle, as in ®. - -\textcompwordmark -\textcapitalwordmark -\textascenderwordmark -composite word mark, in textcap heightascender heightComposite word mark (invisible). The \textcapital... form +\lq\lq +left quote +opening quote +Left (opening) quote: ‘. + +\P\P +\textparagraph\textparagraph +paragraph symbol +pilcrow +Paragraph sign (pilcrow). + +\pounds\pounds +\textsterling\textsterling +pounds symbol +sterling symbol +English pounds sterling: £. + +\quotedblbase („)\quotedblbase („) +\quotesinglbase (‚)\quotesinglbase (‚) +double low-9 quotation mark +single low-9 quotation mark +low-9 quotation marks, single and double +Double and single quotation marks on the baseline: +„ and ‚. + +\rq\rq +right quote +closing quote +Right (closing) quote: ’. + +\S\S +section symbol +Section symbol. + +\TeX\TeX +&tex; logo +logo, &tex; +The &tex; logo. + +\textasciicircum\textasciicircum +circumflex, ASCII, in text +ASCII circumflex, in text +ASCII circumflex: ^. + +\textasciitilde\textasciitilde +tilde, ASCII, in text +ASCII tilde, in text +ASCII tilde: ~. + +\textasteriskcentered\textasteriskcentered +asterisk, centered, in text +centered asterisk, in text +Centered asterisk: *. + +\textbackslash\textbackslash +backslash, in text +Backslash: \. + +\textbar\textbar +vertical bar, in text +bar, vertical, in text +Vertical bar: |. + +\textbardbl\textbardbl +vertical bar, double, in text +bar, double vertical, in text +double vertical bar, in text +Double vertical bar. + +\textbigcircle\textbigcircle +big circle symbols, in text +circle symbol, big, in text +Big circle symbol. + +\textbraceleft\textbraceleft +left brace, in text +brace, left, in text +Left brace: {. + +\textbraceright\textbraceright +right brace, in text +brace, right, in text +Right brace: }. + +\textbullet\textbullet +bullet, in text +Bullet: •. + +\textcircled{letter}\textcircled{letter} +circled letter, in text +letter in a circle, as in ®. + +\textcompwordmark\textcompwordmark +\textcapitalwordmark\textcapitalwordmark +\textascenderwordmark\textascenderwordmark +composite word mark, in text +cap height +ascender height +Composite word mark (invisible). The \textcapital... form has the cap height of the font, while the \textascender... form has the ascender height. -\textdagger -dagger, in textDagger: \dag. - -\textdaggerdbl -dagger, double, in textdouble dagger, in textDouble dagger: \ddag. - -\textdollar (or $) -dollar signcurrency, dollarDollar sign: $. - -\textemdash (or ---) -em-dashEm-dash: — (for punctuation). - -\textendash (or --) -e-dashEn-dash: — (for ranges). - -\texteuro -euro symbolcurrency, euroThe Euro symbol: €. - -\textexclamdown (or !`) -exclamation point, upside-downUpside down exclamation point: ¡. - -\textgreater -greater than symbol, in textGreater than: >. - -\textless -less than symbol, in textLess than: <. - -\textleftarrow -arrow, left, in textleft arrow, in textLeft arrow. - -\textordfeminine -\textordmasculine -feminine ordinal symbolmasculine ordinal symbolordinals, feminine and masculineSpanish ordinals, feminine and masculineFeminine and masculine ordinal symbols: ª, º. - -\textperiodcentered -period, centered, in textcentered period, in textCentered period: \cdot. - -\textquestiondown (or ?`) -questionation point, upside-downUpside down questionation point: ¿. - -\textquotedblleft (or ``) -left quote, doubledouble left quoteDouble left quote: “. - -\textquotedblright (or ') -right quote, doubledouble right quoteDouble right quote: ”. - -\textquoteleft (or `) -left quote, singlesingle left quoteSingle left quote: `. - -\textquoteright (or ') -right quote, singlesingle right quoteSingle right quote: '. - -\textquotestraightbase -\textquotestraightdblbase -quote, straight basestraight quote, basedouble quote, straight basestraight double quote, baseSingle and double straight quotes on the baseline. - -\textregistered -registered symbolRegistered symbol: ®. - -\textrightarrow -arrow, right, in textright arrow, in textRight arrow. - -\textthreequartersemdash -three-quarters em-dashem-dash, three-quarters“Three-quarters” em-dash, between en-dash and em-dash. - -\texttrademark -trademark symbolTrademark symbol: ^{\hbox{TM}}. - -\texttwelveudash -two-thirds em-dashem-dash, two-thirds“Two-thirds” em-dash, between en-dash and em-dash. - -\textunderscore -underscore, in textUnderscore: _. - -\textvisiblespace -visible space symbol, in textVisible space symbol. +\textdagger\textdagger +dagger, in text +Dagger: \dag. + +\textdaggerdbl\textdaggerdbl +dagger, double, in text +double dagger, in text +Double dagger: \ddag. + +\textdollar (or $)\textdollar (or $) +dollar sign +currency, dollar +Dollar sign: $. + +\textemdash (or ---)\textemdash (or ---) +em-dash +Em-dash: — (for punctuation). + +\textendash (or --)\textendash (or --) +e-dash +En-dash: — (for ranges). + +\texteuro\texteuro +euro symbol +currency, euro +The Euro symbol: €. + +\textexclamdown (or !`)\textexclamdown (or !`) +exclamation point, upside-down +Upside down exclamation point: ¡. + +\textgreater\textgreater +greater than symbol, in text +Greater than: >. + +\textless\textless +less than symbol, in text +Less than: <. + +\textleftarrow\textleftarrow +arrow, left, in text +left arrow, in text +Left arrow. + +\textordfeminine\textordfeminine +\textordmasculine\textordmasculine +feminine ordinal symbol +masculine ordinal symbol +ordinals, feminine and masculine +Spanish ordinals, feminine and masculine +Feminine and masculine ordinal symbols: ª, º. + +\textperiodcentered\textperiodcentered +period, centered, in text +centered period, in text +Centered period: \cdot. + +\textquestiondown (or ?`)\textquestiondown (or ?`) +questionation point, upside-down +Upside down questionation point: ¿. + +\textquotedblleft (or ``)\textquotedblleft (or ``) +left quote, double +double left quote +Double left quote: “. + +\textquotedblright (or ')\textquotedblright (or ') +right quote, double +double right quote +Double right quote: ”. + +\textquoteleft (or `)\textquoteleft (or `) +left quote, single +single left quote +Single left quote: ‘. + +\textquoteright (or ')\textquoteright (or ') +right quote, single +single right quote +Single right quote: ’. + +\textquotestraightbase\textquotestraightbase +\textquotestraightdblbase\textquotestraightdblbase +quote, straight base +straight quote, base +double quote, straight base +straight double quote, base +Single and double straight quotes on the baseline. + +\textregistered\textregistered +registered symbol +Registered symbol: ®. + +\textrightarrow\textrightarrow +arrow, right, in text +right arrow, in text +Right arrow. + +\textthreequartersemdash\textthreequartersemdash +three-quarters em-dash +em-dash, three-quarters +“Three-quarters” em-dash, between en-dash and em-dash. + +\texttrademark\texttrademark +trademark symbol +Trademark symbol: ^{\hbox{TM}}. + +\texttwelveudash\texttwelveudash +two-thirds em-dash +em-dash, two-thirds +“Two-thirds” em-dash, between en-dash and em-dash. + +\textunderscore\textunderscore +underscore, in text +Underscore: _. + +\textvisiblespace\textvisiblespace +visible space symbol, in text +Visible space symbol. - Accents -accentscharacters, accentedletters, accented -&latex; has wide support for many of the world's scripts and +accents +characters, accented +letters, accented + +&latex; has wide support for many of the world’s scripts and languages, through the babel package and related support. This section does not attempt to cover all that support. It merely lists the core &latex; commands for creating accented characters. @@ -4850,150 +5558,249 @@ the core &latex; commands for creating accented characters. The \capital... commands produce alternative forms for use with capital letters. These are not available with OT1. -\" -\capitaldieresis -\" (umlaut accent)\capitaldieresisumlaut accentdieresis accentProduces an umlaut (dieresis), as in ö. - -\' -\capitalacute -\' (acute accent)\capitalacuteacute accentProduces an acute accent, as in ó. In the tabbing +\" +\capitaldieresis +\" (umlaut accent) +\capitaldieresis +umlaut accent +dieresis accent +Produces an umlaut (dieresis), as in ö. + +\' +\capitalacute +\’ (acute accent) +\capitalacute +acute accent +Produces an acute accent, as in ó. In the tabbing environment, pushes current column to the right of the previous column -(see ). - -\. -\. (dot-over accent)dot accentdot-over accentProduces a dot accent over the following, as in o.. - -\= -\capitalmacron -\= (macron accent)\capitalmacronmacron accentoverbar accentbar-over accentProduces a macron (overbar) accent over the following, as in o¯. - -\^ -\capitalcircumflex -\^ (circumflex accent)\capitalcircumflexcircumflex accenthat accentProduces a circumflex (hat) accent over the following, as in ô. - -\` -\capitalgrave -\` (grave accent)\capitalgravegrave accentProduces a grave accent over the following, as in ò. In the +(see tabbing). + +\. +\. (dot-over accent) +dot accent +dot-over accent +Produces a dot accent over the following, as in ȯ. + +\= +\capitalmacron +\= (macron accent) +\capitalmacron +macron accent +overbar accent +bar-over accent +Produces a macron (overbar) accent over the following, as in ō. + +\^ +\capitalcircumflex +\^ (circumflex accent) +\capitalcircumflex +circumflex accent +hat accent +Produces a circumflex (hat) accent over the following, as in ô. + +\` +\capitalgrave +\‘ (grave accent) +\capitalgrave +grave accent +Produces a grave accent over the following, as in ò. In the tabbing environment, move following text to the right margin -(see ). - -\~ -\capitaltilde -\~ (tilde accent)\capitaltildetilde accentProduces a tilde accent over the following, as in ñ. - -\b -\b (bar-under accent)bar-under accentProduces a bar accent under the following, as in o_. - -\c -\capitalcedilla -\c (cedilla accent)\capitalcedillacedilla accentProduces a cedilla accent under the following, as in ç. - -\d -\capitaldotaccent -\d (dot-under accent)\capitaldotaccentdot-under accentProduces a dot accent under the following, as in .o. - -\H -\capitalhungarumlaut -\H (Hungarian umlaut accent)\capitalhungarumlauthungarian umlaut accentProduces a long Hungarian umlaut accent over the following, as in o''. - -\i -\i (dotless i)dotless iProduces a dotless i, as in `i'. - -\j -\j (dotless j)dotless jProduces a dotless j, as in `j'. - -\k -\capitalogonek -\k (ogonek)\capitalogonekogonekProduces a letter with ogonek, as in `o;'. Not available in +(see tabbing). + +\~ +\capitaltilde +\~ (tilde accent) +\capitaltilde +tilde accent +Produces a tilde accent over the following, as in ñ. + +\b +\b (bar-under accent) +bar-under accent +Produces a bar accent under the following, as in o_. + +\c +\capitalcedilla +\c (cedilla accent) +\capitalcedilla +cedilla accent +Produces a cedilla accent under the following, as in ç. + +\d +\capitaldotaccent +\d (dot-under accent) +\capitaldotaccent +dot-under accent +Produces a dot accent under the following, as in ọ. + +\H +\capitalhungarumlaut +\H (Hungarian umlaut accent) +\capitalhungarumlaut +hungarian umlaut accent +Produces a long Hungarian umlaut accent over the following, as in ő. + +\i +\i (dotless i) +dotless i +Produces a dotless i, as in ‘i’. + +\j +\j (dotless j) +dotless j +Produces a dotless j, as in ‘j’. + +\k +\capitalogonek +\k (ogonek) +\capitalogonek +ogonek +Produces a letter with ogonek, as in ‘ǫ’. Not available in the OT1 encoding. -\r -\capitalring -\r (ring accent)\capitalringring accentProduces a ring accent, as in `o*'. - -\t -\capitaltie -\newtie -\capitalnewtie -\t (tie-after accent)\capitaltie\newtie\capitalnewtietie-after accentProduces a tie-after accent, as in `oo['. The +\r +\capitalring +\r (ring accent) +\capitalring +ring accent +Produces a ring accent, as in ‘o*’. + +\t +\capitaltie +\newtie +\capitalnewtie +\t (tie-after accent) +\capitaltie +\newtie +\capitalnewtie +tie-after accent +Produces a tie-after accent, as in ‘oo[’. The \newtie form is centered in its box. -\u -\capitalbreve -\u (breve accent)\capitalbrevebreve accentProduces a breve accent, as in `o('. - -\underbar -\underbarunderbarNot exactly an accent, this produces a bar under the argument text. +\u +\capitalbreve +\u (breve accent) +\capitalbreve +breve accent +Produces a breve accent, as in ‘ŏ’. + +\underbar +\underbar +underbar +Not exactly an accent, this produces a bar under the argument text. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through -descenders. See also \underline in . +descenders. See also \underline in Math miscellany. -\v -\capitalcaron -\v (breve accent)\capitalcaronhacek accentcheck accentcaron accentProduces a hác<ek (check, caron) accent, as in `o<'. +\v +\capitalcaron +\v (breve accent) +\capitalcaron +hacek accent +check accent +caron accent +Produces a háček (check, caron) accent, as in ‘ǒ’. - - + Non-English characters -special charactersnon-English characterscharacters, non-Englishletters, non-English +special characters +non-English characters +characters, non-English +letters, non-English + Here are the basic &latex; commands for inserting characters commonly used in languages other than English. -\aa -\AA -\aa (å)\AA (Å)aringå and Å. - -\ae -\AE -\ae (æ)\AE (Æ)ae ligatureæ and Æ. - -\dh -\DH -\dh (æ)\DH (Æ)Icelandic etheth, Icelandic letterIcelandic letter eth: ð and Ð. - -\dj -\DJ -\dj\DJxxxx - -\ij -\IJ -\ij (ij)\IJ (IJ)ij letter, Dutchij and IJ (except somewhat closer together than appears here). - -\l -\L -\l (/l)\L (/L)polish l/l and /L. - -\ng -\NG -\ng\NGxxxx - -\o -\O -\o (ø)\O (Ø)oslashø and Ø. - -\oe -\OE -\oe (œ)\OE (Œ)oe ligatureœ and Œ. - -\ss -\SS -\ss (ß)\SS (SS)es-zet German lettersharp S lettersß and SS. - -\th -\TH -\th (þ)\TH (Þ)Icelandic thornthorn, Icelandic letterIcelandic letter thorn: þ and Þ. + +\aa +\AA +\aa (å) +\AA (Å) +aring +å and Å. + +\ae +\AE +\ae (æ) +\AE (Æ) +ae ligature +æ and Æ. + +\dh +\DH +\dh (æ) +\DH (Æ) +Icelandic eth +eth, Icelandic letter +Icelandic letter eth: ð and Ð. + +\dj +\DJ +\dj +\DJ +xxxx + +\ij +\IJ +\ij (ij) +\IJ (IJ) +ij letter, Dutch +ij and IJ (except somewhat closer together than appears here). + +\l +\L +\l (ł) +\L (Ł) +polish l +ł and Ł. + +\ng +\NG +\ng +\NG +xxxx + +\o +\O +\o (ø) +\O (Ø) +oslash +ø and Ø. + +\oe +\OE +\oe (œ) +\OE (Œ) +oe ligature +œ and Œ. + +\ss +\SS +\ss (ß) +\SS (SS) +es-zet German letter +sharp S letters +ß and SS. + +\th +\TH +\th (þ) +\TH (Þ) +Icelandic thorn +thorn, Icelandic letter +Icelandic letter thorn: þ and Þ. - - + <literal>\rule</literal> \rule + Synopsis: \rule[raise]{width}{thickness} @@ -5001,28 +5808,29 @@ used in languages other than English. The \rule command produces rules, that is, lines or rectangles. The arguments are: -raise -How high to raise the rule (optional). +raise +How high to raise the rule (optional). -width -The length of the rule (mandatory). +width +The length of the rule (mandatory). -thickness -The thickness of the rule (mandatory). +thickness +The thickness of the rule (mandatory). - - + <literal>\today</literal> \today -The \today command produces today's date, in the format -‘month dd, yyyy’; for example, `July 4, 1976'. + +The \today command produces today’s date, in the format +‘month dd, yyyy’; for example, ‘July 4, 1976’. It uses the predefined counters \day, \month, and -\year (see ) to do this. It is not +\year (see \day \month \year) to do this. It is not updated as the program runs. -datetime packageThe datetime package, among others, can produce a wide variety +datetime package +The datetime package, among others, can produce a wide variety of other date formats. @@ -5030,39 +5838,44 @@ of other date formats. Splitting the input -splitting the input fileinput file +splitting the input file +input file + 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 +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;. - + <literal>\include</literal> \include + Synopsis: \include{file} If no \includeonly command is present, the \include command executes \clearpage to start a new page -(see ), then reads file, then does another +(see \clearpage), then reads file, then does another \clearpage. Given an \includeonly command, the \include actions are only run if file is listed as an argument to \includeonly. See the next section. -nested \include, not allowedThe \include command may not appear in the preamble or in a file +nested \include, not allowed +The \include command may not appear in the preamble or in a file read by another \include command. - + \<literal>includeonly</literal> \includeonly + Synopsis: \includeonly{file1,file2,...} @@ -5077,9 +5890,10 @@ effective. - + \input \input + Synopsis: \input{file} @@ -5088,15 +5902,15 @@ effective. and processed, as if its contents had been inserted in the current file at that point. -If file does not end in ‘.tex’ (e.g., ‘foo’ or -‘foo.bar’), it is first tried with that extension (‘foo.tex’ -or ‘foo.bar.tex’). If that is not found, the original file -is tried (‘foo’ or ‘foo.bar’). +If file does not end in ‘.tex’ (e.g., ‘foo’ or +‘foo.bar’), it is first tried with that extension (‘foo.tex’ +or ‘foo.bar.tex’). If that is not found, the original file +is tried (‘foo’ or ‘foo.bar’). - + Front/back matter @@ -5105,7 +5919,10 @@ is tried (‘foo’ or ‘foo.barTables of contents table of contents, creating -\tableofcontents.toc fileA table of contents is produced with the \tableofcontents + +\tableofcontents +.toc file +A table of contents is produced with the \tableofcontents command. You put the command right where you want the table of contents to go; &latex; does the rest for you. A previous run must have generated a .toc file. @@ -5115,78 +5932,87 @@ not automatically start a new page. If you want a new page after the table of contents, write a \newpage command after the \tableofcontents command. -\listoffigures\listoftablesThe analogous commands \listoffigures and \listoftables +\listoffigures +\listoftables +The analogous commands \listoffigures and \listoftables produce a list of figures and a list of tables, respectively. Everything works exactly the same as for the table of contents. -\nofilesThe command \nofiles overrides these commands, and +\nofiles +The command \nofiles overrides these commands, and prevents any of these lists from being generated. - + \addcontentsline -\addcontentsline{ext}{unit}{text}table of contents entry, manually adding +\addcontentsline{ext}{unit}{text} +table of contents entry, manually adding + The \addcontentsline{ext}{unit}{text} command adds an entry to the specified list or table where: -ext -The extension of the file on which information is to be written, +ext +The extension of the file on which information is to be written, typically one of: toc (table of contents), lof (list of figures), or lot (list of tables). -unit -The name of the sectional unit being added, typically one of the +unit +The name of the sectional unit being added, typically one of the following, matching the value of the ext argument: -toc -The name of the sectional unit: part, chapter, +toc +The name of the sectional unit: part, chapter, section, subsection, subsubsection. -lof -For the list of figures. -lot -For the list of tables. +lof +For the list of figures. +lot +For the list of tables. - -entry -The actual text of the entry. +entry +The actual text of the entry. - -\contentslineWhat is written to the .ext file is the +\contentsline +What is written to the .ext file is the command \contentsline{unit}{name}. - + \addtocontents \addtocontents{ext}{text} + The \addtocontents{ext}{text} command adds text (or formatting commands) directly to the .ext file that generates the table of contents or lists of figures or tables. -ext -The extension of the file on which information is to be written: +ext +The extension of the file on which information is to be written: toc (table of contents), lof (list of figures), or lot (list of tables). -text -The text to be written. +text +The text to be written. - Glossaries glossaries -\makeglossaryThe command \makeglossary enables creating glossaries. + +\makeglossary +The command \makeglossary enables creating glossaries. -\glossary.glo fileThe command \glossary{text} writes a glossary entry for +\glossary +.glo file +The command \glossary{text} writes a glossary entry for text to an auxiliary file with the .glo extension. -\glossaryentrySpecifically, what gets written is the command +\glossaryentry +Specifically, what gets written is the command \glossaryentry{text}{pageno}, where pageno is the current \thepage value. @@ -5198,44 +6024,60 @@ glossaries. Indexes indexes -\makeindexThe command \makeindex enables creating indexes. Put this in + +\makeindex +The command \makeindex enables creating indexes. Put this in the preamble. -\index.idx fileThe command \index{text} writes an index entry for +\index +.idx file +The command \index{text} writes an index entry for text to an auxiliary file with the .idx extension. -\indexentrySpecifically, what gets written is the command +\indexentry +Specifically, what gets written is the command \indexentry{text}{pageno}, where pageno is the current \thepage value. -`see' and `see also' index entriesTo generate a index entry for `bar' that says `See foo', use a +‘see’ and ‘see also’ index entries +To generate a index entry for ‘bar’ that says ‘See foo’, use a vertical bar: \index{bar|see{foo}}. Use seealso -instead of see to make a `See also' entry. +instead of see to make a ‘See also’ entry. -\seename\alsonameThe text `See' is defined by the macro \seename, and `See also' +\seename +\alsoname +The text ‘See’ is defined by the macro \seename, and ‘See also’ by the macro \alsoname. These can be redefined for other languages. -makeindex programxindy program.ind fileThe generated .idx file is then sorted with an external +makeindex program +xindy program +.ind file +The generated .idx file is then sorted with an external command, usually either makeindex (http://mirror.ctan.org/indexing/makeindex) or (the multi-lingual) xindy (http://xindy.sourceforge.net). This results in a .ind file, which can then be read to typeset the index. -printindexmakeidx packageThe index is usually generated with the \printindex command. +printindex +makeidx package +The index is usually generated with the \printindex command. This is defined in the makeidx package, so \usepackage{makeidx} needs to be in the preamble. -indexspaceThe rubber length \indexspace is inserted before each new -letter in the printed index; its default value is ‘10pt plus5pt -minus3pt’. +indexspace +The rubber length \indexspace is inserted before each new +letter in the printed index; its default value is ‘10pt plus5pt +minus3pt’. -showidx packageThe showidx package causes each index entries to be shown in +showidx package +The showidx package causes each index entries to be shown in the margin on the page where the entry appears. This can help in preparing the index. -multind packageThe multind package supports multiple indexes. See also the +multind package +The multind package supports multiple indexes. See also the &tex; FAQ entry on this topic, http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind. @@ -5244,7 +6086,9 @@ preparing the index. Letters -letterscreating letters +letters +creating letters + You can use &latex; to typeset letters, both personal and business. The letter document class is designed to make a number of letters at once, although you can make just one if you so desire. @@ -5271,8 +6115,9 @@ the letter follows. It is typed as ordinary &latex; input. Commands that make no sense in a letter, like \chapter, do not work. The letter closes with a \closing command. -\\ for lettersAfter the closing, you can have additional material. The -\cc command produces the usual “cc: …”. There's also a +\\ for letters +After the closing, you can have additional material. The +\cc command produces the usual “cc: …”. There’s also a similar \encl command for a list of enclosures. With both these commands, use \\ to separate the items. @@ -5280,25 +6125,28 @@ commands, use \\ to separate the items. - + \address{<replaceable>return-address}</replaceable> \address + The \address specifies the return address of a letter, as it should appear on the letter and the envelope. Separate lines of the address should be separated by \\ commands. If you do not make an \address declaration, then the letter -will be formatted for copying onto your organisation's standard -letterhead. (See , for details on your local +will be formatted for copying onto your organisation’s standard +letterhead. (See Overview, for details on your local implementation). If you give an \address declaration, then the letter will be formatted as a personal letter. - + <literal>\cc</literal> -\cccc list, in letters +\cc +cc list, in letters + Synopsis: \cc{name1\\name2} @@ -5308,10 +6156,13 @@ printed on a separate line. - + <literal>\closing</literal> -\closingletters, endingclosing letters +\closing +letters, ending +closing letters + Synopsis: \closing{text} @@ -5321,10 +6172,12 @@ printed on a separate line. - + <literal>\encl</literal> -\enclenclosure list +\encl +enclosure list + Synopsis: \encl{line1\\line2} @@ -5333,19 +6186,21 @@ printed on a separate line. - + <literal>\location</literal> \location + \location{address} -This modifies your organisation's standard address. This only appears +This modifies your organisation’s standard address. This only appears if the firstpage pagestyle is selected. - + <literal>\makelabels</literal> \makelabels + \makelabels{number} If you issue this command in the preamble, &latex; will create a sheet of @@ -5354,9 +6209,10 @@ address labels. This sheet will be output before the letters. - + <literal>\name</literal> \name + \name{June Davenport} Your name, used for printing on the envelope together with the return @@ -5364,9 +6220,11 @@ address. - + <literal>\opening{<replaceable>text</replaceable>}</literal> -\openingletters, starting +\opening +letters, starting + Synopsis: \opening{text} @@ -5379,26 +6237,30 @@ For instance: - + <literal>\ps</literal> -\pspostscript, in letters +\ps +postscript, in letters + Use the \ps command to start a postscript in a letter, after \closing. - + <literal>\signature{<replaceable>text</replaceable>}</literal> \signature + Your name, as it should appear at the end of the letter underneath the space for your signature. \\ starts a new line within text as usual. - + <literal>\startbreaks</literal> \startbreaks + \startbreaks Used after a \stopbreaks command to allow page breaks again. @@ -5406,9 +6268,10 @@ space for your signature. \\ starts a new line within - + <literal>\stopbreaks</literal> \stopbreaks + \stopbreaks Inhibit page breaks until a \startbreaks command occurs. @@ -5416,9 +6279,10 @@ space for your signature. \\ starts a new line within - + <literal>\telephone</literal> \telephone + \telephone{number} This is your telephone number. This only appears if the @@ -5427,14 +6291,17 @@ space for your signature. \\ starts a new line within - + Terminal input/output -input/outputterminal input/output +input/output +terminal input/output - + + <literal>\typein[<replaceable>cmd</replaceable>]{<replaceable>msg</replaceable>}</literal> \typein + Synopsis: \typein[\cmd]{msg} @@ -5449,9 +6316,10 @@ redefined to be the typed input. - + <literal>\typeout{<replaceable>msg</replaceable>}</literal> \typeout + Synopsis: \typeout{msg} @@ -5461,7 +6329,7 @@ Commands in msg that are defined with \newcommand\renewcommand (among others) are replaced by their definitions before being printed. -&latex;'s usual rules for treating multiple spaces as a single space +&latex;’s usual rules for treating multiple spaces as a single space and ignoring spaces after a command name apply to msg. A \space command in msg causes a single space to be printed, independent of surrounding spaces. A ^^J in @@ -5473,6 +6341,7 @@ printed, independent of surrounding spaces. A ^^J in Command line command line + The input file specification indicates the file to be formatted; &tex; uses .tex as a default file extension. If you omit the input file entirely, &tex; accepts input from the terminal. You @@ -5483,23 +6352,27 @@ command; e.g. will process foo.tex without pausing after every error. -‘*’ promptprompt, ‘*’\stopIf &latex; stops in the middle of the document and gives you a -‘*’ prompt, it is waiting for input. You can type \stop +‘*’ prompt +prompt, ‘*’ +\stop +If &latex; stops in the middle of the document and gives you a +‘*’ prompt, it is waiting for input. You can type \stop (and return) and it will prematurely end the document. - + Document templates document templates + Although not reference material, perhaps these document templates will -be useful. Additional templates are collected at -http://www.howtotex.com/templates. +be useful. Additional template resources are listed +http://tug.org/interest.html#latextemplates. - + <literal>book</literal> template \documentclass{book} @@ -5521,7 +6394,7 @@ The end. - + <literal>beamer</literal> template The beamer class creates slides presentations. @@ -5551,7 +6424,7 @@ The end. - + <literal>tugboat</literal> template TUGboat is the journal of the &tex; Users Group, @@ -5561,13 +6434,13 @@ The end. \usepackage{graphicx} \usepackage{ifpdf} \ifpdf - \usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, - urlcolor=black]{hyperref} +\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, + urlcolor=black]{hyperref} \else - \usepackage{url} +\usepackage{url} \fi -\title{Example \TUB\ Article} +\title{Example \TUB\ article} % repeat info for each author. \author{First Last} @@ -5575,12 +6448,12 @@ The end. \netaddress{user (at) example dot org} \personalURL{http://example.org/~user/} -\maketitle - \begin{document} +\maketitle + \begin{abstract} -This is an example article for a regular \TUB{} issue. +This is an example article for \TUB{}. \end{abstract} \section{Introduction} @@ -5592,22 +6465,23 @@ We recommend the graphicx package for image inclusions, and the hyperref package for active url's (in the \acro{PDF} output). Nowadays \TUB\ is produced using \acro{PDF} files exclusively. -The \texttt{ltug*} classes provide these abbreviations, among many others: +The \texttt{ltugboat} class provides these abbreviations and many more: -{\small -\begin{verbatim} +% verbatim blocks are often better in \small +\begin{verbatim}[\small] \AllTeX \AMS \AmS \AmSLaTeX \AmSTeX \aw \AW \BibTeX \CTAN \DTD \HTML -\ISBN \ISSN \JTeX \LaTeXe -\Mc \mf \MFB \mtex \PCTeX \pcTeX \Pas +\ISBN \ISSN \LaTeXe +\Mc \mf \MFB \mtex \PCTeX \pcTeX \PiC \PiCTeX \plain \POBox \PS -\SC \SGML \SliTeX \TANGLE \TB \TP \TUB \TUG \tug +\SC \SGML \SliTeX \TANGLE \TB \TP +\TUB \TUG \tug \UG \UNIX \VAX \XeT \WEB \WEAVE \Dash \dash \vellipsis \bull \cents \Dag \careof \thinskip -\acro{FRED} -> {\small fred} % please use! +\acro{FRED} -> {\small[er] fred} % please use! \cs{fred} -> \fred \env{fred} -> \begin{fred} \meta{fred} -> <fred> @@ -5615,14 +6489,13 @@ The \texttt{ltug*} classes provide these abbreviations, among many others: \sfrac{3/4} -> 3/4 \booktitle{Book of Fred} \end{verbatim} -} For more information, see the ltubguid document at: \url{http://mirror.ctan.org/macros/latex/contrib/tugboat} +(we recommend using \verb|mirror.ctan.org| for \CTAN\ references). Email \verb|tugboat@tug.org| if problems or questions. - \bibliographystyle{plain} % we recommend the plain bibliography style \nocite{book-minimal} % just making the bibliography non-empty \bibliography{xampl} % xampl.bib comes with BibTeX @@ -5633,17 +6506,17 @@ Email \verb|tugboat@tug.org| if problems or questions. - + Concept Index - + - + Command Index - + -- cgit v1.2.3