summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/svninfo/svninfo2html.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/svninfo/svninfo2html.tex')
-rw-r--r--Master/texmf-dist/doc/latex/svninfo/svninfo2html.tex172
1 files changed, 172 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/svninfo/svninfo2html.tex b/Master/texmf-dist/doc/latex/svninfo/svninfo2html.tex
new file mode 100644
index 00000000000..38169382a63
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/svninfo/svninfo2html.tex
@@ -0,0 +1,172 @@
+%%
+%% This is file `svninfo2html.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% svninfo.dtx (with options: `header,html')
+%%
+%% IMPORTANT NOTICE:
+%%
+%% For the copyright see the source file.
+%%
+%% Any modified versions of this file must be renamed
+%% with new filenames distinct from svninfo2html.tex.
+%%
+%% For distribution of the original source see the terms
+%% for copying and modification in the file svninfo.dtx.
+%%
+%% This generated file may be distributed as long as the
+%% original source files, as listed above, are part of the
+%% same distribution. (The sources need not necessarily be
+%% in the same archive or directory.)
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%% `svninfo' package to use with LaTeX2e.
+%%
+%% This package is used to extract the revision and file information provided
+%% by the Subversion revision control system.
+%% A PERL-package supporting svninfo and LaTeX2HTML is provieded too.
+%%
+%% Copyright (C) 1995 Dr. Juergen Vollmer
+%% Copyright (C) 2003-2005 Achim D. Brucker
+%%
+%% License:
+%% This program can be redistributed and/or modified under the terms
+%% of the LaTeX Project Public License Distributed from CTAN
+%% archives in directory macros/latex/base/lppl.txt; either
+%% version 1 of the License, or any later version.
+%%
+%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%% \CheckSum{345}
+%% \CharacterTable
+%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
+%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
+%% Digits \0\1\2\3\4\5\6\7\8\9
+%% Exclamation \! Double quote \" Hash (number) \#
+%% Dollar \$ Percent \% Ampersand \&
+%% Acute accent \' Left paren \( Right paren \)
+%% Asterisk \* Plus \+ Comma \,
+%% Minus \- Point \. Solidus \/
+%% Colon \: Semicolon \; Less than \<
+%% Equals \= Greater than \> Question mark \?
+%% Commercial at \@ Left bracket \[ Backslash \\
+%% Right bracket \] Circumflex \^ Underscore \_
+%% Grave accent \` Left brace \{ Vertical bar \|
+%% Right brace \} Tilde \~}
+
+\documentclass{article}
+\IfFileExists{html.sty}{\usepackage{html}}{}
+\usepackage{svninfo}
+
+\IfFileExists{html.sty}{%
+\begin{htmlonly}%
+\input{svninfo2html.aux}%
+\end{htmlonly}%
+}{}
+
+\newcommand{\LatexToHtml}{\LaTeX 2\texttt{HTML}}
+\newcommand{\Var}[1]{\texttt{\$svninfo::#1}}
+\newcommand{\SVN}{\emph{SVN}}
+
+\pagestyle{fancy}
+
+\begin{document}
+\svnInfo $Id: svninfo.dtx 1168 2005-04-08 06:18:47Z brucker $
+
+\author{Achim D. Brucker\\
+ \small{\texttt{brucker@freiburg.linux.de}}}
+\date{\today}
+\title{Example for converting a \LaTeX\ document to \texttt{HTML}\\
+ using \LatexToHtml\ and the \texttt{svninfo}-package}
+\maketitle
+
+\section{Notes}
+%%%%%%%%%%%%%%%
+
+\begin{itemize}
+\item Use at least version \emph{99.1 release (March 30, 1999)} of
+ \LatexToHtml.
+
+\item You should \verb|\usepackage{html}|.
+
+\item You must run \LaTeX\ on the input file before running \LatexToHtml.
+
+\item In order to make \LatexToHtml\ read the \verb|.aux| file, you must
+ either:
+ \begin{itemize}
+ \item call \LatexToHtml\ with the option
+ \verb|-show_section_numbers| or
+ \item include the \verb|.aux| file explicitly in your \LaTeX-source, by
+ adding the lines in the preamble:\\
+\verb|\begin{|\verb|htmlonly}|\\ % looks ulgy, but otherwise
+\verb|\input{|\emph{source}\verb|.aux}|\\
+\verb|\end{|\verb|htmlonly}|\\ % latex2html fails.
+ which requires \verb|\usepackage{html}|.
+ \end{itemize}
+ If you don't do so, the \verb|\svnInfo...| commands give no value.
+
+\item If using the \LatexToHtml\ tool, only the last \verb|\svnInfo| takes
+ effect, e.g.~if using several input files each having the \verb|\svnInfo|
+ command, only the vales of the last included file are used.
+ (If this is a serious problem for you, drop me a mail).
+
+\item If the \verb|fancy| / \verb|fancyhdr| option is given to the
+ \verb|svninfo| package,
+ the date of the \verb|ADDRESS| at the bottom of the \texttt{HTML}
+ page is set to the \SVN\ date.
+
+\item If you would like to set your own \verb|ADDRESS| text, you should
+ define a procedure, which sets \texttt{perl} \verb|$main::ADDRESS|
+ variable in your local \texttt{.latex2html} initialization file.
+ The routine may use the \texttt{perl}
+ variables shown below. Assign a reference of this procdure to the
+ \texttt{perl}-variable
+ \verb|$svninfo::SetAddressProc|.
+ E.g.\ if you have a \texttt{perl} routine \verb|&my_address_field|,
+ then \\
+ \verb|$svninfo::SetAddressProc = &my_address_field|.
+
+ For example the follownig \texttt{perl}-code does the job:
+\begin{verbatim}
+sub my_address_field
+{
+ $ADDRESS = '<hr>This file was last updated on ' .
+ $svninfo::Date .
+ '&nbsp; by ' .
+ '<a href="mailto: brucker@freiburg.linux.de">' .
+ 'Achim D. Brucker ' .
+ '&lt;brucker@freiburg.linux.de&gt;</a>';
+}
+$svninfo::SetAddressProc = \&my_address_field;
+\end{verbatim}
+\end{itemize}
+
+\newpage
+
+\section{Example}
+%%%%%%%%%%%%%%%%%
+
+\label{sec-examples}
+Here are the commands and their output:
+
+\begin{tabular}{lll}
+\LaTeX-command & \texttt{perl} variable & Result for this file \\\hline
+\verb|\today| & \texttt{\$today} & \today \\
+\verb|\svnInfoFile| & \Var{File} & \svnInfoFile \\
+\verb|\svnInfoRevision| & \Var{Revision} & \svnInfoRevision \\
+\verb|\svnInfoOwner| & \Var{Owner} & \svnInfoOwner \\
+\verb|\svnInfoDate| & \Var{Date} & \svnInfoDate \\
+\verb|\svnInfoLongDate| & \Var{LongDate} & \svnInfoLongDate \\
+\verb|\svnInfoDay| & \Var{Day} & \svnInfoDay \\
+\verb|\svnInfoMonth| & \Var{Month} & \svnInfoMonth \\
+\verb|\svnInfoYear| & \Var{Year} & \svnInfoYear \\
+\end{tabular}
+
+\end{document}
+\endinput
+%%
+%% End of file `svninfo2html.tex'.