<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">\section{Das Paket vhistory}
Sinn und Zweck dieses Pakets wurde bereits ausfÃ¼hrlich in Abschnitt \ref{einleitung} beschrieben. Ich sagte ja, dass es sich lohnt, die Einleitung zu lesen. Hier soll nun ausfÃ¼hrlich erklÃ¤rt werden, wie man mit vhistory arbeitet.

\subsection{Laden des Pakets}\label{laden}
Das Paket wird wie Ã¼blich in der PrÃ¤ambel mit dem Befehl\\
\mbox{}\hspace{2em}\verb|\usepackage{vhistory}|\\
geladen. Vhistory setzt \LaTeXe\ und die Pakete sets und ltxtable (welches wiederum longtable und tabularx benÃ¶tigt) voraus. Sollten die Pakete noch nicht geladen worden sein, werden sie von vhistory automatisch geladen.

Das Paket vhistory versteht einige Optionen, um sein Verhalten anzupassen. Diese sind im Folgenden aufgelistet. Ein Aufruf mit Optionen lautet zum Beispiel\\
\mbox{}\hspace{2em}\verb|\usepackage[tocentry, owncaptions]{vhistory}|.

\paragraph{nochapter:} Ist diese Option beim Laden des Pakets angegeben worden, wird fÃ¼r die Versionshistorie kein eigenes Kapitel -- bzw. kein eigener Abschnitt, falls die Dokumentenklasse article (oder scrartcl) verwendet wird -- erzeugt.

\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, Kroatisch, NiederlÃ¤ndisch, Portugiesisch und Spanisch. 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.

\paragraph{omittable:} In manchen FÃ¤llen ist die Ausgabe einer Tabelle nicht gewÃ¼nscht. Mit dieser Option wird die Ausgabe der Tabelle und die Erzeugung eines Kapitels bzw. eines Abschnitts verhindert. In diesem Fall sind die Optionen nochapter, tocentry, owncaptions und tablegrid ohne Funktion. Die Befehle z.\,B. zur Ausgabe aller Autoren funktionieren weiterhin.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Verwendung}\label{verwendung}
Die Verwendung von vhistory ist denkbar einfach und soll in diesem Unterabschnitt beschrieben werden. Allgemein gilt, dass vhistory zwei DurchlÃ¤ufe benÃ¶tigt, da Daten in Dateien geschrieben werden.

\subsubsection{Erzeugen der Versionshistorie}\label{begin}
Die Versionshistorie wird als Umgebung dargestellt:\\
\mbox{}\hspace{2em}\verb|\begin{versionhistory}|\\
\mbox{}\hspace{2em}\verb|&lt;EintrÃ¤ge&gt;|\\
\mbox{}\hspace{2em}\verb|\end{versionhistory}|

Ein Eintrag hat die allgemeine Gestalt:\\
\mbox{}\hspace{2em}\verb@\vhEntry{&lt;Version&gt;}{&lt;Datum&gt;}{&lt;Autoren&gt;}{&lt;Ã„nderungen&gt;}@

Die Autoren werden in der Mengenschreibweise des Pakets set angegeben, d.\,h. als Trennzeichen wird \texttt{|} verwendet. Ein Eintrag kÃ¶nnte also wie folgt aussehen:\\
\mbox{}\hspace{2em}\verb@\vhEntry{1.1}{13.05.04}{JW|AK|KL}{Fehler korrigiert.}@

Durch das \verb|\begin|\ldots wird ein neues Kapitel (beziehungsweise ein neuer Abschnitt, falls article verwendet wird) begonnen, wenn dies nicht durch die Paketoption nochapter wie oben beschrieben abgeschalten wurde.

Die Versionshistorie selbst wird in eine "`ltxtable"' gesetzt. Dadurch kann die Versionshistorie auch mehrere Seiten umfassen. Die Spalten "`Autor(en)"' und "`Ã„nderungen"' werden automatisch umgebrochen. Das Paket ltxtable setzt voraus, dass die Tabelle in einer eigenen Datei liegt. Diese Datei wird von vhistory automatisch erzeugt und hat die Endung "`ver"'.

\subsubsection{Auslesen der aktuellen Versionsnummer}
Die aktuelle Versionsnummer -- genauer: die zuletzt angegebene Versionsnummer -- kann mit dem Befehl\\
\mbox{}\hspace{2em}\verb|\vhCurrentVersion|\\
bestimmt werden. Der Befehl ist ab der Einbindung des Pakets verfÃ¼gbar.

\subsubsection{Auslesen des aktuellen Datums}
Analog zur aktuellen Versionsnummer kann auch das Datum der letzten Ã„nderung angezeigt werden. Dies funktioniert mit dem Befehl\\
\mbox{}\hspace{2em}\verb|\vhCurrentDate|.\\
Der Befehl ist ebenfalls ab der Einbindung des Pakets verfÃ¼gbar.

\subsubsection{Liste aller Autoren ausgeben}
An eine Liste der Autoren kommen Sie auf zwei Wege. Ãœber das Kommando\\
\mbox{}\hspace{2em}\verb|\vhAllAuthorsSet|\\
kÃ¶nnen Sie sich die Autoren als Menge wie in Abschnitt \ref{sets} beschrieben zurÃ¼ckgeben lassen. Der weitaus einfachere Weg liegt im Kommando\\
\mbox{}\hspace{2em}\verb|\vhListAllAuthors|.

Dieses Kommando gibt eine alphabetisch sortierte Liste der Autoren aus. Die einzelnen EintrÃ¤ge werden durch Kommata getrennt. Soll stattdessen ein anderes Trennzeichen -- beispielsweise \texttt{\&amp;} zur Ausgabe in einer Tabelle -- verwendet werden, kÃ¶nnen sie den Befehl\\
\mbox{}\hspace{2em}\verb|\setsepararator|\\
aus dem Paket sets umdefinieren (siehe auch Abschnitt \ref{inspektoren}).

Manchmal mÃ¶chten Sie vielleicht, dass die Autorenliste komplette Namen statt KÃ¼rzeln enthÃ¤lt, zum Beispiel
"`Jochen Wer\-ten\-au\-er"' statt des KÃ¼rzels "`JW"', das in der Versionshistorie Verwendung findet. Indem Sie das Kommando\\
\mbox{}\hspace{2em}\verb|\vhListAllAuthorsLong|\\
verwenden, erhalten Sei das gewÃ¼nschte Verhalten. In diesem Fall schreiben Sie weiterhin ``JW'' im \verb|\entry|-Kommando (Hinweis: Da ist kein backslash an dieser Stelle!), definieren aber zusÃ¤tzlich das Makro \verb|\JW| wie unten beschrieben.\\
\mbox{}\hspace{2em}\verb|\newcommand{\JW}{Jochen Wertenauer}|\\
In der Versionshistorie wird weiterhin der Text "`JW"' angezeigt, aber das Kommando \verb|\vhListAllAuthorsLong| verwendet das Makro \verb|\JW|. Ist das Makro undefiniert, wird das KÃ¼rzel ausgegeben.

Alternativ zu \verb|\vhListAllAuthorsLong| kÃ¶nnen Sie auch\\
\mbox{}\hspace{2em}\verb|\vhListAllAuthorsLongWithAbbrev|\\
verwenden, das hinter dem kompletten Namen jeweils das KÃ¼rzel in Klammern ausgibt, also z.\,B. "`Jochen Wertenauer (JW)"'. Name und KÃ¼rzel werden durch den Befehl\\
\mbox{}\hspace{2em}\verb|\vhAbbrevSeparator|\\
getrennt. Dieser ist mit "`\verb*|\ |"' vorbelegt. Falls Sie ZeilenumbrÃ¼che vermeiden wollen, kÃ¶nnen Sie den Befehl auch mit\\
\mbox{}\hspace{2em}\verb|\renewcommand{\vhAbbrevSeparator}{~}|\\
umdefinieren. Die Klammern kÃ¶nnen durch Umdefinition von\\
\mbox{}\hspace{2em}\verb|\vhAbbrevLeft| und\\
\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, NiederlÃ¤ndisch, Portugiesisch und Spanisch. 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.

Mit der Paketoption "`owncaptions"' kÃ¶nnen eigene Ãœberschriften verwendet werden. Die Option veranlasst vhistory dazu, die Kommandos, die die Ãœberschriften enthalten, mit den Varianten der aktuell gewÃ¤hlten Sprache vorzubelegen. Deshalb ist es sinnvoll, in diesem Fall Pakete wie babel oder ngerman vor vhistory zu laden.

Ãœber das Kommando\\
\mbox{}\hspace{2em}\verb|\renewcommand{&lt;Kommando&gt;}{&lt;gewÃ¼nschter Text&gt;}|\\
kann eine Ãœberschrift verÃ¤ndert werden. Wollen Sie beispielsweise statt "`Ã„nderungen"' lieber "`Verbesserungen"' verwenden, schreiben Sie\\
\mbox{}\hspace{2em}\verb|\renewcommand{\vhchangename}{Verbesserungen}|.

\begin{table}%[htb]
\begin{center}
\begin{scriptsize}
\begin{tabular}{llllll}\hline
&amp; \verb|\vhhistoryname| &amp; \verb|\vhversionname| &amp; \verb|\vhdatename| &amp; \verb|\vhauthorname| &amp; \verb|\vhchangename|\\ \hline
Deutsch &amp; Versionshistorie &amp; Version &amp; Datum &amp; Autor(en) &amp; Ã„nderungen\\
Englisch &amp; Revision History &amp; Revision &amp; Date &amp; Author(s) &amp; Description\\
FranzÃ¶sisch &amp; Historique &amp; Version &amp; Date &amp; Auteur(s) &amp; Modifications\\
Kroatisch &amp; Povijest verzija &amp; Verzija &amp; Datum &amp; Autor(ica) &amp; Opis Promjena\\
NiederlÃ¤ndisch &amp; Wijzigingen &amp; Herziening &amp; Datum &amp; Auteur(s) &amp; Beschrijving\\
Portugiesisch &amp; Tabela de Revis\~{o}es &amp; Revis\~{a}o &amp; Data &amp; Autor(es) &amp; Descri\c{c}\~{a}o\\
Spanisch &amp; Historial de Revisiones &amp; Versi\'{o}n &amp; Fecha &amp; Autor(es) &amp; Descripci\'{o}n\\ \hline
\end{tabular}
\end{scriptsize}
\caption{sprachabhÃ¤ngige Texte}
\label{tab:sprachen}
\end{center}
\end{table}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Beispiel}
%Abbildung \ref{abb:beispiel} zeigt ein kurzes Beispiel fÃ¼r die Verwendung von vhistory.
\input{de_beispiel}
</pre></body></html>