summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/quoting/quoting.dtx
blob: 8ea2c69696eca9cc7a9d414720ee00d086c075e7 (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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
% \iffalse meta-comment
%
% This is file `quoting.dtx'.
%
% Copyright (C) 2011--2014 by Thomas Titz <thomas.titz@chello.at>
%
% Permission is granted to distribute and/or modify this work under the
% terms of the LaTeX Project Public License (LPPL), version 1.3c or
% later.
%
% The LPPL maintenance status of this work is "maintained".
%
% This work consists of the files quoting.dtx, quoting.ins and README
% and the derived files quoting.pdf and quoting.sty.
%
% \fi
%
% \iffalse
%
%<*driver>
\documentclass{ltxdoc}
\EnableCrossrefs 
\CodelineIndex
\RecordChanges
% \OnlyDescription
\GlossaryPrologue{%
  \section*{{Change History}}%
  \markboth{{Change History}}{{Change History}}%
  \vspace{-\multicolsep}%
}
\newcommand*{\SpecialOptIndex}[1]{%
  \index{#1={\protect\sffamily#1} (option)|usage}%
  \index{options:>#1={\protect\sffamily#1}|usage}%
}
\usepackage{quoting}
\usepackage{csquotes}
\SetBlockEnvironment{quoting}
\usepackage[bottom]{footmisc}
\addtolength{\skip\footins}{5pt}
\usepackage{cite,enumitem,url}
\frenchspacing
\def\quo/{\textsf{quoting}}
\def\quoa/{\textsf{quotation}}
\def\quoe/{\textsf{quote}}
\widowpenalty=10000
\begin{document}
\DocInput{quoting.dtx}
\end{document}
%</driver>
%
% \fi
%
% \CheckSum{169}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
% \changes{v0.1}{2011/08/08}{Initial public release}
%
% \GetFileInfo{quoting.sty}
%
% \DoNotIndex{\boolfalse,\booltrue,\csname,\def,\endcsname,\endinput}
% \DoNotIndex{\ifbool,\item,\@M,\NeedsTeXFormat,\newbool,\newcommand}
% \DoNotIndex{\newenvironment,\newlength,\par,\ProvidesPackage,\relax}
% \DoNotIndex{\RequirePackage,\setlength,\z@}
% \DoNotIndex{\do,\else,\fi,\ifcase,\ifcsname,\or}
%
% \title{The \quo/ package\thanks{This document corresponds to
% \quo/~\fileversion, dated \filedate.}}
% \author{Thomas Titz\thanks{E-mail: \texttt{thomas.titz@chello.at}}}
% \maketitle
%
% \begin{abstract}
% \noindent As an alternative to the \LaTeX\ standard environments
% \quoa/ and \quoe/, the \quo/ package provides a consolidated
% environment for displayed text. First-line indentation is activated by
% adding a blank line before the \quo/ environment. A key--value
% interface allows to configure font properties and spacing and to
% control orphans within and after the environment.
% \end{abstract}
%
% \section{Introduction}
%
% The \LaTeX\ standard classes as well as many custom classes provide
% two environments for displayed text: \quoa/ and \quoe/. They can be
% described as follows: \blockcquote[p.~480]{Kop04}{\textins{In} the
% \quoa/ environment \textelp{} text is indented on both sides relative
% to the normal page margins. Paragraphs within the environment are
% marked with an additional indentation of the first line.
%
% \textins{The \quoe/ environment is} \textins*{t}he same as the \quoa/
% environment except that the first line of a paragraph is not indented;
% instead, additional line spacing comes between paragraphs.}
%
% So when to prefer one environment to the other? A common suggestion is
% to use the \quoa/ environment for quotes extending to several
% paragraphs so that the paragraph indentation matches that of the
% surrounding text \cite{Kot11,Lam94,Oet11}. For single-paragraph quotes
% one may either use \quoe/ or, in case the quoted text starts a new
% paragraph (which should be indicated by indentation), \quoa/.
%
% Why didn't Leslie Lamport, the initial developer of \LaTeX, implement
% a single environment for displayed text and provide control over its
% first-line indentation by other means, e.g. the presence of a blank
% line (or a |\par| command) before the environment? The likely reason
% is that Lamport envisaged an additional application of the \quoe/
% environment, namely \blockcquote[p.~24]{Lam94}{a sequence of short
% quotations, separated by blank lines}. But such a sequence (which
% seems to be of limited use) could also be put into effect by stringing
% together several instances of a consolidated quoting environment.
%
% Some unfavourable effects of \quoa/ and \quoe/ in their present form
% are:
%
% \begin{itemize}
%
% \item The \quoa/ environment isn't suited for documents which use
% vertical spacing instead of indentation to denote the start of new
% paragraphs. If one retroactively adopts such a layout, one should
% change the definition of  |\quotation| and |\endquotation| to |\quote|
% resp. |\endquote|.
%
% \item The side-by-side existence of two environments for displayed
% text narrows the utility of the \textsf{csquotes} package which
% provides higher-level wrapper environments, e.g. for quoting in a
% foreign language and specifying the source of citations. Currently,
% \textsf{csquotes} uses \quoe/ as a backend environment, but with
% \LaTeX's default settings, this is not appropriate for multi-paragraph
% quotes.
%
% \end{itemize}
%
% \section{Using the \quo/ package}
%
% As an alternative to \quoa/ and \quoe/, the \quo/ package provides a
% consolidated environment for displayed text. Besides being indented
% relative to the normal page margins, the \quo/ environment behaves as
% follows:
%
% \begin{itemize}
%
% \item A blank line before the environment marks a new paragraph,
% i.\,e. the environment's first line will be (additionally) indented in
% this case (assuming a positive |\parindent|). The mechanism also works
% for adjoining \quo/ environments of the same depth and for nested
% quotes.\footnote{See \cite[p.~120--121]{Fis95} for an example of
% nested quotes.}
%
% \item If a \quo/ environment directly follows a sectioning command
% (which may or may not be considered good style), its first line won't
% be indented.\footnote{That is, unless the |@afterindent| switch was
% set to true, e.g. by loading the \textsf{indentfirst} package. In this
% case, the quote's first line will be indented.}
%
% \item As the start of a new paragraph is already indicated by
% first-line indentation, the vertical space before and after the \quo/
% environment is kept constant (contrary to list environments like
% \textsf{itemize} and \textsf{enumerate}).
%
% \item Because the \quo/ environment uses a custom mechanism to control
% orphans\footnote{If a page break occurs after the first line of a
% paragraph, that line is referred to as \enquote{orphan}.} within and
% after it, it is not affected by \LaTeX\ bug 4065 (|\clubpenalty| not
% always being reset after list environments).
%
% \end{itemize}
%
% The options provided by \quo/ use the key--value interface
% `\meta{key}=\meta{value}'. Set them globally with
% |\usepackage[|\meta{options}|]{quoting}| or for single environments
% with |\begin{quoting}[|\meta{options}|]|. For boolean options, the
% default value is \textsf{false}, and specifying \meta{key} is
% equivalent to \meta{key}\textsf{=true}.
%
% \begin{description}[font=\sffamily]
%
% \changes{v0.1a}{2011/09/08}{New option \textsf{indentfirst}}
%
% \item[indentfirst]\SpecialOptIndex{indentfirst} An option that allows
% to override \quo/'s indentation mechanism and to manually switch
% on/off first-line indentation. The permitted values are \textsf{auto},
% \textsf{true}, and \textsf{false}. The default value is
% \textsf{auto}.\footnote{The \textsf{indentfirst} option may act as a
% fallback solution for cases where \quo/'s indentation mechanism fails.
% Currently, first lines will always be indented a)~immediately after
% \texttt{\textbackslash begin\{document\}} b)~after a
% \textsf{sloppypar}, \textsf{center}, \textsf{flushleft}, or
% \textsf{flushright} environment. Thanks to Enrico Gregorio for
% pointing out \quo/'s behaviour with respect to \textsf{sloppypar},
% \textsf{center} \& friends.}
%
% \changes{v0.1b}{2012/02/21}{Improved syntax of options \textsf{font}
% and \textsf{font+}}
%
% \item[font]\SpecialOptIndex{font} The font used for typesetting the
% contents of a \quo/ environment. Permitted values are the names
% (without preceding backslash) of \LaTeX's font-switching/formatting
% commands; e.\,g, use \textsf{font=itshape} to typeset quotes in
% italics. (By default, \quo/ uses the font/formatting of the
% surrounding text.) To specify several font properties, use a
% comma-separated list of font/formatting names, e.g.,
% \textsf{font=\{itshape,raggedright\}} (note the surrounding
% braces).\footnote{Before \quo/ v0.1b, \textsf{font+} had to be invoked
% for specifying several font properties.}
%
% \item[font+]\SpecialOptIndex{font+} Font properties used for
% typesetting the contents of a \quo/ environment in addition to those
% properties specified by \textsf{font} (and previous calls of
% \textsf{font+}).
%
% \changes{v0.1b}{2012/02/21}{New options \textsf{begintext}
% and \textsf{endtext}}
%
% \item[begintext]\SpecialOptIndex{begintext} Additional text (e.g., an
% opening quotation mark) to be typeset at the start of a \quo/
% environment. By default, no text is added.
%
% \item[endtext]\SpecialOptIndex{endtext} Additional text (e.g., a
% closing quotation mark) to be typeset at the end of a \quo/
% environment. By default, no text is added.
%
% \item[leftmargin]\SpecialOptIndex{leftmargin} The width of the
% environment's left-hand indentation relative to the surrounding text.
% The default value is |\leftmargin|.\footnote{Note that the value of
% \texttt{\textbackslash leftmargin} depends on the depth of the \quo/
% environment, i.\,e. nested quotes will feature smaller indentation by
% default.}
%
% \item[rightmargin]\SpecialOptIndex{rightmargin} The width of the
% environment's right-hand indentation relative to the surrounding text.
% By default, \textsf{rightmargin} matches \textsf{leftmargin}.
%
% \item[vskip]\SpecialOptIndex{vskip} The vertical space before and
% after a \quo/ environment. The default value is the sum of |\topsep|
% and |\partopsep|.
%
% \item[listvskip]\SpecialOptIndex{listvskip} A boolean option that, if
% enabled, adjusts \quo/'s vertical spacing to that of list environments
% (and ignores \textsf{vskip} in the process).
%
% \item[noorphanfirst]\SpecialOptIndex{noorphanfirst} A boolean option
% that controls whether orphans are prohibited in the first paragraph of
% a \quo/ environment.
%
% \item[noorphanafter]\SpecialOptIndex{noorphanafter} A boolean option
% that controls whether orphans are prohibited directly after a \quo/
% environment.
%
% \item[noorphans]\SpecialOptIndex{noorphans} A shortcut boolean option
% enabling both \textsf{noorphanfirst} and \textsf{noorphanafter}.
%
% \end{description}
%
% \DescribeMacro{\quotingsetup}
% The command |\quotingsetup|, which takes a comma-separated list of
% key--value options as argument, allows to change the attributes of the
% \quo/ environment mid-document.
%
% \DescribeMacro{\quotingfont}
% The options \textsf{font} and \textsf{font+} do not accept values
% which itself take an argument. In such cases you must resort to
% redefining the command |\quotingfont|, e.g. by including
% |\renewcommand*{\quotingfont}{\setstretch{1.5}}| in your document
% preamble (with the \textsf{setspace} package loaded).
%
% \StopEventually{%
%
% \bibliographystyle{plain}
%
% \begin{thebibliography}{9}
%
% \bibitem{Bra09}
% Braams, Johannes, David Carlisle, Alan Jeffrey, Leslie Lamport,
% Frank Mittelbach, Chris Rowley, and Rainer Sch\"opf.
% \emph{The \LaTeXe\ sources}.
% 2009/09/24.
% \url{http://www.tug.org/texlive/Contents/live/texmf-dist/doc/latex/base/source2e.pdf}
% (accessed August 2, 2011).
%
% \bibitem{dec09}
% ``\textbackslash DeclareStringOption''.
% Series of messages on \textsf{comp.text.tex}, December 14, 2009.
% \url{http://groups.google.com/group/comp.text.tex/browse_thread/thread/1fb53938ac0026c5}
% (accessed September 6, 2011).
%
% \bibitem{Fis95}
% Fischel, William~A.
% \emph{Regulatory takings: Law, economics, and politics}.
% Cambridge, \textsc{ma}: Harvard University Press, 1995.
%
% \bibitem{Kop04}
% Kopka, Helmut and Patrick~W. Daly.
% \emph{Guide to \LaTeX}. 4\textsuperscript{th} edition.
% Boston: Addison-Wesley, 2004.
%
% \bibitem{Kot11}
% Kottwitz, Stefan.
% \emph{\LaTeX\ beginner's guide}.
% Birmingham: Packt Publishing, 2011.
%
% \bibitem{Lam94}
% Lamport, Leslie.
% \emph{\LaTeX: A document preparation system}.
% 2\textsuperscript{nd} edition.
% Boston: Addison-Wesley, 1994.
%
% \bibitem{Oet11}
% Oetiker, Tobias, Hubert Partl, Irene Hyna, and Elisabeth Schlegl.
% \emph{The not so short introduction to \LaTeXe}.
% Version 5.01, April 6, 2011.
% \url{http://mirror.ctan.org/info/lshort/english/lshort.pdf}
% (accessed August 2, 2011).
%
% \end{thebibliography}
%
% \PrintIndex
% \PrintChanges
%
% }
%
% \section{The package code}
%
% Announce the name and version of the package, which requires \LaTeXe.
%    \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{quoting}
    [2014/01/28 v0.1c Consolidated environment for displayed text]
%    \end{macrocode}
% We require the packages \textsf{kvoptions} (to conveniently specify
% options as key--value pairs) and \textsf{etoolbox} (e.g. for length
% assignments and boolean switch handling).
%    \begin{macrocode}
\RequirePackage{etoolbox,kvoptions}
%    \end{macrocode}
% We use \texttt{quo@} as a short prefix to internal macros defined by
% \textsf{kvoptions}.
%    \begin{macrocode}
\SetupKeyvalOptions{family=quo,prefix=quo@}
%    \end{macrocode}
% \begin{macro}{\quo@indentfirsttype}
% The key \textsf{indentfirst} takes a list of three values with
% associated functions and yields an error message if an unknown value
% is given. We use code snippets presented by Heiko Oberdiek and Joseph
% Wright in a series of messages on \textsf{comp.text.tex} \cite{dec09}.
%    \begin{macrocode}
\def\quo@in@false{\def\quo@indentfirsttype{0}}
\def\quo@in@true{\def\quo@indentfirsttype{1}}
\def\quo@in@auto{\def\quo@indentfirsttype{2}}
\define@key{quo}{indentfirst}{%
  \ifcsname quo@in@#1\endcsname
    \csname quo@in@#1\expandafter\endcsname
  \else
    \PackageError{quoting}{Unknown value #1 for option indentfirst}%
  \fi
}
\setkeys{quo}{indentfirst=auto}
%    \end{macrocode}
% \end{macro}
%
% \changes{v0.1c}{2014/01/28}{Options \textsf{font} and \textsf{font+}
% now work if a class (e.g. \textsf{scrbook}, \textsf{scrreprt}) or
% another package uses \texttt{\textbackslash let\textbackslash
% do\textbackslash relax}}
%
% \begin{macro}{\quotingfont}
% The \textsf{keyval} command |\define@key| is used to define the keys
% \textsf{font} and \textsf{font+}. With the help of |\docsvlist|
% (provided by \textsf{etoolbox}), we convert their comma-separated list
% of values to commands and use these commands to define |\quotingfont|
% resp. to append its definition. We use |\def\do| so that the options
% will also work if a class (e.g. \textsf{scrbook}, \textsf{scrreprt})
% or another package uses |\let\do\relax|.
%    \begin{macrocode}
\newcommand*{\quotingfont}{}
\define@key{quo}{font}{%
  \def\quotingfont{}%
  \def\do##1{\appto{\quotingfont}{\csname ##1\endcsname}}%
  \docsvlist{#1}%
}
\define@key{quo}{font+}{%
  \def\do##1{\appto{\quotingfont}{\csname ##1\endcsname}}%
  \docsvlist{#1}%
}
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\quo@begintext}
% \begin{macro}{\quo@endtext}
% \begin{macro}{\quo@leftmargin}
% \begin{macro}{\quo@rightmargin}
% We use \textsf{kvoptions} to define the keys \textsf{begintext},
% \textsf{endtext}, \textsf{leftmargin}, and \textsf{rightmargin} and to
% set default values for the latter two.
%    \begin{macrocode}
\DeclareStringOption{begintext}
\DeclareStringOption{endtext}
\DeclareStringOption[\leftmargin]{leftmargin}
\DeclareStringOption[\quo@leftmargin]{rightmargin}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \begin{macro}{\quo@toppartop}
% \begin{macro}{\quo@vskip}
% The length |\quo@toppartop| is set to the sum of |\topsep| and
% |\partopsep| and used as the default value of the key \textsf{vskip}.
%    \begin{macrocode}
\newlength{\quo@toppartop}
\deflength{\quo@toppartop}{\topsep + \partopsep}
\DeclareStringOption[\quo@toppartop]{vskip}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% We define the boolean options \textsf{listvskip},
% \textsf{noorphanfirst}, and \textsf{noorphanafter}.
%    \begin{macrocode}
\DeclareBoolOption{listvskip}
\DeclareBoolOption{noorphanfirst}
\DeclareBoolOption{noorphanafter}
%    \end{macrocode}
% The shortcut boolean option \textsf{noorphans} will pass its value to
% |quo@noorphanfirst| and |quo@noorphanafter|. We then process our
% options.
%    \begin{macrocode}
\define@key{quo}{noorphans}[true]{%
  \setbool{quo@noorphanfirst}{#1}%
  \setbool{quo@noorphanafter}{#1}%
}
\ProcessKeyvalOptions*
%    \end{macrocode}
% \begin{macro}{\quotingsetup}
% We define |\quotingsetup| as an alias of |\setkeys{quo}|.
%    \begin{macrocode}
\newcommand*{\quotingsetup}[1]{\setkeys{quo}{#1}}
%    \end{macrocode}
% \end{macro}
% The boolean switch |quo@afterquo| stores whether we are immediately
% (without a paragraph in between) following a \quo/ environment; the
% |quo@afterquoclub| switch stores whether an orphan is permitted after
% the environment. (For the latter task, we don't use
% |quo@noorphanafter| directly because its state needs to be forwarded
% outside the group established by the current environment.)
%    \begin{macrocode}
\newbool{quo@afterquo}
\newbool{quo@afterquoclub}
%    \end{macrocode}
% \begin{macro}{\quo@doendquoclub}
% If the |quo@afterquoclub| switch is set to false, |\quo@doendquoclub|
% will set |\clubpenalty| to 10\,000. It will restore |\everypar| and
% the default value of |\clubpenalty| in the next paragraph.
%    \begin{macrocode}
\newcommand*{\quo@doendquoclub}{%
  \ifbool{quo@afterquoclub}{%
    \clubpenalty=\@clubpenalty
    \everypar{}%
  }{%
    \booltrue{quo@afterquoclub}%
    \clubpenalty=\@M
  }%
}
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\quo@doendquo}
% The macro |\quo@doendquo| is an extended version of the \LaTeX\ kernel
% macro |\@doendpe|. In the original,
% \blockcquote[p.~227]{Bra09}{\textins*{t}o suppress the paragraph
% indentation in text immediately following a paragraph-making
% environment, \texttt{\textbackslash everypar} is changed to remove the
% space, and \texttt{\textbackslash par} is redefined to restore
% \texttt{\textbackslash everypar}.} |\quo@doendquo| adds the following
% changes to |\par|/|\everypar| over and above |\@doendpe|:
% \begin{itemize}
%
% \item |\quo@doendquoclub| is executed;
%
% \item At the end, the |quo@afterquo| switch is globally set to false.
%
% \end{itemize}
%    \begin{macrocode}
\newcommand*{\quo@doendquo}{%
  \booltrue{@endpe}%
  \def\par{%
    \@restorepar
    \everypar{\quo@doendquoclub}%
    \par
    \boolfalse{@endpe}%
    \global\boolfalse{quo@afterquo}%
   }%
  \everypar{%
    {\setbox\z@\lastbox}%
    \quo@doendquoclub
    \boolfalse{@endpe}%
    \global\boolfalse{quo@afterquo}%
  }%
}
%    \end{macrocode}
% \end{macro}
% \begin{environment}{quoting}
% The definition of the \quo/ environment includes an optional argument
% which may be used to change package settings locally.
%    \begin{macrocode}
\newenvironment{quoting}[1][]{%
  \setkeys{quo}{#1}%
%    \end{macrocode}
% \end{environment}
% We start a \textsf{list} environment and (unless the boolean switch
% \textsf{listvskip} is set to true) use the value of \textsf{vskip} for
% vertical spacing.
%    \begin{macrocode}
  \list{}{%
    \ifbool{quo@listvskip}{%
    }{%
      \setlength{\topsep}{\quo@vskip}%
      \setlength{\partopsep}{\z@}%
    }%
%    \end{macrocode}
% The length |\itemindent| is responsible for the first-line indentation
% of \quo/. Its value (0\,pt or |\parindent|) is controlled first and
% foremost by the state of the key \textsf{indentfirst} (\textsf{false},
% \textsf{true}, or \textsf{auto}). In case automatic first-line
% indentation is enabled, |\itemindent| will be set to |\parindent|
% if the following conditions are met:
% \begin{itemize}
%
% \item We are in vertical mode (which usually means that a blank line
% or a |\par| command is present before the environment~-- but see
% below);
%
% \item The boolean switch |quo@afterquo| is set to false (i.\,e.,
% vertical mode does not stem from a preceding \quo/ environment of the
% same depth);
%
% \item The \LaTeX\ kernel switch |@nobreak| is either set to false (the
% \quo/ environment does not directly follow a sectioning command), or
% both |@nobreak| and |@afterindent| are set to true.
%
% \end{itemize}
%    \begin{macrocode}
    \ifcase\quo@indentfirsttype\relax
      \setlength{\itemindent}{\z@}%
    \or
      \setlength{\itemindent}{\parindent}%
    \or
      \setlength{\itemindent}{%
        \ifbool{vmode}{%
          \ifbool{quo@afterquo}{%
            \z@
          }{%
            \ifbool{@nobreak}{%
              \ifbool{@afterindent}{%
                \parindent
              }{%
                \z@
              }%
            }{%
              \parindent
            }%
          }%
        }{%
          \z@
        }%
      }%
    \fi
%    \end{macrocode}
% The lengths |\leftmargin|, |\rightmargin|, |\listparindent|, and
% |\parsep| are set, the latter two in accordance with the settings for
% the surrounding text.
%    \begin{macrocode}
    \setlength{\leftmargin}{\quo@leftmargin}%
    \setlength{\rightmargin}{\quo@rightmargin}%
    \setlength{\listparindent}{\parindent}%
    \setlength{\parsep}{\parskip}%
  }%
%    \end{macrocode}
% We issue the necessary |\item| command, disable orphans in the
% environment's first paragraph when indicated, and switch to
% |\quotingfont|. (With regard to orphans, we make use of |\@item|'s
% internal mechanism to prevent orphans directly after sectioning
% commands \cite[p.~229]{Bra09}.) Lastly, we typeset the replacement
% text of the \textsf{begintext} key.
%    \begin{macrocode}
  \item\relax
  \ifbool{quo@noorphanfirst}{%
    \global\booltrue{@nobreak}%
  }{%
  }%
  \quotingfont
  \quo@begintext\ignorespaces
%    \end{macrocode}
%
% \changes{v0.1c}{2014/01/28}{\quo/ is now permitted to close with a
% list environment plus a blank line}
%
% At the end of \quo/, we typeset the replacement text of
% \textsf{endtext}. (We also remove any preceding space if we are in
% horizontal mode; this does not apply if, e.g., the \quo/ environment
% closes with a list environment like \textsf{itemize} or
% \textsf{enumerate} plus a blank line.) After that, the following
% actions are taken:
% \begin{itemize}
%
% \item The \LaTeX\ kernel switch |@endpe| is set to false (so that
% |\@doendpe| won't be executed);
%
% \item The state of the |quo@noorphanafter| switch is forwarded outside
% the current group (using \TeX\ syntax);
%
% \item |quo@afterquo| is globally set to true;
%
% \item |\quo@doendquo| is executed after the current group.
%
% \end{itemize}
%    \begin{macrocode}
}{%
  \ifbool{hmode}{%
    \unskip
  }{%
  }%
  \quo@endtext
  \endlist
  \boolfalse{@endpe}%
  \ifbool{quo@noorphanafter}{%
    \aftergroup\quo@afterquoclubfalse
  }{%
    \aftergroup\quo@afterquoclubtrue
  }%
  \global\booltrue{quo@afterquo}%
  \aftergroup\quo@doendquo
}
%    \end{macrocode}
% The end of the package.
%    \begin{macrocode}
\endinput
%    \end{macrocode}
%
% \Finale
\endinput