changes (22jul19)

git-svn-id: svn://tug.org/texlive/trunk@51705 c570f23f-e606-0410-a88d-b1316a301751

9 files changed, 151 insertions, 47 deletions

diff --git a/Master/texmf-dist/doc/latex/changes/README b/Master/texmf-dist/doc/latex/changes/README
index 033b5695c24..b14ada07dfb 100644
--- a/Master/texmf-dist/doc/latex/changes/README
+++ b/Master/texmf-dist/doc/latex/changes/README
@@ -10,10 +10,11 @@ Zusätzlich kann Text hervorgehoben und/oder kommentiert werden.
 Das Paket ermöglicht die freie Definition von Autoren und deren zugeordneten Farben.
 Es erlaubt zusätzlich die Änderung des Änderungs-, Autor-, Hervorhebungs- und Kommentarmarkups.
 
+Autor/author: Ekkart Kleinod <ekleinod@edgesoft.de>
 Internet: http://changes.sourceforge.net/
 
-This material is subject to the LaTeX Project Public License (LPPL).
+This material is subject to the LaTeX Project Public License (LPPL 1.3 or any later version).
 For more details please refer to the user documentation changes.english.pdf
 
-Dieses Paket steht unter der LaTeX Project Public License (LPPL).
+Dieses Paket steht unter der LaTeX Project Public License (LPPL 1.3 oder jeder späteren Version).
 Für Details lesen Sie bitte die Nutzerdokumentation changes.ngerman.pdf
diff --git a/Master/texmf-dist/doc/latex/changes/changes.english.pdf b/Master/texmf-dist/doc/latex/changes/changes.english.pdf
index 3241f91d583..9c82f24bef5 100644
--- a/Master/texmf-dist/doc/latex/changes/changes.english.pdf
+++ b/Master/texmf-dist/doc/latex/changes/changes.english.pdf
diff --git a/Master/texmf-dist/doc/latex/changes/changes.english.withcode.pdf b/Master/texmf-dist/doc/latex/changes/changes.english.withcode.pdf
index c2aa89c4dae..9a7fd6423da 100644
--- a/Master/texmf-dist/doc/latex/changes/changes.english.withcode.pdf
+++ b/Master/texmf-dist/doc/latex/changes/changes.english.withcode.pdf
diff --git a/Master/texmf-dist/doc/latex/changes/changes.ngerman.pdf b/Master/texmf-dist/doc/latex/changes/changes.ngerman.pdf
index aeb8198f716..638fea2946c 100644
--- a/Master/texmf-dist/doc/latex/changes/changes.ngerman.pdf
+++ b/Master/texmf-dist/doc/latex/changes/changes.ngerman.pdf
diff --git a/Master/texmf-dist/doc/latex/changes/userdoc/changes.de.tex b/Master/texmf-dist/doc/latex/changes/userdoc/changes.de.tex
index 63825f9cc29..f63ad7309d4 100644
--- a/Master/texmf-dist/doc/latex/changes/userdoc/changes.de.tex
+++ b/Master/texmf-dist/doc/latex/changes/userdoc/changes.de.tex
@@ -199,6 +199,9 @@ In diesem Fall gehen Sie bitte zu
 
 Dort finden Sie Links, wie Fehler oder Verbesserungen gemeldet werden können, wie Tips für andere Nutzerinnen angegeben werden können oder wie Sie bei der Entwicklung des Pakets mithelfen können.
 
+Eine Übersicht über alle mir bekannten Probleme und eventuell vorhandenen Lösungen finden Sie in \autoref{sec:known-problems}.
+Bitte sehen Sie dort zunächst nach, ob Ihr Problem schon bekannt ist und es eine Lösung gibt.
+
 Sie können mir auch eine Mail schreiben an \href{mailto:ekleinod@edgesoft.de}{ekleinod@edgesoft.de}, in diesem Fall starten Sie bitte Ihr Mail-Subject mit \texttt{[changes]}.
 
 Die Änderungsmarkierung von Text funktioniert recht gut, es können auch ganze Absätze markiert werden.
@@ -212,25 +215,10 @@ Die Markierung ist eingeschränkt oder nicht möglich für:
 	\item mehrere Absätze (manchmal)
 \end{itemize}
 
-
 Sie können versuchen, solchen Text in eine eigene Datei auszulagern, und diese mit \texttt{input} einzubinden.
 Manchmal hilft das, oft ist es einen Versuch wert.
 Danke an Charly Arenz für diesen Tip.
 
-Fußnoten oder Randnotizen werden in bestimmten Umgebungen, \zB Tabellen oder der \emph{tabbing}-Umgebung, nicht korrekt gesetzt.
-Vermeiden Sie das Markup, wenn Sie diese Umgebungen benutzen.
-
-Das Paket bietet Raum für Erweiterungen, die ich ich jedoch nicht selbst programmieren werde (weil mir Zeit und oft auch die Fähigkeit fehlt).
-Ich liste hier einige Möglichkeiten auf, die aktuelle Liste finden Sie im Issue-Tracker auf \emph{gitlab}:
-
-\begin{itemize}
-	\item Auswahl der anzunehmenden/abzulehnenden Änderungen mit entsprechendem Löschen des Textes
-	\item Markierung von mehreren Absätzen
-	\item Markierung von Bildern und Tabellen
-	\item automatische Markierung anhand von diff-Informationen (unter Berücksichtigung der Einschränkungen bzgl.\ Absätzen, Bildern, etc.)
-	\item Übersetzung der sprachabhängigen Texte und der Nutzerdokumentation in andere Sprachen
-\end{itemize}
-
 
 
 %^^A ---- user interface
@@ -331,6 +319,7 @@ Die Ausgabe ersetzten Texts ist ein Kombination von zugefügtem und gelöschten
 
 
 \subsubsection{deletedmarkup}
+\label{sec:ui:options:deletedmarkup}
 
 \chinline{usepackage_deletedmarkup_changes}
 
@@ -505,7 +494,6 @@ Mehrere Optionen oder Angaben mit Sonderzeichen müssen in geschweifte Klammern
 \localtableofcontents
 
 \chnewcmd{added}
-\label{sec:ui:cmd:added}
 
 \chinline{added}
 
@@ -874,6 +862,59 @@ Die folgenden Pakete sind manchmal notwendig und müssen installiert sein, wenn
 \end{description}
 
 
+%^^A ---- Known problems and solutions
+\cleardoublepage
+\section{Bekannte Probleme und Lösungen}
+\label{sec:known-problems}
+
+In diesem Kapitel sammle ich die häufigsten Probleme und mir dazu bekannte Lösungen.
+Wenn Ihr Problem hier nicht aufgeführt ist, sehen Sie bitte im Issue-Tracker auf gitlab nach, ob das Problem dort beschrieben ist (es gibt eine Suche):
+
+\url{https://gitlab.com/ekleinod/changes/issues}
+
+Wenn das alles zu nichts führt, öffnen Sie bitte ein neues Issue für das Problem, beschreiben Sie das Problem genau und liefern Sie, wenn möglich, eine kleine Beispieldatei mit dem problematischen Verhalten mit.
+
+\subsection{Besondere Inhalte}
+
+Die Änderungsmarkierung von Text funktioniert recht gut, es können auch ganze Absätze markiert werden.
+Die Markierung ist eingeschränkt oder nicht möglich für:
+
+\begin{itemize}
+	\item Abbildungen
+	\item Tabellen
+	\item Überschriften
+	\item manche Kommandos
+	\item mehrere Absätze (manchmal)
+\end{itemize}
+
+Sie können versuchen, solchen Text in eine eigene Datei auszulagern, und diese mit \texttt{input} einzubinden.
+Manchmal hilft das, oft ist es einen Versuch wert.
+Danke an Charly Arenz für diesen Tip.
+
+\subsection{Fußnoten und Randnotizen}
+
+Fußnoten oder Randnotizen werden in bestimmten Umgebungen, \zB Tabellen oder der \emph{tabbing}-Umgebung, nicht korrekt gesetzt.
+Vermeiden Sie das Markup, wenn Sie diese Umgebungen benutzen.
+
+\subsection{Das \chpackage{ulem}-Paket}
+
+Ich verwende standardmäßig das \chpackage{ulem}-Paket für das Durchstreichen von Text.
+Das führt bei manchen Befehlen und Umgebungen zu Problemen, \zB
+
+\begin{itemize}
+	\item im Mathemodus
+	\item bei Verwendung des \chpackage{siunitx}-Pakets
+	\item bei Nutzung der \chcommand{citet}- oder \chcommand{citep}-Befehle
+\end{itemize}
+
+In dem Fall gibt es wenig gute Möglichkeiten, am besten ist es, das Markup für Löschungen selbst zu definieren und das \chpackage{ulem}-Paket zu vermeiden.
+Siehe
+
+\begin{itemize}
+	\item \autoref{sec:ui:options:deletedmarkup}
+	\item \autoref{sec:ui:cmd:setdeletedmarkup}
+\end{itemize}
+
 %^^A ---- Authors
 \cleardoublepage
 \section{Autorinnen und Autoren}
@@ -937,7 +978,7 @@ Dieses Paket besteht aus den Dateien
 	\>\texttt{source/latex/changes/README}\\
 	\>\texttt{source/latex/changes/userdoc/*.tex}\\
 
-	\>\texttt{scripts/changes/delcmdchanges.bash}
+	\>\texttt{scripts/changes/pyMergeChanges.py}
 \end{tabbing}
 
 
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 fb767a4f3de..2a6fb3964ad 100644
--- a/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
+++ b/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
@@ -202,6 +202,9 @@ In that case, please go to
 
 There you find information on how to report errors or improvements, give advice to other users, or participate in the development of the package.
 
+You can find a list of known problems and possible solutions in \autoref{sec:known-problems}.
+Please refer to the section first if your problem is known and is a solution exists.
+
 You can write me an email too, please send it to \href{mailto:ekleinod@edgesoft.de}{ekleinod@edgesoft.de}.
 In that case, please start your email subject with \texttt{[changes]}.
 
@@ -220,21 +223,6 @@ You can try putting such text in an extra file and include in with \texttt{input
 This works sometimes, give it a try.
 Kudos to Charly Arenz for this tip.
 
-There is a problem of typesetting footnotes or margin notes in special environments, such as tables or tabbings.
-Avoid such markup when using these environments.
-
-There are several possibilities of enhancing the \chpackage{changes}-package.
-I will describe but a few here, I will not implement them due to lack of time and/or skill.
-You can have a look at the complete list of enhancements in the issue tracker of \emph{gitlab}.
-
-\begin{itemize}
-	\item selecting of acknowledged and rejected texts; deletion of the corresponding markup
-	\item markup of more than one paragraph
-	\item markup of figures and tables
-	\item automatic markup based on diff information (with regard to the limitations, such as markup of paragraphs, figures etc.)
-	\item translation of language dependent texts and the user documentation in other languages
-\end{itemize}
-
 
 %^^A ---- user interface
 \cleardoublepage
@@ -336,6 +324,7 @@ The output of replaced text is a combination of added and deleted text, thus any
 
 
 \subsubsection{deletedmarkup}
+\label{sec:ui:options:deletedmarkup}
 
 \chinline{usepackage_deletedmarkup_changes}
 
@@ -878,6 +867,62 @@ The following packages are sometimes required and have to be installed if used b
 \end{description}
 
 
+%^^A ---- Known problems and solutions
+\cleardoublepage
+\section{Known problems and solutions}
+\label{sec:known-problems}
+
+This section contains known problems and their solutions as far as I know some.
+If your problem is not listed here, please see the issue tracker on gitlab if it contains your problem (a search exists):
+
+\url{https://gitlab.com/ekleinod/changes/issues}
+
+If your problem is not listed, please open a new issue for your problem.
+Describe your problem as specific as possible, if possible, include a small example file with the problematic behavior.
+
+\subsection{Special content}
+
+Change markup of texts works well, it is possible to markup whole paragraphs.
+You cannot markup:
+
+\begin{itemize}
+	\item figures
+	\item tables
+	\item headings
+	\item some commands
+	\item several paragraphs (sometimes)
+\end{itemize}
+
+You can try putting such text in an extra file and include in with \texttt{input}.
+This works sometimes, give it a try.
+Kudos to Charly Arenz for this tip.
+
+\subsection{Footnotes and margin notes}
+
+There is a problem of typesetting footnotes or margin notes in special environments, such as tables or tabbings.
+Avoid such markup when using these environments.
+
+
+\subsection{The \chpackage{ulem} package}
+
+I am using the \chpackage{ulem} package for striking out text as default.
+This leads to problems with some commands or environments, e.g.
+
+\begin{itemize}
+	\item in math mode
+	\item when using the \chpackage{siunitx} package
+	\item when using the \chcommand{citet} or \chcommand{citep} command
+\end{itemize}
+
+In that case there are only a few good solutions, the best way is to avoid using the \chpackage{ulem} package by defining your own deletion markup.
+See
+
+\begin{itemize}
+	\item \autoref{sec:ui:options:deletedmarkup}
+	\item \autoref{sec:ui:cmd:setdeletedmarkup}
+\end{itemize}
+
+
 %^^A -- Authors -------------------------------------------------------------
 \cleardoublepage
 \section{Authors}
@@ -941,7 +986,7 @@ This work consists of the files
 	\>\texttt{source/latex/changes/README}\\
 	\>\texttt{source/latex/changes/userdoc/*.tex}\\
 
-	\>\texttt{scripts/changes/delcmdchanges.bash}
+	\>\texttt{scripts/changes/pyMergeChanges.py}
 \end{tabbing}
 
 
diff --git a/Master/texmf-dist/source/latex/changes/changes.drv b/Master/texmf-dist/source/latex/changes/changes.drv
index 3e043757a86..13ee48a492e 100644
--- a/Master/texmf-dist/source/latex/changes/changes.drv
+++ b/Master/texmf-dist/source/latex/changes/changes.drv
@@ -260,11 +260,11 @@
 % document title
 \ifENGLISH
 	\title{The \chpackage{changes}-package}
-	\subtitle{Manual change markup --- version 3.1.2}
+	\subtitle{Manual change markup --- version 3.1.3}
 \fi
 \ifGERMAN
 	\title{Das \chpackage{changes}-Paket}
-	\subtitle{Manuelle Änderungsmarkierung -- Version 3.1.2}
+	\subtitle{Manuelle Änderungsmarkierung -- Version 3.1.3}
 \fi
 
 \author{Ekkart Kleinod}
@@ -279,4 +279,3 @@
 	\DocInput{changes.dtx}
 
 \end{document}
-
diff --git a/Master/texmf-dist/source/latex/changes/changes.dtx b/Master/texmf-dist/source/latex/changes/changes.dtx
index c5aab1a552c..1ca69d8a931 100644
--- a/Master/texmf-dist/source/latex/changes/changes.dtx
+++ b/Master/texmf-dist/source/latex/changes/changes.dtx
@@ -1,4 +1,4 @@
-% \CheckSum{1509}
+% \CheckSum{1510}
 %
 % \iffalse meta-comment
 %
@@ -58,6 +58,7 @@
 % \changes{v3.1.0}{2018/12/17}{new script for markup removal, improved user manual}
 % \changes{v3.1.1}{2018/12/18}{bugfix: uneven dot fills in summaries}
 % \changes{v3.1.2}{2019/01/26}{bugfix: problems with amsart class}
+% \changes{v3.1.3}{2019/07/21}{bugfix: option clash for ulem and truncate; documentation of known problems and solutions}
 % \GetFileInfo{changes.dtx}
 % \RecordChanges
 %
@@ -98,8 +99,8 @@
 %    \begin{macrocode}
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{changes}
-[2019/01/26 v3.1.2 changes package]
-\typeout{*** changes package 2019/01/26 v3.1.2 ***}
+[2019/07/21 v3.1.3 changes package]
+\typeout{*** changes package 2019/07/21 v3.1.3 ***}
 %    \end{macrocode}
 %
 % Package \chpackage{xkeyval} provides options with key-value-pairs.
@@ -500,6 +501,17 @@
 }{}
 %    \end{macrocode}
 %
+% \subsubsection{Package options}
+%
+% In order to avoid option clashes for options, state them here instead at the moment of requiring the package.
+% Thanks for Markus Pahlow for pointing this out and providing the solution.
+%    \begin{macrocode}
+\ExecuteOptionsX{
+	ulem={normalem,normalbf},
+	truncate={breakall,fit}
+}
+%    \end{macrocode}
+%
 % \subsubsection{Option processing}
 %
 % Process the options.
@@ -531,6 +543,7 @@
 %    \end{macrocode}
 %
 % Package \chpackage{ulem} provides commands for striking out text.
+% Providing the needed package options via \chcommand{ExecuteOptionsX}.
 %    \begin{macrocode}
 \ifthenelse{
 	\equal{\Changes@optionaddedmarkup}{uline}\or
@@ -549,7 +562,7 @@
 	\equal{\Changes@optionhighlightmarkup}{uuline}\or
 	\equal{\Changes@optionhighlightmarkup}{uwave}
 }
-	{\RequirePackage[normalem,normalbf]{ulem}}
+	{\RequirePackage{ulem}}
 	{}
 %    \end{macrocode}
 %
@@ -1461,8 +1474,9 @@
 %
 % The list of changes truncates text, therefore the \chpackage{truncate} package is used.
 % (Using fit and redefining the marker: suggestion and code by Frank Mittelbach)
+% Providing the needed package options via \chcommand{ExecuteOptionsX}.
 %    \begin{macrocode}
-\RequirePackage[breakall,fit]{truncate}
+\RequirePackage{truncate}
 \renewcommand\TruncateMarker{ [\dots\negthinspace]\ }
 %    \end{macrocode}
 %
diff --git a/Master/texmf-dist/tex/latex/changes/changes.sty b/Master/texmf-dist/tex/latex/changes/changes.sty
index 98b944858b2..2d96799dd58 100644
--- a/Master/texmf-dist/tex/latex/changes/changes.sty
+++ b/Master/texmf-dist/tex/latex/changes/changes.sty
@@ -41,8 +41,8 @@
 %% 
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{changes}
-[2019/01/26 v3.1.2 changes package]
-\typeout{*** changes package 2019/01/26 v3.1.2 ***}
+[2019/07/21 v3.1.3 changes package]
+\typeout{*** changes package 2019/07/21 v3.1.3 ***}
 \RequirePackage{xkeyval}
 \RequirePackage{xifthen}
 \RequirePackage{xstring}
@@ -285,6 +285,10 @@ style=list,
 title=\@empty,
 show=all,
 }{}
+\ExecuteOptionsX{
+ulem={normalem,normalbf},
+truncate={breakall,fit}
+}
 \ProcessOptionsX*\relax
 \newtest{\isColored}{%
 \not\equal{\Changes@optionmarkup}{nocolor}%
@@ -312,7 +316,7 @@ show=all,
 \equal{\Changes@optionhighlightmarkup}{uuline}\or
 \equal{\Changes@optionhighlightmarkup}{uwave}
 }
-{\RequirePackage[normalem,normalbf]{ulem}}
+{\RequirePackage{ulem}}
 {}
 \ifthenelse{
 \equal{\Changes@optioncommentmarkup}{todo}
@@ -789,7 +793,7 @@ show=all,
 {\changescommentname}%
 {#2}%
 }
-\RequirePackage[breakall,fit]{truncate}
+\RequirePackage{truncate}
 \renewcommand\TruncateMarker{ [\dots\negthinspace]\ }
 \def\changes@chopline#1;#2;#3;#4;#5;#6;#7;#8 \\{%
 \def\Changes@InID{#1}%