diff options
author | Karl Berry <karl@freefriends.org> | 2009-03-27 17:35:58 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-03-27 17:35:58 +0000 |
commit | d72adc4188250dc65f067469817b19bdf48db2b0 (patch) | |
tree | 1ccf0fe39b00af5be2dc54a66dac545a21452cfe /Master/texmf-dist/doc/latex | |
parent | fcbfe57b79d94ecbaa2abcd79da6545496aa01cc (diff) |
new latex package rcs-multi (24mar09)
git-svn-id: svn://tug.org/texlive/trunk@12531 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r-- | Master/texmf-dist/doc/latex/rcs-multi/README | 59 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/rcs-multi/example.pdf | bin | 0 -> 41770 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/rcs-multi/example.tex | 162 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/rcs-multi/rcs-multi.pdf | bin | 0 -> 618485 bytes |
4 files changed, 221 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/rcs-multi/README b/Master/texmf-dist/doc/latex/rcs-multi/README new file mode 100644 index 00000000000..b7b00f7c56d --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcs-multi/README @@ -0,0 +1,59 @@ +-------------------------------------------------------------- + rcs-multi + version 0.1, Mar 23rd, 2009 +-------------------------------------------------------------- + +This package lets you typeset keywords of the version +control system RCS inside your LaTeX files anywhere +you like. Like the very similar package 'svn-multi' the usage of +multiple files for one LaTeX document is well supported. + +Copyright (C) 2009 Martin Scharrer +E-mail: martin@scharrer-online.de +WWW: http://www.scharrer-online.de/latex/rcs-multi/ + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3c +of this license or (at your option) any later version. +The latest version of this license is in + http://www.latex-project.org/lppl.txt +and version 1.3c or later is part of all distributions of LaTeX +version 2008/05/04 or later. + +This work has the LPPL maintenance status `maintained'. + +The Current Maintainer of this work is Martin Scharrer. + + + +Tiny example: +~~~~~~~~~~~~~ +Put the following RCS keyword at the start of all your LaTeX files of +your document: + +\rcsid{$Id$} + +RCS will expand the keyword the next time the files are committed and +then the RCS information can be typeset using + \rcsauthor, \rcsrev, \rcsdate, \rcshour, ... +which will hold the information of the latest comitted file +anywhere in your multi-file LaTeX document. + +Also per-file macros exist: + \rcsfileauthor, \rcsfilerev, ... +which hold the keyword values of the current file. + + +INSTALL: +~~~~~~~~ +From the .dtx file (if you don't get the .sty files directly): +================== +Unpack the zip file and run 'make'. +You also can do it manually: + [pdf]latex rcs-multi.ins # for the style file and perl script + [pdf]latex rcs-multi.dtx # for the documentation +2x[pdf]latex example-main # for the example + +Place the .sty file rcs-multi.sty into your TEXMF tree, e.g. in + $TEXMF/tex/latex/rcs-multi + diff --git a/Master/texmf-dist/doc/latex/rcs-multi/example.pdf b/Master/texmf-dist/doc/latex/rcs-multi/example.pdf Binary files differnew file mode 100644 index 00000000000..06fd465cfb1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcs-multi/example.pdf diff --git a/Master/texmf-dist/doc/latex/rcs-multi/example.tex b/Master/texmf-dist/doc/latex/rcs-multi/example.tex new file mode 100644 index 00000000000..827d7949b4a --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcs-multi/example.tex @@ -0,0 +1,162 @@ +\documentclass[12pt]{report} +\usepackage{rcs-multi} +% Version control information: +\rcsid{$Id: example.tex,v 1.2 2009/03/23 19:07:46 martin Exp martin $} +% or, alternatively, with full path: +\rcsid{$Header: /home/martin/src/latex/rcs-multi/dev/example.tex,v 1.2 2009/03/23 19:07:46 martin Exp martin $} + +% Other keywords can be read using: +\rcskwsave{$Author: martin $} +\rcskwsave{$Date: 2009/03/23 19:07:46 $} +\rcskwsave{$Name: $} +% The `Log' keyword is not supported. +\rcskwsave{$Locker: martin $} +\rcskwsave{$RCSfile: example.tex,v $} +\rcskwsave{$Revision: 1.2 $} +\rcskwsave{$Source: /home/martin/src/latex/rcs-multi/dev/example.tex,v $} +\rcskwsave{$State: Exp $} +% Their values can be typeset using \rcskw{Author}, \rcskw{Date}, etc. + +\usepackage{hyperref} +%\usepackage{url} + +\usepackage{fancyhdr} +\renewcommand{\headrulewidth}{0.4pt} +\renewcommand{\footrulewidth}{0.4pt} +\setlength{\headheight}{14.5pt} +% This will display the last changed date and revision of the current chapter. +% Change to `\rcsdate -- \rcsrev' if you like to have the document revision. +\newcommand{\rcsfooter}{Last Changed: \rcsfiledate -- r\rcsfilerev} + +\pdfinfo{% + /CreationDate (D:\rcspdfdate) +} + +\rcsRegisterAuthor{johnd}{John Doe} +\rcsRegisterAuthor{maryd}{Mary Doe} +\rcsRegisterAuthor{martin}{Martin S.} +\rcsRegisterRevision{1.2}{Version~1} + + +%% The two 'filecontents' environments are used to produce two example chapters. +%% Normally they are separated files from the beginning but they are packed into +%% this main file to only have one example TeX file in the CTAN ZIP file. +\begin{filecontents}{example_chap1.tex} +% Version control information: +\rcsid{$Header: /home/martin/src/latex/rcs-multi/dev/example_chap1.tex,v 1.3 2009/03/23 19:20:18 martin Exp $} + +\chapter{Example Chapter 1} + +\section*{Version} +\subsection*{This chapter} +% \url is needed because there is an underscore in the name +% The package 'underscore' seems not to work properly, so the 'hyperref' +% package is used which is not the best solution. Avoid underscore in LaTeX filenames. +Filename: \rcsnolinkurl{\rcsfilename}\\* +URL: \url{\rcsfileurl}\\* +% Something like \href{\rcskw{HeadURL}}{Download} works also! +\textbf{Last change}\\* +Revision: \rcsfilerev\\* +Date: \rcsfiledate\\* +Year: \rcsfileyear\\* +Time: \rcsfilehour:\rcsfileminute:\rcsfilesecond\\* +Author: \rcsfileauthor\\* + +\enlargethispage{\baselineskip} +\subsection*{Whole document} +Main Filename: \rcsnolinkurl{\rcsmainfilename}\\* +Main URL: \url{\rcsmainurl}\\* +\textbf{Last change}\\* +Filename: \rcsnolinkurl{\rcsname}\\* +URL: \url{\rcsurl}\\* +Revision: \rcsrev\\* +Date: \rcsdate\\* +Year: \rcsyear\\* +Time: \rcshour:\rcsminute:\rcssecond\\* +Author: \rcsauthor\\* +% [...] + +\section{Tests} +\rcsRegisterRevision{2.1}{Test} + +Registered author name: \rcsFullAuthor{\rcsfileauthor}\\* +Registered revision name: \rcsFullRevision{\rcsfilerev}\\* +Registered author name (*): \rcsFullAuthor*{\rcsfileauthor}\\* +Registered revision name (*): \rcsFullRevision*{\rcsfilerev}\\* + +\subsubsection*{Behaviour if value is not registered:} +Not registered user name: \rcsFullAuthor{someusername}\\* +Not registered revision name: \rcsFullRevision{1.4}\\* +Not registered user name (*): \rcsFullAuthor*{someusername}\\* +Not registered revision name (*): \rcsFullRevision*{1.4}\\* + + +\end{filecontents} + +\begin{filecontents}{example_chap2.tex} +% Version control information: +\rcsid{$Header: /home/martin/src/latex/rcs-multi/dev/example_chap2.tex,v 1.2 2009/03/23 19:10:56 martin Exp martin $} + +\chapter{Example Chapter 2} + +\section*{Version} +\subsection*{This chapter} +% \url is needed because there is an underscore in the name +% The package 'underscore' seems not to work properly, so the 'hyperref' +% package is used which is not the best solution. Avoid underscore in LaTeX filenames. +Filename: \rcsnolinkurl{\rcsfilename}\\ +URL: \url{\rcsfileurl}\\ +% Something like \href{\rcskw{HeadURL}}{Download} works also! +\textbf{Last change}\\ +Revision: \rcsfilerev\\ +Date: \rcsfiledate\\ +Year: \rcsfileyear\\ +Time: \rcsfilehour:\rcsfileminute:\rcsfilesecond\\ +Author: \rcsfileauthor\\ + +\enlargethispage{\baselineskip} +\subsection*{Whole document} +Main Filename: \rcsnolinkurl{\rcsmainfilename}\\ +Main URL: \url{\rcsmainurl}\\ +\textbf{Last change}\\ +Filename: \rcsnolinkurl{\rcsname}\\ +URL: \url{\rcsurl}\\ +Revision: \rcsrev\\ +Date: \rcsdate\\ +Year: \rcsyear\\ +Time: \rcshour:\rcsminute:\rcssecond\\ +Author: \rcsauthor +\end{filecontents} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\listfiles +\begin{document} + +\begin{titlepage} + \hbox{} + \pdfbookmark{Title Page}{titlepage} + \vspace{8ex} + {\huge Title\par} + \vspace{2ex} + {\large \noindent This is an example document for the \texttt{rcs-multi} + package. Please also look at the LaTeX source code of this + document.} + \vfill + \flushleft\sffamily + Version control information:\\ + Head Filename: \rcsnolinkurl{\rcsmainfilename}\\ + Head URL: \rcsnolinkurl{\rcsmainfileurl}\\ + Last changed file (name): \rcsnolinkurl{\rcsname}\\ + Last changed file (URL): \rcsnolinkurl{\rcsurl}\\ + Last changed date: \rcsdate\\ + Last changes revision: \rcsrev\\ + Version: \rcsFullRevision*{\rcsrev}\\ + Last changed by: \rcsFullAuthor*{\rcsauthor}\\ +\end{titlepage} + +% Include chapters +\include{example_chap1} +\include{example_chap2} +%\include{example_chap3} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/rcs-multi/rcs-multi.pdf b/Master/texmf-dist/doc/latex/rcs-multi/rcs-multi.pdf Binary files differnew file mode 100644 index 00000000000..ef68c29b8a7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/rcs-multi/rcs-multi.pdf |