diff options
author | Karl Berry <karl@freefriends.org> | 2013-01-23 23:53:17 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-01-23 23:53:17 +0000 |
commit | 943d3f44319a81bca1245e19f0e0e894cf404a87 (patch) | |
tree | bfb103f098d6ad816bdcfca7075f19ef5a267e10 /Master/texmf-dist/doc/latex/vhistory | |
parent | a0e35f2bf6cf222f13ceb9b0553d3539ab22bb7d (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')
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/CHANGES | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/de_vhistory.tex | 28 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/en_introduction.tex | 16 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex | 40 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/example.tar.gz | bin | 0 -> 69160 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/example.zip | bin | 0 -> 69277 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/vh_sets_de.pdf | bin | 166710 -> 167148 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf | bin | 161105 -> 161730 bytes |
8 files changed, 54 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/vhistory/CHANGES b/Master/texmf-dist/doc/latex/vhistory/CHANGES index d81593fe77b..dc0081f3ed9 100644 --- a/Master/texmf-dist/doc/latex/vhistory/CHANGES +++ b/Master/texmf-dist/doc/latex/vhistory/CHANGES @@ -1,3 +1,7 @@ +2013-01-22: - Added Croation translation + - New option tablegrid + - Introduced possibility to change column width + Thanks to the users for their input which led to these changes. 2010-07-17: - Added French translation. - Listing of sets improved. - Dutch translation added and English labels improved. diff --git a/Master/texmf-dist/doc/latex/vhistory/de_vhistory.tex b/Master/texmf-dist/doc/latex/vhistory/de_vhistory.tex index 009f1b1ecd3..42cd15d60a6 100644 --- a/Master/texmf-dist/doc/latex/vhistory/de_vhistory.tex +++ b/Master/texmf-dist/doc/latex/vhistory/de_vhistory.tex @@ -13,7 +13,9 @@ Das Paket vhistory versteht einige Optionen, um sein Verhalten anzupassen. Diese \paragraph{tocentry:} Mit dieser Option wird veranlasst, dass die Versionshistorie im Inhaltsverzeichnis aufgeführt wird. Normalerweise wird dieser Eintrag nicht erzeugt. Ist die Option nochapter aktiviert hat tocentry keine Funktion. Hier sind Sie selbst für eventuelle Einträge in das Inhaltsverzeichnis verantwortlich. -\paragraph{owncaptions:} vhistory unterstützt die Sprachen Deutsch, Englisch, Französisch und Niederländisch. Verwenden Sie eine nicht unterstützte Sprache, werden die Überschriften (z.\,B. "`Versionshistorie"' oder "`Änderungen"') in Englisch ausgegeben. In diesem Fall möchten Sie vielleicht die Überschriften selbst verändern. Die Option own\-capt\-ions unterstützt Sie dabei. Näheres zu diesem Thema finden Sie in Unterabschnitt \ref{sprachen}. +\paragraph{owncaptions:} vhistory unterstützt die Sprachen Deutsch, Englisch, Französisch, Kroatisch und Niederländisch. Verwenden Sie eine nicht unterstützte Sprache, werden die Überschriften (z.\,B. "`Versionshistorie"' oder "`Änderungen"') in Englisch ausgegeben. In diesem Fall möchten Sie vielleicht die Überschriften selbst verändern. Die Option own\-capt\-ions unterstützt Sie dabei. Näheres zu diesem Thema finden Sie in Unterabschnitt \ref{sprachen}. + +\paragraph{tablegrid:} Mit dieser Option wird in der Tabelle mit der Versionshistorie ein Gitternetz angezeigt. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Verwendung}\label{verwendung} @@ -73,6 +75,12 @@ umdefinieren. Die Klammern können durch Umdefinition von\\ \mbox{}\hspace{2em}\verb|\vhAbbrevRight|\\ ebenfalls den eigenen Vorlieben angepasst werden. +\subsubsection{Spaltenbreite der Versionshistorie anpassen} +Sollte die Breite der Spalten für Autoren und Änderungen in der Versionshistorie nicht Ihren Bedürfnissen entsprechen, können Sie das Breitenverhältnis der beiden Spalten zueinander anpassen. Die Befehlsfolge\\ +\mbox{}\hspace{2em}\verb|\renewcommand \vhAuthorColWidth{.8\hsize}|\\ +\mbox{}\hspace{2em}\verb|\renewcommand \vhChangeColWidth{1.2\hsize}|\\ +ändert das Verhältnis auf 2:3 (Standard ist 1:3). Bitte achten Sie bei Änderungen darauf, dass die Summe der beiden Breiten \verb|2\hsize| ergibt. + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Sprachunterstützung}\label{sprachen} Wie schon in Abschnitt \ref{laden} erwähnt unterstützt vhistory die Sprachen Deutsch, Englisch, Französisch und Niederländisch. Die sprachabhängigen Texte mit ihren Voreinstellungen sind in Tabelle \ref{tab:sprachen} aufgelistet. Soll das Dokument in einer Sprache verfasst werden, die vhistory nicht unterstützt, wird die englische Variante gewählt. @@ -86,16 +94,16 @@ kann eine Überschrift verändert werden. Wollen Sie beispielsweise statt "`Änd \begin{table}%[htb] \begin{center} -\begin{small} -\begin{tabular}{lllll}\hline -\textbf{Kommando} & \textbf{Deutsch} & \textbf{Englisch} & \textbf{Französisch} & \textbf{Niederländisch}\\ \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 +Deutsch & Versionshistorie & Version & Datum & Autor(en) & Änderungen\\ +Englisch & Revision History & Revision & Date & Author(s) & Description\\ +Französisch & Historique & Version & Date & Auteur(s) & Modifications\\ +Kroatisch & Povijest verzija & Verzija & Datum & Autor(ica) & Opis Promjena\\ +Niederländisch & Wijzigingen & Herziening & Datum & Auteur(s) & Beschrijving\\ \hline \end{tabular} -\end{small} +\end{scriptsize} \caption{sprachabhängige Texte} \label{tab:sprachen} \end{center} diff --git a/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex b/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex index 18848537d30..9e76493ec20 100644 --- a/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex +++ b/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex @@ -2,7 +2,7 @@ It's clear to me that nobody reads introductions. Nevertheless I recommend not to skip this section, as it tries to explain, why I developed the packages sets and vhistory. By reading the following you can see, if these packages meet your requirements. -During software projects (hopefully) a lot of documents like specification or design are created. These are normally revised several times. To reconstruct changes, documents should contain a so called \emph{history of versions} aka change log. This is a table, whose entries contain the following data: +During software projects (hopefully) a lot of documents like specification or design are created. These are normally revised several times. To reconstruct changes, documents should contain a so called \emph{revision history} aka change log. This is a table, whose entries contain the following data: \begin{itemize} \item a version number, \item the date of the change, @@ -11,18 +11,18 @@ During software projects (hopefully) a lot of documents like specification or de \item a summary of the changes. \end{itemize} -Certain data of the history of versions shall often be repeated at other parts of the document. Typically the title-page shall quote the most recent version number and all authors of the document. The version number should although be repeated on every page, e.\,g. in a footer. By doing this, it is easy to verify, if a page is part of the most recent version or if it is outdated. +Certain data of the revision history shall often be repeated at other parts of the document. Typically the title-page shall quote the most recent version number and all authors of the document. The version number should although be repeated on every page, e.\,g. in a footer. By doing this, it is easy to verify, if a page is part of the most recent version or if it is outdated. -Normally the data, that is placed on say the title-page, is not (automatically) taken from the history of versions, but stated at an other part of the document. The entries in the history of versions are normally always updated. Due to stress and rush updating the data on the title-page is often forgotten. This results in inconsistent documents. +Normally the data, that is placed on say the title-page, is not (automatically) taken from the revision history, but stated at an other part of the document. The entries in the revision history are normally always updated. Due to stress and rush updating the data on the title-page is often forgotten. This results in inconsistent documents. From my own experience I know, that the list of authors is practically never correct, especially when several people edited a document in the course of time. -Therefore it would be nice, if the author of a document only had to take care of the history of versions. The informations on title-page and in footers should be generated from the history of versions automatically. +Therefore it would be nice, if the author of a document only had to take care of the revision history. The informations on title-page and in footers should be generated from the revision history automatically. -These requirements cannot be implemented without any effort, because the titlepage for instance is processed by \LaTeX\ before the history of versions is even read. +These requirements cannot be implemented without any effort, because the titlepage for instance is processed by \LaTeX\ before the revision history is even read. All relevant data therefore has to be written to a file and read again before processing the titlepage. As for some applications even the moment when the aux-file is read is too late, an own file with the extension hst is created. -The table containing the history of versions needs an own file, too, but this topic will be discussed later. +The table containing the revision history needs an own file, too, but this topic will be discussed later. -Another problem is the list of authors. This list cannot be created be simply concatenating the author entries, because this would result in duplicate entries. At this time the package sets was born allowing to manage simple sets of text. At every entry in the history of versions, the set of authors is merged with the set of authors given at this entry. The alphabetically sorted set of authors can then be printed wherever one likes---normally on the tile-page. +Another problem is the list of authors. This list cannot be created be simply concatenating the author entries, because this would result in duplicate entries. At this time the package sets was born allowing to manage simple sets of text. At every entry in the revision history, the set of authors is merged with the set of authors given at this entry. The alphabetically sorted set of authors can then be printed wherever one likes---normally on the tile-page. -The following to sections describe the two packages in more detail and explain, how to use them. I decided not to repeat anything of source code here. Those who are interested can take a look at the sources. I tried to structure and comment the sources in a way that makes it readable for humans.
\ No newline at end of file +The following to sections describe the two packages in more detail and explain, how to use them. I decided not to repeat anything of source code here. Those who are interested can take a look at the sources. I tried to structure and comment the sources in a way that makes it readable for humans. 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} diff --git a/Master/texmf-dist/doc/latex/vhistory/example.tar.gz b/Master/texmf-dist/doc/latex/vhistory/example.tar.gz Binary files differnew file mode 100644 index 00000000000..1ab7ca3b5d8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/vhistory/example.tar.gz diff --git a/Master/texmf-dist/doc/latex/vhistory/example.zip b/Master/texmf-dist/doc/latex/vhistory/example.zip Binary files differnew file mode 100644 index 00000000000..0a2b8d12445 --- /dev/null +++ b/Master/texmf-dist/doc/latex/vhistory/example.zip diff --git a/Master/texmf-dist/doc/latex/vhistory/vh_sets_de.pdf b/Master/texmf-dist/doc/latex/vhistory/vh_sets_de.pdf Binary files differindex 85e12dea153..bf26e135296 100644 --- a/Master/texmf-dist/doc/latex/vhistory/vh_sets_de.pdf +++ b/Master/texmf-dist/doc/latex/vhistory/vh_sets_de.pdf diff --git a/Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf b/Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf Binary files differindex 73031da701b..e4f512091c0 100644 --- a/Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf +++ b/Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf |