summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/changelog/changelog.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/changelog/changelog.tex')
-rw-r--r--macros/latex/contrib/changelog/changelog.tex55
1 files changed, 45 insertions, 10 deletions
diff --git a/macros/latex/contrib/changelog/changelog.tex b/macros/latex/contrib/changelog/changelog.tex
index 3e5611dd5d..f4d0706350 100644
--- a/macros/latex/contrib/changelog/changelog.tex
+++ b/macros/latex/contrib/changelog/changelog.tex
@@ -17,14 +17,7 @@
}
\makeatother
-\setmainfont{Charter}[
- Path = /nix/store/8ylkcs5xw8b3glvgp5l66md6hvxdk098-charter-200512/share/fonts/opentype/,
- Extension = .otf,
- UprightFont = * Regular,
- ItalicFont = * Italic,
- BoldFont = * Bold,
- BoldItalicFont = * Bold Italic,
-]
+\setmainfont{Charter}
\usepackage{FiraSans}
\usepackage{FiraMono}
\lstset{basewidth=0.6em}
@@ -35,9 +28,9 @@
\begin{description}}
{\end{description}}
-\author{Rebecca Turner\thanks{Brandeis University; \email{rbt@sent.as}}}
+\author{Rebecca Turner\thanks{\email{rbt@sent.as}}}
\title{The \cl\ Package}
-\date{2020/08/26 2.4.0}
+\date{2.5.0 (2023/02/16)}
\begin{document}
\maketitle
@@ -159,6 +152,7 @@ versions have the same author.
What to \cs{label} the section?
\end{keys}
+\pagebreak
\begin{desc}
|\begin{version}[<options>]...\end{version}|
\end{desc}
@@ -192,6 +186,10 @@ of the other solutions here.}}
\key{yanked}[\bool][false]
Indicates that the release was revoked due to a ``serious bug or
security issue''; prints a visible notice next to the version number
+ \key{remark}[\m{remark}]
+ Adds a remark in the style of the |yanked| key.
+ \key{remarks}[\m{comma-separated list of remarks}]
+ Adds multiple remarks in the style of the |yanked| key.
\key{simple}[\bool][false]
Indicates this version isn't split up into \cs{added}, \cs{changed},
etc.\ categories; if this option is given, a |version| environment acts
@@ -235,6 +233,21 @@ the \option{simple} option!
\begin{desc}|\security|\end{desc}Introduces a list of \cs{item}s that represent
security-fixes and closed security holes
+\begin{desc}|\newchangelogsection{<command>}{<description>}|\end{desc}
+ Creates a new command like \cs{added}, \cs{changed}, etc., that can be
+ used in the |version| environment.
+
+\begin{LTXexample}
+\newchangelogsection
+ {\critical}{Critical}
+\begin{changelog}[section=false]
+ \begin{version}[v=1.0.0, date=2023-02-16]
+ \critical
+ \item Features!
+ \end{version}
+\end{changelog}
+\end{LTXexample}
+
\subsection{Customization}
The |changelog| environment wraps |changelogdescription| (which is
@@ -257,6 +270,12 @@ Prints the ``revoked release'' notice:
\href{https://keepachangelog.com/en/1.0.0/#yanked}{yanked releases on
\texttt{keepachangelog.com}}.
+\begin{desc}
+|\changelogremark{<remark>}|
+\end{desc}
+Prints a ``remark.'' This is used to implement |\changelogyanked| and the
+|remark| and |remarks| keys of the |version| environment.
+
\section{Translations}
Want to use \cl\ in a non-English document? Great! \cl\ comes with
@@ -327,6 +346,22 @@ an email} and I'll incorporate the translation into \cl's next release!
This is this package's actual changelog --- not an example!
\begin{changelog}[author=Rebecca Turner <\email{rbt@sent.as}>, section=false]
+\begin{version}[v=2.5.0, date=2023-02-16]
+\added
+ \item Added the \cs{newchangelogsection} command to support custom
+ sections.
+ \item Added the |remark| and |remarks| keys to support custom remarks (like
+ ``YANKED'') on versions.
+ \item Added the |\changelogremark| command, which renders the ``YANKED''
+ remark and other custom remarks.
+\end{version}
+\begin{version}[v=2.4.1, date=2023-02-14]
+\changed
+ \item Converted the |changelog.sty| implementation to use the \ctan{expl3}
+ package. \ctan{expl3} provides a reasonable and well-defined programming
+ environment. I believe \ctan{expl3} is the future of programming in
+ \LaTeX, despite its verbosity.
+\end{version}
\begin{version}[v=2.4.0, date=2020-09-02,
author={cmplstofB <\https{github.com/cmplstofB}>}]
\added