summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tugboat/ltubguid.ltx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/tugboat/ltubguid.ltx')
-rw-r--r--macros/latex/contrib/tugboat/ltubguid.ltx46
1 files changed, 30 insertions, 16 deletions
diff --git a/macros/latex/contrib/tugboat/ltubguid.ltx b/macros/latex/contrib/tugboat/ltubguid.ltx
index d2947c0389..da93ceac25 100644
--- a/macros/latex/contrib/tugboat/ltubguid.ltx
+++ b/macros/latex/contrib/tugboat/ltubguid.ltx
@@ -1,4 +1,4 @@
-% $Id: ltubguid.ltx 375 2021-06-25 14:40:52Z karl $
+% $Id: ltubguid.ltx 386 2021-09-28 22:25:51Z karl $
% ltubguid.ltx - documentation for ltugboat classes.
%
% Copyright 1994-2021 TeX Users Group.
@@ -528,11 +528,14 @@ Two caveats about these optional arguments:
defines the \verb|verbatim| environment, as discussed next.
\end{itemize}
-Authors may wish to use a more featureful verbatim package, such as such
-as \pkgname{verbatim}~\cite{Schoepf:verbatim:1996},
-\pkgname{listings}~\cite{pkg:listings}, or
+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.
+\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
+requirement is troublesome. In any case, we will almost always wish to
+print code listings in simple black, not colored or even grayscaled.
If you use the \pkgname{listings} package, please specify:
\begin{verbatim}[\small]
@@ -721,21 +724,28 @@ 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
-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
+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.23, released
March~2020) commands \cs{tbsurl} for \texttt{https} and \cs{tbhurl} for
-\texttt{http}.\footnote{They are simple two-line wrapper around
-\cs{hyper@linkurl}, and are due to Ulrike Fischer.
+\texttt{http}.\footnote{They are wrappers around \cs{hyper@linkurl}, and
+are due to Ulrike Fischer.
\url{https://github.com/latex3/hyperref/issues/125}\raggedright}
For example, \verb|\tbsurl{tug.org}| typesets the text
`\texttt{tug.org}' (with the usual url line breaks) as a link to
\url{https://tug.org}.
-Similarly, \verb|\tbhurl{mirror.ctan.org}| typesets the text
-`\texttt{mirror.ctan.org}' as a link to \url{http://mirror.ctan.org}.
+Similarly, \verb|\tbhurl{example.org}| typesets the text
+`\texttt{example.org}' as a link to \url{http://example.org}.
+
+The correct protocol can be explicitly specified, and will also be
+stripped for display. That is, \verb|\tbsurl{https://tug.org}| also
+works. This can be particularly useful for bibliographies. However, an
+incorrect protocol (\texttt{http} with \cs{tbsurl} or the converse) will
+not be stripped, and will generate an invalid url. That's ok because
+such an inconsistent specification cannot be handled reliably.
\cs{tbsurl} and \cs{tbhurl} only add the protocol and make live links if
\texttt{hyperref} is loaded. Without \texttt{hyperref}, they are merely
@@ -745,8 +755,8 @@ output, the printed url without the protocol suffices. (When a user
copies/pastes url text into a browser, it will normally work.)
For \texttt{ftp}, \texttt{rsync}, and other protocols, it is best to
-include them explicitly and use \cs{url}:\\ \verb|\url{ftp://tug.org}|,\\
-\verb|\url{rsync://tug.org}|, etc.
+always include them explicitly and use \cs{url}:\\
+\verb|\url{ftp://tug.org}|,\\ \verb|\url{rsync://tug.org}|, etc.
\subsection{Url shortcuts}
\label{sec:urlshortcuts}
@@ -801,7 +811,11 @@ four authors (thanks to Mico Loretan and Oren Patashnik).
\textsf{@inproceedings} allows for citing a part, written by author~X,
of a publication written by author~Y, and not just edited by~Y.
-\item Defines an \textsf{@online} entry type as an alias for \textsf{@misc}.
+\item For the \textsf{@misc} entry type, \textsf{editor} is accepted as
+well as \textsf{author}.
+
+\item Defines entry types \textsf{@online} and \textsf{@software} as
+aliases for \textsf{@misc}.
\item Defines an \textsf{@ctan} entry type to reference packages on
\CTAN, following the fields output by the \pkgname{ctanbib} script (in
@@ -886,7 +900,7 @@ date.
\label{fig:citation-macros}
\end{figure}
-Note that, if Tom, Dick, and Harry are a prolific team, there can
+Furthermore, if Tom, Dick, and Harry are a prolific team, there can
easily be more than one reference to their work in one year. In such
a case, the citations will be (Tom, Dick, and Harry, 1990a), (Tom,
Dick, and Harry, 1990b), and so on. These extra `a', `b', etc., tags