From 7ec5d00f29a58da3fda317de7ba27b155efa8f7c Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 30 Apr 2012 23:32:45 +0000 Subject: changes 1.0.0 (27apr12) git-svn-id: svn://tug.org/texlive/trunk@26165 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/source/latex/changes/changes.drv | 4 +- Master/texmf-dist/source/latex/changes/changes.dtx | 171 +++++++++++++++------ Master/texmf-dist/source/latex/changes/changes.ins | 3 +- .../texmf-dist/source/latex/changes/examples.dtx | 15 +- .../source/latex/changes/userdoc/changes.de.tex | 58 ++++--- .../source/latex/changes/userdoc/changes.en.tex | 46 +++--- .../latex/changes/userdoc/files_generated.tex | 1 - 7 files changed, 199 insertions(+), 99 deletions(-) (limited to 'Master/texmf-dist/source/latex') diff --git a/Master/texmf-dist/source/latex/changes/changes.drv b/Master/texmf-dist/source/latex/changes/changes.drv index 91176e5a17f..61c8a9b8521 100644 --- a/Master/texmf-dist/source/latex/changes/changes.drv +++ b/Master/texmf-dist/source/latex/changes/changes.drv @@ -91,11 +91,11 @@ % document title \ifENGLISH \title{The \chpackage{changes}-package} - \subtitle{Manual change markup --- version 0.6.0} + \subtitle{Manual change markup --- version 1.0.0} \fi \ifGERMAN \title{Das \chpackage{changes}-Paket} - \subtitle{Manuelle Änderungsmarkierung -- Version 0.6.0} + \subtitle{Manuelle Änderungsmarkierung -- Version 1.0.0} \fi \author{Ekkart Kleinod} diff --git a/Master/texmf-dist/source/latex/changes/changes.dtx b/Master/texmf-dist/source/latex/changes/changes.dtx index 1fc50b29ccc..b437f0d248d 100644 --- a/Master/texmf-dist/source/latex/changes/changes.dtx +++ b/Master/texmf-dist/source/latex/changes/changes.dtx @@ -1,4 +1,4 @@ -% \CheckSum{822} +% \CheckSum{860} % % \iffalse meta-comment % @@ -47,6 +47,7 @@ % \changes{v0.5.3}{2010/11/22}{use class options (final, draft) as well} % \changes{v0.5.4}{2011/04/25}{extract user documentation; default language changed to English; script for removal of commands} % \changes{v0.6.0}{2012/01/11}{redefined user interface for setting options, markup, authors; newly structured documentation} +% \changes{v1.0.0}{2012/04/25}{key-value-interface for change commands; special characters in list of changes} % \GetFileInfo{changes.dtx} % \RecordChanges % @@ -86,8 +87,8 @@ % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{changes} -[2012/01/11 v0.6.0 changes-Paket] -\typeout{*** changes-Paket 2012/01/11 v0.6.0 ***} +[2012/04/25 v1.0.0 changes-Paket] +\typeout{*** changes-Paket 2012/04/25 v1.0.0 ***} % \end{macrocode} % % Package \chpackage{xkeyval} provides options with key-value-pairs. @@ -309,6 +310,8 @@ % % All options for commands (e.g. \chcommand{definechangesauthor}) have to be declared before option processing. % +% \minisec{\chcommand{definechangesauthor}} +% % Declare available options of the command, define value storage. % \begin{macrocode} \DeclareOptionX{name}{\def\Changes@definechangesauthor@name{#1}} @@ -323,6 +326,54 @@ }{} % \end{macrocode} % +% \minisec{\chcommand{added}} +% +% Declare available options of the command, define value storage. +% \begin{macrocode} +\DeclareOptionX{id}{\def\Changes@added@id{#1}} +\DeclareOptionX{remark}{\def\Changes@added@remark{#1}} +% \end{macrocode} +% +% Set the default values of the options. +% \begin{macrocode} +\presetkeys{Changes@added}{ + id=\@empty, + remark=\@empty +}{} +% \end{macrocode} +% +% \minisec{\chcommand{deleted}} +% +% Declare available options of the command, define value storage. +% \begin{macrocode} +\DeclareOptionX{id}{\def\Changes@deleted@id{#1}} +\DeclareOptionX{remark}{\def\Changes@deleted@remark{#1}} +% \end{macrocode} +% +% Set the default values of the options. +% \begin{macrocode} +\presetkeys{Changes@deleted}{ + id=\@empty, + remark=\@empty +}{} +% \end{macrocode} +% +% \minisec{\chcommand{replaced}} +% +% Declare available options of the command, define value storage. +% \begin{macrocode} +\DeclareOptionX{id}{\def\Changes@replaced@id{#1}} +\DeclareOptionX{remark}{\def\Changes@replaced@remark{#1}} +% \end{macrocode} +% +% Set the default values of the options. +% \begin{macrocode} +\presetkeys{Changes@replaced}{ + id=\@empty, + remark=\@empty +}{} +% \end{macrocode} +% % \subsubsection{Option processing} % % Process the options. @@ -448,7 +499,7 @@ % \begin{macrocode} \newcounter{Changes@AuthorCount} \setcounter{Changes@AuthorCount}{0} -\newcounter{Changes@iAuthor} +\newcounter{Changes@Author} % \end{macrocode} % % \begin{macro}{\definechangesauthor} @@ -658,7 +709,9 @@ % \item author's id % \item remark % \end{enumerate} +% Define boolean for author test. % \begin{macrocode} +\newboolean{Changes@WrongID} \newcommand{\Changes@output}[4]{% % \end{macrocode} % Output changed text if option \choption{draft} is set, otherwise output unchanged text. @@ -666,6 +719,23 @@ \ifthenelse{\boolean{Changes@optiondraft}}% {% % \end{macrocode} +% Check if the author exists, error message otherwise. +% I have the feeling that this code is optimizable. +% \begin{macrocode} + \setboolean{Changes@WrongID}{true}% + \setcounter{Changes@Author}{0}% + \whiledo{\value{Changes@Author} < \value{Changes@AuthorCount}}{% + \stepcounter{Changes@Author}% + \ifthenelse{\equal{#3}{\@nameuse{Changes@AuthorID\theChanges@Author}}}% + {\setboolean{Changes@WrongID}{false}}% + {}% + }% + \ifthenelse{\boolean{Changes@WrongID}}% + {\PackageError{changes}% + {Undefined changes author: #3}% + {You have to define the author #3 with e.g.: \definechangesauthor{#3}}}% + {}% +% \end{macrocode} % Save author text for output. % \begin{macrocode} \ifthenelse{\equal{\Changes@optionauthormarkuptext}{id}}% @@ -713,31 +783,23 @@ % \end{macrocode} % \end{macro} % -% \begin{macro}{\Changes@temp} -% Temporary variable for exchange of optional parameters between interlocked commands. -% \begin{macrocode} -\newcommand{\Changes@temp}{\@empty} -% \end{macrocode} -% \end{macro} -% % \begin{macro}{\added} % The command formats text as new text. -% Defining a command with two optional parameters is rather complicated. % % Mandatory argument: added text. -% Optional arguments: author's id, remark +% Optional argument (key-value): author's id, remark % \begin{macrocode} -\newcommand{\added}[1][\@empty]{% - \renewcommand{\Changes@temp}{#1}% - \Changes@added% -} -\newcommand{\Changes@added}[2][\@empty]{% +\newcommand{\added}[2][\@empty]{% +% \end{macrocode} +% Call \emph{setkeys} in order to evaluate the key-value-options and fill the value storage. +% \begin{macrocode} + \setkeys{Changes@added}{#1}% \Changes@output {\Changes@Markup@Added{#2}} {#2} - {\Changes@temp} - {#1}% - \stepcounter{Changes@AddCount\Changes@temp}% + {\Changes@added@id} + {\Changes@added@remark}% + \stepcounter{Changes@AddCount\Changes@added@id}% } % \end{macrocode} % \end{macro} @@ -749,19 +811,19 @@ % It solves the problem of additional space caused by an empty command. % % Mandatory argument: deleted text. -% Optional arguments: author's id, remark +% Optional argument (key-value): author's id, remark % \begin{macrocode} -\newcommand{\deleted}[1][\@empty]{% - \renewcommand{\Changes@temp}{#1}% - \Changes@deleted% -} -\newcommand{\Changes@deleted}[2][\@empty]{% +\newcommand{\deleted}[2][\@empty]{% +% \end{macrocode} +% Call \emph{setkeys} in order to evaluate the key-value-options and fill the value storage. +% \begin{macrocode} + \setkeys{Changes@deleted}{#1}% \Changes@output {\Changes@Markup@Deleted{#2}} {\@bsphack \expandafter \@esphack} - {\Changes@temp} - {#1}% - \stepcounter{Changes@DeleteCount\Changes@temp}% + {\Changes@deleted@id} + {\Changes@deleted@remark}% + \stepcounter{Changes@DeleteCount\Changes@deleted@id}% } % \end{macrocode} % \end{macro} @@ -770,19 +832,19 @@ % The command formats text as replaced text. % % Mandatory arguments: new text and old text. -% Optional arguments: author's id, remark +% Optional argument (key-value): author's id, remark % \begin{macrocode} -\newcommand{\replaced}[1][\@empty]{% - \renewcommand{\Changes@temp}{#1}% - \Changes@replaced% -} -\newcommand{\Changes@replaced}[3][\@empty]{% +\newcommand{\replaced}[3][\@empty]{% +% \end{macrocode} +% Call \emph{setkeys} in order to evaluate the key-value-options and fill the value storage. +% \begin{macrocode} + \setkeys{Changes@replaced}{#1}% \Changes@output {{\Changes@Markup@Added{#2}}{\Changes@Markup@Deleted{#3}}} {#2} - {\Changes@temp} - {#1}% - \stepcounter{Changes@ReplaceCount\Changes@temp}% + {\Changes@replaced@id} + {\Changes@replaced@remark}% + \stepcounter{Changes@ReplaceCount\Changes@replaced@id}% } % \end{macrocode} % \end{macro} @@ -839,7 +901,7 @@ \changesauthorname: \Changes@InID \ifthenelse{\equal{\Changes@InName}{\@empty}} {} - {(\Changes@InName)} + { (\Changes@InName)} } }\\ \>\changesaddname:\>\Changes@InAdded\\ @@ -865,12 +927,24 @@ % The contents have to be separated by a semicolon. % \begin{macrocode} \AtEndDocument{ +% \end{macrocode} +% Open output file. +% \begin{macrocode} \newwrite\Changes@OutFile \immediate\openout\Changes@OutFile = \jobname.\Changes@extension - \setcounter{Changes@iAuthor}{0} - \whiledo{\value{Changes@iAuthor} < \value{Changes@AuthorCount}}{ - \stepcounter{Changes@iAuthor} - \def\Changes@ID{\@nameuse{Changes@AuthorID\theChanges@iAuthor}} +% \end{macrocode} +% Redefine expandable of \chcommand{protect} in order to write correct special characters. +% Store original definition for resetting \chcommand{protect}. +% \begin{macrocode} + \let\Changes@protect\protect + \let\protect\@unexpandable@protect +% \end{macrocode} +% Output data for list of changes. +% \begin{macrocode} + \setcounter{Changes@Author}{0} + \whiledo{\value{Changes@Author} < \value{Changes@AuthorCount}}{ + \stepcounter{Changes@Author} + \def\Changes@ID{\@nameuse{Changes@AuthorID\theChanges@Author}} \immediate\write\Changes@OutFile{\Changes@ID;% \@nameuse{Changes@AuthorColor\Changes@ID};% \@nameuse{Changes@AuthorName\Changes@ID};% @@ -878,7 +952,14 @@ \the\value{Changes@DeleteCount\Changes@ID};% \the\value{Changes@ReplaceCount\Changes@ID}} } - \closeout\Changes@OutFile +% \end{macrocode} +% Close output file. +% \begin{macrocode} + \immediate\closeout\Changes@OutFile +% \end{macrocode} +% Restore original definition of \chcommand{protect}. +% \begin{macrocode} + \let\protect\Changes@protect } % \end{macrocode} % diff --git a/Master/texmf-dist/source/latex/changes/changes.ins b/Master/texmf-dist/source/latex/changes/changes.ins index 3cf3c8ed710..48af54e6541 100644 --- a/Master/texmf-dist/source/latex/changes/changes.ins +++ b/Master/texmf-dist/source/latex/changes/changes.ins @@ -1,6 +1,6 @@ %% This file creates the needed files from changes.dtx %% -\def\filedate{2012/01/11} +\def\filedate{2012/02/07} \def\batchfile{changes.ins} \input docstrip @@ -36,7 +36,6 @@ and the derived files doc/latex/changes/changes.english.pdf doc/latex/changes/changes.english.withcode.pdf doc/latex/changes/changes.ngerman.pdf - doc/latex/changes/changes.ngerman.withcode.pdf doc/latex/changes/examples/changes.example.*.tex doc/latex/changes/examples/changes.example.*.pdf diff --git a/Master/texmf-dist/source/latex/changes/examples.dtx b/Master/texmf-dist/source/latex/changes/examples.dtx index 40aadc29d57..07f4168cdb9 100644 --- a/Master/texmf-dist/source/latex/changes/examples.dtx +++ b/Master/texmf-dist/source/latex/changes/examples.dtx @@ -33,6 +33,7 @@ % Right brace \} Tilde \~} % % \changes{v0.6.0}{2012/01/11}{separated examples in own dtx file} +% \changes{v0.7.0}{2012/02/07}{key-value-interface for change commands} % \GetFileInfo{examples.dtx} % %^^A -------------------------------------------------------------------------- @@ -238,7 +239,7 @@ You think water moves fast? \added{You should see ice.} It moves like it has a mind. Like it knows it killed the world once and got a taste for murder. -\deleted[][No?]{After the avalanche, it took us a week to climb out.} +\deleted[remark={No?}]{After the avalanche, it took us a week to climb out.} Now, I don't know exactly \added{when} we turned on each other, but I know that seven of us survived the slide... and only five made it out. \replaced{Now we took an oath, that I'm breaking now.}{We said we'd say it was the snow that killed the other two, but it wasn't.} Nature is lethal but it doesn't hold a candle to man. @@ -246,20 +247,20 @@ Nature is lethal but it doesn't hold a candle to man. \subsection*{Changes by green author} The lysine contingency - it's intended to prevent the spread of the animals is case they ever got off the island. -\added[Green]{Dr. Wu inserted} a gene \replaced[Green]{taht}{that} makes a \deleted[Green]{single} faulty enzyme in protein metabolism. +\added[id=Green]{Dr. Wu inserted} a gene \replaced[id=Green]{taht}{that} makes a \deleted[id=Green]{single} faulty enzyme in protein metabolism. The animals can't manufacture the amino acid lysine. -Unless \replaced[Green]{they're}{continually} supplied with lysine by us, they'll slip into a coma and die. +Unless \replaced[id=Green]{they're}{continually} supplied with lysine by us, they'll slip into a coma and die. \subsection*{Changes by orange author with some remarks} Now that we know who you are, I know who I am. -\added[OA][Yeah, I like animals better than people sometimes\dots]{I'm not a mistake!} +\added[id=OA, remark={Yeah, I like animals better than people sometimes\dots}]{I'm not a mistake!} It all makes sense! In a comic, you know how you can tell who the arch-villain's going to be? -\deleted[OA][Especially dogs. Dogs are the best.]{He's the exact opposite of the hero.} -\deleted[OA]{And most times they're friends, like you and me!} +\deleted[id=OA, remark={Especially dogs. Dogs are the best.}]{He's the exact opposite of the hero.} +\deleted[id=OA]{And most times they're friends, like you and me!} I should've known way back when... -\replaced[OA][Every time you come home, they act like they haven't seen you in a year.]{You know why, David?}{Because of the kids.} +\replaced[id=OA, remark={Every time you come home, they act like they haven't seen you in a year.}]{You know why, David?}{Because of the kids.} They called me Mr Glass. \subsection*{No changes} diff --git a/Master/texmf-dist/source/latex/changes/userdoc/changes.de.tex b/Master/texmf-dist/source/latex/changes/userdoc/changes.de.tex index 6c71c9cbe0c..c04a462915d 100644 --- a/Master/texmf-dist/source/latex/changes/userdoc/changes.de.tex +++ b/Master/texmf-dist/source/latex/changes/userdoc/changes.de.tex @@ -63,13 +63,13 @@ Für Details lesen Sie bitte \autoref{sec:user:options} und \autoref{sec:user:cu \minisec{Autoren definieren} Das \chpackage{changes}-Paket stellt einen vordefinierten anonymen Autor zur Verfügung. -Wenn Sie jedoch die Änderungen per AutorIn verfolgen wollen, müssen Sie die entsprechenden AutorInnen definieren. +Wenn Sie jedoch die Änderungen per Autor\_in verfolgen wollen, müssen Sie die entsprechenden Autor\_innen definieren. Dies geht wie folgt: \chcommand{definechangesauthor[]\{ID\}} -Über die ID werden der/die AutorIn und die zugehörigen Textänderungen eindeutig identifiziert. -Optional können Sie einen Namen angeben und dem/der AutorIn eine eigene Farbe zuweisen. +Über die ID werden der/die Autor\_in und die zugehörigen Textänderungen eindeutig identifiziert. +Optional können Sie einen Namen angeben und dem/der Autor\_in eine eigene Farbe zuweisen. Für Details lesen Sie bitte \autoref{sec:user:authormanagement}. @@ -79,13 +79,13 @@ Jetzt ist alles vorbereitet, um den geänderten Text zu markieren. Benutzen Sie bitte je nach Änderung die folgenden Befehle: für neu zugefügten Text:\\ -\chcommand{added[][]\{Text\}} +\chcommand{added[id=, remark=]\{Text\}} für gelöschten Text:\\ -\chcommand{deleted[][]\{Text\}} +\chcommand{deleted[id=, remark=]\{Text\}} für geänderten Text:\\ -\chcommand{replaced[][]\{neuer Text\}\{alter Text\}} +\chcommand{replaced[id=, remark=]\{neuer Text\}\{alter Text\}} Die Angabe von Autoren-ID und einer Anmerkung ist optional. @@ -104,7 +104,7 @@ Dies erfolgt mit dem Kommando: \chcommand{listofchanges} Die Ausgabe ist gedacht als Analogon zur Liste von Tabellen oder Abbildungen. -Sie dient dazu, einen schnellen Überblick über Art und Anzahl der Änderungen abhängig von dem/der AutorIn zu bekommen. +Sie dient dazu, einen schnellen Überblick über Art und Anzahl der Änderungen abhängig von dem/der Autor\_in zu bekommen. Bei jedem \LaTeX-Lauf werden die Daten für diese Liste in eine Hilfsdatei geschrieben. Beim nächsten \LaTeX-Lauf werden dann diese Daten genutzt, um die Änderungsliste anzuzeigen. @@ -312,19 +312,19 @@ Zwei oder mehr Optionen müssen in geschweifte Klammern gesetzt werden. Der Befehl \chcommand{added} markiert zugefügten Text. Der neue Text wird als notwendiges Argument in geschweiften Klammern übergeben. -Optional können eine Autor-ID sowie eine Anmerkung übergeben werden. +Das optionale Argument enthält Key-Value-Paare für die Angabe von Autor-ID sowie einer Anmerkung. Die Autor-ID muss mit einer mit dem \chcommand{definechangesauthor}-Befehl definierten ID übereinstimmen. -Soll nur eine Anmerkung (ohne Autor) eingegeben werden, so ist statt des Autors ein leeres Argument zu übergeben. +Enthält die Anmerkung Sonderzeichen oder Leerzeichen, ist sie in geschweifte Klammern einzuschließen. \begin{chusage} - \>\chcommand{added[\meta{Autor-ID}][\meta{Anmerkung}]\{\meta{neuer Text}\}}\\ + \>\chcommand{added[id=\meta{Autor-ID}, remark=\meta{Anmerkung}]\{\meta{neuer Text}\}}\\ \usageexample - \>\texttt{Das ist \chcommand{added}[EK]\{neuer\} Text.}\\ - \>Das ist \added[EK]{neuer} Text.\\ - \>\texttt{Das ist \chcommand{added}[EK][muss rein]\{neuer\} Text.}\\ - \>Das ist \added[EK][muss rein]{neuer} Text.\\ - \>\texttt{Das ist \chcommand{added}[][anonym]\{neuer\} Text.}\\ - \>Das ist \added[][anonym]{neuer} Text. + \>\texttt{Das ist \chcommand{added}[id=EK]\{neuer\} Text.}\\ + \>Das ist \added[id=EK]{neuer} Text.\\ + \>\texttt{Das ist \chcommand{added}[id=EK, remark=\{muss rein\}]\{neuer\} Text.}\\ + \>Das ist \added[id=EK, remark={muss rein}]{neuer} Text.\\ + \>\texttt{Das ist \chcommand{added}[remark=anonym]\{neuer\} Text.}\\ + \>Das ist \added[remark=anonym]{neuer} Text. \end{chusage} @@ -335,10 +335,10 @@ Der Befehl \chcommand{deleted} markiert gelöschten Text. Argumente: siehe \chcommand{added}. \begin{chusage} - \>\chcommand{deleted[\meta{Autor-ID}][\meta{Anmerkung}]\{\meta{gelöschter Text}\}}\\ + \>\chcommand{deleted[id=\meta{Autor-ID}, remark=\meta{Anmerkung}]\{\meta{gelöschter Text}\}}\\ \usageexample - \>\texttt{Das ist \chcommand{deleted}[][obsolet]\{schlechter\} Text.}\\ - \>Das ist \deleted[][obsolet]{schlechter} Text. + \>\texttt{Das ist \chcommand{deleted}[remark=obsolet]\{schlechter\} Text.}\\ + \>Das ist \deleted[remark=obsolet]{schlechter} Text. \end{chusage} @@ -350,10 +350,10 @@ Notwendige Argumente sind der neue sowie der alte Text. Optionale Argumente: siehe \chcommand{added}. \begin{chusage} - \>\chcommand{replaced[\meta{Autor-ID}][\meta{Anmerkung}]\{\meta{neuer Text}\}\{\meta{alter Text}\}}\\ + \>\chcommand{replaced[id=\meta{Autor-ID}, remark=\meta{Anmerkung}]\{\meta{neuer Text}\}\{\meta{alter Text}\}}\\ \usageexample - \>\texttt{Das ist \chcommand{replaced}[EK]\{schöner\}\{schlechter\} Text.}\\ - \>Das ist \replaced[EK]{schöner}{schlechter} Text. + \>\texttt{Das ist \chcommand{replaced}[id=EK]\{schöner\}\{schlechter\} Text.}\\ + \>Das ist \replaced[id=EK]{schöner}{schlechter} Text. \end{chusage} @@ -379,7 +379,7 @@ Der Befehl \chcommand{definechangesauthor} definiert einen neuen Autor/eine neue Es muss eine eindeutige Autor-ID angegeben werden, die keine Sonder- oder Leerzeichen enthalten darf. Optional kann eine Farbe und ein Name angegeben werden. Wird keine Farbe angegeben, wird schwarz genutzt. -Der AutorInnenname wird in der Änderungsliste sowie im Markup benutzt, im Markup jedoch nur, wenn die entsprechende Option gesetzt ist. +Der Autor\_innenname wird in der Änderungsliste sowie im Markup benutzt, im Markup jedoch nur, wenn die entsprechende Option gesetzt ist. \input{userdoc/command_definechangesauthor} @@ -519,6 +519,16 @@ Dies sind in alphabetischer Reihenfolge: \section{Versionen} \label{sec:versions} +\minisec{Version 1.0.0} + +Datum: 25.\,04.~2012 +\begin{itemize} + \item Key-Value-Interface für Änderungsmanagement-Kommandos + \item Fehler (Crash) in Änderungsliste gefixt, der bei Sonderzeichen auftrat + \item Leerzeichen vor Autor\_innenname in Änderungsliste + \item Fehlermeldung bei Verwendung einer ungültigen Autor\_innen-ID +\end{itemize} + \minisec{Version 0.6.0} Datum: 11.\,01.~2012 @@ -528,7 +538,7 @@ Datum: 11.\,01.~2012 \item Restrukturierung und Codeverbesserung \item verbesserte Dokumentation mit typischem Anwendungsfall \item Beispieldateien für alle Optionen und Befehle - \item Anmerkunge sind per Default nicht mehr farbig + \item Anmerkungen sind per Default nicht mehr farbig \end{itemize} \minisec{Version 0.5.4} diff --git a/Master/texmf-dist/source/latex/changes/userdoc/changes.en.tex b/Master/texmf-dist/source/latex/changes/userdoc/changes.en.tex index 024230439a0..f1bec7db586 100644 --- a/Master/texmf-dist/source/latex/changes/userdoc/changes.en.tex +++ b/Master/texmf-dist/source/latex/changes/userdoc/changes.en.tex @@ -81,13 +81,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[][]\{text\}} +\chcommand{added[id=, remark=]\{text\}} for deleted text:\\ -\chcommand{deleted[][]\{text\}} +\chcommand{deleted[id=, remark=]\{text\}} for replaced text:\\ -\chcommand{replaced[][]\{text\}} +\chcommand{replaced[id=, remark=]\{text\}} Stating the author's id and/or a remark is optional. @@ -320,19 +320,19 @@ Two or more option have to be embraced in curly brackets. The command \chcommand{added} marks new text. The new text is the mandatory argument for the command, thus it is written in curly braces. -There are two optional arguments: author-id and remark. +The optional argument contains key-value-pairs for author-id and remark. The author-id has to be defined using \chcommand{definechangesauthor}. -Use an empty author for an anonymous remark. +If the remark contains special characters or spaces, use curly brackets to enclose the remark. \begin{chusage} - \>\chcommand{added[\meta{author's id}][\meta{remark}]\{\meta{new text}\}}\\ + \>\chcommand{added[id=\meta{author's id}, remark=\meta{remark}]\{\meta{new text}\}}\\ \usageexample - \>\texttt{This is \chcommand{added}[EK]\{new\} text.}\\ - \>This is \added[EK]{new} text.\\ - \>\texttt{This is \chcommand{added}[EK][has to be in it]\{new\} text.}\\ - \>This is \added[EK][has to be in it]{new} text.\\ - \>\texttt{This is \chcommand{added}[][anonymous]\{new\} text.}\\ - \>This is \added[][anonymous]{new} text. + \>\texttt{This is \chcommand{added}[id=EK]\{new\} text.}\\ + \>This is \added[id=EK]{new} text.\\ + \>\texttt{This is \chcommand{added}[id=EK, remark=\{has to be in it\}]\{new\} text.}\\ + \>This is \added[id=EK, remark={has to be in it}]{new} text.\\ + \>\texttt{This is \chcommand{added}[remark=anonymous]\{new\} text.}\\ + \>This is \added[remark=anonymous]{new} text. \end{chusage} @@ -343,10 +343,10 @@ The command \chcommand{deleted} marks deleted text. For arguments see \chcommand{added}. \begin{chusage} - \>\chcommand{deleted[\meta{author's id}][\meta{remark}]\{\meta{deleted text}\}}\\ + \>\chcommand{deleted[id=\meta{author's id}, remark=\meta{remark}]\{\meta{deleted text}\}}\\ \usageexample - \>\texttt{This is \chcommand{deleted}[][obsolete]\{bad\} text.}\\ - \>This is \deleted[][obsolete]{bad} text. + \>\texttt{This is \chcommand{deleted}[remark=obsolete]\{bad\} text.}\\ + \>This is \deleted[remark=obsolete]{bad} text. \end{chusage} @@ -358,10 +358,10 @@ Mandatory arguments are the new text and the old text. For optional arguments see \chcommand{added}. \begin{chusage} - \>\chcommand{replaced[\meta{author's id}][\meta{remark}]\{\meta{new text}\}\{\meta{old text}\}}\\ + \>\chcommand{replaced[id=\meta{author's id}, remark=\meta{remark}]\{\meta{new text}\}\{\meta{old text}\}}\\ \usageexample - \>\texttt{This is \chcommand{replaced}[EK]\{nice\}\{bad\} text.}\\ - \>This is \replaced[EK]{nice}{bad} text. + \>\texttt{This is \chcommand{replaced}[id=EK]\{nice\}\{bad\} text.}\\ + \>This is \replaced[id=EK]{nice}{bad} text. \end{chusage} @@ -528,6 +528,16 @@ The authors are (in alphabetical order): \section{Versions} \label{sec:versions} +\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 diff --git a/Master/texmf-dist/source/latex/changes/userdoc/files_generated.tex b/Master/texmf-dist/source/latex/changes/userdoc/files_generated.tex index 823ed02db25..1f0fee3cd99 100644 --- a/Master/texmf-dist/source/latex/changes/userdoc/files_generated.tex +++ b/Master/texmf-dist/source/latex/changes/userdoc/files_generated.tex @@ -3,7 +3,6 @@ \>\texttt{doc/latex/changes/changes.english.pdf}\\ \>\texttt{doc/latex/changes/changes.english.withcode.pdf}\\ \>\texttt{doc/latex/changes/changes.ngerman.pdf}\\ - \>\texttt{doc/latex/changes/changes.ngerman.withcode.pdf}\\ \>\texttt{doc/latex/changes/examples/changes.example.*.tex}\\ \>\texttt{doc/latex/changes/examples/changes.example.*.pdf}\\ -- cgit v1.2.3