~ubuntu-branches/debian/wheezy/texlive-extra/wheezy

« back to all changes in this revision

Viewing changes to texmf-dist/doc/latex/bibleref/bibleref-manual.html

  • Committer: Bazaar Package Importer
  • Author(s): Norbert Preining
  • Date: 2009-01-15 09:56:54 UTC
  • mfrom: (1.3.1 upstream) (11.1.1 sid)
  • Revision ID: james.westby@ubuntu.com-20090115095654-71ev5rcx4pi5loe1
Tags: 2007.dfsg.15-1
upgrade bibleref to version from upstream which changes the license
to LPPL (Closes: #511843) RC->medium

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 
2
 
 
3
<!--Converted with LaTeX2HTML 2002 (1.67)
 
4
original version by:  Nikos Drakos, CBLU, University of Leeds
 
5
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
 
6
* with significant contributions from:
 
7
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
 
8
<HTML>
 
9
<HEAD>
 
10
<TITLE>bibleref.sty v1.07: a LATEX2e package for typesetting bible references</TITLE>
 
11
<META NAME="description" CONTENT="bibleref.sty v1.07: a LATEX2e package for typesetting bible references">
 
12
<META NAME="keywords" CONTENT="manual">
 
13
<META NAME="resource-type" CONTENT="document">
 
14
<META NAME="distribution" CONTENT="global">
 
15
 
 
16
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
 
17
<META NAME="Generator" CONTENT="LaTeX2HTML v2002">
 
18
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
 
19
 
 
20
 
 
21
</HEAD>
 
22
 
 
23
<BODY >
 
24
 
 
25
<H1 ALIGN="CENTER">bibleref.sty v1.07: a L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X2<SUB>e</SUB> package for 
 
26
typesetting bible references</H1>
 
27
<P ALIGN="CENTER"><STRONG>Nicola Talbot
 
28
<BR>
 
29
<BR>
 
30
School of Computing Sciences
 
31
<BR>
 
32
University of East Anglia
 
33
<BR>
 
34
Norwich. Norfolk. NR4 7TJ.
 
35
<BR>
 
36
United Kingdom
 
37
<BR><TT><A NAME="tex2html1"
 
38
  HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT></STRONG></P>
 
39
<P ALIGN="CENTER"><STRONG>20 Aug 2007</STRONG></P>
 
40
<BR>
 
41
 
 
42
<H2><A NAME="SECTION00010000000000000000">
 
43
Contents</A>
 
44
</H2>
 
45
<!--Table of Contents-->
 
46
 
 
47
<UL>
 
48
<LI><A NAME="tex2html8"
 
49
  HREF="manual.html#SECTION00020000000000000000">Introduction</A>
 
50
<LI><A NAME="tex2html9"
 
51
  HREF="manual.html#SECTION00030000000000000000">Defining New Styles</A>
 
52
<LI><A NAME="tex2html10"
 
53
  HREF="manual.html#SECTION00040000000000000000">Indexing Bible References</A>
 
54
<LI><A NAME="tex2html11"
 
55
  HREF="manual.html#SECTION00050000000000000000">Acknowledgements</A>
 
56
</UL>
 
57
<!--End of Table of Contents-->
 
58
<P>
 
59
 
 
60
<H1><A NAME="SECTION00020000000000000000">
 
61
Introduction</A>
 
62
</H1>
 
63
 
 
64
<P>
 
65
The <TT>bibleref</TT> package was designed to provide consistent formatting for referencing
 
66
parts of the bible.
 
67
 
 
68
<P>
 
69
 
 
70
<P>
 
71
<TT>&#092;bibleverse{</TT><EM>book title</EM><TT>}({</TT><EM>chapter</EM><TT>}:</TT><I>verse(s)</I><TT>)</TT>
 
72
<P>
 
73
This command can be used to cite a bible book, chapter or verse 
 
74
or range of chapters or verses.
 
75
 
 
76
<P>
 
77
The book title, <I>book title</I>, may be given either as the
 
78
full title (e.g. <TT>Matthew</TT>) or as an abbreviation (e.g. <TT>Mt</TT> or <TT>Matt</TT>), most standard abbreviations are
 
79
recognised.  Books with multiple parts should be preceeded by the
 
80
book number in uppercase roman numerals. For example, the second
 
81
book of Kings should be entered as <code>\bibleverse{IIKings}</code>
 
82
 
 
83
<P>
 
84
You may have any number, or zero, sets of parenthesis
 
85
<code>(</code><I>chapter</I><TT>:</TT><I>verse(s)</I><code>)</code>,
 
86
indicating the chapter and verse or verses. Verses can be
 
87
specified as a comma separated list of individual verses or range
 
88
of verses. A range of verses should be written with a single
 
89
hyphen, e.g. <code>2-4</code>. In the typeset output the verses will
 
90
be separated with <TT>&#092;BRvsep</TT> (an en-dash
 
91
by default.) A chapter may be referenced without a verse, but the
 
92
colon must remain, e.g. <code>(12:)</code> simply indicates chapter
 
93
12.
 
94
 
 
95
<P>
 
96
A range of verses spanning more than one chapter can
 
97
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>
 
98
 
 
99
<P>
 
100
Examples:
 
101
<DIV ALIGN="CENTER">
 
102
<TABLE CELLPADDING=3>
 
103
<TR><TD ALIGN="LEFT"><code>\bibleverse{Ex}</code></TD>
 
104
<TD ALIGN="LEFT">Exodus</TD>
 
105
</TR>
 
106
<TR><TD ALIGN="LEFT"><code>\bibleverse{Exodus}(20:)</code></TD>
 
107
<TD ALIGN="LEFT">Exodus 20</TD>
 
108
</TR>
 
109
<TR><TD ALIGN="LEFT"><code>\bibleverse{Exod}(20:17)</code></TD>
 
110
<TD ALIGN="LEFT">Exodus 20:17</TD>
 
111
</TR>
 
112
<TR><TD ALIGN="LEFT"><code>\bibleverse{IICo}(12:21)</code></TD>
 
113
<TD ALIGN="LEFT">2 Corinthians 12:21</TD>
 
114
</TR>
 
115
<TR><TD ALIGN="LEFT"><code>\bibleverse{IICor}(12:21-32)</code></TD>
 
116
<TD ALIGN="LEFT">2 Corinthians 12:21-32</TD>
 
117
</TR>
 
118
<TR><TD ALIGN="LEFT"><code>\bibleverse{Ex}(20:17)(21:3)</code></TD>
 
119
<TD ALIGN="LEFT">Exodus 20:17;21:3</TD>
 
120
</TR>
 
121
<TR><TD ALIGN="LEFT"><code>\bibleverse{Ex}(15:)(17:)(20:)</code></TD>
 
122
<TD ALIGN="LEFT">Exodus 15;17;20</TD>
 
123
</TR>
 
124
<TR><TD ALIGN="LEFT"><code>\bibleverse{Rev}(1:2,5,7-9,11)</code></TD>
 
125
<TD ALIGN="LEFT">Revelation 1:2,5,7-9,11</TD>
 
126
</TR>
 
127
<TR><TD ALIGN="LEFT"><code>\bibleverse{IChronicles}(1:3)-(2:7)</code></TD>
 
128
<TD ALIGN="LEFT">1 Chronicles 1:3-2:7</TD>
 
129
</TR>
 
130
</TABLE>
 
131
</DIV>
 
132
 
 
133
<P>
 
134
The style of the reference can be specified either by 
 
135
package option or as the argument to the command
 
136
 
 
137
<P>
 
138
<TT>&#092;biblerefstyle{</TT><EM>style</EM><TT>}</TT>
 
139
<P>
 
140
Styles are listed in Table&nbsp;<A HREF="manual.html#tab:styles">1</A>.
 
141
 
 
142
<P>
 
143
<BR><P></P>
 
144
<DIV ALIGN="CENTER">
 
145
 
 
146
<A NAME="tab:styles"></A>
 
147
<BR>
 
148
<BR>
 
149
<DIV ALIGN="CENTER">
 
150
<A NAME="172"></A>
 
151
<TABLE CELLPADDING=3>
 
152
<CAPTION><STRONG>Table 1:</STRONG>
 
153
Bible Citation Styles (can be used as package option or in the argument to 
 
154
<TT>&#092;biblerefstyle</TT>)</CAPTION>
 
155
<TR><TH ALIGN="LEFT"><B>Style </B></TH>
 
156
<TH ALIGN="LEFT" VALIGN="TOP" WIDTH=250><B>Example</B></TH>
 
157
</TR>
 
158
<TR><TD ALIGN="LEFT">default</TD>
 
159
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Corinthians 12:1-5</TD>
 
160
</TR>
 
161
<TR><TD ALIGN="LEFT">jerusalem</TD>
 
162
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Co 12:1-5</TD>
 
163
</TR>
 
164
<TR><TD ALIGN="LEFT">anglosaxon</TD>
 
165
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>II Cor 12.1-5</TD>
 
166
</TR>
 
167
<TR><TD ALIGN="LEFT">JEH</TD>
 
168
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii. 1-5</TD>
 
169
</TR>
 
170
<TR><TD ALIGN="LEFT">NTG</TD>
 
171
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii,1-5</TD>
 
172
</TR>
 
173
<TR><TD ALIGN="LEFT">MLA</TD>
 
174
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii.1-5</TD>
 
175
</TR>
 
176
<TR><TD ALIGN="LEFT">chicago</TD>
 
177
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii:1-5</TD>
 
178
</TR>
 
179
<TR><TD ALIGN="LEFT">text</TD>
 
180
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=250>2 Cor xii:1-5</TD>
 
181
</TR>
 
182
</TABLE>
 
183
</DIV>
 
184
</DIV>
 
185
<BR>
 
186
 
 
187
<P>
 
188
You can change the name of a book using 
 
189
 
 
190
<P>
 
191
<TT>&#092;setbooktitle{</TT><EM>name</EM><TT>}{</TT><EM>new title</EM><TT>}</TT>
 
192
<P>
 
193
Note that <I>name</I> must be the full name, not the
 
194
abbreviated name of the book. For example, to change
 
195
Revelation to Apoc, do 
 
196
<code>\setbookname{Revelation}{Apoc}</code>
 
197
(<B>Note</B> that you shouldn't do 
 
198
<code>\setbookname{Rev}{Apoc}</code>)
 
199
 
 
200
<P>
 
201
 
 
202
<H1><A NAME="SECTION00030000000000000000">
 
203
Defining New Styles</A>
 
204
</H1>
 
205
 
 
206
<P>
 
207
You can define a new style using the command
 
208
 
 
209
<P>
 
210
<TT>&#092;newbiblerefstyle{</TT><EM>style-name</EM><TT>}{</TT><EM>commands</EM><TT>}</TT>
 
211
<P>
 
212
where <I>commands</I> are
 
213
the commands needed to modify the citation style.
 
214
 
 
215
<P>
 
216
Example: 
 
217
This new style is based on the `default' style, but
 
218
has verses in lower case Roman numerals, and redefines
 
219
``Revelation'' as ``Apocalypse''.
 
220
<PRE>
 
221
\newbiblerefstyle{sample}{%
 
222
\biblerefstyle{default}%
 
223
\renewcommand{\BRversestyle}[1]{\romannumeral##1}%
 
224
\setbooktitle{Revelation}{Apocalypse}%
 
225
}
 
226
</PRE>
 
227
Note the use of <code>##1</code> instead of <code>#1</code>.
 
228
 
 
229
<P>
 
230
 
 
231
<H1><A NAME="SECTION00040000000000000000">
 
232
Indexing Bible References</A>
 
233
</H1>
 
234
 
 
235
<P>
 
236
 
 
237
<P>
 
238
<TT>&#092;ibibleverse{</TT><EM>book title</EM><TT>}({</TT><EM>chapter</EM><TT>}:</TT><I>verse(s)</I><TT>)</TT>
 
239
<P>
 
240
This does the same as <TT>&#092;bibleverse</TT>
 
241
but also adds an index entry (provided you have used 
 
242
<TT>&#092;makeindex</TT> in the preamble.) The default page number 
 
243
format is given by the command 
 
244
<TT>&#092;bvidxpgformat</TT>. This
 
245
is <TT>textrm</TT> by default, but can be redefined. To 
 
246
override the page number format for a particular entry you can
 
247
use the optional argument to <TT>&#092;ibibleverse</TT>. For example:
 
248
<PRE>
 
249
\ibibleverse[textit]{Exodus}
 
250
</PRE>
 
251
(Note there is no backslash.)
 
252
 
 
253
<P>
 
254
 
 
255
<H1><A NAME="SECTION00050000000000000000">
 
256
Acknowledgements</A>
 
257
</H1>
 
258
Many thanks to all the useful comments from comp.text.tex, 
 
259
especially from Jesse&nbsp;Billett, Brooks&nbsp;Moses and Ulrich&nbsp;M.&nbsp;Schwarz.
 
260
 
 
261
<P>
 
262
 
 
263
<P>
 
264
<BR><HR>
 
265
<ADDRESS>
 
266
<A href=http://theoval.cmp.uea.ac.uk/~nlct/>Nicola L. C. Talbot</A>. 
 
267
<A HREF=http://www.cmp.uea.ac.uk/>School of Computing Sciences</A>. 
 
268
<A HREF=http://www.uea.ac.uk/>University of East Anglia.</A> 
 
269
Last Modified: 2007-08-20
 
270
</ADDRESS>
 
271
</BODY>
 
272
</HTML>