changelog (17feb23)

git-svn-id: svn://tug.org/texlive/trunk@65861 c570f23f-e606-0410-a88d-b1316a301751

5 files changed, 70 insertions, 10 deletions

diff --git a/Master/texmf-dist/doc/latex/changelog/README.md b/Master/texmf-dist/doc/latex/changelog/README.md
index 93e7c2834ed..ab16196d1e6 100644
--- a/Master/texmf-dist/doc/latex/changelog/README.md
+++ b/Master/texmf-dist/doc/latex/changelog/README.md
@@ -19,5 +19,19 @@ screenshot.png               | Sample screenshot
 README.md                    | This file
 LICENSE.txt                  | LPPL v1.3c
 
+## Development
+
+Sources for this package are [available on GitHub.][github]
+This package is built with the [Nix][nix] package manager.
+
+- Build a release directory with rendered PDFs:
+  `nix build .#changelog`
+- Build a release tarball:
+  `nix build .#changelog-tar`, or just `nix build`
+- Enter a development shell with `latexmk` and fonts available:
+  `nix develop`
+
 [keepachangelog.com]: https://keepachangelog.com/
 [changelog]: https://ctan.org/pkg/changelog
+[github]: https://github.com/9999years/latex-changelog
+[nix]: https://zero-to-nix.com/
diff --git a/Master/texmf-dist/doc/latex/changelog/changelog.pdf b/Master/texmf-dist/doc/latex/changelog/changelog.pdf
index 800b2ac3653..c80cec01db6 100644
--- a/Master/texmf-dist/doc/latex/changelog/changelog.pdf
+++ b/Master/texmf-dist/doc/latex/changelog/changelog.pdf
diff --git a/Master/texmf-dist/doc/latex/changelog/changelog.tex b/Master/texmf-dist/doc/latex/changelog/changelog.tex
index 3e5611dd5d5..f4d07063509 100644
--- a/Master/texmf-dist/doc/latex/changelog/changelog.tex
+++ b/Master/texmf-dist/doc/latex/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
diff --git a/Master/texmf-dist/doc/latex/changelog/example.pdf b/Master/texmf-dist/doc/latex/changelog/example.pdf
index 6cb7383b02c..110ae72c38f 100644
--- a/Master/texmf-dist/doc/latex/changelog/example.pdf
+++ b/Master/texmf-dist/doc/latex/changelog/example.pdf
diff --git a/Master/texmf-dist/doc/latex/changelog/example.tex b/Master/texmf-dist/doc/latex/changelog/example.tex
index ad2272c5b86..9db61a2ea7f 100644
--- a/Master/texmf-dist/doc/latex/changelog/example.tex
+++ b/Master/texmf-dist/doc/latex/changelog/example.tex
@@ -1,10 +1,13 @@
 \documentclass{article}
 \usepackage{changelog}
+\newchangelogsection{\critical}{Critical}
 \begin{document}
 \begin{changelog}[author=Rebecca Turner,
 	sectioncmd=\subsection,
 	title=Example changelog]
 \begin{version}
+\critical
+	\item A critical new feature
 \added
 	\item Really cool features
 \end{version}
@@ -17,6 +20,14 @@
 	\item A version with no date
 \end{version}
 
+\begin{version}[v=1.0.3, remark=Remark, simple]
+	\item A version with a remark.
+\end{version}
+
+\begin{version}[v=1.0.2, remarks={Remark 1, Remark 2}, simple]
+	\item A version with multiple remarks.
+\end{version}
+
 \begin{version}[v=1.0.1, yanked, simple]
 	\item A version with a terrible bug
 \end{version}