% $Date: 2024/03/25 15:18:05 $
% This template file is public domain.
%
% TUGboat class documentation is at:
%   texdoc tugboat
% or
%   https://texdoc.org/serve/tugboat/0
% or
%   https://mirrors.ctan.org/macros/latex/contrib/tugboat/ltubguid.pdf

\documentclass{ltugboat}
\usepackage[T1]{fontenc}
\usepackage{graphicx}
\usepackage{microtype}
\usepackage[hidelinks]{hyperref}

\title{Example \TUB\ article}

% repeat info for each author; comment out items that don't apply.
\author{First Last}
\address{Street Address \\ Town, Postal \\ Country}
\netaddress{user (at) example dot org}
\personalURL{https://example.org/~user/}
%\ORCID{0}

% Please state if you'd like to receive a physical copy of the TUGboat
% issue or if electronic access suffices.  If you want a physical issue,
% please include the mailing address we should use, as a comment if
% you prefer it not be printed.

\begin{document}
\maketitle

\begin{abstract}
Please write an abstract. Please use only standard \LaTeX\ and \TUB\
macros in the abstract, not article-specific abbreviations or other
macros; that helps us make the web pages.
\end{abstract}

\section{Introduction}

This is an example article for \TUB, linked from
\url{https://tug.org/TUGboat/location.html}.

\section{Basic packages and hyperlinks}

The standard \texttt{graphicx} and \texttt{xcolor} packages work fine
for image and color handling, respectively, as does the
\texttt{hyperref} package for active urls. \TUB\ is produced using
\acro{PDF} files exclusively, but conversion from \DVI\ is fine and supported.

Please use the standard \cs{url} command for urls, as in:
\begin{verbatim}
\url{https://some/ftp/url} % yes
\url{ftp://some/ftp/url}   % yes
\end{verbatim}
For \TUB, we prefer not to print the `\texttt{https://}', but to include
the protocol in other cases, so we usually do \verb|\def\url{\tburl}|,
which takes care of that, while keeping the source using the standard
\cs{url} command.

In any case, please do \emph{not} hide hyperlinks via \cs{href}, as in:
\begin{verbatim}
\href{https://some/url}{some text} % no!
\end{verbatim}
When printed on paper, the url will not be visible; indeed, readers will
not know it exists.

\section{Abbreviation macros}

The \texttt{ltugboat} class provides many abbreviation commands; here
are a few of the most common:

% verbatim blocks are often better in \small
\begin{verbatim}[\small]
\AllTeX \AMS
\BibTeX \Cplusplus \CTAN
\DVI
\HTML \LaTeXe
\macOS \MathML \MF
\PDF \PS
\TUB \TUG \tug
\WEB
\XeLaTeX \XeTeX \XML

% Em-dash with our spacing, preferred to ---:
\Dash

% Please use \acro for initialisms in all caps:
\acro{FRED} -> {\small[er] FRED}

% A literal control sequence:
\cs{fred}   -> \fred

% A syntactic metavariable:
\meta{fred} -> <fred>

% The title of something:
\titleref{Book of Fred}
\end{verbatim}

We recommend using \cs{begin}\tubbraced{verbatim}\texttt{[\small] ...}
\cs{end}\tubbraced{verbatim} for code blocks, since we prefer not to
colorize code when printed. But if you want to have some font changes,
our recommended settings for the \texttt{listings} package are in the
\texttt{ltubguid} manual mentioned below.

\section{Figures}

For \TUB, the standard \texttt{figure} environment produces a
column-width figure; this is desirable when at all possible. The
\texttt{figure*} environment produces a full-width (across both columns)
figure when needed. Analogously for \texttt{table} and \texttt{table*}.

Please put captions below figures, but above tables. That's our
convention.

Don't worry overmuch about figure placements, as they will likely change
with editing.

\begin{figure}
A column-width figure, made with \cs{begin}\tubbraced{figure}.
\caption{Caption for column-width figure.}
\label{fig.colwidth}
\end{figure}

\begin{figure*}
A full-width figure, made with \cs{begin}\tubbraced{figure*}.
\caption{Caption for full-width figure.}
\label{fig.fullwidth}
\end{figure*}

\section{References}

For references to other issues of \TUB, please use the format
\textsl{volno}:\textsl{issno}, e.g., ``\TUB\ 32:1'' for volume~32,
number~1.

The primary \TUB\ style documentation is the \texttt{ltubguid} manual,
available online at \tbsurl{ctan.org/pkg/tugboat} or locally with
\texttt{texdoc tugboat}. For general \CTAN\ package references, we
recommend that form, using \texttt{/pkg/}; if you need to refer to a
specific file on \CTAN, use:\\
\texttt{https://mirror.ctan.org/\textsl{path}}

We recommend using \BibTeX\ (but don't require it), with the
\texttt{tugboat} \BibTeX\ style. The \texttt{biblio} directory on \CTAN,
\tbsurl{ctan.org/pkg/biblio}, provides files \texttt{tugboat.bib} with a
complete bibliography of \TUB, and \texttt{texbook3.bib} many common
\TeX-related books and articles, and plenty more. Both of these (and
lots more) should be present in a non-minimal \TeX\ distribution.

Email \verb|tugboat@tug.org| with any problems or questions.

\bibliographystyle{tugboat}
\nocite{book-minimal}      % make the example bibliography non-empty
\bibliography{xampl}       % xampl.bib comes with BibTeX

\makesignature
\end{document}
