| blob | bb7661814821eb5f42e8e857b719b8afa3e1e164 |
1 % \iffalse meta-comment
2 %
3 % Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
4 % 2006 2008 2009
5 % The LaTeX3 Project and any individual authors listed elsewhere
6 % in this file.
7 %
8 % This file is part of the Standard LaTeX `Tools Bundle'.
9 % -------------------------------------------------------
10 %
11 % It may be distributed and/or modified under the
12 % conditions of the LaTeX Project Public License, either version 1.3c
13 % of this license or (at your option) any later version.
14 % The latest version of this license is in
15 % http://www.latex-project.org/lppl.txt
16 % and version 1.3c or later is part of all distributions of LaTeX
17 % version 2005/12/01 or later.
18 %
19 % The list of all files belonging to the LaTeX `Tools Bundle' is
20 % given in the file `manifest.txt'.
21 %
22 % \fi
23 % \iffalse
24 %% File: xr.dtx Copyright (C) 1994-1994 David Carlisle
25 %
26 %<package>\NeedsTeXFormat{LaTeX2e}
27 %<package>\ProvidesPackage{xr}
28 %<package> [1994/05/28 v5.02 eXternal References (DPC)]
29 %
30 %<*driver>
31 \documentclass{ltxdoc}
32 \usepackage{xr}
33 \GetFileInfo{xr.sty}
34 \begin{document}
35 \title{The \textsf{xr} package\thanks{This file
36 has version number \fileversion, last
37 revised \filedate.}}
38 \author{David Carlisle\thanks{%
39 The Author of Versions 1--4 was Jean-Pierre Drucbert}}
40 \date{\filedate}
41 \MaintainedByLaTeXTeam{tools}
42 \maketitle
43 \DocInput{xr.dtx}
44 \end{document}
45 %</driver>
46 % \fi
47 %
48 % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
49 %
50 %
51 % \changes{v5.00}{1993/07/07}
52 % {First DPC version (by agreement with J-PD). New mechanism
53 % (\cmd{\read} instead of \cmd\input).}
54 %
55 % \changes{v5.01}{1993/07/20}{Fix bug added by DPC, v5.00 did not import
56 % aux files of \cmd\include'ed files. (Reported by J-PD)}
57 %
58 % \changes{v5.02}{1994/05/28}{Update for LaTeX2e}
59 %
60 %
61 % This package implements a system for eXternal References.
62 %
63 % If one document needs to refer to sections of another, say |aaa.tex|,
64 % then this package may be loaded in the main file, and the command\\
65 % |\externaldocument{aaa}|\\
66 % given in the preamble.
67 %
68 % Then you may use |\ref| and |\pageref| to refer to anything which has
69 % been given a |\label| in either |aaa.tex| or the main document.
70 % You may declare any number of such external documents.
71 %
72 % If any of the external documents, or the main document, use the same
73 % |\label| then an error will occur as the label will be multiply
74 % defined. To overcome this problem |\externaldocument| has an optional
75 % argument. If you declare |\externaldocument[A-]{aaa}| Then all
76 % references from |aaa| are prefixed by |A-|. So for instance, if a
77 % section of |aaa| had |\label{intro}|, then this could be referenced
78 % with |\ref{A-intro}|. The prefix need not be |A-|, it can be any
79 % string chosen to ensure that all the labels imported from external
80 % files are unique. Note however that if your style declares certain
81 % active characters (|:| in French, |"| in German) then these
82 % characters can not usually be used in |\label|, and similarly may not
83 % be used in the optional argument to |\externaldocument|.
84 %
85 % \StopEventually{}
86 %
87 % \section{The macros}
88 %
89 % \begin{macrocode}
90 %<*package>
91 % \end{macrocode}
92 %
93 % Check for the optional argument.
94 % \begin{macrocode}
95 \def\externaldocument{\@ifnextchar[\XR@{\XR@[]}}
96 % \end{macrocode}
97 %
98 % Save the optional prefix. Start processing the first |aux| file.
99 % \begin{macrocode}
100 \def\XR@[#1]#2{{%
101 \makeatletter
102 \def\XR@prefix{#1}%
103 \XR@next#2.aux\relax\\}}
104 % \end{macrocode}
105 %
106 % Process the next |aux| file in the list and remove it from the head of
107 % the list of files to process.
108 % \begin{macrocode}
109 \def\XR@next#1\relax#2\\{%
110 \edef\XR@list{#2}%
111 \XR@loop{#1}}
112 % \end{macrocode}
113 %
114 % Check whether the list of |aux| files is empty.
115 % \begin{macrocode}
116 \def\XR@aux{%
117 \ifx\XR@list\@empty\else\expandafter\XR@explist\fi}
118 % \end{macrocode}
119 %
121 % Expand the list of aux files, and call |\XR@next| to process the first
122 % one.
123 % \begin{macrocode}
124 \def\XR@explist{\expandafter\XR@next\XR@list\\}
125 % \end{macrocode}
126 %
127 % If the |aux| file exists, loop through line by line, looking for
128 % |\newlabel| and |\@input|. Otherwise process the next file in the
129 % list.
130 % \begin{macrocode}
131 \def\XR@loop#1{\openin\@inputcheck#1\relax
132 \ifeof\@inputcheck
133 \PackageWarning{xr}{^^JNo file #1^^JLABELS NOT IMPORTED.^^J}%
134 \expandafter\XR@aux
135 \else
136 \PackageInfo{xr}{IMPORTING LABELS FROM #1}%
137 \expandafter\XR@read\fi}
138 % \end{macrocode}
139 %
140 % Read the next line of the aux file.
141 % \begin{macrocode}
142 \def\XR@read{%
143 \read\@inputcheck to\XR@line
144 % \end{macrocode}
145 % The |...| make sure that |\XR@test| always has sufficient arguments.
146 % \begin{macrocode}
147 \expandafter\XR@test\XR@line...\XR@}
148 % \end{macrocode}
149 %
150 % Look at the first token of the line.
151 % If it is |\newlabel|, do the |\newlabel|. If it is |\@input|, add the
152 % filename to the list of files to process. Otherwise ignore.
153 % Go around the loop if not at end of file. Finally process the next
154 % file in the list.
155 % \begin{macrocode}
156 \long\def\XR@test#1#2#3#4\XR@{%
157 \ifx#1\newlabel
158 \newlabel{\XR@prefix#2}{#3}%
159 \else\ifx#1\@input
160 \edef\XR@list{\XR@list#2\relax}%
161 \fi\fi
162 \ifeof\@inputcheck\expandafter\XR@aux
163 \else\expandafter\XR@read\fi}
164 % \end{macrocode}
165 %
166 % \begin{macrocode}
167 %</package>
168 % \end{macrocode}
169 %
170 % \Finale
171 %