diff options
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.tex | 77 |
1 files changed, 61 insertions, 16 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 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} |