summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-01-23 23:53:17 +0000
committerKarl Berry <karl@freefriends.org>2013-01-23 23:53:17 +0000
commit943d3f44319a81bca1245e19f0e0e894cf404a87 (patch)
treebfb103f098d6ad816bdcfca7075f19ef5a267e10 /Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
parenta0e35f2bf6cf222f13ceb9b0553d3539ab22bb7d (diff)
vhistory 1.6 (22jan13)
git-svn-id: svn://tug.org/texlive/trunk@28914 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex')
-rw-r--r--Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex40
1 files changed, 24 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex b/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
index 18dc5d662c4..05d87a798e3 100644
--- a/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
+++ b/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex
@@ -11,19 +11,21 @@ in the preamble. Vhistory requires \LaTeXe\ and the packages sets and ltxtable (
Vhistory understands several options to control its behaviour. These are listed below. An example for using options would be\\
\mbox{}\hspace{2em}\verb|\usepackage[tocentry, owncaptions]{vhistory}|.
-\paragraph{nochapter:} If this option is used, the history of versions will no be placed in an own chapter---respectively an own section, if you use the document classes article or scrartcl.
+\paragraph{nochapter:} If this option is used, the revision history will no be placed in an own chapter---respectively an own section, if you use the document classes article or scrartcl.
\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 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}.
+\paragraph{owncaptions:} vhistory supports the languages Croatian, Dutch, English, French and German. If you use an unsopported language, all captions (like ``Revision history'' 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{tablegrid:} Setting this option will display a grid in the table representing the revision history.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Usage}\label{usage}
The Usage of vhistory is rather easy and is to be described in this subsection.
It is important to know that vhistory needs to runs of \LaTeX, because some data is written to external files.
-\subsubsection{Creating the history of versions}\label{begin}
-The history of versions is an environment:\\
+\subsubsection{Creating the revision history}\label{begin}
+The revision history is an environment:\\
\mbox{}\hspace{2em}\verb|\begin{versionhistory}|\\
\mbox{}\hspace{2em}\verb|<entries>|\\
\mbox{}\hspace{2em}\verb|\end{versionhistory}|
@@ -36,7 +38,7 @@ The authors are written in the set notation of the package sets, i.\,e. the char
The \verb|\begin|\ldots starts a new chapter (or a new section respectively, if article is used), if not disabled as described above.
-The history of versions itself is set in an ``ltxtable''. As a result of that, the history of versions can consist of more than one page. Lines in the columns ``Author(s)'' and ``Changes'' are broken automatically. The package ltxtable requires the table to be in a separate file. This file is generated be vhistory an has the ending ``ver''.
+The revision history itself is set in an ``ltxtable''. As a result of that, the revision history can consist of more than one page. Lines in the columns ``Author(s)'' and ``Changes'' are broken automatically. The package ltxtable requires the table to be in a separate file. This file is generated be vhistory an has the ending ``ver''.
\subsubsection{Getting the current version number}
The current version number---precisely: the version number of the last entry---can be read with the command\\
@@ -58,11 +60,11 @@ This command returns an alphabetically sorted list of authors. The items of the
\mbox{}\hspace{2em}\verb|\setsepararator|\\
from the package sets (compare section \ref{inspectors}).
-Sometimes you want the list to contain full names like ``Jochen Wer\-ten\-au\-er'' instead of the short form ``JW'', which would probably be used in the history of versions. By using the command\\
+Sometimes you want the list to contain full names like ``Jochen Wer\-ten\-au\-er'' instead of the short form ``JW'', which would probably be used in the revision history. By using the command\\
\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, the short for will be shown (for this author).
+In the revision history, 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|,\\
@@ -75,6 +77,12 @@ In order to change the brackets you can redefine the commands\\
\mbox{}\hspace{2em}\verb|\vhAbbrevRight|\\
as needed.
+\subsubsection{Adjusting the column with in the revision history}
+If the width of the columns for authors and changes in the revision history does not meet your requirements, you can change the with ratio of the two columns. The commands\\
+\mbox{}\hspace{2em}\verb|\renewcommand \vhAuthorColWidth{.8\hsize}|\\
+\mbox{}\hspace{2em}\verb|\renewcommand \vhChangeColWidth{1.2\hsize}|\\
+change the ratio to 2:3 (default is 1:3). When changing the widths, please take care that the widths add up to \verb|2\hsize|.
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Language support}\label{languages}
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.
@@ -89,16 +97,16 @@ to get the desired result.
\begin{table}%[htb]
\begin{center}
-\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
+\begin{scriptsize}
+\begin{tabular}{llllll}\hline
+& \verb|\vhhistoryname| & \verb|\vhversionname| & \verb|\vhdatename| & \verb|\vhauthorname| & \verb|\vhchangename|\\ \hline
+Croatian & Povijest verzija & Verzija & Datum & Autor(ica) & Opis Promjena\\
+Dutch & Wijzigingen & Herziening & Datum & Auteur(s) & Beschrijving\\ \hline
+English & Revision History & Revision & Date & Author(s) & Description\\
+French & Historique & Version & Date & Auteur(s) & Modifications\\
+German & Versionshistorie & Version & Datum & Autor(en) & Ă„nderungen\\
\end{tabular}
-\end{small}
+\end{scriptsize}
\caption{language dependent captions}
\label{tab:languages}
\end{center}