summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/novel/novel.cls
blob: e029b43c7990a9a57fbee09734a36888aebe393b (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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
%%
%% This is file `novel.cls', LuaLaTeX `novel' document class.
%% Copyright 2017-2018 Robert Allgeyer.  Contact:  anytthree [at] gmail.com
%% 
%% This file may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3c
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%    http://www.latex-project.org/lppl.txt
%% and version 1.3c or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%% 
%% 
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
% Actually needs LuaLaTeX, at least version 0.95 from TeXLive 2016.
\ProvidesClass{novel}[2018/04/26 v1.52 LaTeX document class]
%%
%% Version 1.50.n (any n) incremental minor changes from 1.50.
%% Version 1.50: Improved image handled, sandbox, scripts.
%% Version 1.46.2: Now called "novel-old" version.
%% Version 1.43: General cleanup of docs and code, for improved readbaility.
%% Version 1.42: Greatly improved HTML documentation.
%% Version 1.41: Improved HTML documentation.
%% Versions 1.40.x: Incremental minor changes, leading to 1.42.
%% Version 1.40: removed `debug' option (was not useful). Major docs rewrite.
%%   This version was successfully used for a P.O.D. novel, with cover.
%% Version 1.38: corrected offset in cover artwork; some docs modified.
%% Version 1.36: minor documentation correction.
%% Version 1.34: Added debug class option and related code. [Later removed.]
%% Version 1.32 includes a minor documentation fix, and a major bug fix
%%   concerning looose text tracking. The bug occasionally appeared when
%%   page headings were compiled, but gave a cryptic error message
%%   about MT@res@a. The fix is expected to be permanent.
%% Version 1.2: Added capability for cover artwork.
%% Versions 1.1.x: First general release, occasional documentation changes.


%% DESCRIPTION:
%% ----------------------------------------------------------------------------
%% Class `novel' is designed for print fiction: novels or short stories.
%% It cannot be used for e-books or for journal publication.
%% It is not suitable for most non-fiction, because routine academic features
%% such as bibiography and automatic sectioning are defeated.
%%
%% There are pre-configured layouts for the most commonly used choices of
%% trim size (finished book width and height), and internal layout consistent
%% with fiction. The user can over-ride the pre-configured settings.
%%
%% The class will automatically create PDF/X compliant files upon request,
%% using a self-contained command structure. Results have been tested.
%%
%% LuaLaTeX is required, and input files must be encoded utf-8.
%%
%% Fonts are loaded by luaotfload and fontspec, and massaged by microtype.
%% For best results, use modern Open Type fonts, or TrueType fonts.
%%
%% The Libertinus font family, a fork of [Linux] Libertine/Biolinum,
%% is the default. Actually, I recommend it! In addition, an included
%% custom font, NovelDeco.otf, is used for special purposes.
%%


%% REQUIRE LUATEX and do some preliminary setup.
%% ----------------------------------------------------------------------------
%% These are not user settings.
%
\RequirePackage{ifluatex} % LuaTeX is required. Not XeTeX, dvips, or pdfTeX.
\RequirePackage{ifxetex} % For occasional hacks (hiss, boo).
\RequirePackage{luatex85} % Needed for compatibility with LuaTeX 0.95 etc.
\RequirePackage{pdftexcmds} % compatibility
\ifluatex
  % New with TeXlive 2016. Removes unnecessary File Data:
  \pdfvariable suppressoptionalinfo 511 % writes only ID to PDF Catalog
\else
  \ClassError{novel}{Must compile with LuaLaTeX 0.95+}%
   {Sorry, LuaLaTeX only. No pdfTeX, dvips, or XeTeX.}
\fi
\pdfimageresolution=300 % default dpi if image does not say
%
\RequirePackage{etoolbox} % general good stuff
\RequirePackage{xifthen} % improved ifthenelse handling
\RequirePackage{xstring} % parses strings
\RequirePackage{fp} % used everywhere for math calculations
\RequirePackage{xfp} % more math calculations
\RequirePackage{keyval} % used by drop cap
\FPmessagesfalse % eliminates numerous friendly messages from the log
%
\pdfminorversion=3 % might be reset later, depending on settings
\gdef\thepdfminorversion{\pdfminorversion} % compatibility
%
\RequirePackage{silence} % Used here:
% hyperref draft mode is always on, even when novel is not in draft mode:
\WarningFilter{hyperref}{Draft mode on} % So, get rid of the hyperref warning.
% Prevent complaints about no protrusion list for cmr, cmm, etc. in decimal pt:
\WarningFilter{microtype}{I cannot find a protrusion list} % It's not there!
%
\WarningsOff[Fancyhdr,fancyhdr] % complains about headheight when no header
\RequirePackage[relative]{textpos} % for inserting images
\RequirePackage{calc} % allows length expression calculations
\RequirePackage{atbegshi} % in oberdiek bundle. For one-page header changes. Also used by hyperref.
\RequirePackage{letltxmacro} % in oberdiek bundle. For re-defining some macros
\RequirePackage{xparse} % for writing cool-looking commands
%
% In addition, the following packages are required, but not loaded yet.
% They must wait for something else to happen first. Then they will be loaded
%   with suitable arguments, when the time comes:
% fontspec -- in novel-LayoutSettings.sty
% unicode-math -- in novel-LayoutSettings.sty
% polyglossia -- in novel-LayoutSettings.sty
% microtype -- in novel-Fonts.sty
% hyperref -- in novel-pdfx.sty
% fancyhdr -- in novel.HeadFootStyles.sty
% xcolor -- lower in this page
% adjustbox -- lower on this page
% eso-pic -- lower on this page
% lipsum -- lower on this page
%%


\newlength\@tempLength % scratch length for local calculations
\newif \if@tempTF % scratch boolean for local tests


%% Global lengths are often passed around in `novel'.
%% But \setlength is not always global in effect.
%% This code defines a global command.
%% Via Heiko Oberdiek at tex.stackexchange.com:
\gdef\gsetlength#1#2{% #1 is the length command, #2 is the length value
  \begingroup%
    \setlength\skip@{#2}% Local assignment to a TeX scratch register.
    \global#1=\skip@% Global assignment to #1
  \endgroup% \skip@ is restored by end of group.
}% end \gsetlength
%%


%% Process document class options.
%% ----------------------------------------------------------------------------
% Allowed option list:
%   draft xml shademargins cropmarks cropview closecrop
%   coverart sandbox unblock mtoff polyoff test
% Yes, I realize that this could have been done another way, but I want
%   to issue error messages from `novel' rather than (say) `keyval':
\gdef\@mycol{\@classoptionslist}
\StrDel{\@mycol}{ }[\@mycol]
\StrDel{\@mycol}{,}[\@mycol]
\StrDel{\@mycol}{draft}[\@mycol]
\StrDel{\@mycol}{xml}[\@mycol]
\StrDel{\@mycol}{shademargins}[\@mycol]
\StrDel{\@mycol}{graytext}[\@mycol] % Obsolete. Now always allows graytext.
\StrDel{\@mycol}{greytext}[\@mycol] % See above.
\StrDel{\@mycol}{cropmarks}[\@mycol]
\StrDel{\@mycol}{cropview}[\@mycol]
\StrDel{\@mycol}{closecrop}[\@mycol]
\StrDel{\@mycol}{coverart}[\@mycol]
\StrDel{\@mycol}{unblock}[\@mycol]
\StrDel{\@mycol}{mtoff}[\@mycol]
\StrDel{\@mycol}{polyoff}[\@mycol]
\StrDel{\@mycol}{test}[\@mycol]
\StrDel{\@mycol}{sandbox}[\@mycol]
%
\ifthenelse{\equal{\@mycol}{}}{}{
  \ClassWarning{novel}{^^JUnrecognized class option: \@mycol. ^^J%
   The unrecognized option was ignored! ^^J%
   If `debug' it is obsolete from v.1.40. ^^J%
   Note that font size, document size, and language ^^J%
   are not `novel' class options. See documentation. ^^J}%
}
% If used, option `draft' shows overflow rule.
% Prior to v. 1.46.1, the following was \if@useDraftMode.
% Changed for possible compatibility with packages that detect draft mode.
\newif \ifdraftdoc
\setlength\overfullrule{0pt}
\DeclareOption{draft}{
  \setlength\overfullrule{6pt}
  \draftdoctrue
  \ClassWarning{novel}{^^JCompiled with draft mode. Not for final release! ^^J}
}
\newif \ifmsdoc % manuscript, always false. Compatibility with other packages.
% If used, option `xml' creates a file `\jobname-XMPasXML.xml` that contains
% the XMP metadata with an xml declaration and comments at top.
% Only works when \SetPDFX is not `off'. Note that you do not need to use
% this option to get PDF/X. It is only for your own usage.
\newif \if@wantXMPasXML
\DeclareOption{xml}{\@wantXMPasXMLtrue}
\DeclareOption{xmp}{ % in case you mis-type.
  \ClassError{novel}{No class option `xmp'. Use `xml'}%
   {There is no class option named `xmp'. It is `xml'.}
}
% Option `shademargins' does just that. Ignored unless in draft mode.
\newif \if@shademargins
\DeclareOption{shademargins}{\@shademarginstrue}
%
\newif \if@graytext % remains here for backwards compatibility
\@graytexttrue % from v.1.50 always true, no longer an option.
%
% Usually you do NOT want crop (trim) marks!
\newif \if@cropmarks
\DeclareOption{cropmarks}{\@cropmarkstrue}
% PDF viewers display CropBox, which normally is identical to MediaBox.
% Option `cropview', sets CropBox to TrimBox instead, so that's all you see.
% Only makes a difference when MediaBox is larger than TrimBox.
% Ignored unless in draft mode.
\newif \if@cropview
\DeclareOption{cropview}{\@cropviewtrue}
% With `closecrop', the TrimSize and margins are re-sized, to preserve the
% live area, but with reduced margins on all sides (same for verso/recto).
% This option is available only in draft mode, and disables shademargins.
% The purpose is to create a PDF that is more easily read on a handheld device,
% so you can think about edits while traveling. It is NOT an e-book, since
% it has no hyperlinks and is missing some features that an e-book should have.
\newif \if@closecrop
\DeclareOption{closecrop}{\@cropviewtrue\@closecroptrue}
% New in version 1.2: `coverart' option. See documentation.
% This is used to create a 1-page file with no text, just an image.
% Intended purpose is PDF/X for novel cover.
\newif \if@coverart
\DeclareOption{coverart}{\@coverarttrue}
% New in version 1.34: unblock option, for developer use only.
% Normally, a number of packages known to be incompatible with `novel'
% are blocked from loading. If the user tries to get them via \usepackage
% or \RequirePackage, or if they are called within some other loaded package,
% then compile halts with an error. The `unblock' option turns off blocking,
% and allows incompatible packages to load. Use only at own risk!
\newif \if@novelunblock % For developer use.
\DeclareOption{unblock}{\@novelunblocktrue}
% New in version 1.44: mtoff option, primarily for developer use.
% With mtoff, the microtype package is not loaded.
\newif \if@mtoff
\DeclareOption{mtoff}{\@mtofftrue}
% New in version 1.44: polyoff option, primarily for developer use.
% With polyoff, the polyglossia package is not loaded.
% You may need to load babel, or not, via \RequirePackage[options]{babel}.
\newif \if@polyoff
\DeclareOption{polyoff}{\@polyofftrue}
% New in version 1.46: test option, primarily for developer use.
\newif \if@testsuite
\DeclareOption{test}{\@testsuitetrue}
%
% New in version 1.50: sandbox option, for artwork and tables. Max 4 pages.
\newif \if@sandbox
\DeclareOption{sandbox}{\@sandboxtrue}
%
%% Note that document size and normal font size are not class options.
%% They are set by commands in the Preamble, and have default values.
%
\ProcessOptions\relax
% Disable some options, depending on compatibilities:
\ifdraftdoc\else
  \global\@shademarginsfalse
  \global\@cropviewfalse
  \global\@closecropfalse
\fi
%
\if@testsuite
  \gdef\@testintentional{Test suite intentionally generates this warning. ^^J}
\else
  \gdef\@testintentional{}
\fi
%
\if@cropview
  \global\@cropmarksfalse
\fi
%
\if@closecrop
  \global\@cropviewtrue
  \global\@shademarginsfalse
  \global\@cropmarksfalse
\fi
%
\if@coverart
  \global\draftdocfalse
  \global\@shademarginsfalse
  \global\@cropviewfalse
  \global\@closecropfalse
  \global\@sandboxfalse
\fi
%
\if@sandbox
  % Thanks to user Compholio at stackexchange.com:
  \newcounter{sandboxcount}
  \ifx\latex@outputpage\@undefined\relax%
      \global\let\latex@outputpage\@outputpage%
  \fi%
  \gdef\@outputpage{%
    \addtocounter{sandboxcount}{1}%
    \ifnum\value{sandboxcount}>4\relax% no output after 4 pages
    \else%
      \latex@outputpage%
    \fi%
  }%
  \AtEndPreamble{%
    \gdef\@title{untitled interior artwork}%
  }%
  \AfterEndPreamble{%
    \ifdraftdoc\else\thispagestyle{empty}\fi%
  }%
\fi
%% end class options


\RequirePackage{noindentafter} % for unindented chapter and scene starts
\RequirePackage{changepage} % provides block indents, etc. Do not use strict!
\RequirePackage{magaz} % special treatment of first lines


%% Activate xcolor, adjustbox, and eso-pic:
%% ----------------------------------------------------------------------------
% The final book must be black/white and gray only, for all text.
% Interior images must be raster black/white or grayscale. See documentation.
%   Vector graphics are strongly discouraged, in any case.
% In draft mode only, the `shademargins' option requires `grayscale',
%   which will be temporarily enabled, even if not specifically requested.
%
\RequirePackage[gray,hyperref]{xcolor}
%
% adjustbox and eso-pic cannot precede xcolor.
\RequirePackage{adjustbox} % for scaling and moving
\RequirePackage{eso-pic} % background effects in draft mode
\RequirePackage{pdfpages} % only used for pdf pre-processed by novel-scripts
%% end activate xcolor and adjustbox


%% Temporary normal font size, baselineskip, and fontspec
%% ----------------------------------------------------------------------------
%% This normalsize is temporary, so that packages can load without complaint.
%% It will be modified later, during layout calculations.
%% Actual default font size will be 11pt-12pt, with 11.4pt average.
%% The small temporary size is to ensure that overly-large struts and skips
%%   are not created prior to page layout calculation.
\gdef\@TentativeEmN{10}
\gdef\@TentativeBLSkipN{13}
\renewcommand\normalsize{%
  \@setfontsize\normalsize{\@TentativeEmN}{\@TentativeBLSkipN}%
}
\normalsize
\RequirePackage[no-math]{fontspec} % For LuaLaTeX. NOT package `fontenc'.
% The `novel' class is not intended for math. But TeX assumes you do math,
%   so it needs a math font, whether you like it or not.
\RequirePackage{unicode-math}
%% end temporary normal point size, baselineskip, and fontspec.


%% Define commands used for File Data, including PDF/X Settings.
%% ----------------------------------------------------------------------------
%% As used here, `File Data' refers to PDF metadata as found in PDF/Info
%% and in XMP. This class does not write it to the PDF Catalog.
\RequirePackage{novel-FileData}
%%


%% Physical Layout Commands and Settings.
%% ----------------------------------------------------------------------------
%% Define user commands that over-ride class option pre-configured settings.
%% Also sets a variety of miscellaneous lengths:s \parsep, \parindent, etc.
\RequirePackage{novel-LayoutSettings}


%% Polyglossia.
%% ----------------------------------------------------------------------------
% Language-specific settings:
\if@polyoff % polyoff is new in v 1.44.
  \ClassWarning{novel}{^^JYou chose the `polyoff' class option. ^^J%
    So, the polyglossia package was not loaded. But like it or not, ^^J%
    the babel package was loaded, with generic hyphenation. ^^J%
    This behavior, or choice of language, cannot be changed. ^^J%
    If you want a specific language, you will have to use polyglossia. ^^J}%
\else
  \RequirePackage{polyglossia} % loading order changed in v. 1.40.3.
  \setdefaultlanguage[variant=american]{english} % may be changed by user
\fi
%% end polyglossia


%% Additional Macros, Loaded in Preamble.
%% ----------------------------------------------------------------------------
\RequirePackage{novel-Fonts} % font settings and defaults
\if@coverart\else\RequirePackage{lipsum}\fi % generates dummy text for examples
%% New in version 1.50:
\RequirePackage{novel-DropCap}
% Macros for use in document body:
\RequirePackage{novel-TextMacros}
% Standard header footer styles, based on `fancyhdr':
% Each pre-configured style will set these booleans true or false:
\newif\if@HasHeader \newif\if@HasFooter
\RequirePackage{novel-HeadFootStyles}
% Chapter and Scene styles:
\RequirePackage{novel-ChapterScene}
% Image placement:
\RequirePackage{novel-Images}
% Footnotes and endnotes:
\RequirePackage{novel-Footnotes}
% Obsolete code. Do not use in new documents:
\RequirePackage{novel-Obsolete}
%%


%% For convenience, from `article' class.
%% ----------------------------------------------------------------------------
\newenvironment{verse}{% Not very useful.
  \let\\\@centercr
  \list{}{%
    \itemsep\z@
    \itemindent -\parindent%
    \listparindent\itemindent
    \rightmargin \leftmargin
    \advance\leftmargin \parindent%
  }%
  \item\relax%
}{%
  \endlist%
}
%%
\newenvironment{quotation}{% Not very useful.
  \list{}{%
    \listparindent \parindent%
    \itemindent \listparindent
    \rightmargin \leftmargin
    \parsep \z@%
  }%
  \item\relax%
}{%
  \endlist%
}
%%
\newenvironment{quote}{% Not very useful.
  \list{}{%
    \rightmargin\leftmargin%
  }%
  \item\relax%
}{%
  \endlist%
}
%
%% end convenience.



%% Special features of test suite (for developers and error reporting)
%% ----------------------------------------------------------------------------
% Files `novel-testsuite.tex' and `novel-testimage.png' are within the novel
%   documentation extras folder. To run the test suite, copy these files to
%   a writeable location (such as your home directory) and compile there.
\newcommand\testsuiteoops[1]{%
  \ClassError{novel}{#1 missing}{Install the necessary file(s).}%
}
\if@testsuite
  \IfFontExistsTF{libertinusserif-regular.otf}{}{%
    \testsuiteoops{`libertinus' fonts}%
  }
  \IfFileExists{lmodern.sty}{}{\testsuiteoops{`lmodern' package}}
  \IfFileExists{novel-testimage.png}{}{\testsuiteoops{`novel-testimage.png'}}
  \NewFontFamily\mustbelibertinus{Libertinus Serif}
  \NewFontFamily\mustbelmodern{Latin Modern Roman}
\fi
%% end special features of test suite.


%% \AtEndPreamble sets defaults, calculates layout, and writes PDF/X
%% ----------------------------------------------------------------------------
% This is prior to \AtBeginDocument, and ensures that the results are available
%   prior to any \AtBeginDocument routines from user macros or loaded packages. 
\AtEndPreamble{
  \@ActivateFonts % in `novel-Fonts.sty'
  \RequirePackage{novel-CalculateLayout} % may load novel-ChangeLayout.sty
  \RequirePackage{novel-PostLayout} % calculates shademargins, cropmarks, etc.
  \RequirePackage{novel-pdfx}% also provides an \AtBeginDocument macro
  \@GetInitialYpos% in `novel-TextMacros.sty
}%
%% end AtEndPreamble


%% Messages that may be issued by \AtBeginDocument routines:
%% ----------------------------------------------------------------------------
%
%% Dealing with known incompatible packages:
\gdef\really@no#1#2#3{ % cannot be used, even with unblock or sandbox
  \@ifpackageloaded{#1}{%
   \ClassError{novel}{Sorry, package `#1' cannot be used in `novel' class}%
    {No exceptions. You are out of luck. ^^J%
     Reason: `novel' has #2 ^^J%
     See `novel' HTML documentation, section #3. ^^J%
     Note: The offending package may have been loaded by another package.}%
  }{}%
} %
%
%% Command or environment native to LuaLaTeX, but banned except in sandbox:
\gdef\@OnlySandbox#1{%
  \ClassError{novel}{Use of `#1' page \thepage\space requires sandbox}%
   {`novel' class prohibits command or environment `#1' ^^J%
    unless you use class option `sandbox'. See documentation.}%
}
%
%% Package can be used, but Alert:
\gdef\alert@nodisp#1{%
  \@ifpackageloaded{#1}{%
  \typeout{^^JClass `novel' Alert: Beware of package #1. ^^J%
   Commands from this package may cause mis-positioning in main text. ^^J%
   Maybe, maybe not. Best if usage is confined to display pages. ^^J}%
  }%
}
%
%% Dealing with blocked packages, allowed with `unblock':
\if@novelunblock
  \gdef\sorry@no#1{} % no package-specific errors, when unblock
  \ClassWarning{novel}{Using `unblock' class option, at your own risk. ^^J%
    The `unblock' option is for developer use, not production documents. ^^J%
    If the unblocked packages and commands cause problems, ^^J%
    they are not bugs. Do not report them. You have been warned. ^^J%
    Perhaps your document will compile without error, and perhaps the ^^J%
    results are OK. But in other cases, unexpected typesetting results. ^^J}%
\else % package-specific errors, when no unblock
  \gdef\sorry@no#1{
    \@ifpackageloaded{#1}{%
     \ClassError{novel}{Sorry, package `#1' cannot be used in `novel' class}%
      {See `novel' HTML documentation, regarding `sandbox' option. ^^J%
       Note: The offending package may have been loaded by another package.}%
    }{}%
  } %
\fi
%
\gdef\@needsandboxmsg{%
  \ClassError{novel}{Need `sandbox' for picture, figure, table environments}%
   {You cannot use picture, figure, or table environments in `novel' unless ^^J%
    you use the `sandbox' document class option. See docs.}%
}
%% end messages.


%% \AtBeginDocument finishes the setup
%% ----------------------------------------------------------------------------
%
\AtBeginDocument{ %
  \@RedefineParapos % in `novel-TextMacros.sty'
  \@ActivateTextLengths % in `novel-TextMacros.sty'
  \@ActivateDropCaps % in `novel-DropCaps.sty'
  \@ActivateChapterScene % in `novel-ChapterScene.sty'
  \@ActivateHeadFootStyles % in file `novel-HeadFootStyles.sty'
  \@AlertNoPDFX % in file `novel-pdfx.sty'
  \@ActivatePDFInfo % in file `novel-pdfx.sty'
  \@ActivateTextMacros % in `novel-TextMacros.sty'
  \@ActivateFootnotes % in `novel-Footnotes.sty'
  \@DisableFontSizes % in file `novel-LayoutSettings.sty'
  \@DisableLayoutSettings % in file `novel-LayoutSettings.sty'
  \@DisableFileDataSettings % in file `novel-FileData.sty'
  \@DisableChapterSceneSettings % in file `novel-ChapterScene.sty'
  \@RedefineBreakpos % in file `novel-ChapterScene.sty'
  \@DisableHeadFootSettings % in file `novel-HeadFootStyles.sty'
  \@GatherGoodImages % in file `novel-Images.sty'.
  % List of always-blocked packages (not exhaustive, since TeX has so many):
  \really@no{geometry}{its own layout commands.}{4}
  \really@no{pdfx}{built-in PDF/X capability.}{3.4}
  \really@no{xmpincl}{built-in PDF/X capability.}{3.4}
  \really@no{hyperxmp}{built-in PDF/X capability.}{3.4}
  \really@no{pdfxmult}{built-in PDF/X capability.}{3.4}
  \really@no{inputenc}{utf-8 encoding always.}{1.2.1}
  \really@no{fontenc}{`fontspec' and utf-8 encoding always.}{1.2.1, 1.2.3}
  \really@no{biblatex}{no bibiography capability.}{1.2.5}
  \really@no{showkeys}{an incompatible layout method.}{1.2.5}
  \really@no{booktabs}{no capability for this, due to printer specs.}{3.4}
  \really@no{pax}{no capability for this, due to printer specs.}{3.4}
  \really@no{bookmark}{focus on paper books, not e-books.}{(top of file)}
  \really@no{endnotes}{limited, built-in endnote methods.}{6.5}
  \really@no{acronym}{focus on paper books, not e-books.}{(top of file)}
  \really@no{embedfile}{incompatible print requirements.}{(top of file)}
  \really@no{makeidx}{an incompatible layout method.}{1.2.5}
  \really@no{gridset}{a command name conflict.}{4}
  % Potential problem packages, allowed in sandbox or with unblock:
  \if@sandbox
    \RequirePackage{novel-Sandbox}
  \else
    \gdef\mplibcode{\@OnlySandbox{mplibcode}}
    % Related to floats:
    \sorry@no{floatflt}
    \sorry@no{floatfig}
    \sorry@no{flafter}
    \sorry@no{float}
    \sorry@no{morefloats}
    \sorry@no{endfloat}
    \sorry@no{placeins}
    % Related to footnotes and endnotes:
    \sorry@no{footmisc}
    \sorry@no{footnote}
    \sorry@no{manyfoot}
    % Related to tables:
    \sorry@no{multirow}
    \sorry@no{tabu}
    \sorry@no{tabularx}
    \sorry@no{tabulary}
    \sorry@no{longtable}
    % Related to lists:
    \sorry@no{array}
    \sorry@no{easylist}
    \sorry@no{listings}
    \sorry@no{numitem}
    \sorry@no{tasks}
    % Related to graphics or layout:
    \sorry@no{pagegrid}
    \sorry@no{subfig}
    \sorry@no{lpic}
    \sorry@no{pinlabel}
    \sorry@no{overpic}
    \sorry@no{caption}
    \sorry@no{sidecap}
    \sorry@no{subcaption}
    \sorry@no{paracol}
    \sorry@no{scrextend}
    \sorry@no{exsheets}
    \sorry@no{eqparbox}
    \sorry@no{colortbl}
    \sorry@no{tikz}
    \sorry@no{pstricks}
    \sorry@no{xypic}
    \sorry@no{xfig}
    \sorry@no{pgfcalendar}
    \sorry@no{pgfpages}
    \sorry@no{pst-pdf}
    \sorry@no{auto-pst-pdf}
    \sorry@no{epstopdf}
    \sorry@no{pdftricks}
    \sorry@no{pdftricks2}
    \sorry@no{mpgraphics}
    \sorry@no{pict2e}
    \sorry@no{picman}
    \sorry@no{scalerel}
    \sorry@no{pmgraph}
    \sorry@no{reflectgraphics}
  \fi % end sandbox.
  % Alert packages, might cause minor layout problems, not enough to block:
  \alert@nodisp{nth}
  \alert@nodisp{engord}
  \alert@nodisp{ulem}
  \alert@nodisp{soul}
  % end list of Alert packages.
  % Package `pagegrid' interacts with `shademargins' and `draft' options:
  \@ifpackageloaded{pagegrid}{ % that is, if permitted by sandbox or unblock
    \ifdraftdoc
      \if@shademargins
        \ClassWarning{novel}{^^JGrid from `pagegrid' is concealed. ^^J%
         Document class option `shademargins' over-writes page grid. ^^J%
         To see the grid, use `draft' but not `shademargins'. ^^J}
      \else\fi
    \else
      \ClassError{novel}{Package `pagegrid' needs `draft' mode}%
       {Package `pagegrid' only with document class option `draft'.}%
    \fi
  }{} % end if pagegrid
}% end \AtBeginDocument
%%


%% AtEndDocument adds one or two blank pages, required by printers.
% Also writes list of inspected, good images to aux, for later use:
\AtEndDocument{%
  \if@coverart\else%
    \if@sandbox\else%
      \immediate\write\@auxout{%
        \string\xdef\string\@AllGoodImages{\@AllGoodImages}^^J%
        \string\xdef\string\@UnknownImages{\@UnknownImages}^^J%
      }%
      \cleartoend% adds 1 or 2 blanks, for final verso blank
    \fi%
  \fi%
}
%%


%% AfterEndDocument writes final message:
\AfterEndDocument{
  \@WarnUnknownImages % in `novel-Images.sty'.
}
%%



%%
%% End of file `novel.cls'