summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/memoir/doc-src/memman.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/memoir/doc-src/memman.tex')
-rw-r--r--macros/latex/contrib/memoir/doc-src/memman.tex571
1 files changed, 219 insertions, 352 deletions
diff --git a/macros/latex/contrib/memoir/doc-src/memman.tex b/macros/latex/contrib/memoir/doc-src/memman.tex
index c233cfecd9..f186c23cfd 100644
--- a/macros/latex/contrib/memoir/doc-src/memman.tex
+++ b/macros/latex/contrib/memoir/doc-src/memman.tex
@@ -389,8 +389,8 @@ Manual last changed \svnyear/\svnmonth/\svnday
\svnidlong
{$Ignore: $}
-{$LastChangedDate: 2023-08-08 16:33:42 +0200 (Tue, 08 Aug 2023) $}
-{$LastChangedRevision: 772 $}
+{$LastChangedDate: 2024-01-26 14:56:06 +0100 (Fri, 26 Jan 2024) $}
+{$LastChangedRevision: 806 $}
{$LastChangedBy: daleif@math.au.dk $}
\chapter{Remarks from the maintainer}
@@ -398,7 +398,7 @@ Manual last changed \svnyear/\svnmonth/\svnday
When Peter Wilson released the first version of \theclass{} (back in
-2021), \LaTeX{} land was very different. Updating packages outside of
+2001), \LaTeX{} land was very different. Updating packages outside of
the yearly release (TeXLive) had to be done by hand. Manuals for
packages was \emph{not} even a requirement for CTAN. Thus it made
sense to embed the functionality from several packages and provide
@@ -462,30 +462,12 @@ Additionally, going forward I will additionally be starting to look at
removing certain functionality from \theclass. This will be things
that does not really belong in \theclass, users should really get this
functionality from somewhere else (some additional package). Unless it
-is clear that the macro has to go due to reimplemantation of a
-feature, the removal will be announced in advance (say 12--18 months),
-by adding a warning to the macro (especially if we would like the user
-to use a different macro). It will also be marked in the manual that
-the macro/environment will be removed in a future release.
-
-% Macros and environments currently under consideration (but not marked
-% yet) include: \begingroup
-% \renewcommand\descriptionlabel[1]{\hspace\labelsep\parbox[t]{\dimexpr\textwidth-5pt\relax}{#1}}
-% \begin{description}
-% \item[\cmd{\patchcommand}]
-% Users should use \cmd{\pretocmd} and \cmd{\apptocmd} from
-% \Lpack{etoolbox}. The \Lpack{xpatch} package even have extended
-% versions of them.
-% \item[ctabular]
-% This is a breakable version of \Pe{tabular} but with not way of
-% replicating the table header like for example \Lpack{longtable}
-% can. These days there are several packages to handles tables.
-% \item[\cmd{\newloglike}]
-% \item[\cmd{\provideloglike}]
-% Users should really use \cmd{\DeclareMathOperator} from
-% \Lpack{amsopn} (autoloaded by the ever present \Lpack{amsmath}).
-% \end{description}
-% \endgroup
+is clear that the macro has to go due to reimplemantation of a feature
+or that the feature probably is not used by that many people, the
+removal will be announced in advance (say 12--18 months), by adding a
+warning to the macro (especially if we would like the user to use a
+different macro). It will also be marked in the manual that the
+macro/environment will be removed in a future release.
\begin{flushright}
Summer 2023
@@ -494,11 +476,13 @@ the macro/environment will be removed in a future release.
\end{flushright}
+\begingroup
+\renewcommand\descriptionlabel[1]{\hspace\labelsep\parbox[t]{\dimexpr\textwidth-5pt\relax}{#1}}
+
+
\section*{Public interfaces removed/disabled in v3.8}
The four title macros was disabled due to the \cmd{\titleref} reimplementation.
-\begingroup
-\renewcommand\descriptionlabel[1]{\hspace\labelsep\parbox[t]{\dimexpr\textwidth-5pt\relax}{#1}}
\begin{description}
\item[\cmd{\currenttitle}] Would have given the title of the current
sectional devide. Too risky to rely on, use
@@ -513,6 +497,21 @@ The four title macros was disabled due to the \cmd{\titleref} reimplementation.
formats before 2015. The package loading and the class option have
been removed.
\end{description}
+
+\section*{Public interfaces removed/disabled in v3.8.2}
+The following macros were discontinued due to the un-embedding of the \Lpack{verbatim package}
+\begin{description}
+\item[\cmd{\tabson}, \cmd{\tabsoff}] Used to be able to enable/disable
+ tab marking support in verbatim texts.
+\item[\cmd{\wrappingon}, \cmd{\wrappingoff}] Used to be able to enable
+ automatic line breaking at white space in verbatim
+ texts.\footnote{The implementation had bugs which were never
+ reported, thus probably not used that much.}
+\item[\cmd{\verbatimbreakchar}] Left on a verbatim line broken at
+ white space.
+\end{description}
+
+
\endgroup
@@ -521,6 +520,10 @@ The four title macros was disabled due to the \cmd{\titleref} reimplementation.
+
+
+
+
%#% extend
%#% extstart include preface.tex
%\chapter{Foreword}
@@ -1451,8 +1454,8 @@ been answered.
\svnidlong
{$Ignore: $}
-{$LastChangedDate: 2023-08-06 15:24:34 +0200 (Sun, 06 Aug 2023) $}
-{$LastChangedRevision: 767 $}
+{$LastChangedDate: 2024-01-10 16:45:12 +0100 (Wed, 10 Jan 2024) $}
+{$LastChangedRevision: 802 $}
{$LastChangedBy: daleif@math.au.dk $}
\chapter{Introduction to the eighth edition}
@@ -1831,7 +1834,7 @@ the same as those in the packages:
\item \Lpack{parskip}
\item \Lpack{patchcmd}
\item \Lpack{setspace}
- \item \Lpack{shortvrb}
+ %\item \Lpack{shortvrb}
\item \Lpack{showidx}
% \item \Lpack{tabularx}
\item \Lpack{titleref}
@@ -1905,6 +1908,7 @@ The following packages are automatically loaded by the class:
\item \Lpack{nameref}
\item \Lpack{mparhack}~(if~twocolumn)
\item \Lpack{memhfixc}~(if~\Lpack{hyperref}~is~loaded)
+ \item \Lpack{shortvrb}
\end{lineitems}
\end{center}
@@ -24121,8 +24125,8 @@ and the result is shown on the next page.
\svnidlong
{$Ignore: $}
-{$LastChangedDate: 2021-03-22 14:24:31 +0100 (Mon, 22 Mar 2021) $}
-{$LastChangedRevision: 706 $}
+{$LastChangedDate: 2024-01-25 16:57:21 +0100 (Thu, 25 Jan 2024) $}
+{$LastChangedRevision: 805 $}
{$LastChangedBy: daleif@math.au.dk $}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -24259,7 +24263,7 @@ contents than it does in the \Ie{shaded} environment.
\begin{recommended}
See the \Lpack{tcolorbox} package by Thomas~F.~Sturm. An impressive
- system of boxes and decorations and much much more. All based on TikZ.
+ system of boxes, decorations and much much more. All based on TikZ.
\end{recommended}
@@ -24677,6 +24681,13 @@ be expected:
More encompassing \Ie{comment} environments are available if you
use Victor Eijkhout's \Lpack{comment} package~\cite{COMMENT}.
+\fancybreak{}
+
+Do note that due to most syntax highlighting not being aware of your
+\Ie{comment}-like envs they are easy to miss in the code.
+
+
+
\section{Verbatims}
@@ -24696,11 +24707,15 @@ this book, it gets tedious to keep on typing this sort of thing:
the \cmd{\verb}, or \cmd{\verb*}, ends the verbatim processing.
\begin{syntax}
\cmd{\MakeShortVerb}\marg{backslash-char} \\
+\cmd{\MakeShortVerb*}\marg{backslash-char} \\
\cmd{\DeleteShortVerb}\marg{backslash-char} \\
\end{syntax}
\glossary(MakeShortVerb)%
{\cs{MakeShortVerb}\marg{backslash-char}}%
{Makes \meta{char} a shorthand for \cs{verb}\meta{char}.}
+\glossary(MakeShortVerb*)%
+ {\cs{MakeShortVerb*}\marg{backslash-char}}%
+ {Makes \meta{char} a shorthand for \cs{verb*}\meta{char}.}
\glossary(DeleteShortVerb)%
{\cs{DeleteShortVerb}\marg{backslash-char}}%
{Returns \meta{char} to its normal meaning instead of being a shorthand
@@ -24711,20 +24726,24 @@ as its argument, say \verb?\!?, and makes that character equivalent to
processing.
Doing, for example \verb?\MakeShortVerb{\!}?, lets you then use
\verb?!verbatim text!?
-instead of the longer winded \verb?\verb!verbatim text!?.
+instead of the longer winded \verb?\verb!verbatim text!?.
+The \cs{MakeShortVerb*} makes a version that uses \verb?\verb*? internally.
+
+You have to pick as the short verb character one that you are unlikely
+to use; a good choice is often the \verb?|? bar character as this
+rarely used in normal text. This choice, though may be unfortunate if
+you want to have any tabulars with vertical lines, as the bar
+character is used to specify those. The \cmd{\DeleteShortVerb} macro
+is provided for this contingency; give it the same argument as an
+earlier \cmd{\MakeShortVerb} and it will restore the short verb
+character to its normal state.
+
+The \cmd{\MakeShortVerb}, \cmd{\MakeShortVerb} and
+\cmd{\DeleteShortVerb} macros come from the \Lpack{shortvrb} package
+which is automatically loaded by the class.
- You have to pick
-as the short verb character one that you are unlikely to use; a good choice
-is often the \verb?|? bar character as this rarely used in normal text.
-This choice, though may be unfortunate if you want to have any tabulars with
-vertical lines, as the bar character is used to specify those. The
-\cmd{\DeleteShortVerb} macro is provided for this contingency; give it the
-same argument as an earlier \cmd{\MakeShortVerb} and it will restore
-the short verb character to its normal state.
+\fancybreak{}
- The \cmd{\MakeShortVerb} and \cmd{\DeleteShortVerb} macros come from the
-\Lpack{shortvrb} package which is part of the \ltx\ base system, but I
-have found them so convenient that I added them to the class.
\begin{syntax}
\cmd{\setverbatimfont}\marg{font-declaration} \\
@@ -24760,12 +24779,12 @@ like ``, or '', or ---, or <, or >, print as expected.
After this we will switch back to the default verbatim font via
\setverbatimfont{\normalfont\ttfamily}
\end{verbatim}
-\setverbatimfont{\normalfont\ttfamily}
-In the normal way of things with an OT1 fontencoding,
-typesetting the ligatures mentioned above
-in the sans font produces:
-{\fontencoding{OT1}\fontfamily{cmss}\selectfont ligatures like ``, or '', or ---, or <, or >},
-which is not what happens in the \cmd{\verbatim} environment.
+\setverbatimfont{\normalfont\ttfamily} In the normal way of things
+with an OT1 fontencoding,\footnote{No-one should use OT1 encoding
+ anymore.} typesetting the ligatures mentioned above in the sans
+font produces: {\fontencoding{OT1}\fontfamily{cmss}\selectfont
+ ligatures like ``, or '', or ---, or <, or >}, which is not what
+happens in the \cmd{\verbatim} environment.
\begin{syntax}
@@ -24780,79 +24799,102 @@ environment is heavily based on the \Lpack{verbatim} package~\cite{VERBATIM}
but does provide some extensions.}
you can write anything you want (except
\eenv{verbatim}), and it will be typeset exactly as written. The \Ie{verbatim*}
-environment is similar except, like with \cmd{\verb*}, spaces will be
+environment is similar except, like with \cmd{\verb*}, spaces and tabs will be
indicated with a \verb*? ? mark.
-\begin{syntax}
-\cmd{\tabson}\oarg{number} \\
-\cmd{\tabsoff} \\
-\end{syntax}
-\glossary(tabson)%
- {\cs{tabson}\oarg{number}}%
- {Set \meta{number} of spaces in a verbatim for a TAB character;
- default 4.}
-\glossary(tabsoff)%
- {\cs{tabsoff}}%
- {Ignore extra TAB spaces in a verbatim.}
-\index{verbatim!with tab spaces}
-The standard \Ie{verbatim} environment ignores any TAB characters; with
-the class's environment after calling the \cmd{\tabson} declaration
-the environment will handle TAB characters. By default 4 spaces are used
-to represent a TAB; the optional \meta{number} argument to the declaration
-will set the number of spaces for a TAB to be \meta{number}.
-Some folk like to use 8 spaces for a TAB, in which case they would need
-to declare \verb?\tabson[8]?. Unremarkably, the declaration \cmd{\tabsoff}
-switches off TABs. The class default is \cmd{\tabsoff}.
-
-\begin{syntax}
-\cmd{\wrappingon} \\
-\cmd{\wrappingoff} \\
-\lnc{\verbatimindent} \\
-\cmd{\verbatimbreakchar}\marg{char} \\
-\end{syntax}
-\glossary(wrappingon)%
- {\cs{wrappingon}}%
- {Wrap overlong verbatim lines.}
-\glossary(wrappingoff)%
- {\cs{wrappingoff}}%
- {The normal behaviour of not wrapping overlong verbatim lines.}
-\glossary(verbatimindent)%
- {\cs{verbatimindent}}%
- {Indent for wrapped overlong verbatim lines.}
-\glossary(verbatimbreakchar)%
- {\cs{verbatimbreakchar}\marg{char}}%
- {Character indicating a verbatim line is being wrapped.}
-As noted, whatever is written in a \Ie{verbatim} environment is output
-just as written, even if lines are too long\index{verbatim!wrap long lines}
-to fit on the page. The
-declaration \cmd{\wrappingon} lets the environment break lines so that they
-do not overflow. The declaration \cmd{\wrappingoff} restores the normal
-behaviour.
-
- The following is an example of how a wrapped verbatim line looks. In
-the source the contents of the \Ie{verbatim} was written as a single line.
-\wrappingon
-\begin{verbatim}
-This is an example of line wrapping in the verbatim environment. It is a single line in the source and the \wrappingon declaration has been used.
-\end{verbatim}
-\wrappingoff
- The wrapped portion of verbatim lines are indented from the left margin
-by the length \lnc{\verbatimindent}. The value can be changed by the usual
-length changing commands. The end of each line that has been wrapped is marked
-with the \meta{char} character of the \cmd{\verbatimbreakchar} macro.
-The class default is \verb?\verbatimbreakchar{\char`\%}?, so that lines are
-marked with \verb?%?.
-To put a `/' mark at the end of wrapped lines you can do
-\begin{lcode}
-\setverbatimbreak{\char'\/}
-\end{lcode}
-or similarly if you would like another character. Another possibility
-is
-\begin{lcode}
-\setverbatimchar{\char'\/\char'\*}
-\end{lcode}
-which will make `/*' the end marker.
+\begin{Changed}[January 2024]
+ The following macros are no longer used. They will either issue a
+ warning or do nothing. Users are encouraged to remove them.
+ \cmd{\tabson}\oarg{number}, \cmd{\tabsoff} (was the default),
+ \cmd{\wrappingon}, \cmd{\wrappingoff} (was the default).
+
+ These macro enabled tabs marking (by displaying tabs as sseveral
+ spaces) and automatic line wrapping (at white space) for
+ \Ie{verbatim} (it was never applied to \Ie{verbatim*}). As part of a
+ restructuring these features are no longer supported.
+\end{Changed}
+
+
+
+% \begin{syntax}
+% \cmd{\tabson}\oarg{number} \\
+% \cmd{\tabsoff} \\
+% \end{syntax}
+% \glossary(tabson)%
+% {\cs{tabson}\oarg{number}}%
+% {Set \meta{number} of spaces in a verbatim for a TAB character;
+% default 4.}
+% \glossary(tabsoff)%
+% {\cs{tabsoff}}%
+% {Ignore extra TAB spaces in a verbatim.}
+% \index{verbatim!with tab spaces}
+% The standard \Ie{verbatim} environment ignores any TAB characters; with
+% the class's environment after calling the \cmd{\tabson} declaration
+% the environment will handle TAB characters. By default 4 spaces are used
+% to represent a TAB; the optional \meta{number} argument to the declaration
+% will set the number of spaces for a TAB to be \meta{number}.
+% Some folk like to use 8 spaces for a TAB, in which case they would need
+% to declare \verb?\tabson[8]?. Unremarkably, the declaration \cmd{\tabsoff}
+% switches off TABs. The class default is \cmd{\tabsoff}.
+
+% \begin{syntax}
+% \cmd{\wrappingon} \\
+% \cmd{\wrappingoff} \\
+% \lnc{\verbatimindent} \\
+% \cmd{\verbatimbreakchar} \\
+% \end{syntax}
+% \glossary(wrappingon)%
+% {\cs{wrappingon}}%
+% {Wrap overlong verbatim lines.}
+% \glossary(wrappingoff)%
+% {\cs{wrappingoff}}%
+% {The normal behaviour of not wrapping overlong verbatim lines.}
+% \glossary(verbatimindent)%
+% {\cs{verbatimindent}}%
+% {Indent for wrapped overlong verbatim lines.}
+% \glossary(verbatimbreakchar)%
+% {\cs{verbatimbreakchar}}%
+% {Character indicating a verbatim line is being wrapped.}
+% As noted, whatever is written in a \Ie{verbatim} environment is output
+% just as written, even if lines are too long\index{verbatim!wrap long lines}
+% to fit on the page. The
+% declaration \cmd{\wrappingon} lets the environment break lines so that they
+% do not overflow. The declaration \cmd{\wrappingoff} restores the normal
+% behaviour.
+
+% The following is an example of how a wrapped verbatim line looks. In
+% the source the contents of the \Ie{verbatim} was written as a single line.
+% \wrappingon
+% \begin{verbatim}
+% This is an example of line wrapping in the verbatim environment. It is a single line in the source and the \wrappingon declaration has been used.
+% \end{verbatim}
+% \wrappingoff
+
+% The wrapped portion of verbatim lines are indented from the left margin
+% by the length \lnc{\verbatimindent}. The value can be changed by the usual
+% length changing commands. The end of each line that has been wrapped is marked
+% with the \meta{char} character of the \cmd{\verbatimbreakchar} macro.
+% The class default is \verb?\char`\%?, so that lines are
+% marked with \verb?%?.
+% To put a `/' mark at the end of wrapped lines you can do
+% \begin{lcode}
+% \renewcommand*\verbatimbreakchar{\char'\/}
+% \end{lcode}
+% If you need something more exotic, you need to wrap it in a box:
+% \begin{lcode}
+% \renewcommand*\verbatimbreakchar{\mbox{$\downarrow$}}
+% \end{lcode}
+% which will make `$\downarrow$' the end marker.\footnote{Internally the
+% \cs{discretionary} macro is used to typeset \cs{verbatimbreakchar},
+% so the break char should be what ever \cs{discretionary} can
+% handle.}
+
+% \begin{caveat}
+% \cmd{\wrappingon} combined with \Ie{verbatim*} does not work, the
+% wrapping part is ignored. Currently there are no plans to fix this.
+% \end{caveat}
+
\subsection{Boxed verbatims}
@@ -28290,8 +28332,8 @@ pdflatex memman
\svnidlong
{$Ignore: $}
-{$LastChangedDate: 2023-08-06 23:23:21 +0200 (Sun, 06 Aug 2023) $}
-{$LastChangedRevision: 768 $}
+{$LastChangedDate: 2024-01-25 16:57:21 +0100 (Thu, 25 Jan 2024) $}
+{$LastChangedRevision: 805 $}
{$LastChangedBy: daleif@math.au.dk $}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -29906,185 +29948,6 @@ in text mode you can combine spacing commands as:
which will result in an overall space of 5/18\,em
(from $(4 + 4 - 3)/18$).
-\begin{comment}
-\section{Cross references}\label{sec:xrefthis} \label{sec:xref}
-
- LaTeX supplies the \cmd{\ref} and \cmd{\pageref} commands for cross
-referencing to a label or a page which has a label on it.
-
-\begin{syntax}
-\cmd{\fref}\marg{label} \cmd{\figurerefname} \\
-\cmd{\tref}\marg{label} \cmd{\tablerefname} \\
-\cmd{\pref}\marg{label} \cmd{\pagerefname} \\
-\end{syntax}
-
- The class provides these more particular named references to a figure\index{figure!reference},
-table\index{table!reference} or page\index{page!reference}. For example the default definitions of \cmd{\fref} and
-\cmd{\pref} are
-\begin{lcode}
-\newcommand{\fref}[1]{\figurerefname~\ref{#1}}
-\newcommand{\pref}[1]{\pagerefname~\pageref{#1}}
-\end{lcode}
-and can be used as
-\begin{lcode}
-\ldots footnote parameters are shown in~\fref{fig:fn} on~\pref{fig:fn}.
-\end{lcode}
-which in this document prints as:
-\begin{syntax}
-\ldots footnote parameters are shown in~\fref{fig:fn} on~\pref{fig:fn}. \\
-\end{syntax}
-
-\begin{syntax}
-\cmd{\Pref}\marg{label} \cmd{\partrefname} \\
-\cmd{\Cref}\marg{label} \cmd{\chapterrefname} \\
-\cmd{\Sref}\marg{label} \cmd{\sectionrefname} \\
-\end{syntax}
-
- Also provided are named references to labelled
-Part (\cmd{\Pref}),
-Chapter (\cmd{\Cref}) and
-sectional (\cmd{\Sref}) divisions.
-These are all defined like
-\begin{lcode}
-\newcommand{\Sref}[1]{\sectionrefname\ref{#1}}
-\end{lcode}
-with no tie between the name and the \cmd{\ref}.
-
- In this document
-\begin{lcode}
-`In \Cref{chap:misc} there is a section
-(\Sref{sec:xrefthis}) about cross references.'
-\end{lcode}
-is typeset as:
-\begin{syntax}
-`In \Cref{chap:misc} there is a section
-(\Sref{sec:xrefthis}) about cross references.' \\
-\end{syntax}
-
- It can be useful to refer to parts of a document by name rather than
-number, as in
-\begin{lcode}
-The chapter \textit{\titleref{chap:bringhurst}} describes \ldots
-\end{lcode}
-The chapter \textit{\titleref{chap:bringhurst}} describes \ldots
-
- There are two packages, \Lpack{nameref}~\cite{NAMEREF} and
-\Lpack{titleref}~\cite{TITLEREF},
- that let you refer to things by name instead of number.
-
- Name references were added to the class as a consequence of adding
-a second optional argument to the sectioning commands. I found
-that this broke the \Lpack{nameref} package, and hence the
-\Lpack{hyperref} package as well, so they had to be fixed. The change
-also broke Donald Arseneau's \Lpack{titleref} package, and it turned out
-that \Lpack{nameref} also clobbered \Lpack{titleref}. The class also
-provides titles, like \cmd{\poemtitle}, that are not recognised by
-either of the packages. From my viewpoint the most efficient
-thing to do was to enable the class itself to provide name
-referencing.
-
-\begin{syntax}
-\cmd{\label}\marg{key} \cmd{\ref}\marg{key} \cmd{\pageref}\marg{key} \\
-\cmd{\titleref}\marg{key} \\
-\cmd{\headnamereftrue} \cmd{\headnamereffalse} \\
-\end{syntax}
-The macro \cmd{\titleref} is an addition to the usual set of cross referencing
-commands. Instead of typesetting a number it typesets the title associated
-with the labelled number. This is, of course, only useful if there is an
-associated title, such as from a \cmd{\caption} or \cmd{\section} command.
-As a bad example:
-\begin{lcode}
-Labelling for \verb?\titleref? may be applied to:
-\begin{enumerate}
-\item Chapters, sections, etc. \label{sec:xref:item1}
-...
-\item Items in numbered lists, etc. \ldots \label{sec:xref:item3}
-\end{enumerate}
-Item \ref{sec:xref:item2} in section~\ref{sec:xref} mentions captions
-while item \titleref{sec:xref:item3} in the same section
-\textit{\titleref{sec:xref}} lists other things.
-\end{lcode}
-Labelling for \verb?\titleref? may be applied to:
-\begin{enumerate}
-\item Chapters, sections, etc. \label{sec:xref:item1}
-\item Captions \label{sec:xref:item2}
-\item Legends
-\item Poem titles
-\item Items in numbered lists, etc. \label{sec:xref:item3}
-\end{enumerate}
-Item \ref{sec:xref:item2} in section~\ref{sec:xref} mentions captions
-while item \titleref{sec:xref:item3} in the same section
-\textit{\titleref{sec:xref}} lists other things.
-
-
- As the above example shows, you have to be a little careful in using
-\cmd{\titleref}.
-Generally speaking, \cmd{\titleref}\marg{key} produces the last named
-thing before the \cmd{\label} that defines the \meta{key}.
-
- Chapters, and the lower level sectional divisions, may have three
-different title texts --- the main title, the title in the ToC, and a third
-in the page header. By default (\cmd{\headnamereffalse}) the ToC title
-is produced by \cmd{\titleref}. Following the declaration
-\cmd{\headnamereftrue} the text intended for page headers will be produced.
-
-\Note{} Specifically with the \Lclass{memoir} class,
-do not put a \cmd{\label} command inside an
-argument to a \cmd{\chapter} or \cmd{\section} or \cmd{\caption}, etc.,
-command. Most likely it will either be ignored or referencing it will
-produce incorrect values. This restriction does not apply to the standard
-classes, but in any case I think it is good practice not to embed any
-\cmd{\label} commands.
-
-\begin{syntax}
-\cmd{\currenttitle} \\
-\end{syntax}
- If you just want to refer to the current title you can do so with
-\cmd{\currenttitle}. This acts as though there had been a label associated
-with the title and then \cmd{\titleref} had been used to refer to that label.
-For example:
-\begin{lcode}
-This sentence in the section titled `\currenttitle' is an example of the
-use of the command \verb?\currenttitle?.
-\end{lcode}
-This sentence in the section titled `\currenttitle' is an example of the
-use of the command \verb?\currenttitle?.
-
-
-\begin{syntax}
-\cmd{\theTitleReference}\marg{num}\marg{text} \\
-\end{syntax}
-Both \cmd{\titleref} and \cmd{\currenttitle} use the \cmd{\theTitleReference}
-to typeset the title. This is called with two arguments ---
-the number, \meta{num}, and the text, \meta{text}, of the title. The
-default definition is:
-\begin{lcode}
-\newcommand{\theTitleReference}[2]{#2}
-\end{lcode}
-so that only the \meta{text} argument is printed. You could, for example,
-change the definition to
-\begin{lcode}
-\renewcommand{\theTitleReference}[2]{#1\space \textit{#2}}
-\end{lcode}
-to print the number followed by the title in italics. If you do this, only use
-\cmd{\titleref} for numbered titles, as a printed number for an
-unnumbered title (a) makes no sense, and (b) will in any case be
-incorrect.
-
- The commands \cmd{\titleref}, \cmd{\theTitleReference} and
-\cmd{\currenttitle} are direct equivalents of those in the \Lpack{titleref}
-package~\cite{TITLEREF}.
-
-\begin{syntax}
-\cmd{\namerefon} \cmd{\namerefoff} \\
-\end{syntax}
- Implementing name referencing has had an unfortunate side effect of
-turning some arguments into moving ones; the argument to the \cmd{\legend}
-command is one example. If you don't need name referencing you can turn
-it off by the \cmd{\namerefoff} declaration; the \cmd{\namerefon}
-declaration enables name referencing.
-
-\end{comment}
\section{Adding a period}
@@ -32640,35 +32503,40 @@ than Archibald Smythe University will permit.
\svnidlong
{$Ignore: $}
-{$LastChangedDate: 2023-08-14 12:41:03 +0200 (Mon, 14 Aug 2023) $}
-{$LastChangedRevision: 777 $}
+{$LastChangedDate: 2024-01-26 14:56:06 +0100 (Fri, 26 Jan 2024) $}
+{$LastChangedRevision: 806 $}
{$LastChangedBy: daleif@math.au.dk $}
\chapter{Packages and macros}
The \Mname\ class does not provide for everything that you
-have seen in the manual. I have used some packages that you are very likely
+have seen in the manual. We have used some packages that you are very likely
to have in your \ltx\ distribution, and have supplemented these with some
-additional macros, some of which I will show you.
+additional macros, some of which we will show you.
\section{Packages}
- The packages that I have used that you are likely to have, and if
+ The packages that we have used that you are likely to have, and if
you do not have them please consider getting them,
-are:\fxnote[author=dlf,vadj=0em]{2023/08/10: rewrite}
+are:
\begin{itemize}
-\item \Lpack{etex} lets you take advantage of e\tx's extended support
- for counters and such.
-
- Note that from 2015 and onwards, the allocation of extra
- registers have now been build into the LaTeX kernel. Thus in
- most cases the \Lpack{etex} package is no longer
- necessary. There are how ever extra very special features left
- in \Lpack{etex} that \emph{some} users may need. In that case
- please remember to load \Lpack{etex} by placing
- \verb|\RequirePackage{etex}| \emph{before} \cs{documentclass}!
+% \item \Lpack{etex} lets you take advantage of e\tx's extended support
+% for counters and such.
+
+% Note that from 2015 and onwards, the allocation of extra
+% registers have now been build into the LaTeX kernel. Thus in
+% most cases the \Lpack{etex} package is no longer
+% necessary. There are how ever extra very special features left
+% in \Lpack{etex} that \emph{some} users may need. In that case
+% please remember to load \Lpack{etex} by placing
+% \verb|\RequirePackage{etex}| \emph{before} \cs{documentclass}!
\item \Lpack{url}~\cite{URL} is for typesetting URL's without worrying
about special characters or line breaking.
+
+ Nowadays \Lpack{xurl}~\cite{XURL} is probably better as it allows
+ more preak points.
+
+
% \item \Lpack{fixltx2e}~\cite{FIXLTX2E} eliminates some infelicities
% of the original LaTeX kernel. In particular it maintains the order
% of floats\index{float} on a twocolumn\index{column!double} page
@@ -40407,37 +40275,37 @@ Robert Bringhurst.
\newblock Hartley \& Marks, 2nd edition, 1999.
\newblock ISBN 0--88179--033--8.
-\bibitem[Car14a]{AFTERPAGE}
+\bibitem[Car14]{DELARRAY}
David Carlisle.
-\newblock {\em The afterpage package}, 2014.
+\newblock {\em The delarray package}, 2014.
\newblock \viaCTANurl{/macros/latex/required/tools/}.
-\bibitem[Car14b]{DCOLUMN}
+\bibitem[Car15]{ENUMERATE}
David Carlisle.
-\newblock {\em The dcolumn package}, 2014.
+\newblock {\em The enumerate package}, 2015.
\newblock \viaCTANurl{/macros/latex/required/tools/}.
-\bibitem[Car14c]{DELARRAY}
+\bibitem[Car21]{LONGTABLE}
David Carlisle.
-\newblock {\em The delarray package}, 2014.
+\newblock {\em The longtable package}, 2021.
\newblock \viaCTANurl{/macros/latex/required/tools/}.
-\bibitem[Car15]{ENUMERATE}
+\bibitem[Car23a]{AFTERPAGE}
David Carlisle.
-\newblock {\em The enumerate package}, 2015.
+\newblock {\em The afterpage package}, 2023.
\newblock \viaCTANurl{/macros/latex/required/tools/}.
-\bibitem[Car20]{TABULARX}
+\bibitem[Car23b]{DCOLUMN}
David Carlisle.
-\newblock {\em The tabularx package}, 2020.
+\newblock {\em The dcolumn package}, 2023.
\newblock \viaCTANurl{/macros/latex/required/tools/}.
-\bibitem[Car21]{LONGTABLE}
+\bibitem[Car23c]{TABULARX}
David Carlisle.
-\newblock {\em The longtable package}, 2021.
+\newblock {\em The tabularx package}, 2023.
\newblock \viaCTANurl{/macros/latex/required/tools/}.
-\bibitem[Car23]{textcase}
+\bibitem[Car23d]{textcase}
David Carlisle.
\newblock {\em The textcase package}, 2023.
\newblock The package is marked \emph{obsolete} as of the June 2022 \LaTeX\
@@ -40495,10 +40363,10 @@ Michael~J. Downes.
\bibitem[dP84]{PARVILLE84}
H.~de~Parville.
-\newblock {\em Recreations mathematique: {La Tour d'Hanoi} et la question du
- {Tonkin}}.
+\newblock {\em R{\'e}cr{\'e}ations math{\'e}matiques: {La Tour d'Hanoi} et la
+ question du {Tonkin}}.
\newblock La Nature, 1884.
-\newblock part {I}:285--286, Paris 1884\fixme{data not correct}.
+\newblock Part {I}: 285--286, Paris 1884.
\bibitem[Eij07]{TEXBYTOPIC}
Victor Eijkhout.
@@ -40551,6 +40419,13 @@ Michel Goossens, Frank Mittelbach, Sebastian Rahtz, Denis Roegel, and Herbert
\newblock Addison-Wesley, 2007.
\newblock ISBN 0--321--50892--0.
+\bibitem[GR99]{WCOMPANION}
+Michel Goossens and Sebastian {Rahtz (with Eitan Gurari, Ross Moore and Robert
+ Sutor)}.
+\newblock {\em The LaTeX Web Companion: Integrating TeX, HTML and XML}.
+\newblock Addison-Wesley, 1999.
+\newblock ISBN 0--201--43311--7.
+
\bibitem[Hoe98]{HOENIG98}
Alan Hoenig.
\newblock {\em TeX Unbound: LaTeX and TeX strategies for fonts, graphics, and
@@ -40652,12 +40527,12 @@ Ruari McLean.
\newblock Thames \& Hudson, 1980.
\newblock ISBN 0--500--68022--1.
-\bibitem[{Mic}99]{WCOMPANION}
-{Michel Goossens and Sebastian Rahtz (with Eitan Gurari, Ross Moore and Robert
- Sutor)}.
-\newblock {\em The LaTeX Web Companion: Integrating TeX, HTML and XML}.
-\newblock Addison-Wesley, 1999.
-\newblock ISBN 0--201--43311--7\fixme{author needs fixing}.
+\bibitem[MG04]{COMPANION}
+Frank Mittelbach and Michel {Goossens with Johannes Braams, David Carlisle and
+ Chris Rowley}.
+\newblock {\em The \LaTeX\ Companion}.
+\newblock Addison-Wesley, 2nd edition, 2004.
+\newblock ISBN 0--201--36299--6.
\bibitem[Mit23a]{MULTICOL}
Frank Mittelbach.
@@ -40684,13 +40559,6 @@ Michael~E. Mortenson.
\newblock {\em Geometric Modeling}.
\newblock John Wiley \& Sons, 1985.
-\bibitem[Mw04]{COMPANION}
-Frank Mittelbach and Michel~Goossens {with Johannes Braams, David Carlisle and
- Chris Rowley}.
-\newblock {\em The \LaTeX\ Companion}.
-\newblock Addison-Wesley, 2nd edition, 2004.
-\newblock ISBN 0--201--36299--6.\fixme{with authors}.
-
\bibitem[NG23]{SIDECAP}
Rolf Niespraschk and Hubert G{\"{a}\ss{}}lein.
\newblock {\em The sidecap package}, 2023.
@@ -40797,9 +40665,8 @@ Christina Thiele.
\newblock The treasure chest: Package tours from ctan.
\newblock {\em TUGboat}, 20(1):53--58, 1999.
-\bibitem[TJR17]{CALC}
-Kresten~Krab Thorup, Frank Jensen, and Chris {Rowley\fxnote{should be (and
- Chris Rowley)}}.
+\bibitem[TJ17]{CALC}
+Kresten~Krab Thorup and Frank {Jensen (and Chris Rowley)}.
\newblock {\em The calc package --- Infix notation arithmetic in LaTeX}, 2017.
\newblock \viaCTANurl{/macros/latex/required/tools/}.