summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/changelog/example.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/changelog/example.tex')
-rw-r--r--macros/latex/contrib/changelog/example.tex44
1 files changed, 44 insertions, 0 deletions
diff --git a/macros/latex/contrib/changelog/example.tex b/macros/latex/contrib/changelog/example.tex
new file mode 100644
index 0000000000..ad2272c5b8
--- /dev/null
+++ b/macros/latex/contrib/changelog/example.tex
@@ -0,0 +1,44 @@
+\documentclass{article}
+\usepackage{changelog}
+\begin{document}
+\begin{changelog}[author=Rebecca Turner,
+ sectioncmd=\subsection,
+ title=Example changelog]
+\begin{version}
+\added
+ \item Really cool features
+\end{version}
+
+\begin{version}[date=2019-01-23, short]
+ A version with only a date
+\end{version}
+
+\begin{version}[v=1.1.0, simple]
+ \item A version with no date
+\end{version}
+
+\begin{version}[v=1.0.1, yanked, simple]
+ \item A version with a terrible bug
+\end{version}
+
+\begin{version}[v=1.0.0, date=2018-10-26]
+\added
+ \item A cool feature
+\changed
+ \item Some \textsc{api} detail
+\deprecated
+ \item Something that was a bad idea in the first place
+\removed
+ \item Something that was deprecated 3 versions ago
+\fixed
+ \item A bug that would delete files instead of saving them
+\security
+ \item improved with addition of buffer bound checks
+\misc
+ \item A change that doesn't fit into any other category
+\end{version}
+
+\shortversion{v=0.1.0, date=2018-10-19,
+ changes=Initial beta.}
+\end{changelog}
+\end{document}