summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/titlesec
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-07-25 21:54:45 +0000
committerKarl Berry <karl@freefriends.org>2011-07-25 21:54:45 +0000
commitd82f21bf5bbb6269a51a3b7045e3764cfbccd6b7 (patch)
tree2c894d976d0ae2cb9bfff01ff929ecb1b5234d8e /Master/texmf-dist/doc/latex/titlesec
parentc8570fd6aff117b8caeec3dcc0039161c6e85049 (diff)
titlesec (25jul11)
git-svn-id: svn://tug.org/texlive/trunk@23221 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/titlesec')
-rw-r--r--Master/texmf-dist/doc/latex/titlesec/CHANGES237
-rw-r--r--Master/texmf-dist/doc/latex/titlesec/README23
-rw-r--r--Master/texmf-dist/doc/latex/titlesec/titlesec.pdfbin230231 -> 194710 bytes
-rw-r--r--Master/texmf-dist/doc/latex/titlesec/titlesec.tex473
4 files changed, 507 insertions, 226 deletions
diff --git a/Master/texmf-dist/doc/latex/titlesec/CHANGES b/Master/texmf-dist/doc/latex/titlesec/CHANGES
new file mode 100644
index 00000000000..8900459dc9f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/titlesec/CHANGES
@@ -0,0 +1,237 @@
+Titlesec changes
+
+History of v1.0
+~~~~~~~~~~~~~~~
+1998/02/25 Added nops option
+1998/02/28 Added \@mkboth stuff in \setmarks
+1998/03/01 Changed test in \ttl@secnum
+1998/03/03 Corrected some \fil... commands
+1998/03/03 Replaced the faulty \@hangfrom by new commands
+1998/03/03 Some \def replaced by \newcommand
+1998/03/04 .dtx/.ins scheme finally rejected. Useless
+ for users, obtrusive for `readers' and proned
+ to errors
+1998/03/04 Tidied up documentation
+1998/03/06 \wordsep renamed and documented
+1998/03/06 Added dummy asignation in \ttl@chap.
+1998/03/06 Removed \ttl@xsect and merged into \tl@sect
+1998/03/06 Added \ProvidesPackage
+
+History of v1.1
+~~~~~~~~~~~~~~~~
+1998/03/25 \chapter corrected, as well as the size options
+1998/03/26 Added compact option
+1998/03/26 Added flushleft, flushright and center options
+1998/04/08 Changed all instances of \noindent by \parindent\z@
+1998/04/14 Added \filinner, \filouter
+1998/04/14 Added drop shape
+1998/05/01 Added rightmargin shape (and margin renamed to
+ leftmargin)
+1998/05/03 Added \setheadindent
+
+History of v1.2 (unreleased)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1998/06/01 Compatibility with AMS classes
+1998/06/08 On-demand loading of shapes
+1998/06/11 Frame shape. Some \fil... command
+ modified to work in the label of this
+ chapter shape.
+1998/07/03 Bottomtitle option (at last...)
+1998/07/14 ...margin styles bug fixed using a method
+ similar to bottomtitle.
+1998/07/29 \titleline
+
+====================
+
+History of v2.0
+~~~~~~~~~~~~~~~~
+
+1998/08/05 to
+1998/08/29 Fully reimplemented
+
+History of v2.1
+~~~~~~~~~~~~~~~~
+1999/01/05 We define in this file the three basic shapes.
+ Additional ones remain defined in external files.
+ Unified the shapes for sections and chapters.
+1999/01/05 \ttl@shape merged into \ttl@format@iii.
+1999/01/05 \titlerule
+1999/01/07 \ttl@defkeys splitted from \ttl@keys
+1999/01/10 Added the \part stuff, including a definition of \@openright
+1999/01/11 Removed unnecessary \ttl@numsecfalse in \ttl@sect@i.
+1999/01/14 Optimized \titlerule
+1999/01/27 Changed \titleline to correct the spacing at the
+ top page and to fix a bug which changed the mode
+ to horizontal, thus introducing unwanted space
+ (\makebox -> \@makebox).
+1999/02/02 \ttl@secnum renamed to \ttl@write and introduced the
+ \ttl@savewrite mechanism to sincronize the toc/marks
+ with the title in case there is a \newpage in <after>.
+1999/02/03 wrap shape
+1999/02/03 Added a \kern\z@ for not to avoid hyphenation
+ of the last word. Not strictly necessary, but
+ it is more LaTeX-like.
+1999/02/05 \partmark defined (and in \setmarks, too).
+1999/02/08 \ttl@row@i simplified.
+1999/02/08 \ttl@savefn mechanism.
+1999/02/10 Removed extra \leavevmode in display
+1999/02/13 Now \titleline doesn't add the width. It's set.
+1999/02/17 The part mark is catched, even if unused.
+1999/02/17 old/newparttoc added.
+1999/02/18 Changed many TeX assignments to the LaTeX
+ counterpart.
+1999/02/19 Introduced \ttl@startargs.
+
+History of v2.1.1
+~~~~~~~~~~~~~~~~~
+1999/08/04 Moved misplaced lines in \ttl@makeboth
+
+History of v2.2 (unreleased)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1999/11/03 We load titleps if pagestyles are required, but
+ some old definitions are restored.
+1999/11/06 Improved outermarks test in \ttl@sect@i. Formerly
+ the section number could be printed if a page ended
+ with an unnumebered section followed by a numbered one.
+1999/11/06 \ttl@startargs now adds (and passes) automatically the
+ section name. Involved macros modified accordingly.
+1999/11/06 Replaced explicit part names by the parameter in
+ \ttl@part@i. The same for chapter.
+1999/11/21 \ttl@try's are not given explicitly, but built by
+ \ttl@setkeys. Intruduced the \ttl@key@... and
+ \ttl@extra@... commands.
+1999/11/23 Minor problems with keys fixed.
+1999/12/10 Added the nobottomtitles* option and \ttl@addstretch.
+2000/01/07 First steps towards the calcwidth feature (basic code).
+2000/01/08 (Continued.) \titleline* for rules of width \titlewidth.
+ Option calcwidth implemented.
+2000/01/12 Finished with changes in wrap.tss (no longer
+ "experimental" :-) )
+
+History of v2.3
+~~~~~~~~~~~~~~~
+2000/01/19 All keys are grouped in a single file tttkeys. Removed
+ page.tsk and deleted the corresponding code in the sty.
+2000/01/19 Classes begun.
+2000/01/19 The level numbers are stored in \ttll@ macros, and not
+ passed as arguments.
+2000/01/21 Introduced the new mark scheme. It's mostly compatible
+ with the old one, but a compatibility mode seems
+ imposible (it was introduced in a preliminary test
+ but eventually removed).
+2000/01/23 loadonly package option.
+2000/02/01 Classes finished. Many things had to be rewritten.
+2000/02/02 Made partially compatible with hyperref (dvips).
+2000/02/08 \ttl@savewrite moved from shapes to classes. But
+ explicit page breaks expand it, too, to avoid wrong
+ toc entries.
+2000/02/18 A new box named \ttl@box stores the title in runin
+ leftmargin etc shapes, to increase reliability.
+
+(2.3.1 -- 2.3.3 No changes on this file)
+
+History of v2.3.4
+~~~~~~~~~~~~~~~~~
+2000/05/12 nonindentfirst redefine \titlespacing instead of
+ \@afterindent... so that they don't interfere with
+ the first entry in tocs.
+2000/05/17 The marks in \ttl@select are protected to prevent
+ endless loop if the title is expanded, say, by
+ \MakeUppercase.
+
+History of v2.3.5
+~~~~~~~~~~~~~~~~~
+2000/05/21 Restores missing test for secnumdepth in \ttl@mkchap,
+ and instead of setting \ttl@toclevel in ttlps now is
+ done in \secdef. Except inside the macros, \ttl@toclevel
+ is false, so that an explicit \...mark works.
+2000/06/04 \partmark defined with \providecommand
+2000/06/14 A patch mechanism added, for small bug fixes.
+
+History of v2.4
+~~~~~~~~~~~~~~~~
+2001/01/18 Minor changes in code. Essentialy an incremental
+ update.
+2001/01/22 \titleformat has a new "easy" starred variant.
+
+History of v2.5
+~~~~~~~~~~~~~~~
+2002/01/02 New macros for \ttl@assign. Now * length allow
+ non integer values.
+2002/03/22 Added \ttl@calc and \ttl@calcneg to make titlesec
+ calc-savvy.
+ - Merged bug fixes of .new into this file.
+ - Bugs in frame fixed -- gap in lines, misplaced
+ label, wrong margins (sometimes),
+ - \leftskip, \rightskip and \linewidth (re)set in
+ margin shapes.
+ - Removed obsolete flush... options.
+ - indentafter and noindentafter, new names for
+ indentfirst and nonindentfirst.
+ - A new level (\titleclass) without its "location"
+ now raises a meaningful error.
+ - Bug in top-level \titleclass fixed.
+2002/03/23 Tests for undefined and unformatted sectioning levels,
+ and horizontal material in <format>.
+ - Missing \if@openright inside \if@twoside in
+ page class added.
+ - Removed extra (but inoffensive) \expandafter
+ in \ttl@class@iii.
+2002/03/27 Added \titlewidthfirst and ...last
+ - "Not definable" gives a more meaningful message in
+ the context of the package.
+
+History of v.2.6
+~~~~~~~~~~~~~~~~
+2004/08/30 Corrected typo in margin \hsiz -> \hsize.
+2004/10/17 Added a couple of missing \noexpand's in drop.
+2004/12/01 Removed the error about the mode in block because this
+ style is general purpose.
+2005/01/16 Missing braces around #2 in the last else part of
+ \ttl@headinline added
+ - Replaced explicit \makeatother's by a saved value as
+ the macros can be used in a class/package file.
+2005/01/18 newlinetospace mechanism
+ - // does not break pages; option pageatnewline to
+ restore the LaTeX behaviour.
+2005/01/19 \...break in top shape.
+ - Renumbered several scratch registers to follow the
+ TeXbook (p. 346), with \ttl@box in a few cases. In
+ wrap \titlewidthfirst and \titlewidthlast made global.
+ - Float heads and foots have now a further argument for
+ additional stuff (eg, to remove rules). Option is now
+ psfloats while floatps enters in compatibility mode.
+ - \ttl@savetitle in all classes. Option toctitles.
+2005/01/21 Changed pageatnewline to make it compatible with
+ titletoc, with \ttl@changecentercr.
+2005/01/22 \...tolist in top class.
+
+History of v.2.7
+~~~~~~~~~~~~~~~~
+2007-03-27 Added the `explicit' option.
+ - Added \titlepagestyle.
+2007-03-29 Fixed wrong number for chapter in log
+ - Patch file named .270 instead of .new
+2007-05-09 Added <after> to leftmargin, so that you can add stuff
+ at the beginning of the paragraph, eg, the sec number.
+2007-07-07 Removed the patch mechanism.
+2007-08-07 `explicit' improved.
+
+History of v.2.8
+~~~~~~~~~~~~~~~~
+2007-08-12 \titlepagestyle already used by KOMA-Script. Renamed
+ to \assignpagestyle.
+
+History of v.2.9
+~~~~~~~~~~~~~~
+2010-05-04 Add \nobreak in \ttl@addcontentsline, to prevent the title
+ going to footnotes (!) in runin style in some (rare) cases.
+2010-05-06 Option uppercase (and \ttl@case).
+2011-02-25 \iftitlemeasuring test
+2011-07-14 Fixed \assignpagestyle
+2011-07-15 Introduced the \scantokens mechanism to make sure section
+ names are 'letters' and not 'others'
+2011-07-18 Removed \if@nobreak test in wrap/drop, which added a line
+ to the title after another section (why?)
+ \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/titlesec/README b/Master/texmf-dist/doc/latex/titlesec/README
index c46f3f2a5e2..12350ceaecf 100644
--- a/Master/texmf-dist/doc/latex/titlesec/README
+++ b/Master/texmf-dist/doc/latex/titlesec/README
@@ -4,7 +4,7 @@ This package allows to change the sectioning titles. Amongst its many
features it provides margin titles, different format in left and right
pages, rules above and below the title, etc.
-Current version is 2.8.
+Current version is 2.9.
Titletoc package
~~~~~~~~~~~~~~~~
@@ -15,6 +15,17 @@ in a single paragraph, pretty free-forms entries, partial tocs, etc.
The titletoc.sty file is not part of the titlesec package; it's
an independent package, but it's described in titlesec.tex.
+What's new (2.9)
+~~~~~~~~~~~~~~~~
+
+- Fixed \assignpagestyle, which did not work except in a
+few cases.
+- Fixed an incompatibility with hyperref (wrong appendix
+name).
+- Added \iftitlemeasuring
+- Added package option uppercase
+- Fixed a bug when reckoning the number of lines in wrap/drop.
+
Installation
~~~~~~~~~~~~
No .ins/.dtx preinstalation is required. Move the files to a place
@@ -24,11 +35,9 @@ manual titlesec.tex (and this 'readme' file). The manual requires
titlesec.sty and titletoc.sty, and hence all the .tss and .def
files as well.
-Files with extension .new (titlesec.new and titletoc.new)
-used to be patch files, ie, files with bug fixes, which were
-loaded automatically. Since titlesec 2.7 (titletoc 1.6), these
-files do not exist any more and should be removed (however,
-they will be ignored if present).
+Formerly there were files with extension .new (titlesec.new and
+titletoc.new) used to patch the packages, but if present should be
+removed (they will be ignored, however).
Web site, manual in PDF format and info
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -49,5 +58,5 @@ after a section in a so radical way that titlesec (which
uses the internal LaTeX macros) cannot supress it again.
For example, spanish (fixed in version 5.0) and frenchb.
-2007/08/12
+2011/07/25
diff --git a/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf b/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf
index b8077cb8940..ce1b38070e9 100644
--- a/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf
+++ b/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/titlesec/titlesec.tex b/Master/texmf-dist/doc/latex/titlesec/titlesec.tex
index 82d34e69224..5611fadcd39 100644
--- a/Master/texmf-dist/doc/latex/titlesec/titlesec.tex
+++ b/Master/texmf-dist/doc/latex/titlesec/titlesec.tex
@@ -2,10 +2,10 @@
% | Typeset this file to get the documentation. |
% +--------------------------------------------------+
%
-% Copyright (c) 1998-2007 by Javier Bezos.
+% Copyright (c) 1998-2011 by Javier Bezos.
% All Rights Reserved.
%
-% This file is part of the titlesec distribution release 2.8
+% This file is part of the titlesec distribution release 2.9
% -----------------------------------------------------------
%
% It may be distributed and/or modified under the
@@ -20,8 +20,8 @@
%
% The Current Maintainer of this work is Javier Bezos.
-\def\fileversion{2.8}
-\def\docdate{2007-08-12}
+\def\fileversion{2.9}
+\def\docdate{2011-07-25}
\documentclass[a4paper]{ltxguide}
\usepackage[sf,bf,compact,topmarks,calcwidth,pagestyles]{titlesec}
@@ -43,9 +43,9 @@
\title{The \textsf{titlesec} and \textsf{titletoc}
Packages\footnote{The \textsf{titlesec} package is currently at
-version 2.8. \copyright{} 1998--2007 Javier Bezos.
+version 2.9. \copyright{} 1998--2011 Javier Bezos.
The \textsf{titletoc} package is currently at
-version 1.6. \copyright{} 1999--2007 Javier Bezos. All Rights
+version 1.6. \copyright{} 1999--2011 Javier Bezos. All Rights
Reserved.}}
\author{Javier Bezos\footnote{For bug reports, comments and
@@ -124,7 +124,7 @@ Appendix shows a good deal of examples, so jump forward right now!
\item Headers and footers defined with no |\...mark| intermediates,
and perhaps containing top, first \emph{and} bot marks at the same time.
-Top marks correctly synchronized with titles, and without
+Top marks correctly synchronized with titles, without
incompatibilities with the float mechanism. Decorative elements easily
added, including picture environments.
@@ -134,12 +134,15 @@ of entries in the middle of a document.
\end{itemize}
\textsf{Titlesec} works with the standard classes and with many
others, including the AMS ones, and it runs smoothly with
-\textsf{hyperref}.\footnote{However, be aware that the AMS classes
+\textsf{hyperref}.\footnote{However, be aware the AMS classes
reimplement the original internal commands. These changes will be
lost here. The compatibility with \textsf{hyperref} has been tested
-with \textsf{dvips}, \textsf{dvipdfm} and \textsf{pdftex} but it's an
-unsupported feature. Please, check that your version of
+with \textsf{dvips}, \textsf{dvipdfm} and \textsf{pdftex} but it is an
+unsupported feature. Please, check your version of
\textsf{hyperref} is compatible with \textsf{titlesec}.}
+Unfortunately, it is not compatible with \textsf{memoir}, which
+provides its own tools with a limited subset of the features available
+in \textsf{titlesec}.
As usual, load the package in the standard way with
|\usepackage|. Then, redefine the sectioning commands with the
@@ -157,7 +160,7 @@ should be changed with the help of the ``Advanced Interface.''
The easiest way to change the format is by means of a set of package
options and a couple of commands. If you feel happy with the
-functionality provided by this set of tools, you needn't go
+functionality provided by this set of tools, you need not go
further in this manual. Just read this section and ignore the
subsequent ones.
@@ -194,6 +197,15 @@ Control the alignment.
This option is independent from those above and reduces the spacing
above and below the titles.
+\subsection{Uppercase}
+
+\begin{desc}
+|uppercase|
+\end{desc}
+
+\fbox{2.9} Uppercases titles. Depending on the class, it might not work in
+\verb|\chapter| and \verb|\part|.
+
\subsection{Tools}
\begin{desc}
@@ -262,7 +274,7 @@ standard |\chapter|.)
\item[leftmargin] puts the title at the left margin. Titles at the
very end of a page will be moved to the next one and will not stick
-out in the bottom margin, which means that large titles can lead to
+out in the bottom margin, which means large titles can lead to
underfull pages.\footnote{However, floats following the title a couple
of lines after will interfere with the page breaking used here and
sometimes the title may stick out.} In this case you may increase the
@@ -273,23 +285,23 @@ A deprecated synonymous is |margin|.
\item[rightmargin] is like |leftmargin| but at the right margin.
-\item[drop] wraps the text around the title, provided that the
+\item[drop] wraps the text around the title, provided the
first paragraph is longer than the title (if not, they overlap).
-The comments in |leftmargin| also applies here.
+The comments in |leftmargin| also apply here.
-\item[wrap] is quite similar to drop. The only difference is that
+\item[wrap] is quite similar to drop. The only difference is
while the space reserved in drop for the title is fixed, in wrap is
automatically readjusted to the longest line. The limitations
-explained below related to |calcwidth| also applies here.
+explained below related to |calcwidth| also apply here.
-\item[frame] similar to display, but the title will be framed.
+\item[frame] Similar to display, but the title will be framed.
\end{description}
-Note, however, that some shapes don't make sense in chapters and
+Note, however, some shapes do not make sense in chapters and
parts.
\begin{desc}
-|\titleformat{<command>}[<shape>]{<format>}{<label>}{<sep>}{<before>}[<after>]|
+|\titleformat{<command>}[<shape>]{<format>}{<label>}{<sep>}{<before-code>}[<after-code>]|
\end{desc}
Here
@@ -307,27 +319,27 @@ title---label and text. This part can contain vertical material (and
horizontal with some shapes) which is typeset just after the space
above the title.
-\item The label is defined in |<label>|. You may left it empty it if
-there is no section label at that level, but note that by doing so
-the number is not suppressed in the table of contents and running
-heads.
+\item The label is defined in |<label>|. You may leave it empty if
+there is no section label at that level, but this is not recommended
+because by doing so the number is not suppressed in the table of
+contents and running heads.
\item |<sep>| is the horizontal separation between label and title
-body and must be a length (it cannot be left empty). This space is
+body and must be a length (it must not be empty). This space is
vertical in |display| shape; in |frame| it is the distance from text
to frame. Both |<label>| and |<sep>| are ignored in starred versions
of sectioning commands. If you are using |picture| and the like, set
this parameter to 0 pt.
-\item |<before>| is code preceding the title body. The very last
+\item |<before-code>| is code preceding the title body. The very last
command can take an argument, which is the title
-text.\footnote{Remember that font size can be changed safely between
-paragraphs only, and that changes in the text should be made local with
-a group; otherwise the leading can be wrong---too large or too small.}
+text.\footnote{Remember font size can be changed safely between
+paragraphs only, and changes in the text should be made local with
+a group; otherwise the leading might be wrong---too large or too small.}
However, with the package option \texttt{explicit} the title must
be given explicitly with |#1| (see below).
-\item |<after>| is code following the title body. The typeset
+\item |<after-code>| is code following the title body. The typeset
material is in vertical mode with |hang|, |block| and |display|;
in horizontal mode with |runin| and |leftmargin| (\fbox{2.7} with the latter,
at the beginning of the paragraph). Otherwise is ignored.
@@ -344,7 +356,7 @@ a chapter.
\subsection{Spacing}
\begin{desc}
-|\titlespacing*{<command>}{<left>}{<beforesep>}{<aftersep>}[<right>]|
+|\titlespacing*{<command>}{<left>}{<before-sep>}{<after-sep>}[<right-sep>]|
\end{desc}
The starred version kills the indentation of the paragraph
@@ -361,9 +373,9 @@ doesn't work correctly. With a negative value in the latter and if
will start in the outer margin, as expected, but the subsequent lines
will not; worse, those lines will be shortened at the right margin.}
-\item |<beforesep>| is the vertical space before the title.
+\item |<before-sep>| is the vertical space before the title.
-\item |<aftersep>| is the separation between title and text---vertical
+\item |<after-sep>| is the separation between title and text---vertical
with |hang|, |block|, and |display|, and horizontal with |runin|,
|drop|, |wrap| and |...margin|. By making the value negative, you may
define an effective space of less than |\parskip|.\footnote{See
@@ -371,27 +383,27 @@ Goossens, Mittelbach and Samarin: \textit{The \LaTeX{} Companion},
Reading, Addison Wesley, 1993, p.~25.}
\item The |hang|, |block| and |display| shapes have the
-possibility of increasing the |<right>| margin with this optional
+possibility of increasing the |<right-sep>| margin with this optional
argument.
\end{itemize}
If you dislike typing the full skip values, including the |plus| and
|minus| parameters, an abbreviation |*|$n$ is provided. In the
-|<beforesep>| argument this is equivalent to $n$ |ex| with some
+|<before-sep>| argument this is equivalent to $n$ |ex| with some
stretchability and a minute shrinkability. In the
-|<aftersep>| some stretchability (smaller) and no shrinkability.%
+|<after-sep>| some stretchability (smaller) and no shrinkability.%
\footnote{They stand for $n$ times |1ex plus .3ex minus .06ex| and
|1ex plus .1ex|, respectively.} Thus, you can write
\begin{verbatim}
\titlespacing{\section}{0pt}{*4}{*1.5}
\end{verbatim}
The lengths |\beforetitleunit| and |\aftertitleunit| are used
-as units in the |*| settings and you can change them if you don't like
+as units in the |*| settings and you can change them if you do not like
the predefined values (or for slight changes in the makeup, for
example).
-\textbf{Notes.} |\titlespacing| does not work with neither |\chapter|
-nor |\part| unless you change its title format as well by means of
+\textbf{Notes.} |\titlespacing| does not work with either |\chapter|
+and |\part| unless you change its title format as well by means of
|\titleformat|, the simple settings, or |\titleclass|. Arguments in
|\titlespacing| must be dimensions; |\stretch| includes a command and
hence raises an error.
@@ -407,9 +419,11 @@ These commands are provided as tools for |\titleformat| and
Variants of the |\ragged...| commands, with slight differences. In
particular, the |\ragged...| commands kills the left and right spaces
-set by |\titlespacing|.
-|\fillast| justifies the paragraph, except the last line which is
-centered.\footnote{Admittedly, a weird name, but it's short.} These
+set by |\titlespacing|.\footnote{Remember the package
+\textsf{ragged2e} provides some additional commands for alignment,
+too, like \texttt{\string\justifying}.} |\fillast| justifies the
+paragraph, except the last line which is
+centered.\footnote{Admittedly, a weird name, but it is short.} These
commands work in the |frame| label, too.
|\filinner| and |\filouter| are |\filleft| or |\filright| depending
@@ -422,7 +436,7 @@ on the page, see ``Extended settings'' below.
|\wordsep|
\end{desc}
-The inter-word space of the current font.
+The inter-word space for the current font.
\begin{desc}
|indentafter noindentafter| \quad (Package options)
@@ -438,11 +452,11 @@ deprecated.}
\end{desc}
With |rigidchapters| the space for chapter titles is always the same,
-and |<aftersep>| in |\titlespacing| does not mean the space from the
+and |<after-sep>| in |\titlespacing| does not mean the space from the
bottom of the text title to the text body as described above, but from
-the \textit{top} of the text title, i.~e., |<beforesep>| $+$
-|<aftersep>| now is a fixed distance from the top of the page body to
-the main text. The default is |rubberchapters| where |<aftersep>| is
+the \textit{top} of the text title, i.~e., |<before-sep>| $+$
+|<after-sep>| now is a fixed distance from the top of the page body to
+the main text. The default is |rubberchapters| where |<after-sep>| is
the separation between title and text as usual. Actually, the name is
misleading because it applies not only to the default chapter, but to
any title of top class. (More on classes below.)
@@ -470,10 +484,10 @@ placed. Usually, you should use the starred version.
|aftersep largestsep| \quad (Package options)
\end{desc}
-By default, when there are two consecutive titles the |<aftersep>|
-space from the first one is used between them. Sometimes that is not
-the desired behaviour, especially when the |<beforesep>| space is much
-larger than the |<aftersep>| one (otherwise the default seems
+By default, when there are two consecutive titles the |<after-sep>|
+space from the first one is used between them. Sometimes this is not
+the desired behaviour, especially when the |<before-sep>| space is much
+larger than the |<after-sep>| one (otherwise the default seems
preferable). With |largestsep| the largest of them is used.
Default is |aftersep|.
@@ -482,12 +496,12 @@ Default is |aftersep|.
|pageatnewline| \quad (Package option)
\end{desc}
-\fbox{2.6} The package option \verb|pageatnewline| is for backward
-compatibility. In 2.6, \verb|\\| does not allow a page break and
-therefore is equivalent to \verb|\\*|. Since I presume none wants a
-page break inside a title, this has been made the default. If for
-some extrange reason you want to allow page breaks inside the titles,
-use the package option.
+\fbox{2.6} In version 2.6 and later, \verb|\\| does not allow a page
+break and therefore is equivalent to \verb|\\*|. Since I presume none
+wants a page break inside a title, this has been made the default. If
+for some extrange reason you want to allow page breaks inside the
+titles, use the package option \verb|pageatnewline|, which is provided
+for backward compatibility.
\subsection{Rules}
@@ -503,7 +517,7 @@ They also take into account the space used by marginal titles.
\end{desc}
The |\titleline| command allows inserting a line, which may
-contain text and other ``horizontal'' material. It's intended
+contain text and other ``horizontal'' material. it is intended
mainly for rules and leaders but in fact is also useful for other
purposes. The line has a fixed width and hence must be filled, i.e.,
|\titleline{CHAPTER}| produces an underfull box. Here the optional
@@ -514,10 +528,10 @@ purposes. The line has a fixed width and hence must be filled, i.e.,
Using |\titleline| in places where vertical material is not expected
can lead to anomalous results. In other words, you can use it in the
-|<format>| (always) and |<after>| (|hang|, |display| and |block|)
+|<format>| (always) and |<after-code>| (|hang|, |display| and |block|)
arguments; and in the |display| shape at the very beginning of the
-|<before>| and |<label>| argument as well. But try it out, because
-it's very likely it works in other places.
+|<before-code>| and |<label>| argument as well. But try it out, because
+very likely it works in other places.
The |\titlerule| command, which is enclosed automatically in
|\titleline| if necessary, can be used to build rules and
@@ -556,7 +570,11 @@ The |wrap| shape has the capability of measuring the lines in the title
to format the paragraph. This capability may be extended to other
three shapes---namely |display|, |block| and |hang|---with this
package option. The length of the longest line is returned in
-|\titlewidth|.
+|\titlewidth|.\footnote{There are two further
+parameters, |\string\titlewidthfirst| and |\string\titlewidthlast|,
+which return the length of the first and last lines. There are not
+specific tools for using them, but you can assign their values to
+|\string\titlewidth| and then use |\string\titleline*|.}
As far as \TeX{} is concerned, any box is considered typeset material.
If the box has been enlarged with blank space, or if conversely a box
@@ -568,22 +586,29 @@ produces better results. In other words, using boxes whose natural
width has been overridden may be wrong.\footnote{Which include
justified lines, whose interword spacing has been enlarged.} Further,
some commands may confuse \TeX{} and stop parsing the title. But if
-you stick to text, |\\| and |\\[...]| (and it's very unlikely you
-might want something else), there will be no problems. Another
-important point is that the |<before>|, |<label>|, |<sep>|, and
-|<title>| parameters (but not |<after>|) are evaluated twice at local
+you stick to text, |\\| and |\\[...]| (and it is very unlikely you
+might want something else), there will be no problems.
+
+Another
+important point is the |<before-code>|, |<label>|, |<sep>|, and
+|<title>| parameters (but not |<after-code>|) are evaluated twice at local
scope; if you increase a counter \emph{globally}, you are increasing
it twice. In most of cases, placing the conflicting assignment in the
-|<after>| parameter will be ok.\footnote{There are two further
-parameters, |\string\titlewidthfirst| and |\string\titlewidthlast|,
-which return the length of the first and last lines. There are not
-specific tools for using them, but you can assign their values to
-|\string\titlewidth| and then use |\string\titleline*|.}
+|<after-code>| parameter will be ok, but alternativey you can use the
+following macro.
+
+\begin{desc}
+|\iftitlemeasuring{<true>}{<false>}|
+\end{desc}
+
+\fbox{2.9} When the title is being measured (first pass), the |<true>|
+branch is used, and when the title is actually typeset (second pass)
+the |<false>| branch is used.
-We now describe a variant of |\titleline|.
\begin{desc}
|\titleline*[<align>]{<horizontal material>}|
\end{desc}
+A variant of |\titleline| to be used only with |calcwidth|.
The text will be enclosed first in a box of width |\titlewidth|; this box
will be in turn enclosed in the main box with the specified alignment.
There is no equivalent |\titlerule| and therefore you must enclose
@@ -611,7 +636,7 @@ For example, to suppress the page number in chapters write:
\begin{desc}
|\sectionbreak \subsectionbreak \subsubsectionbreak|\\
-|\paragraphbreak \subparagraphbreak|
+|\paragraphbreak \subparagraphbreak \<section>break|
\end{desc}
By defining these command with |\newcommand| different page breaks
@@ -630,8 +655,7 @@ page; that's accomplished with:
\vspace*{0pt}}
\end{verbatim}
-\fbox{2.6} Until now, \verb|\...break| was allowed only in the
-\verb|straight| class, but now it's available in the \verb|top| class,
+\fbox{2.6} \verb|\<section>break| is available in the \verb|top| class,
too. Suitable values would be \verb|\cleardoublepage| (the default if
\verb|openright|) and \verb|\clearpage| (the default if
\verb|openany|). Thus, you can override \verb|openright| by defining
@@ -645,8 +669,13 @@ changed to \verb|top| (in this example, parts will continue with the
\fbox{2.6} If defined, the usual white space written to lists (ie,
List of Figures and List of Tables) is replaced by the code in this
-command. If you don't want the white space when a chapter begins,
-define it to empty. This command is not a general tool to control
+command. If you do not want the white space when a chapter begins,
+define it to empty, i.e.,
+\begin{verbatim}
+\newcommand{\chaptertolists}{}
+\end{verbatim}
+
+This command is not a general tool to control
spacing in lists, and is available only in titles of top class, so
it will not work with the default chapters except if you change their
class (on the other hand, |\...tolists| can be used in any title whose
@@ -658,7 +687,7 @@ class is top).
|explicit| \quad (Package option)
\end{desc}
-\fbox{2.7} With it, the title is not implicit after |<before>| but
+\fbox{2.7} With it, the title is not implicit after |<before-code>| but
must be given explicitly with |#1| as in, for example:
\begin{verbatim}
\titleformat{\section}
@@ -697,7 +726,7 @@ TOC entries, which will be based on the full title.
\fbox{2.6} Replaces every occurrence of \verb|\\| or \verb|\\*| in
titles by a space in running heads and TOC entries. This way, you
-don't have to repeat the title just to remove a formatting command.
+do not have to repeat the title just to remove a formatting command.
@@ -718,7 +747,7 @@ besides the sectioning command name. Thus, the available keys are:
\begin{itemize}
\item |name|. Allowed values are |\chapter|, |\section|, etc.
\item |page|. Allowed values are |odd| or |even|.
-\item |numberless|. A valueless key. It's not necessary unless you
+\item |numberless|. A valueless key. it is not necessary unless you
want to set different numbered (without this key) and unnumbered
(with |numberless|) variants.
\end{itemize}
@@ -732,8 +761,8 @@ is in fact an abbreviation for
\titleformat{name=\section} ...
\end{verbatim}
-Let's suppose that we'd like a layout with titles in the
-outer margin. We may set something like
+Let's suppose we'd like a layout with titles in the
+outer margin. We might set something like
\begin{verbatim}
\titleformat{name=\section,page=even}[leftmargin]
{\filleft\scshape}{\thesection}{.5em}{}
@@ -767,7 +796,7 @@ misleading. In one side printing the ``odd'' pages refer
to ``even'' pages as well (cf.\@ |\oddsidemargin|.)
If you intend to create different odd/even \emph{and}
-different numbered/unnumbered versions, it's recommended defining
+different numbered/unnumbered versions, it is recommended defining
the four variants.
If you remove the page specifier from a sectioning command you
@@ -787,16 +816,16 @@ are three classes: |page| is like the book |\part|, in a single page,
the top, and |straight| is intended for titles in the middle of
text.\footnote{There is an further class named |part| to emulate the
article |\cs{part}|, but you should not use it at all. Use the
-|straight| class instead. Remember that some features rely in these
-classes and that \textsf{titlesec} does not change by default the
+|straight| class instead. Remember some features rely in these
+classes and \textsf{titlesec} does not change by default the
definition of \texttt{\string\part} and \texttt{\string\chapter}.}
\begin{desc}
|\titleclass{<name>}{<class>}|\\
-|\titleclass{<name>}{<class>}[<sup-level>]|
+|\titleclass{<name>}{<class>}[<super-level-cmd>]|
\end{desc}
-If you don't use the optional argument, you just change
+If you do not use the optional argument, you just change
the |<class>| of |<name>|. For example:
\begin{verbatim}
\titleclass{\part}{straight}
@@ -804,7 +833,7 @@ the |<class>| of |<name>|. For example:
makes |part| of |straight| class.
When the second form is used, the level number is the following of
-|<sup-level>|. For example:
+|<super-level-cmd>|. For example:
\begin{verbatim}
\titleclass{\subchapter}{straight}[\chapter]
\newcounter{subchapter}
@@ -830,21 +859,22 @@ except if you use the |newparttoc| option.
|loadonly| \quad (Package option)
\end{desc}
-Now, you want to create your sectioning commands from scratch.
+Let us suppose you want to create your sectioning commands from scratch.
This package option ignores any previous definitions, if any,
-and hence removes the possibility of using the option described
+and hence removes the possibility of using the options described
in ``Quick Reference.'' Then you use the \textsf{titlesec}
tools, and define the corresponding counters and labels.
\begin{desc}
-|\titleclass{<name>}[<top-num>]{<class>}|
+|\titleclass{<name>}[<start-level-num>]{<class>}|
\end{desc}
-Here, the |<name>| title is considered the top level, with |<top-num>|
-level number (typically 0 or $-$1). It should be used only when
-creating sectioning commands from scratch with the help of |loadonly|,
-and there must be exactly one (no more, no less) declaration of this
-kind. After it, the rest of levels are added as explained above.
+Here, the |<name>| title is considered the top level, with number
+|<start-level-num>| (typically 0 or $-$1). It should be used only
+when creating sectioning commands from scratch with the help of
+|loadonly|, and there must be exactly one (no more, no less)
+declaration of this kind. After it, the rest of levels are added as
+explained above.
\section{Additional Notes}
%~~~~~~~~~~~~~~~~~~~~~~~~
@@ -869,12 +899,12 @@ See your \LaTeX{} manual for further reference on boxing commands.
\subsection{Starred Versions}
\label{s:starred}
-The use of sectioning commands in the starred version is strongly
+Using sectioning commands in the starred version is strongly
discouraged. Instead, you can use a set of markup oriented commands
which are easy to define and modify, if necessary. Thus, you can test
different layouts before choosing amongst them.
-Firstly remember that if you say
+Firstly remember if you say
\begin{verbatim}
\setcounter{secnumdepth}{0}
\end{verbatim}
@@ -882,7 +912,7 @@ sections will be not numbered but they will be included in both toc
and headers.
Now, let's
-suppose that you want to include some sections with a special content;
+suppose you want to include some sections with a special content;
for example, a section (or more) with exercises. We will use an
environment named |exercises| whose usage is:
\begin{verbatim}
@@ -926,7 +956,7 @@ no toc line:
\end{verbatim}
(I find the latter a bit odd in this particular example; the
first and second options are more sensible. The |\ignorespaces|
-is not very important, and you needn't it unless there is
+is not very important, and you need not it unless there is
unwanted space in the toc.)
That works with standard classes, but if you are using
@@ -937,8 +967,8 @@ that's accomplished with |\ifthesection| (see below).
As you can see, there are no |\addcontentsline|, no
|\markboth|, no |\section*|, just logical structure. Of
course you may change it as you wish; for example if you decide
-that these sections should be typeset in small typeface, include
-|\small|, and if you realize that you don't like that, remove it.
+these sections should be typeset in small typeface, include
+|\small|, and if you realize you do not like that, remove it.
While the standard \LaTeX{} commands are easier and more
direct for simple cases, I think the proposed method above is
@@ -983,7 +1013,7 @@ The basic technique was described above, but here is a reminder:
{\thesection}{..}{..\periodafter}
\end{verbatim}
-If you had to combine that dot with some command (perhaps an
+If you had to combine this dot with some command (perhaps an
underlining), you can say:
\begin{verbatim}
\newcommand{\periodafter}[2]{#1{#2.}}
@@ -992,7 +1022,7 @@ underlining), you can say:
{\thesection}{..}{..\periodafter{\ul}} % \ul from soul package
\end{verbatim}
-You might prefer the package option \texttt{explicit}.
+However, you might prefer the package option \texttt{explicit}.
\section{Page Styles}
%~~~~~~~~~~~~~~~~~~~
@@ -1001,7 +1031,7 @@ As a part of this package a set of commands are provided for one-step
headline and footline settings. Those page styles has been designed to work
with sectioning related information; you shouldn't use to create
headers with the first an last entry of a page in a dictionary,
-for example (you could, but it's more complicated than with
+for example (you could, but it is more complicated than with
\textsf{fancyhdr}).
It works with standard classes and many others; however, additional
@@ -1011,16 +1041,16 @@ adjustments could be necessary in some of them (for instance the
Two columns layout requires the
\textsf{fix2col} package by David Carlisle.} For using them,
set the following package option:\footnote{The
-way page styles works have been reimplemented in full in release 2.3.
+way page styles works was reimplemented in full in release 2.3.
However, in most of cases you won't notice it at all.}
\begin{desc}
|pagestyles|
\end{desc}
-Once that has been done, you can define your own page styles
+Once this has been done, you can define your own page styles
and then activate them.\footnote{Page styles so defined cannot
be used with \texttt{\string\thispagestyle} except if the surrounding
-page style has been defined with titlesec, too.}
+page style has been defined with \textsf{titlesec}, too.}
\subsection{Defining Page Styles}
@@ -1030,7 +1060,7 @@ page style has been defined with titlesec, too.}
\end{desc}
Defines a new style or redefines an existing one, named |<name>|.
-For convenience, end of lines are ignored, and you needn't ``hide''
+For convenience, end of lines are ignored, and you need not ``hide''
them with |%|.\footnote{Even if marks should be reserved to
pass information to headers, some classes, like AMS ones, introduce additional
code. When redefining the |plain| style of AMS classes, you must add the
@@ -1040,9 +1070,7 @@ following line:
|<global-style>| is any command to be applied to both footlines and
headlines. Fragile commands are allowed.
-In |<commands>| you can use (these commands are local to a page
-style, i.e., defining them directly in the preamble will
-not work because the page style settings will override them):
+In |<commands>| you can use
\begin{desc}
|\headrule \footrule|\\
@@ -1054,6 +1082,10 @@ also set their width directly with the commands |\setheadrule| and
|\setfootrule|. (For instance, |\setheadrule{.4pt}| which is, by the
way, the default value.)
+These commands are local to a page
+style, i.e., defining them directly in the preamble will
+not work because the page style settings will override them.
+
\begin{desc}
|\makeheadrule \makefootrule|
\end{desc}
@@ -1063,7 +1095,7 @@ If there is no rule, both commands are empty (this value is the
default).
|\setheadrule{|\emph{dim}|}| just stands for
\begin{verbatim}
-\renewcommand{\makeheadrule}{\rule[-.3\baselineskip]{\linewidth}{d}}
+\renewcommand{\makeheadrule}{\rule[-.3\baselineskip]{\linewidth}{<dim>}}
\end{verbatim}
unless if \emph{dim} is 0 pt, which empties
|\makeheadrule| (and similarly |\setfootrule|).
@@ -1071,7 +1103,7 @@ unless if \emph{dim} is 0 pt, which empties
You can access the total head/foot width with |\linewidth|
but the box enclosing the rule is in fact dimensionless. Hence,
you must be concerned with the rule placement only. Its
-baseline is the same as that of the head/foot. That means that the
+baseline is the same as that of the head/foot. That means the
material to be used as rule should be raised or lowered with
|\raisebox|, the lifting argument in |\rule| or by using sensible
coordinates in |picture|, for instance. That makes easy to
@@ -1100,10 +1132,10 @@ Set the corresponding part in heads and foots. The optional arguments
are all or none. If no optional arguments are given the odd-page
settings applies to both even and odd pages. A couple of starred
variant (|\setfoot*|, |\sethead*|) reverses the order of the settings
-for even pages (obviously, if you use them, the optional arguments are
+for even pages (obviously, with them the optional arguments are
not allowed). In the arguments of |\sethead|/|\setfoot| and because
of its one-step mechanism, we must distinguish between two groups of
-commands. The first one are those saved when the marks are sent, with
+commands. The first one includes those saved when the marks are sent, with
information related to sections, and includes:
\begin{itemize}
\item |\thechapter|, |\thesection|\dots{}
@@ -1143,7 +1175,7 @@ By default it is
to set the default to be used in newly defined and redefined page styles.
Use it before |\pagestyle|.
-Note that |\markboth| is a command to set the |myheadings| marks and
+Note |\markboth| is a command to set the |myheadings| marks and
here does not make sense. In fact, using it can lead to unpredictable
results. Anyway, using directly the marking commands is discouraged
(see sec.~\ref{s:starred}) but if you need them, you may use them
@@ -1169,18 +1201,18 @@ starred version reverses the setting for even pages---for example,
\subsection{Running heads with floats}
\begin{desc}
-|psfloats| (Package option.)
+|psfloats| \quad (Package option.)
\end{desc}
This package option activates the commands described in this section.%
\footnote{It redefines some internal \LaTeX{} commands and there could be
incompatibilities with other packages modifying the same commands. That's
-the very reason these commands are loaded only optionally.}
-
-\fbox{2.6} The commands below now have a new argument to allow
-extra stuff in running heads/foots. This change is backward
+the very reason these commands are loaded only optionally. As of
+version 2.6 the syntax was extended with a new argument to allow
+extra stuff in running heads/foots. This change was backward
compatible---just preserve the old name \verb|floatps|, which
-is deprecated, if you want the old behaviour.
+is deprecated, if you want the pre-2.6 behaviour.}
+
\begin{desc}
|\setfloathead*{.}{.}{.}{<extra>}[<which-floats>]|\\
@@ -1189,7 +1221,7 @@ is deprecated, if you want the old behaviour.
\end{desc}
The arguments with a dot are similar to those of |\sethead|. The final
-argument says that head is used when there is a float of
+argument says the head is used when there is a float of
the specified types (default is |tp| in headers, and |bp| in footers).
For example:
\begin{verbatim}
@@ -1210,7 +1242,7 @@ removes the header/footer on float pages, including the rules.
\end{desc}
You may force a header (respectively footer) when a certain
-float is the first top (respectively last bottom) one with
+float is the first top one (respectively last bottom) with
those commands, where the arguments with a dot are similar to
those of |\sethead|, just before the corresponding float.
Those commands are used by themselves, without putting them
@@ -1222,13 +1254,14 @@ inside |\(re)newpagestyle|.
|outermarks innermarks topmarks botmarks| \quad (Package options)
\end{desc}
-|innermarks| is the default in \LaTeX, with bottom marks in even pages
-and first marks in odd pages. More convenient is |outermarks|, with
-top marks in even pages and bottom marks in odd pages; it's the more
-usual system in technical works and it's described in \textit{The
-\TeX{}book}, p.~259. Both of them are intended for two side printing;
-|topmarks|/|botmarks| are intended for one side printing with top/bot
-marks in every page (they can be used in two side printing as well).%
+|innermarks| is the default in \LaTeX, with bottom marks in even pages
+and first marks in odd pages. More convenient is |outermarks|, with
+top marks in even pages and bottom marks in odd pages; it is the more
+usual system in classic scientific literature and it is described in
+\textit{The \TeX{}book}, p.~259. Both of them are intended for two
+side printing; |topmarks|/|botmarks| are intended for one side
+printing with top/bot marks in every page (they can be used in two
+side printing as well).%
\footnote{|outermarks| does not work well in conjunction with explicit
|\string\<section>mark| commands. The top marks mechanism fails just
after explicit page breaks.}
@@ -1240,17 +1273,17 @@ after explicit page breaks.}
One of the cooler features added to page styles is the possibility of
selecting which marks are used in subsequent macros. These commands
-set from which mark the values of |\thesection|, |\sectiontitle|, etc.
-will be taken. You can use freely in your headers;\,%
+set which mark the values of |\thesection|, |\sectiontitle|,
+etc., will be taken from. You can use freely in your headers;\,%
\footnote{Not exactly: top marks must not be used in the page where a
chapter begins, except by overriding the default definition and making
it of |top| class.} just for fun, the following header shows the
section label from three of these marks:
\begin{verbatim}
\newpagestyle{funny}{
- \sethead{Top is \toptitlemarks\thesection}
- {First is \firsttitlemarks\thesection}
- {Bot is \bottitlemarks\thesection}}
+ \sethead{Top~is~\toptitlemarks\thesection}
+ {First~is~\firsttitlemarks\thesection}
+ {Bot~is~\bottitlemarks\thesection}}
\end{verbatim}
|\outertitlemarks| is the default value when the |outermarks| package
@@ -1345,12 +1378,12 @@ example), and adds new features.
This package is a companion to the \textsf{titlesec} package and it
handles
-toc entries. However, it's an independent package and you can use
+toc entries. However, it is an independent package and you can use
it alone. The philosophy is similar to that of \textsf{titlesec}---instead
of hooking the commands as defined by standard \LaTeX{} and classes,
there are new commands which you can format the toc entries with
-in a generic way. That means that you have to learn just
-two new basic command and a couple of tools, no more, and that you have access
+in a generic way. This means you have to learn just
+two new basic command and a couple of tools, no more, and you have access
to
new features. Paragraph format
and fonts are set with commands like |\\|,
@@ -1360,19 +1393,19 @@ fashion because they are pretty free form.
The behaviour of entries
defined with \textsf{titletoc} are different at some points
-to that created with the standard commands. In particular:
+to those created with the standard commands. In particular:
\begin{itemize}
\item Pages are never broken between entries if the first one is
of an higher level than the second one as, for instance, between
a section and a subsection. If both of them are of the same
level, the break is allowed, and if the first is lower than
-the second, it's considered a good place for a page break.
+the second, it is considered a good place for a page break.
\item The symbols in the leaders are not centered but flushed
right. That is usually more convenient.
\end{itemize}
-I would like to note that no attempt to handle tocs can be complete
+I would like to note no attempt to handle tocs can be complete
because the standard \LaTeX{} commands write directly some formatting
commands which cannot be removed. This is particularly important in
lists of figures and tables, and in the |\part| command.\footnote{But
@@ -1461,7 +1494,7 @@ and
Now, we are about to show the three basic commands:
\begin{desc}
-|\dottedcontents{<section>}[<left>]{<above>}|\\
+|\dottedcontents{<section>}[<left>]{<above-code>}|\\
| {<label width>}{<leader width>}|
\end{desc}
@@ -1473,7 +1506,7 @@ Here:
and not the |\part|, |\section|, etc. macros themselves.
Furthermore, |figure| and |table| are environments.)
-\item |<above>| is code for the global formatting of the entry.
+\item |<above-code>| is code for the global formatting of the entry.
Vertical material is allowed. At this point the value of
|\thecontentslabel| (see below) is known which enables you to
take decisions depending on its value (with the help of
@@ -1499,28 +1532,28 @@ class are roughly equivalent to:
\end{verbatim}
\begin{desc}
-|\titlecontents{<section>}[<left>]{<above>}|\\
-| {<before with label>}{<before without label>}|\\
-| {<filler and page>}[<after>]|
+|\titlecontents{<section>}[<left>]{<above-code>}|\\
+| {<numbered-entry-format>}{<numberless-entry-format>}|\\
+| {<filler-page-format>}[<below-code>]|
\end{desc}
-Here |<section>|, |<left>| and |<above>| like above, and
+Here |<section>|, |<left>| and |<above-code>| like above, and
\begin{itemize}
-\item |<before with label>| is in horizontal mode and it will
+\item |<numbered-entry-format>| is in horizontal mode and it will
be used just before the entry title. As in |\titleformat|, the
last command can take an argument with the title.
-\item |<before without label>| is like the above if there is, well,
+\item |<numberless-entry-format>| is like the above if there is, well,
no label.
-\item|<filler and page>| is self explanatory. Fillers are created
+\item|<filler-page-format>| is self explanatory. Fillers are created
with the |\titlerule| command which is shared by that package and
\textsf{titlesec}. However, when used in this context its behaviour
changes a little to fit the needs of toc leaders.\footnote{For
\TeX{}nicians, the default |\cs{xleaders}| becomes
|\cs{leaders}|.} You might prefer a |\hspace| instead.
-\item And finally |<after>| is code following the entry for, say,
+\item And finally |<below-code>| is code following the entry for, say,
vertical space.
\end{itemize}
@@ -1539,7 +1572,7 @@ see the changes.
The value set is used in all of sections. If you are wondering
why, the answer is quite simple: in most of cases the |<right>|
margin will be constant. However, you are allowed to change
-it locally in the |<before>| arguments. Note as well that
+it locally in the |<before-code>| arguments. Note as well that
the default space in standard classes does not leave room to
display boldfaced page number above 100 and therefore you
might want to set a larger margin with this command.
@@ -1558,12 +1591,12 @@ Compare this definition with that given above and you will
understand how |\dottedcontents| is defined.
Although standard classes use font dependent units (mainly em),
-it's recommended using absolute ones (pc, pt, etc.)
-
+it is recommended using absolute ones (pc, pt, etc.) to ensure
+they entries are aligned correctly.
\subsection{And more}
-Strict typographical rules state that full text lines shouldn't
+Strict typographical rules state full text lines shouldn't
surpass the last dot of the leaders; ideally they should be aligned.
Surprisingly enough, \TeX{} lacks of a tool for doing that
automatically---when you fill a box with leading dots, they can be
@@ -1585,7 +1618,7 @@ the text lines are 6 pt longer than the last dot, you should rewrite the
|\contentsmargin| command to add a |<correction>| of 6 pt.%
\footnote{Usefully, many dvi previewers allow to get the coordinates of
the pointed location.} Unlike the standard \LaTeX{} tools, the
-|\titlerule*| command has been designed so the |<correction>|
+|\titlerule*| command has been designed so that the |<correction>|
will have the minimum value possible.
\begin{desc}
@@ -1608,15 +1641,15 @@ just |\thecontentslabel| and |\thecontentspage|, respectively.
\end{desc}
Prints the |<text>| and increases
-|<left>| by the width of |<text>|. is similar to
+|<left>| by the width of |<text>|. It is similar to
the hang shape of \textsf{titlesec}.
\begin{desc}
-|\titlecontents*{<section>}[<left>]{<above>}|\\
-| {<before with label>}{<before without label>}|\\
-| {<filler and page>}[<separator>]|\\[3pt]
-| |\textit{or ...}|{<filler and page>}[<separator>][<end>]|\\
-| |\textit{or ...}|{<filler and page>}[<begin>][<separator>][<end>]|
+|\titlecontents*{<section>}[<left>]{<above-code>}|\\
+| {<numbered-entry-format>}{<numberless-entry-format>}|\\
+| {<filler-page-format>}[<separator>]|\\[3pt]
+| |\textit{or ...}|{<filler-page-format>}[<separator>][<end>]|\\
+| |\textit{or ...}|{<filler-page-format>}[<begin>][<separator>][<end>]|
\end{desc}
This starred version groups the entries in a single paragraph.
@@ -1633,23 +1666,23 @@ punctuation. For example, this document sets:
\end{verbatim}
whose result is showed in the contents at the very beginning of
this document. Note the paragraph format must be written in
-the |<above>| argument.
-
-Let's explain how the optional arguments works. First note the
-number of them determines their meaning---since there should be a
-separator between entries this one is always present; on the other
-hand, |<begin>| is rarely used and hence it has the lowest
-``preference.'' The simplest case is when the titles are of the same
-level; in this case the |<sep>| and the |<end>| parameters (which default to
-empty) are inserted between consecutive entries and at the end of the
-block, respectively. |<before>| is executed just once at the very
-beginning of the block and its declarations are local to the whole set
-of entries.
-
-Let's now suppose we want to group entries of two levels; in this
+the |<above-code>| argument.
+
+Let us explain how the optional arguments works. First note the number
+of them determines their meaning---since there should be a separator
+between entries this one is always present; on the other hand,
+|<begin>| is rarely used and hence it has the lowest ``preference.''
+The simplest case is when the titles are of the same level; in this
+case the |<sepatator>| and the |<end>| parameters (which default to
+empty) are inserted between consecutive entries and at the end of the
+block, respectively. |<before-code>| is executed just once at the
+very beginning of the block and its declarations are local to the
+whole set of entries.
+
+Now suppose we want to group entries of two levels; in this
case a nesting principle applies. To fix ideas, we will use section
and subsection. When a subsection entry begins after a section one,
-|<before>| is executed and |<begin>| of subsection is
+|<before-code>| is executed and |<begin>| of subsection is
inserted, which should contain text format only. Then subsections are
added inserting separators as explained above. When a section
arrives, the ending punctuation of subsection and the separator of
@@ -1682,7 +1715,7 @@ fourth section {\upshape(A subsection in it, 1. Another, 2)}.
\end{desc}
Makes \textsf{titletoc} aware of the existence of a contents file with
-|<ext>| extension. Mainly, it makes sure that the command
+|<ext>| extension. Mainly, it makes sure the command
|\contentsfinish| is added at the end of the corresponding
contents (and which must be added at the end of tocs made by hand).
The package performs
@@ -1718,40 +1751,41 @@ With this package option, a dot is added after the label in
\subsection{Partial TOC's}
\begin{desc}
-|\startcontents[<kind>]|
+|\startcontents[<name>]|
\end{desc}
-At the point where this command is used, a partial toc begins.
-The |<kind>| argument allows different sets of tocs and it
-defaults to |default|. These sets may be intermingled, but usually
-will be nested. For example, you may want two kinds of partial tocs:
-by part and by chapter (besides the full toc, of course). When
-a part begins, write |\startcontents[parts]|, and when a chapter
-|\startcontents[chapters]|. This way a new toc is started at
-each part and chapter.\footnote{\emph{All} partial tocs are
-stored in a single file with extension |.ptc|.}
+At the point where this command is used, a partial toc begins (note
+the document doesn't require a |\tableofcontents| for partial tocs to
+work). The |<name>| argument allows different sets of tocs and it
+defaults to |default|. These sets may be intermingled, but usually
+will be nested. For example, you may want two kinds of partial tocs:
+by part and by chapter (besides the full toc, of course). When a part
+begins, write |\startcontents[parts]|, and when a chapter
+|\startcontents[chapters]|. This way a new toc is started at each
+part and chapter.\footnote{\emph{All} partial tocs are stored in a
+single file with extension |.ptc|.}
\begin{desc}
-|\stopcontents[<kind>]|\\
-|\resumecontents[<kind>]|
+|\stopcontents[<name>]|\\
+|\resumecontents[<name>]|
\end{desc}
-Stops the partial toc of |<kind>| kind, which may be resumed.
+Stops the partial toc of |<name>| kind, which may be resumed.
Since partial contents are stopped by |\startcontents| if necessary,
-you won't use those macros very often.
+those macros will not be used very often.
\begin{desc}
-|\printcontents[<kind>]{<prefix>}{<top>}{<init-code>}|
+|\printcontents[<name>]{<prefix>}{<start-level>}{<toc-code>}|
\end{desc}
-Print the current partial toc of |<kind>| kind. The format
+Print the current partial toc of |<name>| kind. The format
of the main toc entries are used, except if there is a |<prefix>|.
In such a case, the format of |<prefix><level>| is used, provided
it is defined. For example, if prefix is |l| and the format of
|lsection| is defined, then this definition will be used; otherwise,
-the format is that of |section|. The |<top>| parameter sets the
+the format is that of |section|. The |<start-level>| parameter sets the
top level of the tocs---for a part toc it would be |0| (chapter), for a
-chapter toc |1| (section), and so on. Finally, |<init-code>| is
+chapter toc |1| (section), and so on. Finally, |<toc-code>| is
local code for the current toc; it may be used to change the
|tocdepth| value or |\contentsmargin|, for instance.
@@ -1768,7 +1802,8 @@ A simple usage might look like (provided you are using
{\small\itshape}{}{}
{}[ \textbullet\ ][.]
\end{verbatim}
-The included entries are those in the level from 1 to 2 inclusive.
+The included entries are those in levels 1 to 2 inclusive (i.e., 1
+and 2).
\subsection[Partial lists]{Partial lists \normalfont\normalsize\fbox{2.6}}
@@ -1776,22 +1811,22 @@ You may want to create partial LOFs and LOTs. The systax is similar to
that of partial TOCs and what was said for them can be applied here.
The commands are:
\begin{desc}
-|\startlist[<kind>]{<list>}|\\
-|\stoplist[<kind>]{<list>}|\\
-|\resumelist[<kind>]{<list>}|\\
-|\printlist[<kind>]{<list>}{<prefix>}{<init-code>}|
+|\startlist[<name>]{<list>}|\\
+|\stoplist[<name>]{<list>}|\\
+|\resumelist[<name>]{<list>}|\\
+|\printlist[<name>]{<list>}{<prefix>}{<toc-code>}|
\end{desc}
Here |<list>| is either |lof| or |lot|. Note as well |\printlist|
-does not have the |<top>| argument, because figures and tables have
-not levels. Currently (version 2.8), only these two floats are
-supported, but in a future release support for more kinds of floats
-will be added. Unfortunately, many classes write some formatting
-commands to these lists (more precisely, \verb|\addvspace|s in
-chapters); I'm still not sure how to remove these commands without
-removing as well others which can be wanted, but for the time being a
-quick trick to remove these spaces is to redefine \verb|\addvspace| in
-the |<init-code>| with |\renewcommand\addvspace[1]{}|.
+does not have the |<start-level>| argument, because figures and tables
+have not levels. Currently, only those two float lists are supported,
+but in a future release support for more kinds of float lists will be
+added. Unfortunately, many classes write some formatting commands to
+these lists (more precisely, \verb|\addvspace|s in chapters); I'm
+still not sure how to remove these commands without removing as well
+others which can be wanted, but for the time being a quick trick to
+remove these spaces is to redefine \verb|\addvspace| in the
+|<toc-code>| with |\renewcommand\addvspace[1]{}|.
\subsection{Examples}
@@ -1840,7 +1875,7 @@ arguments are not allowed and writing complex code could be a mess.
The trick is to define a command to perform the required operations
which in turn is written with |\protect|.
-Let's suppose that we want to insert a figure before an entry.
+Let's suppose we want to insert a figure before an entry.
\begin{verbatim}
\newcommand{\figureintoc}[1]{
\begin{figure}
@@ -1858,7 +1893,7 @@ In the place where a figure is inserted write:
Let's now resume a problem explained in relation with
\textsf{titlesec}: marking sections with asterisks to
-denote an ``advanced topic'' unless that the star should
+denote an ``advanced topic'' unless the star should
be printed in the toc as well. Here is the code:
\begin{verbatim}
\newcommand{\secmark}{}
@@ -1876,11 +1911,11 @@ be printed in the toc as well. Here is the code:
\section{The \textsf{titlesec} philosophy}
-Once you have read the documentation it should be clear that this
+Once you have read the documentation it should be clear this
is not a package for the casual user who likes the standard
layout and wants to make simple changes. This is a tool for the
-serious typographer that has a clear idea of what layout wants
-and don't have the skill to get it. No attempt is made to improve
+serious typographer who has a clear idea of what layout wants
+and do not have the skill to get it. No attempt is made to improve
your taste in section formatting.
\section{Appendix}
@@ -2061,7 +2096,7 @@ by some text to show the result.
\section[Appendix]{And another}
Note how the text wraps the title and the space reserved to it is
-readjusted automatically. And that is followed by some text to
+readjusted automatically. And it is followed by some text to
show the result. Which is followed by some text to show the result.
\begin{verbatim}
@@ -2108,7 +2143,7 @@ after a sensible value (1em, for example).
\section*{Example of margin section}
Which is followed by some text to show the result.
-But don't stop reading, because the following example illustrates how
+But do not stop reading, because the following example illustrates how
to take advantage of other packages. The last command in the last
argument can take an argument, which is the title with no
additional command inside it. We just give the code, but you
@@ -2139,7 +2174,7 @@ The margin title above was defined:
\examplesep
The following examples are intended for chapters. However, this
-document lacks of |\chapter| and are showed using |\sections|
+document lacks of |\chapter| and are showed using |\section|s
with slight changes.
\titlespacing{\section}{0pt}{*4}{*4}