CTAN Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/changelog

README.md

The changelog pack­age

Changel­ogs are im­por­tant. Un­for­tu­nately, there are few fa­cil­i­ties for type­set­ting changel­ogs in . changelog de­fines a changelog en­vi­ron­ment to make changel­ogs sim­ple and in­tu­itive.

In­spired by keep­achangelog.com.

File De­scrip­tion
changelog.sty The changelog pack­age
changelog.pdf Doc­u­men­ta­tion (English)
changelog.tex Doc­u­men­ta­tion source
changelog-doc.sty Doc­u­men­ta­tion styles
README.md This file
LICENSE.md GNU GPLv3

Ex­am­ple

\documentclass{article}
\usepackage[color]{changelog}
\begin{document}
\begin{changelog}[author=Rebecca Turner]
\begin{version}
  \added Really cool features
\end{version}
\begin{version}[date=2019-01-23]
  \item A version with only a date
\end{version}
\begin{version}[v=1.1.0]
  \item A version with no date
\end{version}
\begin{version}[v=1.0.1, yanked]
  \item A version with a terrible bug
\end{version}
\begin{version}[v=1.0.0, date=2018-10-26]
  \added a cool feature
  \changed some \textsc{api} detail
  \deprecated something that was a bad idea in the first place
  \removed something that was deprecated 3 versions ago
  \fixed a bug that would delete files instead of saving them
  \security improved with addition of buffer bound checks
  \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}

Which ren­ders roughly as:Rendered changelog

Down­load the con­tents of this pack­age in one zip archive (246.8k).

changelog – Pro­vides a changelog en­vi­ron­ment

This pack­age pro­vides a changelog en­vi­ron­ment (which it­self pro­vides a ver­sion en­vi­ron­ment) to rep­re­sent a changelog. The pack­age sup­ports mul­ti­ple au­thors, un­re­leased changes, and yanked (re­voked) re­leases.

In­spired by keep­achangelog.com.

Pack­agechangelog
Bug trackerhttps://github.com/9999years/la­tex-changelog/is­sues
Re­pos­i­toryhttps://github.com/9999years/la­tex-changelog
Ver­sion1.0.0
Li­censesGNU Gen­eral Public Li­cense, ver­sion 3
Main­tainerRe­becca Turner
Con­tained inTeX Live as changelog
MiKTeX as changelog
TopicsVer­sion con­trol
Doc­u­ment Man­age­ment
...
Guest Book Sitemap Contact Contact Author