summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/latex/changelog
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-05-04 22:46:53 +0000
committerKarl Berry <karl@freefriends.org>2019-05-04 22:46:53 +0000
commitc454261d3133ff69d91828cf2411f1d830c7b249 (patch)
tree6dc4382eb53ed1dad60eb1f8646943269be92a2f /Master/texmf-dist/tex/latex/changelog
parentd1d125c560bc7daf71c625137a13fd7ee222fe03 (diff)
changelog (16apr19)
git-svn-id: svn://tug.org/texlive/trunk@50987 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/tex/latex/changelog')
-rw-r--r--Master/texmf-dist/tex/latex/changelog/changelog-doc.sty89
-rw-r--r--Master/texmf-dist/tex/latex/changelog/changelog.sty117
2 files changed, 68 insertions, 138 deletions
diff --git a/Master/texmf-dist/tex/latex/changelog/changelog-doc.sty b/Master/texmf-dist/tex/latex/changelog/changelog-doc.sty
deleted file mode 100644
index c839f386342..00000000000
--- a/Master/texmf-dist/tex/latex/changelog/changelog-doc.sty
+++ /dev/null
@@ -1,89 +0,0 @@
-\usepackage{hypdoc}
-\PassOptionsToPackage{writefile}{listings}
-\usepackage[
- loadHyperref=false,
- createIndexEntries=false
-]{doctools}
-
-\PageIndex
-\EnableCrossrefs
-
-\usepackage{lstdoc}
-\usepackage{textcomp} % needed for listings
-\usepackage{xparse}
-\usepackage{xkeyval}
-\usepackage{changepage}
-\usepackage{mdframed}
-
-\usepackage[color]{changelog}
-
-\errorcontextlines 10
-
-\newcommand{\email}[1]{\href{mailto:#1}{\texttt{#1}}}
-\newcommand{\https}[1]{\href{https://#1}{\texttt{#1}}}
-\newcommand{\todo}[1]{\begin{itemize}\item[\textbf{To-do:}] #1 \end{itemize}}
-\newcommand{\note}[1]{\begin{itemize}\item[\textbf{Note:}] #1 \end{itemize}}
-\newcommand{\ctan}[1]{\href{https://ctan.org/pkg/#1}{\package{#1}}}
-\NewExpandableDocumentCommand{\Th}{O{l} m}
- {\multicolumn{1}{#1}{\textbf{#2}}}
-\newcommand{\ext}[1]{\texttt{.#1}}
-\newcommand{\filename}[1]{\texttt{#1}}
-\newcommand{\noterepo}[1]{\note{Browse the sources, contribute, or complain at \\
- \https{github.com/#1}}}
-
-\newcommand{\cl}{\ctan{changelog}}
-\newcommand{\keepachangelog}{\https{keepachangelog.com}}
-
-% definition copied from doc package \DescribeMacro
-\lstnewenvironment{latexfile}[1]
- {\lstset{style=lstDemoStyleLaTeXCode}%
- }
- {}
-
-\NewDocumentEnvironment{ctandescription}{}
- {\NewDocumentCommand{\pkg}{m}{\item[\ctan{##1}]}
- \begin{description}}
- {\end{description}}
-
-% a list of colors; use \color{colorname}
-\newenvironment{colorlist}
- {\begin{itemize}
- \let\old@item\item
- \renewcommand{\item}[1]{%
- \old@item[\fcolorbox{black}{##1}{\vphantom{X}\hspace{1em}}]
- \texttt{##1}
- }
- }
- {\end{itemize}}
-
-\newif\ifsidebyside@first
-\newcommand{\sidebyside@maybehfill}{%
- \ifsidebyside@first
- \hfill
- \sidebyside@firstfalse
- \fi
-}
-\newenvironment{sidebyside}{%
-
- \lstnewenvironment{code}[1][]{%
- \lstset{style=lstDemoStyleLaTeXCode,
- basicstyle=\ttfamily\small,
- frame=single,
- linewidth=0.45\linewidth,
- ##1}%
- }
- {%
- \sidebyside@maybehfill
- }%
- \newenvironment{example}{%
- \begin{mdframed}[userdefinedwidth=0.45\linewidth]
- }
- {%
- \end{mdframed}\sidebyside@maybehfill
- }%
- \sidebyside@firsttrue
- \medskip
- \noindent
- }
- {%
- }
diff --git a/Master/texmf-dist/tex/latex/changelog/changelog.sty b/Master/texmf-dist/tex/latex/changelog/changelog.sty
index 53e7299bb90..403ebbddbde 100644
--- a/Master/texmf-dist/tex/latex/changelog/changelog.sty
+++ b/Master/texmf-dist/tex/latex/changelog/changelog.sty
@@ -1,52 +1,40 @@
-\ProvidesPackage{changelog}[2018-12-28 1.0.0 Typesetting changelogs]
+\ProvidesPackage{changelog}[2019/04/15 2.0.0 Typesetting changelogs]
% Description: Provides the changelog environment for typesetting changelogs
-% License: GPL-3.0
+% License: LPPL 1.3c
% Homepage: https://github.com/9999years/latex-changelog
% https://ctan.org/pkg/changelog
% Maintainer: Rebecca Turner <637275@gmail.com>
-
-\newif\ifchangelog@color\changelog@colorfalse
-\DeclareOption{color}{\changelog@colortrue}
-\ProcessOptions
-
-\ifchangelog@color
- \RequirePackage{xcolor}
-
- \colorlet{ChangelogAdded} {green}
- \colorlet{ChangelogChanged} {blue}
- \colorlet{ChangelogDeprecated}{orange}
- \colorlet{ChangelogRemoved} {red}
- \colorlet{ChangelogFixed} {cyan}
- \colorlet{ChangelogSecurity} {magenta}
- \colorlet{ChangelogMiscellaneous}{.}
-
- \newcommand{\changelog@yanked@pre}{\color{ChangelogSecurity}}
- % parameter = item type (Added, Changed, etc.)
- \newcommand{\changelog@item@preitem}[1]{\color{Changelog#1}}
- \newcommand{\changelog@item@postitem}{\hspace{0pt}}
-\else
- \newcommand{\changelog@yanked@pre}{}
- \newcommand{\changelog@item@preitem}[1]{}
- \newcommand{\changelog@item@postitem}{}
-\fi
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status `maintained'.
+%
+% The Current Maintainer of this work is Rebecca Turner <637275@gmail.com>.
+%
+% This work consists of the files changelog.sty and changelog.tex.
+
+\RequirePackage{xparse}
+\RequirePackage{xkeyval}
\newif\ifchangelog@versionfirst
-\newcommand{\changelog@item@pre}{%
+\newcommand{\changelog@item}[1]{%
+ \noindent
\ifchangelog@versionfirst
\changelog@versionfirstfalse
\else
\end{changelogitemize}
\fi
-}
-
-\newcommand{\changelog@item}[1]{%
- \noindent
- \changelog@item@pre
- {\changelog@item@preitem{#1}\textbf{#1}}\changelog@item@postitem
+ \textbf{#1}%
\begin{changelogitemize}%
}
-\newcommand{\changelogyanked}{{\changelog@yanked@pre\fbox{\textbf{YANKED}}}}
+\newcommand{\changelogyanked}{\fbox{\textbf{YANKED}}}
\newcommand{\changelog@sectioncmds}{
\newcommand{\added} {\changelog@item{Added}}
@@ -62,6 +50,7 @@
\define@key{version}{v}{\def\cmdKV@version@version{#1}}
\define@boolkey{version}{yanked}[true]{}
\define@boolkey{version}{simple}[true]{}
+\define@boolkey{version}{short}[true]{}
\define@cmdkeys{changelog}{sectioncmd, title, label}
\define@boolkey{changelog}{section}[true]{}
@@ -118,33 +107,63 @@
\begin{changelogitemize}
\fi
}
-\newcommand{\changelog@version@post}{\end{changelogitemize}}
+\newcommand{\changelog@version@post}{%
+ \ifchangelog@versionfirst
+ \ifKV@version@simple
+ \else
+ \PackageError{changelog}{Something's wrong in version environment;
+ perhaps a missing \protect\added, \protect\changed,
+ \protect\deprecated, \protect\removed, \protect\fixed,
+ \protect\security, or \protect\misc}{A version environment needs to
+ introduce its \protect\item-ized lists with one of the provided
+ section commands; maybe you meant to use the [simple] option?}
+ \fi
+ \fi
+ \end{changelogitemize}%
+}
+\newif\ifchangelog@hadversion
\NewDocumentEnvironment{changelog}{o}
- {\IfValueT{#1}{\setkeys{changelog, version}{#1}}%
+ {\global\changelog@hadversionfalse
+ \IfValueT{#1}{\setkeys{changelog, version}{#1}}%
\changelog@section@maybe
%\today
% version environment; wraps a list
- \NewDocumentEnvironment{version}{ O{} }
+ \NewDocumentEnvironment{version}{ O{} }%
{\setkeys{version}{##1}%
\@shortversion
- \changelog@version@pre}
- {\changelog@version@post}%
+ \ifKV@version@short
+ \else
+ \changelog@version@pre
+ \fi}
+ {\ifKV@version@short
+ \else
+ \changelog@version@post
+ \fi}%
% doesn't set keys so this can share code with the version
% environment
- \NewDocumentCommand{\@shortversion}{}{{%
+ \NewDocumentCommand{\@shortversion}{}{%
\changelog@shortversion@definedate
- \item[\changelog@shortversion@item]
- \changelog@shortversion@authordate
- \@ifundefined{cmdKV@version@changes}{}{ --- \cmdKV@version@changes}
- }}
+ \global\changelog@hadversiontrue
+ \item[\changelog@shortversion@item]%
+ \changelog@shortversion@authordate
+ \ifKV@version@short
+ \ ---
+ \@ifundefined{cmdKV@version@changes}{}{\cmdKV@version@changes}%
+ \fi
+ }%
% short version; "like" a 1-bullet list
% extra braces keep command definitions local
- \NewDocumentCommand{\shortversion}{m}{{
- \setkeys{version}{##1}%
+ \NewDocumentCommand{\shortversion}{m}{{%
+ \setkeys{version}{##1, short}%
\@shortversion
- }}
+ }}%
\begin{changelogdescription}}
- {\end{changelogdescription}}
+ {\ifchangelog@hadversion
+ \else
+ \PackageError{changelog}{No versions in changelog environment body}{A
+ changelog environment must have at least one version or shortversion in
+ it.}%
+ \fi\end{changelogdescription}}