summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex174
1 files changed, 19 insertions, 155 deletions
diff --git a/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex b/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
index 0f88d704543..e3708b7f374 100644
--- a/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
+++ b/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
@@ -4,11 +4,11 @@
This package provides means for manual change markup.
Any comments, thoughts or improvements are welcome.
-The package is maintained at \emph{sourceforge}, please see
+The package is maintained at \emph{gitlab}, please see
-\url{http://changes.sourceforge.net/}
+\url{http://edgesoft.de/projects/latex/changes/}
-for source code access, bug and feature tracker, forum etc.
+for links to source code access, bug and feature tracker, etc.
If you want to contact me directly, please send an email to \href{mailto:ekleinod@edgesoft.de}{ekleinod@edgesoft.de}.
Please start your email subject with \texttt{[changes]}.
@@ -22,6 +22,7 @@ Please start your email subject with \texttt{[changes]}.
%^^A ---- usage
+\cleardoublepage
\section{Using the \chpackage{changes}-package}
\label{sec:usage}
@@ -81,13 +82,13 @@ Now everything is set to markup the changed text.
Please use the following commands according to your change:
for newly added text:\\
-\chcommand{added[id=<id>, remark=<remark>]\{text\}}
+\chcommand{added[id=<id>, remark=<remark>]\{new text\}}
for deleted text:\\
-\chcommand{deleted[id=<id>, remark=<remark>]\{text\}}
+\chcommand{deleted[id=<id>, remark=<remark>]\{old text\}}
for replaced text:\\
-\chcommand{replaced[id=<id>, remark=<remark>]\{text\}}
+\chcommand{replaced[id=<id>, remark=<remark>]\{\meta{new text}\}\{\meta{old text}\}}
Stating the author's id and/or a remark is optional.
@@ -134,6 +135,7 @@ You can select or deselect markup from removal using the interactive mode.
Switch on the interactive mode with the script parameter \texttt{-i}.
%^^A ---- limitations
+\cleardoublepage
\section{Limitations and possible enhancements}
\label{sec:limitations}
@@ -177,6 +179,7 @@ You can have a look at the more complete list of enhancements on the \emph{sourc
%^^A ---- user interface
+\cleardoublepage
\section{User interface of the \chpackage{changes}-package}
\label{sec:user}
@@ -629,6 +632,7 @@ The following packages are sometimes required and have to be installed if used b
%^^A -- Authors -------------------------------------------------------------
+\cleardoublepage
\section{Authors}
\label{sec:authors}
@@ -638,6 +642,7 @@ The authors are (in alphabetical order):
\item Chiaradonna, Silvano
\item Giovannini, Daniele
\item Kleinod, Ekkart
+ \item Mittelbach, Frank
\item Wölfel, Philipp
\item Wolter, Steve
\end{itemize}
@@ -645,166 +650,26 @@ The authors are (in alphabetical order):
%^^A -- Versions -------------------------------------------------------------
+\cleardoublepage
\section{Versions}
\label{sec:versions}
-\minisec{Version 2.0.4}
-
-Date: 2015/04/27
-\begin{itemize}
- \item fixed error when using an unknown language
-\end{itemize}
-
-\minisec{Version 2.0.3}
-
-Date: 2014/10/15
-\begin{itemize}
- \item fixed crash when used with the amsart class
-\end{itemize}
-
-\minisec{Version 2.0.2}
-
-Date: 2013/08/13
-\begin{itemize}
- \item no changes in code or behavior
- \item fixed problem of corrupt documentation PDFs in CTAN
- \item improved/bugfixed documentation
-\end{itemize}
-
-\minisec{Version 2.0.1}
-
-Date: 2013/08/10
-\begin{itemize}
- \item no changes in code or behavior
- \item fixed upload problems with CTAN (wrong line endings)
- \item put all needed files in CTAN archive
-\end{itemize}
-
-\minisec{Version 2.0.0}
-
-Date: 2013/06/30
-\begin{itemize}
- \item ``real'' list of changes, old summary now with optional parameter \choption{style=summary}
- \item fixed problem with special characters in summary of changes
- \item renamed \chcommand{setlocextension} to \chcommand{setsocextension}
- \item new author markup \choption{none}
- \item completed script description with \texttt{-i} parameter
-\end{itemize}
-
-\minisec{Version 1.0.0}
-
-Date: 2012/04/25
-\begin{itemize}
- \item key-value-interface for change commands
- \item fixed bug (crash) with special characters in list of changes
- \item added space before author name in list of changes
- \item error message if an unknown author id is used
-\end{itemize}
-
-\minisec{Version 0.6.0}
-
-Date: 2012/01/11
-\begin{itemize}
- \item Italian translations of captions by Daniele Giovannini
- \item redefined user interface for setting options and definitions of markup and authors
- \item restructuring and code improvement
- \item improved documentation including typical use case
- \item example files for all options and commands
- \item by default remarks are not colored anymore
-\end{itemize}
+For a list of versions and the changes within these version, please refer to
-\minisec{Version 0.5.4}
+\url{https://gitlab.com/ekleinod/changes/blob/master/changelog.md}
-Date: 2011/04/25
-\begin{itemize}
- \item extraction of user documentation in separate file
- \item default language changed to English
- \item new script for removal of \chpackage{changes} commands by Silvano Chiaradonna
-\end{itemize}
+Here you too find the implemented but not released changes for the new version.
-\minisec{Version 0.5.3}
+If you are interested in planned new features, please see
-Date: 2010/11/22
-\begin{itemize}
- \item document options of \chcommand{documentclass} are used too (suggestion and code of Steve Wolter)
-\end{itemize}
-
-\minisec{Version 0.5.2}
-
-Date: 2007/10/10
-\begin{itemize}
- \item package options for \chpackage{ulem} and \chpackage{xcolor} are passed to the packages
-\end{itemize}
-
-\minisec{Version 0.5.1}
-
-Date: 2007/08/27
-\begin{itemize}
- \item deleted text is striked out again using package \chpackage{ulem}, greying didn't work
-\end{itemize}
-
-\minisec{Version 0.5}
-
-Date: 2007/08/26
-\begin{itemize}
- \item no usage of package \chpackage{arrayjob} anymore, thus no errors using package \chpackage{array}
- \item switch to UTF-8-encoding
- \item no usage of package \chpackage{soul} anymore, thus no errors using UTF-8-encoding
- \item markup for deleted text changed to gray background, because there's no possibility to conveniently strike out UTF-8-text
- \item new optional argument for author's name
- \item colored list of changes
- \item changed loc file format
- \item improved English documentation
-\end{itemize}
-
-\minisec{Version 0.4}
-
-Date: 2007/01/24
-\begin{itemize}
- \item included \chpackage{pdfcolmk} to solve problem with colored text and page breaks
- \item extended \chcommand{setremarkmarkup} with author's id for using color in remarks
- \item by default remarks are colored now
- \item first version uploaded to CTAN
-\end{itemize}
-
-\minisec{Version 0.3}
-
-Date: 2007/01/22
-\begin{itemize}
- \item English user-documentation
- \item replaced command \chcommand{changed} with \chcommand{replaced}
- \item improved \choption{final}-option: no additional space
-\end{itemize}
-
-\minisec{Version 0.2}
-
-Date: 2007/01/17
-\begin{itemize}
- \item defined loc-names when missing \chpackage{babel}-package
- \item new commands \chcommand{setauthormarkup}, \chcommand{setlocextension}, \chcommand{setremarkmarkup}
- \item generated examples
- \item inserted LPPL
-\end{itemize}
-Bugfixes
-\begin{itemize}
- \item fixed wrong \chpackage{ifthen} package placement
- \item fixed error in loc, always showing ``added''
- \item fixed authormarkup (\chcommand{if}-condition not bugfree)
-\end{itemize}
-
-\minisec{Version 0.1}
-
-Date: 2007/01/16
-\begin{itemize}
- \item initial version
- \item commands \chcommand{added}, \chcommand{deleted}, and \chcommand{changed}
-\end{itemize}
+\url{https://gitlab.com/ekleinod/changes/milestones}
%^^A ---- copyright, license
+\cleardoublepage
\section{Distribution, Copyright, License}
-Copyright 2007-2015 Ekkart Kleinod (\href{mailto:ekleinod@edgesoft.de}{ekleinod@edgesoft.de})
+Copyright 2007-2018 Ekkart Kleinod (\href{mailto:ekleinod@edgesoft.de}{ekleinod@edgesoft.de})
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 any later version.
The latest version of this license is in \url{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.
@@ -843,4 +708,3 @@ and the derived files
%^^A end of user documentation
-