diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi')
-rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi | 141 |
1 files changed, 108 insertions, 33 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi index 8bfe58fe889..bac9e0992a2 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi @@ -1,20 +1,20 @@ \input texinfo -@c $Id: latex2e.texi 270 2013-05-13 17:48:08Z karl $ +@c $Id: latex2e.texi 282 2014-05-19 16:31:57Z karl $ @comment %**start of header (This is for running Texinfo on a region.) @setfilename latex2e.info -@set UPDATED May 2013 +@set UPDATED May 2014 @settitle @LaTeX{}2e reference manual (@value{UPDATED}) @comment %**end of header (This is for running Texinfo on a region.) @c latex 2.09 commands should all be present now, @c xx but latex2e stuff is missing. @c -@c xx mention \topnumber, \bottomnumber, \totalnumber @c xx mention \nocorr, \textit and ic @c xx give actual smallskip/etc. defaults @c @c xx merge http://ctan.org/tex-archive/info/latex-info/ (alt-latex-info) @c xx merge permuted-index +@c xx merge latex-manual from savannah @c @c xx The typeset source2e has an index with all kernel @c xx commands, though some are internal and shouldn't be included. @@ -33,15 +33,16 @@ George@tie{}D. Greenwade of Sam Houston State University. The @LaTeX{}@tie{}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 @cite{Hypertext Help with @LaTeX{}}, by Sheldon Green, and the +using @cite{Hypertext Help with @LaTeX{}}, by Sheldon Green, and @cite{@LaTeX{} Command Summary} (for @LaTeX{} 2.09) by L.@tie{}Botway and C.@tie{}Biemesderfer (published by the @TeX{} Users Group as @cite{@TeX{}niques} number 10), as reference material (no text was directly copied). -Copyright @copyright{} 2007, 2008, 2009, 2010, 2011, 2012, 2013 Karl Berry.@* -Copyright @copyright{} 1988, 1994, 2007 Stephen Gilmore.@* -Copyright @copyright{} 1994, 1995, 1996 Torsten Martinsen. +Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, +2014 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 @@ -73,8 +74,7 @@ into another language, under the above conditions for modified versions. @end tex @titlepage -@title @LaTeX{}: Structured documents for @TeX{} -@subtitle unofficial @LaTeX{} reference manual +@title @LaTeX{}: An unofficial reference manual @subtitle @value{UPDATED} @author @url{http://home.gna.org/latexrefman} @page @@ -98,7 +98,7 @@ intended to cover @LaTeX{}2e, which has been the standard version of * Overview:: What is @LaTeX{}? * Starting & ending:: The standard beginning and end of a document. * Document classes:: Some of the various classes available. -* Typefaces:: And fonts, such as bold, italics etc. +* Fonts:: Italic, bold, typewriter, etc. * Layout:: Controlling the page layout. * Sectioning:: How to section properly. * Cross references:: Automatic referencing. @@ -448,8 +448,9 @@ by the selected document class are passed on to the packages loaded with @code{\usepackage}. -@node Typefaces -@chapter Typefaces +@node Fonts +@chapter Fonts +@anchor{Typefaces}@c old name @cindex typefaces @cindex fonts @@ -473,20 +474,21 @@ and a style. The @LaTeX{} commands for doing this are described here. The following type style commands are supported by @LaTeX{}. -This first group of commands is typically used like -@code{\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 with an argument, as in +@code{\textit@{italic text@}}. In the table below, 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 -@code{\sffamily\bfseries} or @code{\bfseries\sffamily} to get bold -sans serif. +These commands, in both the argument form and the declaration form, +are cumulative; e.g.,, you can say either @code{\sffamily\bfseries} or +@code{\bfseries\sffamily} to get bold sans serif. You can alternatively use an environment form of the declarations; for instance, @code{\begin@{ttfamily@}...\end@{ttfamily@}}. -These commands automatically supply an italic correction if the +These commands automatically supply an italic correction if needed. + @table @code @item \textrm (\rmfamily) @findex \textrm @@ -574,6 +576,8 @@ For use in math mode, e.g. inside another type style declaration. @end table @findex \mathversion +@cindex math, bold +@cindex bold math In addition, the command @code{\mathversion@{bold@}} can be used for switching to bold letters and symbols in formulas. @code{\mathversion@{normal@}} restores the default. @@ -593,11 +597,11 @@ numerals also; sometimes the @code{textcomp} package must be loaded, and sometimes package options are provided to make them the default. FAQ entry: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf}. -@LaTeX{} also provides these commands, which unconditionally switch to -the given style, that is, are @emph{not} cumulative. They are used -differently than the above commands, too: @code{@{\@var{cmd} ...@}} -instead of @code{\@var{cmd}@{...@}}. These are two very different -things. +@LaTeX{} also provides the following commands, which unconditionally +switch to the given style, that is, are @emph{not} cumulative. Also, +they are used differently than the above commands: @code{@{\@var{cmd} +...@}} instead of @code{\@var{cmd}@{...@}}. These are two very +different things. @ftable @code @item \bf @@ -642,6 +646,14 @@ Typewriter (monospace, fixed-width). @end ftable +Some people consider the unconditional font-switching commands, such +as @code{\tt}, obsolete and @emph{only} the cumulative commands +(@code{\texttt}) should be used. I (Karl) do not agree. There are +perfectly reasonable situations when an unconditional font switch is +precisely what you need to get the desired output; for one example, +@pxref{description,,@code{description}}. Both sets of commands have +their place. + @node Font sizes @section Font sizes @@ -1170,6 +1182,7 @@ Each environment begins and ends in the same manner: * eqnarray:: Sequences of aligned equations. * equation:: Displayed equation. * figure:: Floating figures. +* filecontents:: Writing multiple files from the source. * flushleft:: Flushed left lines. * flushright:: Flushed right lines. * itemize:: Bulleted lists. @@ -1658,6 +1671,63 @@ The principal @TeX{} FAQ entry relating to floats: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats}. +@node filecontents +@section @code{filecontents}: Create external files +@findex filecontents +@cindex external files, creating +@cindex writing external files + +Synopsis: + +@example +\begin@{filecontents@}@{@var{filename}@} +@var{contents-of-file} +\end@{filecontents@} +... +\documentclass@{@var{my-document-class}@} +@end example + +@cindex initial command +@findex \documentclass, commands before +The @code{filecontents} environment is an @dfn{initial command}, +meaning that it can be used only before the @code{\documentclass} +command, as in the synopsis above. + +@LaTeX{} will create a file named @var{filename} with the content +@var{contents-of-file} preceded by a header comment indicating how and +when the file was generated. If the file already exists then nothing will +happen. + +You can also use the @code{filecontents} package, which has the +following advantages: + +@itemize +@item +If the file already exists, then it will be overwritten. + +@item +You can use the @code{filecontents} environment at any point after the +declaration @code{\usepackage@{filecontents@}}, not just before +@code{\documentclass}. + +@item +The @code{filecontents} package also provides a @code{filecontents*} +environment which is used in the same way as the @code{filecontents} +environment except that it won't insert any leading comment, so it is +better suited to create files which aren't in @LaTeX{} format. + +@end itemize + +The @code{filecontents} environment only creates the file, and is +unrelated to using the created file. So you need to use, for +instance, @code{\input} or @code{\usepackage} or @code{\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 @file{.bib} file with the main +document. + + @node flushleft @section @code{flushleft} @findex flushleft @r{environment} @@ -3696,8 +3766,8 @@ $\ast\ast$ $\dagger\dagger$ $\ddagger\ddagger$ @ifnottex The symbols mostly aren't supported in Info, but here are the names: @display -asterix(*) dagger ddagger section-sign paragraph-sign parallel -double-asterix(**) double-dagger double-ddagger +asterisk(*) dagger ddagger section-sign paragraph-sign parallel +double-asterisk(**) double-dagger double-ddagger @end display @end ifnottex @@ -5177,12 +5247,16 @@ Specifies the style of page numbers, according to @var{style}: @table @code @item arabic arabic numerals + @item roman lowercase Roman numerals + @item Roman uppercase Roman numerals + @item alph lowercase letters + @item Alph uppercase letters @end table @@ -5227,7 +5301,7 @@ Here are the descriptions of @code{\markboth} and @code{\markright}: @item \markboth@{@var{left}@}@{@var{right}@} Sets both the left and the right heading. A ``left-hand heading'' (@var{left}) is generated by the last @code{\markboth} command before -the end of the page, while a ``right-hand heading'' (@var{right} is +the end of the page, while a ``right-hand heading'' (@var{right}) is generated by the first @code{\markboth} or @code{\markright} that comes on the page if there is one, otherwise by the last one before the page. @@ -5700,7 +5774,7 @@ Synopsis: \usebox@{@var{\boxcmd}@} @end example -@code{\usebox} producesthe box most recently saved in the bin +@code{\usebox} produces the box most recently saved in the bin @var{\boxcmd} by a @code{\savebox} command (@pxref{\savebox}). @@ -6353,6 +6427,9 @@ 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{}. +@xref{filecontents}, for an environment that allows bundling an +external file to be created with the main document. + @menu * \include:: Conditionally include a file. * \includeonly:: Determine which files are included. @@ -6422,7 +6499,6 @@ If @var{file} does not end in @samp{.tex} (e.g., @samp{foo} or or @samp{foo.bar.tex}). If that is not found, the original @var{file} is tried (@samp{foo} or @samp{foo.bar}). - @node Front/back matter @chapter Front/back matter @@ -6990,8 +7066,7 @@ One web resource for this: \usepackage{graphicx} \usepackage{ifpdf} \ifpdf -\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, - urlcolor=black]{hyperref} +\usepackage[breaklinks,hidelinks]{hyperref} \else \usepackage{url} \fi |