res_info/texi_bib-example/my-file-with-bib.passfirst

1 bib-example.texi(,2) @c % Copyright (C) 2004  Aaron S. Hawley
2 bib-example.texi(,3)
3 bib-example.texi(,4) @c % Author: Aaron S. Hawley <ashawley@gnu.uvm.edu>
4 bib-example.texi(,5) @c % Keywords: docs, texinfo, extensions, bib
5 bib-example.texi(,6)
6 bib-example.texi(,7) @c % This file is free software; you can redistribute it and/or modify
7 bib-example.texi(,8) @c % it under the terms of the GNU General Public License as published by
8 bib-example.texi(,9) @c % the Free Software Foundation; either version 2, or (at your option)
9 bib-example.texi(,10) @c % any later version.
10 bib-example.texi(,11)
11 bib-example.texi(,12) @c % This file is distributed in the hope that it will be useful,
12 bib-example.texi(,13) @c % but WITHOUT ANY WARRANTY; without even the implied warranty of
13 bib-example.texi(,14) @c % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 bib-example.texi(,15) @c % GNU General Public License for more details.
15 bib-example.texi(,16)
16 bib-example.texi(,17) @c % You should have received a copy of the GNU General Public License
17 bib-example.texi(,18) @c % along with texi2html; see the file COPYING.  If not, write to
18 bib-example.texi(,19) @c % the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 bib-example.texi(,20) @c % Boston, MA 02111-1307, USA.
20 bib-example.texi(,21)
21 bib-example.texi(,22) @comment %**start of header
22 bib-example.texi(,23) @setfilename my-file-with-bib.info
23 bib-example.texi(,24) @settitle Texinfo with a Bibliography and References
24 bib-example.texi(,25)
25 my-bib-macros.texi(,1) @c \input texinfo   @c -*-texinfo-*-
26 my-bib-macros.texi(,2) @c %% my-bib-macros.texi --- Texinfo macros providing a crude
27 my-bib-macros.texi(,3) @c %% bibliography and citation capability.
28 my-bib-macros.texi(,4)
29 my-bib-macros.texi(,5) @c % Copyright (C) 2004  Aaron S. Hawley
30 my-bib-macros.texi(,6)
31 my-bib-macros.texi(,7) @c % Author: Aaron S. Hawley <ashawley@gnu.uvm.edu>
32 my-bib-macros.texi(,8) @c % Keywords: docs, texinfo, extensions, bib
33 my-bib-macros.texi(,9)
34 my-bib-macros.texi(,10) @c % This file is free software; you can redistribute it and/or modify
35 my-bib-macros.texi(,11) @c % it under the terms of the GNU General Public License as published by
36 my-bib-macros.texi(,12) @c % the Free Software Foundation; either version 2, or (at your option)
37 my-bib-macros.texi(,13) @c % any later version.
38 my-bib-macros.texi(,14)
39 my-bib-macros.texi(,15) @c % This file is distributed in the hope that it will be useful,
40 my-bib-macros.texi(,16) @c % but WITHOUT ANY WARRANTY; without even the implied warranty of
41 my-bib-macros.texi(,17) @c % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
42 my-bib-macros.texi(,18) @c % GNU General Public License for more details.
43 my-bib-macros.texi(,19)
44 my-bib-macros.texi(,20) @c % You should have received a copy of the GNU General Public License
45 my-bib-macros.texi(,21) @c % along with texi2html; see the file COPYING.  If not, write to
46 my-bib-macros.texi(,22) @c % the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
47 my-bib-macros.texi(,23) @c % Boston, MA 02111-1307, USA.
48 my-bib-macros.texi(,24)
49 my-bib-macros.texi(,25) @c %% Commentary:
50 my-bib-macros.texi(,26)
51 my-bib-macros.texi(,27) @c %%% Introduction
52 my-bib-macros.texi(,28)
53 my-bib-macros.texi(,29) @c %% Creates references to a ``Bibliography'' or ``References''
54 my-bib-macros.texi(,30) @c %% section of a Texinfo document, using Texinfo's
55 my-bib-macros.texi(,31) @c %% macro system.  Although not as terse a way to cite systems as is
56 my-bib-macros.texi(,32) @c %% found in document systems like TeX, the format is simpler and
57 my-bib-macros.texi(,33) @c %% the rendering  is easier for non-academic readers.
58 my-bib-macros.texi(,34)
59 my-bib-macros.texi(,35) @c %
60 my-bib-macros.texi(,36)
61 my-bib-macros.texi(,37) @c %%% Usage
62 my-bib-macros.texi(,38)
63 my-bib-macros.texi(,39) @c %% References to cited works can be put in any section of a document.
64 my-bib-macros.texi(,40) @c %% The cited works must be put in either a Texinfo table (for
65 my-bib-macros.texi(,41) @c %% instance with ``@table @asis ... @end table'') or within a
66 my-bib-macros.texi(,42) @c %% Texinfo list (something like ``@enumerate ... @end enumerate''
67 my-bib-macros.texi(,43) @c %% or ``@itemize @bullet ... @end itemize'').  They are created
68 my-bib-macros.texi(,44) @c %% with the command ``@mybibitem{REF-NAME}''.  To cite a reference
69 my-bib-macros.texi(,45) @c %% with a @mybibitem use ``@mybibcite{REF-NAME}''.
70 my-bib-macros.texi(,46)
71 my-bib-macros.texi(,47) @c %% The beginning of a document must include (using the @include
72 my-bib-macros.texi(,48) @c %% command) the file my-bib-macros.texi, which should be made
73 my-bib-macros.texi(,49) @c %% available in the current directory of the parent file.  A single
74 my-bib-macros.texi(,50) @c %% call should be made to choose to use a list or a table.  The
75 my-bib-macros.texi(,51) @c %% command to chose is called @mybibuselist{NODE}, where NODE is
76 my-bib-macros.texi(,52) @c %% the node containing the location where the references are listed.
77 my-bib-macros.texi(,53)
78 my-bib-macros.texi(,54) @c %
79 my-bib-macros.texi(,55)
80 my-bib-macros.texi(,56) @c %%% Example
81 my-bib-macros.texi(,57)
82 my-bib-macros.texi(,58) @c %% \input texinfo   @c -*-texinfo-*-
83 my-bib-macros.texi(,59) @c %% @comment %**start of header
84 my-bib-macros.texi(,60) @c %% @setfilename my-file-with-bib.info
85 my-bib-macros.texi(,61) @c %% @settitle Texinfo with a Bibliography and References
86 my-bib-macros.texi(,62) @c %%
87 my-bib-macros.texi(,63) @c %% @include my-bib-macros.texi
88 my-bib-macros.texi(,64) @c %% @mybibuselist{References}
89 my-bib-macros.texi(,65) @c %%
90 my-bib-macros.texi(,66) @c %% @comment %**end of header
91 my-bib-macros.texi(,67) @c %%
92 my-bib-macros.texi(,68) @c %% @node Top
93 my-bib-macros.texi(,69) @c %% @top Top
94 my-bib-macros.texi(,70) @c %%
95 my-bib-macros.texi(,71) @c %% @menu
96 my-bib-macros.texi(,72) @c %% * Introduction::
97 my-bib-macros.texi(,73) @c %% * @mybibnode{}::
98 my-bib-macros.texi(,74) @c %%
99 my-bib-macros.texi(,75) @c %% @end menu
100 my-bib-macros.texi(,76) @c %%
101 my-bib-macros.texi(,77) @c %% @node Introduction
102 my-bib-macros.texi(,78) @c %% @chapter Introduction
103 my-bib-macros.texi(,79) @c %%
104 my-bib-macros.texi(,80) @c %% The ability of a documentation format to make cross references to a
105 my-bib-macros.texi(,81) @c %% bibliography, a feature of LaTeX @mybibcite{LaTeX2e}, isn't
106 my-bib-macros.texi(,82) @c %% currently supported in Texinfo.
107 my-bib-macros.texi(,83) @c %%
108 my-bib-macros.texi(,84) @c %% @node @mybibnode{}
109 my-bib-macros.texi(,85) @c %% @chapter References
110 my-bib-macros.texi(,86) @c %%
111 my-bib-macros.texi(,87) @c %% @itemize @asis
112 my-bib-macros.texi(,88) @c %%
113 my-bib-macros.texi(,89) @c %% @mybibitem{LaTeX2e} Leslie Lamport, LaTeX User's Guide and
114 my-bib-macros.texi(,90) @c %% Reference Manual, 2nd edition, Addison-Wesley, Reading,
115 my-bib-macros.texi(,91) @c %% Massachusetts, 1994.
116 my-bib-macros.texi(,92) @c %%
117 my-bib-macros.texi(,93) @c %% @end itemize
118 my-bib-macros.texi(,94) @c %%
119 my-bib-macros.texi(,95) @c %% @bye
120 my-bib-macros.texi(,96)
121 my-bib-macros.texi(,97) @c %%
122 my-bib-macros.texi(,98)
123 my-bib-macros.texi(,99) @c %% This example produces (in Info):
124 my-bib-macros.texi(,100)
125 my-bib-macros.texi(,101) @c %%       1 Introduction
126 my-bib-macros.texi(,102) @c %%       **************
127 my-bib-macros.texi(,103) @c %%
128 my-bib-macros.texi(,104) @c %%       The ability of a documentation format to make cross
129 my-bib-macros.texi(,105) @c %%       references to a bibliography, a feature of LaTeX (See item
130 my-bib-macros.texi(,106) @c %%       [LaTeX2e] in *Note LaTeX2e: References.), is not currently
131 my-bib-macros.texi(,107) @c %%       supported in Texinfo.
132 my-bib-macros.texi(,108) @c %%
133 my-bib-macros.texi(,109) @c %%
134 my-bib-macros.texi(,110) @c %%       2 References
135 my-bib-macros.texi(,111) @c %%       ************
136 my-bib-macros.texi(,112) @c %%
137 my-bib-macros.texi(,113) @c %%       [LaTeX2e] Leslie Lamport, LaTeX User's Guide and Reference
138 my-bib-macros.texi(,114) @c %%       Manual, 2nd edition, Addison-Wesley, Reading,
139 my-bib-macros.texi(,115) @c %%       Massachusetts, 1994.
140 my-bib-macros.texi(,116)
141 my-bib-macros.texi(,117) @c %% and (in printed output):
142 my-bib-macros.texi(,118)
143 my-bib-macros.texi(,119) @c %%       1 Introduction
144 my-bib-macros.texi(,120) @c %%       **************
145 my-bib-macros.texi(,121) @c %%
146 my-bib-macros.texi(,122) @c %%       The ability of a documentation format to make cross
147 my-bib-macros.texi(,123) @c %%       references to a bibliography, a feature of LaTeX (See item
148 my-bib-macros.texi(,124) @c %%       [LaTeX2e] in Chapter 2 [References], page 3.), is not
149 my-bib-macros.texi(,125) @c %%       currently supported in Texinfo.
150 my-bib-macros.texi(,126) @c %%
151 my-bib-macros.texi(,127) @c %%
152 my-bib-macros.texi(,128) @c %%       2 References
153 my-bib-macros.texi(,129) @c %%       ************
154 my-bib-macros.texi(,130) @c %%
155 my-bib-macros.texi(,131) @c %%       [LaTeX2e] Leslie Lamport, LaTeX User's Guide and Reference
156 my-bib-macros.texi(,132) @c %%       Manual, 2nd edition, Addison-Wesley, Reading,
157 my-bib-macros.texi(,133) @c %%       Massachusetts, 1994.
158 my-bib-macros.texi(,134)
159 my-bib-macros.texi(,135) @c %
160 my-bib-macros.texi(,136)
161 my-bib-macros.texi(,137) @c %%% Notes
162 my-bib-macros.texi(,138)
163 my-bib-macros.texi(,139) @c %% The pointers to references will be functional in hypertext
164 my-bib-macros.texi(,140) @c %% documentation (info, HTML, XML and others) and properly rendered
165 my-bib-macros.texi(,141) @c %% in print documents, because they are implemented with Texinfo's
166 my-bib-macros.texi(,142) @c %% cross referencing capabilities (using @anchor and @ref).  Failures
167 my-bib-macros.texi(,143) @c %% by an author to make proper references with ``my-bib-macros'' in
168 my-bib-macros.texi(,144) @c %% their document will give cross referencing errors by Texinfo
169 my-bib-macros.texi(,145) @c %% conversion tools.
170 my-bib-macros.texi(,146)
171 my-bib-macros.texi(,147) @c %% Only one ``Reference'' section is allowed per document.
172 my-bib-macros.texi(,148)
173 my-bib-macros.texi(,149) @c %% An improvement of this system would create cross references
174 my-bib-macros.texi(,150) @c %% (with @xref) at each cited work to all the originating cross
175 my-bib-macros.texi(,151) @c %% refererences.
176 my-bib-macros.texi(,152)
177 my-bib-macros.texi(,153) @c %
178 my-bib-macros.texi(,154)
179 my-bib-macros.texi(,155) @c %% Code:
180 my-bib-macros.texi(,156)
181 my-bib-macros.texi(,157) @c % Configuration Options
182 my-bib-macros.texi(,158)
183 my-bib-macros.texi(,159) @c %% @mybibsetrefnode : Defines the name of the node to contain
184 my-bib-macros.texi(,160) @c %% references.
185 my-bib-macros.texi(,161)
186 my-bib-macros.texi(,162) @macro mybibsetrefnode{node}
187 my-bib-macros.texi(,163) @set mybibrefnode \node\
188 my-bib-macros.texi(,164) @end macro
189 my-bib-macros.texi(,165)
190 my-bib-macros.texi(,166) @c %% @mybibnode{} : Macro to be placed at node containing references
191 my-bib-macros.texi(,167) @c %% and calls to @mybibcite{}
192 my-bib-macros.texi(,168)
193 my-bib-macros.texi(,169) @macro mybibnode{}
194 my-bib-macros.texi(,170) @value{mybibrefnode}
195 my-bib-macros.texi(,171) @end macro
196 my-bib-macros.texi(,172)
197 my-bib-macros.texi(,173) @c %% @mybibusetable : Whether each @mybibitem will be put in a
198 my-bib-macros.texi(,174) @c %% table.
199 my-bib-macros.texi(,175)
200 my-bib-macros.texi(,176) @macro mybibusetable{node}
201 my-bib-macros.texi(,177) @set mybibtable true
202 my-bib-macros.texi(,178) @ifset mybiblist
203 my-bib-macros.texi(,179) @clear mybiblist
204 my-bib-macros.texi(,180) @end ifset
205 my-bib-macros.texi(,181) @mybibsetrefnode{\node\}
206 my-bib-macros.texi(,182) @end macro
207 my-bib-macros.texi(,183)
208 my-bib-macros.texi(,184) @c %% @mybibuselist : Whether each @mybibitem will be put in a
209 my-bib-macros.texi(,185) @c %% list.
210 my-bib-macros.texi(,186)
211 my-bib-macros.texi(,187) @macro mybibuselist{node}
212 my-bib-macros.texi(,188) @set mybiblist true
213 my-bib-macros.texi(,189) @ifset mybibtable
214 my-bib-macros.texi(,190) @clear mybibtable
215 my-bib-macros.texi(,191) @end ifset
216 my-bib-macros.texi(,192) @mybibsetrefnode{\node\}
217 my-bib-macros.texi(,193) @end macro
218 my-bib-macros.texi(,194)
219 my-bib-macros.texi(,195)
220 my-bib-macros.texi(,196) @c %% @mybibcite{REF} : Cites the cross reference REF.
221 my-bib-macros.texi(,197)
222 my-bib-macros.texi(,198) @macro mybibcite{ref}
223 my-bib-macros.texi(,199) @ifclear mybibrefnode
224 my-bib-macros.texi(,200) @mybibmakeref{mybibsetrefnode was not used, \ref\}
225 my-bib-macros.texi(,201) @end ifclear
226 my-bib-macros.texi(,202) @c %**else if
227 my-bib-macros.texi(,203) @ifset mybibrefnode
228 my-bib-macros.texi(,204) @mybibmakeref{@mybibnode{}, \ref\}
229 my-bib-macros.texi(,205) @end ifset
230 my-bib-macros.texi(,206)
231 my-bib-macros.texi(,207) @end macro
232 my-bib-macros.texi(,208)
233 my-bib-macros.texi(,209) @macro mybibmakeref{node, ref}
234 my-bib-macros.texi(,210) (See item [\ref\] in @ref{\node\, \ref\}.)
235 my-bib-macros.texi(,211) @end macro
236 my-bib-macros.texi(,212)
237 my-bib-macros.texi(,213) @c %% @mybibcite{REF} : Creates a cross referenced citation REF.
238 my-bib-macros.texi(,214)
239 my-bib-macros.texi(,215) @macro mybibitem{ref}
240 my-bib-macros.texi(,216) @ifclear mybiblist
241 my-bib-macros.texi(,217) @ifclear mybibtable
242 my-bib-macros.texi(,218) @set mybiblist true
243 my-bib-macros.texi(,219) @end ifclear
244 my-bib-macros.texi(,220) @end ifclear
245 my-bib-macros.texi(,221) @ifset mybiblist
246 my-bib-macros.texi(,222) @item
247 my-bib-macros.texi(,223) @anchor{\ref\}[\ref\]
248 my-bib-macros.texi(,224) @end ifset
249 my-bib-macros.texi(,225) @c %**else if
250 my-bib-macros.texi(,226) @ifset mybibtable
251 my-bib-macros.texi(,227) @item @anchor{\ref\}[\ref\]
252 my-bib-macros.texi(,228) @end ifset
253 my-bib-macros.texi(,229)
254 my-bib-macros.texi(,230) @end macro
255 my-bib-macros.texi(,231)
256 my-bib-macros.texi(,232) @c %% my-bib-macros.texi ends here
257 bib-example.texi(mybibuselist,27) @set mybiblist true
258 bib-example.texi(mybibuselist,27) @set mybibrefnode References
259 bib-example.texi(,28)
260 bib-example.texi(,29) @comment %**end of header
261 bib-example.texi(,30)
262 bib-example.texi(,31) @node Top
263 bib-example.texi(,32) @top Top
264 bib-example.texi(,33)
265 bib-example.texi(,34) @menu
266 bib-example.texi(,35) * Introduction::
267 bib-example.texi(mybibnode,36) * References::
268 bib-example.texi(,37)
269 bib-example.texi(,38) @end menu
270 bib-example.texi(,39)
271 bib-example.texi(,40) @node Introduction
272 bib-example.texi(,41) @chapter Introduction
273 bib-example.texi(,42)
274 bib-example.texi(,43) The ability of a documentation format to make cross references to a
275 bib-example.texi(mybibcite,44) bibliography, a feature of LaTeX @c %**else if
276 bib-example.texi(mybibcite,44) (See item [LaTeX2e] in @ref{References, LaTeX2e}.)
277 bib-example.texi(mybibcite,44) , isn't
278 bib-example.texi(,45) currently supported in Texinfo.
279 bib-example.texi(,46)
280 bib-example.texi(mybibnode,47) @node References
281 bib-example.texi(,48) @chapter References
282 bib-example.texi(,49)
283 bib-example.texi(,50) @itemize @asis
284 bib-example.texi(,51)
285 bib-example.texi(mybibitem,52) @item
286 bib-example.texi(mybibitem,52) @anchor{LaTeX2e}[LaTeX2e]
287 bib-example.texi(mybibitem,52) @c %**else if
288 bib-example.texi(mybibitem,52)  Leslie Lamport, LaTeX User's Guide and
289 bib-example.texi(,53) Reference Manual, 2nd edition, Addison-Wesley, Reading,
290 bib-example.texi(,54) Massachusetts, 1994.
291 bib-example.texi(,55)
292 bib-example.texi(,56) @end itemize
293 bib-example.texi(,57)
294 bib-example.texi(,58) @bye