diff options
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/CHANGES | 5 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/en_introduction.tex | 24 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/en_sets.tex | 17 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex | 32 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/example.tar.gz | bin | 69160 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/example.zip | bin | 69277 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf | bin | 161730 -> 161460 bytes | |||
| -rw-r--r-- | Master/texmf-dist/tex/latex/vhistory/vhistory.sty | 26 |
8 files changed, 54 insertions, 50 deletions
diff --git a/Master/texmf-dist/doc/latex/vhistory/CHANGES b/Master/texmf-dist/doc/latex/vhistory/CHANGES index dc0081f3ed9..ec9ce16af88 100644 --- a/Master/texmf-dist/doc/latex/vhistory/CHANGES +++ b/Master/texmf-dist/doc/latex/vhistory/CHANGES @@ -1,3 +1,8 @@ +2013-04-21: Bugfix release 1.6.1. No new features, but: + - Fixed bug that occurs when the options hideauthorcolumn and + tablegrid are used together + - Corrected lot of typos in the English documentation + - Described the previously undocumented option hideauthorcolumn 2013-01-22: - Added Croation translation - New option tablegrid - Introduced possibility to change column width diff --git a/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex b/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex index 9e76493ec20..d4d99fb9e56 100644 --- a/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex +++ b/Master/texmf-dist/doc/latex/vhistory/en_introduction.tex @@ -1,28 +1,28 @@ \section{Introduction}\label{introduction} -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. +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{revision history} 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, - \item some kind of identification code (e.\,g.\ the initials) of the persons, that + \item some kind of identification code (e.\,g.\ the initials) of the persons that made the changes (the authors), \item a summary of the changes. \end{itemize} -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. +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 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. +Normally the data that is placed on say the title page, is not (automatically) taken from the revision history, but stated at another 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 revision history. The informations on title-page and in footers should be generated from the revision history 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 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. +These requirements cannot be implemented without any effort, because the title page 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 title page. 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 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 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. +Another problem is the list of authors. This list cannot be created by 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. +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_sets.tex b/Master/texmf-dist/doc/latex/vhistory/en_sets.tex index d3f6ff745cb..21f17115878 100644 --- a/Master/texmf-dist/doc/latex/vhistory/en_sets.tex +++ b/Master/texmf-dist/doc/latex/vhistory/en_sets.tex @@ -35,7 +35,7 @@ The items of a set are separated with \texttt{|}. The set $A$ could therefore be The set $L$ is defined with:\\ \mbox{}\hspace{2em}\verb$\newset{\sL}{}$\\ -\verb$\newset$ creates a new set. This set will be sorted in alphabetical order and duplicates will be removed. So it would be no matter, if in the definition of $A$ after ``Charly'' a second ``Alice'' was inserted. +\verb$\newset$ creates a new set. This set will be sorted in alphabetical order and duplicates will be removed. So it would be no matter if in the definition of $A$ after ``Charly'' a second ``Alice'' was inserted. The effort for sorting and duplicate deleting is unnecessary at this point. If you want to skip these expensive steps, you can create a set with the command \verb$\newsetsimple$, too. @@ -52,9 +52,8 @@ Inspectores help you to retrieve informations about sets and to print sets. \paragraph{Printing:}A set can be printed using the command\\ \mbox{}\hspace{2em}\verb$\listset$.\\ -The elements will be put in the sequence they are in the set. A comma is used as separator. - -\verb$\listset{\sA}$ therefore leads to the following output:\\ +The elements will be put in the sequence they are in the set. A comma is used as separator.\\ +\mbox{}\hspace{2em}\verb$\listset{\sA}$ therefore leads to the following output:\\ \centerline{\listset{\sA}} Sometimes you might want to separate the items in a different way, for example with a \texttt{\&} to put them in a table. In this case a (temporary) redefinition of\\ @@ -68,7 +67,7 @@ where \texttt{<counter>} is the name of a \LaTeX\ counter, which afterwards will \mbox{}\hspace{2em}\verb$\sizeofset{\sB}\is{mycounter}$\sizeofset{\sB}\is{mycounter}\\ \mbox{}\hspace{2em}\verb$\arabic{mycounter}$\\ leads to the output: ``\arabic{mycounter}'' -If you determine the size of set $L$, the result\sizeofset{\sL}\is{mycounter}---as you might have expected---is ``\arabic{mycounter}''. +If you determine the size of set $L$, the result\sizeofset{\sL}\is{mycounter} (as you might have expected) is ``\arabic{mycounter}''. \paragraph{Testing for membership:}By using the command\\ \mbox{}\hspace{2em}\verb$\iselementofset{$$e$\verb$}{$$S$\verb$}$\\ @@ -87,14 +86,14 @@ Table \ref{tab:ops} contains some examples. The result of the operation is a sor \mbox{}\hspace{2em}\verb|\minussets{|$S_1$\verb|}\minus{|$S_2$\verb|}\to{|$R$\verb|}|.\\ If $S_1$ is a sorted set, $R$ will be sorted, too. If $S_1$ contains duplicates, $R$ might also contains these duplicate elements. Table \ref{tab:ops} contains several examples for the usage of this command. -Colloquially you can formulate the operation as follows: Check for every element $e$ in $S_1$, if $e \in S_2$ is true. If not, insert $e$ into $R$. And that's exactly the way it has been implemented! +Colloquially you can formulate the operation as follows: Check for every element $e$ in $S_1$ if $e \in S_2$ is true. If not, insert $e$ into $R$. And that's exactly the way it has been implemented! \paragraph{Intersection of sets:} The operation $R := S_1 \cap S_2$ is made possible with the command\\ \mbox{}\hspace{2em}\verb|\intersectsets{|$S_1$\verb|}{|$S_2$\verb|}\to{|$R$\verb|}|.\\ As above: If $S_1$ is a sorted set, $R$ will be sorted, too. If $S_1$ contains duplicates, $R$ might also contains these duplicate elements. Table \ref{tab:ops} contains several examples for the usage of this command, too. -This operation can colloquially be written down as: Check for every element $e$ in $S_1$, if $e \in S_2$ is true. If yes, insert $e$ into $R$. If you compare this with the formulation above, one can recognize that the only difference is the small word ``yes''. -In the source code, this expresses in a missing \verb|\else|. Acutally amazingly simple, if you remember the formal relation $S_1 \cap S_2 \equiv S_1 \backslash (S_1\backslash S_2)$, which lets one expect a much higher complexity. +This operation can colloquially be written down as: Check for every element $e$ in $S_1$ if $e \in S_2$ is true. If yes, insert $e$ into $R$. If you compare this with the formulation above, one can recognize that the only difference is the small word ``yes''. +In the source code, this expresses in a missing \verb|\else|. Acutally amazingly simple if you remember the formal relation $S_1 \cap S_2 \equiv S_1 \backslash (S_1\backslash S_2)$, which lets one expect a much higher complexity. \begin{table}%[htb] \begin{center} @@ -173,4 +172,4 @@ The given complexity classes can help you to arrange a set of operations in the \caption{Complexity classes of set operations}% \label{tab:complexity}% \end{center} -\end{table}
\ No newline at end of file +\end{table} diff --git a/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex b/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex index 05d87a798e3..6610cd5b0d6 100644 --- a/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex +++ b/Master/texmf-dist/doc/latex/vhistory/en_vhistory.tex @@ -1,7 +1,7 @@ \section{The package vhistory} The purpose of this package was described in detail in section \ref{introduction}. -I told you, it is worth reading, didn't I? In this section the usage of vhistory is described in detail. +In this section the usage of vhistory is described in detail. \subsection{Loading the package}\label{load} As usual the package is loaded by using the command\\ @@ -11,18 +11,18 @@ 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 revision history 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{tocentry:} With this option you can cause an entry in the table of contents. Normally 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 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{owncaptions:} vhistory supports the languages Croatian, Dutch, English, French and German. If you use an unsupported 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. +It is important to know that vhistory needs two runs of \LaTeX, because some data is written to external files. \subsubsection{Creating the revision history}\label{begin} The revision history is an environment:\\ @@ -36,12 +36,12 @@ An entry generally looks like:\\ The authors are written in the set notation of the package sets, i.\,e. the character \texttt{|} is used as the separator. An example for entry could therefore be:\\ \mbox{}\hspace{2em}\verb@\vhEntry{1.1}{13.05.04}{JW|AK|KL}{Typos corrected.}@ -The \verb|\begin|\ldots starts a new chapter (or a new section respectively, if article is used), if not disabled as described above. +The \verb|\begin|\ldots starts a new chapter (or a new section respectively if article is used) if not disabled as described above. -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''. +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 by 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\\ +The current version number---i.\,e.: the version number of the last entry---can be read with the command\\ \mbox{}\hspace{2em}\verb|\vhCurrentVersion|.\\ The command is available right after loading the package. @@ -51,7 +51,7 @@ Analogous to the current version number, the date of the last change can be prin you will get this data. The command is available right after loading the package, too. \subsubsection{Putting a list of all authors} -You can get a list of all authors on two ways. Via the command\\ +You can get a list of all authors in two ways. Via the command\\ \mbox{}\hspace{2em}\verb|\vhAllAuthorsSet|\\ you can get the authors as a set as described in section \ref{sets}. The more convenient way is using the command\\ \mbox{}\hspace{2em}\verb|\vhListAllAuthors|. @@ -62,9 +62,9 @@ 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 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.\\ +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| as shown below.\\ \mbox{}\hspace{2em}\verb|\newcommand{\JW}{Jochen Wertenauer}|\\ -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). +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 form will be shown (for this author). Instead of \verb|\vhListAllAuthorsLong| you can also use\\ \mbox{}\hspace{2em}\verb|\vhListAllAuthorsLongWithAbbrev|,\\ @@ -85,13 +85,13 @@ change the ratio to 2:3 (default is 1:3). When changing the widths, please take %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \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. +As mentioned in section \ref{load}, vhistory supports the languages Croatian, 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 unsupported 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. +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. A caption can be changed via the command\\ \mbox{}\hspace{2em}\verb|\renewcommand{<Command>}{<custom text>}|.\\ -If you prefer to use ``Improvements'' instead of ``Canges'', you have to write\\ +If you prefer to use ``Improvements'' instead of ``Description'', you have to write\\ \mbox{}\hspace{2em}\verb|\renewcommand{\vhchangename}{Improvements}|\\ to get the desired result. @@ -101,10 +101,10 @@ to get the desired result. \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 +Dutch & Wijzigingen & Herziening & Datum & Auteur(s) & Beschrijving\\ English & Revision History & Revision & Date & Author(s) & Description\\ French & Historique & Version & Date & Auteur(s) & Modifications\\ -German & Versionshistorie & Version & Datum & Autor(en) & Änderungen\\ +German & Versionshistorie & Version & Datum & Autor(en) & Änderungen\\ \hline \end{tabular} \end{scriptsize} \caption{language dependent captions} diff --git a/Master/texmf-dist/doc/latex/vhistory/example.tar.gz b/Master/texmf-dist/doc/latex/vhistory/example.tar.gz Binary files differdeleted file mode 100644 index 1ab7ca3b5d8..00000000000 --- a/Master/texmf-dist/doc/latex/vhistory/example.tar.gz +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/vhistory/example.zip b/Master/texmf-dist/doc/latex/vhistory/example.zip Binary files differdeleted file mode 100644 index 0a2b8d12445..00000000000 --- a/Master/texmf-dist/doc/latex/vhistory/example.zip +++ /dev/null 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 e4f512091c0..5a72e01b6d1 100644 --- a/Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf +++ b/Master/texmf-dist/doc/latex/vhistory/vh_sets_en.pdf diff --git a/Master/texmf-dist/tex/latex/vhistory/vhistory.sty b/Master/texmf-dist/tex/latex/vhistory/vhistory.sty index da90e99c2e5..b4e515923e0 100644 --- a/Master/texmf-dist/tex/latex/vhistory/vhistory.sty +++ b/Master/texmf-dist/tex/latex/vhistory/vhistory.sty @@ -3,8 +3,8 @@ %% FILE: vhistory.sty %% %% %% %% AUTHOR: Jochen Wertenauer %% -%% VERSION: 1.6 %% -%% DATE: 2013-01-22 %% +%% VERSION: 1.6.1 %% +%% DATE: 2013-01-28 %% %% %% %% LICENSE: This program may be distributed and/or modified under the %% %% conditions of the LaTeX Project Public License, either version 1.2 %% @@ -332,16 +332,16 @@ \gdef \vhCurrentVersion{##1}% Update version number \gdef \vhCurrentDate{##2}% Update date \vh@add{##3}% - \vh@verbwrite \vh@verfile {##1}% - \vh@verbwrite \vh@verfile { & ##2}% - \ifnum \vh@hideauthor=0\relax - \vh@verbwrite \vh@verfile { & \listset{##3}}% - \fi - \ifnum \vh@tablegrid=0\relax - \vh@verbwrite \vh@verfile { & ##4\\} - \else - \vh@verbwrite \vh@verfile { & ##4\\\hline} - \fi + \vh@verbwrite \vh@verfile {##1}% + \vh@verbwrite \vh@verfile { & ##2}% + \ifnum \vh@hideauthor=0\relax + \vh@verbwrite \vh@verfile { & \listset{##3}}% + \fi + \ifnum \vh@tablegrid=0\relax + \vh@verbwrite \vh@verfile { & ##4\\}% + \else + \vh@verbwrite \vh@verfile { & ##4\\\hline}% + \fi }% } @@ -400,7 +400,7 @@ \ifnum \vh@tablegrid=0\relax \vh@verbwrite \vh@verfile {\begin{longtable}{@{}llX@{}}}% \else - \vh@verbwrite \vh@verfile {\begin{longtable}{@{}|l|l|X|@{}}}\hline% + \vh@verbwrite \vh@verfile {\begin{longtable}{@{}|l|l|X|@{}}\hline}% \fi } |