summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/book-of-common-prayer/book-of-common-prayer.tex
blob: 61b18b9a09889f486350cdaecadeea46972f4ae7 (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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
\documentclass{article}
\usepackage{booktabs}
\usepackage{hyperref}
\usepackage{xcolor}
\usepackage{listings}
\usepackage{subcaption}
\usepackage{book-of-common-prayer}
\geometry{
  paperheight=11in,
  paperwidth=8.5in,
  heightrounded,
  left=1in, right=1in, vmargin=1in
}
\definecolor{name}{rgb}{0.5,0.5,0.5}
\lstset{basicstyle=\normalfont\ttfamily,
	breaklines=true,
	otherkeywords={},
	language=[LaTeX]{TeX},
	tabsize=2,
	breaklines=true,
	keywordstyle=\color{blue},
    texcsstyle=*\color{blue},
    commentstyle=\color{comments}\ttfamily,
	}  

\title{\texttt{book-of-common-prayer}\\
	   \Large Typesetting for liturgical documents in the style of the 1979 Book of Common Prayer \\
	   }
\date{February 2022 \\ \textit{Version 1.1.0}}
\author{Arlie Coles}

\begin{document}
\maketitle

\tableofcontents

\clearpage
\section{Introduction}

\texttt{book-of-common-prayer} is a \LaTeX\ package for liturgical documents in the style of the 1979 Book of Common Prayer\footnote{\url{http://justus.anglican.org/resources/bcp/formatted_1979.htm}}. It provides special typesetting tools for common liturgical situations (e.g. versicle and response, longer prayers, etc.) as well as formatting specifications for an entire document (e.g. font face, section headers, margins, etc.).

% \blankline
\section{Setup}

You can import \texttt{book-of-common-prayer} in the typical way by writing \lstinline|\usepackage{book-of-common-prayer}| in the preable of your \LaTeX\ document.

\subsection{Fonts}

The standard font used in the 1979 Book of Common Prayer is Sabon\footnote{\url{https://www.linotype.com/5598633/sabon-family.html}}. If you have Sabon installed on your computer, you can use it with \texttt{book-of-common-prayer} by writing \lstinline|\usepackage[sabon]{book-of-common-prayer}| in the preamble of your document to import the package.

You should also have the fonts Arial Unicode MS\footnote{\url{https://docs.microsoft.com/en-us/typography/font-list/arial-unicode-ms}} and Junicode\footnote{\url{https://junicode.sourceforge.io/}} installed on your computer. These two fonts provide some special symbols used by \texttt{book-of-common-prayer}.

Since \texttt{book-of-common-prayer} uses special fonts, you should compile your document with the Lua\LaTeX\ or Xe\LaTeX\ compiler.

\subsection{Music}

\texttt{book-of-common-prayer} works with Lilypond\footnote{\url{http://lilypond.org/}} for inline music notation. If you have musical scores you would like to integrate into your document, you should use the \texttt{lyluatex} package by writing \lstinline|\usepackage{lyluatex}| in the preamble of your document.

To compile your document with Lilypond scores, you must use Lua\LaTeX, e.g. \lstinline{lualatex -shell-escape your_document.tex}.

\subsection{Page setup}

By default, \texttt{book-of-common-prayer} structures the document to be booklet size (a folded 8.5 $\times$ 11" sheet). If you would like a different size, you can override this behavior by writing e.g.

\begin{lstlisting}
\geometry{paperheight=8.5in, paperwidth=5.5in}
\end{lstlisting}

in the preamble of your document.

\section{Documentation}

\subsection{Special symbols}

Table \ref{tab:symbol} shows the special symbols available in \lstinline{book-of-common-prayer}. To produce the formatted output, you must simply type the corresponding \LaTeX\ code.

\begin{table}[h!]
	\centering
	\begin{tabular}{ll}
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline|\versicle| & \versicle \\
	\lstinline|\response| & \response \\
	\lstinline|\cross| & \cross \\
	\lstinline|\scross| & \sabon{\scross} \\
	\lstinline|\gl| & \gl \\
	\lstinline|\gr| & \gr \\
	\bottomrule
	\end{tabular}
	\caption{Special symbols available in \lstinline{book-of-common-prayer}.}
	\label{tab:symbol}
\end{table}

\subsection{Special commands}

There are also some special commands to fine-tune formatting when needed (usually these are controlled by \LaTeX\, so the below should be used sparingly):

\begin{itemize}
	\item \lstinline{\blankline} forces a blank line (similar to pressing \lstinline{Enter} twice in Microsoft Word). Usually, \LaTeX\ manages this type of spacing for you, but you can use this command if you need more manual control.
	\item \lstinline{\deleteline} deletes an empty line's space (similar to backspacing over a blank line in Microsoft Word).
	\item \lstinline{\tab} creates an indent (similar to pressing \lstinline{tab} in Microsoft Word).
	\item \lstinline{\spacer} creates a very small vertical space when this kind of fine control is desired.
\end{itemize}

\subsection{Text formatting}

Several text formatting bracketings (macros) are available.

\subsubsection{Instructions}

\lstinline! \instruct{} ! will format the contents as instructions, i.e. italicized and slightly smaller font size than the body text.

\begin{table}[h!]
	\centering
	\begin{tabular}{l l} 
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline! \instruct{Here are instructions.} ! & \sabon{\instruct{Here are instructions.}} \\
	\bottomrule
	\end{tabular}
	\caption{Instructions.}
\end{table}

\lstinline! \instructsmall{} ! does the same, but in an even smaller font size.

\begin{table}[h!]
	\centering
	\begin{tabular}{l l} 
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline! \instruct{Here are instructions.} ! & \sabon{\instructsmall{Here are instructions.}} \\
	\bottomrule
	\end{tabular}
	\caption{Small instructions.}
\end{table}

\subsubsection{Bible verses}

\lstinline! \bibleref{} ! will format a Bible reference (chapter and verse) in a small font in small-caps.

\begin{table}[h!]
	\centering
	\begin{tabular}{l l} 
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline! \bibleref{John 3:16} ! & \sabon{\bibleref{John 3:16}} \\
	\bottomrule
	\end{tabular}
	\caption{A single Bible reference.}
\end{table}

\lstinline! \bibleverse{}{} ! takes two arguments: the text of the Bible verse, and its reference (chapter and verse). It formats the former in standard body text, and the latter is formatted in a small font in small caps, right-justified.

\begin{table}[h!]
	\centering
	\begin{tabular}{l l} 
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline! \bibleverse{Remember Lot's wife.}{Luke 17:32} ! & \sabon{Remember Lot's wife. \scriptsize\textsc{Luke 17:32} } \\
	\bottomrule
	\end{tabular}
	\caption{An expanded Bible reference.}
\end{table}

\subsubsection{Miscellaneous}

It is conventional to typset the current monarch’s name (if any) in all caps, italicized. We can do this with \lstinline! \monarch{} !:

\begin{table}[h!]
	\centering
	\begin{tabular}{l l} 
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline! \monarch{ELIZABETH} ! & \sabon{\monarch{ELIZABETH}} \\
	\bottomrule
	\end{tabular}
	\caption{Monarch name typesetting.}
\end{table}

To put a box around some text, and italicize the text inside, we can use \lstinline! \boxaround{} !:

\begin{table}[h!]
	\centering
	\begin{tabular}{l l} 
	\toprule
	\LaTeX\ code & Formatted output \\
	\midrule
	\lstinline! \boxaround{A box.} ! & \sabon{\fbox{A box.}} \\
	\bottomrule
	\end{tabular}
	\caption{Boxes around text.}
\end{table}

\continued
\clearpage
\subsection{Environments}

Several environments are available in \texttt{book-of-common-prayer}. These are used for common formatting blocks, such as versicle-and-response exchanges or longer prayers.

\subsubsection{Named responses with \lstinline{responses}}

Table \ref{tab:env_responses} shows how to use the \lstinline{responses} environment, which typesets response exchanges from named roles. This environment is useful for e.g. exchanges between the priest and the people. One named role and the text associated with it must be provided per line. The named role will be italicized and the text associated with that role will be spaced rightward.

Supported roles are \lstinline{priest}, \lstinline{deacon}, \lstinline{officiant}, \lstinline{servers}, and \lstinline{people}. Support for roles in French is also available (as \lstinline{pretre}, \lstinline{diacre}, \lstinline{officiant}, \lstinline{servants}, and \lstinline{peuple} respectively). The text associated with the \lstinline{people}/\lstinline{peuple} role is always bolded.

Other supported roles that will render as non-bolded are: \lstinline{subdeacon}, \lstinline{epistoler}, \lstinline{lector}.

% \pagebreak
\begin{table}[h!]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{responses}
	\priest{The priest can speak.}
	\deacon{The deacon too.}
	\officiant{So can an officiant.}
	\servers{The servers too.}
	\people{The people can respond.}

	\pretre{Le prêtre parle.}
	\diacre{Le diacre aussi.}
	\officiant{L'officiant parle aussi.}
	\servants{Les servants aussi.}
	\peuple{Le peuple repond.}
\end{responses}
\end{lstlisting}
&
\sabon{ 
\begin{responsesex}
	\priest{The priest can speak.}
	\deacon{The deacon too.}
	\officiant{So can an officiant.}
	\servers{The servers too.}
	\people{The people can respond.}
	& \\
	\pretre{Le prêtre parle.}
	\diacre{Le diacre aussi.}
	\officiant{L'officiant parle aussi.}
	\servants{Les servants aussi.}
	\peuple{Le peuple repond.}
\end{responsesex}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{responses} environment.}
\label{tab:env_responses}
\end{table}

% \blankline
\subsubsection{Versicle-response responses with \lstinline{vresponses}}

Table \ref{tab:env_vresponses} shows how to use the \lstinline{vresponses} environment, which typesets versicle-response exchanges. This environment works the same way as the \lstinline{responses} environment, but does not include named roles. Instead, turns in the exchange are headed by \versicle and \response characters, and we indicate which turn we are on by using \lstinline{V} and \lstinline{R} (as we might have used \lstinline{priest} in the \lstinline{responses} environment). The text associated with the response is always bolded.

\begin{table}[h]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{vresponses}
	\V{Here is the versicle.}
	\R{Here is the response.}
\end{vresponses}
\end{lstlisting}
&
\sabon{
\begin{vresponsesex}
	\V{Here is the versicle.}
	\R{Here is the response.}
\end{vresponsesex}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{vresponses} environment.}
\label{tab:env_vresponses}
\end{table}

Sometimes, if the response is long, we might want to format it further. We can do this by placing the response inside of an \lstinline|\rlong{}| bracketing. We can then use line breaks (\lstinline{\\}) and tabs (\lstinline{\tab}) to format the response as we like. Table \ref{tab:env_vresponses_rlong} shows an example of this.

\clearpage
\begin{table}[h!]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{vresponses}
	\V{Our Father,}
	\R{\rlong{
		Who art in heaven, \\
		\tab hallowed be thy name. \\
		Thy Kingdom come; \\
		\tab thy will be done \\
		\tab on earth as it is in heaven.} 
	}
\end{vresponses}
\end{lstlisting}
&
\sabon{
\begin{vresponsesex}
	\V{Our Father,}
	\R{\rlong{Who art in heaven, \\
		\tab hallowed be thy name. \\
		Thy Kingdom come; \\
		\tab thy will be done \\
		\tab on earth as it is in heaven. 
	}}
\end{vresponsesex}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{vresponses} environment used with a long, formatted response.}
\label{tab:env_vresponses_rlong}
\end{table}

\subsubsection{Doubled versicle-response responses with \lstinline{vresponsesdouble}}

Table \ref{tab:env_vresponsesdouble} shows how to use the \lstinline{vresponsesdouble} environment, which typesets versicle-response exchanges that are doubled up on one line. This environment works the same way as the \lstinline{vresponses} environment, but the versicle and response are included on the same line. Each turn is headed with \lstinline{\VR} and takes two arguments in brackets: one for the versicle text and the other for the response text. This can be useful when responses are repeated or space is at a premium. The text associated with the response is always bolded.

This environment takes one argument that represents the proportion of the line width that should be taken by the versicle. For example, calling \lstinline|\begin{vresponsesdouble}[0.5]| will allot half the line width for the versicle (and the remaining half to the response).

\begin{table}[h]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{vresponsesdouble}[0.7]
	\VR{Joy to thee, O Queen of Heaven;}
		{Alleluia.}
	\VR{He whom thou wast meet to bear,}
		{Alleluia.}
	\VR{As He promised hath arisen;}
		{Alleluia.}
	\VR{Pour for us to God thy prayer.}
		{Alleluia.}
\end{vresponses}
\end{lstlisting}
&
\sabon{
\begin{vresponsesdoubleex}[0.2]
	\VR{Joy to thee, O Queen of Heaven;}{Alleluia.}
	\VR{He whom thou wast meet to bear,}{Alleluia.}
	\VR{As He promised hath arisen;}{Alleluia.}
	\VR{Pour for us to God thy prayer.}{Alleluia.}
\end{vresponsesdoubleex}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{vresponsesdouble} environment.}
\label{tab:env_vresponsesdouble}
\end{table}

% \blankline
\subsubsection{Prayers with \lstinline{prayer}}

Table \ref{tab:env_prayer} shows how to use the \lstinline{prayer} environment, which typesets longer prayers that you may desire to format. As in the \lstinline{vresponses} environment, you can use \lstinline{\tab} to indent, but you do not need to use \lstinline{\\} for a line break. If the prayer is to be said by everyone, you may wish to surround it with a \lstinline|\textbf{}| to bold it. 

% \pagebreak
\begin{table}[h!]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{prayer}
	\textbf{
	Almighty God,
	\tab Father of our Lord Jesus Christ,
	\tab Maker of all things, Judge of all men:
	}
\end{prayer}
\end{lstlisting}
&
\sabon{
\begin{tabular}{l}
\textbf{Almighty God,} \\
\tab \textbf{Father of our Lord Jesus Christ,} \\
\tab \textbf{Maker of all things, Judge of all men:} \\
\end{tabular}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{prayer} environment.}
\label{tab:env_prayer}
\end{table}

% \blankline
\subsubsection{Two-column prayers with \lstinline{twocolprayer}}

Table \ref{tab:env_twocolprayer} shows how to use the \lstinline{twocolprayer} environment, which typesets prayers in two columns. This is useful for side-by-side texts in e.g. Latin and English. You can indicate a switch in column with the \lstinline{&} character.

\begin{table}[h!]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{twocolprayer}
	Sanctus, sanctus, sanctus, &
		Holy, holy, holy, \\
	Dominus, Deus sabaoth. &
		Lord God of hosts.
\end{twocolprayer}
\end{lstlisting}
&
\sabon{
\begin{tabular}{ll}
	Sanctus, sanctus, sanctus, & Holy, holy, holy, \\
	Dominus, Deus sabaoth. & Lord God of hosts.
\end{tabular}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{twocolprayer} environment.}
\label{tab:env_twocolprayer}
\end{table}

\subsubsection{Three-column prayers with \lstinline{threecolprayer}}

Table \ref{tab:env_threecolprayer} shows how to use the \lstinline{threecolprayer} environment, which typesets prayers in three columns. This is useful for responsive prayers. You can indicate a switch in column with the \lstinline{&} character.

\begin{table}[h!]
\centering
\begin{tabular}{ll}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{threecolprayer}
	Kyrie eleison, 
		& \textbf{Kyrie eleison,}
		& Kyrie eleison. \\
	\textbf{Christe eleison,}
		& Christe eleison,
		& \textbf{Christe eleison.} \\
	Kyrie eleison,
		& \textbf{Kyrie eleison,}
		& Kyrie eleison.
\end{threecolprayer}
\end{lstlisting}
&
\sabon{
\begin{tabular}{lll}
	Kyrie eleison, & \textbf{Kyrie eleison,} & Kyrie eleison. \\
	\textbf{Christe eleison,} & Christe eleison, & \textbf{Christe eleison.} \\
	Kyrie eleison, & \textbf{Kyrie eleison,} & Kyrie eleison.
\end{tabular}
}
\\
\bottomrule
\end{tabular}
\caption{The \lstinline{threecolprayer} environment.}
\label{tab:env_threecolprayer}
\end{table}


\subsubsection{Psalm typesetting}

It is possible to typeset psalms with a combination of an enumerated list and \lstinline{\psalmverse}, as shown in Table \ref{tab:psalms}.

\begin{table}[h]
\centering
\begin{xtabular}{p{.45\textwidth}p{.45\textwidth}}
\toprule
\LaTeX\ code & Formatted output \\
\midrule
\begin{lstlisting}
\begin{enumerate}[
	leftmargin=*,
	label=\textsc{\arabic*}
	]
	\item \psalmverse
		{The Lord is my shepherd:}
		{Therefore can I lack nothing.}
	\item \psalmverse
		{He shall feed me
		 in a green pasture:}
 		{and lead me forth beside
 		 the waters of comfort.}
\end{enumerate}
\end{lstlisting}
&
\sabon{
\begin{enumerate}[
	leftmargin=*,
	label=\textsc{\arabic*}
	]
	\item \psalmverse
		{The Lord is my shepherd:}
		{Therefore can I lack nothing.}
	\item \psalmverse
		{He shall feed me
		 in a green pasture:}
 		{and lead me forth beside
 		 the waters of comfort.}
\end{enumerate}
}
\\
\bottomrule
\end{xtabular}
\caption{Typesetting psalms with an enumerated list and \lstinline{\\psalmverse}.}
\label{tab:psalms}
\end{table}


\end{document}