diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/rcsinfo')
| -rw-r--r-- | Master/texmf-dist/doc/latex/rcsinfo/README | 91 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/rcsinfo/README-1.9 | 84 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.init | 39 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.pdf | bin | 0 -> 161700 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.perl | 282 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/rcsinfo/rcsinfo2html.tex | 174 |
6 files changed, 670 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/rcsinfo/README b/Master/texmf-dist/doc/latex/rcsinfo/README new file mode 100644 index 00000000000..06f4c233483 --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcsinfo/README @@ -0,0 +1,91 @@ +This directory contains the LaTeX2e package + + `rcsinfo' + + version 1.11, Feburary 25, 2005 + +This package is used to extract the revision and file information provided +by the RCS revision control system. +A PERL-package supporting rcsinfo and LaTeX2HTML is provided too. + +Copyright (C) 1995 Dr. Jürgen Vollmer, all rights reserved. +Dr. Juergen Vollmer, Viktoriastrasse 15, D-76133 Karlsruhe, Germany +email: Juergen.Vollmer@informatik-vollmer.de + +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. + +If you find this software useful, please send me a postcard. + +You are allowed to distribute this file under the condition that it is +distributed together with all the following files: + rcsinfo.sty LaTeX package + rcsinfo.pdf Documentation + rcsinfo.ins Create script for all other files + rcsinfo.dtx Source of all + rcsinfo.perl use with latex2html + rcsinfo.init use with latex2html + Makefile + README + +If you receive only some of these files from someone, complain! + +To install: + unpack and + `make' +or execute the commands manualy: + latex rcsinfo.ins // creates the file of this package + latex rcsinfo.dtx // create the package documentation + +and if latex2html is installed on your system: + latex2html -dir html -init_file rcsinfo.init \ + -html_version 4.0,math rcsinfo2html.tex + +The following files are created by 'latex rcsinfo.ins' + - rcsinfo.cfg + - rcsinfo.sty + - rcsinfo.perl + - rcsinfo.init + - rcsinfo2html.tex + +then copy the files + rcsinfo.sty + rcsinfo.cfg +to a place where LaTeX can find it + (e.g. under UNIX: $HOME/tex/inputs + and set the environment variable + TEXINPUTS=$HOME/tex/inputs//:$TEXINPUTS + ) +and + rcsinfo.perl +to a place where latex2html will find it. + + +============================================================================ + +HISTORY +1.11 : Added option datehyphen (file date may look like YYYY-MM-DD instead + of YYYY/MM/DD) +1.10 : Added option scrpage2 +1.9 : The initial $ of $Id may be omitted. +1.8 : rcsinfo.perl can deal now with latex2html version 99.1. + Restructured package files. +1.7.1 : Make does not abort, if laext2html is not found +1.7 : Underscores in file names are now handeled correctly. +1.6 : Fixed problems with the french-option of `babel'. + (The `:' is made active when using the french language. + Now rcsinfo can handle this situation). +1.5 : - The Babel-package is not loaded automagically anymore. + This avoids problems within the `babel'-package when other + packages (like `ifthen' or `varioref') are loaded _and_ no + language was given in the `documentclass'. + - Fixed the `notoday' option. +1.4 : Support fancyhdr-package, added rcsinfo.cfg configuration file. +1.3 : Fixed documentation, new address, reimplemeted parts, added + rcsinfo.perl. +1.2 : New Makefile. +1.1 : (internal changes). +1.0 : Initial Version, submitted to CTAN. diff --git a/Master/texmf-dist/doc/latex/rcsinfo/README-1.9 b/Master/texmf-dist/doc/latex/rcsinfo/README-1.9 new file mode 100644 index 00000000000..d660406e400 --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcsinfo/README-1.9 @@ -0,0 +1,84 @@ +This directory contains the LaTeX2e package + + `rcsinfo' + + version 1.9, April 19, 2002 + +This package is used to extract the revision and file information provided +by the RCS revision control system. +A PERL-package supporting rcsinfo and LaTeX2HTML is provi ded too. + +Copyright (C) 1995 Dr. Jürgen Vollmer, all rights reserved. +Dr. Juergen Vollmer, Viktoriastrasse 15, D-76133 Karlsruhe, Germany +email: Juergen.Vollmer@acm.org + +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. + +If you find this software useful, please send me a postcard. + +You are allowed to distribute this file under the condition that it is +distributed together with all the following two files: + rcsinfo.ins + rcsinfo.dtx + Makefile + README-1.9 + +If you receive only some of these files from someone, complain! + +To install: + unpack and + `make' +or execute the commands manualy: + latex rcsinfo.ins // creates the file of this package + latex rcsinfo.dtx // create the package documentation + +and if latex2html is installed on your system: + latex2html -dir html -init_file rcsinfo.init \ + -html_version 4.0,math rcsinfo2html.tex + +The following files are created by 'latex rcsinfo.ins' + - rcsinfo.cfg + - rcsinfo.sty + - rcsinfo.perl + - rcsinfo.init + - rcsinfo2html.tex + +then copy the files + rcsinfo.sty + rcsinfo.cfg +to a place where LaTeX can find it + (e.g. under UNIX: $HOME/tex/inputs + and set the environment variable + TEXINPUTS=$HOME/tex/inputs//:$TEXINPUTS + ) +and + rcsinfo.perl +to a place where latex2html will find it. + + +============================================================================ + +HISTORY +1.9 : the initial $ of $Id may be omitted. +1.8 : rcsinfo.perl can deal now with latex2html version 99.1. + Restructured package files. +1.7.1 : Make does not abort, if laext2html is not found +1.7 : Underscores in file names are now handeled correctly. +1.6 : Fixed problems with the french-option of `babel'. + (The `:' is made active when using the french language. + Now rcsinfo can handle this situation). +1.5 : - The Babel-package is not loaded automagically anymore. + This avoids problems within the `babel'-package when other + packages (like `ifthen' or `varioref') are loaded _and_ no + language was given in the `documentclass'. + - Fixed the `notoday' option. +1.4 : Support fancyhdr-package, added rcsinfo.cfg configuration file. +1.3 : Fixed documentation, new address, reimplemeted parts, added + rcsinfo.perl. +1.2 : New Makefile. +1.1 : (internal changes). +1.0 : Initial Version, submitted to CTAN. diff --git a/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.init b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.init new file mode 100644 index 00000000000..c433eb9931c --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.init @@ -0,0 +1,39 @@ + +# This is file `rcsinfo.init', +# generated with the docstrip utility. +# +# The original source files were: +# +# rcsinfo.dtx (with options: `init') +# +# IMPORTANT NOTICE: +# +# For the copyright see the source file. +# +# Any modified versions of this file must be renamed +# with new filenames distinct from rcsinfo.init. +# +# For distribution of the original source see the terms +# for copying and modification in the file rcsinfo.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.) +# +# This file should be used as initialization file for LaTeX2HTML +# when transforming rcsinfo2html.tex --> HTML +# +# $Id: rcsinfo.dtx,v 1.7 2005/02/25 08:37:03 vollmer draft vollmer $ +############################################################################### +sub my_address_field +{ + $ADDRESS = '<hr>This file was last updated on ' . + $rcsinfo::Date . + ' by ' . + '<a href="mailto: Juergen.Vollmer@informatik-vollmer.de">' . + 'Dr. Juergen Vollmer ' . + '<Juergen.Vollmer@informatik-vollmer.de></a>'; +} +$rcsinfo::SetAddressProc = \&my_address_field; +############################################################################### diff --git a/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.pdf b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.pdf Binary files differnew file mode 100644 index 00000000000..4a66f5c7230 --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.pdf diff --git a/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.perl b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.perl new file mode 100644 index 00000000000..895adb95fbc --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo.perl @@ -0,0 +1,282 @@ + +############################################################################### +# RCSINFO.PERL +# Copyright 1995, Dr. Juergen Vollmer <Juergen.Vollmer@informatik-vollmer.de> +# +# Extension to LaTeX2HTML to translate LaTeX commands of the +# rcsinfo +# package to equivalent HTML commands. +# +# This is file `rcsinfo.perl', +# generated with the docstrip utility. +# +# The original source files were: +# +# rcsinfo.dtx (with options: `perl') +# +# IMPORTANT NOTICE: +# +# For the copyright see the source file. +# +# Any modified versions of this file must be renamed +# with new filenames distinct from rcsinfo.perl. +# +# For distribution of the original source see the terms +# for copying and modification in the file rcsinfo.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.) +# +# $Id: rcsinfo.dtx,v 1.7 2005/02/25 08:37:03 vollmer draft vollmer $ +# +############################################################################### + +package rcsinfo; + +($Dummy1,$PackageVersionDate,$PackageVersionTime,$Dummy2) = + split (/ /,'$Date: 2005/02/25 08:37:03 $'); + +print "\n\t rcsinfo style interface for LaTeX2HTML, $PackageVersionDate\n"; + +# set defaults options +$OptionFancy = 1; +$OptionToday = 1; +$OptionLong = 1; + +# set default values +$Date = `date '+%Y/%m/%d'`; +$Time = `date '+%H:%M:%S'`; +$File = "--sourcefile--"; +$Revision = "--revision--"; +$Owner = "--owner--"; +$Status = "--status--"; +$Locker = "--locker--"; +$Year = `date '+%Y'`; +$Month = `date '+%m'`; +$Day = `date '+%d'`; +$LongDate = $Date; + +sub SetAddress +{ + $main::address_data[1] = "Revision: $rcsinfo::Revision, $rcsinfo::LongDate"; + # Supply your own string if you don't like the default <Name> <Date> + $main::ADDRESS = "<I>$main::address_data[0] <BR>\n$main::address_data[1]</I>"; +} +if ($SetAddressProc == "") { + $SetAddressProc = \&rcsinfo::SetAddress; +} +sub make_cmds +{ + my $cmd; + foreach $cmd (File,Revision,Date,Time,Owner,Status,Locker,Year,Month,Day,LongDate) { + eval "sub main::do_cmd_rcsInfo$cmd { " + . 'my $val = $rcsinfo::' . "$cmd; " +# . 'printf STDERR "\ndo_cmd_rcsInfo%s=%s\n", ' . $cmd .', $val;' + . "join('',\$val,\$_[0]);" + . "}"; + } +} + +@GermanMonthName = ('','Januar','Februar','März','April','Mai','Juni','Juli', + 'August','September','Oktober','November','Dezember'); +@EnglishMonthName = ('','January','February','March','April','May','June','July', + 'August','September','October','November','December'); +@FrenchMonthName = ('','Janvier','Février','Mars','Avril','Mai','Juin', + 'Juillet','Août','Septembre','Octobre','Novembre', + 'Décembre'); + +############################################################################### + +package main; + +# handling package options +sub do_rcsinfo_fancyhdr { $rcsinfo::OptionFancy = 1; } +sub do_rcsinfo_fancy { $rcsinfo::OptionFancy = 1; } +sub do_rcsinfo_nofancy { $rcsinfo::OptionFancy = 0; } +sub do_rcsinfo_today { $rcsinfo::OptionToday = 1; } +sub do_rcsinfo_notoday { $rcsinfo::OptionToday = 0; } +sub do_rcsinfo_short { $rcsinfo::OptionLong = 0; } +sub do_rcsinfo_long { $rcsinfo::OptionLong = 1; } +sub do_rcsinfo_datehyphen { } # nothing just ignore it + +# handling of LaTeX commands +sub do_cmd_rcsInfo +{ + + local ($_) = @_; + + # printf STDERR "\ndo_cmd_rcsInfo\n"; + + # see latex2html, procedure: substitute_meta_cmds, process_body_newcommand + # the format of the variable $new_command{cmd} is: + # $new_command{$cmd} = join(':!:',$argn,$body,$opt); + # note: opt = "}" means: Flag for no optional arg + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoFILE}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoREVISION}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoYEAR}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoMONTH}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoDAY}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoTIME}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoOWNER}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoSTATUS}; + # printf STDERR "xxxxxxxxxxx `%s'\n", $new_command{rcsInfoLOCKER}; + + # the following assumes: LaTeX2HTML Version 99.1 release (March 30, 1999) + # may be later + my ($argn, $opt); + if (exists $new_command{rcsInfoFILE}) { + ($argn, $rcsinfo::File, $opt) = split(/:!:/, $new_command{rcsInfoFILE}); + } else { + $rcsinfo::File = $File + } + if (exists $new_command{rcsInfoREVISION}) { + ($argn, $rcsinfo::Revision, $opt) = split(/:!:/, $new_command{rcsInfoREVISION}); + } else { + $rcsinfo::Revision = $Revision + } + if (exists $new_command{rcsInfoYEAR}) { + ($argn, $rcsinfo::Year, $opt) = split(/:!:/, $new_command{rcsInfoYEAR}); + } else { + $rcsinfo::Year = $Year + } + if (exists $new_command{rcsInfoMONTH}) { + ($argn, $rcsinfo::Month, $opt) = split(/:!:/, $new_command{rcsInfoMONTH}); + } else { + $rcsinfo::Month = $Month + } + if (exists $new_command{rcsInfoDAY}) { + ($argn, $rcsinfo::Day, $opt) = split(/:!:/, $new_command{rcsInfoDAY}); + } else { + $rcsinfo::Day = $Day + } + if (exists $new_command{rcsInfoTIME}) { + ($argn, $rcsinfo::Time, $opt) = split(/:!:/, $new_command{rcsInfoTIME}); + } else { + $rcsinfo::Time = $Time + } + if (exists $new_command{rcsInfoOWNER}) { + ($argn, $rcsinfo::Owner, $opt) = split(/:!:/, $new_command{rcsInfoOWNER}); + } else { + $rcsinfo::Owner = $Owner + } + if (exists $new_command{rcsInfoSTATUS}) { + ($argn, $rcsinfo::Status, $opt) = split(/:!:/, $new_command{rcsInfoSTATUS}); + } else { + $rcsinfo::Status = $Status + } + if (exists $new_command{rcsInfoLOCKER}) { + ($argn, $rcsinfo::Locker, $opt) = split(/:!:/, $new_command{rcsInfoLOCKER}); + } else { + $rcsinfo::Locker = $Locker + } + + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::File; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Revision; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Year; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Month; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Day; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Time; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Owner; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Status; + # printf STDERR "yyyyyyyyyyy `%s'\n", $rcsinfo::Locker; + + # the following code is for oldfashioned latex2hmtl, not anymore supported + # format of $_: + # vvvvvv that's text following the RCS-Id-string + # <#nr#>.....<#nr>...... + # ^ ^ ^ that's the RCS-Id-string +# my ($Nr,$IdString,$Rest) = /(<#\d+#>)(.*)\1(.*)/s ; + + # The Id-String may contain various tags, remove them +# $IdString =~ s/<[^>]*>//g; + + # The Id-String may contain various tags, remove them +# $IdString =~ s/<[^>]*>//g; + + # split the Id-string +# my ($id,$file,$revision,$date,$time,$owner,$status,$locker) = split(/\s/,$IdString); + + # remove trailing ,v +# $file =~ s/,v$//; + + # split date +# ($rcsinfo::Year,$rcsinfo::Month,$rcsinfo::Day) = split (/[\-]//,$date); + +# $rcsinfo::Revision = $revision; +# $rcsinfo::File = $file; +# $rcsinfo::Date = $date; +# $rcsinfo::Time = $time; +# $rcsinfo::Owner = $owner; +# $rcsinfo::Status = $status; +# $rcsinfo::Locker = $locker; + + if ($default_language eq 'german' || $default_language eq 'austrian') { + $rcsinfo::LongDate = $rcsinfo::Day . '. ' . + $rcsinfo::GermanMonthName[$rcsinfo::Month] . ' ' . + $rcsinfo::Year; + $rcsInfo::Date = $rcsinfo::Day . '. ' . $rcsinfo::Month . '. ' . $rcsinfo::Year; + } elsif ($default_language eq 'french') { + $rcsinfo::LongDate = $rcsinfo::Day . '. ' . + $rcsinfo::FrenchMonthName[$rcsinfo::Month] . ' ' . + $rcsinfo::Year; + $rcsInfo::Date = $rcsinfo::Day . '. ' .$rcsinfo::Month . '. ' . $rcsinfo::Year; + } else { # english is the default + $rcsinfo::LongDate = $rcsinfo::EnglishMonthName[$rcsinfo::Month] . ' ' . + $rcsinfo::Day . ', ' . + $rcsinfo::Year; + $rcsInfo::Date = $rcsinfo::Year . '/' .$rcsinfo::Month . '/' . $rcsinfo::Day; + } + + if ($rcsinfo::OptionFancy == 1) { + &$rcsinfo::SetAddressProc; + } + rcsinfo::make_cmds(); + + # printf STDERR "xxx $HTML_VERSION, $HTML_OPTIONS\n"; + # remove stuff generated for the $Id: rcsinfo.dtx,v 1.7 2005/02/25 08:37:03 vollmer draft vollmer $-string + # we assume that noting follows the "\rcsInfo $Id....$" + if ($HTML_VERSION >= 3.2) { + /^<tex2html_verbatim_mark>[^\n]*/; + return $'; + } elsif ($HTML_VERSION == 3.1 || $HTML_VERSION == 2.1) { + /^<tex2html_image_mark>[^\n]*/; + return $'; + } else { + if ($HTML_OPTIONS =~ /math/) { + /^<tex2html_verbatim_mark>[^\n]*/; + return $'; + } else { + /^<tex2html_image_mark>[^\n]*/; + return $'; + } + } +} + +# Replace do_cmd_today (\today) using the RCS date. +sub do_cmd_today { + local($today); + if ($rcsinfo::OptionToday == 1) { + $today = $rcsinfo::LongDate; + } else { + if ($default_language eq 'german' || $default_language eq 'austrian') { + $today = (`date "+%m:%d, 20%y"`); + $today =~ s/(\d{1,2}):0?(\d{1,2}),/$2. $rcsinfo::GermanMonthName[$1]/o; + $today =~ s/20([7|8|9]\d{1})/19$1/o; + } elsif ($default_language eq 'french') { + $today = (`date "+%m:%d, 20%y"`); + $today =~ s/(\d{1,2}):0?(\d{1,2}),/$2 $rcsinfo::FrenchMonthName[$1]/o; + $today =~ s/20([7|8|9]\d{1})/19$1/o; + } else { # english is the default + $today = (`date "+%m:%d, 20%y"`); + $today =~ s/(\d{1,2}):0?/$rcsinfo::EnglishMonthName[$1] /o; + $today =~ s/20([7|8|9]\d{1})/19$1/o; + } + } + join('',$today,$_[0]); +} + +1; + +############################################################################### diff --git a/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo2html.tex b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo2html.tex new file mode 100644 index 00000000000..37f83588ee5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcsinfo/rcsinfo2html.tex @@ -0,0 +1,174 @@ +%% +%% This is file `rcsinfo2html.tex', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% rcsinfo.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 rcsinfo2html.tex. +%% +%% For distribution of the original source see the terms +%% for copying and modification in the file rcsinfo.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.) + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% +%% `rcsinfo' package to use with LaTeX2e. +%% +%% This package is used to extract the revision and file information provided +%% by the RCS revision control system. +%% A PERL-package supporting rcsinfo and LaTeX2HTML is provieded too. +%% +%% Copyright (C) 1995 Dr. Juergen Vollmer +%% Viktoriastrasse 15, D-76133 Karlsruhe, Germany +%% Juergen.Vollmer@informatik-vollmer.de +%% 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. +%% +%% If you find this software useful, please send me a postcard. +%% +%% $Id: rcsinfo.dtx,v 1.7 2005/02/25 08:37:03 vollmer draft vollmer $ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%% \CheckSum{397} +%% \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} +\usepackage{html} +\usepackage{rcsinfo} + +\begin{htmlonly} +\input{rcsinfo2html.aux} +\end{htmlonly} + +\newcommand{\LatexToHtml}{\LaTeX 2\texttt{HTML}} +\newcommand{\Var}[1]{\texttt{\$rcsinfo::#1}} +\newcommand{\RCS}{\emph{RCS}} + +\pagestyle{fancy} + +\begin{document} +\rcsInfo $Id: rcsinfo.dtx,v 1.7 2005/02/25 08:37:03 vollmer draft vollmer $ + +\author{Dr.~J{\"u}rgen Vollmer\\ + Viktoriastra{\ss}e 15, D-76133 Karlruhe, Germany\\ + \small{\texttt{Juergen.Vollmer@informaktik-vollmer.de}}} +\date{\today} +\title{Example for converting a \LaTeX\ document to \texttt{HTML}\\ + using \LatexToHtml\ and the \texttt{rcsinfo}-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|\rcsInfo...| commands give no value. + +\item If using the \LatexToHtml\ tool, only the last \verb|\rcsInfo| takes + effect, e.g.~if using several input files each having the \verb|\rcsInfo| + 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|rcsinfo| package, + the date of the \verb|ADDRESS| at the bottom of the \texttt{HTML} + page is set to the \RCS\ 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|$rcsinfo::SetAddressProc|. + E.g.\ if you have a \texttt{perl} routine \verb|&my_address_field|, + then \\ + \verb|$rcsinfo::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 ' . + $rcsinfo::Date . + ' by ' . + '<a href="mailto: Juergen.Vollmer@informatik-vollmer.de">' . + 'Dr. Juergen Vollmer ' . + '<Juergen.Vollmer@informatik-vollmer.de></a>'; +} +$rcsinfo::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|\rcsInfoFile| & \Var{File} & \rcsInfoFile \\ +\verb|\rcsInfoOwner| & \Var{Owner} & \rcsInfoOwner \\ +\verb|\rcsInfoStatus| & \Var{Status} & \rcsInfoStatus \\ +\verb|\rcsInfoLocker| & \Var{Locker} & \rcsInfoLocker \\ +\verb|\rcsInfoDate| & \Var{Date} & \rcsInfoDate \\ +\verb|\rcsInfoLongDate| & \Var{LongDate} & \rcsInfoLongDate \\ +\verb|\rcsInfoDay| & \Var{Day} & \rcsInfoDay \\ +\verb|\rcsInfoMonth| & \Var{Month} & \rcsInfoMonth \\ +\verb|\rcsInfoYear| & \Var{Year} & \rcsInfoYear \\ +\end{tabular} + +\end{document} +\endinput +%% +%% End of file `rcsinfo2html.tex'. |