diff options
author | Karl Berry <karl@freefriends.org> | 2011-09-03 23:14:37 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-09-03 23:14:37 +0000 |
commit | 6913dfd3cb7fbe255811ffae92d537b83a4cb1b6 (patch) | |
tree | 8cd8eb9a946b031d394f78674104f8d4d1989d6a /Master/texmf-dist/source/latex/svn-multi | |
parent | ea16ae60028a1e6e1820c3a99a66a74369259f8c (diff) |
svn-multi update (2sep11)
git-svn-id: svn://tug.org/texlive/trunk@23782 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/svn-multi')
3 files changed, 264 insertions, 265 deletions
diff --git a/Master/texmf-dist/source/latex/svn-multi/svn-multi-pl.dtx b/Master/texmf-dist/source/latex/svn-multi/svn-multi-pl.dtx index 83d26da4a30..f328b4b651d 100644 --- a/Master/texmf-dist/source/latex/svn-multi/svn-multi-pl.dtx +++ b/Master/texmf-dist/source/latex/svn-multi/svn-multi-pl.dtx @@ -12,7 +12,7 @@ # E-mail: martin@scharrer-online.de # WWW: http://latex.scharrer-online.de/svn-multi/ # -# $Id: svn-multi-pl.dtx 1873 2010-07-26 15:31:45Z martin $ +# $Id$ # # This program works only in combination with the LaTeX package 'svn-multi' and # generates .svx files with '\svnidlong' macros holding Subversion keywords for @@ -59,15 +59,15 @@ %<*driver> \fi \makeatletter -% $Id: svn-multi-pl.dtx 1873 2010-07-26 15:31:45Z martin $ +% $Id$ \def\svnmultipl@version {v0.1a} \def\svnmultipl@rev $#1: #2 ${\def\svnmultipl@rev{#2}} \def\svnmultipl@date $#1: #2-#3-#4 #5 ${% \def\svnmultipl@today{{\year#2\month#3\day#4\today}}% \def\svnmultipl@date{#2/#3/#4}% } -\svnmultipl@rev $Rev: 1873 $ -\svnmultipl@date $Date: 2010-07-26 16:31:45 +0100 (Mon, 26 Jul 2010) $ +\svnmultipl@rev $Rev$ +\svnmultipl@date $Date$ \ProvidesFile{svn-multi-pl.dtx} [\svnmultipl@date\space\svnmultipl@version\space SVN Keywords extractor for svn-multi] @@ -166,7 +166,7 @@ use File::Basename; % \begin{macrocode} my $VERSION = "0.2"; my ($REV,$DATE) = - (split ' ','$Id: svn-multi-pl.dtx 1873 2010-07-26 15:31:45Z martin $')[2,3]; + (split ' ','$Id$')[2,3]; % \end{macrocode} % Declaration of other global constants and variables: diff --git a/Master/texmf-dist/source/latex/svn-multi/svn-multi.dtx b/Master/texmf-dist/source/latex/svn-multi/svn-multi.dtx index eb1dc815e90..e5ea263ed23 100644 --- a/Master/texmf-dist/source/latex/svn-multi/svn-multi.dtx +++ b/Master/texmf-dist/source/latex/svn-multi/svn-multi.dtx @@ -18,28 +18,16 @@ % This work consists of the files svn-multi.dtx and svn-multi.ins % and the derived files svn-multi.sty and svnkw.sty. % -% <*driver> -\makeatletter -% </driver> % \fi % \iffalse -%<*package|driver> -% $Id: svn-multi.dtx 2431 2011-04-01 23:00:26Z martin $ -% -\def\svnmulti@version{v2.4c} -\RequirePackage{svn-prov}[2010/04/14] -%</package|driver> %<*driver> -\ProvidesFileSVN{$Id: svn-multi.dtx 2431 2011-04-01 23:00:26Z martin $} - [\svnmulti@version\space SVN Keywords for multi-file LaTeX documents] -\DefineFileInfoSVN[svnmulti] -\GetFileInfoSVN* +\ProvidesFile{svn-multi.dtx}[2011/08/30 svn-multi DTX file] \documentclass{ydoc}[2011/03/19] \usepackage[english]{babel} \dateenglish -\usepackage{svn-multi}[\svnmulti@date] +\usepackage{svn-multi}[2011/08/30] \newcommand{\ie}{i.e.\@\xspace} \newcommand{\eg}{e.g.\@\xspace} @@ -67,10 +55,9 @@ \PrintIndex \end{document} %</driver> -%<*package> % \fi % -% \CheckSum{2887} +% \CheckSum{2893} % % {\makeatother % \CharacterTable @@ -111,9 +98,9 @@ % \cs{svnfiletoday}.} % \changes{v2.0}{2009/03/23}{New features: keyword groups, external file % support, auto-include of images, files as subgroups and table of revisions.} -% \changes{v2.1}{2009/03/27}{Added automatic extraction of keywords from +% \changes{v2.1}{2009/03/27}{Added automatic extraction of keywords from % Subversion 'entries' file: 'autokw' option} -% \changes{v2.2}{2009/10/19}{Added \css{ifsvnmodified} and +% \changes{v2.2}{2009/10/19}{Added \css{ifsvnmodified} and % \css{ifsvnfilemodified} macros. Some bug fixes.} % \changes{v2.3}{2010/03/30}{Changed \css{svnidlong} to ignore all comments between verbatim arguments.} % \changes{v2.3}{2010/07/19}{ @@ -141,6 +128,7 @@ % } % \changes{v2.4b}{2011/03/20}{Fix for non-ASCII characters in keywords. Added group check for \cs{svnexternal}.} % \changes{v2.4c}{2011/04/02}{Fix for modified marker 'M' used in \cs{svnid}.} +% \changes{v2.4d}{2011/08/30}{Fix for \cs{include} files in table-of-revisions.} % % ^^A \GetFileInfo{svn-multi.dtx} % @@ -175,21 +163,22 @@ % \email{martin@scharrer-online.de} % \date{Version \expandafter\@gobble\svnmulti@version\\[0.5ex]\svnmulti@today} % +% \GetFileInfo[svn-multi.dtx] % \maketitle % % \section{Introduction} -% This package allows to typeset version control (VC) information provided by -% Subversion\footnote{Subversion homepage: \url{http://subversion.tigris.org/}} -% keywords (\eg |$||Id: ... $|) in \LaTeX\ documents which can contain of +% This package allows to typeset version control (VC) information provided by +% Subversion\footnote{Subversion homepage: \url{http://subversion.tigris.org/}} +% keywords (\eg |$||Id: ... $|) in \LaTeX\ documents which can contain of % multiple |.tex| files included using |\include| or |\input|. -% Subversion is a modern version control system designed to replace its +% Subversion is a modern version control system designed to replace its % predecessor CVS and uses integers as revision numbers. % -% This package reads the keywords of all files and provides the VC information -% of of the most recent changed file of the document to the user through a set -% of macros. This information is written to an auxiliary |.aux| file during the -% first \LaTeX\ run and read back at the next which introduces the same delay -% known from the table of contents. The standard \LaTeX{} switch |\nofiles| can +% This package reads the keywords of all files and provides the VC information +% of of the most recent changed file of the document to the user through a set +% of macros. This information is written to an auxiliary |.aux| file during the +% first \LaTeX\ run and read back at the next which introduces the same delay +% known from the table of contents. The standard \LaTeX{} switch |\nofiles| can % be used to suppress the file generation. % % In addition to this basic functionality several more features are provided: @@ -207,51 +196,51 @@ % document-global, file-local and, new with v2.0, by group. % % \subsubsection*{Document Global} -% The document global macros, like \cs{svnrev}, return the latest version -% control information (keyword data) for the whole multi-file document, \ie the -% information of the latest changed file of the document. To collect, sort and +% The document global macros, like \cs{svnrev}, return the latest version +% control information (keyword data) for the whole multi-file document, \ie the +% information of the latest changed file of the document. To collect, sort and % provide this information is the main functionality of this package. % % \subsubsection*{Local to Current File} -% There are also file-local macros, \eg \cs{svnfilerev}, which return the -% version control information of the current file, \ie the file they are used -% in. It is assumed here that every file using this macros calls first either a -% \cs{svnid} or \cs{svnidlong} macro or both. See section~\ref{sec:usage:id} -% for more details about the id macros. Please note that the file-local macros -% technically actually return the \emph{last registered} information from the -% last \cs{svnid} or \cs{svnidlong}. As long the \opt{filehooks} option (new in -% v2.0) is not enabled (explicit or implicit) this keyword macros will leak from -% one file over to the next. This will cause wrong results if they are used in -% a file before or without any id macros. With this option the macros will be +% There are also file-local macros, \eg \cs{svnfilerev}, which return the +% version control information of the current file, \ie the file they are used +% in. It is assumed here that every file using this macros calls first either a +% \cs{svnid} or \cs{svnidlong} macro or both. See section~\ref{sec:usage:id} +% for more details about the id macros. Please note that the file-local macros +% technically actually return the \emph{last registered} information from the +% last \cs{svnid} or \cs{svnidlong}. As long the \opt{filehooks} option (new in +% v2.0) is not enabled (explicit or implicit) this keyword macros will leak from +% one file over to the next. This will cause wrong results if they are used in +% a file before or without any id macros. With this option the macros will be % reset at the beginning of every source file of the document. % % \subsubsection*{Groups} -% Version 2.0 introduces the concept of groups. Several files of a multi-file -% \LaTeX\ document can be grouped together and the latest version control -% information of all files of a group is provided by macros. This works in the -% same way as the global macros mentioned above but only with the files in the -% group. It can also be seen from the other side: the macros are local like the -% file-local macros mentioned above but for all files of the group, not only the +% Version 2.0 introduces the concept of groups. Several files of a multi-file +% \LaTeX\ document can be grouped together and the latest version control +% information of all files of a group is provided by macros. This works in the +% same way as the global macros mentioned above but only with the files in the +% group. It can also be seen from the other side: the macros are local like the +% file-local macros mentioned above but for all files of the group, not only the % current one. % -% These groups could also be called \textit{file groups}, \textit{keyword -% groups} or, like in programming languages, \textit{namespaces}. In this manual -% they will be reference as simple \textit{groups} most the time. In places -% where they could be confused with \TeX\ groups (|{ }|, |\begingroup| -% |\endgroup|), \eg ``in the current group'' or ``group local'', they will be +% These groups could also be called \textit{file groups}, \textit{keyword +% groups} or, like in programming languages, \textit{namespaces}. In this manual +% they will be reference as simple \textit{groups} most the time. In places +% where they could be confused with \TeX\ groups (|{ }|, |\begingroup| +% |\endgroup|), \eg ``in the current group'' or ``group local'', they will be % called \textit{keyword groups}. % -% There is no limitation (besides internal \LaTeX\ resource limits) for the -% number of different groups. The files of one group do not have to be included -% in a row but can be included everywhere in the document. The version control -% information of the current group can be typeset with macros like \cs{svncgrev} -% (|cg| for \emph{current group}). Also, a general but less robust macro -% \cs{svng}\marg{group name}\marg{key} is provided to access others groups by -% name everywhere in the document. To avoid some macro robustness problems the -% current group can be changed locally for the output macros using +% There is no limitation (besides internal \LaTeX\ resource limits) for the +% number of different groups. The files of one group do not have to be included +% in a row but can be included everywhere in the document. The version control +% information of the current group can be typeset with macros like \cs{svncgrev} +% (|cg| for \emph{current group}). Also, a general but less robust macro +% \cs{svng}\marg{group name}\marg{key} is provided to access others groups by +% name everywhere in the document. To avoid some macro robustness problems the +% current group can be changed locally for the output macros using % \cs{svnsetcg}\marg{group name}. % -% See section~\ref{sec:group} for further details and usage instructions on +% See section~\ref{sec:group} for further details and usage instructions on % group macros. % % \section{Usage} @@ -260,9 +249,9 @@ % different macros. % % \subsection{Package Options} -% Since v2.0 this package provides options to enable only a needed features, \eg -% to avoid problems with other packages or save \TeX\ memory. For backwards -% compatibility to pre-2.0 package versions all old features are enabled by +% Since v2.0 this package provides options to enable only a needed features, \eg +% to avoid problems with other packages or save \TeX\ memory. For backwards +% compatibility to pre-2.0 package versions all old features are enabled by % default and all new features are disabled to save a little of \TeX\ memory. % % All options except the first two are boolean key=value options (so far) and @@ -273,180 +262,180 @@ % The available options are:\par % % \DescribeOption{old} -% Only pre-v2.0 features are active. This enables \opt{verbatim} and disables all +% Only pre-v2.0 features are active. This enables \opt{verbatim} and disables all % other options below. This is the default for reasons mentioned above. % % \DescribeOption{all} % Activates all features of the package except of the experimental ones. % % \DescribeOption{verbatim} -% Controls the verbatim mode of the keyword parser macros. Normally verbatim -% mode is very much wanted to support strange characters in URLs and file names, -% but this options gives the user a possibility to disable verbatim, \eg for -% trouble shooting. Please note that verbatim mode is needed in order to make +% Controls the verbatim mode of the keyword parser macros. Normally verbatim +% mode is very much wanted to support strange characters in URLs and file names, +% but this options gives the user a possibility to disable verbatim, \eg for +% trouble shooting. Please note that verbatim mode is needed in order to make % \svnmulti work with some packages, like \pkg{babel} with the |french| option. % % \DescribeOption{external} -% Controls the support for keywords from external files described in -% section~\ref{sec:external}. This needs either the external script +% Controls the support for keywords from external files described in +% section~\ref{sec:external}. This needs either the external script % \scr{svn-multi.pl} or the \opt{autokw} option. % -% If the \opt{groups} option is enabled the macro -% \csi{svnexternalgroup}\marg{group name} can be used to declare a own group -% which is used for all the external files. Otherwise they are placed in the -% currently active group. This macro can be used several times during the -% document where an empty argument means \emph{no group} and a `|*|' means +% If the \opt{groups} option is enabled the macro +% \csi{svnexternalgroup}\marg{group name} can be used to declare a own group +% which is used for all the external files. Otherwise they are placed in the +% currently active group. This macro can be used several times during the +% document where an empty argument means \emph{no group} and a `|*|' means % \emph{current group}. % % \DescribeOption{groups} % Controls the keyword groups feature described in section~\ref{sec:group}. % % \DescribeOption{subgroups} -% Controls the automatic declaration of all input files as subgroups so that -% there keyword information can be typeset inside other files. The group name is +% Controls the automatic declaration of all input files as subgroups so that +% there keyword information can be typeset inside other files. The group name is % the file path without the file extension (`|subdir/filebase|'). -% It is possible to disable and re-enable this using \cs{svnsubgroupsfalse} and -% \cs{svnsubgroupstrue} during the document preamble or body to exclude certain +% It is possible to disable and re-enable this using \cs{svnsubgroupsfalse} and +% \cs{svnsubgroupstrue} during the document preamble or body to exclude certain % files. See section~\ref{sec:subgroups} for additional information. % % \DescribeOption{graphics} -% This option allows to automatically declare all images included using the -% macro |\includegraphics| from the \pkg{graphics}/\pkg{graphicx} package as -% external files (see section~\ref{sec:external}). The options \opt{external} and -% \opt{autoload} are activated by this option so that the produced |.svx| files -% are loaded automatically. An |autoload=false| option after \pkg{graphics} -% will deactivate this, but then an \cs{svnexternal} macro must be included in -% all \LaTeX\ files which should take the image revisions into account.\par The -% \pkg{graphics} package is loaded if this option is active. If this package is -% needed with some special options it should be loaded by the \LaTeX\ document -% before \svnmulti.\par Please note that this feature needs to tie itself into -% the \pkg{graphics} package and might fail if the internal structure of this +% This option allows to automatically declare all images included using the +% macro |\includegraphics| from the \pkg{graphics}/\pkg{graphicx} package as +% external files (see section~\ref{sec:external}). The options \opt{external} and +% \opt{autoload} are activated by this option so that the produced |.svx| files +% are loaded automatically. An |autoload=false| option after \pkg{graphics} +% will deactivate this, but then an \cs{svnexternal} macro must be included in +% all \LaTeX\ files which should take the image revisions into account.\par The +% \pkg{graphics} package is loaded if this option is active. If this package is +% needed with some special options it should be loaded by the \LaTeX\ document +% before \svnmulti.\par Please note that this feature needs to tie itself into +% the \pkg{graphics} package and might fail if the internal structure of this % package changes in future versions. % -% If the \opt{groups} option is enabled the macro -% \csi{svngraphicsgroup}\marg{group name} can be used to declare a own group -% which is used for all the graphic files (also for pgf images, see below). -% Otherwise they are placed in the group specified by \cs{svnexternalgroup} -% which defaults to the currently active group. This macro can be used several -% times during the document where an empty argument means \emph{no group} and a -% `|*|' means \emph{current group}.\par Some graphics like logos can appear -% frequently in a document. Do not count them as part of each chapter they can -% be ignored using \csi{svnignoregraphic}\marg{file path}. The macro -% \csi{svnconsidergraphic}\marg{file path} disables this again. Such graphics -% can be then included manually using an explicit \cs{svnexternal} macro. +% If the \opt{groups} option is enabled the macro +% \csi{svngraphicsgroup}\marg{group name} can be used to declare a own group +% which is used for all the graphic files (also for pgf images, see below). +% Otherwise they are placed in the group specified by \cs{svnexternalgroup} +% which defaults to the currently active group. This macro can be used several +% times during the document where an empty argument means \emph{no group} and a +% `|*|' means \emph{current group}.\par Some graphics like logos can appear +% frequently in a document. Do not count them as part of each chapter they can +% be ignored using \csi{svnignoregraphic}\marg{file path}. The macro +% \csi{svnconsidergraphic}\marg{file path} disables this again. Such graphics +% can be then included manually using an explicit \cs{svnexternal} macro. % % \DescribeOption{pgfimages} -% Identical to like the \opt{graphics} option but for the \pkg{pgf} package -% (implemented against the version from 2008/01/15) with the |\pgfuseimage| and -% |\pgfimage| macros. Please also see the notes about package loading and ties -% mentioned above. +% Identical to like the \opt{graphics} option but for the \pkg{pgf} package +% (implemented against the version from 2008/01/15) with the |\pgfuseimage| and +% |\pgfimage| macros. Please also see the notes about package loading and ties +% mentioned above. % % \DescribeOption{autoload} -% Controls automatic loading of corresponding |.svx| files at the begin of files -% included using |\input| or |\import|. This avoids the need of putting an -% \cs{svnexternal} macro in every file just to load the |.svx| files created -% automatically by the \opt{graphics} option. The option \opt{external} is -% activated by \opt{autoload}. +% Controls automatic loading of corresponding |.svx| files at the begin of files +% included using |\input| or |\import|. This avoids the need of putting an +% \cs{svnexternal} macro in every file just to load the |.svx| files created +% automatically by the \opt{graphics} option. The option \opt{external} is +% activated by \opt{autoload}. % % \DescribeOption{table} -% Controls the generation of a table of revisions which can be included using -% the \cs{tableofrevisions} macro. This table shows the revisions of all files -% and groups. This needs \opt{groups} to work which is activated with \opt{table}. -% Enable \opt{subgroups} to include a list of all files per group. See the +% Controls the generation of a table of revisions which can be included using +% the \cs{tableofrevisions} macro. This table shows the revisions of all files +% and groups. This needs \opt{groups} to work which is activated with \opt{table}. +% Enable \opt{subgroups} to include a list of all files per group. See the % section~\ref{sec:table} for more information. % % \DescribeOption{filehooks} -% This option loads the \pkg{filehook} package and installs at-begin-input-file and -% at-end-input-file hooks which are needed for many of the options above. While -% this option is enabled automatically if needed it can be also enabled -% manually to ensure that the file-local macros are reset to empty values at -% the begin of each input file. This prevents the keyword from leaking over -% from one file to the next. After every subfile the file-local keyword macros +% This option loads the \pkg{filehook} package and installs at-begin-input-file and +% at-end-input-file hooks which are needed for many of the options above. While +% this option is enabled automatically if needed it can be also enabled +% manually to ensure that the file-local macros are reset to empty values at +% the begin of each input file. This prevents the keyword from leaking over +% from one file to the next. After every subfile the file-local keyword macros % are also restored to the value of the parent file. A \cs{clearpage} should be -% added at the very end of \cs{include}d files to ensure the last page is flushed -% out by \TeX\ before the keyword macros are restored. Otherwise the last page +% added at the very end of \cs{include}d files to ensure the last page is flushed +% out by \TeX\ before the keyword macros are restored. Otherwise the last page % might display the mainfile keyword values. % % \DescribeOption{autokw} -% This experimental feature allows the automatically extraction of the keyword -% values from the hidden Subversion working copy database. The database (a text -% file called `|entries|') is located in the hidden Subversion directory -% `|.svn|' (or `|_svn|' on some Windows installations) inside every directory +% This experimental feature allows the automatically extraction of the keyword +% values from the hidden Subversion working copy database. The database (a text +% file called `|entries|') is located in the hidden Subversion directory +% `|.svn|' (or `|_svn|' on some Windows installations) inside every directory % which is under VC. % -% This feature makes an external script like \scr{svn-multi.pl} or even keyword -% macros redundant as long the files are inside a Subversion working directory. -% However, this feature does not work if the files are exported (\eg with -% \texttt{svn~export}) or manually copied and also depends on the used version -% of Subversion. Only versions starting with 1.4 (with working copy format -% version 7) are supported. Earlier version used a different format for the -% |entries| file. Newer versions should be compatible as long the basic format +% This feature makes an external script like \scr{svn-multi.pl} or even keyword +% macros redundant as long the files are inside a Subversion working directory. +% However, this feature does not work if the files are exported (\eg with +% \texttt{svn~export}) or manually copied and also depends on the used version +% of Subversion. Only versions starting with 1.4 (with working copy format +% version 7) are supported. Earlier version used a different format for the +% |entries| file. Newer versions should be compatible as long the basic format % is not changed again. % % The experimental status will be lifted after the feature was tested using -% different Subversion versions on different platforms. Please do not hesitate -% to send error reports to the package author. Minimal examples and information +% different Subversion versions on different platforms. Please do not hesitate +% to send error reports to the package author. Minimal examples and information % about the used Subversion version and platform are very much appreciated. % % This option allows the following values: % \begin{description} % \item[\texttt{false}] Feature is disabled (default). -% \item[\textnormal{\sffamily No value or \textbf{\texttt{true}} or -% \textbf{\texttt{all}}}] The keywords of all files are automatically -% extracted. No \cs{svnid} or \cs{svnidlong} macros or external scripts are -% necessary as long the files are inside a Subversion working directory and +% \item[\textnormal{\sffamily No value or \textbf{\texttt{true}} or +% \textbf{\texttt{all}}}] The keywords of all files are automatically +% extracted. No \cs{svnid} or \cs{svnidlong} macros or external scripts are +% necessary as long the files are inside a Subversion working directory and % not exported. -% \item[\texttt{ext}] Only the keywords of external files are extracted. This -% avoids the need of the \scr{svn-multi.pl} script. The option \opt{external} +% \item[\texttt{ext}] Only the keywords of external files are extracted. This +% avoids the need of the \scr{svn-multi.pl} script. The option \opt{external} % must be still enabled manually. % \end{description} % % \subsection{Including Subversion Keywords}\label{sec:usage:id} -% Subversion keywords are included using \cs{svnid} or \cs{svnidlong}. These -% macros should be written very early in each file, \ie in the preamble of the -% main document soon after |\documentclass| and |\usepackage{svn-multi}| and as -% first in \emph{every} subfile before an |\chapter| or similar macro. They do -% not create any output. See section~\ref{sec:kwaccess} to learn how to typeset +% Subversion keywords are included using \cs{svnid} or \cs{svnidlong}. These +% macros should be written very early in each file, \ie in the preamble of the +% main document soon after |\documentclass| and |\usepackage{svn-multi}| and as +% first in \emph{every} subfile before an |\chapter| or similar macro. They do +% not create any output. See section~\ref{sec:kwaccess} to learn how to typeset % the keyword values. % -% \DescribeMacro{svnid}{'$Id: svn-multi.dtx 2431 2011-04-01 23:00:26Z martin $'} -% The macro is for the |Id| keyword and must be written like shown. A trailing -% colon with or without spaces after the `|Id|' is also valid but -% \textbf{everything else} except a valid Subversion string will cause a \TeX{} -% parse error. The subversion property |svn:keywords| must be set on all source +% \DescribeMacro{svnid}{'$Id$'} +% The macro is for the |Id| keyword and must be written like shown. A trailing +% colon with or without spaces after the `|Id|' is also valid but +% \textbf{everything else} except a valid Subversion string will cause a \TeX{} +% parse error. The subversion property |svn:keywords| must be set on all source % files and include `|Id|' so that Subversion will expand it at the next commit. % % \begin{DescribeMacrosTab}{l} % \Macro\svnidlong\\ -% \MacroArgs{'$HeadURL: svn+ssh://scharrer-online.de/home/martin/svn/src/trunk/latex/svn-multi/dev/svn-multi.dtx $'} \\ -% \MacroArgs{'$LastChangedDate: 2011-04-02 00:00:26 +0100 (Sat, 02 Apr 2011) $'} \\ -% \MacroArgs{'$LastChangedRevision: 2431 $'} \\ -% \MacroArgs{'$LastChangedBy: martin $'} \\ +% \MacroArgs{'$HeadURL$'} \\ +% \MacroArgs{'$LastChangedDate$'} \\ +% \MacroArgs{'$LastChangedRevision$'} \\ +% \MacroArgs{'$LastChangedBy$'} \\ % \end{DescribeMacrosTab} -% Macro for a ``long Id''. Saves similar values like in `|Id|' but from the -% above four keywords. The usage of \cs{svnid} or \cs{svnidlong} is a matter of -% taste. The second is more readable inside the code and results in a nicer date -% and a full URL, not only the filename. However, both can also be used -% together. In this case the \cs{svnid} macro should be come last. Because its -% revision is not higher (but identical) than the revision of the \cs{svnidlong} -% macro it does not override its values. This way both the full time zone from -% the long and the file name from the short id macro can be accessed. Please -% note that all features from the 2.x version load the \pkg{currfile} package which -% lets you typeset the current file name anyway using -% |\currfilename|\footnote{The file name in \texttt{\${}Id\$} is always the -% original Subversion file name while the one given by the \pkg{currfile} package is +% Macro for a ``long Id''. Saves similar values like in `|Id|' but from the +% above four keywords. The usage of \cs{svnid} or \cs{svnidlong} is a matter of +% taste. The second is more readable inside the code and results in a nicer date +% and a full URL, not only the filename. However, both can also be used +% together. In this case the \cs{svnid} macro should be come last. Because its +% revision is not higher (but identical) than the revision of the \cs{svnidlong} +% macro it does not override its values. This way both the full time zone from +% the long and the file name from the short id macro can be accessed. Please +% note that all features from the 2.x version load the \pkg{currfile} package which +% lets you typeset the current file name anyway using +% |\currfilename|\footnote{The file name in \texttt{\${}Id\$} is always the +% original Subversion file name while the one given by the \pkg{currfile} package is % the current file name. Both could differ if the file got renamed.}. Before v2.3 % the \pkg{fink} package was used to provide the file names. % -% This macro must be written like seen above while the order of arguments is not -% meaningfull. The Subversion property |svn:keywords| must be set on all source -% files with an value which includes `|HeadURL| |LastChangedDate| -% |LastChangedRevision| |LastChangedBy|' or one of their alternative spellings +% This macro must be written like seen above while the order of arguments is not +% meaningfull. The Subversion property |svn:keywords| must be set on all source +% files with an value which includes `|HeadURL| |LastChangedDate| +% |LastChangedRevision| |LastChangedBy|' or one of their alternative spellings % (\eg `|URL|', `|Rev|', `|Date|', etc.). % -% Please note that the arguments are read verbatim as long the \opt{verbatim} -% option is not disabled explicitly. Special precaution are taken to allow -% spaces, newlines and comments direct after the |\svnidlong| and after each of +% Please note that the arguments are read verbatim as long the \opt{verbatim} +% option is not disabled explicitly. Special precaution are taken to allow +% spaces, newlines and comments direct after the |\svnidlong| and after each of % the four arguments. In fact everything not inside braces |{ }| is ignored. % % \DescribeMacro{svn}{'$'<keyword>'$'} @@ -469,31 +458,31 @@ % activate these macros. % % \DescribeMacro{svngroup}{<\/group name>} -% This macro declares all following files until the next \cs{svngroup} as part -% of the given keyword group. It can be placed inside the main file before some -% |\include|/|\input| macros or inside subfiles before the id macros, \ie direct +% This macro declares all following files until the next \cs{svngroup} as part +% of the given keyword group. It can be placed inside the main file before some +% |\include|/|\input| macros or inside subfiles before the id macros, \ie direct % at the start of the file. -% -% The changes done by this macro are \TeX\ global, \ie there can't be caught -% using \TeX\ groups (|{ }|). However, in order to prevent subfiles to change -% the group of the rest of the parent file the group will be restored to the +% +% The changes done by this macro are \TeX\ global, \ie there can't be caught +% using \TeX\ groups (|{ }|). However, in order to prevent subfiles to change +% the group of the rest of the parent file the group will be restored to the % previous one at the end of each input file. % -% The latest VC information of a group can be typeset with the |\svnvgXXX| +% The latest VC information of a group can be typeset with the |\svnvgXXX| % macros or the \cs{svng} macro shown in section~\ref{sec:kwaccess}. % % \DescribeMacro{thesvngroup} % Returns the name of the current keyword group. % % \DescribeMacro{svnsetcg}{<\/group name>} -% Normally the |\svncgXXX| macros mentioned below use the last keyword -% group defined by \cs{svngroup} but this can be changed using the \cs{svnsetcg} -% macro. The idea behind it is that the currently selected group can be -% changed locally to the current \TeX\ group for the keyword output macros -% |\svncgXXX| only while the group for the keyword input macros like \cs{svnid} +% Normally the |\svncgXXX| macros mentioned below use the last keyword +% group defined by \cs{svngroup} but this can be changed using the \cs{svnsetcg} +% macro. The idea behind it is that the currently selected group can be +% changed locally to the current \TeX\ group for the keyword output macros +% |\svncgXXX| only while the group for the keyword input macros like \cs{svnid} % is unaffected. % -% To reset the used group to the last one defined by \cs{svngroup} simply use +% To reset the used group to the last one defined by \cs{svngroup} simply use % \cs{svnsetcg} with an `|*|' as argument. % % \paragraph*{Example 1:} |{\svnsetcg{abc}\svnFullAuthor{\svncgauthor}}|\\ would @@ -510,11 +499,11 @@ % Returns the name of the current group selected by \cs{svnsetcg}. % % \subsubsection{Files as Subgroups}\label{sec:subgroups} -% The group feature could be used to access the version control information of -% single files anywhere in the document when these are defined as own groups for -% themselves. Because a file can only be in one group this would not be -% compatible with the normal usage of the group feature. Therefore a special -% feature was introduced to automatically or manually define a file as subgroup +% The group feature could be used to access the version control information of +% single files anywhere in the document when these are defined as own groups for +% themselves. Because a file can only be in one group this would not be +% compatible with the normal usage of the group feature. Therefore a special +% feature was introduced to automatically or manually define a file as subgroup % for itself which does not influence its membership in a normal group. % \paragraph{Declaration:} % This feature is enabled by the \opt{subgroups} option. All files of the @@ -524,7 +513,7 @@ % declared as extra group with the \cs{svnsubgroup} macro.\par % % \DescribeMacro{svnsubgroup} -% This macro declares the current file as subgroup. It is used automatically for +% This macro declares the current file as subgroup. It is used automatically for % every subfile if \opt{subgroups} and \csi{svnsubgroupstrue} are enabled. % % \paragraph{Exclude/Consider files extensions:} @@ -535,25 +524,25 @@ % by their file extension. This filter can by modified by the two following % macros. % -% \DescribeMacro{svnignoreextensions}{<comma separated list of extension +% \DescribeMacro{svnignoreextensions}{<comma separated list of extension % without leading dot>} -% Tells \svnmulti to ignore the following file extension and never declare files +% Tells \svnmulti to ignore the following file extension and never declare files % with them as extra groups. % -% \DescribeMacro{svnconsiderextensions}{<comma separated list of extension +% \DescribeMacro{svnconsiderextensions}{<comma separated list of extension % without leading dot>} -% Tells \svnmulti to (re-)consider the following file extension and declare +% Tells \svnmulti to (re-)consider the following file extension and declare % files with them as extra groups if read in. % % \paragraph{Typesetting:} -% The keyword information of the subgroups (subfile including any included -% external files or subsubfiles) can be typeset using the normal group typeset -% macros mentioned below where the group name is the file path without -% extension. The keyword information of the |.tex| file alone can be typeset +% The keyword information of the subgroups (subfile including any included +% external files or subsubfiles) can be typeset using the normal group typeset +% macros mentioned below where the group name is the file path without +% extension. The keyword information of the |.tex| file alone can be typeset % with the full file path including extension. -% \paragraph{Example:} |\svnsetcg{subdir/some_file.tex}\svncgrev| would typeset +% \paragraph{Example:} |\svnsetcg{subdir/some_file.tex}\svncgrev| would typeset % the revision of the file |some_file.tex| while -% |\svnsetcg{subdir/some_file}\svncgrev| would typeset the latest revision of +% |\svnsetcg{subdir/some_file}\svncgrev| would typeset the latest revision of % the same file or any subfile or declared external file included by it. % % @@ -597,7 +586,7 @@ % In order to hold them robust, which is important to use them in macros like % \cs{svnFullAuthor}, they do not provide any arguments to select other groups % than the current one. To access keyword values of other groups use the general -% macro \cs{svng} or change the locally selected keyword group using the macro +% macro \cs{svng} or change the locally selected keyword group using the macro % \cs{svnsetcg}. % % \DescribeMacro{svng}{<\/group name>}{<key>} @@ -657,18 +646,18 @@ % |\svnkw{Revision}| or |\svnkw{LastChangedRev}| if you like. % % \subsubsection*{New in version 2.2. Will change in future versions:} -% \DescribeMacro{ifsvnfilemodified}{<case:~modified>}{<case:~not +% \DescribeMacro{ifsvnfilemodified}{<case:~modified>}{<case:~not % modified>} % \DescribeMacro{ifsvnmodified}{<case:~modified>}{<case:~not modified>} -% This two macro can be used to check if either the current or any file was -% modified after it was last checked into the repository. At the moment (v2.2) a -% file is marked `modified' if there is either a `|*|' or `|M|' after the -% revision number, \eg `|$||Rev: 123M $|'. Such an marker is automatically added -% for exported files (`|svn export|') if there where locally modified, but can +% This two macro can be used to check if either the current or any file was +% modified after it was last checked into the repository. At the moment (v2.2) a +% file is marked `modified' if there is either a `|*|' or `|M|' after the +% revision number, \eg `|$||Rev: 123M $|'. Such an marker is automatically added +% for exported files (`|svn export|') if there where locally modified, but can % also be added manually. -% -% Future versions of this package might mark files as modified by use of the -% \opt{autokw} option which can read this information out of the working +% +% Future versions of this package might mark files as modified by use of the +% \opt{autokw} option which can read this information out of the working % directory Subversion entries. % % \subsection{Accessing Date Values}\label{sec:date} @@ -833,7 +822,7 @@ % The |.svt| file is in an general format which uses a lot of macros to format % the table and the different cells. This macros should not be used by the user % directly but rather can be redefined to fit the personal taste. -% Figure~\ref{fig:tablemacros} shows this macros in their position inside the +% Figure~\ref{fig:tablemacros} shows this macros in their position inside the % table of revisions. % % \par\noindent @@ -922,11 +911,11 @@ % Formats the group name. % % \DescribeMacro{svntabsubgroup}{<nesting level (1,2,3,\ldots)>}{<subgroup name>} -% Formats a subgroup name. The name is derived from a file name and therefore +% Formats a subgroup name. The name is derived from a file name and therefore % could contain characters like `|_|' which should be taken into account. The % macro \cs{svnnolinkurl} can be used for this. Because subgroups can be nested % a number is provided to tell the nesting depth. This can be used to produce -% different indents for different levels: \eg: +% different indents for different levels: \eg: % |\addtolength{\leftskip}{#1\someindentamount}|. % % \DescribeMacro{svntabfile}{<nesting level (1,2,3,\ldots)>}{<\/file path/name>} @@ -1049,9 +1038,9 @@ % % \subsection*{Table of Revisions} % \begin{enumerate} -% \item Compile document with \LaTeX. Document global and group keyword macros +% \item Compile document with \LaTeX. Document global and group keyword macros % are calculated and written to the |.svt| file. -% \item Compile document again with \LaTeX. The |.svt| file is read and +% \item Compile document again with \LaTeX. The |.svt| file is read and % typeset by the \cs{tableofrevisions} macro. % \end{enumerate} % @@ -1117,7 +1106,7 @@ % {\infoline{Location:} CTAN: \url% % {http://tug.ctan.org/pkg/\thedeppackage}} % -% Since v2.3 the authors packages \pkg{currfile} and \pkg{filehook} replacing the +% Since v2.3 the authors packages \pkg{currfile} and \pkg{filehook} replacing the % previous used (and patched) package \pkg{fink}. % % \begin{DepPackage}{hyperref} @@ -1192,15 +1181,20 @@ % \StopEventually{} % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % \section{Implementation} +% \iffalse +%<*svn-multi.sty> +% \fi +% \begin{macrocode} +\def\svnmulti@version{v2.4d} +% \end{macrocode} +% % \subsection{Package Header} % \subsubsection*{Package Identification} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e}[1999/12/01] -\ProvidesPackageSVN - {$Id: svn-multi.dtx 2431 2011-04-01 23:00:26Z martin $} - [\svnmulti@version\space SVN Keywords for multi-file LaTeX documents] +\ProvidesPackage{svn-multi}[2011/08/20 \svnmulti@version\space SVN Keywords for multi-file LaTeX documents] % \end{macrocode} - +% % \subsubsection*{Options} % Declaration of options and internal switches. % \begin{macrocode} @@ -1384,6 +1378,8 @@ \begingroup \edef\svn@stringa{#1}% \edef\svn@stringb{#2}% + \@onelevel@sanitize\svn@stringa + \@onelevel@sanitize\svn@stringb \ifx\svn@stringa\svn@stringb \endgroup \expandafter @@ -1569,7 +1565,7 @@ % \subsection{Auto-Keywords} -% Special care must be taken for the line feed character, otherwise it causes an +% Special care must be taken for the line feed character, otherwise it causes an % error if \opt{autokw} is disabled. % \begin{macrocode} \begingroup @@ -1583,13 +1579,13 @@ % \begin{macrocode} \if@svnmulti@autokw % \end{macrocode} -% +% % \begin{macrocode} \newread\svne@read % \end{macrocode} % \begin{macro}{\svne@catcodes} -% Sets the catcodes for verbatim input reading. Also removes the end-of-line +% Sets the catcodes for verbatim input reading. Also removes the end-of-line % character. % \begin{macrocode} \newcommand*{\svne@catcodes}{% @@ -1615,7 +1611,7 @@ % \end{macro} % \begin{macro}{\svne@readline}[1]{macro} -% Reads the next line to the provided macro and handles the end-of-file case +% Reads the next line to the provided macro and handles the end-of-file case % correctly. % \begin{macrocode} \def\svne@readline#1{% @@ -1700,7 +1696,7 @@ % \end{macro} % \begin{macro}{\svne@parsedirentry} -% Reads the first entry which is the directory entry and sets its URL as base +% Reads the first entry which is the directory entry and sets its URL as base % URL for all other entries. % \begin{macrocode} \newcommand*{\svne@parsedirentry}{% @@ -1720,9 +1716,9 @@ % \begin{macro}{\svne@scandate} % \begin{macro}{\svne@scandate@} -% Parses the date from the svn entries file. Special care is taken to handle the -% case when the TeX parsing would fail. The catcode of the characters '|-|', -% '|:|', '|.|' used inside the date is set explicitly to ensure the correct +% Parses the date from the svn entries file. Special care is taken to handle the +% case when the TeX parsing would fail. The catcode of the characters '|-|', +% '|:|', '|.|' used inside the date is set explicitly to ensure the correct % value. % % \begin{macrocode} @@ -1792,12 +1788,12 @@ % \end{macro} % \begin{macro}{\svne@handleentry} -% This macro is called for every entry except the first one which stands for the -% directory. The VC data is located in the following macros: \csi{svne@name}, +% This macro is called for every entry except the first one which stands for the +% directory. The VC data is located in the following macros: \csi{svne@name}, % \csi{svne@date}, \csi{svne@rev}, \csi{svne@author}, \csi{svne@url}. % -% This implementation sets the correct keywords and calls the update macro to -% emulate the behaviour of \cs{svnidlong}. Then the \cs{svne@endread} macro is +% This implementation sets the correct keywords and calls the update macro to +% emulate the behaviour of \cs{svnidlong}. Then the \cs{svne@endread} macro is % used to stop the file reading. % \begin{macrocode} \def\svne@handleentry{% @@ -1842,7 +1838,7 @@ % \end{macrocode} % \end{macro} -% Load keywords of main document at begin of the document body if option is set +% Load keywords of main document at begin of the document body if option is set % to 'all'. % \begin{macrocode} \if@svnmulti@autokwall @@ -1964,7 +1960,7 @@ % % \begin{macro}{\svn@scanId}[2]{file name}{rest of id line} -% Ensures proper behaviour also for copied but not yet committed files which have +% Ensures proper behaviour also for copied but not yet committed files which have % no date, time and author name. The revision is set to -1. So \meta{rest} is simply % compared to `|-1|' and a fall-back text is supplied if needed. % \begin{macrocode} @@ -2089,7 +2085,7 @@ % % \begin{macro}{\svnidlong@readverb} % The following macros read the four arguments of |\svnidlong| one-by-one with -% verbatim mode deactivated between them to ignore all comments. The macro +% verbatim mode deactivated between them to ignore all comments. The macro % |\@ifnextchar| is used to get rid of all spaces (and therefore comments) between % the arguments. An error message is printed if a wrong syntax is discovered. % \begin{macrocode} @@ -2299,7 +2295,7 @@ % % The keywords |Author| and |Date| are just calling \cs{svnkwdef@} with a fixed % first argument. For the revision the value is checked if empty and then a 0 -% is substituted. Also a temp counter is used to strip any trailing characters +% is substituted. Also a temp counter is used to strip any trailing characters % like `M' which indicate an exported and modified file. % \begin{macrocode} \def\svnkwdef@Rev#1{% @@ -2669,7 +2665,7 @@ % \end{macro} % \subsection{Input File Name} -% The \pkg{currfile} package is used to get the input file names. AtBegin/AtEnd +% The \pkg{currfile} package is used to get the input file names. AtBegin/AtEnd % hooks are installed which will be used later. % \begin{macrocode} \if@svnmulti@filehooks @@ -3123,7 +3119,7 @@ % \end{macro} % \begin{macro}{\svn@cleanfilelist}[1]{macro holing a file list} -% Takes a macro which holds a file list and removes all files from the list +% Takes a macro which holds a file list and removes all files from the list % which don't have a valid revision number. % \begin{macrocode} \def\svn@cleanfilelist#1{ @@ -3245,8 +3241,8 @@ lof,log,lot,out,svn,svt,svx,toc} } % \end{macrocode} -% The main file is added to the main base name (|\jobname|) subgroup here. This -% subgroup is added as first element to the active group at begin of the +% The main file is added to the main base name (|\jobname|) subgroup here. This +% subgroup is added as first element to the active group at begin of the % document body. % \begin{macrocode} \if@svnmulti@subgroups @@ -3307,7 +3303,7 @@ lof,log,lot,out,svn,svt,svx,toc} % \end{macrocode} % \end{macro} -% \begin{macro}{\svnexternal}[2]{group name}{list of filenames in \texttt{\{ +% \begin{macro}{\svnexternal}[2]{group name}{list of filenames in \texttt{\{ % \}}} % \begin{macrocode} \if@svnmulti@autokw @@ -3603,7 +3599,7 @@ patch generated macros '\string\pgf@image@<name>!' from the 'pgf' package!}% % The |\tableofcontents| macro from standard \LaTeX\ is adapted for this macro. % Classes which provide chapters will get a different table then one which not. % -% The external (\ie non-svn-multi) if-switches are masked using |\ifx| and +% The external (\ie non-svn-multi) if-switches are masked using |\ifx| and % |\csname| to avoid \TeX{} if-parsing errors when they are not defined. % \begin{macrocode} \AtBeginDocument{% @@ -4046,7 +4042,7 @@ patch generated macros '\string\pgf@image@<name>!' from the 'pgf' package!}% \svn@cleanfilelist\svn@files \@for\svn@file:=\svn@files\do{% % \end{macrocode} -% Check if VC data is set and then if it is a (sub)group or not by looking at +% Check if VC data is set and then if it is a (sub)group or not by looking at % the file list. % \begin{macrocode} \svn@ifvalidrev{@svng@\svn@file @rev}% @@ -4054,8 +4050,8 @@ patch generated macros '\string\pgf@image@<name>!' from the 'pgf' package!}% \@ifundefined{@svng@\svn@file @files}% {\svn@writefilerow{\the\svn@grouplevel}{\svn@file}}% % \end{macrocode} -% If subgroup only contains out of a TeX file with the same name print it as -% file and only as subgroup otherwise. If the subgroup file list is empty the +% If subgroup only contains out of a TeX file with the same name print it as +% file and only as subgroup otherwise. If the subgroup file list is empty the % subgroup was generated in error and is not printed at all. % \begin{macrocode} {\svn@ifonlyone{\svn@file}% @@ -4131,10 +4127,10 @@ patch generated macros '\string\pgf@image@<name>!' from the 'pgf' package!}% % \end{macrocode} % \end{macro} -% Load the keywords of every subfile if the \opt{autokw} option is enabled and +% Load the keywords of every subfile if the \opt{autokw} option is enabled and % the extension is not on the ignore list. % -% This code is placed here because it has to come after the at-begin-input-file +% This code is placed here because it has to come after the at-begin-input-file % code. % \begin{macrocode} \if@svnmulti@autokwall @@ -4166,24 +4162,27 @@ patch generated macros '\string\pgf@image@<name>!' from the 'pgf' package!}% } % \end{macrocode} % +% \iffalse +%</svn-multi.sty> +% \fi +% +% \iffalse +%<*svnkw.sty> +% \fi % \subsection{Backward compatibility wrapper \texttt{svnkw.sty}} % For backward compatibility a wrapper file with the old package name |svnkw| is % provided. Newer documents should use the name \svnmulti. -% \iffalse -%</package> -%<*wrapper> -% \fi % \begin{macrocode} \NeedsTeXFormat{LaTeX2e}[1999/12/01] \ProvidesPackage{svnkw} [2009/03/27 v2.1 Backward compatibility wrapper for svn-multi] -\PackageWarning{svnkw}{The package 'svnkw' got renamed to 'svn-multi' and is now -only a backward compatibility wrapper which loads 'svn-multi'. Please adjust +\PackageWarning{svnkw}{The package 'svnkw' got renamed to 'svn-multi' and is now +only a backward compatibility wrapper which loads 'svn-multi'. Please adjust your document preamble to use the new name.} \RequirePackage{svn-multi} % \end{macrocode} % \iffalse -%</wrapper> +%</svnkw.sty> % \fi % % \Finale diff --git a/Master/texmf-dist/source/latex/svn-multi/svn-multi.ins b/Master/texmf-dist/source/latex/svn-multi/svn-multi.ins index 9ae4d53330e..579c7883ee8 100644 --- a/Master/texmf-dist/source/latex/svn-multi/svn-multi.ins +++ b/Master/texmf-dist/source/latex/svn-multi/svn-multi.ins @@ -15,7 +15,7 @@ %% This work consists of the files svn-multi.dtx, svn-multi-pl.dtx, svn-multi.ins %% and the derived files svn-multi.sty, svnkw.sty and svn-multi.pl. %% -%% $Id: svn-multi.ins 622 2009-03-23 12:27:16Z martin $ +%% $Id$ \input docstrip.tex @@ -48,7 +48,7 @@ and the derived files svn-multi.sty, svnkw.sty and svn-multi.pl. \generate{% %\file{svn-multi.drv}{\from{svn-multi.dtx}{driver}}% - \file{svn-multi.sty}{\from{svn-multi.dtx}{package}}% + \file{svn-multi.sty}{\from{svn-multi.dtx}{svn-multi.sty}}% %\nopreamble \nopostamble \file{svnkw.sty}{\from{svn-multi.dtx}{wrapper}}% \nopreamble\nopostamble |