summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex/novel/novel.tex
blob: 2fa6678d9f5ce92c232136ccb1b5a50b83dca6f3 (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
% !TeX program = LuaLaTeX
% !TeX encoding = UTF-8
\documentclass{novel} % v. 1.0.6 or later
% This is the source code for file `novel.pdf'.
\SetTitle{Novel Document Class}
\SetAuthor{Robert Allgeyer}
\SetHeadFootStyle{3}
\SetPDFX[CGATSTR001]{X-1a:2001}

\begin{document}

\begin{ChapterDisplay}[15]
\null
\ChapterTitle{\textbf{NOVEL}}
\null
\ChapterSubtitle{A Document Class for the Rest of Us}
\null\null
\ChapterDeco[4]{\decoglyph{r9554}}
\null
{\centering\emph{It was a dark and stormy night.}\par}
\end{ChapterDisplay}

The \emph{novel\/} document class is for writers of original fiction, to be printed to paper, with particular attention to the requirements of the print-on-demand market.

If your work is an \acronym{E}-book, or uses color other than gray, or is academic writing, then this document class is not for you. Images are supported, but only as they might be used in fiction; so if your work is a picture book, this 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[5em]{1. Features}

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

A new \emph{novel\/} is pre-configured to produce a standard trade book size of 5.5in \acronym{W} x 8.5in \acronym{H}, with layout margins that are likely to be acceptable to the most widely-used print services. The file now 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 \acronym{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 fontspec technology. If you have a professional font that you prefer to the defaults, it will be easy to load and use in utf-8.

Many standard LaTeX commands are disabled. This may surprise you 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 \acronym{PDF/X} technology that exceeds the capabilities currently available via other LaTeX packages.


\QuickChapter[5em]{2. Complete Documentation}

The complete documentation is in \acronym{HTML} format, directly written in \acronym{HTML} rather than extracted from code. There are numerous examples and images, too detailed to be presented as \acronym{PDF}.


\QuickChapter[5em]{3. Project Page}

The \emph{novel} code is hosted by GitHub:

{\centering https://github.com/RobtAll/novel\par}

There, you will find a complete novel (public domain text) in its source code and finished print-ready \acronym{PDF}. There may also be extras that are not part of the LaTeX code.

A predecessor of this document class has actually been used for a commercially marketed print-on-demand novel.


\QuickChapter[5em]{4. License}
 
The LaTeX code, and accompanying documentation, is released under the LateX Project Public License, version 1.3c or later.

The companion font NovelDeco.otf is licensed under the SIL Open Font License, version 1.1.


\QuickChapter[5em]{5. Version}

The initial release of novel via GitHub was on February 20, 2017. Several minor but useful changes were made in the following week.

The first \acronym{CTAN} version was 1.0.5, released February 28, 2017. Based on feedback, version 1.0.5 was upgraded to version 1.0.6 on March 1, 2017, for enhanced compatibility with TeXLive structure.


\QuickChapter[5em]{6. Contact}

If you find any bugs, and have a GitHub account, please raise an issue on the project page. Otherwise, the author's e-mail address is shown near the top of the novel.cls file, located in (your TeX distro)/tex/lualatex/novel directory.

\end{document}