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.tex49
1 files changed, 29 insertions, 20 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 751f4aa391f..a9853fbef12 100644
--- a/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
+++ b/Master/texmf-dist/doc/latex/changes/userdoc/changes.en.tex
@@ -202,7 +202,7 @@ You cannot markup:
\item tables
\item headings
\item some commands
- \item several paragraphs (sometimes)
+ \item multiple paragraphs (sometimes)
\end{itemize}
You can try putting such text in an extra file and include in with \texttt{input}.
@@ -699,6 +699,25 @@ The package predefines one anonymous author without id.
\localtableofcontents
+\subsubsection{Values for markup command definitions}
+
+If you want to adapt the markup output, you can use any \hologo{LaTeX}-commands and special values resp.\ macros of the \docpackage{changes} package.
+Some values or macros are specific for each command, they are described in the corresponding sections.
+
+The following values and macros can be used in each command:
+
+\begin{itemize}
+ \item any \hologo{LaTeX}-commands
+ \item author's color can be used with color ``authorcolor''
+ \item boolean test if colored change output is needed ``\doccommand{IfIsColored}''
+\end{itemize}
+
+I do not provide full access to all elements of the markup for every command in order to keep the macros simple.
+For example, the author's id is only available for \doccommand{setcommentmarkup}.
+
+The output of replaced text is a combination of added and deleted text.
+
+
\chnewcmd{setaddedmarkup}
\chinline{setaddedmarkup}
@@ -709,7 +728,6 @@ The default markup is colored text, or the markup set with the option \docoption
Values for definition:
\begin{itemize}
- \item any \hologo{LaTeX}-commands
\item added text can be used with ``\#1''
\end{itemize}
@@ -728,7 +746,6 @@ The default markup is striked-out, or the markup set with the option \docoption{
Values for definition:
\begin{itemize}
- \item any \hologo{LaTeX}-commands
\item deleted text can be used with ``\#1''
\end{itemize}
@@ -747,10 +764,7 @@ The default markup is via a background color, or the markup set with the option
Values for definition:
\begin{itemize}
- \item any \hologo{LaTeX}-commands
\item highlighted text can be used with ``\#1''
- \item \docpackage{ifthenelse} boolean test for colored text ``\doccommand{isColored}''
- \item author's color can be used with color ``authorcolor''
\end{itemize}
\chexample{sethighlightmarkup}
@@ -766,14 +780,11 @@ The default markup is a margin note, or the markup set with the option \docoptio
Values for definition:
\begin{itemize}
- \item any \hologo{LaTeX}-commands
\item comment can be used with ``\#1''
\item author's id can be used with ``\#2''
\item author output (id or name) can be used with ``\#3''
- \item \docpackage{ifthenelse} boolean test for anonymous author ``\doccommand{isAnonymous}''
- \item \docpackage{ifthenelse} boolean test for colored text ``\doccommand{isColored}''
- \item author's color can be used with color ``authorcolor''
\item comment count of the autor can be used with counter ``authorcommentcount''
+ \item boolean test if author is anonymous ``\doccommand{IfIsAnonymous}''
\end{itemize}
\chexample{setcommentmarkup}
@@ -789,7 +800,6 @@ The default markup is a superscripted author's text.
Values for definition:
\begin{itemize}
- \item any \hologo{LaTeX}-commands
\item author output (id or name) can be used with ``\#1''
\end{itemize}
@@ -982,14 +992,14 @@ 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.
+There is a problem of typesetting footnotes or margin notes in special environments, such as tables or the \emph{tabbing} environment.
+Avoid this type of markup when using these environments.
\subsection{The \docpackage{ulem} package}
I am using the \docpackage{ulem} package for striking out text as default.
-This leads to problems with some commands or environments, e.g.
+This causes problems with some commands and environments, e.g.
\begin{itemize}
\item in math mode
@@ -997,7 +1007,7 @@ This leads to problems with some commands or environments, e.g.
\item when using the \doccommand{citet} or \doccommand{citep} command
\end{itemize}
-In that case there are only a few good solutions, the best way is to avoid using the \docpackage{ulem} package by defining your own deletion markup.
+In that case there are few good options, the best is to define the markup for deletions yourself and avoid the ulem package.
See
\begin{itemize}
@@ -1008,13 +1018,12 @@ See
\subsection{Command already defined}
-Some package define the markup commands as well, especially \doccommand{comment} and \doccommand{highlight} are not exclusively used by \docpackage{changes}.
-
-If needed, \docpackage{changes} can prefix it's markup commands in order to avoid name clashes.
-This is set with the option \docoption{commandnameprefix}, see \autoref{sec:ui:options:commandnameprefix} for the documentation.
+Some packages use the same names for their commands as the \docpackage{changes} package, in particular \doccommand{comment} and \doccommand{highlight} are not originally named commands.
-In order for this to work, the \docpackage{changes} package has to be used after the other package defining the command.
+In this case, \docpackage{changes} may prefix its commands to avoid naming collisions.
+This is controlled by the \docoption{commandnameprefix} option, see \autoref{sec:ui:options:commandnameprefix} for the documentation.
+In order for this to work, the \docpackage{changes} package has to be loaded after the other packages or \docoption{commandnameprefix=always} must be selected.
%^^A -- Authors -------------------------------------------------------------