From 03c75c44272fafbdc68ad57c2895873f73a46a27 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 12 May 2015 22:34:18 +0000 Subject: latex2e-help-texinfo (12may15) git-svn-id: svn://tug.org/texlive/trunk@37355 c570f23f-e606-0410-a88d-b1316a301751 --- .../doc/latex/latex2e-help-texinfo/latex2e.dbk | 1321 ++++++++++++-------- 1 file changed, 787 insertions(+), 534 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 10eb5b9ea47..960c331c619 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk @@ -4,28 +4,29 @@ ]> -&latex;2e reference manual (May 2014) +&latex;2e unofficial reference manual (May 2015) + - - + + + - + + - - - + This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2014. +document preparation system, version of May 2015. This manual was originally translated from LATEX.HLP v1.0a in the VMS Help Library. The pre-translation version was written by @@ -34,13 +35,13 @@ George D. Greenwade of Sam Houston State University. 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 -&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). +&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, 2013, -2014 Karl Berry. +2014, 2015 Karl Berry. Copyright 1988, 1994, 2007 Stephen Gilmore. @@ -62,7 +63,7 @@ into another language, under the above conditions for modified versions. This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2014. +document preparation system, version of May 2015. This manual was originally translated from LATEX.HLP v1.0a in the VMS Help Library. The pre-translation version was written by @@ -71,13 +72,13 @@ George D. Greenwade of Sam Houston State University. 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 -&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). +&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, 2013, -2014 Karl Berry. +2014, 2015 Karl Berry. Copyright 1988, 1994, 2007 Stephen Gilmore. @@ -99,12 +100,10 @@ into another language, under the above conditions for modified versions. -&latex;2e +&latex;2e: An unofficial reference manual -This document is an unofficial reference manual for &latex;, a -document preparation system, version as of May 2014. It is -intended to cover &latex;2e, which has been the standard version of -&latex; for many years. +This document is an unofficial reference manual (version of +May 2015) for &latex;2e, a document preparation system. @@ -112,183 +111,350 @@ intended to cover &latex;2e, which has been the standard version of About this document -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 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. - -The home page for this document is +http://home.gna.org/latexrefman home page +This is an unofficial reference manual for the &latex;2e document +preparation system, which is a macro package for the &tex; +typesetting program (see Overview). This document’s home page is http://home.gna.org/latexrefman. That page has links to the -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: +current output in various formats, sources, mailing list archives and +subscriptions, and other infrastructure. -http://www.ctan.org/pkg/latex-doc-ptr -Two pages of recommended references to &latex; documentation. +&latex; vs. &latex;2e +In this document, we will mostly just use ‘&latex;’ rather than +‘&latex;2e’, since the previous version of &latex; (2.09) was +retired many years ago. -http://www.ctan.org/pkg/first-latex-doc -Writing your first document, with a bit of both text and math. - -http://www.ctan.org/pkg/usrguide -The guide for document authors maintained as part of &latex;; there -are several others. +unofficial nature of this manual +&latex; Project team +latexrefman-discuss@gna.org email address +&latex; is currently maintained by a group of volunteers +(http://latex-project.org). The official documentation written by +the &latex; project is available from their web site. This 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. + +This document is a reference. There is a vast array of other sources +of information about &latex;, at all levels. Here are a few +introductions. + +http://ctan.org/pkg/latex-doc-ptr +latex-doc-ptr document +Two pages of recommended references to &latex; documentation. + +http://ctan.org/pkg/first-latex-doc +first-latex-doc document +Writing your first document, with a bit of both text and math. + +http://ctan.org/pkg/usrguide +usrguide official documentation +The guide for document authors that is maintained as part of &latex;; +there are plenty of others available elsewhere. + +http://ctan.org/pkg/lshort +lshort document +A short introduction to &latex;, translated to many languages. http://tug.org/begin.html -Introduction to the &tex; system, including &latex;. - +Introduction to the &tex; system, including &latex;, with further +references. + + Overview of &latex; -What is &latex;? - overview of &latex; basics of &latex; +Knuth, Donald E. +Lamport, Leslie &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: + +&latex; is a system for typesetting documents. It was originally +created by Leslie Lamport and is now maintained by a group of volunteers +(http://latex-project.org). It is widely used, particularly for +complex and technical documents, such as those involving mathematics. + +macro package, &latex; as +A &latex; user writes an input file containing text along with +interspersed commands, for instance commands describing how the text +should be formatted. It is implemented as a set of related commands +that interface with Donald E. Knuth’s &tex; typesetting program +(the technical term is that &latex; is a macro package for the +&tex; engine). The user produces the output document by giving that +file to the &tex; engine. + +The term &latex; is also sometimes used to mean the language in which +the document is marked up, that is, to mean the set of commands +available to a &latex; user. + +Lamport &tex; +pronunciation +The name &latex; is short for “Lamport &tex;”. It is pronounced +LAH-teck or LAY-teck, or sometimes LAY-tecks. Inside a document, +produce the logo with \LaTeX. Where use of the logo is not +sensible, such as in plain text, write it as ‘LaTeX’. + + + + +Starting and ending + + +starting & ending +ending & starting +hello, world + +&latex; files have a simple global structure, with a standard +starting and ending. Here is a “hello, world” example: + +\documentclass{article} +\begin{document} +Hello, \LaTeX\ world. +\end{document} + +document class, defined +Here, the ‘article’ is the so-called document class, +implemented in a file article.cls. Any document class can be +used. A few document classes are defined by &latex; itself, and vast +array of others are widely available. See Document classes. + +preamble, defined +You can include other &latex; commands between the +\documentclass and the \begin{document} commands. +This area is called the preamble. + +The \begin{document} ... \end{document} is a so-called +environment; the ‘document’ environment (and no others) is +required in all &latex; documents. &latex; provides many +environments itself, and many more are defined separately. +See Environments. -The main output file, which is one of: +The following sections discuss how to produce PDF or other output from +a &latex; input file. + + + + +Output files + +&latex; produces a main output file and at least two accessory files. +The main output file’s name ends in either .dvi or .pdf. .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). +xdvi command +dvips command +dvipdfmx command +dvitype command +If &latex; is invoked with the system command latex then it +produces a DeVice Independent file, with extension .dvi. You +can view this file with a command such as xdvi, or convert +it to a PostScript .ps file with dvips or to a +Portable Document Format .pdf file with dvipdfmx. +The contents of the file can be dumped in human-readable form with +dvitype. A vast array of other DVI utility programs are +available (http://mirror.ctan.org/tex-archive/dviware). .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 command -Lua&tex; -If invoked as lualatex, a .pdf file is created using -the Lua&tex; engine (http://luatex.org). - -xelatex command -Xe&tex; -If invoked as xelatex, a .pdf file is created using -the Xe&tex; engine (http://tug.org/xetex). +If &latex; is invoked via the system command pdflatex, +among other commands (see &tex; engines), then the main output is +a Portable Document Format (PDF) file. Typically this is a +self-contained file, with all fonts and images included. -Many other less-common variants of &latex; (and &tex;) exist, which -can produce HTML, XML, and other things. +&latex; also produces at least two additional files. -transcript file +.log +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. +This transcript file contains summary information such as a list of +loaded packages. It also includes diagnostic messages and perhaps +additional information for any errors. -auxiliary file +.aux +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 -list them all. Xxx components? +cross references, resolving +forward references, resolving +references, resolving forward +Auxiliary information is used by &latex; for things such as +cross references. For example, the first time that &latex; finds a +forward reference—a cross reference to something that has not yet +appeared in the source—it will appear in the output as a doubled +question mark ??. When the referred-to spot does eventually +appear in the source then &latex; writes its location information to +this .aux file. On the next invocation, &latex; reads the +location information from this file and uses it to resolve the +reference, replacing the double question mark with the remembered +location. + +.lof file +list of figures file +.lot file +list of tables file +.toc file +table of contents file +contents file +&latex; may produce yet more files, characterized by the filename +ending. These include a .lof file that is used to make a list +of figures, a .lot file used to make a list of tables, and a +.toc file used to make a table of contents. A particular class +may create others; the list is open-ended. + + + + +&tex; engines + +engines, &tex; +implementations of &tex; +UTF-8 +Unicode input, native +TrueType fonts +OpenType fonts + +&latex; is defined to be a set of commands that are run by a &tex; +implementation (see Overview). This section gives a terse +overview of the main programs. + +latex +pdflatex +pdf&tex; engine +etex command +e-&tex; +In &tex; Live (http://tug.org/texlive, if &latex; is invoked +via either the system command latex or pdflatex, +then the pdf&tex; engine is run (http://ctan.org/pkg/pdftex). +When invoked as latex, the main output is a .dvi +file; as pdflatex, the main output is a .pdf file. + +pdf&tex; incorporates the e-&tex; extensions to Knuth’s original +program (http://ctan.org/pkg/etex), including additional +programming features and bi-directional typesetting, and has plenty of +extensions of its own. e-&tex; is available on its own as the +command etex, but this is plain &tex; (and produces +.dvi). + +In other &tex; distributions, latex may invoke e-&tex; +rather than pdf&tex;. In any case, the e-&tex; extensions can be +assumed to be available in &latex;. + +lualatex +lualatex command +Lua&tex; +If &latex; is invoked via the system command lualatex, the +Lua&tex; engine is run (http://ctan.org/pkg/luatex). This +program allows code written in the scripting language Lua +(http://luatex.org) to interact with &tex;’s typesetting. +Lua&tex; handles UTF-8 Unicode input natively, can handle OpenType +and TrueType fonts, and produces a .pdf file by default. +There is also dvilualatex to produce a .dvi file, +but this is rarely used. + +xelatex +xelatex command +Xe&tex; +If &latex; is invoked with the system command xelatex, the +Xe&tex; engine is run (http://tug.org/xetex). Like Lua&tex;, +Xe&tex; also natively supports UTF-8 Unicode and TrueType and +OpenType fonts, though the implementation is completely different, +mainly using external libraries instead of internal code. Xe&tex; +produces a .pdf file as output; it does not support DVI output. + + +Other variants of &latex; and &tex; exist, e.g., to provide +additional support for Japanese and other languages ([u]p&tex;, +http://ctan.org/pkg/ptex, http://ctan.org/pkg/uptex). + + + + +&latex; command syntax + +command syntax \ 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. +In the &latex; input file, a command name starts with a \; the +name itself then consists of either (a) a string of letters or +(b) a single non-letter. -case sensitivity of &latex; -&latex; is case sensitive. Enter all commands in lower case unless -explicitly directed to do otherwise. +A command may be followed by zero, one, or more arguments, either +required or optional. Required arguments are contained in curly +braces, {...}. Optional arguments are contained in square +brackets, [...]. Generally, but not universally, if the +command accepts an optional argument, it comes first, before any +required arguments. - - - -Starting & ending - -starting & ending -ending & starting - -A minimal input file looks like the following: +Some commands have a * form that is related to the form without +a *, such as \chapter and \chapter*. -\documentclass{class} -\begin{document} -your text -\end{document} - -where the class is a valid document class for &latex;. -See Document classes, for details of the various document classes -available locally. +&latex; commands are case sensitive; neither \Begin{document} +nor \begin{Document} will work. Most commands are lowercase, +but in any event you must enter all commands in the same case as they +are defined. -preamble, defined -You may include other &latex; commands between the \documentclass -and the \begin{document} commands (this area is called the -preamble). +This manual describes all accepted options and *-forms for the +commands it covers (barring unintentional omissions, a.k.a. bugs). + - + Document classes document classes classes of documents \documentclass -The class of a given document is defined with the command: +The document’s overall class is defined with this command, which is +normally the first command in a &latex; source file. \documentclass[options]{class} -The \documentclass command must be the first command in a -&latex; source file. - 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): +The following document class names are built into &latex;. +(Many other document classes are available as separate packages; +see Overview.) -article report book letter slides - - - -Standard options are described below. +article +For a journal article, a presentation, and miscellaneous general use. + +book +Full-length books, including chapters and possibly including front +matter, such as a preface, and back matter, such as an appendix +(see Front/back matter). + +report +For documents of length between an article and a book, +such as technical reports or theses, which may contain several chapters. + +slides +For slide presentations—rarely used today. In its place the +beamer package is perhaps the most prevalent (see beamer +template). + + +Standard options are described in the next section. - + Document class options document class options @@ -296,10 +462,9 @@ classes are available as add-ons; see Overview): 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 -them with a comma: +You can specify so-called global options or class options to +the \documentclass command by enclosing them in square brackets. +To specify more than one option, separate them with a comma, as in: \documentclass[option1,option2,...]{class} @@ -334,21 +499,39 @@ size (default is letterpaper): notitlepage option Miscellaneous other options: -draft, final +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. +Mark (draft) or do not mark (final) overfull boxes with a +black box in the margin; default is final. + +fleqn +flush left equations +centered equations +equations, flush left vs. centered +Put displayed formulas flush left; default is centered. + +landscape +landscape orientation +portrait orientation +Selects landscape format; default is portrait. + +leqno +left-hand equation numbers +right-hand equation numbers +equation numbers, left vs. right +Put equation numbers on the left side of equations; default is the right side. + +openbib +bibliography format, open +Use “open” bibliography format. + +titlepage +notitlepage +title page, separate or run-in +Specifies whether the title page is separate; default depends on the class. -These options are not available with the slides class: +The following options are not available with the slides class. onecolumn option twocolumn option @@ -365,34 +548,35 @@ size (default is letterpaper): \evensidemargin \oddsidemargin Selects one- or two-sided layout; default is oneside, except -for the book class. +that in the book class the default is twoside. -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 -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. +For one-sided printing, the text is centered on the page. For two-sided +printing, 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, with \oddsidemargin +being 40% of the difference between \paperwidth and +\textwidth, and \evensidemargin is the remainder. openright openany -Determines if a chapter should start on a -right-hand page; default is openright for book. +Determines if a chapter should start on a right-hand page; default is +openright for book, and openany for report. +clock option to slides class The slides class offers the option clock for printing the time at the bottom of each note. - -packages, loading loading additional packages +packages, loading additional +additional packages, loading \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. +To specify more than one package, you can separate them with a comma, +as in \usepackage{pkg1,pkg2,...}, or use multiple +\usepackage commands. global options options, global @@ -403,7 +587,7 @@ by the selected document class are passed on to the packages loaded with - + Fonts @@ -415,7 +599,7 @@ and a style. The &latex; commands for doing this are described here. - + Font styles font styles @@ -431,13 +615,22 @@ arguments. The scope of the declaration form lasts until the next type style command or the end of the current group. These commands, in both the argument form and the declaration form, -are cumulative; e.g.,, you can say either \sffamily\bfseries or +are cumulative; e.g., you can say either \sffamily\bfseries or \bfseries\sffamily to get bold sans serif. You can alternatively use an environment form of the declarations; for instance, \begin{ttfamily}...\end{ttfamily}. -These commands automatically supply an italic correction if needed. +\nocorrlist +\nocorr +These font-switching commands automatically insert italic corrections +if needed. (See \/, for the details of italic corrections.) +Specifically, they insert the italic correction unless the following +character is in the list \nocorrlist, which by default consists +of a period and a comma. To suppress the automatic insertion of +italic correction, use \nocorr at the start or end of the +command argument, such as \textit{\nocorr text} or +\textsc{text \nocorr}. \textrm (\rmfamily) \textrm @@ -548,8 +741,8 @@ FAQ entry: http: &latex; also provides the following commands, which unconditionally switch to the given style, that is, are not cumulative. Also, they are used differently than the above commands: {\cmd -...} instead of \cmd{...}. These are two very -different things. +...} instead of \cmd{...}. These are two unrelated +constructs. \bf\bf bold font @@ -602,7 +795,7 @@ their place. - + Font sizes font sizes typeface sizes @@ -654,7 +847,7 @@ these commands; for instance, \begin{tiny}...\end{tiny}. - + Low-level font commands low-level font commands font commands, low-level @@ -743,7 +936,7 @@ followed by \selectfont. - + Layout layout commands @@ -751,7 +944,7 @@ followed by \selectfont. - + <literal>\onecolumn</literal> \onecolumn one-column output @@ -761,7 +954,7 @@ single-column output. This is the default. - + <literal>\twocolumn</literal> \twocolumn multicolumn text @@ -812,7 +1005,7 @@ and the main text. Default ‘20pt plus2pt minus4pt̵ - + <literal>\flushbottom</literal> \flushbottom @@ -826,7 +1019,7 @@ page. - + <literal>\raggedbottom</literal> \raggedbottom stretch, omitting vertical @@ -837,7 +1030,7 @@ stretched. - + Page layout parameters page layout parameters @@ -914,14 +1107,14 @@ then divided by two. \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 +the first line of text. For the standard classes, the default is the same as the font size, e.g., ‘10pt’ at ‘10pt’. - + Sectioning sectioning @@ -929,7 +1122,7 @@ same as the font size, e.g., ‘10pt’ at ‘
  • \part\part \chapter\chapter -(report and book class only) +(report and book class only) \section\section \subsection\subsection \subsubsection\subsubsection @@ -982,7 +1175,7 @@ The setting - + Cross references cross references @@ -991,7 +1184,7 @@ the reader to them, as in “See Figure 3 for more details.” - + <literal>\label</literal> \label @@ -1004,7 +1197,8 @@ the reader to them, as in “See Figure 3 for more details.” inside a numbered environment assigns that number to key. A key name can consist of any sequence of letters, digits, or -punctuation characters. Upper and lowercase letters are distinguished. +punctuation characters. Upper and lowercase letters are +distinguished, as usual. To avoid accidentally creating two labels with the same name, it is common to use labels consisting of a prefix and a suffix separated by @@ -1026,7 +1220,7 @@ a colon or period. Some conventionally-used prefixes: - + <literal>\pageref{<replaceable>key</replaceable>}</literal> \pageref cross referencing with page number @@ -1042,7 +1236,7 @@ the place in the text where the corresponding - + <literal>\ref{<replaceable>key</replaceable>}</literal> \ref cross referencing, symbolic @@ -1063,7 +1257,7 @@ such as the word ‘Section’ or ‘Figure’, just the bare nu - + Environments environments @@ -1079,7 +1273,7 @@ Each environment begins and ends in the same manner: - + <literal>abstract</literal> abstract environment @@ -1094,7 +1288,7 @@ Each environment begins and ends in the same manner: - + <literal>array</literal> array environment arrays, math @@ -1110,8 +1304,8 @@ Each environment begins and ends in the same manner: 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: +specified by a single letter that tells how items in each row of that +column should be formatted, as follows: c centered @@ -1148,7 +1342,7 @@ namely \arrayrulewidth and \arraystretch. - + <literal>center</literal> center environment @@ -1169,7 +1363,7 @@ string \\. - + <literal>\centering</literal> \centering @@ -1198,7 +1392,7 @@ second line \\ - + <literal>description</literal> description environment @@ -1231,7 +1425,7 @@ plain typewriter}]. - + <literal>displaymath</literal> displaymath environment @@ -1256,17 +1450,17 @@ equation number, use the equation environment (see - + <literal>document</literal> document environment The document environment encloses the body of a document. -It is required in every &latex; document. See Starting & ending. +It is required in every &latex; document. See Starting and ending. - + <literal>enumerate</literal> enumerate environment @@ -1322,7 +1516,7 @@ letters: - + <literal>eqnarray</literal> eqnarray environment @@ -1349,7 +1543,7 @@ others) from the amsmath package. \\ (for eqnarray) The eqnarray environment is used to display a sequence of -equations or inequalities. It is very much like a three-column +equations or inequalities. It is similar to a three-column array environment, with consecutive rows separated by \\ and consecutive items within a row separated by an &. @@ -1372,7 +1566,7 @@ zero width. - + <literal>equation</literal> equation environment @@ -1391,7 +1585,7 @@ on the page, and also places an equation number in the right margin. - + <literal>figure</literal> figure inserting figures @@ -1427,9 +1621,8 @@ output. To ameliorate this, use the stfloats or 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 +(Here)—at the position in the text where the figure environment +appears. However, t is not allowed by itself; t is automatically added. here, putting floats @@ -1451,7 +1644,7 @@ The ! specifier does not mean “put see above. -The standard report and article classes use the default placement +The standard report and article classes use the default placement tbp. The body of the figure is made up of whatever text, &latex; commands, @@ -1467,7 +1660,7 @@ present, it is used in the list of figures instead of text \bottomfraction -The maximum fraction of the page allowed to be occuped by floats at +The maximum fraction of the page allowed to be occupied by floats at the bottom; default ‘.3’. \floatpagefraction\floatpagefraction @@ -1498,17 +1691,21 @@ floats; default ‘.7’. 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: +Counters relating to the number of floats on a page: -\bottomnumber\bottomnumber +bottomnumberbottomnumber Maximum number of floats that can appear at the bottom of a text page; default 1. -\topnumber\topnumber +dbltopnumberdbltopnumber +Maximum number of full-sized floats that can appear at the top of a +two-column page; default 2. + +topnumbertopnumber Maximum number of floats that can appear at the top of a text page; default 2. -\totalnumber\totalnumber +totalnumbertotalnumber Maximum number of floats that can appear on a text page; default 3. The principal &tex; FAQ entry relating to floats: @@ -1516,7 +1713,7 @@ default 2. - + <literal>filecontents</literal>: Create external files filecontents external files, creating @@ -1561,13 +1758,13 @@ unrelated to using the created file. So you need to use, for instance, \input or \usepackage or \bibliography or whatever is applicable, to use the created file. -This environment is also useful to make a self-contained document, for -example, for a bug report, or to keep a .bib file with the main -document. +This environment is also useful to make a document in a self-contained +file, for example, for a bug report, or to keep the content of a +.bib file in the same file as the main document. - + <literal>flushleft</literal> flushleft environment left-justifying text, environment for @@ -1586,7 +1783,7 @@ right Each line must be terminated with the string \\. - + <literal>\raggedright</literal> \raggedright ragged right text @@ -1606,7 +1803,7 @@ command that ends the paragraph unit. - + <literal>flushright</literal> flushright environment ragged left text, environment for @@ -1625,7 +1822,7 @@ left. Each line must be terminated with the string \\. - + <literal>\raggedleft</literal> \raggedleft ragged left text @@ -1645,7 +1842,7 @@ command that ends the paragraph unit. - + <literal>itemize</literal> itemize environment \item @@ -1771,7 +1968,7 @@ see \parskip): - + <literal>letter</literal> environment: writing letters letter @@ -1779,7 +1976,7 @@ see \parskip): - + <literal>list</literal> list lists of items, generic @@ -1808,7 +2005,7 @@ empty, i.e., {}, which leaves the default spacing. - + <literal>math</literal> math environment @@ -1826,7 +2023,7 @@ See Math formulas. - + <literal>minipage</literal> minipage environment @@ -1865,7 +2062,7 @@ footnotes; they may wind up at the bottom of the wrong minipage. - + <literal>picture</literal> picture @@ -1946,32 +2143,34 @@ be the lower left corner of the box. - + <literal>\circle</literal> \circle -\circle[*]{diameter} +Synopsis: +\circle[*]{diameter} The \circle command produces a circle with a diameter as close to the specified one as possible. The *-form of the command draws a solid circle. -Circles up to 40 pt can be drawn. +Circles up to 40pt can be drawn. - + <literal>\makebox</literal> -\makebox (picture) +\makebox (for picture) -\makebox(width,height)[position]{...} - +Synopsis: +\makebox(width,height)[position]{text} + The \makebox command for the picture environment is similar to the normal \makebox command except that you must specify a -width and height in multiples of \unitlength. +width and height in multiples of \unitlength. -The optional argument, [position], specifies the quadrant that -your text appears in. You may select up to two of the following: +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. @@ -1990,7 +2189,7 @@ your text appears in. You may select up to two of the following: - + <literal>\framebox</literal> \framebox @@ -2010,7 +2209,7 @@ and the contents of the box. - + <literal>\dashbox</literal> \dashbox @@ -2024,12 +2223,12 @@ and the contents of the box. rectangle has overall width rwidth and height rheight. The text is positioned at optional pos. -A dashed box looks best when the rwidth and rheight are -multiples of the dlen. +A dashed box looks best when the rwidth and rheight are +multiples of the dlen. - + <literal>\frame</literal> \frame @@ -2043,7 +2242,7 @@ space is put between the frame and the object. - + <literal>\line</literal> \line @@ -2054,14 +2253,16 @@ space is put between the frame and the object. The \line command draws a line with the given length and slope xslope/yslope. +pict2e package +graphics packages 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. +through 6. For lines of any slope, and plenty of other shapes, +see pict2e and many other packages on CTAN. - + <literal>\linethickness</literal> \linethickness @@ -2074,7 +2275,7 @@ circles, or the quarter circles drawn by \oval. - + <literal>\thicklines</literal> \thicklines @@ -2084,7 +2285,7 @@ cf. \linethickness and - + <literal>\thinlines</literal> \thinlines @@ -2094,7 +2295,7 @@ cf. \linethickness and - + <literal>\multiput</literal> \multiput @@ -2108,7 +2309,7 @@ pattern across a picture. obj is first placed at pos - + <literal>\oval</literal> \oval @@ -2135,19 +2336,21 @@ boxes with rounded corners. - + <literal>\put</literal> - \put -\put(x coord,y coord){ ... } +Synopsis: -The \put command places the item specified by the mandatory -argument at the given coordinates. +\put(xcoord,ycoord){ ... } + +The \put command places the material specified by the +(mandatory) argument in braces at the given coordinate, +(xcoord,ycoord). - + <literal>\shortstack</literal> \shortstack @@ -2170,22 +2373,22 @@ positions are: - + <literal>\vector</literal> \vector Synopsis: -\vector(x-slope,y-slope){length} +\vector(xslope,yslope){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 xslope and yslope +values must lie between −4 and +4, inclusive. - + <literal>quotation</literal> quotation @@ -2208,7 +2411,7 @@ normally. - + <literal>quote</literal> quote @@ -2216,7 +2419,7 @@ normally. displaying quoted text without paragraph indentation paragraph indentations in quoted text, omitting -Snyopsis: +Synopsis: \begin{quote} text @@ -2230,7 +2433,7 @@ blank line between text produces a new paragraph. - + <literal>tabbing</literal> tabbing environment @@ -2254,7 +2457,7 @@ the width of each column is constant and known in advance. This environment can be broken across pages, unlike the tabular environment. -The following commands can be used inside a tabbing enviroment: +The following commands can be used inside a tabbing environment: \\ (tabbing)\\ (tabbing) End a line. @@ -2335,7 +2538,7 @@ function \= fact(n : integer) : integer;\\ - + <literal>table</literal> table @@ -2368,7 +2571,7 @@ you wish. The \caption command allows you to title your tabl - + <literal>tabular</literal> tabular environment lines in tables @@ -2491,7 +2694,7 @@ environment: - + <literal>\multicolumn</literal> \multicolumn @@ -2517,7 +2720,7 @@ for flushleft, r for flushright. The third mandatory argumen - + <literal>\cline</literal> \cline @@ -2531,7 +2734,7 @@ which are specified in the mandatory argument. - + <literal>\hline</literal> \hline @@ -2542,7 +2745,7 @@ of a table. - + <literal>\vline</literal> \vline @@ -2554,7 +2757,7 @@ move the line to the edge of the column. It can also be used in an - + <literal>thebibliography</literal> thebibliography @@ -2585,7 +2788,7 @@ less than 10 references, 99 for ones with less than 100, etc. - + <literal>\bibitem</literal> \bibitem @@ -2608,7 +2811,7 @@ associated label. - + <literal>\cite</literal> \cite @@ -2628,7 +2831,7 @@ citation. For example, \cite[p.~314]{knuth} might produce - + <literal>\nocite</literal> \nocite @@ -2639,7 +2842,7 @@ which is a list of one or more citation keys, on the .aux f - + Using Bib&tex; using Bib&tex; @@ -2675,7 +2878,7 @@ publication. 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. +http://mirror.ctan.org/biblio/bibtex/contrib. The \bibliography command is what actually produces the bibliography. The argument to \bibliography refers to files @@ -2686,7 +2889,7 @@ Bib&tex; format. Only the entries referred to via \cite and - + <literal>theorem</literal> theorem environment @@ -2705,7 +2908,7 @@ possibilities for n are described under \new - + <literal>titlepage</literal> titlepage environment @@ -2729,7 +2932,7 @@ produce a standard title page without a titlepage environment - + <literal>verbatim</literal> verbatim environment @@ -2754,7 +2957,7 @@ effect that they would on a typewriter. The verbatim uses a monospaced typewriter-like font (\tt). - + <literal>\verb</literal> \verb @@ -2778,7 +2981,7 @@ verbatim text. The delimiter must not appear in literal-text - + <literal>verse</literal> verse environment @@ -2804,7 +3007,7 @@ stanzas. - + Line breaking line breaking breaking lines @@ -2820,7 +3023,7 @@ some environments, you do the line breaking yourself with the - + <literal>\\</literal>[*][<replaceable>morespace</replaceable>] \\ force line break new line, starting @@ -2836,7 +3039,7 @@ except that it tells &latex; not to start a new page after the line. - + <literal>\obeycr</literal> & <literal>\restorecr</literal> \obeycr \restorecr @@ -2851,7 +3054,7 @@ in the output. - + <literal>\newline</literal> \newline new line, starting (paragraph mode) @@ -2862,14 +3065,14 @@ mode. - + <literal>\-</literal> (discretionary hyphen) \- (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 +that point. &latex; is pretty good at hyphenating, and usually finds +most of the correct hyphenation points, while almost never using an incorrect one. The \- command is used for the exceptional cases. @@ -2880,7 +3083,7 @@ that &latex; might otherwise have chosen. - + <literal>\fussy</literal> \fussy @@ -2893,7 +3096,7 @@ words, at the cost of an occasional overfull box. - + <literal>\sloppy</literal> The declaration \sloppy makes &tex; less fussy about line @@ -2904,7 +3107,7 @@ interword spacing. - + <literal>\hyphenation</literal> \hyphenation hyphenation, defining @@ -2924,7 +3127,7 @@ misses the hyphenations in these words): - + <literal>\linebreak</literal> & <literal>\nolinebreak</literal> \linebreak \nolinebreak @@ -2948,7 +3151,7 @@ from a demand to a request. The priority must be a n - + Page breaking page breaking breaking pages @@ -2959,7 +3162,7 @@ but sometimes you may want to influence the breaks. - + <literal>\cleardoublepage</literal> \cleardoublepage @@ -2972,7 +3175,7 @@ In a two-sided printing style, it also makes the next page a right-hand - + <literal>\clearpage</literal> \clearpage flushing floats and starting a page @@ -2983,7 +3186,7 @@ figures and tables that have so far appeared in the input to be printed. - + <literal>\newpage</literal> \newpage new page, starting @@ -2994,7 +3197,7 @@ floats (see \clearpage above). - + <literal>\enlargethispage</literal> \enlargethispage enlarge current page @@ -3013,7 +3216,7 @@ much as possible. This is normally used together with an explicit - + <literal>\pagebreak</literal> & <literal>\nopagebreak</literal> \pagebreak \nopagebreak @@ -3038,7 +3241,7 @@ insistent the request is. - + Footnotes footnotes, creating @@ -3049,7 +3252,7 @@ produced with two commands, the \footnotemark and the - + <literal>\footnote</literal> \footnote @@ -3068,7 +3271,7 @@ tables or in a tabular environment. (See following sections. - + <literal>\footnotemark</literal> \footnotemark @@ -3086,7 +3289,7 @@ markers referring to the same footnote with - + <literal>\footnotetext</literal> \footnotetext @@ -3103,7 +3306,7 @@ appear in outer paragraph mode. - + Symbolic footnotes footnotes, symbolic instead of numbered @@ -3121,7 +3324,7 @@ redefine \@fnsymbol. - + Footnote parameters footnote parameters @@ -3131,7 +3334,7 @@ redefine \@fnsymbol. 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). +slides, where it does not appear). \footnotesep\footnotesep The height of the strut placed at the beginning of the footnote. By @@ -3144,7 +3347,7 @@ footnotes. This is ‘6.65pt’ for ‘ - + Definitions definitions @@ -3154,7 +3357,7 @@ footnotes. This is ‘6.65pt’ for ‘ - + <literal>\newcommand</literal> & <literal>\renewcommand</literal> \newcommand commands, defining new ones @@ -3164,8 +3367,8 @@ footnotes. This is ‘6.65pt’ for ‘ \newcommand and \renewcommand define and redefine a command, respectively. Synopses: - \newcommand[*]{cmd}[nargs][optarg]{defn} -\renewcommand[*]{cmd}[nargs][optarg]{defn} + \newcommand[*]{cmd}[nargs][optargval]{defn} +\renewcommand[*]{cmd}[nargs][optargval]{defn} * *-form of defining new commands @@ -3173,7 +3376,7 @@ command, respectively. Synopses: multiple paragraphs of text (not \long, in plain &tex; terms). cmd -The command name beginning with \. For \newcommand, it +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. @@ -3182,12 +3385,14 @@ must not be already defined and must not begin with \end; for that the command will take. The default is for the command to have no arguments. -optarg -If this optional parameter is present, it means that the command’s -first argument is optional. The default value of the optional -argument (i.e., if it is not specified in the call) is optarg, -or, if that argument is present in the \newcommand but has an -empty value, the string ‘def’. +optargval +If this optional parameter is present, it means that the first +argument of command cmd is optional and its default value (i.e., +if it is not specified in the call) is optarg. In otherwise, +when calling the macro, if no [value] is given after +cmd—which is different from having [] for an +empty value—then string ‘optargval’ becomes the +value of #1 within defn when the macro is expanded. defn The text to be substituted for every occurrence of cmd; a @@ -3198,26 +3403,26 @@ text of the nth argument. - + <literal>\newcounter</literal> \newcounter counters, defining new Synopsis: -\newcounter{cnt}[countername] +\newcounter{countername}[supercounter] -The \newcounter command defines a new counter named cnt. +The \newcounter command defines a new counter named countername. The new counter is initialized to zero. -Given the optional argument [countername], cnt -will be reset whenever countername is incremented. +Given the optional argument [super], countername +will be reset whenever the counter named supercounter is incremented. See Counters, for more information about counters. - + <literal>\newlength</literal> \newlength lengths, defining new @@ -3227,7 +3432,7 @@ will be reset whenever countername is incremented. \newlength{\arg} The \newlength command defines the mandatory argument as a -length command with a value of 0in. The argument must +length command with a value of zero. The argument must be a control sequence, as in \newlength{\foo}. An error occurs if \foo is already defined. @@ -3236,7 +3441,7 @@ for more information about lengths in general. - + <literal>\newsavebox</literal> \newsavebox @@ -3249,7 +3454,7 @@ defined, to refer to a new bin for storing boxes. - + <literal>\newenvironment</literal> & <literal>\renewenvironment</literal> \newenvironment \renewenvironment @@ -3296,7 +3501,7 @@ may not contain any argument parameters. - + <literal>\newtheorem</literal> \newtheorem theorems, defining @@ -3330,7 +3535,7 @@ not both. - + <literal>\newfont</literal> \newfont fonts, new commands for @@ -3349,7 +3554,7 @@ More commonly, fonts are defined in families through .fd fi - + <literal>\protect</literal> \protect @@ -3380,7 +3585,7 @@ be preceded by \protect. - + Counters counters, a list of variables, a list of @@ -3400,7 +3605,7 @@ subsubsection - + <literal>\alph \Alph \arabic \roman \Roman \fnsymbol</literal>: Printing counters All of these commands take a single counter as an argument, for @@ -3418,7 +3623,7 @@ instance, \alph{enumi}. \roman\roman uses lowercase roman numerals: ‘i’, ‘ii’, ... -\roman\roman +\Roman\Roman uses uppercase roman numerals: ‘I’, ‘II’, ... \fnsymbol\fnsymbol @@ -3426,14 +3631,16 @@ instance, \alph{enumi}. symbols (conventionally used for labeling footnotes). The value of counter must be between 1 and 9, inclusive. -The symbols mostly aren’t supported in Info, but here are the names: -asterisk(*) dagger ddagger section-sign paragraph-sign parallel -double-asterisk(**) double-dagger double-ddagger +Here are the symbols (as Unicode code points in ASCII output): + +asterisk(*) dagger(‡) ddagger(‡) +section-sign(§) paragraph-sign(¶) parallel(∥) +double-asterisk(**) double-dagger(‡‡) double-ddagger(‡‡) - + <literal>\usecounter{<replaceable>counter</replaceable>}</literal> \usecounter list items, specifying counter @@ -3449,7 +3656,7 @@ the list items. - + <literal>\value{<replaceable>counter</replaceable>}</literal> \value counters, getting value of @@ -3467,7 +3674,7 @@ be used anywhere &latex; expects a number, for example: - + <literal>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal> \setcounter counters, setting @@ -3475,14 +3682,14 @@ be used anywhere &latex; expects a number, for example: Synopsis: -\setcounter{\counter}{value} +\setcounter{counter}{value} -The \setcounter command sets the value of \counter to the +The \setcounter command sets the value of counter to the value argument. - + <literal>\addtocounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal> \addtocounter @@ -3491,7 +3698,7 @@ amount specified by the value argument, which may be - + <literal>\refstepcounter{<replaceable>counter</replaceable>}</literal> \refstepcounter @@ -3501,7 +3708,7 @@ current \ref value to be the result of \thecounter - + <literal>\stepcounter{<replaceable>counter</replaceable>}</literal> \stepcounter @@ -3510,7 +3717,7 @@ resets all subsidiary counters. - + <literal>\day \month \year</literal>: Predefined counters \day \month @@ -3528,7 +3735,7 @@ current day (see \today). - + Lengths lengths, defining and using @@ -3537,7 +3744,7 @@ length as an argument. - + <literal>\setlength{\<replaceable>len</replaceable>}{<replaceable>value</replaceable>}</literal> \setlength lengths, setting @@ -3549,7 +3756,7 @@ understands, i.e., inches (in), millimeters (mm - + \addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>} \addtolength lengths, adding to @@ -3560,7 +3767,7 @@ may be negative. - + <literal>\settodepth</literal> \settodepth @@ -3571,7 +3778,7 @@ equal to the depth of the text argument. - + <literal>\settoheight</literal> \settoheight @@ -3583,7 +3790,7 @@ equal to the height of the text argument. - + <literal>\settowidth{\<replaceable>len</replaceable>}{<replaceable>text</replaceable>}</literal> \settowidth @@ -3592,7 +3799,7 @@ to the width of the text argument. - + Predefined lengths lengths, predefined predefined lengths @@ -3620,7 +3827,7 @@ natural size, e.g., say - + Making paragraphs making paragraphs paragraphs @@ -3632,7 +3839,7 @@ a sectioning command. - + <literal>\indent</literal> \indent \parindent @@ -3649,7 +3856,7 @@ mode, otherwise 15pt for 10pt documents, < - + <literal>\noindent</literal> \noindent indent, suppressing @@ -3660,7 +3867,7 @@ the middle of a paragraph. - + <literal>\parskip</literal> \parskip vertical space before paragraphs @@ -3670,7 +3877,7 @@ before each paragraph. The default is 0pt plus1pt. - + Marginal notes marginal notes notes in the margin @@ -3730,7 +3937,7 @@ notes from falling off the bottom of the page. - + Math formulas math formulas formulas, math @@ -3785,7 +3992,7 @@ below summations. For example - + Subscripts & superscripts superscript subscript @@ -3802,7 +4009,7 @@ superscript. - + Math symbols math symbols symbols, math @@ -4447,7 +4654,7 @@ the pi symbol (\pi) in - + Math functions math functions functions, math @@ -4549,7 +4756,10 @@ spacing. \sinh \sup\sup -\sup +sup + + + \tan\tan \tan @@ -4560,7 +4770,7 @@ spacing. - + Math accents math accents accents, mathematical @@ -4636,7 +4846,7 @@ in math. These are different from accents in normal text - + Spacing in math mode spacing within math mode math mode, spacing @@ -4662,7 +4872,7 @@ commands for use in math mode: - + Math miscellany math miscellany @@ -4697,7 +4907,7 @@ For example, \overbrace{x+\cdots+x}^{k \rm\;times} \overline{text}\overline{text} Generates a horizontal line over tex. -For exampe, \overline{x+y}. +For example, \overline{x+y}. \sqrt[root]{arg}\sqrt[root]{arg} Produces the representation of the square root of arg. The @@ -4725,14 +4935,13 @@ descenders. - + Modes modes paragraph mode math mode left-to-right mode -lR mode - +LR mode When &latex; is processing your input text, it is always in one of three modes: @@ -4741,36 +4950,39 @@ modes: 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 +Mode changes occur only when entering or leaving an environment, or when &latex; is processing the argument of certain text-producing commands. -“Paragraph mode” is the most common; it’s the one &latex; is in -when processing ordinary text. In that mode, &latex; breaks your -text into lines and breaks the lines into pages. &latex; is in -“math mode” when it’s generating a mathematical formula. In “LR -mode”, as in paragraph mode, &latex; considers the output that it -produces to be a string of words with spaces between them. However, -unlike paragraph mode, &latex; keeps going from left to right; it -never starts a new line in LR mode. Even if you put a hundred words -into an \mbox, &latex; would keep typesetting them from left -to right inside a single box, and then complain because the resulting -box was too wide to fit on the line. - -&latex; is in LR mode when it starts making a box with an \mbox -command. You can get it to enter a different mode inside the box - for -example, you can make it enter math mode to put a formula in the box. -There are also several text-producing commands and environments for -making a box that put &latex; in paragraph mode. The box make by one of -these commands or environments will be called a parbox. When -&latex; is in paragraph mode while making a box, it is said to be in -“inner paragraph mode”. Its normal paragraph mode, which it starts out -in, is called “outer paragraph mode”. +Paragraph mode is the most common; it’s the one &latex; is in +when processing ordinary text. In this mode, &latex; breaks the +input text into lines and breaks the lines into pages. + +&latex; is in math mode when it’s generating a mathematical +formula, either displayed math or within a line. + +\mbox, and LR mode +In LR mode, as in paragraph mode, &latex; considers the output +that it produces to be a string of words with spaces between them. +However, unlike paragraph mode, &latex; keeps going from left to +right; it never starts a new line in LR mode. Even if you put a +hundred words into an \mbox, &latex; would keep typesetting +them from left to right inside a single box (and then most likely +complain because the resulting box was too wide to fit on the line). +&latex; is in LR mode when it starts making a box with an +\mbox command. You can get it to enter a different mode inside +the box—for example, you can make it enter math mode to put a +formula in the box. + +There are also several text-producing commands and environments for +making a box that put &latex; into paragraph mode. The box made 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” (no page breaks). Its normal paragraph +mode, which it starts out in, is called “outer paragraph mode”. - + Page styles styles, page page styles @@ -4780,7 +4992,7 @@ the page’s head and foot. The page style determines what goes in them. - + <literal>\maketitle</literal> titles, making \maketitle @@ -4820,7 +5032,7 @@ document. Use \\ to force a line break, as usual. - + <literal>\pagenumbering</literal> \pagenumbering page numbering style @@ -4829,7 +5041,9 @@ document. Use \\ to force a line break, as usual. \pagenumbering{style} -Specifies the style of page numbers, according to style: +Specifies the style of page numbers, according to style; also +resets the page number to 1. The style argument is one of +the following: arabic arabic numerals @@ -4848,7 +5062,7 @@ document. Use \\ to force a line break, as usual. - + <literal>\pagestyle</literal> \pagestyle header style @@ -4893,7 +5107,7 @@ the page. - + <literal>\thispagestyle{<replaceable>style</replaceable>}</literal> \thispagestyle @@ -4904,7 +5118,7 @@ changes to style for the current page only. - + Spaces spaces @@ -4916,7 +5130,7 @@ more often useful in math mode (see Spacin - + <literal>\hspace</literal> \hspace @@ -4936,10 +5150,12 @@ form. - + <literal>\hfill</literal> - \hfill + +stretch, infinite horizontal +infinite horizontal stretch The \hfill fill command produces a “rubber length” which has no natural space but can stretch or shrink horizontally as far as needed. @@ -4951,16 +5167,16 @@ equivalent to \hfill. - -<literal>\SPACE</literal> + +<literal>\SPACE</literal>: Normal interword space \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 +useful after punctuation which shouldn’t end a sentence. For example, +the article in Proc.\ Amer.\ Math\. Soc.\ is fundamental. It +is also often used after control sequences, as in \TeX\ is a nice system. In normal circumstances, \tab and \newline @@ -4968,9 +5184,10 @@ are equivalent to \ . - -<literal>\@</literal> + +<literal>\@</literal>: Force sentence-ending punctuation \@ + The \@ command makes the following punctuation character end a sentence even if it normally would not. This is typically used after @@ -4982,26 +5199,27 @@ a capital letter. Here are side-by-side examples with and without produces - +
    … in C. Pascal, though … … in C. Pascal, though …
    - -<literal>\thinspace</literal> + +<literal>\thinspace</literal>: Insert 1/6em \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 ’”. +is 1/6 of an em. This is the proper space to use between nested +quotes, as in ’”. - -<literal>\/</literal> + +<literal>\/</literal>: Insert italic correction \/ +italic correction The \/ command produces an italic correction. This is a small space defined by the font designer for a given character, @@ -5015,14 +5233,22 @@ normal letters, it can help. Compare f: f; (in the &tex; output, the ‘f’s are nicely separated) with f: f;. +When changing fonts with commands such as \textit{italic +text} or {\itshape italic text}, &latex; will +automatically insert an italic correction if appropriate (see Font +styles). + 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’) with pdf&tex;. +There is no concept of italic correction in math mode; spacing is done +in a different way. + - + <literal>\hrulefill</literal> \hrulefill @@ -5032,7 +5258,7 @@ rule. - + <literal>\dotfill</literal> \dotfill @@ -5043,7 +5269,7 @@ with dots instead of just white space. - + <literal>\addvspace</literal> \addvspace vertical space @@ -5054,50 +5280,56 @@ with dots instead of just white space. The \addvspace command normally adds a vertical space of height length. However, if vertical space has already been added to the same point in the output by a previous \addvspace command, then this -command will not add more space than needed to make the natural length -of the total vertical space equal to length. +command will not add more space than is needed to make the natural +length of the total vertical space equal to length. - + <literal>\bigskip \medskip \smallskip</literal> -These commands produce a given amount of space. +These commands produce a given amount of space, specified by the +document class. \bigskip \bigskip \bigskipamount -The same as \vspace{bigskipamount}, ordinarily about one line -space (with stretch and shrink). +The same as \vspace{\bigskipamount}, ordinarily about one line +space, with stretch and shrink (the default for the book and +article classes is 12pt plus 4pt minus 4pt). \medskip \medskip \medskipamount -The same as \vspace{medskipamount}, ordinarily -about half of a line space (with stretch and shrink). +The same as \vspace{\medskipamount}, ordinarily about half of +a line space, with stretch and shrink (the default for the book +and article classes is 6pt plus 2pt minus 2pt). \smallskip \smallskip \smallskipamount -The same as \vspace{smallskipamount}, ordinarily about a -quarter of a line space (with stretch and shrink). +The same as \vspace{\smallskipamount}, ordinarily about a +quarter of a line space, with stretch and shrink (the default for the +book and article classes is 3pt plus 1pt minus +1pt). -The \...amount parameters are determined by the document class. - - + <literal>\vfill</literal> \vfill +stretch, infinite vertical +infinite vertical stretch + 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 \hfill). - + <literal>\vspace[*]{<replaceable>length</replaceable>}</literal> \vspace @@ -5115,7 +5347,7 @@ space is not removed.
    - + Boxes boxes @@ -5125,7 +5357,7 @@ used in the arguments of the box-making commands. - + <literal>\mbox{<replaceable>text}</replaceable></literal> \mbox @@ -5136,7 +5368,7 @@ lines, so it can be used to prevent hyphenation. - + <literal>\fbox</literal> and <literal>\framebox</literal> \fbox @@ -5166,7 +5398,7 @@ argument. - + <literal>lrbox</literal> lrbox @@ -5179,7 +5411,7 @@ must have been declared with \newsavebox. - + <literal>\makebox</literal> \makebox @@ -5208,7 +5440,7 @@ see \makebox (picture). - + <literal>\parbox</literal> \parbox @@ -5252,7 +5484,7 @@ for this to work. - + <literal>\raisebox</literal> \raisebox @@ -5272,7 +5504,7 @@ ignoring its natural height and depth. - + <literal>\savebox</literal> \savebox @@ -5287,7 +5519,7 @@ declared with \newsavebox (see + <literal>\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}</literal> \sbox @@ -5303,8 +5535,8 @@ included in the normal output, it is saved in the box labeled - -<literal>\usebox{<replaceable>\boxcmd</replaceable></literal> + +<literal>\usebox{<replaceable>\boxcmd</replaceable>}</literal> \usebox Synopsis: @@ -5317,7 +5549,7 @@ included in the normal output, it is saved in the box labeled - + Special insertions &latex; provides commands for inserting characters that have a @@ -5325,7 +5557,7 @@ special meaning do not correspond to simple characters you can type. - + Reserved characters reserved characters characters, reserved @@ -5374,7 +5606,7 @@ with ", so the previous example could also be written as - + Text symbols text symbols @@ -5402,6 +5634,11 @@ not available in OT1; you may need to load the textcomp packa logo, &latex; The &latex; logo. +\LaTeXe\LaTeXe +&latex;2e logo +logo, &latex;2e +The &latex;2e logo. + \guillemotleft («)\guillemotleft («) \guillemotright (»)\guillemotright (») \guilsinglleft (‹)\guilsinglleft (‹) @@ -5446,7 +5683,7 @@ and \dots also work in math mode. 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: +Double and single quotation marks on the baseline: „ and ‚. \rq\rq @@ -5584,8 +5821,8 @@ has the ascender height. Centered period: \cdot. \textquestiondown (or ?`)\textquestiondown (or ?`) -questionation point, upside-down -Upside down questionation point: ¿. +question mark, upside-down +Upside down question mark: ¿. \textquotedblleft (or ``)\textquotedblleft (or ``) left quote, double @@ -5649,13 +5886,15 @@ has the ascender height. - + Accents accents characters, accented letters, accented +babel package +multilingual support &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 @@ -5810,7 +6049,7 @@ descenders. See also \underline in + Non-English characters special characters @@ -5838,8 +6077,8 @@ used in languages other than English. \dh \DH -\dh (æ) -\DH (Æ) +\dh (ð) +\DH (Ð) Icelandic eth eth, Icelandic letter Icelandic letter eth: ð and Ð. @@ -5848,7 +6087,7 @@ used in languages other than English. \DJ \dj \DJ -xxxx +Crossed d and D, a.k.a. capital and small letter d with stroke. \ij \IJ @@ -5868,7 +6107,7 @@ used in languages other than English. \NG \ng \NG -xxxx +Latin letter eng, also used in phonetics. \o \O @@ -5903,7 +6142,7 @@ used in languages other than English. - + <literal>\rule</literal> \rule @@ -5925,7 +6164,7 @@ rectangles. The arguments are: - + <literal>\today</literal> \today @@ -5942,7 +6181,7 @@ of other date formats. - + Splitting the input splitting the input file input file @@ -5958,7 +6197,7 @@ external file to be created with the main document. - + <literal>\include</literal> \include @@ -5981,7 +6220,7 @@ read by another \include command. - + \<literal>includeonly</literal> \includeonly @@ -5999,7 +6238,7 @@ effective. - + \input \input @@ -6018,12 +6257,12 @@ is tried (‘foo’ or ‘foo.bar - + Front/back matter - + Tables of contents table of contents, creating @@ -6042,9 +6281,12 @@ table of contents, write a \newpage command after the \listoffigures \listoftables +.lof file +.lot file 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. +produce a list of figures and a list of tables (from .lof and +.lot files), respectively. Everything works exactly the same +as for the table of contents. \nofiles The command \nofiles overrides these commands, and @@ -6052,7 +6294,7 @@ Everything works exactly the same as for the table of contents. - + \addcontentsline \addcontentsline{ext}{unit}{text} table of contents entry, manually adding @@ -6078,17 +6320,17 @@ following, matching the value of the ext argument: For the list of tables. entry -The actual text of the entry. +The text of the entry. \contentsline What is written to the .ext file is the command \contentsline{unit}{name}. - + - + \addtocontents \addtocontents{ext}{text} @@ -6097,9 +6339,9 @@ command \contentsline{unit}{nam generates the table of contents or lists of figures or tables. 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). +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). text The text to be written. @@ -6107,7 +6349,7 @@ generates the table of contents or lists of figures or tables. - + Glossaries glossaries @@ -6124,12 +6366,13 @@ generates the table of contents or lists of figures or tables. \glossaryentry{text}{pageno}, where pageno is the current \thepage value. +glossary package The glossary package on CTAN provides support for fancier glossaries. - + Indexes indexes @@ -6148,6 +6391,7 @@ the preamble. is the current \thepage value. ‘see’ and ‘see also’ index entries +index entries, ‘see’ and ‘see also’ 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. @@ -6192,7 +6436,7 @@ preparing the index. - + Letters letters creating letters @@ -6233,7 +6477,7 @@ commands, use \\ to separate the items. - + \address{<replaceable>return-address}</replaceable> \address @@ -6242,14 +6486,14 @@ 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 +will be formatted for copying onto your organization’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> \cc @@ -6264,7 +6508,7 @@ printed on a separate line. - + <literal>\closing</literal> \closing @@ -6280,7 +6524,7 @@ printed on a separate line. - + <literal>\encl</literal> \encl @@ -6294,18 +6538,18 @@ printed on a separate line. - + <literal>\location</literal> \location \location{address} -This modifies your organisation’s standard address. This only appears +This modifies your organization’s standard address. This only appears if the firstpage pagestyle is selected. - + <literal>\makelabels</literal> \makelabels @@ -6317,7 +6561,7 @@ address labels. This sheet will be output before the letters. - + <literal>\name</literal> \name @@ -6328,7 +6572,7 @@ address. - + <literal>\opening{<replaceable>text</replaceable>}</literal> \opening letters, starting @@ -6345,7 +6589,7 @@ For instance: - + <literal>\ps</literal> \ps postscript, in letters @@ -6355,7 +6599,7 @@ For instance: - + <literal>\signature{<replaceable>text</replaceable>}</literal> \signature @@ -6365,7 +6609,7 @@ space for your signature. \\ starts a new line within - + <literal>\startbreaks</literal> \startbreaks @@ -6374,9 +6618,8 @@ space for your signature. \\ starts a new line within Used after a \stopbreaks command to allow page breaks again. - - + <literal>\stopbreaks</literal> \stopbreaks @@ -6385,9 +6628,8 @@ space for your signature. \\ starts a new line within Inhibit page breaks until a \startbreaks command occurs. - - + <literal>\telephone</literal> \telephone @@ -6399,14 +6641,14 @@ space for your signature. \\ starts a new line within - + Terminal input/output input/output terminal input/output - + <literal>\typein[<replaceable>cmd</replaceable>]{<replaceable>msg</replaceable>}</literal> \typein @@ -6424,7 +6666,7 @@ redefined to be the typed input. - + <literal>\typeout{<replaceable>msg</replaceable>}</literal> \typeout @@ -6446,19 +6688,24 @@ printed, independent of surrounding spaces. A ^^J in - + Command line command line +.tex, default extension The input file specification indicates the file to be formatted; &tex; uses .tex as a default file extension. If you omit the -input file entirely, &tex; accepts input from the terminal. You -specify command options by supplying a string as a parameter to the -command; e.g. +input file entirely, &tex; accepts input from the terminal. You can +also specify arbitrary &latex; input by starting with a backslash. +For example, this processes foo.tex without pausing after every +error: latex '\nonstopmode\input foo.tex' -will process foo.tex without pausing after every error. +–help command-line option +With many, but not all, implementations, command-line options can also +be specified in the usual Unix way, starting with ‘-’ or +‘--’. For a list of those options, try ‘latex --help’. *’ prompt prompt, ‘* @@ -6467,7 +6714,8 @@ command; e.g. ‘*’ prompt, it is waiting for input. You can type \stop (and return) and it will prematurely end the document. - +See &tex; engines, for other system commands invoking &latex;. + @@ -6475,37 +6723,17 @@ command; e.g. document templates Although not reference material, perhaps these document templates will -be useful. Additional template resources are listed +be useful. Additional template resources are listed at http://tug.org/interest.html#latextemplates. - -<literal>book</literal> template - -\documentclass{book} -\title{Book Class Template} -\author{Alex Author} - -\begin{document} -\maketitle - -\chapter{First} -Some text. - -\chapter{Second} -Some other text. - -\section{A subtopic} -The end. -\end{document} - - - - + <literal>beamer</literal> template -The beamer class creates slides presentations. +beamer template and class +The beamer class creates presentation slides. It has a vast +array of features, but here is a basic template: \documentclass{beamer} @@ -6533,10 +6761,35 @@ The end. http://robjhyndman.com/hyndsight/beamer/. + + +<literal>book</literal> template + +\documentclass{book} +\title{Book Class Template} +\author{Alex Author} + +\begin{document} +\maketitle + +\chapter{First} +Some text. + +\chapter{Second} +Some other text. + +\section{A subtopic} +The end. +\end{document} + + <literal>tugboat</literal> template +TUGboat template +ltugboat class + TUGboat is the journal of the &tex; Users Group, http://tug.org/TUGboat. @@ -6570,8 +6823,8 @@ This is an example article for \TUB{}. This is an example article for \TUB, from \url{http://tug.org/TUGboat/location.html}. -We recommend the graphicx package for image inclusions, and the -hyperref package for active url's (in the \acro{PDF} output). +We recommend the \texttt{graphicx} package for image inclusions, and the +\texttt{hyperref} package for active urls in the \acro{PDF} output. Nowadays \TUB\ is produced using \acro{PDF} files exclusively. The \texttt{ltugboat} class provides these abbreviations and many more: -- cgit v1.2.3