summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex')
-rw-r--r--Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex37
1 files changed, 25 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex b/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
index a5c974eb6c4..18dc5d662c4 100644
--- a/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
+++ b/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
@@ -15,7 +15,7 @@ Vhistory understands several options to control its behaviour. These are listed
\paragraph{tocentry:} With this option you can cause an entry in the table of contents. Normaly there won't be such an entry. If the option nochapter is used, tocentry has no effect and you are responsible for toc entries.
-\paragraph{owncaptions:} vhistory supports the languages English and German. If you use an unsopported language, all captions (like ``History of versions'' or ``Chan\-ges'') will be in English. In this case you might want to change captions yourself. The option own\-capt\-ions supports you in this case. More information on this topic can be found in subsection \ref{languages}.
+\paragraph{owncaptions:} vhistory supports the languages Dutch, English, French and German. If you use an unsopported language, all captions (like ``History of versions'' or ``Chan\-ges'') will be in English. In this case you might want to change captions yourself. The option own\-capt\-ions supports you in this case. More information on this topic can be found in subsection \ref{languages}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Usage}\label{usage}
@@ -26,7 +26,7 @@ It is important to know that vhistory needs to runs of \LaTeX, because some data
The history of versions is an environment:\\
\mbox{}\hspace{2em}\verb|\begin{versionhistory}|\\
\mbox{}\hspace{2em}\verb|<entries>|\\
-\mbox{}\hspace{2em}\verb|\begin{versionhistory}|
+\mbox{}\hspace{2em}\verb|\end{versionhistory}|
An entry generally looks like:\\
\mbox{}\hspace{2em}\verb@\vhEntry{<Version>}{<Date>}{<Authors>}{<Changes>}@
@@ -62,11 +62,22 @@ Sometimes you want the list to contain full names like ``Jochen Wer\-ten\-au\-er
\mbox{}\hspace{2em}\verb|\vhListAllAuthorsLong|\\
you can get this behaviour. In this case you still write ``JW'' in the \verb|\entry| command (note: there is no backslash here!), but also define a macro \verb|\JW| like shown below.\\
\mbox{}\hspace{2em}\verb|\newcommand{\JW}{Jochen Wertenauer}|\\
-In the history of versions, the text ``JW'' will be shown in the authors column, but \verb|\vhListAllAuthorsLong| will use the macro \verb|\JW|. If the macro is undefined, no text will be shown (for this author).
+In the history of versions, the text ``JW'' will be shown in the authors column, but \verb|\vhListAllAuthorsLong| will use the macro \verb|\JW|. If the macro is undefined, the short for will be shown (for this author).
+
+Instead of \verb|\vhListAllAuthorsLong| you can also use\\
+\mbox{}\hspace{2em}\verb|\vhListAllAuthorsLongWithAbbrev|,\\
+which prints the short form in brackets after the complete name, e.\,g. ``Jochen Wertenauer (JW)''. Name und short form are separated by the command\\
+\mbox{}\hspace{2em}\verb|\vhAbbrevSeparator|,\\
+which defaults to ``\verb*|\ |''. In order to avoid line breaks, you can redefine the command with\\
+\mbox{}\hspace{2em}\verb|\renewcommand{\vhAbbrevSeparator}{~}|.\\
+In order to change the brackets you can redefine the commands\\
+\mbox{}\hspace{2em}\verb|\vhAbbrevLeft| and\\
+\mbox{}\hspace{2em}\verb|\vhAbbrevRight|\\
+as needed.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Language support}\label{languages}
-As mentioned is section \ref{load}, vhistory supports the languages English and German. All language dependent captions with their defaults are listed in table \ref{tab:languages}. If the document is written in a unsopported language, the English version will be used.
+As mentioned is section \ref{load}, vhistory supports the languages Dutch, English, French and German. All language dependent captions with their defaults are listed in table \ref{tab:languages}. If the document is written in a unsopported language, the English version will be used.
By providing the option ``owncaptions'' you can use custom captions. This option causes vhistory to default the commands in the language that was selected, when vhistory is loaded. Therefore it makes sense to load packages like babel or ngerman before vhistory.
@@ -78,14 +89,16 @@ to get the desired result.
\begin{table}%[htb]
\begin{center}
-\begin{tabular}{|l|l|l|}\hline
-\textbf{Command} & \textbf{German} & \textbf{English}\\ \hline
-\verb|\vhhistoryname| & Versionshistorie & History of Versions \\
-\verb|\vhversionname| & Version & Version \\
-\verb|\vhdatename| & Datum & Date \\
-\verb|\vhauthorname| & Autor(en) & Author(s) \\
-\verb|\vhchangename| & Änderungen & Changes \\ \hline
+\begin{small}
+\begin{tabular}{lllll}\hline
+\textbf{Command} & \textbf{German} & \textbf{English} & \textbf{French} & \textbf{Dutch}\\ \hline
+\verb|\vhhistoryname| & Versionshistorie & Revision History & Historique & Wijzigingen \\
+\verb|\vhversionname| & Version & Revision History & Version & Herziening \\
+\verb|\vhdatename| & Datum & Date & Date & Datum\\
+\verb|\vhauthorname| & Autor(en) & Author(s) & Auteur(s) & Auteur(s) \\
+\verb|\vhchangename| & Änderungen & Description & Modifications & Beschrijving \\ \hline
\end{tabular}
+\end{small}
\caption{language dependent captions}
\label{tab:languages}
\end{center}
@@ -93,4 +106,4 @@ to get the desired result.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Example}
-\input{en_example} \ No newline at end of file
+\input{en_example}