%%
%% This is file `hep-text-documentation.tex',
%% generated with the docstrip utility.
%%
%% The original source files were:
%%
%% hep-text-implementation.dtx  (with options: `documentation')
%% This is a generated file.
%% Copyright (C) 2019-2025 by Jan Hajer
%% This file may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either
%% version 1.3c of this license or (at your option) any later
%% version. The latest version of this license is in:
%% http://www.latex-project.org/lppl.txt
%% and version 1.3c or later is part of all distributions of
%% LaTeX version 2005/12/01 or later.

\ProvidesFile{hep-text-documentation.tex}[2026/08/01 v1.5 HEP-Text documentation]
\ProvidesFile{hep-text-text.tex}[2026/08/01 v1.5 HEP-Text tests]

\RequirePackage[l2tabu, orthodox]{nag}
\documentclass{ltxdoc}

\renewcommand*\theCodelineNo{\rmfamily\tstyle\footnotesize\arabic{CodelineNo}}
\AtBeginEnvironment{macrocode}{\renewcommand*{\ttdefault}{clmt}}
\renewcommand*{\MacroFont}{\codestyle}
\AtBeginDocument{\DeleteShortVerb{\|}}
\AtBeginDocument{\MakeShortVerb{\"}}
\EnableCrossrefs
\CodelineIndex
\RecordChanges

\usepackage{hologo}

\usepackage[parskip,oldstyle,font=10pt]{hep-paper}
\bibliography{bibliography}

\acronym{CM}{computer modern}
\acronym{LM}{latin modern}

\newenvironment{columns}[1][.5]{%
  \par\vspace{-\bigskipamount}%
  \begin{minipage}[t]{\linewidth}%
  \begin{minipage}[t]{#1\linewidth}%
  \def\column{%
    \end{minipage}%
    \begin{minipage}[t]{\linewidth-#1\linewidth}%
  }%
}{\end{minipage}\end{minipage}\par}

\GetFileInfo{hep-text.sty}

\title{The \software{hep-text} package\thanks{This document corresponds to \software{hep-text}~\fileversion.}}
\subtitle{List and text extensions}
\author{Jan Hajer \email{jan.hajer@tecnico.ulisboa.pt}}
\date{\filedate}

\begin{document}

\newgeometry{vscale=.8, vmarginratio=3:4, includeheadfoot, left=11em, marginparwidth=4.6cm, marginparsep=3mm, right=7em}

\maketitle

\begin{abstract}
The \software{hep-text} package collects lightweight text utilities.
It configures language-aware hyphenation, quotation marks, and Latin abbreviations through established \hologo{LaTeX} packages, adds helpers for software names, online references, email addresses, numero labels, prefix constructions, and line-breakable underlining, and defines compact inline and enumerated description lists based on \software{enumitem}.
\end{abstract}

Load the package with "\usepackage{hep-text}".

\DescribeMacro{lang}
The "lang" option selects the document language.
It accepts the language names understood by \software{babel} \cite{babel}, which is loaded for hyphenation support.

\software{csquotes} \cite{csquotes} provides context-sensitive quotation commands.
\DescribeMacro{\enquote}
\DescribeMacro{\MakeOuterQuote}
The macros "\enquote"\marg{text} and "\MakeOuterQuote{}" leave the choice of quotation marks to \hologo{LaTeX}.
The latter also allows \verb|"| to be used instead of the pair \verb|``| and \verb|''|.

\DescribeMacro{\eg}
\DescribeMacro{\ie}
\DescribeMacro{\cf}
\DescribeMacro{\vs}
The \software{foreign} package \cite{foreign} defines common Latin abbreviations such as "\eg", "\ie", "\cf", and "\vs".
They are typeset as \eg, \ie, \cf, and \vs with appropriate spacing.
Redefine "\foreignabbrfont" to adjust their style, for example "\renewcommand\foreignabbrfont{\itshape}" for italic abbreviations.

\DescribeMacro{\no}
The "\no"\marg{number} macro prints a numero sign followed by a non-breaking space, as in \no{123}.

\DescribeMacro{\software}
The "\software"\oarg{version}\marg{name} macro typesets software names in small caps, with optional version information, as in \software[\fileversion]{HEP-Paper}.

\DescribeMacro{\online}
The "\online"\marg{url}\marg{text} macro links \meta{text} to \meta{url} when \software{hyperref} \cite{hyperref} is loaded and otherwise prints the text in a URL-like style, as in \online{https://ctan.org/pkg/hep-text}{ctan.org/pkg/hep-text}.

\DescribeMacro{\email}
The "\email"\marg{address} macro is shorthand for "\online"\marg{mailto:address}\marg{address}, as in \email{jan.hajer@tecnico.ulisboa.pt}.

\DescribeMacro{\prefix}
The "\prefix"\marg{prefix}\marg{word} macro typesets prefix constructions with a permissible line break after the prefix, as in \prefix{pre}{selection}.

\DescribeMacro{\subsubparagraph}
The "\subsubparagraph" macro starts an unnumbered paragraph-level break with the same vertical spacing as "\paragraph" but without a heading.

\DescribeMacro{inlinelist}
\DescribeMacro{enumdescript}
The "inlinelist" and "enumdescript" environments are built with \software{enumitem} \cite{enumitem}.
\\
\begin{columns}
\begin{verbatim}
The three main points are
\begin{inlinelist}
  \item one
  \item two
  \item three
\end{inlinelist}
\end{verbatim}
\column
The three main points are
\begin{inlinelist}
 \item one
 \item two
 \item three
\end{inlinelist}
\end{columns}
\vspace{4ex}
\begin{columns}[.6]
\begin{verbatim}
\begin{enumdescript}[label=\Roman*)]
  \item{First} one
  \item{Second} two
  \item{Third} three
\end{enumdescript}
\end{verbatim}
\column
\begin{enumdescript}[label=\Roman*)]
 \item{First} one
 \item{Second} two
 \item{Third} three
\end{enumdescript}
\end{columns}

\DescribeMacro{\underline}
The "\underline" macro is redefined with \software{soul} \cite{soul} so that underlined text can break across lines.


\printbibliography

\end{document}

\endinput
%%
%% End of file `hep-text-documentation.tex'.
