summaryrefslogtreecommitdiff
path: root/macros/latex/contrib
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib')
-rw-r--r--macros/latex/contrib/etoc/README.md5
-rw-r--r--macros/latex/contrib/etoc/etoc.dtx66
-rw-r--r--macros/latex/contrib/etoc/etoc.pdfbin978250 -> 979119 bytes
-rw-r--r--macros/latex/contrib/exesheet/exesheet.dtx150
-rw-r--r--macros/latex/contrib/exesheet/exesheet.pdfbin296915 -> 296810 bytes
-rw-r--r--macros/latex/contrib/hvqrurl/Changes1
-rw-r--r--macros/latex/contrib/hvqrurl/doc/hvqrurl.pdfbin105059 -> 107179 bytes
-rw-r--r--macros/latex/contrib/hvqrurl/doc/hvqrurl.tex27
-rw-r--r--macros/latex/contrib/hvqrurl/latex/hvqrurl.sty11
-rw-r--r--macros/latex/contrib/tugboat/NEWS24
-rw-r--r--macros/latex/contrib/tugboat/ltubguid.ltx739
-rw-r--r--macros/latex/contrib/tugboat/ltubguid.pdfbin364822 -> 328791 bytes
-rw-r--r--macros/latex/contrib/tugboat/tugboat-code.pdfbin519269 -> 521480 bytes
-rw-r--r--macros/latex/contrib/tugboat/tugboat.bst160
-rw-r--r--macros/latex/contrib/tugboat/tugboat.dtx201
15 files changed, 808 insertions, 576 deletions
diff --git a/macros/latex/contrib/etoc/README.md b/macros/latex/contrib/etoc/README.md
index b45d22bb03..b44011a15d 100644
--- a/macros/latex/contrib/etoc/README.md
+++ b/macros/latex/contrib/etoc/README.md
@@ -1,6 +1,6 @@
<!-- -->
- Source: etoc.dtx (1.2c)
+ Source: etoc.dtx (1.2d)
Author: Jean-Francois Burnol
Info: Completely customisable TOCs
License: LPPL 1.3c
@@ -78,6 +78,9 @@ etoc.sty, etoc.tex, etoc.pdf, etoc.dvi.
RECENT CHANGES
==============
+- `1.2d 2023/10/29` fix crash (since `1.2`) in presence of
+ `\usepackage[nottoc]{tocbibind}`. Thanks to François Jonca for report.
+
- `1.2c 2023/10/28` compatibility hotfix with `hyperref v7.01c`. Thanks
to Denis Bitouzé for report.
diff --git a/macros/latex/contrib/etoc/etoc.dtx b/macros/latex/contrib/etoc/etoc.dtx
index 6bc8ebe644..2c014e28c4 100644
--- a/macros/latex/contrib/etoc/etoc.dtx
+++ b/macros/latex/contrib/etoc/etoc.dtx
@@ -2,20 +2,20 @@
% N.B.: this dtx file does NOT use \DocInput. It does NOT prefix the user
% manual part with percent characters.
%<*none>
-\def\etocdtxtimestamp {Time-stamp: <04-07-2023 at 22:42:41 CEST>}%
+\def\etocdtxtimestamp {Time-stamp: <29-10-2023 at 10:31:05 CET>}%
%</none>
%<*!readme>
%%
%% Package: etoc
-%% Version: 1.2c
+%% Version: 1.2d
%% License: LPPL 1.3c
%% Copyright (C) 2012-2023 Jean-Francois Burnol
%% <jfbu at free dot fr>
%</!readme>
%<*none>
-\def\etocpkgdate {2023/10/28}
-\def\etocdocdate {2023/10/28}
-\def\etocpkgversion {1.2c}
+\def\etocpkgdate {2023/10/29}
+\def\etocdocdate {2023/10/29}
+\def\etocpkgversion {1.2d}
\def\etocpkgdescription {Completely customisable TOCs (JFB)}
%% Formerly this etoc.dtx also included source for a German translation
%% etoc-DE.pdf. But all additions since April 2015 had been only in English.
@@ -29,7 +29,7 @@
\catcode32=13\catcode`\\=12^^Brelax^^A
^^Bfirstofone{^^Bendgroup^^Bdef^^BetocLicense^^A
{% Package: etoc
-% Version: 1.2c
+% Version: 1.2d
% License: LPPL 1.3c
% Copyright (C) 2012-2023 Jean-Francois Burnol <jfbu at free dot fr>
%
@@ -56,7 +56,7 @@
%<*readme>
<!-- -->
- Source: etoc.dtx (1.2c)
+ Source: etoc.dtx (1.2d)
Author: Jean-Francois Burnol
Info: Completely customisable TOCs
License: LPPL 1.3c
@@ -137,6 +137,9 @@ etoc.sty, etoc.tex, etoc.pdf, etoc.dvi.
RECENT CHANGES
==============
+- `1.2d 2023/10/29` fix crash (since `1.2`) in presence of
+ `\usepackage[nottoc]{tocbibind}`. Thanks to François Jonca for report.
+
- `1.2c 2023/10/28` compatibility hotfix with `hyperref v7.01c`. Thanks
to Denis Bitouzé for report.
@@ -6805,11 +6808,21 @@ should work.
Please inform the author in case of issues: \etoc was from the start designed
to be |100%| compatible with package \ctanpkg{hyperref}.
+\begin{framed}
+ Releases of \etoc prior to \etocrelease{1.2c} copied over some legacy
+ internals of \ctanpkg{hyperref} which got removed there at release
+ |v7.01c| of |2023-10-21|, and this caused \etoc to stop displaying
+ tables of contents. You must use at least \etocrelease{1.2c} to avoid
+ that mishap.
+\end{framed}
+
The macros \csb{etocname}, \csb{etocnumber}, and \csb{etocpage} contain the
\ctanpkg{hyperref} links, if present (note that the \emph{linktoc=all} option of
\ctanpkg{hyperref} tells it to put a link also in the page number corresponding to a
given toc entry). For example, the tables of contents of the present document
-are all fully linked. It doesn't matter whether \etoc or \ctanpkg{hyperref} is loaded
+are all fully linked.
+
+It doesn't matter whether \etoc or \ctanpkg{hyperref} is loaded
first.
\subsection{Compatibility with \ctanpkg{microtype}}
@@ -6968,8 +6981,7 @@ above with some more width for the numbers of subsections.
\subsection{Compatibility with \ctanpkg{tocloft}}\label{subs:tocloft}
-Release \etocrelease{1.07k} added compatibility with package
-\ctanpkg{tocloft}: steps are
+Steps are
taken to prevent the redefinition of |\tableofcontents| done by
\ctanpkg{tocloft} at |\begin{document}|.
%
@@ -6990,10 +7002,8 @@ not possible.
the time of |\begin{document}| and trick \ctanpkg{tocloft} into believing
having been loaded with the |titles| option.
- Sadly, \etocrelease{1.2} and \etocrelease{1.2a} had a bug and loading
- \ctanpkg{tocloft} before \etoc caused \toc to not be the \etoc one. One had
- to use explicitly \csb{etoctableofcontents} (there was no issue with
- \localtoc). The regression was fixed at \etocrelease{1.2b}.
+ Some bugs with \etocrelease{1.2} and \etocrelease{1.2a} were fixed at
+ \etocrelease{1.2b}.
\end{framed}
It is possible to modify midway in the document the macros \csa{l@section},
@@ -7003,9 +7013,10 @@ customizations). It will have no effect on true \etoc TOCs.
\subsection{Compatibility with \ctanpkg{tocbibind}}\label{subs:tocbibind}
-Added at \etocrelease{1.2}. See also \csb{etocsetup} for a discussion of the
- package options which are all related to this (they will achieve the
- \ctanpkg{tocbibind} ``to toc'' features without requiring the package).
+Added at \etocrelease{1.2} (but with a bug fixed only at
+\etocrelease{1.2d}). See also \csb{etocsetup} for a discussion of the
+package options which are all related to this (they will achieve the
+\ctanpkg{tocbibind} ``to toc'' features without requiring the package).
Thanks to Denis Bitouzé for feature request.
@@ -7212,6 +7223,12 @@ version is \texttt{\etocpkgversion}, of \texttt{\etocpkgdate}.
\makeatother
\vskip-\baselineskip
\begin{jfverbatim}
+~1.2d [2023/10/29]^
+
+ Fix crash (present since 1.2) if used with
+ \usepackage[nottoc]{tocbibind} (the faulty code was avoided if also
+ tocloft was used by document). Thanks to François Jonca for report.
+
~1.2c [2023/10/28]^
Compatibility hotfix with hyperref v7.01c; etoc had copied
@@ -8454,7 +8471,7 @@ of real structure in a \LaTeX{} document body).
% \csa{numexpr} or \csa{unexpanded} or maybe others yet that we use).
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}[2003/12/01]
-\ProvidesPackage{etoc}[2023/10/28 v1.2c Completely customisable TOCs (JFB)]
+\ProvidesPackage{etoc}[2023/10/29 v1.2d Completely customisable TOCs (JFB)]
% \end{macrocode}
% Gentle Info message in the log to mention no testing is done of current
% \etoc on old \LaTeX{} installations.
@@ -8467,7 +8484,7 @@ of real structure in a \LaTeX{} document body).
Since 1.1a (2023/01/14), etoc prefers LaTeX at least\MessageBreak
as recent as 2020-10-01, for reasons of the .toc file,\MessageBreak
and used to require it (from 1.1a to 1.2).\MessageBreak
- This etoc (1.2c) does not *require* it, but has not been\MessageBreak
+ This etoc (1.2d) does not *require* it, but has not been\MessageBreak
tested thoroughly on old LaTeX (especially if document\MessageBreak
does not use hyperref) and retrofitting was done only\MessageBreak
on basis of author partial remembrances of old context.\MessageBreak
@@ -11793,6 +11810,10 @@ of real structure in a \LaTeX{} document body).
}%
{% no tocloft
\@ifpackageloaded {tocbibind}
+% \end{macrocode}
+% For some reason this \etocrelease{1.2} code had no |\fi| matching the
+% |\if@dotoctoc|. Fixed at \etocrelease{1.2d}.
+% \begin{macrocode}
{\if@dotoctoc
\def\etocclasstocstyle{%
\etoctocbibindstyle
@@ -11817,9 +11838,10 @@ of real structure in a \LaTeX{} document body).
\else
\let\tableofcontents\etoctableofcontents
\fi
- }%
- {}%
- }%
+ \fi
+ }% end of tocbibind without tocloft at begin document code
+ {}% empty false branch
+ }% end of no tocloft at begin document code
% \end{macrocode}
% Maybe I should check if the options were already set. I will simply
% make the message more generic.
diff --git a/macros/latex/contrib/etoc/etoc.pdf b/macros/latex/contrib/etoc/etoc.pdf
index 8f6b1a892a..e140a7df71 100644
--- a/macros/latex/contrib/etoc/etoc.pdf
+++ b/macros/latex/contrib/etoc/etoc.pdf
Binary files differ
diff --git a/macros/latex/contrib/exesheet/exesheet.dtx b/macros/latex/contrib/exesheet/exesheet.dtx
index 443bef2991..7f57f4195e 100644
--- a/macros/latex/contrib/exesheet/exesheet.dtx
+++ b/macros/latex/contrib/exesheet/exesheet.dtx
@@ -23,7 +23,7 @@
%<class>\ProvidesClass{exesheet}
%<package>\ProvidesPackage{exesheet}
%<*class|package>
-[2023/10/25 v2.3 .dtx exesheet file]
+[2023/10/28 v2.4 .dtx exesheet file]
%</class|package>
%<*driver>
\documentclass{ltxdoc}
@@ -152,13 +152,20 @@
% \changes{v2.3}{2023/10/24}{
% - new implementation of marking scheme checking:
% checking is done in points or totalpoints instead of exercise command,
-% - correct ref macro for tablenuma using ref implementation in tasks,
+% - correct ref macro for tablenuma using ref option in tasks,
% available since 2020/08/19
% - new commands question* and answer* for executing code when
% questions are displayed but not answers, or the contrary
% - using basic languages (with lower case first letter) instead of aliases
% in translations commands}
%
+% \changes{v2.4}{2013/10/28}{
+% - a small mistake in the documentation about the example of the tablenuma environment
+% is now corrected
+% - other small changes in the documentation
+% - lack of percent symbols at end of lines in the exe@check macro causes an unwanted
+% space in points macro}
+%
% \GetFileInfo{exesheet.dtx}
%
% \maketitle
@@ -197,8 +204,8 @@
% or individual corrections per exercise,
% per part (subpart of exercise), per question, per sub-question.
%
-% Finally this package enables to display a detailed marking scheme in the margin,
-% with optional explanations or remarks,
+% Finally \textsf{exesheet} enables to display a detailed marking scheme
+% in the margin, with optional explanations or remarks,
% and offering consistency control.
%
% Many settings can be customized, and various options are available
@@ -251,7 +258,7 @@
% \footnote{Currently, translation is integrated into the package
% for the following languages: French, German, Spanish, Italian, and Portuguese.}
% depending on the language that is loaded (via \textsf{babel} or \textsf{polyglossia}).
-% You can redefine it using |\renewcommand|.
+% You can alter it by modifying |\exercisename|.
% A better approach is to use macros from the \textsf{translations}
% package by Clemens Niederberger (which allows dynamic language switching), \eg
% |\DeclareTranslation{swedish}{exesheet-exercise}{\"Ovning}}|.
@@ -304,7 +311,7 @@
% \bigskip
%
% \pagebreak
-% The following macros manage formatting in the same manner as for |\exercise|.
+% The following macros allow customization in the same manner as for |\exercise|.
%
% \medskip
% \DescribeMacro{\thesubpart}
@@ -350,11 +357,11 @@
% which is defined as follows: |\newcommand\annexstyle{\MakeUppercase}|.
% This command may be redefined according to your preferences.
%
-% \subsection{Exercise titles in the table of contents} \label{toc}
+% \subsection{Titles in the table of contents} \label{toc}
% \DescribeMacro{[exetoc=\meta{bool}]}
% By default, the titles \textbf{\exercisename}, \textbf{\subpartname}
-% and \textbf{\annexname} are included in the table of contents if there is any
-% (or in the PDF file's summary when the \textsf{hyperref} package is utilized).
+% and \textbf{\annexname} are included in the table of contents, if there is any,
+% or in the PDF file's summary when the \textsf{hyperref} package is utilized.
% To prevent this, you can set the package option \texttt{exetoc=false}
% (with the default being \texttt{true}).
% However, note that optional title arguments will always be ignored in the table of contents.
@@ -378,9 +385,9 @@
% The abbreviation \textbf{\exname} can be modified by
% redefining |\exname| or with macros from the \textsf{translations} package.
% The |\exlabel| macro combines |\exname| with a period then the exercise number
-% (given by the \texttt{exercise} counter),
+% (given by the same \texttt{exercise} counter),
% while |\exsepmark| typesets a long dash.
-% You can alter these characteristics by redefining these commands.
+% These characteristics can be altered by redefining these commands.
%
% \medskip
% \DescribeMacro{\exe*}
@@ -427,25 +434,25 @@
% \eg \texttt{\bs begin\{enumerate\}[A.]},
% or globally through the redefinition of \texttt{\bs labelenumi}
% or \texttt{\bs labelenumii} commands.}.
-% You can change global label font formatting using the syntax
+% Label font formatting can be changed globally using
% |\setlist[enumerate]{font=...}|
% (called \emph{after} |\begin{document}|).
%
% Lists created with the \texttt{itemize} environment retain their default
% configuration
% \footnote{However, the \texttt{french} option of the \textsf{babel} package
-% changes the behavior of \texttt{itemize} lists and employs long dashes
+% changes the appearance of \texttt{itemize} lists and employs long dashes
% as labels for each list level.
-% This behavior can cause issues when mathematical content follows the dash
+% This can cause issues when mathematical content follows the dash
% symbol, as it might be mistaken for the minus sign.
% Thus, with the option \texttt{setlist=true}, the default \LaTeX{}
% \texttt{itemize} list style is
-% reinstated. The \texttt{\bs frenchsetup} command (from the
-% \textsf{babel-french} package) can achieve several other settings.}.
+% reinstated with \texttt{\bs frenchsetup\{StandardLists=true\}}.}.
+% ^^A The \texttt{\bs frenchsetup} command can also achieve other settings.}.
%
% \medskip
% \DescribeMacro{[setlist=\meta{bool}]}
-% The package option |setlist=false| prevents changes to enumeration and itemize lists
+% The package option |setlist=false| prevents changes to enumeration lists
% and reverts to the default \LaTeX{} settings
% (the default value is \texttt{true}).
%
@@ -521,14 +528,15 @@
% \item $\ds l(x) = \int_{\frac{1}{x}}^{x}\frac{1}{\ln t}\, \mathrm{d}t$.
% \end{tablenum1}
%
-% ^^A \smallskip
+% \smallskip
% For \texttt{tablenuma}, labels are letters, a, b, c, \ldots, enclosed in parentheses.
%
% \DescribeMacro{\labelenumone}\DescribeMacro{\labelenuma}
% You can change the labels by redefining the macros |\labelenumone|
% (for \texttt{tablenum1}) and |\labelenuma| (for \texttt{tablenuma}),
-% using the \texttt{task} counter,
-% \eg |\renewcommand\labelenuma{\Alph{task}.}| yields the labels \textbf{A.}, \textbf{B.}, \ldots
+% using the \texttt{task} counter:
+% \eg |\renewcommand\labelenuma{\Alph{task}.}| yields the labels
+% \textbf{A.}, \textbf{B.}, \ldots
%
% \smallskip
% If the \textsf{exesheet} package is invoked with the option \texttt{setlist=false},
@@ -544,18 +552,18 @@
% When you intend to utilize \texttt{tablenuma} (or \texttt{tablitem})
% immediately after inserting the |\item| command
% within an \texttt{enumerate} environment,
-% a vertical misplacement occurs, as demonstrated in the following example:
-% \begin{enumerate}
-% \item
-% \begin{tablenuma}(3) \item One \item Two \item Three \end{tablenuma}
-% \end{enumerate}
-%
+% a vertical misplacement may occur.
+% ^^A as demonstrated in the following example:
+% ^^A \begin{enumerate}
+% ^^A \item
+% ^^A \begin{tablenuma}(3) \item One \item Two \item Three \end{tablenuma}
+% ^^A \end{enumerate}
% To achieve proper vertical spacing in such cases, we offer
% the starred environments \texttt{tablenuma*} and \texttt{tablitem*},
% with corrected alignment as shown below:
%
-% \noindent\psframe(-0.25,0.05)(12.75,-0.9)
-% \psline[linewidth=0.1pt,linecolor=green,linestyle=dashed](0, -0.57)(10.5, -0.57)
+% \noindent\psframe(-0.25,0.05)(12.75,-0.97)
+% \psline[linewidth=0.1pt,linecolor=green,linestyle=dashed](0, -0.63)(10.5, -0.63)
% \begin{enumerate}
% \item
% \begin{tablenuma*}(3) \item One \item Two \item Three \end{tablenuma*}
@@ -568,8 +576,8 @@
%
% \subsection{Items aligned by column: \texttt{colsenum}, \texttt{colsitem}}
% \DescribeEnv{colsenum}
-% To achieve numbering of items by column, the
-% \texttt{colsenum} environment is available:
+% To achieve numbering of items by column, we provide the
+% \texttt{colsenum} environment:
% |\begin{colsenum}|\oarg{opt}\marg{cols}.
% The mandatory parameter is the number of columns,
% and the optional parameter will be passed to the underlying \texttt{enumerate} environment,
@@ -591,18 +599,17 @@
%
% \medskip
% \DescribeEnv{colsenum*}
-% We will observe that, on each line, items are not necessarily properly
+% It may be observed that, on each line, items are not necessarily properly
% aligned, which can result in ungraceful effects.
% On the other hand, the \texttt{colsenum} environment doesn't attempt to align columns
% from the bottom by adjusting the vertical spacing between items.
-% If we desire this alignment
-% (which is the default behavior in \textsf{multicol}), we can use the
+% If you desire this alignment
+% (which is the default behavior in \textsf{multicol}), you can use the
% \texttt{colsenum*} environment (with the same syntax as \texttt{colsenum}).
% Here's what we obtain with \texttt{colsenum*}:
%
-% \pagebreak
% \exercise
-% \psframe(-0.25,1.3)(12.75,-2.65)
+% \psframe(-0.25,1.3)(12.75,-2.67)
% Calculate the derivative of the following functions:
% \begin{colsenum*}{3}
% \item $\ds f(x) = \frac{1-x^2}{\mathrm{e}^x +\mathrm{e}^{-x}}$,
@@ -639,7 +646,8 @@
% \label{output}
%
% \DescribeEnv{questions} \DescribeEnv{answers}
-% The package offers two environments, \texttt{questions} and \texttt{answers},
+% The \textsf{exesheet} package offers two environments,
+% \texttt{questions} and \texttt{answers},
% which allow you to optionally show or hide questions and answers within exercises.
%
% \bigskip
@@ -686,7 +694,7 @@
% \end{questions}
% \begin{answers}
% \begin{enumerate}
-% \item Yes, the \textsf{exesheet} package is indeed useful for teachers.
+% \item The \textsf{exesheet} package is useful for teachers.
% \item There are numerous other packages that handle exercises and
% provide the capability to create questions and solutions separately.
% For instance the
@@ -800,8 +808,8 @@
%
% \section{Marking scheme commands}
%
-% The \textsf{exesheet} package enables the display of a detailed marking
-% scheme in the margins, along with optional comments and explanations about answers.
+% The \textsf{exesheet} package provides several commands to display a marking
+% scheme, with optional comments and explanations about answers in the margins.
%
% \subsection{The \texttt{\bs points} command}\label{points}
% \DescribeMacro{\points}
@@ -818,11 +826,11 @@
% Try to read this document to the end without drinking tea and you get five points.
%
% \bigskip
-% When only the correction is displayed in an exercise, the |\points| macro doesn't
+% When only the answers are displayed in an exercise, the |\points| macro doesn't
% show the points.
-% Printing answers along with the point scale
-% will be discussed
-% in section \ref{totalpoints}, which includes another |\totalpoints| macro.
+% Further, we provide another macro, which displays points
+% in \texttt{questions} like here, and differently in \texttt{answers} environments
+% (see section \ref{totalpoints}).
%
% \bigskip
% \DescribeMacro{\pointsname} \DescribeMacro{\pointname}
@@ -1098,13 +1106,14 @@
% \DescribeMacro{\totalpoints}
% The |\totalpoints|\marg{num} macro serves as a replacement for
% |\points| when using a comprehensive marking scheme.
-% When the scale isn't visible,
-% it functions similarly to |\points|, and when the scale is shown,
+% When the scale is not displayed,
+% it functions similarly to |\points| (visible in questions but not in answers),
+% and when the scale is shown,
% it's akin to |\totalexe|.
% For instance, in exercise \ref{totalexe}, we could have used |\totalpoints|
-% instead of |\totalexe|. In this case,
-% when the detailed marking scheme is not displayed, the total points would be presented
-% similarly to exercise \ref{points} rather than being absent.
+% instead of |\totalexe|. Thus,
+% if the detailed marking scheme is not displayed, the total points would be presented
+% similarly to exercise \ref{points}.
%
% \subsection{Marking scheme consistency checking}\label{scale}
%
@@ -1127,7 +1136,7 @@
% Both comma notation (\eg 4,5) and decimal point format (\eg 4.5)
% may be accepted, depending on your chosen language.
% The control is made at the beginning of the subsequent exercise,
-% inside |\points|, |\totalexe| or |totalpoints| macros.
+% inside the |\points|, |\totalexe| or |\totalpoints| macros.
% No deep checking will be processed at this level if no points are displayed
% for the questions inside the exercise (with \texttt{display=none} option).
%
@@ -1190,7 +1199,7 @@
% can be changed dynamically, even within the document,
% while the others are applicable in the preamble exclusively.
% Dynamic options are processed with each call, whereas the others are processed once,
-% at |\begin{document}|.
+% at the beginning of the document.
% \hypertarget{correct}{}
%
% \bigskip
@@ -1271,7 +1280,7 @@
%
% A distinct case is to mention with \texttt{setlist} when utilized in conjunction with
% \textsf{babel-french}.
-% In this instance, this option is processed immediately and subsequently disabled
+% In this instance, this option is processed immediately
% (further clarification follows below).
%
% \begin{macrocode}
@@ -1577,7 +1586,7 @@
% These modifications are undone here to revert to the default
% \LaTeX\ \texttt{itemize} lists, including labels and spaces.
% We have created the |\standardfrenchlists| command, which should be invoked within the
-% |\AtBeginDocument| command, depending on whether
+% |\AtBeginDocument| command or immediately, depending on whether
% \textsf{exesheet} is loaded before or after \textsf{babel}.
% \begin{macrocode}
\newcommand\standardfrenchlists{%
@@ -1849,8 +1858,8 @@
}{\ifthenelse{\boolean{exesheet@answers}}{}{\endcomment}}
% \end{macrocode}
-% In the \texttt{answers} environment, when placing |\correctionstyle|
-% before |\subsubsection| (as in the case of |\typeset@correctionname|),
+% When placing |\correctionstyle| before |\subsubsection|
+% in the \texttt{answers} environment (as in the case of |\typeset@correctionname|),
% the preceding vertical space may become too wide.
% \end{environment}
%
@@ -2066,7 +2075,7 @@
% \end{macrocode}
% \end{macro}
% For a two-sided document, the \textsf{geometry} package does not correctly set
-% the width of the margin paragraph by default; it's too wide.
+% the default width of the margin paragraph; it's too wide.
% Therefore, we provide an explicit setting here, which is
% useful when \texttt{marginwidth=unset}. Otherwise, the setting is
% handled by the \texttt{marginwidth} key option.
@@ -2151,7 +2160,8 @@
% These lengths are compared against |\exe@total| and |\sheet@total|.
% The |\exe@check| macro validates the calculations of the previous exercise
% when triggered by |\points|, |\totalexe| or |\totalpoints| macros.
-% It is also invoked within |\exs@process@checkpts| at the document's end
+% Percent symbols at end of lines are necessary to prevent unwanted spaces.
+% |\exe@check| is also invoked within |\exs@process@checkpts| at the document's end
% for a final check on the last exercise.
% \begin{macrocode}
\newlength{\sheet@total}
@@ -2176,23 +2186,23 @@
\endgroup
}
-\def\exe@check{
- \ifthenelse{\lengthtest{\sum@pts = 0pt}}{
+\def\exe@check{%
+ \ifthenelse{\lengthtest{\sum@pts = 0pt}}{%
% do not check, no points or first exercise begins
- \ifthenelse{\equal{\exe@currentlabel}{none}}{}{
+ \ifthenelse{\equal{\exe@currentlabel}{none}}{}{%
\PackageWarningNoLine{exesheet}{\exe@currentlabel:
- \the\exe@total}}
- }{
- \ifthenelse{\lengthtest{\exe@total = \sum@pts}}{
+ \the\exe@total}}%
+ }{%
+ \ifthenelse{\lengthtest{\exe@total = \sum@pts}}{%
\PackageWarningNoLine{exesheet}{\exe@currentlabel:
- Sum of points \the\exe@total\space is valid}
- }{
+ Sum of points \the\exe@total\space is valid}%
+ }{%
\PackageWarningNoLine{exesheet}{\exe@currentlabel:
Sum of points is \the\sum@pts\space
- instead of \the\exe@total}
- \setboolean{scale@valid}{false}
- }
- }
+ instead of \the\exe@total}%
+ \setboolean{scale@valid}{false}%
+ }%
+ }%
}
\def\exs@process@checkpts{
@@ -2276,8 +2286,8 @@
\newcommand*{\points}[1]{%
\ifthenelse{\boolean{exesheet@questions}}{\hfill
\pointsstyle{#1~%
- \ifthenelse{\lengthtest{#1pt < 2pt}}{\pointname}{\pointsname}}
- \check@points{#1}
+ \ifthenelse{\lengthtest{#1pt < 2pt}}{\pointname}{\pointsname}}%
+ \check@points{#1}%
}{}
}
diff --git a/macros/latex/contrib/exesheet/exesheet.pdf b/macros/latex/contrib/exesheet/exesheet.pdf
index 3eae349ae8..ee19226c2c 100644
--- a/macros/latex/contrib/exesheet/exesheet.pdf
+++ b/macros/latex/contrib/exesheet/exesheet.pdf
Binary files differ
diff --git a/macros/latex/contrib/hvqrurl/Changes b/macros/latex/contrib/hvqrurl/Changes
index e56ba4a168..d9bf68a6b3 100644
--- a/macros/latex/contrib/hvqrurl/Changes
+++ b/macros/latex/contrib/hvqrurl/Changes
@@ -1,4 +1,5 @@
hvqrurl.sty:
+0.03 2023-10-29 - fix for # in an url
0.02 2021-05-18 - added optional argument qrreverse to the set
the qr code in the opposite margin
0.01a 2019-12-01 - fixes to the documentation
diff --git a/macros/latex/contrib/hvqrurl/doc/hvqrurl.pdf b/macros/latex/contrib/hvqrurl/doc/hvqrurl.pdf
index c2d85e3b27..69e8e5fa77 100644
--- a/macros/latex/contrib/hvqrurl/doc/hvqrurl.pdf
+++ b/macros/latex/contrib/hvqrurl/doc/hvqrurl.pdf
Binary files differ
diff --git a/macros/latex/contrib/hvqrurl/doc/hvqrurl.tex b/macros/latex/contrib/hvqrurl/doc/hvqrurl.tex
index 6f9d96953f..c3639f6609 100644
--- a/macros/latex/contrib/hvqrurl/doc/hvqrurl.tex
+++ b/macros/latex/contrib/hvqrurl/doc/hvqrurl.tex
@@ -1,4 +1,4 @@
-%% $Id: hvqrurl.tex 1123 2019-12-01 09:16:34Z herbert $
+%% $Id: hvqrurl.tex 790 2023-10-29 15:33:17Z herbert $
\listfiles
\errorcontextlines=100
\documentclass[twoside,usegeometry]{scrartcl}
@@ -11,7 +11,8 @@
\usepackage[showframe=false]{geometry}
\usepackage{listings}
-\usepackage{makeidx}\makeindex
+\usepackage[imakeidx]{xindex}
+\makeindex
%
\lstset{%
language=[LaTeX]TeX,%
@@ -30,7 +31,6 @@
\usepackage{ragged2e}
\usepackage{hvqrurl}
-\usepackage{xindex}
\usepackage{hvdoctools}
@@ -89,12 +89,12 @@ has no meaning.
\subsection{Color of the QR code}
Without using \LPack{hyperref} the default color is \Lkeyval{black}. It can be changed by
-the optional argument \Lkeyword{qrcolor}. The package \LPack{xcolor}\hvqrurl*[qrlink=nolink,qrcolor=red!40!white]{http://mirror.ctan.org/pkg/xcolor}
+the optional argument \Lkeyword{qrcolor}. The package \LPack{xcolor}\hvqrurl*[qrlink=nolink,qrcolor=red!40!white]{https://mirror.ctan.org/pkg/xcolor}
is loaded by default,
the reason why an extended color definition is possible. For this example we used
\begin{lstlisting}
-The package xcolor\hvqrurl*[qrcolor=red!40!white]{http://mirror.ctan.org/pkg/xcolor}
+The package xcolor\hvqrurl*[qrcolor=red!40!white]{https://mirror.ctan.org/pkg/xcolor}
is loaded by default, ...
\end{lstlisting}
@@ -102,13 +102,16 @@ The package xcolor\hvqrurl*[qrcolor=red!40!white]{http://mirror.ctan.org/pkg/xco
By default the baseline of the QR code is nearly at the same height as the baseline of the textline.
However, when changing the size of the QR code it may be nessesary to move up or down the QR code.
The default value of \Lkeyword{qradjust} is \verb|-1.5\normalbaselineskip|. Setting the value
-to 0pt the QR code \hvqrurl*[qrlink=nolink,qradjust=0pt]{http://ctan.org/} is moved down which is the default
+to 0pt the QR code
+\hvqrurl[qrlink=nolink,qradjust=0pt]{https://latex.texnik.de/tutorials/packages/#header-footer}
+is moved down which is the default
setting without a vertical adjustment.
\begin{lstlisting}
The default value of qradjust is \verb|-1.5\normalbaselineskip|. Setting the value
-to 0pt the QR code \hvqrurl*[qradjust=0pt]{http://ctan.org/} is moved down which is the default
-setting without a vertical adjustment.
+to 0pt the QR code
+\hvqrurl[qradjust=0pt]{https://latex.texnik.de/tutorials/packages/#header-footer}
+is moved down which is the default setting without a vertical adjustment.
\end{lstlisting}
@@ -147,14 +150,14 @@ controlled internally by the package.
\subsection{Inner or outer margin for the QR code}
By default the QR code is set in the right (oneside document) or outer margin (twoside) of the
-document. This one (\hvqrurl{http://hvoss.org}) is at the default position.
+document. This one (\hvqrurl{https://hvoss.org}) is at the default position.
With the optional argument \Lkeyword{qrreverse} it can be placed in the left or inner margin.
-This one (\hvqrurl[qrreverse]{http://latex.texnik.de}) is in the other margin.
+This one (\hvqrurl[qrreverse]{https://latex.texnik.de}) is in the other margin.
\begin{lstlisting}
-This one (\hvqrurl{http://hvoss.org}) is at the default position.
+This one (\hvqrurl{https://hvoss.org}) is at the default position.
With the optional argument \Lkeyword{qrreverse} it can be placed in the left or inner margin.
-This one (\hvqrurl[qrreverse]{http://latex.texnik.de}) is in the other margin.
+This one (\hvqrurl[qrreverse]{https://latex.texnik.de}) is in the other margin.
\end{lstlisting}
diff --git a/macros/latex/contrib/hvqrurl/latex/hvqrurl.sty b/macros/latex/contrib/hvqrurl/latex/hvqrurl.sty
index 64bc0ead4a..fa73a30854 100644
--- a/macros/latex/contrib/hvqrurl/latex/hvqrurl.sty
+++ b/macros/latex/contrib/hvqrurl/latex/hvqrurl.sty
@@ -1,13 +1,13 @@
-%% $Id: hvqrurl.sty 1123 2019-12-01 09:16:34Z herbert $
+%% $Id: hvqrurl.sty 790 2023-10-29 15:33:17Z herbert $
%%
%% This file is distributed under the terms of the LaTeX Project Public
%% License from CTAN archives in directory macros/latex/base/lppl.txt.
%% Either version 1.3 or, at your option, any later version.
%%
-% Copyright 2019,21 Herbert Voss hvoss@tug.org
+% Copyright 2019,21,23 Herbert Voss hvoss@tug.org
%%
\ProvidesPackage{hvqrurl}[%
- 2021/05/18 v.0.02 (Herbert Voss) Supports qr images into the margin (hv)]
+ 2023/10/29 v.0.03 (Herbert Voss) Supports qr images into the margin (hv)]
%
\NeedsTeXFormat{LaTeX2e}
\RequirePackage{url}
@@ -40,7 +40,10 @@
\ifx\relax#1\relax \else\hvqrset{#1}\fi
\expandafter\qrset\expandafter{\qr@url@qrlink,height=\qr@url@qrheight,level=\qr@url@qrlevel}%
\ifhv@qrreverse\reversemarginpar\fi
- \if@tempswa\url{#2}\fi
+ \if@tempswa
+ \edef\hv@foo{\detokenize\expandafter{#2}}%
+ \url{\hv@foo}
+ \fi
\edef\reserved@a{\noexpand\marginnote{\noexpand\color{qr@url@qrcolor}\noexpand\qrcode{%
\detokenize\expandafter{#2}}}[\qr@url@qradjust]}%
\reserved@a
diff --git a/macros/latex/contrib/tugboat/NEWS b/macros/latex/contrib/tugboat/NEWS
index 53621cccdc..2ee5014884 100644
--- a/macros/latex/contrib/tugboat/NEWS
+++ b/macros/latex/contrib/tugboat/NEWS
@@ -1,6 +1,26 @@
-$Id: NEWS 490 2023-07-03 22:27:49Z karl $
+$Id: NEWS 533 2023-10-28 22:40:31Z karl $
This file records noteworthy changes. This file is public domain.
+-----------------
+2.31 (2023-10-28):
+ltugboat.cls:
+- input our hyphenation exceptions (ushyphex.tex) if available.
+- \dblfloatpagefraction and similar parameters set so figures don't go
+ to a float page so soon, and reduce \abovecaptionskip.
+- new abbreviation \LMTX.
+- new abbreviations \pdfTeX and \pdfLaTeX, with italic correction after the f.
+- new generic commands \tbcode and \tbcodebreak for package names, class
+ names, file names, environment variables, etc. (Just outputs in typewriter.)
+
+tugboat.bst:
+- in month field, recognize numbers 01..12, with or without leading zero.
+- for @misc, output organization field if present.
+- support "eprints" (https://arxiv.org/abs/).
+
+Substantial rearrangement and updating of documentation.
+
+-----------------
+2.30 (2023-07-03):
ltugboat.cls:
- print page numbers with preceding ? in draft mode, including in references,
by redefining \thepage.
@@ -12,7 +32,7 @@ tugboat.bst:
ltubguid documentation:
- mention preferred placement of captions, namely below figures
-but above tables and listings.
+ but above tables and listings.
-----------------
2.29 (2023-03-08):
diff --git a/macros/latex/contrib/tugboat/ltubguid.ltx b/macros/latex/contrib/tugboat/ltubguid.ltx
index 088a8e19af..4f06882574 100644
--- a/macros/latex/contrib/tugboat/ltubguid.ltx
+++ b/macros/latex/contrib/tugboat/ltubguid.ltx
@@ -1,4 +1,4 @@
-% $Id: ltubguid.ltx 487 2023-06-22 22:39:59Z karl $
+% $Id: ltubguid.ltx 529 2023-10-27 16:32:42Z karl $
% ltubguid.ltx - documentation for ltugboat classes.
%
% Copyright 1994-2023 TeX Users Group.
@@ -37,26 +37,26 @@
@Misc{pkg:fancyvrb,
author = {Timothy Van Zandt and others},
- title = {The {\textsf{fancyvrb}} package},
+ title = {The {\tbcode{fancyvrb}} package},
url = {ctan.org/pkg/fancyvrb},
}
@Misc{pkg:listings,
author = {Carsten Heinz and others},
- title = {The {\textsf{listings}} package},
+ title = {The {\tbcode{listings}} package},
url = {ctan.org/pkg/listings},
}
@Misc{Arseneau:url:1996,
author = {Donald Arseneau},
- title = {The {\textsf{url}} package},
+ title = {The {\tbcode{url}} package},
url = {ctan.org/pkg/url},
urlnewline = 1,
}
@Misc{Rahtz:hyperref:1997,
author = {Sebastian Rahtz and Heiko Oberdiek and others},
- title = {The {\textsf{hyperref}} package},
+ title = {The {\tbcode{hyperref}} package},
url = {ctan.org/pkg/hyperref},
}
@@ -70,14 +70,14 @@
@Misc{Schoepf:verbatim:1996,
author = {Rainer Sch{\"{o}}pf},
- title = {The {\textsf{verbatim}} package},
+ title = {The {\tbcode{verbatim}} package},
url = {ctan.org/pkg/verbatim},
urlnewline = 1,
}
@Misc{Vieth:mflogo:1995,
author = {Ulrik Vieth},
- title = {The {\textsf{mflogo}} package},
+ title = {The {\tbcode{mflogo}} package},
url = {ctan.org/pkg/mflogo},
urlnewline = 1,
}
@@ -132,16 +132,19 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
-\documentclass[final,letterpaper]{ltugboat}
-\usepackage{graphics} % just so letterpaper takes effect
+\documentclass[letterpaper]{ltugboat}
+\usepackage{graphics} % so letterpaper takes effect
\usepackage{microtype}
\usepackage{ctandir}
+\usepackage[hidelinks,pdfa]{hyperref}
\IfFileExists{booktabs.sty}%
{\usepackage{booktabs}}%
{\let\midrule\hline}
%
\vbadness=10000 % imperfectly broken pages are ok
\overfullrule=4pt % want to see
+% omit word "draft:"
+\def\rtitlenexttopage{\ifPrelimDraft \textsl{\small \Now}\fi}
%
% define CTAN addresses using the commands of the |ctandir| package
\CTANdirectory{packages}{macros/latex/required}
@@ -150,11 +153,11 @@
% ***** Commands provided by this paper *****
%
% Typeset the name of an environment, class, package, option, program
-\providecommand\envname[1]{\textsf{#1}}
-\providecommand\clsname[1]{\textsf{#1}}
-\providecommand\pkgname[1]{\textsf{#1}}
-\providecommand\optname[1]{\textsf{#1}}
-\providecommand\progname[1]{\textsf{#1}}
+\providecommand\envname[1]{\tbcode{#1}}
+\providecommand\clsname[1]{\tbcode{#1}}
+\providecommand\pkgname[1]{\tbcode{#1}}
+\providecommand\optname[1]{\tbcode{#1}}
+\providecommand\progname[1]{\tbcode{#1}}
%
% A list of options for a package/class
\newenvironment{optlist}{\begin{description}%
@@ -187,43 +190,48 @@
\@tempa%
}
\makeatother
+\def\url{\tburl} % use our url macros
%
%%%%%%%%%%%%%%%%
\begin{document}
%%%%%%%%%%%%%%%%
%
\title{The \LaTeXe\ \TUB{} macros}
-\author{Robin Fairbairns \& TUGboat editors}
+\author{TUGboat editors}
\EDITORnoaddress
\netaddress{tugboat@tug.org}
\personalURL{tug.org/TUGboat}
\maketitle
+{\hyphenpenalty=10000\raggedright \tableofcontents}
+\count0=1
\section{Introduction}
This is the documentation for the \LaTeXe\ macros to be used by \TUB{}
-authors. The macros represent a development of the earlier
+authors. The macros represent a development of the earlier
\clsname{ltugboat} and \clsname{ltugproc} styles that were written for
-use with \LaTeX~2.09; major contributors have been Robin Fairbairns,
-Sebastian Rahtz, Michel Goossens, Nico Poppelier and Johannes Braams.
-Many others have been involved, including Barbara Beeton, Karl Berry,
-Mimi Burbank, and the \LaTeX\ team.
+use with \LaTeX~2.09; the main original author was Robin Fairbairns,
+with Sebastian Rahtz, Michel Goossens, Nico Poppelier and Johannes
+Braams. Many others have been involved in the years since, including
+Barbara Beeton, Karl Berry, Mimi Burbank, and the \LaTeX\ team.
-\section{Availability}
+\subsection{Availability}
-The \TUB\ web pages are at:\\\centerline{\url{https://tug.org/TUGboat}}
+The \TUB\ web pages are at:\par\smallskip
+\centerline{\url{https://tug.org/TUGboat}}
+\par\smallskip\noindent
They provide \textbf{an article template}, information for authors and
reviewers, and the complete run of all published \TUB\ issues, among
other things.
-The macros are released for general use, and are distributed via \CTAN{}
-(directory \CTANref{tub-latex}) in the usual \LaTeX{} way as files
-\path|tugboat.dtx| and \path|tugboat.ins|. When the\,\verb|.ins| file
-is processed by \LaTeX{}, the files \path|ltugboat.cls| and
-\path|ltugbib.bst| (for use with articles) and \path|ltugcomn.sty| (a
-cooking pot of perhaps-useful macros, for documentation, etc.)\ are
-produced. (\path|ltugproc.cls| is also produced for compatibility, but
-is no longer used for proceedings or anything else.)
+The macros are distributed via \CTAN{}
+(\url{https://ctan.org/pkg/tugboat}) in the usual \LaTeX{} way as files
+\path|tugboat.dtx| and \path|tugboat.ins|. When the \verb|.ins| file is
+processed by \LaTeX{}, the files \path|ltugboat.cls| and
+\path|ltugcomn.sty| (a melange of perhaps-useful macros, for
+documentation, etc.)\ are produced. (For compatibility,
+\path|ltugproc.cls| is also produced, but is no longer used for
+proceedings or anything else.)
The\,\verb|.dtx| file may itself be processed by \LaTeX{} to
produce a formatted (somewhat `literate') source listing for those
@@ -236,23 +244,33 @@ The basic idea is to start your \LaTeX\ document with
articles. This uses the file \path|ltugboat.cls| as usual.
Each paper, therefore, is written as a document that may stand on its
-own. It starts with a \cs{documentclass} command, and its body is
-enclosed in a \envname{document} environment. There are some options to
+own. It starts with a \cs{documentclass} command, and its body is
+enclosed in a \envname{document} environment. There are some options to
the document class, described in the next section, but ordinarily the
-author needn't bother with them. The defaults are
-designed for creating proof copies of papers.
+author needn't bother with them. The defaults are designed for creating
+proof copies of papers.
The proof output differs from the final production output with respect
to page numbers and other material. The changes required for final
-production are the responsibility of the \TUB{} editors, and the author
-need not be concerned with them.
+production are the responsibility of the \TUB{} editors; authors will
+see the final version in proof.
-\section{Class options: The \clsname{ltugboat} class}
+In general, we have sought simply to keep to the spirit of \LaTeX\ in
+the commands provided by the \TUB\ class (\verb|ltugboat|). On the
+whole, the new \clsname{ltugboat} macros define \LaTeX{} commands and
+environments, or modify the definitions of \LaTeX{} standard commands.
+For those interested, section~\ref{sec:equiv} lists equivalences between
+macros defined by the `plain' package \cite{Whitney:TB10-3-378} and
+those defined by the new package.
+
+\subsection{Class options for \clsname{ltugboat}}
\label{sec:boat-opts}
The \clsname{ltugboat} class accepts many of the options of the
-\clsname{article} class (it suppresses the font-size selection
-and one/two-side options).
+\clsname{article} class (it suppresses the font-size selection and
+one/two-side options). Normally there is no need to use any document
+option. They are listed here for completeness.
+
\begin{optlist}
\item[draft] Set up for a draft copy of a paper (this is the default
setting\Dash the author need not explicitly set it): page numbering
@@ -261,10 +279,10 @@ and one/two-side options).
of the reference; see section~\ref{sec:biblio}.
\item[final] Set up for the final copy of a paper: page numbering to
come from elsewhere, no cropmarks.
-\item[harvardcite] Specify Harvard-style citation (not
+\item[harvardcite] Specify Harvard-style citation. Not
recommended in general; see section~\ref{sec:biblio}.
-\item[noextralabel] Don't use the extra label-distinguishing mark in
- the body of the reference; see section~\ref{sec:biblio}.
+\item[noextralabel] Don't use the extra mark for distinguishing labels in
+ the body of the reference; see section~\ref{sec:biblio-harvard}.
\item[nonumber] Sections are not numbered; section heading
layout is to be as in the `plain' \pkgname{tugboat} styles.
\item[numbersec] Sections, subsections and subsubsections are to be
@@ -277,110 +295,45 @@ and one/two-side options).
\item[runningfull] Information in both header and footer (default).
\item[runningminimal] Information in header only.
\item[runningoff] Information in neither header nor footer.
+\item[secondcolstart] Start the article in the second column.
\end{optlist}
-\noindent Again, normally there is no need to use any document options.
-They are listed here for completeness.
-
-\section{Command syntax}
-\label{sec:syntax}
-
-In general, we have sought simply to keep to the spirit of \LaTeX\ in
-the commands provided by the \TUB\ class (\verb|ltugboat|).
-
-In the few cases that it has proved possible to emulate (what seems to
-a staid old \LaTeX{} programmer, such as the original author here) the gay
-abandon of the syntax of the `plain' \pkgname{tugboat} styles
-\cite{Whitney:TB10-3-378}, we have done so. Nevertheless, on the whole,
-the new \clsname{ltugboat} macros define \LaTeX{} commands and
-environments, or modify the definitions of \LaTeX{} `standard'
-commands. Section~\ref{sec:equiv} lists equivalences between macros
-defined by the `plain' package and those defined by the new package.
-
-\section{Divisions of the paper}
-\label{sec:divs-paper}
-
-Papers in \TUB{} may be subdivided in the normal way of a \LaTeX{}
-article (the classes are defined in terms of \LaTeX{}'s
-\clsname{article} class). Thus the author may use \cs{section},
-\cs{subsection}, \dots, \cs{paragraph} commands (but \cs{part} and
-\cs{subparagraph} from \clsname{article} are suppressed, and
-\cs{chapter}, which doesn't even appear in the parent class, receives
-the same treatment).
-
-Authors may note that the style of ordinary issues of \TUB{} makes
-no distinction between the titles of the divisions; the visual style
-relies on the section numbers to indicate where the divisions lie in
-the hierarchy. If you use \cs{paragraph}, consider ending the paragraph
-label with a period; sometimes it is helpful, sometimes not.
-
-For references to numbered sections, our style is to always use the word
-`Section' in the text, e.g.,\\
-\verb|Section~\ref{sec:whatever}|\\
-without worrying about whether it is technically a sub(sub)section.
-It's also ok to use the section sign~\S{}, if that suits the material
-better.
-
-Reference can also be made to the `title' of divisions of the paper,
-whether they are numbered or not. The \cs{nameref} command (which uses
-the technique developed for the \textsf{hyperref} package
-\cite{Rahtz:hyperref:1997}) permits such references; for example, the
-present section was introduced by:
-\begin{verbatim}[\small]
-\section{Divisions of the paper}
-\label{sec:divs-paper}
-\end{verbatim}
-and the command \verb|\nameref{sec:divs-paper}| produces
-`\nameref{sec:divs-paper}'. However, as you can see here, reusing the
-literal text of section titles often results in awkward results. We
-recommend numbered references in general.
-
-\subsection{Abstracts}
-
-The \clsname{ltugboat} class provides two environments for abstracts,
-\envname{abstract} and \envname{longabstract}. The \envname{abstract}
-environment simply typesets its body as an un-numbered section whose
-title is `Abstract'. The \envname{longabstract} environment typesets its
-body in small text, and separates the abstract from the rest of the
-paper with a decorative line; this is rarely used.
+\subsection{Use of packages}
-Please write an abstract, however short.
-
-\subsection{Appendices}
-
-A paper may have appendices, which can be expressed in exactly the same
-way as they would be in the \LaTeX{} article class (confusing as that
-may be):
+Being a \TeX\ journal, authors may use both standard and non-standard
+external packages for their articles. The overriding criterion is that
+articles need to be processable on the \TUB{} production computers
+(running current \TeX\ Live). A sensible mechanism for submitting
+personal packages is by use of the \envname{filecontents} environment.
+It's also fine to submit manuscript source with additional packages in a
+zip or other archive.
-\begin{verbatim}[\small]
-\appendix
-\section{This is appendix A}
-...
-\section{This is appendix B}
-\end{verbatim}
-Which will produce `section' headings similar to:
-\begin{quote}
-\textbf{A\quad This is appendix A}
-\end{quote}
+In general, packages currently on \CTAN, and known to work with
+\emph{current} \LaTeX{} are likely to be fine. In particular, \TUB\ is
+happy to accept papers using packages that are supported by members of
+the \LaTeX\ team.
-\TUB{} articles may have a small extension to this format using an
-\texttt{appendix} environment:
+\tug{} has a policy that macro packages described in \TUB{} should be
+available for readers to use. Since typing macros from printed sources
+is tedious, authors of publicly available packages are urged to submit
+their macros to \CTAN{}. If a package is only available under restricted
+terms, authors are requested to make this fact clear when first
+submitting an article to the editor.
-\begin{verbatim}[\small]
-\begin{appendix}
-\section{This is the first one}
-...
-\end{appendix}
-\end{verbatim}
-which will produce `section' headings similar to:
-\begin{quote}
-\textbf{Appendix A\quad This is the first one}
-\end{quote}
+The \texttt{ltugboat} class loads the package \path|mflogo.sty|
+\cite{Vieth:mflogo:1995} for typesetting the \MF\ logo. If this package
+is not present by some mischance, \texttt{ltugboat} will emulate it.
-In both cases, the subsections are numbered as normal (i.e., as
-`A.\ensuremath{n}' in normal \TUB{} papers):
+Although not necessarily recommended in all cases, many additional
+packages are commonly used. To mention a few:
+\begin{description}
+\item[microtype] can help reduce overfull boxes and improve appearance
+(\verb|\usepackage{microtype}|);
+\item[hyperref] supports live and internal hyperlinks, outlines, and
+much more\\(\verb|\usepackage[hidelinks,pdfa]{hyperref}|).
+\end{description}
-\section{Titles, addresses and so on}
+\subsection{Titles, addresses and so on}
The title and author(s) of a paper are quoted using commands that are
familiar (in syntax, at least) to most \LaTeX{} users; the \cs{title}
@@ -443,7 +396,7 @@ given at \tug'95 (abbreviated):
The class files will take care of arranging author names and addresses
between the \cs{maketitle} and (possibly) \cs{makesignature} commands.
-\subsection{Compilation articles}
+\subsubsection{Compilation articles}
Compilation articles are written as a set of contributed parts under the
general editorship of the author(s) of the article. The author of the
@@ -470,7 +423,186 @@ closes the group. The general scheme looks like:
\makesignature ...
\end{verbatim}
-\section{Verbatim text}
+\subsection{Divisions of the paper}
+\label{sec:divs-paper}
+
+Papers in \TUB{} may be subdivided in the normal way of a \LaTeX{}
+article (the classes are defined in terms of \LaTeX{}'s
+\clsname{article} class). Thus the author may use \cs{section},
+\cs{subsection}, \dots, \cs{paragraph} commands (but \cs{part} and
+\cs{subparagraph} from \clsname{article} are suppressed, and
+\cs{chapter}, which does not even appear in the parent class, receives
+the same treatment).
+
+Authors may note that the style of ordinary issues of \TUB{} makes
+no distinction between the titles of the divisions; the visual style
+relies on the section numbers to indicate where the divisions lie in
+the hierarchy. If you use \cs{paragraph}, consider ending the paragraph
+label with a period; sometimes it is helpful, sometimes not.
+
+For references to numbered sections, our style is to always use the word
+`Section' in the text, e.g.,\\
+\verb|Section~\ref{sec:whatever}|\\
+without worrying about whether it is technically a sub(sub)section.
+It's also ok to use the section sign~\S{}, if that suits the material
+better.
+
+Reference can also be made to the `title' of divisions of the paper,
+whether they are numbered or not. The \cs{nameref} command (which uses
+the technique developed for the \tbcode{hyperref} package
+\cite{Rahtz:hyperref:1997}) permits such references; for example, the
+present section was introduced by:
+\begin{verbatim}[\small]
+\section{Divisions of the paper}
+\label{sec:divs-paper}
+\end{verbatim}
+and the command \verb|\nameref{sec:divs-paper}| produces
+`\nameref{sec:divs-paper}'. However, as you can see here, reusing the
+literal text of section titles often results in awkward results. We
+recommend numbered references in general.
+
+\subsubsection{Abstracts}
+
+The \clsname{ltugboat} class provides two environments for abstracts.
+The \envname{abstract} environment simply typesets its body as an
+unnumbered section whose title is `Abstract'. The \envname{longabstract}
+environment typesets its body in small text, and separates the abstract
+from the rest of the paper with a decorative line; this is rarely used.
+
+Please write an abstract, however short.
+
+\subsubsection{Appendices}
+
+A paper may have appendices, which can be expressed in exactly the same
+way as they would be in the \LaTeX{} article class (confusing as that
+may be):
+
+\begin{verbatim}[\small]
+\appendix
+\section{This is appendix A}
+...
+\section{This is appendix B}
+\end{verbatim}
+Which will produce `section' headings similar to:
+\begin{quote}
+\textbf{A\quad This is appendix A}
+\end{quote}
+
+\TUB{} articles may have a small extension to this format using an
+\texttt{appendix} environment:
+
+\begin{verbatim}[\small]
+\begin{appendix}
+\section{This is the first one}
+...
+\end{appendix}
+\end{verbatim}
+which will produce `section' headings similar to:
+\begin{quote}
+\textbf{Appendix A\quad This is the first one}
+\end{quote}
+
+In both cases, the subsections are numbered as normal (i.e., as
+`A.\ensuremath{n}' in normal \TUB{} papers):
+
+\section{Floating inserts}
+
+The classes do not make any change to \LaTeX{}'s built-in provision for
+floating inserts, so that authors should write figures and tables as usual,
+
+The default is for floats to be the width of the column. To make a float
+which is the width of the whole page, use \envname{figure*} and
+\envname{table*}.
+
+Regarding caption placement, \TUB's convention is to put captions for
+figures below the figure, but captions for tables and listings above the
+table\slash listing. Please follow this convention unless there is a
+specific reason not to.
+
+As a reminder, \cs{label} commands should always follow the
+\cs{caption}.
+
+\section{Special-purpose typesetting}
+
+The classes define a rather large set of commands for special-purpose
+typesetting.
+
+\subsection{Assorted simple markup}
+
+A short list of commonly-needed special typesetting commands follows; a
+larger set of such commands is defined in the classes. Feel free to peruse.
+
+\begin{cmdlist}\raggedright
+\item[\cs{cmd}] Typeset a control sequence name:\\
+ \verb|\cs{fred}| produces \cs{fred}.
+
+\item[\Dash] Typeset an em-dash, ignoring preceding and following space,
+ surrounded by thin spaces, only breakable after the dash; this
+ is our preferred method of specifying an em-dash in running text, over
+ \texttt{---} or (especially) the Unicode character(s).
+
+\item[\meta{var}] Typeset meta-syntactic text:\\
+ \verb|\meta{fred}| produces \meta{fred}.
+
+\item[\tbcode{text}] Literal text, such as class names, package names,
+filenames, environment variables, etc. The text is typeset in typewriter
+and is not breakable.
+
+\item[\tbcodebreak{text}] Like \cs{tbcode}, but breakable as with urls,
+e.g., at periods. Still not hyphenated.
+
+\item[\tubbraced{text}] Typeset typewriter text in typewriter
+ braces: \verb|\tubbraced{fred}| produces \tubbraced{fred}.
+\end{cmdlist}
+For commands to typeset urls, see section~\ref{sec:urls}.
+
+\subsection{Acronyms and logos}
+
+The classes provide macros that produce `correct' representations of a
+large number of acronyms and logos; a small representative selection is
+shown in figure~\ref{fig:acro-logo}. The sample documents at
+\url{tug.org/TUGboat/location.html} have a more complete list,
+and of course the class sources are the ultimate reference.
+\begin{figure}[htbp!]
+ \begin{center}
+ \begin{tabular}{@{}ll@{}}
+ \small\textsl{\tbcode{Macro}}&\small\textsl{\tbcode{Output}}\\
+ \midrule
+ \verb|\ConTeXt| & \ConTeXt \\
+ \verb|\Cplusplus| & \Cplusplus \\
+ \verb|\CTAN| & \CTAN \\
+ \verb|\eTeX| & \eTeX\\
+ \verb|\FAQ| & \FAQ \\
+ \verb|\HTML| & \HTML \\
+ \verb|\ISBN| & \ISBN \\
+ \verb|\KOMAScript| & \KOMAScript \\
+ \verb|\LaTeXe| & \LaTeXe \\
+ \verb|\macOS| & \macOS \\
+ \verb|\MathML| & \MathML \\
+ \verb|\MF| & \MF \\
+ \verb|\PDF| & \PDF \\
+ \verb|\SGML| & \SGML \\
+ \verb|\TUB| & \TUB \\
+ \verb|\TUG| & \TUG \\
+ \verb|\tug| & \tug \\
+ \verb|\XML| & \XML \\
+ \end{tabular}
+ \end{center}
+ \caption{A few of the provided acronyms and logos}
+ \label{fig:acro-logo}
+\end{figure}
+
+Authors are especially urged to note the \cs{acro} command, which is
+defined in the classes. The visual appearance of all-caps sequences
+among normal text is rather unpleasing in Computer Modern,
+unfortunately. Therefore, the \cs{acro} command typesets its argument
+one point size smaller than the surrounding text: compare `\acro{DANTE}'
+(\verb|\acro{DANTE}|) with `DANTE'\@. Many of the provided macros merely
+generate calls to \cs{acro}; two examples, \cs{CTAN} and \cs{tug} of the
+list in figure~\ref{fig:acro-logo} have already been used in the present
+paper.
+
+\subsection{Verbatim text}
\label{sec:verbatim}
For inline verbatim text, authors should ordinarily employ the
@@ -532,20 +664,19 @@ Authors may wish to use a more featureful verbatim package, such as
\pkgname{listings}~\cite{pkg:listings} or
\pkgname{fancyvrb}~\cite{pkg:fancyvrb}. This is ok; it just means the
\TUB\ optional-argument feature is not available. On the other hand,
-please do not use the \pkgname{minted} package if possible; it is much
-harder to customize and correct at the \TeX\ level, and the shell escape
+please do not use the \pkgname{minted} package if possible; it is harder
+to customize and correct at the \TeX\ level, and the shell escape
requirement is troublesome. In any case, we will almost always wish to
-print code listings in simple black, not colored or even grayscaled.
+print code listings in straight black, not colored or even grayscaled.
-If you use the \pkgname{listings} package, please specify:
+If you use the \pkgname{listings} package, please set:
\begin{verbatim}[\small]
-\lstset{columns=fullflexible, keepspaces=true,
- commentstyle=\slshape,
- basicstyle=\ttfamily\small}
-\lstdefinestyle{inline}
- {basicstyle=\ttfamily\normalsize}
+\lstset{columns=fullflexible,
+ keepspaces=true,
+ commentstyle=\slshape,
+ basicstyle=\ttfamily
+ \lst@ifdisplaystyle\small\fi,}
\end{verbatim}
-
Explanations:
\begin{itemize}
\item \texttt{columns=fullflexible}:
@@ -563,200 +694,92 @@ We prefer slanted to Computer Modern typewriter italic.
Using regular upright typewriter for comments is fine too.
\item \texttt{basicstyle=...}:
-We usually prefer \cs{small} for displayed verbatim; when using
-\texttt{listings}, it is necessary to reset inline verbatim to the
-normal text size.
+We usually prefer \cs{small} for displayed verbatim, but not inline
+verbatim, hence the conditional.
\end{itemize}
-\section{Floating inserts}
-
-The classes do not make any change to \LaTeX{}'s built-in provision for
-floating inserts, so that authors may write figures and tables as usual,
-
-The default is for floats to be the width of the column. To make a float
-which is the width of the whole page, use \envname{figure*} and
-\envname{table*}.
-
-Regarding caption placement, \TUB's convention is to put captions for
-figures beneath the figure, but captions for tables and listings above
-the table\slash listing. Please follow this convention unless there is a
-specific reason not to. As a reminder, \cs{label} commands should always
-follow the \cs{caption}.
-
-\section{Special-purpose typesetting}
-
-The classes define a rather large set of commands for special-purpose
-typesetting. Some of them are available for historical reasons only,
-and many are only useful in somewhat restricted circumstances. For
-this reason, the present paper only outlines a representative, small
-set of the macros.
-
-\subsection{Acronyms and logos}
-
-The classes provide macros that produce `correct' representations of a
-large number of acronyms and logos; a small representative selection is
-shown in figure~\ref{fig:acro-logo}. The sample documents at
-\url{tug.org/TUGboat/location.html} have a more complete list,
-and of course the class sources are the ultimate reference.
-\begin{figure}[htbp!]
- \begin{center}
- \begin{tabular}{@{}ll@{}}
- \small\textsl{\textsf{Macro}}&\small\textsl{\textsf{Output}}\\
- \midrule
- \verb|\ConTeXt| & \ConTeXt \\
- \verb|\Cplusplus| & \Cplusplus \\
- \verb|\CTAN| & \CTAN \\
- \verb|\eTeX| & \eTeX\\
- \verb|\FAQ| & \FAQ \\
- \verb|\HTML| & \HTML \\
- \verb|\ISBN| & \ISBN \\
- \verb|\KOMAScript| & \KOMAScript \\
- \verb|\LaTeXe| & \LaTeXe \\
- \verb|\MacOSX| & \MacOSX \\
- \verb|\MathML| & \MathML \\
- \verb|\MF| & \MF \\
- \verb|\OMEGA| & \OMEGA \\
- \verb|\PDF| & \PDF \\
- \verb|\SGML| & \SGML \\
- \verb|\TUB| & \TUB \\
- \verb|\TUG| & \TUG \\
- \verb|\tug| & \tug \\
- \verb|\XML| & \XML \\
- \end{tabular}
- \end{center}
- \caption{A few of the provided acronyms and logos}
- \label{fig:acro-logo}
-\end{figure}
-
-Authors are especially urged to note the \cs{acro} command, which is
-defined in the classes. The visual appearance of all-caps sequences
-among normal text is rather unpleasing in Computer Modern,
-unfortunately. Therefore, the \cs{acro} command typesets its argument
-one point size smaller than the surrounding text: compare `\acro{DANTE}'
-(\verb|\acro{DANTE}|) with `DANTE'\@. Many of the provided macros merely
-generate calls to \cs{acro}; two examples, \cs{CTAN} and \cs{tug} of the
-list in figure~\ref{fig:acro-logo} have already been used in the present
-paper.
-
-\subsection{Assorted other markup}
-
-A small list of special typesetting commands follows; a larger set of
-such commands is defined in the classes.
-\begin{cmdlist}\raggedright
-\item[\Dash] Typeset an em-dash, ignoring preceding and following space,
- surrounded by thin spaces, only breakable \emph{after} the dash; this
- is the preferred method of specifying a dash in running text.
-\item[\cs{cmd}] Typeset a control sequence name:\\
- \verb|\cs{fred}| produces \cs{fred}.
-\item[\env{environ}] Typeset the command to begin an environment:
- \verb|\env{fred}| produces \env{fred}.
-\item[\meta{var}] Typeset meta-syntactic text:\\
- \verb|\meta{fred}| produces \meta{fred}.
-\item[\tubbraced{text}] Typeset typewriter text in typewriter
- braces: \verb|\tubbraced{fred}| produces \tubbraced{fred}.
-\item[\nth{n}] Typeset an ordinal number; \verb|\nth{1}| is
- set as \nth{1}, \verb|\nth{27}| is set as \nth{27}, and so on.
-%\item[\sfrac{num}{denom}] Typeset a fraction to match running text;
-% for example \verb|\sfrac{3}{4}| is set as \sfrac{3}{4}\,.
-\end{cmdlist}
-For commands to typeset urls, see section~\ref{sec:urls}.
-
-\section{Use of packages}
-
-Being a \TeX\ journal, authors may use both standard and non-standard
-external packages for their articles. The overriding criterion is that
-articles need to be processable on the \TUB{} production computers
-(running current \TeX\ Live). A sensible mechanism for submitting
-personal packages is by use of the \envname{filecontents} environment.
-It's also fine to submit manuscript source with additional packages in a
-zip or other archive.
-
-In general, packages currently on \CTAN, and known to work with
-\emph{current} \LaTeX{} are likely to be fine. In particular,
-the team is happy to accept papers using packages that are supported by
-members of the \LaTeX\ team.\footnote{%
- Those in the \LaTeX{} base distribution, or one of those in the
- \CTANref{packages} sub-tree on \CTAN.}
-
-\tug{} has a policy that macro packages described in \TUB{} should be
-available for readers to use. Since typing macros from printed sources
-is a tedious undertaking, authors of publicly available packages are
-urged to submit their macros to \CTAN{}. If a package is only available
-under restricted terms, authors are requested to make this fact clear
-when first submitting an article to the editor.
-
-The \texttt{ltugboat} class loads the package \path|mflogo.sty|
-\cite{Vieth:mflogo:1995} for typesetting the \MF\ logo. (If this package
-is not present by some mischance, \texttt{ltugboat} will emulate its
-important feature.)
-
-An additional canonically-recommended package is \path|url.sty|
-\cite{Arseneau:url:1996}, for typesetting filenames, email addresses,
-urls, etc.; it is being used throughout the present paper (not least in
-the bibliography), either on its own or via \texttt{hyperref}.
-
-Although not necessarily recommended in all cases, many additional
-packages are commonly used. To mention a few:
-\begin{description}
-\item[microtype] can help reduce overfull boxes and improve appearance;
-\item[hyperref] supports live and internal hyperlinks, outlines, and
-many other features.
-\end{description}
-
-\section{Typesetting urls}
+\subsection{Typesetting urls}
\label{sec:urls}
-As mentioned above, please load either \texttt{url} or (preferably)
-\texttt{hyperref} so that reasonable line breaking of urls can happen.
-
-Furthermore, for the printed (visible) \TUB\ page, nowadays we typically
-prefer to omit a leading \texttt{http://} or \texttt{https://}. But for
-the link to actually work in the output \PDF\ or \HTML, the protocol is
-required (or it appears to be a local filesystem path). Therefore the
-\texttt{ltugboat} class provides (as of version 2.28, released
-January~2023) the command \cs{tburl} for this. Related commands
-\cs{tbsurl} for \texttt{https} and \cs{tbhurl} for \texttt{http} were
-defined in version~2.23 (March~2020).\footnote{All these commands are
-wrappers around \cs{hyper@linkurl}, and are due to Ulrike Fischer.
-\url{https://github.com/latex3/hyperref/issues/125}\raggedright}
+In short:
+
+\begin{enumerate}
+\item Please load either the \texttt{url} or (preferably) the
+\texttt{hyperref} package so that reasonable line breaking of urls can
+happen.
+
+\item Add \verb|\def\url{\tburl}| to your preamble and use \cs{url} in your
+document as usual. (It seems too intrusive for the \TUB\ classes to
+redefine something as fragile and widespread as \cs{url}.)
+\end{enumerate}
+The rest of this section is more details about the above.
+
+The main reason for preferring the above is that for the printed
+(visible) \TUB\ page, nowadays we typically prefer to omit a leading
+\texttt{https://}. But for the link to actually work in the output \PDF\
+or \HTML, the protocol is required (else the \PDF\ reader thinks it is
+a local filesystem path). Therefore the \texttt{ltugboat} class provides
+(as of 2023) the command \cs{tburl} for this.\footnote{This and related
+commands are wrappers around \cs{hyper@linkurl}.
+Thanks to Ulrike Fischer for doing the real work:
+\tburl{https://github.com/latex3/hyperref/issues/125}\raggedright}
For example, the commands \verb|\tburl{tug.org}| and
\verb|\tburl{https://tug.org}| both typeset the text `\texttt{tug.org}'
(with the usual url line breaks possible) as a link to
\url{https://tug.org}.
-Similarly, \verb|\tburl{http://example.org}| typesets the text
-`\texttt{example.org}' as a link to \url{http://example.org}, for the
-(unusual nowadays) case when \url{http} is required.
+Since so few web sites do not support https,
+\verb|\tburl{http://example.org}| typesets the full url as text
+`\texttt{http://example.org}' as a link to itself. If it's desirable to
+elide the http://, the variant \cs{tbhurl} can be used.
-As shown, the correct protocol can be explicitly specified, and will be
-stripped for display.
+Thus, as shown, the correct protocol can be explicitly specified, and
+will be stripped for display. Just use \cs{tburl}.
-\cs{tburl} and related add the protocol and make live links if
-\texttt{hyperref} is loaded. Without \texttt{hyperref}, they are merely
-synonyms for \cs{url}. This is ok, and we still request that the
-protocol not be included; if live links are not being produced in the
-output, the printed url without the protocol suffices. (When a user
-copies/pastes url text into a browser, it will normally work.)
+In short, \cs{tburl} and related make live links and omit the protocol
+if \pkgname{hyperref} is loaded. We highly recommend this.
+
+Without \texttt{hyperref}, they are merely synonyms for \cs{url}. This
+is ok, and we still request that the protocol not be included; if live
+links are not being produced in the output, the printed url without the
+protocol suffices. (When a user copies/pastes url text into a browser,
+it will normally work.)
In order to keep using \cs{url} in a document body, we suggest
\verb|\def\url{\tburl}|.
-The shortcut macro \cs{tburlfootnote} makes a ragged-right footnote
-using \cs{tburl} command. We recognize that when writing url references,
-sometimes the best option is to put urls in footnotes. However, when
-it's sensible, we prefer to have them as either parentheticals in the
-main text or in bibliography entries, to ease page breaking.
-
For \texttt{ftp}, \texttt{rsync}, and other protocols, it is best to
always include them explicitly and use \cs{url}:\\
\verb|\url{ftp://tug.org}|,\\ \verb|\url{rsync://tug.org}|, etc.
-\subsection{Url shortcuts}
+Finally, sometimes it is best to allow line breaks at hyphens in urls.
+We've found that this is not confusing in practice. To enable this and
+\pkgname{hyperref} at the same time, it's necessary to load
+\pkgname{url} explicitly and enable the \tbcode{hyphens} option:
+
+\begin{verbatim}
+\usepackage[hyphens]{url}
+\usepackage[hidelinks,pdfa]{hyperref}
+\end{verbatim}
+
+\subsubsection{Url footnotes}
+\label{sec:urlfootnotes}
+
+The shortcut macro \cs{tburlfootnote} makes a ragged-right footnote
+using the \cs{tburl} command. We recognize that when writing url
+references, sometimes the best option is to put urls in footnotes.
+
+However, when it's sensible, we prefer to have urls as either
+parentheticals in the main text or in bibliography entries, to ease page
+breaking and reading flow. It is ideal to minimize\slash avoid footnotes
+in general.
+
+\subsubsection{Url shortcuts}
\label{sec:urlshortcuts}
-Another aspect of urls: the \tug\ web server supports a shortcut url
+A different aspect of urls: the \tug\ web server supports a shortcut url
mechanism, \url{tug.org/l/}\meta{ident}, where \meta{ident} can be any
tag, similar to \url{tinyurl.com} and similar sites. The idea is that
\url{tug.org} shortcuts can be used in \TUB\ articles needing to link to
@@ -767,7 +790,7 @@ will disappear.
The only way to create a \url{tug.org/l/} shortcut is by request, which
we are happy to receive.
-\section{Bibliography}
+\section{Bibliographies}
\label{sec:biblio}
In short: our basic recommendation for handling bibliographies is to use
@@ -795,42 +818,47 @@ small but useful features:
\begin{itemize}
\item It is based on \pkgname{abbrvurl.bst} (see \url{ctan.org/pkg/urlbst}),
-\item and thus supports \textsf{url} and \textsf{doi} fields, among others.
-Please use \textsf{url} instead of putting urls in the
-\textsf{note} field, where possible. Also, please don't bother to
+\item and thus supports \tbcode{url} and \tbcode{doi} fields, among others.
+Please use \tbcode{url} instead of putting urls in the
+\tbcode{note} field, where possible. Also, please don't bother to
include ``access date'' information for \TUB; we find that extraneous.
-\item The \textsf{url} field is ignored if either the \textsf{howpublished} or
-\textsf{doi} field is present. In practice we observe that people put
-the same information in all those fields, and we don't want to typeset
-redundant information.
+\item The \tbcode{url} field is ignored if either the \tbcode{doi} or
+\tbcode{howpublished} field is present. In practice we observe that
+people put the same information in all those fields, and we don't want
+to typeset redundant information.
-\item Does even more abbreviating than \textsf{abbrv}, such as
+\item Does even more abbreviating than \tbcode{abbrv}, such as
printing only two author names (plus ``et~al.'')\ if there are more than
four authors (thanks to Mico Loretan and Oren Patashnik).
-\item New field \textsf{bookauthor} for the \textsf{@incollection} and
-\textsf{@inproceedings} allows for citing a part, written by author~X,
+\item New field \tbcode{bookauthor} for the \tbcode{@incollection} and
+\tbcode{@inproceedings} allows for citing a part, written by author~X,
of a publication written by author~Y, and not just edited by~Y.
-\item For the \textsf{@misc} entry type, \textsf{editor} is accepted as
-well as \textsf{author}.
+\item For the \tbcode{@misc} entry type, \tbcode{editor} is accepted as
+well as \tbcode{author}.
-\item Defines entry types \textsf{@online} and \textsf{@software} as
-aliases for \textsf{@misc}.
+\item Defines entry types \tbcode{@online} and \tbcode{@software} as
+aliases for \tbcode{@misc}.
-\item Defines an \textsf{@ctan} entry type to reference packages on
+\item Defines an \tbcode{@ctan} entry type to reference packages on
\CTAN, following the fields output by the \pkgname{ctanbib} script (in
the package of the same name, \url{ctan.org/pkg/ctanbib}).
\item For completeness only: \verb|tugboat.bst| provides several
-fields intended to be used by the editors: \textsf{journaltie} to output
-a tie instead of space after the \textsf{journal} value,
-\textsf{monthtie} for the same after \textsf{month},
-\textsf{newpage} to force a page break after the current item,
-\textsf{nowarning} to omit empty field warnings, \textsf{prebibitem} to
-output material before \cs{bibitem} (e.g., a section heading), and
-\textsf{urlnewline} to force a line break before the \textsf{url} value.
+fields intended to be used by the editors:
+\begin{description}\raggedright
+\item[\sf journaltie] to output
+ a tie instead of space after the \tbcode{journal} value,
+\item[\sf monthtie] for the same after \tbcode{month},
+\item[\sf newpage] to force a page break after the current item,
+\item[\sf nowarning] to omit empty field warnings, \tbcode{prebibitem} to
+ output material before \cs{bibitem} (e.g., a section heading),
+\item[\sf pagesnodashify] to avoid autoconverting \texttt{-} to
+ \texttt{--} in the \texttt{pages} field,
+\item[\sf urlnewline] to force a line break before the \tbcode{url} value.
+\end{description}
As editors, we've found that these presentation tweaks can be desirable
for the final typeset output. Authors need not worry about them.
@@ -838,14 +866,14 @@ for the final typeset output. Authors need not worry about them.
By the way, we recommending using commas to terminate all fields in
\texttt{.bib} files, including the last one in an entry. That makes for
-one less thing to worry about when changing fields around in the source.
+one less thing to worry about when changing fields in the source.
Bibliographies can be difficult to typeset at the best of times.
\LaTeX{} sets \cs{sloppy} when typesetting the bibliography, but this
typically leads to unpleasant output with \TUB's narrow columns. The
author can specify typesetting parameters using the command
\cs{SetBibJustification}. The classes remain \cs{sloppy} by default, but
-the author may (for example) say:
+this can be changed with (for example),
\begin{verbatim}
\SetBibJustification{\raggedright}
\end{verbatim}
@@ -859,11 +887,8 @@ as reference `[2]' and \texttt{bar} as `[1]', use \verb|\cite{bar,foo}|.
One more note on references: for \TUB\ issues, please use the format
\textsl{volno\,:\,issno}, e.g., ``\TUB\ 32:1'' for volume~32, number~1.
-By the way, if anyone would like to volunteer to implement a \BibLaTeX\
-style with the same features and output as our \BibTeX\ style, we would
-be grateful.
-
-\subsection{Non-recommended bibliography facilities}
+\subsection*{Non-recommended bibliography facilities}
+\label{sec:biblio-harvard}
The preceding gives the bibliography recommendations for current \TUB\
articles. If, for whatever reason, you do not wish to follow those
@@ -892,7 +917,7 @@ date.
\begin{center}
\leavevmode
\begin{tabular}{@{}ll@{}}% @{ $\rightarrow$ } between columns removed
- \small\textsf{\textsl{Macro}} &\small\textsf{\textsl{Output}}\\
+ \small Macro & Output\\
\midrule
\verb|\cite{key}| & (Tom, Dick, and Harry, 1990)\\
\verb|\citeA{key}| & (Tom, Dick, and Harry)\\
@@ -925,8 +950,7 @@ use it, that is ok, but we may still change it to using the default
\LaTeX\ and \BibTeX\ facilities in processing for publication if the
output from \BibLaTeX\ is problematic, as we have often seen it to be.
-
-
+%\appendix
\section{Equivalences between the `plain' and \LaTeX{} \TUB\ packages}
\label{sec:equiv}
@@ -939,7 +963,7 @@ differ significantly.
\begin{center}
\leavevmode
\begin{tabular}{@{}ll@{}}
- \small\textsf{Plain macro} & \small\textsf{\LaTeX{} macro} \\
+ \small Plain macro & \small \LaTeX{} macro \\
\midrule
\cs{head} & \cs{section} \\
\cs{subhead} & \cs{subsection} \\
@@ -965,9 +989,8 @@ elaborate facilities, the user is referred to the \pkgname{verbatim},
\pkgname{listings}, and \pkgname{fancyvrb} packages (see
section~\ref{sec:verbatim}).
-Of course, the syntax of commands given to the \LaTeX{} classes is
-different (as discussed in section~\ref{sec:syntax}); arguments are
-(almost always) enclosed in braces instead of the various
+The syntax of commands given to the \LaTeX{} classes is different;
+arguments are (almost always) enclosed in braces instead of the various
forms provided by the `plain' macros.
\SetBibJustification{\raggedright}
diff --git a/macros/latex/contrib/tugboat/ltubguid.pdf b/macros/latex/contrib/tugboat/ltubguid.pdf
index 5d4df0b38f..7b6b3231f1 100644
--- a/macros/latex/contrib/tugboat/ltubguid.pdf
+++ b/macros/latex/contrib/tugboat/ltubguid.pdf
Binary files differ
diff --git a/macros/latex/contrib/tugboat/tugboat-code.pdf b/macros/latex/contrib/tugboat/tugboat-code.pdf
index 2c5c124fa8..09edcef396 100644
--- a/macros/latex/contrib/tugboat/tugboat-code.pdf
+++ b/macros/latex/contrib/tugboat/tugboat-code.pdf
Binary files differ
diff --git a/macros/latex/contrib/tugboat/tugboat.bst b/macros/latex/contrib/tugboat/tugboat.bst
index 403256d1a4..0c507119b7 100644
--- a/macros/latex/contrib/tugboat/tugboat.bst
+++ b/macros/latex/contrib/tugboat/tugboat.bst
@@ -1,34 +1,38 @@
-%%% $Id: tugboat.bst 487 2023-06-22 22:39:59Z karl $
+%%% $Id: tugboat.bst 529 2023-10-27 16:32:42Z karl $
%%% TUGboat changes are public domain.
%%%
%%% Modified for TUGboat from abbrvurl.bst:
%%% New entry types: @ctan (see ctanbib);
%%% @online and @software (aliases for @misc).
%%% For @misc, the editor field is accepted along with author.
+%%% For @misc, the organization field is output.
%%% New field bookauthor for @incollection and @inproceedings.
%%% Abbreviate "page(s)" to "p(p).",
%%% "volume" to "vol.",
%%% "editor(s)" to "ed(s).",
%%% "edition" to "ed.".
%%% Output "Ph.D." rather than "PhD".
-%%% Output "No." and "no." for number field.
-%%% Omit spaces between author initials, like "A.B. Smith".
+%%% In number field, output "No." and "no.".
+%%% In month field, output numbers 01..12 as our preferred abbreviations.
+%%% Omit spaces between author initials, as in "A.B. Smith".
%%% Set urlintro="" and onlinestring="" to omit labels from output.
%%% Use \url instead of \href, so we don't require hyperref.
%%% Always use https://doi.org/ for the doi url; omit "doi:" from output.
%%% If doi or howpublished is present, omit url, since in practice
%%% they are usually all the same thing. Should check if
-%%% howpublished is in fact a url, though.
+%%% howpublished is in fact a url, but we currently don't.
%%% Truncate long author lists in format.names (max.names, trunc.num);
%%% omit "and" from author lists, per Oren P.
%%% Use \emph instead of \em so we get automatic italic corrections.
%%% New fields for editors:
%%% "journaltie" - ~ instead of space after journal name.
-%%% "newpage" - force page break after entry;
+%%% "monthtie" - ~ instead of space after month name.
+%%% "newpage" - force page break after entry.
%%% "nowarning" - if set, omit empty field warnings from output.check.
+%%% "pagesnodashify" - if set, don't convert - to -- in pages field.
%%% "prebibitem" - material output before \bibitem, with newline appended
%%% (for example, section headings).
-%%% "urlnewline" - force line break before url or doi value;
+%%% "urlnewline" - force line break before url or doi value.
%%% --karl, originally created 24jul18.
%%%
%%% Modification of BibTeX style file /usr/local/texlive/2009/texmf-dist/bibtex/bst/base/abbrv.bst
@@ -84,12 +88,13 @@ ENTRY
urldate % ctan
version % ctan
%
- journaltie % tub
- monthtie % tub
- newpage % tub
- nowarning % tub
- prebibitem % tub
- urlnewline % tub
+ journaltie % tub
+ monthtie % tub
+ newpage % tub
+ nowarning % tub
+ pagesnodashify % tub
+ prebibitem % tub
+ urlnewline % tub
}
{}
{ label }
@@ -109,22 +114,22 @@ FUNCTION {init.urlbst.variables}
% The following constants may be adjusted by hand, if desired
% The first set allow you to enable or disable certain functionality.
- #0 'addeprints := % 0=no eprints; 1=include eprints
+ #1 'addeprints := % 0=no eprints; 1=include eprints
#1 'adddoiresolver := % 0=no DOI resolver; 1=include it
#1 'addpubmedresolver := % 0=no PUBMED resolver; 1=include it
#2 'hrefform := % 0=no crossrefs; 1=hypertex xrefs; 2=hyperref refs
#0 'inlinelinks := % 0=URLs explicit; 1=URLs attached to titles
% String constants, which you _might_ want to tweak.
- "" 'urlintro := % prefix before URL; typically "Available from:" or "URL":
+ "" 'urlintro := % prefix before URL; typically "Available from:" or "URL":
"" 'onlinestring := % indication that resource is online; typically "online"
- "cited " 'citedstring := % indicator of citation date; typically "cited "
- "[link]" 'linktextstring := % dummy link text; typically "[link]"
- "http://arxiv.org/abs/" 'eprinturl := % prefix to make URL from eprint ref
- "arXiv:" 'eprintprefix := % text prefix printed before eprint ref; typically "arXiv:"
+ "cited " 'citedstring := % indicator of citation date; typically "cited "
+ "[links]" 'linktextstring := % dummy link text; typically "[link]"
+ "https://arxiv.org/abs/" 'eprinturl := % prefix to make URL from eprint ref
+ "arXiv:" 'eprintprefix := % text prefix printed before eprint ref; typically "arXiv:"
"https://doi.org/" 'doiurl := % prefix to make URL from DOI
- "" 'doiprefix := % text prefix printed before DOI ref; typically "doi:"
- "http://www.ncbi.nlm.nih.gov/pubmed/" 'pubmedurl := % prefix to make URL from PUBMED
+ "" 'doiprefix := % text prefix printed before DOI ref; typically "doi:"
+ "https://www.ncbi.nlm.nih.gov/pubmed/" 'pubmedurl := % prefix to make URL from PUBMED
"PMID:" 'pubmedprefix := % text prefix printed before PUBMED ref; typically "PMID:"
% The following are internal state variables, not configuration constants,
@@ -178,8 +183,9 @@ STRINGS { s t last.output.check }
% urlbst
% arg on stack is what needs to be written.
%
-% If a journal, we want to omit the following comma, as in
-% "TUGboat 39(1)" instead of the default "TUGboat, 39(1)".
+% If journal is "TUGboat" or "\TUB", we want to omit the following
+% comma, as in "TUGboat 39(1)" instead of the default "TUGboat, 39(1)".
+% But for all other journals, we want the comma.
%
% Furthermore, if field journaltie is non-empty, output a tie after the
% journal name instad of a space.
@@ -188,10 +194,14 @@ FUNCTION {output.nonnull.original}
{ 's :=
output.state mid.sentence =
{ last.output.check "journal" = not
- { ", " * }
- { journaltie empty$ not
- { "~" }
+ { ", " * } % not a journal, normal comma+space separator
+ { journal "TUGboat" = journal "\TUB" = or
+ { skip$ } % TUGboat, no comma
+ { "," * } % not TUGboat, want comma
+ if$
+ journaltie empty$
{ " " }
+ { "~" }
if$
*
}
@@ -574,29 +584,100 @@ FUNCTION {format.title}
if$
}
+% Return argument with - replaced by -- (unless already --),
+% unless pagesnodashify is set, in which case do nothing.
+%
+% We use pagesnodashify when an article has a reference to another article
+% in the same issue, in which case we use (from tb137kopp-microtemplates):
+% pages = "{\thisissuepageref{beeton-basic}}",
+% and that - clearly should not become --. Although we can work around
+% it by using a macro instead of a literal -, that's ugly.
+%
FUNCTION {n.dashify}
{ 't :=
- ""
- { t empty$ not }
- { t #1 #1 substring$ "-" =
- { t #1 #2 substring$ "--" = not
- { "--" *
- t #2 global.max$ substring$ 't :=
- }
- { { t #1 #1 substring$ "-" = }
- { "-" *
+ pagesnodashify empty$
+ {
+ ""
+ { t empty$ not }
+ { t #1 #1 substring$ "-" =
+ { t #1 #2 substring$ "--" = not
+ { "--" *
t #2 global.max$ substring$ 't :=
}
- while$
+ { { t #1 #1 substring$ "-" = }
+ { "-" *
+ t #2 global.max$ substring$ 't :=
+ }
+ while$
+ }
+ if$
+ }
+ { t #1 #1 substring$ *
+ t #2 global.max$ substring$ 't :=
}
if$
}
- { t #1 #1 substring$ *
- t #2 global.max$ substring$ 't :=
+ while$
+ }
+ {
+ t
+ }
+ if$
+}
+
+% tub: assume month is nonempty. If numeric (biblatex), output
+% our preferred month abbreviation; else output as-is.
+% There is no way to reuse the macro definitions previously made here,
+% so just write them out again.
+FUNCTION {format.month}
+{ month "01" = month "1" = or
+ { "Jan." }
+ { month "02" = month "2" = or
+ { "Feb." }
+ { month "03" = month "3" = or
+ { "Mar." }
+ { month "03" = month "4" = or
+ { "Apr." }
+ { month "05" = month "5" = or
+ { "May" }
+ { month "06" = month "6" = or
+ { "June" }
+ { month "07" = month "7" = or
+ { "July" }
+ { month "08" = month "8" = or
+ { "Aug." }
+ { month "09" = month "9" = or
+ { "Sept." }
+ { month "10" =
+ { "Oct." }
+ { month "11" =
+ { "Nov." }
+ { month "12" =
+ { "Dec." }
+ { month }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
+ }
+ if$
}
if$
}
- while$
+ if$
}
FUNCTION {format.date}
@@ -610,7 +691,7 @@ FUNCTION {format.date}
}
{ month empty$
'year
- { month
+ { format.month
monthtie empty$ not
{ "~" }
{ " " }
@@ -1398,6 +1479,7 @@ FUNCTION {misc}
howpublished output
format.date output
new.block
+ organization output
note output
fin.entry
empty.misc.check
diff --git a/macros/latex/contrib/tugboat/tugboat.dtx b/macros/latex/contrib/tugboat/tugboat.dtx
index a4b558b158..2a98a67ffc 100644
--- a/macros/latex/contrib/tugboat/tugboat.dtx
+++ b/macros/latex/contrib/tugboat/tugboat.dtx
@@ -1,5 +1,5 @@
% \iffalse (this is a meta-comment (so they say))
-% $Id: tugboat.dtx 490 2023-07-03 22:27:49Z karl $
+% $Id: tugboat.dtx 533 2023-10-28 22:40:31Z karl $
% tugboat.dtx - main source for LaTeX TUGboat classes.
%
% Copyright 1994-2023 TeX Users Group.
@@ -28,7 +28,7 @@
%<ltugboatsty>\ProvidesPackage{ltugboat}
%<ltugprocsty>\ProvidesPackage{ltugproc}
%<ltugcomn> \ProvidesPackage{ltugcomn}
- [2023-07-03 v2.30
+ [2023-10-28 v2.31
%<ltugboatcls> TUGboat journal class%
%<ltugproccls> TUG conference proceedings class%
%<ltugboatsty|ltugprocsty> TUG compatibility package%
@@ -221,8 +221,6 @@
% & separated by a slash)\\
% |\cs|& control sequence name\\
% & |\cs{name}|$\rightarrow$\cs{name}\\
-% |\env|& environment name \\
-% & |\env{name}|$\rightarrow$\env{name}\\
% |\meta|& meta-argument name\\
% & |\meta{name}|$\rightarrow$\meta{name}\\
% |\dash|& en-dash surrounded by thinspaces; only breakable AFTER\\
@@ -240,7 +238,7 @@
% |\revtitle|& with one argument, title of \ldots \\
% |\revpubinfo|& with one argument, other info pertaining to \ldots \\
% |\endreviewitem|& end data for item being reviewed\\
-% |\titleref|& with one argument, format title as straight text
+% |\titleref|& one argument, format title as straight text
% (slanted, frenchspacing) \\
% |\Input|& |\input| with some other bookkeeping for
% case where multiple articles are put together\\
@@ -342,7 +340,7 @@
\tubfinaloptiontrue
\AtEndOfClass{%
% Insert draft date into the header even with [final], if we are not
- % doing a production run. (tugboat.dates sets up page numbers
+ % doing a production run. (|tugboat.dates| sets up page numbers
% above 900 in such pseudo-draft mode.) We use [final] in the first
% place for this case because draft vs. final can change page
% layout, wrt registration marks, etc. (Not good, but too painful to
@@ -682,7 +680,7 @@
% Font used for the METAFONT logo, etc.
% \begin{macrocode}
\DeclareRobustCommand{\AllTeX}{%
- \texorpdfstring{(\La\kern-.075em)\kern-.075em\TeX}{(La)TeX}}
+ \texorpdfstring{(\La\kern-.075em)\kern-.05em\TeX}{(La)TeX}}
\def\AMS{American Mathematical Society}
\def\AmS{$\mathcal{A}$\kern-.1667em\lower.5ex\hbox
{$\mathcal{M}$}\kern-.125em$\mathcal{S}$}
@@ -799,10 +797,12 @@
%
% \begin{macrocode}
%<!latex>\def\LaTeX{\La\kern-.15em\TeX}
+\def\LMTX{\acro{LMTX}}
\def\LuaHBTeX{Lua\acro{HB}\-\TeX}%
\def\LuaHBLaTeX{Lua\acro{HB}\-\LaTeX}%
\def\LuaLaTeX{Lua\-\LaTeX}% dtk-logos defines it and people like to use it
\def\LuaTeX{Lua\-\TeX}% ditto
+\def\luatex{\LuaTeX}% ditto
\def\LyX{L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX}
\def\macOS{mac\acro{OS}}
\def\MacOSX{Mac\,\acro{OS\,X}}
@@ -848,9 +848,10 @@
\def\pcMF{\leavevmode\raise.5ex\hbox{p\kern-.3\p@ c}MF\@}
\def\PCTeX{PC\thinspace\TeX}
\def\pcTeX{\leavevmode\raise.5ex\hbox{p\kern-.3\p@ c}\TeX}
-\def\pdflatex{pdf\-\LaTeX}% dtk-logos
-\def\pdftex{pdf\-\TeX}% dtk-logos
-\def\pdfTeX{\pdftex}
+\def\pdfLaTeX{pdf\/\-\LaTeX}% dtk-logos
+\def\pdflatex{\pdfLatex}
+\def\pdfTeX{pdf\/\-\TeX}% dtk-logos
+\def\pdftex{\pdfTeX}
\def\PDF{\acro{PDF}}
\def\PGF{\acro{PGF}}
\def\PHP{\acro{PHP}}
@@ -904,7 +905,7 @@
% \fi
% but let's make the smaller change.
\fi
-\def\TikZ{Ti{\em k}Z}
+\def\TikZ{Ti\/{\em k}Z}
\def\ttn{\textsl{TTN}\@}
\def\TTN{\textsl{\TeX{} and TUG News}}
\def\TUB{\texttub{TUGboat}}\def\texttub{\textsl} % redefined in some situations
@@ -993,7 +994,6 @@
% \end{macrocode}
%
% \begin{macro}{\tubsentencespace}
-%
% Occasionally, notably after citations that need to come after a
% sentence-ending period, we want to tell \TeX\ that it's still at the
% end of a sentence. As in:
@@ -1008,16 +1008,21 @@
% \end{macrocode}
% \end{macro}
%
+% \begin{macro}{\tubdots}
% Latin Modern and many other fonts irritatingly make the Unicode
% ellipsis character (U+2026) a single character's width, typically more
% squashed together than three period characters. This just looks wrong.
% It is too painful to try to redefine in general, but provide the
% normal definition to reset in individual papers with, e.g.:
% |\ifx\tubdots\undefined \else \let\dots\tubdots \let\ldots\tubdots \fi|
+%
+% \begin{macrocode}
\DeclareRobustCommand{\tubdots}{\ifmmode\mathellipsis\else
.\kern\fontdimen3\font
.\kern\fontdimen3\font
.\kern\fontdimen3\font\fi}
+% \end{macrocode}
+% \end{macro}
%
% \begin{macro}{\allowhyphens}
% Hyphen control: first, we save (via \cs{edef}) the hyphenpenalties in
@@ -1145,9 +1150,18 @@
\def\now{\ifnum\hours<10 0\fi\number\hours:%
\ifnum\minutes<10 0\fi\number\minutes}
\def\Now{\today\ \now}
-\newif\ifPrelimDraft % [draft] or [preprint] or pageno>900
+\newif\ifPrelimDraft % true if ([draft] or [preprint] or pageno>900)
\def\midrtitle{} % center of running heads
\def\rtitlenexttopage{\ifPrelimDraft \textsl{\small draft: \Now}\fi}
+%\def\rtitlenexttopage{\ifnum\value{page}>900 \textsl{\small draft: \Now}\fi}
+% \end{macrocode}
+%
+% Sometimes we want to refer to the pages of another article in the same
+% issue. |tugboat.dates| makes the real definition; here we define a
+% placeholder so it won't be undefined when we send the source back to
+% the author.
+% \begin{macrocode}
+\let\thisissuepageref\empty
% \end{macrocode}
%
% \subsection{Ragged right and friends}
@@ -1217,14 +1231,13 @@
%
% \subsection{Assorted user-level markup}
%
-% \LaTeXe{} defines a robust \cs{,} we provide a new definition
-% of |~| by redefining \cs{\nobreakspace} (\cs{DeclareRobustCommand}
-% doesn't mind redefinition, fortunately). This is based on the version
-% in AMS-\TeX---the \LaTeXe{} version (|ltspace.dtx|) has \cs{leavevmode}
-% and does not do anything with the surrounding space(s). Our version
-% messes up with the \cs{pfill} used in |doc|-generated indexes
-% (\url{github.com/latex3/latex2e/issues/75}), but later (2018++)
-% versions of |doc| should be protected against our redefinition.
+% We provide a new definition of |~| by redefining \cs{\nobreakspace}
+% (\cs{DeclareRobustCommand} doesn't mind redefinition, fortunately).
+% This is based on the version in AMS-\TeX---the \LaTeXe{} version
+% (|ltspace.dtx|) has \cs{leavevmode} and does not do anything with the
+% surrounding space(s). Our version messes up with the \cs{pfill} used in
+% |doc|-generated indexes (\url{github.com/latex3/latex2e/issues/75}),
+% but later (2018++) versions of |doc| should protect against our redefinition.
%
% \begin{macrocode}
\let\latexnobreakspace=\nobreakspace
@@ -1289,8 +1302,20 @@
{\textbraceleft #1\textbraceright}%
}
%
-% Well, just the \begin part. Never seen it used.
-\DeclareRobustCommand{\env}[1]{\cs{begin}\tubbraced{#1}}
+% Literal text, such as class names, package names, filenames, etc,
+% Trying to define separate commands for each seems impossible and pointless.
+% Usually we don't want hyphenation or any other kind of break.
+\DeclareRobustCommand{\tbcode}[1]{\mbox{\texttt{#1}}}
+%
+% On the other hand, sometimes we need to break such code fragments.
+% If |hyperref| is loaded, we want |\nolinkurl|, else just |\url|.
+\AtBeginDocument{%
+\ifx\nolinkurl\undefined
+ \DeclareRobustCommand{\tbcodebreak}{\url}
+\else
+ \DeclareRobustCommand{\tbcodebreak}{\nolinkurl}
+\fi
+}
%
% Not sure why we ever want this instead of LaTeX's \, (using \kern),
% but fine, just keeping it.
@@ -1306,9 +1331,6 @@
% \cs{tbhurl}\tubbraced{foo} produces \texttt{http://foo}.
\AtBeginDocument{%
\ifx\hyper@normalise\undefined
- \def\tburl{\url}%
- \def\tbsurl{\url}% no hyperref, so just \url is fine.
- \def\tbhurl{\url}%
\ifx\url\undefined % make sure \url is defined
\def\url{\begingroup % might as well catch common special chars
\catcode`\#=12 \catcode`\$=12 \catcode`\%=12 \catcode`\^=12
@@ -1316,6 +1338,9 @@
\finish@tub@url}
\def\finish@tub@url#1{\tt #1\endgroup}
\fi
+ \let\tburl\url % no hyperref, so just \url is fine;
+ \let\tbsurl\url % \let instead of \def so we can still
+ \let\tbhurl\url % use \def\url{\tbsurl} without infloop.
\else
% This hyperref hook-in is due to Ulrike Fischer.
% \url{https://github.com/latex3/hyperref/issues/125}.
@@ -1370,10 +1395,14 @@
\def\tbsurlfootnote#1{\footnote{\raggedright\tbsurl{#1}}}
\def\tbhurlfootnote#1{\footnote{\raggedright\tbhurl{#1}}}
%
+% Close up space between footnote mark and punctuation ("pre-punctuation").
+\DeclareRobustCommand{\tbppkernfoot}{\tubthinnerspace}
+
% Make \! work in text mode.
\DeclareRobustCommand{\!}{\ifmmode\mskip-\thinmuskip \else\kern-0.16667em \fi}
%
-% Half a thinspace, positive and negative.
+% Half a thinspace, positive and negative. Should have named these
+% \cs{tb} instead of \cs{tub}, but not worth changing now.
\DeclareRobustCommand{\tubthinnerspace}
{\ifmmode\mskip.5\thinmuskip \else\kern0.08333em \fi}
\DeclareRobustCommand{\tubthinnerspaceneg}
@@ -1461,7 +1490,7 @@
\therevauth\therevtitle\therevpubinfo\endgraf}%
\vskip\medskipamount
}
-\def\titleref#1{{\slshape\frenchspacing#1\/}}
+\def\titleref#1{{\slshape\frenchspacing#1\nocorr}}
\let\booktitle=\titleref % older name
% \end{macrocode}
%
@@ -1604,7 +1633,8 @@
\@readFLN
\everyjob=\expandafter{\the\everyjob\@readFLN}
\InputIfFileExists{\jobname.fln}%
- {\TBInfo{Reading alternative file file \jobname.fln}}{}
+ {\TBInfo{Reading alternative file \jobname.fln}}
+ {}
% \end{macrocode}
%
% The following needs to work entirely in \TeX's mouth
@@ -1667,20 +1697,27 @@
\let\TBdriver\gobble
% \end{macrocode}
%
-% Some hyphenation exceptions:
+% Hyphenation exceptions. We read our own full |ushyphex.tex| (generated
+% from |tb0hyf.tex|) if it's available. The additional exceptions are
+% nearly all included in the file, but keep defining them anyway, since
+% we have for many years.
+%
+% But do not define any exceptions if |\tubomithyphenations| is defined.
+% This is needed for the |hyf| articles themselves.
%
% \begin{macrocode}
\ifx\tubomithyphenations\@thisisundefined
+\InputIfFileExists{ushyphex.tex}{}{} % ok if it's missing
\hyphenation{Del-a-ware Dijk-stra Duane Eijk-hout
- Flor-i-da Free-BSD Ghost-script Ghost-view
+ Flor-i-da Free-BSD Ghost-script
Hara-lam-bous Jac-kow-ski Ja-pa-nese Karls-ruhe Lua-Meta
- Mac-OS Ma-la-ya-lam Math-Sci-Net
+ Mac-OS Math-Sci-Net
Net-BSD Open-BSD Open-Office
- Pak-i-stan Pfa-Edit Post-Script Rich-ard Skoup South-all
+ Pak-i-stan Post-Script Rich-ard Skoup South-all
Vieth VM-ware Win-Edt
acro-nym acro-nyms analy-sis ap-pen-di-ces ap-pen-dix asyn-chro-nous
bib-lio-graph-i-cal bit-map bit-mapped bit-maps buf-fer buf-fers bool-ean
- col-umns com-put-able com-put-abil-ity cus-tom-iz-able
+ col-umns com-put-able com-put-abil-ity
data-base data-bases
de-allo-cate de-allo-cates de-allo-cated de-allo-ca-tion
de-riv-a-tive de-riv-a-tives de-riv-a-ble der-i-va-tion dis-trib-ut-able
@@ -1694,7 +1731,7 @@
mne-mon-ic mne-mon-ics mono-space mono-spaced
name-space name-spaces
off-line over-view
- pal-ettes par-a-digm par-a-dig-mat-ic par-a-digms
+ pal-ettes par-a-digm par-a-dig-matic par-a-digms
pipe-line pipe-lines
plug-in plug-ins pres-ent-ly pro-gram-mable
re-allo-cate re-allo-cates re-allo-cated re-printed
@@ -1758,8 +1795,16 @@
\newdimen\headmargin \headmargin=3.5pc
% \end{macrocode}
%
-% In \LaTeXe, |twoside| option is forced on when
-% |article.cls| is loaded.
+% Don't go to a float page so soon. Not all of these are relevant to all
+% articles, but we may as well set them all.
+% \begin{macrocode}
+\renewcommand{\topfraction}{.9} % don't go to a float page so soon
+\renewcommand{\dbltopfraction}{.9}
+\renewcommand{\bottomfraction}{.7}
+\renewcommand{\textfraction}{.1}
+\renewcommand{\floatpagefraction}{.8}
+\renewcommand{\dblfloatpagefraction}{.8} % the most common one used
+% \end{macrocode}
%
% \subsection{Messing about with the \LaTeX{} logo}
% \label{sec:latex-logo}
@@ -2725,12 +2770,12 @@
\string#2\space used instead}#2}
% \end{macrocode}
%
-% \cs{l@<sectioning-name>} is for table of contents (of an article).
+% \cs{l@<sectioninglevel>} is for table of contents (of an article).
% We define new macros to allow easily changing the font used for toc
% entries (for \TUB, we usually want roman, not bold), and the space
% between entries. Nelson Beebe and Frank Mittelbach's articles
% often have toc's (and few others). Also turn off microtype
-% protrusion after \tableofcontents or leaders get messed up.
+% protrusion after \tableofcontents, or leaders get messed up.
%
% \begin{macrocode}
\def\TBtocsectionfont{\normalfont}
@@ -2741,14 +2786,16 @@
% |#1| is both the section number and title; |#2| is the page number.
% Per Ulrike, the hook calls are for tagging, introduced with the
% June 2023 \LaTeX.
+% qqq need to also do subsections like tb137carlisle to avoid hyphenation
\def\l@section#1#2{%
\addpenalty{\@secpenalty}%
\addvspace{\TBtocsectionspace}%
\@tempdima 1.5em
\begingroup
\parindent\z@
- \rightskip\z@ % article style makes \rightskip > 0
+ \rightskip=0pt plus2em
\parfillskip\z@
+ \hyphenpenalty=10000
\TBtocsectionfont
\leavevmode
\advance\leftskip\@tempdima
@@ -2772,7 +2819,7 @@
\UseHookWithArguments{contentsline/page/before}{4}
{\toclevel@part}{#1}{#2}{\@contentsline@destination}%
\fi
- #2%
+ \tubtypesetpageno{#2}%
\ifx\UseHookWithArguments\undefined\else
\UseHookWithArguments{contentsline/page/after}{4}
{\toclevel@part}{#1}{#2}{\@contentsline@destination}%
@@ -2905,9 +2952,14 @@
% With more recent LaTeX, define \@currentlabelname via hooks.
% \begin{macrocode}
\@ifl@t@r\fmtversion{2023-06-01}{%
- \AddToHookWithArguments{cmd/@sect/before}{\def\@currentlabelname{#7}}%
- \AddToHookWithArguments{cmd/@ssect/before}{\def\@currentlabelname{#5}}%
-}{%
+ \RequirePackage{gettitlestring}
+ \AddToHookWithArguments{cmd/@sect/before}{%
+ \GetTitleString{#7}%
+ \let\@currentlabelname\GetTitleStringResult}%
+ \AddToHookWithArguments{cmd/@ssect/before}{%
+ \GetTitleString{#5}%
+ \let\@currentlabelname\GetTitleStringResult}%
+}{% else older latex:
\let\@savelatexlabel=\label % so save original LaTeX command
%
\def\label#1{%
@@ -3023,7 +3075,7 @@
% Let's reduce the default space above captions a bit, and give it some
% flexibility. The default is |10pt|, which seems too much.
% \begin{macrocode}
-\setlength\abovecaptionskip{6pt plus1pt minus1pt}
+\setlength\abovecaptionskip{3pt plus2pt minus1pt}
% \end{macrocode}
%
% \subsection{Size changing commands}
@@ -3537,38 +3589,50 @@
\def\@oddhead{\MakeRegistrationMarks
\frenchspacing
\normalsize\csname normalshape\endcsname\rm \tubheadhook
- \rtitlex\qquad \midrtitle\hfil \rtitlenexttopage\quad\thepage}
+ \rtitlex\qquad \midrtitle\hfil
+ \rtitlenexttopage\quad\tubtypesetpageno{\thepage}}
\def\@evenhead{\MakeRegistrationMarks
\frenchspacing
\normalsize\csname normalshape\endcsname\rm \tubheadhook
- \thepage\quad\rtitlenexttopage \hfil\midrtitle \qquad\rtitlex}
+ \tubtypesetpageno{\thepage}\quad\rtitlenexttopage
+ \hfil\midrtitle \qquad\rtitlex}
-% Put a ? into the page number in all but a final run, so people
-% aren't tempted to cite it.
+% Put a ? into the page number in the headers in all but a final run, so
+% people aren't tempted to cite it.
%
-% We redefine |\thepage| so that the ? will also be used in page
-% references (in the text) and the toc. This is what's recommended by
-% the LaTeX developers: https://tex.stackexchange.com/questions/687258.
-% (Ulrike's example does this after loading hyperref, but doesn't seem
-% to matter?)
-\renewcommand\thepage{%
- \ifnum\value{page}>900
+\newcommand{\tubtypesetpageno}[1]{%
+ \ifnum #1>900
% in CM, numerals are exactly .5em.
%
% The \texorpdfstring avoids the usual hyperref warning:
% Token not allowed in a PDF string ... removing `\@ifnextchar'
\texorpdfstring{\makebox[.5em][l]{\small ?}}{?}%
%
- \textsl{\@arabic{\numexpr\value{page}-900\relax}}% e-tex
+ \textsl{\@arabic{\numexpr#1-900\relax}}% assuming e-tex
\else
- \@arabic{\value{page}}%
+ \@arabic{#1}%
\fi
}
-% This custom page number format will break makeindex, etc., so we have
-% to tell about the format. Per Ulrike:
-% \usepackage{index}
-% \newcommand\specialthepage{\inteval{\value{page}-900}}
-% \newindex[specialthepage]*{default}{idx}{ind}{Index}
+%
+% The above changes the page number in the headers and tocs. It does not
+% change the page number in cross-references, which will still show up
+% as `901' instead of `?1'. In order to do that, we'd have to redefine
+% |\thepage| (https://tex.stackexchange.com/questions/687258).
+%
+% The problem is that |\thepage| is not expected to contain typesetting
+% commands like |\makebox| and |\textsl|, but to expand to the simple
+% page number (in whatever form). For example, when redefining
+% |\thepage| to the above, terminal warnings then look like:
+% |LaTeX Warning: Citation `foo' on page \makebox [.5em][l]{...|
+% losing the actual page number.
+%
+% So apparently there is no way to add the ? correctly in all contexts.
+%
+% BTW, such a custom page number format would also break makeindex,
+% etc., but for that we could provide the information. Per Ulrike:
+%\usepackage{index}
+%\newcommand\specialthepage{\inteval{\value{page}-900}}
+%\newindex[specialthepage]*{default}{idx}{ind}{Index}
% can be used to reset the font, e.g., tb98kuester.
\def\tubheadhook{}
@@ -3735,7 +3799,7 @@
% spacefactor after inserting its text.
%
% \begin{macrocode}
-\newcommand{\acro}[1]{\textSMC{#1}\@}
+\DeclareRobustCommand{\acro}[1]{\textSMC{#1}\@}
%</common>
% \end{macrocode}
%
@@ -3843,12 +3907,13 @@
\fi
\authornumber\z@
\let\@signature\@defaultsignature
-\InputIfFileExists{ltugboat.cfg}{\TBInfo{Loading ltugboat
- configuration information}}{}
+\InputIfFileExists{ltugboat.cfg}
+ {\TBInfo{Loading ltugboat.cfg configuration information}}
+ {}
%</classtail>
% \end{macrocode}
%
-% \section{\protect\LaTeXe\ Proceedings class}
+% \section{\protect\LaTeXe\ proceedings class (no longer used)}
%
% \begin{macro}{\@tugclass}
% Make the code of |ltugboat.cls| (when we load it) say it's really
@@ -3943,7 +4008,7 @@
%
% \begin{macrocode}
\InputIfFileExists{\@tugclass.cfg}{\ClassInfo{ltugproc}%
- {Loading ltugproc configuration information}}{}
+ {Loading ltugproc.cfg configuration information}}{}
\@ifundefined{TUGprocExtraOptions}%
{\let\TUGprocExtraOptions\@empty}%
{\edef\TUGprocExtraOptions{,\TUGprocExtraOptions}}
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-07 06:29:21 +0000