summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bibleref/bibleref-manual.html
blob: 278492d319e60269cc99760c10ee615fb539231f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<!--Converted with LaTeX2HTML 2002 (1.67)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>bibleref.sty v1.11: a LATEX2e package for typesetting bible references</TITLE>
<META NAME="description" CONTENT="bibleref.sty v1.11: a LATEX2e package for typesetting bible references">
<META NAME="keywords" CONTENT="bibleref-manual">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">


</HEAD>

<BODY >

<H1 ALIGN="CENTER">bibleref.sty v1.11: a L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X2<SUB>e</SUB> package for 
typesetting bible references</H1>
<P ALIGN="CENTER"><STRONG>Nicola Talbot
<BR>
<BR>
School of Computing Sciences
<BR>
University of East Anglia
<BR>
Norwich. Norfolk. NR4 7TJ.
<BR>
United Kingdom
<BR><TT><A NAME="tex2html1"
  HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT></STRONG></P>
<P ALIGN="CENTER"><STRONG>29th April 2010</STRONG></P>
<BR>

<H2><A NAME="SECTION00010000000000000000">
Contents</A>
</H2>
<!--Table of Contents-->

<UL>
<LI><A NAME="tex2html10"
  HREF="bibleref-manual.html#SECTION00020000000000000000">Introduction</A>
<LI><A NAME="tex2html11"
  HREF="bibleref-manual.html#SECTION00030000000000000000">Defining New Styles</A>
<LI><A NAME="tex2html12"
  HREF="bibleref-manual.html#SECTION00040000000000000000">Indexing Bible References</A>
<UL>
<LI><A NAME="tex2html13"
  HREF="bibleref-manual.html#SECTION00041000000000000000">Separate Scripture Index</A>
<LI><A NAME="tex2html14"
  HREF="bibleref-manual.html#SECTION00042000000000000000">Changing the Sort Order</A>
</UL>
<BR>
<LI><A NAME="tex2html15"
  HREF="bibleref-manual.html#SECTION00050000000000000000">Acknowledgements</A>
</UL>
<!--End of Table of Contents-->
<P>

<H1><A NAME="SECTION00020000000000000000">
Introduction</A>
</H1>

<P>
The <TT>bibleref</TT> package was designed to provide consistent formatting for referencing
parts of the bible.

<P>

<P>
<TT>&#092;bibleverse{</TT><EM>book title</EM><TT>}(</TT><I>chapter</I><TT>:</TT><I>verse(s)</I><TT>)</TT>
<P>
This command can be used to cite a bible book, chapter or verse 
or range of chapters or verses.

<P>
The book title, <I>book title</I>, may be given either as the
full title (e.g. <TT>Matthew</TT>) or as an abbreviation (e.g. <TT>Mt</TT> or <TT>Matt</TT>), most standard abbreviations are
recognised.  Books with multiple parts should be preceeded by the
book number in uppercase roman numerals. For example, the second
book of Kings should be entered as <code>\bibleverse{IIKings}</code>

<P>
You may have any number, or zero, sets of parenthesis
<code>(</code><I>chapter</I><TT>:</TT><I>verse(s)</I><code>)</code>,
indicating the chapter and verse or verses. Verses can be
specified as a comma separated list of individual verses or range
of verses. A range of verses should be written with a single
hyphen, e.g. <code>2-4</code>. In the typeset output the verses will
be separated with <TT>&#092;BRvsep</TT> (an en-dash
by default.) A chapter may be referenced without a verse, but the
colon must remain, e.g. <code>(12:)</code> simply indicates chapter
12.

<P>
A range of verses spanning more than one chapter can
be entered as <TT>(</TT><I>ch</I><TT>:</TT><I>v</I><TT>)-(</TT><I>ch</I><TT>:</TT><I>v</I><TT>)</TT>

<P>
Examples:
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3>
<TR><TD ALIGN="LEFT"><code>\bibleverse{Ex}</code></TD>
<TD ALIGN="LEFT">Exodus</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{Exodus}(20:)</code></TD>
<TD ALIGN="LEFT">Exodus 20</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{Exod}(20:17)</code></TD>
<TD ALIGN="LEFT">Exodus 20:17</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{IICo}(12:21)</code></TD>
<TD ALIGN="LEFT">2 Corinthians 12:21</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{IICor}(12:21-32)</code></TD>
<TD ALIGN="LEFT">2 Corinthians 12:21-32</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{Ex}(20:17)(21:3)</code></TD>
<TD ALIGN="LEFT">Exodus 20:17;21:3</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{Ex}(15:)(17:)(20:)</code></TD>
<TD ALIGN="LEFT">Exodus 15;17;20</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{Rev}(1:2,5,7-9,11)</code></TD>
<TD ALIGN="LEFT">Revelation 1:2,5,7-9,11</TD>
</TR>
<TR><TD ALIGN="LEFT"><code>\bibleverse{IChronicles}(1:3)-(2:7)</code></TD>
<TD ALIGN="LEFT">1 Chronicles 1:3-2:7</TD>
</TR>
</TABLE>
</DIV>

<P>
The style of the reference can be specified either by 
package option or as the argument to the command

<P>
<TT>&#092;biblerefstyle{</TT><EM>style</EM><TT>}</TT>
<P>
Styles are listed in Table&nbsp;<A HREF="bibleref-manual.html#tab:styles">1</A>.

<P>
<BR><P></P>
<DIV ALIGN="CENTER">

<A NAME="tab:styles"></A>
<BR>
<BR>
<DIV ALIGN="CENTER">
<A NAME="220"></A>
<TABLE CELLPADDING=3>
<CAPTION><STRONG>Table 1:</STRONG>
Bible Citation Styles (can be used as package option or in the argument to 
<TT>&#092;biblerefstyle</TT>)</CAPTION>
<TR><TH ALIGN="LEFT"><B>Style </B></TH>
<TH ALIGN="LEFT" VALIGN="TOP" WIDTH=250><B>Example</B></TH>
</TR>
<TR><TD ALIGN="LEFT">default</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Corinthians 12:1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">jerusalem</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Co 12:1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">anglosaxon</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>II Cor 12.1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">JEH</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii. 1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">NTG</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii,1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">MLA</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii.1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">chicago</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii:1-5</TD>
</TR>
<TR><TD ALIGN="LEFT">text</TD>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii:1-5</TD>
</TR>
</TABLE>
</DIV>
</DIV>
<BR>

<P>
You can change the name of a book using 

<P>
<TT>&#092;setbooktitle{</TT><EM>name</EM><TT>}{</TT><EM>new title</EM><TT>}</TT>
<P>
Note that <I>name</I> must be the full name, not the
abbreviated name of the book. For example, to change
Revelation to Apoc, do 
<code>\setbookname{Revelation}{Apoc}</code>
(<B>Note</B> that you shouldn't do 
<code>\setbookname{Rev}{Apoc}</code>)

<P>
If you want a different title for a book depending on whether it's
in the main body of the document or in the index, you can set the
index version using:

<P>
<TT>&#092;setindexbooktitle{</TT><EM>name</EM><TT>}{</TT><EM>title</EM><TT>}</TT>
<P>
In this case, <I>name</I> should be the name you'll use in 
<TT>&#092;ibibleverse</TT>. For example, if you do:
<PRE>
\setbooktitle{Psalms}{Psalm}
\setindexbooktitle{Psalms}{Psalms}
</PRE>
Then <code>\ibibleverse{Psalms}(2:)</code> will print Psalm the
document and Psalms in the index, but <code>\ibibleverse{Ps}(2:)</code>
will print Psalms in both the document and the index.

<P>
You can add a book using

<P>
<TT>&#092;addbiblebook{</TT><EM>name</EM><TT>}{</TT><EM>title</EM><TT>}</TT>
<P>
For example:
<PRE>
\addbiblebook{Susanna}{Story of Susanna}
</PRE>

<P>

<H1><A NAME="SECTION00030000000000000000">
Defining New Styles</A>
</H1>

<P>
You can define a new style using the command

<P>
<TT>&#092;newbiblerefstyle{</TT><EM>style-name</EM><TT>}{</TT><EM>commands</EM><TT>}</TT>
<P>
where <I>commands</I> are
the commands needed to modify the citation style.

<P>
Example: 
This new style is based on the `default' style, but
has verses in lower case Roman numerals, and redefines
``Revelation'' as ``Apocalypse''.
<PRE>
\newbiblerefstyle{sample}{%
\biblerefstyle{default}%
\renewcommand{\BRversestyle}[1]{\romannumeral##1}%
\setbooktitle{Revelation}{Apocalypse}%
}
</PRE>
Note the use of <code>##1</code> instead of <code>#1</code>.

<P>

<H1><A NAME="SECTION00040000000000000000">
Indexing Bible References</A>
</H1>

<P>

<P>
<TT>&#092;ibibleverse{</TT><EM>book title</EM><TT>}({</TT><EM>chapter</EM><TT>}:</TT><I>verse(s)</I><TT>)</TT>
<P>
This does the same as <TT>&#092;bibleverse</TT>
but also adds an index entry (provided you have used 
<TT>&#092;makeindex</TT> in the preamble.) The default page number 
format is given by the command 
<TT>&#092;bvidxpgformat</TT>. This
is <TT>textrm</TT> by default, but can be redefined. To 
override the page number format for a particular entry you can
use the optional argument to <TT>&#092;ibibleverse</TT>. For example:
<PRE>
\ibibleverse[textit]{Exodus}
</PRE>
(Note there is no backslash.)

<P>

<H2><A NAME="SECTION00041000000000000000">
Separate Scripture Index</A>
</H2>

<P>
If you want a separate index for bible verses, in addition to
a general index, you can redefine <TT>&#092;biblerefindex</TT>.
This command defaults to <TT>&#092;index</TT>, but can be changed to
the appropriate indexing command. For example, suppose you
are using the <TT>multind</TT> package and you want a general
index and a scripture index, you can do something like:
<PRE>
\documentclass{article}
\usepackage{bibleref}
\usepackage{multind}

\makeindex{scripture}
\makeindex{general}

\renewcommand{\biblerefindex}{\index{scripture}}
</PRE>
In the document, you can use <TT>&#092;ibibleverse</TT> as before, and
the scripture index is displayed using
<PRE>
\printindex{scripture}{Scripture Index}
</PRE>
You will then need to run <TT>makeindex</TT> on the file
<TT>scripture.idx</TT>. See the <TT>multind</TT> documentation
for further details.

<P>

<H2><A NAME="SECTION00042000000000000000">
Changing the Sort Order</A>
</H2>

<P>
The bible reference entries will be sorted alphabetically by
<TT>makeindex</TT>. However you may prefer the entries to be sorted
according to their order in the bible. This can either be done
using <TT>xindy</TT> instead of <TT>makeindex</TT> and creating your
own custom alphabet (see <TT>xindy</TT> manual for details) or you
can use <TT>bibleref</TT>'s mapping command.

<P>

<P>
<TT>&#092;biblerefmap{</TT><EM>label</EM><TT>}{</TT><EM>new sort key</EM><TT>}</TT>
<P>
For example, in the preamble:
<PRE>
\biblerefmap{Genesis}{01}
\biblerefmap{Exodus}{02}
\biblerefmap{Leviticus}{03}
\biblerefmap{Numbers}{04}
\biblerefmap{Deuteronomy}{05}
...
</PRE>
When you run <TT>makeindex</TT>, the references will now be sorted
in numerical order.

<P>
If you want to subdivide the index into, say, old and new 
testament, you can add this to the mapping. For example:
<PRE>
\biblerefmap{Genesis}{1@Old Testament!01}
\biblerefmap{Exodus}{1@Old Testament!02}
\biblerefmap{Leviticus}{1@Old Testament!03}
\biblerefmap{Numbers}{1@Old Testament!04}
\biblerefmap{Deuteronomy}{1@Old Testament!05}
...
\biblerefmap{Matthew}{2@New Testament!01}
\biblerefmap{Mark}{2@New Testament!02}
...
</PRE>

<P>

<H1><A NAME="SECTION00050000000000000000">
Acknowledgements</A>
</H1>
Many thanks to all the useful comments from comp.text.tex, 
especially from Jesse&nbsp;Billett, Brooks&nbsp;Moses and Ulrich&nbsp;M.&nbsp;Schwarz.

<P>
<BR><HR>
<ADDRESS>
<A href="http://theoval.cmp.uea.ac.uk/~nlct/">Nicola L. C. Talbot</A>. 
<A HREF="http://www.cmp.uea.ac.uk/">School of Computing Sciences</A>. 
<A HREF="http://www.uea.ac.uk/">University of East Anglia.</A> 
Last Modified: 2010-04-29
</ADDRESS>
</BODY>
</HTML>