summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/novel/doc/novel.tex
blob: fec858cab63d63701823d2229023c2f22c50cfaf (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
% !TeX TS-program = lualatex
% !TeX encoding = UTF-8
%
% SOURCE CODE FOR FILE novel.pdf, the cover info for novel document class.
% IF YOU COMPILE THIS DOCUMENT: Be sure that both this file and
%   novel.pdf (if present) have read/write permissions for any user.
%   Otherwise, compile may fail at the point where files are written.
\documentclass{novel} % v. 1.81a.
% Almost all settings are defaults.
\SetHeadFootStyle{3}
\SetTitle{Novel Document Class} % only footer, with page number
% The following PDF/X standard is typical for USA print-on-demand.
% However, not every P.O.D. service needs PDF/X these days.
\SetPDFX[CGATSTR001]{X-1a:2001}
\begin{document}
\begin{ChapterStart}[8]
\vspace{\nbs} % \nbs is normal baselineskip
\ChapterTitle{NOVEL}
\vspace{\nbs}
\ChapterSubtitle{A Document Class for the Rest of Us}
\centering{Also consider the simpler \textit{novelette} document class.\par}
\ChapterDeco[4]{\decoglyph{n9548}}
\end{ChapterStart}

\textbf{Where is the documentation??} It is in HTML format, and cannot be retrieved via  \textit{texdoc}. If you have this package installed, look for (texroot)/doc/lualatex/novel/novel-documentation.html. If you are online, go to the CTAN page at https://ctan.org/pkg/novel and click ``Package Documentation (HTML).''

\scenebreak

\textbf{Description:} The \emph{novel} document class is for writers of original fiction, to be printed to paper, with attention to the requirements of the print-on-demand market. Non-color interiors and color covers are supported. Images are supported, but only as they might be used in fiction, not picture books.

If your work is an E-book, or uses interior color other than gray, or is academic, then this document class is not for you. 

But if you are writing a detective novel, or science fiction, or a collection of short stories, then read on!

\QuickChapter{1. Features}

Throughout, it is assumed that the purpose of your writing is a commercially printed book of fiction.

A new \emph{novel} is pre-configured to produce a standard trade book size of 5.5in W x 8.5in H, with layout margins that are likely to be acceptable to the most widely-used print services. The file you are now reading is in this format. But if that is not the size or layout you want, then there are commands that configure just about anything, using standard terminology and understandable purpose. Best of all, the HTML documentation comes with images and examples, so you know what you are doing.

Almost everything is pre-configured to “just work,” even the choice of fonts. The chosen compiler is LuaLaTeX, and Open Type fonts are loaded using \textit{fontspec} technology. If you prefer to use a professional font, it will be easy to load and use in utf-8.

Many standard LaTeX commands are disabled. This will be surprising at first. But \emph{novel} is focused on one thing only. Anything that might interfere with that purpose may have been tossed aside. So, be sure that you read the documentation! If you take an existing LaTeX document and just change the class to \emph{novel,} it is very unlikely to work as expected.

Many new commands are provided. They are focused on the needs of print fiction writers, period. And, \emph{novel} has built-in PDF/X technology that exceeds the capabilities currently available via other LaTeX packages.

\QuickChapter{2. Complete Documentation}

What you are reading now, is only an introduction. The complete documentation is in HTML format, directly written in HTML rather than extracted from code. There are numerous examples and images, too detailed to be presented as PDF.

\QuickChapter{3. License}

The LaTeX code, and accompanying documentation, is released under the LateX Project Public License, version 1.3c or later.

The companion font(s) is(are) licensed under the SIL Open Font License, version 1.1.



\QuickChapter{4. Version}

\noindent 1.81, 2023-03-25: Bug fixes. Also 1.81a.

\noindent 1.80, 2023-02-08: Class option ``rev'' for new documents.

\noindent 1.52, 2018-04-26: Enhanced detection and warning using Lua code.

\noindent 1.50.5, 2018-04-11: Minor bug fixes (docs and code disagreed).

\noindent 1.50, 2018-03-28: Improved image handling commands, sandbox.

\noindent 1.1, 2017-03-01: initial public release.

\clearpage

\QuickChapter{5. FAQs}

\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{Q. }Can this document class be used for E-books?
\end{adjustwidth}
\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{A. }No. And, that feature will never be added, as the technology is inherently incompatible. A word processor is your friend.
\end{adjustwidth}

\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{Q. }What happened to floats and lists?
\end{adjustwidth}
\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{A. }Use the new image commands, or sandbox mode.
\end{adjustwidth}

\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{Q. }My thesis advisor told me---
\end{adjustwidth}
\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{A. }Stop right there. This document class is very different from anything used for theses and other academic publications.
\end{adjustwidth}

\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{Q. }If I use TikZ for Feynman diagrams, then---
\end{adjustwidth}
\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{A. }Go away.
\end{adjustwidth}

\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{Q. }Has this document class ever been used for an actual novel?
\end{adjustwidth}
\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{A. }Yes indeed! In August 2017 the author published a complete novel, including its cover, using this document class. Almost all of the setup used defaults. The files (textblock and cover) were submitted to a major American P.O.D. service in \lnum{PDF/X-1a:2001} format, then electronically reviewed and accepted \textit{on the first attempt.} A printed copy was in the author's hands within a week. Just like that. Took months to write, of course.\par
Update: Several other authors report success.
\end{adjustwidth}

\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{Q. }When I woke up this morning, my head felt like a toddler had been pounding it in a sandbox. I rolled over and looked at the mug shot on the wall. It was a woman in her forties with a drug habit that was bad, and an attitude that was even worse. She had seen better days, like the time I took her to the eighth grade sock hop. Then I got up, washed, and dragged my lonely butt down to the one-man detective agency that I jokingly called my means of living. You know what I mean?
\end{adjustwidth}
\begin{adjustwidth}{\parindent}{0pt}
\backindent\makebox[\parindent][l]{A. }Yeah. Stick with me, kid. This document class is for you.
\end{adjustwidth}

\end{document}