summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/changelog/example.tex
blob: ad2272c5b862a3d3eb019d410e7336f4235b36a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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}