summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-05-15 21:52:09 +0000
committerKarl Berry <karl@freefriends.org>2013-05-15 21:52:09 +0000
commita3f89152f66285a955a51e3dbeeae31e1f8a63e1 (patch)
tree088c89520e533101f7b2f065752e945e169e8244 /Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk
parentb1c0322f63142a632f15e21009547e439784bfc9 (diff)
latex2e-help-texinfo (15may13)
git-svn-id: svn://tug.org/texlive/trunk@30487 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk')
-rw-r--r--Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk131
1 files changed, 85 insertions, 46 deletions
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 6d42c9c12d1..94aba2c18a0 100644
--- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk
+++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk
@@ -4,14 +4,15 @@
<!ENTITY latex "LaTeX">
]>
<book id="latex2e.dbk" lang="en">
-<title>&latex;2e reference manual (May 2012)</title>
+<title>&latex;2e reference manual (May 2013)</title>
<!-- %**end of header (This is for running Texinfo on a region.) -->
<!-- latex 2.09 commands should all be present now, -->
<!-- xx but latex2e stuff is missing. -->
<!-- -->
-<!-- xx mention \oldstylenums (comes from where?) -->
<!-- xx mention \topnumber, \bottomnumber, \totalnumber -->
+<!-- xx mention \nocorr, \textit and ic -->
+<!-- xx give actual smallskip/etc. defaults -->
<!-- -->
<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ (alt-latex-info) -->
<!-- xx merge permuted-index -->
@@ -19,12 +20,12 @@
<!-- xx The typeset source2e has an index with all kernel -->
<!-- xx commands, though some are internal and shouldn't be included. -->
<!-- xx classes.dtx et al. define additional commands. -->
+<!-- xx See also http://www.ctan.org/pkg/macros2e. -->
<!-- -->
-<!-- xx packages - required, additional, useful; oberdiek ... -->
-<!-- xx fonts - latexsys -->
+<!-- xx packages - required, additional, useful; oberdiek; fonts -->
<bookinfo><legalnotice><para>This document is an unofficial reference manual for &latex;, a
-document preparation system, version of May 2012.
+document preparation system, version of May 2013.
</para>
<para>This manual was originally translated from <filename>LATEX.HLP</filename> v1.0a in
the VMS Help Library. The pre-translation version was written by
@@ -38,7 +39,7 @@ and C.&#160;Biemesderfer (published by the &tex; Users Group as
<citetitle>&tex;niques</citetitle> number 10), as reference material (no text was
directly copied).
</para>
-<para>Copyright &#169; 2007, 2008, 2009, 2010, 2011, 2012 Karl Berry.
+<para>Copyright &#169; 2007, 2008, 2009, 2010, 2011, 2012, 2013 Karl Berry.
Copyright &#169; 1988, 1994, 2007 Stephen Gilmore.
@@ -60,7 +61,7 @@ into another language, under the above conditions for modified versions.
<para>This document is an unofficial reference manual for &latex;, a
-document preparation system, version of May 2012.
+document preparation system, version of May 2013.
</para>
<para>This manual was originally translated from <filename>LATEX.HLP</filename> v1.0a in
the VMS Help Library. The pre-translation version was written by
@@ -74,7 +75,7 @@ and C.&#160;Biemesderfer (published by the &tex; Users Group as
<citetitle>&tex;niques</citetitle> number 10), as reference material (no text was
directly copied).
</para>
-<para>Copyright &#169; 2007, 2008, 2009, 2010, 2011, 2012 Karl Berry.
+<para>Copyright &#169; 2007, 2008, 2009, 2010, 2011, 2012, 2013 Karl Berry.
Copyright &#169; 1988, 1994, 2007 Stephen Gilmore.
@@ -99,7 +100,7 @@ into another language, under the above conditions for modified versions.
<title>&latex;2e</title>
<para>This document is an unofficial reference manual for &latex;, a
-document preparation system, version as of May 2012. It is
+document preparation system, version as of May 2013. It is
intended to cover &latex;2e, which has been the standard version of
&latex; for many years.
</para>
@@ -135,17 +136,17 @@ infrastructure.
<para>Of course, there are many, many other sources of information about
&latex;. Here are a few:
</para>
-<variablelist><varlistentry><term>
+<variablelist><varlistentry><term><ulink url="http://www.ctan.org/pkg/latex-doc-ptr">http://www.ctan.org/pkg/latex-doc-ptr</ulink>
</term><listitem><para>Two pages of recommended references to &latex; documentation.
</para>
-</listitem></varlistentry><varlistentry><term>
+</listitem></varlistentry><varlistentry><term><ulink url="http://www.ctan.org/pkg/first-latex-doc">http://www.ctan.org/pkg/first-latex-doc</ulink>
</term><listitem><para>Writing your first document, with a bit of both text and math.
</para>
-</listitem></varlistentry><varlistentry><term>
+</listitem></varlistentry><varlistentry><term><ulink url="http://www.ctan.org/pkg/usrguide">http://www.ctan.org/pkg/usrguide</ulink>
</term><listitem><para>The guide for document authors maintained as part of &latex;; there
are several others.
</para>
-</listitem></varlistentry><varlistentry><term>
+</listitem></varlistentry><varlistentry><term><ulink url="http://tug.org/begin.html">http://tug.org/begin.html</ulink>
</term><listitem><para>Introduction to the &tex; system, including &latex;.
</para></listitem></varlistentry></variablelist>
@@ -458,40 +459,50 @@ instance, <literal>\begin{ttfamily}...\end{ttfamily}</literal>.
</term><listitem><indexterm role="fn"><primary>\textbf</primary></indexterm>
<indexterm role="fn"><primary>\bfseries</primary></indexterm>
<para>Boldface.
-</para></listitem></varlistentry><varlistentry><term><literal>\textup (\upshape)</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\textup (\upshape)</literal>
</term><listitem><indexterm role="fn"><primary>\textup</primary></indexterm>
<indexterm role="fn"><primary>\upshape</primary></indexterm>
<para>Upright (default). The opposite of slanted.
-</para></listitem></varlistentry><varlistentry><term><literal>\textsl (\slshape)</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\textsl (\slshape)</literal>
</term><listitem><indexterm role="fn"><primary>\textsl</primary></indexterm>
<indexterm role="fn"><primary>\slshape</primary></indexterm>
<para>Slanted.
-</para></listitem></varlistentry><varlistentry><term><literal>\textsf (\sffamily)</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\textsf (\sffamily)</literal>
</term><listitem><indexterm role="fn"><primary>\textsf</primary></indexterm>
<indexterm role="fn"><primary>\sffamily</primary></indexterm>
<para>Sans serif.
-</para></listitem></varlistentry><varlistentry><term><literal>\textsc (\scshape)</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\textsc (\scshape)</literal>
</term><listitem><indexterm role="fn"><primary>\textsc</primary></indexterm>
<indexterm role="fn"><primary>\scshape</primary></indexterm>
<para>Small caps.
-</para></listitem></varlistentry><varlistentry><term><literal>\texttt (\ttfamily)</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\texttt (\ttfamily)</literal>
</term><listitem><indexterm role="fn"><primary>\texttt</primary></indexterm>
<indexterm role="fn"><primary>\ttfamily</primary></indexterm>
<para>Typewriter.
-</para></listitem></varlistentry><varlistentry><term><literal>\textnormal (\normalfont)</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\textnormal (\normalfont)</literal>
</term><listitem><indexterm role="fn"><primary>\textnormal</primary></indexterm>
<indexterm role="fn"><primary>\normalfont</primary></indexterm>
<para>Main document font.
-</para></listitem></varlistentry><varlistentry><term><literal>\mathrm</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\mathrm</literal>
</term><listitem><indexterm role="fn"><primary>\mathrm</primary></indexterm>
<para>Roman, for use in math mode.
-</para></listitem></varlistentry><varlistentry><term><literal>\mathbf</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\mathbf</literal>
</term><listitem><indexterm role="fn"><primary>\mathbf</primary></indexterm>
<para>Boldface, for use in math mode.
-</para></listitem></varlistentry><varlistentry><term><literal>\mathsf</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\mathsf</literal>
</term><listitem><indexterm role="fn"><primary>\mathsf</primary></indexterm>
<para>Sans serif, for use in math mode.
-</para></listitem></varlistentry><varlistentry><term><literal>\mathtt</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\mathtt</literal>
</term><listitem><indexterm role="fn"><primary>\mathtt</primary></indexterm>
<para>Typewriter, for use in math mode.
</para>
@@ -502,16 +513,32 @@ instance, <literal>\begin{ttfamily}...\end{ttfamily}</literal>.
</listitem></varlistentry><varlistentry><term><literal>\mathnormal</literal>
</term><listitem><indexterm role="fn"><primary>\mathnormal</primary></indexterm>
<para>For use in math mode, e.g. inside another type style declaration.
-</para></listitem></varlistentry><varlistentry><term><literal>\mathcal</literal>
+</para>
+</listitem></varlistentry><varlistentry><term><literal>\mathcal</literal>
</term><listitem><indexterm role="fn"><primary>\mathcal</primary></indexterm>
<para>&#8216;Calligraphic&#8217; letters, for use in math mode.
-</para></listitem></varlistentry></variablelist>
-<para>In addition, the command
-<literal>\mathversion{bold}</literal>
+</para>
+</listitem></varlistentry></variablelist>
<indexterm role="fn"><primary>\mathversion</primary></indexterm>
-can be used for switching to bold letters and symbols in
+<para>In addition, the command <literal>\mathversion{bold}</literal> can be used for
+switching to bold letters and symbols in
formulas. <literal>\mathversion{normal}</literal> restores the default.
</para>
+<indexterm role="fn"><primary>\oldstylenums</primary></indexterm>
+<indexterm role="cp"><primary>numerals, old-style</primary></indexterm>
+<indexterm role="cp"><primary>old-style numerals</primary></indexterm>
+<indexterm role="cp"><primary>lining numerals</primary></indexterm>
+<indexterm role="cp"><primary><literal>textcomp</literal> package</primary></indexterm>
+<para>Finally, the command <literal>\oldstylenums{<replaceable>numerals</replaceable>}</literal> will
+typeset so-called &#8220;old-style&#8221; numerals, which have differing heights
+and depths (and sometimes widths) from the standard &#8220;lining&#8221;
+numerals. &latex;&#8217;s default fonts support this, and will respect
+<literal>\textbf</literal> (but not other styles; there are no italic old-style
+numerals in Computer Modern). Many other fonts have old-style
+numerals also; sometimes the <literal>textcomp</literal> package must be loaded,
+and sometimes package options are provided to make them the default.
+FAQ entry: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</ulink>.
+</para>
<para>&latex; also provides these commands, which unconditionally switch to
the given style, that is, are <emphasis>not</emphasis> cumulative. They are used
differently than the above commands, too: <literal>{\<replaceable>cmd</replaceable> ...}</literal>
@@ -1793,9 +1820,11 @@ point and a minus sign&#8212;a number like <literal>5</literal>, <literal>0.3</l
<literal>-3.1416</literal>. A coordinate specifies a length in multiples of the
unit length <literal>\unitlength</literal>, so if <literal>\unitlength</literal> has been set
to <literal>1cm</literal>, then the coordinate 2.54 specifies a length of 2.54
-centimeters. You should only change the value of <literal>\unitlength</literal>,
-using the <literal>\setlength</literal> command, outside of a <literal>picture</literal>
-environment.
+centimeters.
+</para>
+<para>You should only change the value of <literal>\unitlength</literal>, using the
+<literal>\setlength</literal> command, outside of a <literal>picture</literal> environment.
+The default value is <literal>1pt</literal>.
</para>
<para>A position is a pair of coordinates, such as <literal>(2.4,-5)</literal>, specifying
the point with x-coordinate <literal>2.4</literal> and y-coordinate <literal>-5</literal>.
@@ -3070,13 +3099,15 @@ footnotes. This is &#8216;<literal>6.65pt</literal>&#8217; for &#8216;<literal>
<para><literal>\newcommand</literal> and <literal>\renewcommand</literal> define and redefine a
command, respectively. Synopses:
</para>
-<screen> \newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>defn</replaceable>}
-\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>defn</replaceable>}
- \newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>defn</replaceable>}
-\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>defn</replaceable>}
+<screen> \newcommand[*]{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optarg</replaceable>]{<replaceable>defn</replaceable>}
+\renewcommand[*]{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optarg</replaceable>]{<replaceable>defn</replaceable>}
</screen>
-
-<variablelist><varlistentry><term><replaceable>cmd</replaceable>
+<variablelist><varlistentry><term><replaceable><literal>*</literal></replaceable>
+</term><listitem><indexterm role="cp"><primary>*-form of defining new commands</primary></indexterm>
+<para>The *-form of these commands requires that the arguments not contain
+multiple paragraphs of text (not <literal>\long</literal>, in plain &tex; terms).
+</para>
+</listitem></varlistentry><varlistentry><term><replaceable>cmd</replaceable>
</term><listitem><para>The command name beginning with <literal>\</literal>. For <literal>\newcommand</literal>, it
must not be already defined and must not begin with <literal>\end</literal>; for
<literal>\renewcommand</literal>, it must already be defined.
@@ -3086,11 +3117,12 @@ must not be already defined and must not begin with <literal>\end</literal>; for
that the command will take. The default is for the command to have no
arguments.
</para>
-</listitem></varlistentry><varlistentry><term><replaceable>default</replaceable>
+</listitem></varlistentry><varlistentry><term><replaceable>optarg</replaceable>
</term><listitem><para>If this optional parameter is present, it means that the command&#8217;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 &#8216;<literal>def</literal>&#8217;.
+first argument is optional. The default value of the optional
+argument (i.e., if it is not specified in the call) is <replaceable>optarg</replaceable>,
+or, if that argument is present in the <literal>\newcommand</literal> but has an
+empty value, the string &#8216;<literal>def</literal>&#8217;.
</para>
</listitem></varlistentry><varlistentry><term><replaceable>defn</replaceable>
</term><listitem><para>The text to be substituted for every occurrence of <literal>cmd</literal>; a
@@ -3162,14 +3194,18 @@ defined, to refer to a new bin for storing boxes.
<para>Synopses:
</para>
-<screen> \newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
- \newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
-\renewenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
+<screen> \newenvironment[*]{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
+\renewenvironment[*]{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
</screen>
<para>These commands define or redefine an environment <replaceable>env</replaceable>, that is,
<literal>\begin{<replaceable>env</replaceable>} &#8230; \end{<replaceable>env</replaceable>}</literal>.
</para>
-<variablelist><varlistentry><term><replaceable>env</replaceable>
+<variablelist><varlistentry><term><replaceable><literal>*</literal></replaceable>
+</term><listitem><indexterm role="cp"><primary>*-form of environment commands</primary></indexterm>
+<para>The *-form of these commands requires that the arguments (not the
+contents of the environment) not contain multiple paragraphs of text.
+</para>
+</listitem></varlistentry><varlistentry><term><replaceable>env</replaceable>
</term><listitem><para>The name of the environment. For <literal>\newenvironment</literal>, <replaceable>env</replaceable>
must not be an existing environment, and the command <literal>\<replaceable>env</replaceable></literal>
must be undefined. For <literal>\renewenvironment</literal>, <replaceable>env</replaceable> must be
@@ -4879,6 +4915,7 @@ a capital letter. Here are side-by-side examples with and without
</para>
<!-- Texinfo does it differently, but the result is the same. -->
<blockquote><para>&#8230; in C. Pascal, though &#8230;
+
&#8230; in C. Pascal, though &#8230;
</para></blockquote>
@@ -6420,8 +6457,10 @@ The end.
\end{frame}
\end{document}
-
</screen>
+<para>One web resource for this:
+<ulink url="http://robjhyndman.com/hyndsight/beamer/">http://robjhyndman.com/hyndsight/beamer/</ulink>.
+</para>
</sect1>
<sect1 label="A.3" id="tugboat-template">