diff options
35 files changed, 636 insertions, 360 deletions
diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/acknow.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/acknow.png Binary files differnew file mode 100644 index 00000000000..f92b80cac84 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/acknow.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/blakemilt.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/blakemilt.png Binary files differnew file mode 100644 index 00000000000..bd884ec3a14 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/blakemilt.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/blfr.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/blfr.png Binary files differnew file mode 100644 index 00000000000..f59d233e1f8 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/blfr.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/chapst.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/chapst.png Binary files differnew file mode 100644 index 00000000000..87a8b78ce6c --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/chapst.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/coprbot.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/coprbot.png Binary files differnew file mode 100644 index 00000000000..81ee161dcd8 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/coprbot.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/coprcen.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/coprcen.png Binary files differnew file mode 100644 index 00000000000..d46567546d2 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/coprcen.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/dedic.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/dedic.png Binary files differnew file mode 100644 index 00000000000..c2435ca8a68 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/dedic.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/dfi.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/dfi.png Binary files differnew file mode 100644 index 00000000000..de707e69c82 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/dfi.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/dorfmcnorf.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/dorfmcnorf.png Binary files differnew file mode 100644 index 00000000000..643112ad43d --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/dorfmcnorf.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/epibjorn.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/epibjorn.png Binary files differnew file mode 100644 index 00000000000..30e7d219d05 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/epibjorn.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/epigraph.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/epigraph.png Binary files differdeleted file mode 100644 index 74911c76afd..00000000000 --- a/Master/texmf-dist/doc/lualatex/novel/html-resources/epigraph.png +++ /dev/null diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/epigrcom.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/epigrcom.png Binary files differnew file mode 100644 index 00000000000..4d436a5c018 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/epigrcom.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/htgb.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/htgb.png Binary files differnew file mode 100644 index 00000000000..0e5704e31a9 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/htgb.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/htss.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/htss.png Binary files differnew file mode 100644 index 00000000000..68f59630904 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/htss.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/novel-doc.css b/Master/texmf-dist/doc/lualatex/novel/html-resources/novel-doc.css index 03e4e6911e9..7971004d93f 100644 --- a/Master/texmf-dist/doc/lualatex/novel/html-resources/novel-doc.css +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/novel-doc.css @@ -35,6 +35,8 @@ div.pagetopage p {text-indent:0px; margin:4px;} p {font-family:serif;} pre, code {font-family:monospace,monospace; font-size:1em;} p, pre {margin: 0px 16px 0px 16px; text-indent: 16px;} +p.h5 {text-indent:0px; margin-top:1em; clear:both;} +p.h5 b {font-family:sans-serif; font-weight:bold;} *.technote {font-weight:normal; color:#333333; margin-bottom:6px;} *.technote img {position:relative; top:4px;} *.noindent {text-indent:0px;} @@ -59,6 +61,9 @@ table.preconf tfoot td {border-top:1px solid #000000;} table.preconf p {text-indent:0px; margin:6px;} *.onedown {font-size:smaller} *.menuitem {text-indent:-8px; margin-left:24px; margin-top:0px; margin-bottom:0px;} +small {line-height:50%;} +span.ap {color: #996633;} /* percent comment in code */ +span.apdk {color: #502000;} span.flat { font-family: "Lucida Sans Unicode", "DejaVu Sans", "Lucida Grande", "Helvetica Neue", sans-serif; color:#00cc00; diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/partsep.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/partsep.png Binary files differnew file mode 100644 index 00000000000..dc0767433ef --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/partsep.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/preface.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/preface.png Binary files differnew file mode 100644 index 00000000000..58f6324be9f --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/preface.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/scenebreaks.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/scenebreaks.png Binary files differindex 078a9b1735a..0622b6a8290 100644 --- a/Master/texmf-dist/doc/lualatex/novel/html-resources/scenebreaks.png +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/scenebreaks.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/starsmash.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/starsmash.png Binary files differnew file mode 100644 index 00000000000..75496391cd1 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/starsmash.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/toc.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/toc.png Binary files differindex 3293d7a739b..75b158b8332 100644 --- a/Master/texmf-dist/doc/lualatex/novel/html-resources/toc.png +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/toc.png diff --git a/Master/texmf-dist/doc/lualatex/novel/novel.tex b/Master/texmf-dist/doc/lualatex/novel/novel.tex deleted file mode 100644 index 080e85cae45..00000000000 --- a/Master/texmf-dist/doc/lualatex/novel/novel.tex +++ /dev/null @@ -1,78 +0,0 @@ -% !TeX program = LuaLaTeX -% !TeX encoding = UTF-8 -\documentclass{novel} % v. 1.0.7 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}[16] -\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. Users should upgrade to the latest version, 1.0.7 or later. - - -\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} - diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html index d2c02dc4fd1..9b8eb5d5ea7 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html @@ -150,7 +150,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-02-class-options.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-02-class-options.html index de784b41041..aba89722db6 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-02-class-options.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-02-class-options.html @@ -50,7 +50,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-03-metadata-pdfx.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-03-metadata-pdfx.html index 7bb07b9ed09..81a494a90d9 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-03-metadata-pdfx.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-03-metadata-pdfx.html @@ -71,7 +71,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> <a id="a3"></a> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-04-layout.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-04-layout.html index cf9927ccf40..2b276446e6c 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-04-layout.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-04-layout.html @@ -78,7 +78,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-05-fonts.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-05-fonts.html index 04aa01ad739..4093a12f802 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-05-fonts.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-05-fonts.html @@ -78,7 +78,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> <a id="a5"></a> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-06-header-footer.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-06-header-footer.html index 0c0299956f1..3e3d6ea9a07 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-06-header-footer.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-06-header-footer.html @@ -62,7 +62,9 @@ <p>6. Headers, Footers<br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-07-text-size-style.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-07-text-size-style.html index c1301dc4bd0..b9e2f6198f3 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-07-text-size-style.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-07-text-size-style.html @@ -70,7 +70,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p>7. Text Sizes, Styles</p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-08-images.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-08-images.html index 58990ae95aa..681a603cce9 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-08-images.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-08-images.html @@ -60,7 +60,9 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p>8. Using Images</p> -<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p> +<p><a href="noveldocs-09-chapters-displays.html">9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</a></p> </div> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-09-chapters-displays.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-09-chapters-displays.html index ba1e45e0f82..96cb3aa35ea 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-09-chapters-displays.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-09-chapters-displays.html @@ -2,7 +2,7 @@ <html lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"/> -<title>Class novel - 9 - Special Layouts</title> +<title>Novel class documentation - Display, Start, Continued Pages, Footnotes, Endnotes</title> <link rel="stylesheet" type="text/css" href="html-resources/novel-doc.css"/> </head> @@ -14,55 +14,94 @@ <p>Document class "novel"</p> -<p><a href="#a9">9. Special Layouts</a></p> +<p><a href="#a9">Display, Start, and Continued Pages;<br/> +Footnotes and Endnotes</a></p> <ul> - <li><a href="#a9.1">9.1 Copyright Page</a> + + <li><a href="#a9.1">9.1 Display Pages</a><br/> + <span style="visibility:hidden">9.1 </span> including blank <ul> - <li><a href="#a9.1.1">9.1.1 Useful Commands</a></li> + <li><a href="#a9.1.1">9.1.1 Half-Title</a></li> + <li><a href="#a9.1.2">9.1.2 Frontispiece</a></li> + <li><a href="#a9.1.3">9.1.3 Title Page</a></li> + <li><a href="#a9.1.4">9.1.4 Copyright Page</a></li> + <li><a href="#a9.1.5">9.1.5 Other Display Pages</a> + <ul> + <li><a href="#a9.1.5.1">9.1.5.1 Dedication</a></li> + <li><a href="#a9.1.5.2">9.1.5.2 Epigraph</a></li> + <li><a href="#a9.1.5.3">9.1.5.3 Table of Contents</a></li> + <li><a href="#a9.1.5.4">9.1.5.4 Part Separator</a></li> + <li><a href="#a9.1.5.5">9.1.5.5 Map or Illustration</a></li> + </ul> + </li> </ul> </li><!-- end 9.1 --> - <li><a href="#a9.2">9.2 Epigraph or Dedication</a> + + <li><a href="#a9.2">9.2 Start Pages: General</a> <ul> - <li><a href="#a9.2.1">9.2.1 Available Methods</a></li> - <li><a href="#a9.2.2">9.2.2 Example of Epigraph</a></li> + <li><a href="#a9.2.1">9.2.1 \thispagestyle{}</a></li> + <li><a href="#a9.2.2">9.2.2 \SetVersoHeadText{}<br/> + <span style="visibility:hidden">9.2.2 </span>\SetRectoHeadText{}</a> + </li> </ul> </li><!-- end 9.2 --> - <li><a href="#a9.3">9.3 Table of Contents</a> + + <li><a href="#a9.3">9.3 Start Pages in Front Matter</a><br/> + <span style="visibility:hidden">9.3 </span>Foreword, Preface, etc. + </li><!-- end 9.3 --> + + <li><a href="#a9.4">9.4 Start Pages in Main Matter</a><br/> + <span style="visibility:hidden">9.3 </span>New Chapters <ul> - <li><a href="#a9.3.1">9.3.1 Environment: toc</a></li> - <li><a href="#a9.3.2">9.3.2 \tocitem[]{}{}</a></li> - <li><a href="#a9.3.3">9.3.3 Example Table of Contents</a></li> + <li><a href="#a9.4.1">9.4.1 \SetChapterStart{}</a></li> + <li><a href="#a9.4.2">9.4.2 Environment: ChapterStart</a></li> + + <li><a href="#a9.4.3">9.4.3 Chapter Title Commands</a> + <ul> + <li><a href="#a9.4.3.1">9.4.3.1 \ChapterTitle{}</a></li> + <li><a href="#a9.4.3.2">9.4.3.2 \ChapterSubtitle{}</a></li> + <li><a href="#a9.4.3.3">9.4.3.3 \ChapterDeco[]{}</a></li> + </ul> + </li> + <li><a href="#a9.4.4">9.4.4 ChapterStart With Image</a> + <ul> + <li><a href="#a9.4.4.1">9.4.4.1 Text Over Image</a></li> + <li><a href="#a9.4.4.2">9.4.4.2 Image Includes Text</a></li> + </ul> + </li> </ul> - </li><!-- end 9.3 --> - <li><a href="#a9.4">9.4 Foreword, Preface, etc.</a></li> - <li><a href="#a9.5">9.5 New Chapters</a> + </li><!-- end 9.4 --> + + <li><a href="#a9.5">9.5 Continued Pages</a><br/> <ul> - <li><a href="#a9.5.1">9.5.1 Environment: ChapterDisplay</a></li> - <li><a href="#a9.5.2">9.5.2 Commands for Chapter Titles</a></li> - <li><a href="#a9.5.3">9.5.3 ChapterDisplay with Image</a></li> - <li><a href="#a9.5.4">9.5.4 \QuickChapter[]{}</a></li> + <li><a href="#a9.5.1">9.5.1 \QuickChapter[]{}</a></li> + <li><a href="#a9.5.2">9.5.2 Scene Breaks</a> + <ul> + <li><a href="#a9.5.2.1">9.5.2.1 \scenebreak</a></li> + <li><a href="#a9.5.2.2">9.5.2.2 \sceneline</a></li> + <li><a href="#a9.5.2.3">9.5.2.3 \scenestars</a></li> + </ul> + </li> + <li><a href="#a9.5.3">9.5.3 \IndentAfterScenebreak</a> </ul> </li><!-- end 9.5 --> - <li><a href="#a9.6">9.6 Scene Breaks</a> + + <li><a href="#a9.6">9.6 Footnotes</a> <ul> - <li><a href="#a9.6.1">9.6.1 \scenebreak \sceneline \scenestars</a></li> - <li><a href="#a9.6.2">9.6.2 \IndentAfterScenebreak</a></li> + <li><a href="#a9.6.1">9.6.1 \SetMarkers[]{}</a></li> + <li><a href="#a9.6.2">9.6.2 \realmarker \fakemarker</li> + <li><a href="#a9.6.3">9.6.3 \footnote[]{}</li> </ul> </li><!-- end 9.6 --> - <li><a href="#a9.7">9.7 Footnotes</a> + + <li><a href="#a9.7">9.7 Endnotes</a> <ul> - <li><a href="#a9.7.1">9.7.1 \SetMarkers[]{}</a></li> - <li><a href="#a9.7.2">9.7.2 \realmarker \fakemarker</a></li> - <li><a href="#a9.7.3">9.7.3 \footnote[]{}</a></li> + <li><a href="#a9.7.1">9.7.1 \endnote</a></li> + <li><a href="#a9.7.2">9.7.2 \endnotetext{}{}</li> </ul> </li><!-- end 9.7 --> - <li><a href="#a9.8">9.8 Endnotes</a> - <ul> - <li><a href="#a9.8.1">9.8.1 \endnote</a></li> - <li><a href="#a9.8.2">9.8.2 \endnotetext{}{}</a></li> - </ul> - </li><!-- end 9.8 --> + </ul> <p> </p> @@ -71,9 +110,9 @@ <div id="main"> -<a id="thetop"></a> +<a id="a9"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.0.7.</p> +<p>Documentation version: 1.0.8.</p> <div class="pagetopage"> @@ -86,187 +125,347 @@ <p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/> <p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p> <p><a href="noveldocs-08-images.html">8. Using Images</a></p> -<p>9. Chapters, Display Pages</p> +<p>9. Display, Start Pages;<br/> +<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/> +<span style="visibility:hidden">9. </span>Footnotes, Endotes.</p> </div> -<a id="a9"></a> -<h2 style="clear:none">9. Special Layouts</h2> -<p>In this part of the documentation, I will discusss a variety of special layout situations: Copyright Page, Dedication/Epigraph, Table of Contents, Chapter Displays (new chapters), Scenes, Footnotes, and Endnotes. What these have in common is that they are not continuous flowing text, and are not part of the overall layout dimensions.</p> +<h2 style="clear:none">Display, Start, and Continued Pages;<br/> +Footnotes and Endnotes</h2> -<p>In many cases, you will need to manually insert a page break using <code>\clearpage</code> or <code>\clearpage</code>. This is not built into the various commands that are used after a page break.</p> +<p>A <em>display page</em> stands by itself, has a unique purpose, and is never continued to another page. A blank page is considered to be a display, even when there are several blanks.</p> -<p>If you need a blank page, here is how:</p> +<p>A <em>start page</em> is the first page of a continued section of related pages, with the same style and purpose. The important criterion is whether the section "might" continue to additional pages, not whether it actually does. Thus, a very brief Author's Note (essentially a one-page Preface) is considered to be a start page, because the author might have gone on for several pages.</p> -<p class="code"><code>\clearpage\thispagestyle{empty}\null\clearpage</code></p> +<p>Anything other than a display page or a start page is a <em>continued page</em>.</p> -<p>TeX is smart enough to know that if you issue two consecutive <code>\clearpage</code> instructions, without at least a <code>\null</code> command to occupy the blank page, then you did not really intend to skip a page.</p> -<p>It is often the case that display pages provoke an "Underfull \vbox (badness 10000)" message in the log file, due to the break in continuous text flow. In most (probably all) cases, this message may be ignored.</p> -<p>In fiction, the book title page is often very stylish. A good one cannot be constructed by automatically placing information such as title and author. For that reason, <code>novel</code> has no commands such as <code>\maketitle</code>. You will probably want to use stylish fonts, and images, perhaps even using an image for the entire title page. The methods for using new fonts are described on <a href="noveldocs-05-fonts.html#a5.3.3">Page 5</a>. Techniques for images are described on <a href="noveldocs-08-images.html">Page 8</a>.</p> +<a id="a9.1"></a> +<h3>9.1 Display Pages</h3> -<p>If your book is self-published, which is normally the case for print-on-demand, remember that <em>you</em> are the publisher, not the service that prints and distributes your book. You cannot use their name or logo in circumstances that might imply that they are the publisher.</p> +<p>In the book's front matter, many (perhaps all) of the pages are display pages. In fictional works, once the main matter begins, the only display pages (if any) will be part separators, maps, and blank pages.</p> +<p>Display pages do not show a header or footer. At the top of the page, put this code:</p> +<p class="code"><code>\thispagestyle{empty}</code></p> -<a id="a9.1"></a> -<h3>9.1 Copyright Page</h3> +<p>Note that the header and/or footer is still there, and occupies its usual space. But it has no visible content. The page number does not appear in print, However, it is visible in the control panel of a PDF reader.</p> -<p>The copyright page is always the verso of the full title page. In books that begin with a half-title, blank, full title, the copyright page will be lowercase roman numeral <code>iv</code>. If your book begins directly with its full title page (uncommon), then the copyright page will be <code>ii</code>. In al cases, use <code>\thispagestyle{empty}</code> so that no header or footer prints on the copyright page. Thus, the page number will not appear in print (but you can see it in a PDF reader).</p> +<p>Blank pages are considered to be display pages. Te create a blank page:</p> -<p>In <code>novel</code> there are several commands that are well-suited to the copyright page. But before I discuss them: Since you are using Unicode, just paste the copyright symbol © from a character map. No TeX code required.</p> +<p class="code"><code>\clearpage \thispagestyle{empty} \null \clearpage</code></p> -<p>• The copyright page should have a different look from pages of the story. This may involve slightly smaller font size, or different margins. It usually involves pushing the text downward so that the unused space is at the top, rather than at the bottom. Your text will usually not be justified, but may be ragged-left, centered, or (very rarely) ragged-right. Words will not be hyphenated. It is <em>not</em> customary to use a different font or font weight. Paragraphs will not usually be indented, but will be separated by blank lines. Small Caps may be used for occasional emphasis.</p> +<p>If the preceding material ended with <code>\clearpage</code> or the following material begins with it, no problem. TeX wisely assumes that consecutive <code>\clearpage</code> commands are a mistake, and does not automatically skip a page between them. The <code>\null</code> command is the most effective way to show that you really did mean to create a page there.</p> -<p>• If your book has Cataloging-in-Publication data (used by libraries), it may be prepared for you by someone using a word processor. Where you see two hyphens, it is supposed to be an <em>em dash</em>, which is <em>three</em> hyphens in TeX, rather than the two of MS Word.</p> +<p>A novel, or collection of stories, may contain these display pages: Half-Title, Frontispiece, Title, Copyright, Dedication, Epigraph, Map, Acknowledgements, Separator.</p> -<p>• Under no circumstances should you use "copyleft" or anything other than full Copyright ©year Your Name, All Rights Reserved. That, plus utter damnation to anyone who violates the copyright. Reason: Why should anyone take the trouble to prepare and distribute your book, even if you are paying for it, when someone else can legally do it cheaper? The demonstration file that comes with this documentation does not have a full copyright, but that is only because it is <em>not a real book.</em></p> -<p>Now for some code:</p> +<a id="a9.1.1"></a> +<h4>9.1.1 Half-Title Page</h4> +<p>Historically, the purpose of a Half-Title was to protect the title page during transportation and storage. This purpose has been obsolete for a long time, bcause modern books are printed and bound at once. But the tradition lives on. Use a Half-Title unless you absolutely must reduce the page count of your book.</p> -<a id="a9.1.1"></a> -<h4>9.1.1 Useful Commands for Copyright Page</h4> +<p>The Half-Title is the first page of front matter. It is lowercase roman page <cide>i</code>, even though the number is not printed. The only material on the page is the book's title (not author) and usually not even a subtitle. If the title is artistically designed, then the Half-Title may be designed the same way, but is usually at smaller size. Place the Half-Title wherever it looks good on the page (certainly not at top left). For example:</p> -<p>These commands are not specific to copyright. They address a number of common situations encountered on that page.</p> +<p class="code"><code><img class="floatright" src="html-resources/htss.png" width="174" height="269" alt="sample half title"/> +<small>\frontmatter <span class="ap">% Sets page numbers to lowercase roman.</span><br/> +\thispagestyle{empty} <span class="ap">% No header or footer.</span><br/> +\vspace*{6\nbs} <span class="ap">% Note asterisk. Skips 6 lines.</span><br/> +<span class="ap">% Right-aligns half-title at 2x normal font size:</span><br/> + <span class="ap">% \orbitron is defined as the non-TeX font Orbitron-Medium.otf</span><br/> +\stake\hfill{\orbitron\charscale[2]{Star Smash}}\par +\vspace{0.4\nbs} +<span class="ap">% Decorative portion of half-title:</span><br/> +\noindent\hspace{12em}\charscale[1.6]{\decoglyph{r10059}} +\bigemdash[2,2]\stake\par +\clearpage <span class="ap">% Ends the page.</span> +</small></code></p> -<pre> -<b>\begin{adjustwidth}{<em>left</em>}{<em>right</em>} <em>...</em> \end{adjustwidth}</b></pre> +<p>You can do better than that, perhaps by using a fancier font than you use for ordinary text, or even by placing the Half-Title in the form of an image.</p> -<p>From the <code>changepage</code> package (included with <code>novel</code>), the <code>adjustwidth</code> environment allows you to increase the left and/or right margins by the indicated lengths. Use units of <code>em</code> or <code>\parindent</code> or <code>\textwidth</code> rather than points or inches. The environment can span pages, although a copyright page is rarely as much as a full page.</p> -<p class="code"><code>\begin{adjustwidth}{0em}{0.2\textwidth}<br/> -Copyright ©2017 Dirk Hardcase. All Rights Reserved.<br/> -... % and many other lines<br/> -\end{adjustwidth} -</code></p> +<a id="a9.1.2"></a> +<h4 style="clear:both">9.1.2 Frontispiece (usually blank)</h4> + +<p><img class="floatright" src="html-resources/blakemilt.png" width="200" height="309" alt="sample artwork frontispiece" title="Frontispiece to William Blake's poem about Milton. Public Domain in U.S.A. and artist's home nation. Source Library of Congress via Wikimedia Commons."/> The verso of the Half-Title has page number <code>ii</code>, number not printed. Normally, this page is blank.</p> -<p>The above code places its text so that it remains at the usual left margin, but only occupies 80% of the normal textwidth. Remember that the copyright page is always verso (on the left side of the open book).</p> +<p>In the good old days (looong ago), this page might show an illustration. Search the Internet for "frontispiece" to see examples. At right is the frontispiece by William Blake for his poetry regarding Milton. In the original, it was in color (spectacularly expensive, back then).</p> +<p>If your Aunt Sally is a brilliant, internationally-known illustrator, and permits you (in writing, without royalties) to place one of her creations there, then that is a possibility. You might also use a photograph (reduced to grayscale), if your story is set in a real location. However, depending on location and jurisdiction, just because something is in plain public view does not necessary mean that you are free to take a photograph and use it commercially! That may even apply when it is a natural scene with no people in the picture. Here's a famous <a href="http://www.nytimes.com/1990/08/02/us/monterey-journal-trees-and-trademarks-the-disputes-run-deep.html" rel="external" target="new">example</a>, not too far from where I live.</p> -<pre> -<b>\begin{legalese} <em>...</em> \end{legalese}</b></pre> +<p>Something that is an integral part of the story, such as a map of its fictional locale, should not be placed as a frontispiece. Actually, with fiction you have a lot of wiggle room, so a map is possible <em>if</em> its artwork is good enough to face the title page, and you don't have a better place to put the map.</p> -<p>Although the <code>legalese</code> environment can be used for any purpose, it is most suited to ... legalese language, such as on a copyright page.</p> +<p>The preparation and placement of images is described on another documentation page.</p> -<p>The included text will be set ragged-right, without hyphenation.</p> +<p class="clear:both"><img class="floatright" style="margin-top:40px" src="html-resources/blfr.png" width="134" height="207" alt="sample blank frontispiece"/> Some publishers put a centered list of “Books by the Same Author” here. Or, if the particular book is part of a set (“Splork Chronicles, Volume VI”) that can be mentioned. However, in the print-on-demand market, your printing and distribution service may not permit you to do that, unless they carry all of the books.</p> +<p>So, it is best to leave this page blank:</p> + +<p class="code"><code><small>\clearpage<br/> +\thispagestyle{empty}<br/> +\null<br/> +\clearpage</small></code></p> -<pre> -<b>\begin{center} <em>...</em> \end{center} <em>and</em> {\centering <em>...</em> \par}</b></pre> -<p>When used with a reduced-width textblock (<code>adjustwidth</code>), a centered copyright page can be attractive. I often see it. Something like this, which centers its text at 60% of the textblock width:</p> +<a id="a9.1.3"></a> +<h4 style="clear:both">9.1.3 Title Page</h4> + +<p>The Title Page has page number <code>iii</code>, number not printed.</p> + +<p>With <code>novel</code>, there is no automatic construction of a Title Page, because its original artistic design is important. Nothing says “this book was written by someone who normally writes term papers instead of fiction” more than a Title Page that looks like it belongs on a term paper. Don't be afraid to use stylish fonts that differ from whatever you are using for the main text, or create the title as an image.</p> + +<p>If you wish to use gray text, you will need the <code>graytext</code> class option. Without it, text will always be black. But don't use the option unless you really need gray text somewhere in your book. Grayscale images will be grayscale, whether or not you choose this option:</p> + +<p class="code"><code>\documentclass[graytext]{novel} <span class="ap">% do not use graytext unless needed</span></code></p> + +<p>Here are some commands that may be helpful for building your Title Page:</p> <p class="code"><code> -\begin{adjustwidth}{0.2\textwidth}{0.2\textwidth}<br/> +\thispagestyle{empty} <span class="ap">% no header or footer</span><br/> +\vspace*{<em>length</em>} <span class="ap">% puts space at top</span><br/> +\charscale[<em>scale, position</em>]{<em>text</em>} <span class="ap">% changes text size and position</span><br/> +{\centering <em>one line of text</em>\par} <span class="ap">% centers text</span><br/> +\stake\hfill <em>text</em>\par <span class="ap">% pushes text to right</span><br/> +\InlineImage[<em>options</em>]{<em>file</em>} <span class="ap">% see separate docs page</span><br/> +\BlockImage[<em>options</em>]{<em>file</em>} <span class="ap">% see separate docs page</span><br/> +\vfill <span class="ap">% pushes following text to bottom of textblock</span> +</code></p> + +<p>Below is a sample Title Page. The <code>\orbitron</code> command calls for the font Orbitron-Medium.otf, which is not part of the TeX distribution. The <code>\decoglyph</code> command calls fo a decorative element from the NovelDeco.otf font, which comes with the <code>novel</code> class. The length <code>\nbs</code> is the normal baseline skip of the book's main font. The <code>\stake</code> commands place an invisible zero-width reference point, for the use of adjacent commands. Here is the code:</p> + + +<p class="code"><img class="floatright" src="html-resources/starsmash.png" width="263" height="410" alt="sample title page"/> +<code><small> +\clearpage<br/> +\thispagestyle{empty}<br/> +\vspace*{6\nbs}<br/> +\stake\hfill{\orbitron\charscale[3]{Star Smash}}\par<br/> +\vspace{0.4\nbs}<br/> +\noindent\charscale[3]{\decoglyph{r10059}}<br/> +\bigemdash[3.4,3]\stake\par<br/> +\vspace{0.4\nbs}<br/> +\stake\hfill{\orbitron\charscale[1.42]{A Sci-Fi Murder Mystery}}\par<br/> +\vspace{9\nbs}<br/> \begin{center}<br/> -Copyright ©2017 Dirk Hardcase. All Rights Reserved.<br/> -... % and many other lines<br/> +\charscale[4]{Dirk Hardcase}<br/> +\vfill<br/> +Meaningless Press\par<br/> +Eschwege • Merthyr Tydfil • Lethbridge\par<br/> \end{center}<br/> -\end{adjustwidth} -</code></p> +\clearpage +</small></code></p> -<p>The <code>center</code> environment may be used on the copyright page, where deviations from the baseline grid are acceptable. But do not use <code>center</code> in your main text, as there will often be a noticeable disruption of vertical alignment. You may use the <code>{\centering ... \par}</code> command anywhere, but it can only include one paragraph at a time.</p> +<p style="clear:both">Remember that you can also use black-and-white line art, or a grayscale image. You may find it easier to design all or part of your Title Page in a graphics program, export as <code>png</code> or <code>jpg</code>, and place the image. Be sure to read how this must be done in <code>novel</code> class, as the image requirements and commands are different from those used in other document classes.</p> -<pre> -<b>\begin{parascale}[<em>scale</em>] <em>...</em> \end{parascale}</b></pre> +<a id="a9.1.4"></a> +<h4>9.1.4 Copyright Page</h4> -<p>The <code>parascale</code> environment is described in more detail on <a href="noveldocs-07-text-size-style.html#a7.1.3">Page 7</a>.</p> -<p>If your copyright and related data does not quite fit on one page at normal size, then use <code>parascale</code> to shrink it.</p> +<p>The Copyright Page will be page <code>iv</code>, number not printed. It is always the verso if the Title Page.</p> +<p>This page should be styled differently from the main text. Typically, the vertical alignment leaves space at top. The final line may be at the bottom of the textblock. The text may be centered throughout (often used nowadays) or be left-aligned with ragged alignment instead of justification. The text will have one or both side margins increased, so that it does not occupy the full width of the textblock. Lines will not break with hyphenated words. All-uppercase words will be presented in small caps.</p> -<pre> -<b>\lnum{<em>numbers or other text</em>}</b></pre> +<p>If you have a service prepare a Cataloging-in-Print data block for you, the file will show two hyphens to mean an em dash, because that's how word processors do it. In TeX, use three dashes instead.</p> -<p>If your main font uses OldStyle numbers (it probably does), you might prefer Lining numbers for the legalese and other data. The <code>\lnum</code> performs the change. Note that the command only affects the appearance of numbers. Letters are unchanged:</p> +<p>Some commands useful on a Copyright Page:</p> -<p class="code"><img class="floatright" src="html-resources/lnum.png" width="185" height="32" alt="lnum"/><code>367Ag\lnum{367Ag}367Ag</code></p> +<p class="code"><code> +\thispagestyle{empty} <span class="ap">% no header or footer</span><br/> +\vspace*{<em>length</em>} <span class="ap">% creates vertical space</span><br/> +<span class="ap">% legalese: ragged lines, no hyphenation, no indent.</span><br/> +\begin{legalese} ... \end{legalese}<br/> +\begin{adjustwidth}{<em>left</em>}{<em>right</em>} ... \end{adjustwidth} <span class="ap">% reduces width</span><br/> +\begin{center} ... \end{center} <span class="ap">% if desired</span><br/> +\begin{parascale} ... \end{parascale} <span class="ap">% shrinks text</span><br/> +\itshape{<em>text</em>} <span class="ap">% italics, and can span paragraphs</span><br/> +\textsc{<em>text</em>} <span class="ap">% lowercase to small caps (uppercase still uppercase)</span><br/> +\allsmcp{<em>text</em>} <span class="ap">% uppercase and lowercase to small caps</span><br/> +\acronym{<em>text</em>} <span class="ap">% uppercase to medium caps</span><br/> +\lnum{<em>number</em>} <span class="ap">% lining numbers instead of old style</span><br/> +\_ <span class="ap">% when underscore is in a URL</span><br/> +\% <span class="ap">% when % is in a URL</span><br/> +\& <span class="ap">% when & is in a URL</span><br/> +</code></p> +<p>You normally do not need to write a lot of things on a Copyright Page. But if your novel has a lot of real-world material, some of it may require acknowledgements and permissions. They may be placed on the Copyright Page. If everything almost fits, but not quite, you can shrink it using the <code>parascale</code> environment. However, do not shrink it too much, and don't fill the whole page like it was ordinary story text. When you have a lot of acknowledgements and permissions, move them to a separate section. If your book has a Preface (uncommon in fiction), perhaps put them there. Or, create a separate Acknowledgements section (also uncommon in fiction).</p> -<a id="a9.2"></a> -<h3>9.2 Epigraph or Dedication</h3> +<p>Here is a sample abbreviated Copyright Page, centered style. Note that in the image, the text is displaced slightly to the left, because this is a verso page, and the right margin includes an allowance for gutter.</p> -<p>If you use a Dedication, it must go on the recto page immediately following the copyright page, regardless of whether or not your frontmatter has any other content. The only exception is when the book is a critical edition of someone else's work, where the original author's dedication is delayed to near the end of the frontmatter.</p> +<p class="code"><img class="floatright" style="padding-top:2em" src="html-resources/coprcen.png" width="265" height="406" alt="sample copyright page"/> +<code><small> +\clearpage<br/> +\thispagestyle{empty}<br/> +\vspace*{5\nbs}<br/> +\begin{center}<br/> +\itshape{<br/> +Copyright ©2017 Dirk Hardcase.\\<br/> +All Rights Reserved.\par<br/> +\null<br/> +This is a work of fiction.\\<br/> +All persons and events are imaginary.\\<br/> +Resemblance to any real persons or events\\<br/> +is entirely coincidental.\par<br/> +\null<br/> +Printed in the United States of America\\<br/> +on acid-free paper.\par<br/> +\null<br/> +\allsmcp{FIRST EDITION}, March 2017.\par<br/> +\null<br/> +\allsmcp{ISBN} 9-876-54321-0\par<br/> +\null<br/> +Published by Dirk Hardcase,\\<br/> +Anytown, U.S.A.\par<br/> +\null<br/> +Inquiries for Cataloging-in-Publication data\\<br/> +should be directed to the author's web site:\par<br/> +\null<br/> +http://example.com/bigdealauthor.html\par<br/> +} % end \itshape<br/> +\end{center}<br/> +\clearpage +</small></code></p> -<p>Dedications aren't what they used to be. Nowadays, you can use a web site to dedicate your book to some current flame. Then, when you break up, you edit the web site. You next flame doesn't have to see it in print. There is a certain kind of author who likes to make a silly dedication, but I assume anyone using LaTeX is too sophisticated for that.</p> +<p> </p> -<p>On the other hand, if you are a combat veteran writing about your adventures, most folks would expect something such as "To Our Armed Forces" on a Dedication page. It's up to you.</p> +<p style="clear:both">Sample abbreviated Copyright Page, alternative style. This style is more effective when there are more details, particularly if there is a complete Cataloging-in-Publication data block:</p> + +<p class="code"><img class="floatright" style="padding-top:2em" src="html-resources/coprbot.png" width="266" height="411" alt="sample copyright page"/> +<code><small> +\clearpage<br/> +\thispagestyle{empty}<br/> +\null\vfill<br/> +\begin{adjustwidth}{0em}{8em}<br/> +\begin{legalese}<br/> +Copyright ©2017 Dirk Hardcase.\\<br/> +All Rights Reserved.\par<br/> +\null<br/> +This is a work of fiction.\\<br/> +All persons and events are imaginary.\\<br/> +Resemblance to any real persons or events\\<br/> +is entirely coincidental.\par<br/> +\null<br/> +Printed in the United States of America\\<br/> +on acid-free paper.\par<br/> +\null<br/> +\allsmcp{FIRST EDITION}, March 2017.\par<br/> +\null<br/> +\allsmcp{ISBN} 9-876-54321-0\par<br/> +\null<br/> +Published by Dirk Hardcase,\\<br/> +Anytown, U.S.A.\par<br/> +\null<br/> +Inquiries for Cataloging-in-Publication data\\<br/> +should be directed to the author's web site:\par<br/> +http://example.com/bigdealauthor.html\par<br/> +\end{legalese}<br/> +\end{adjustwidth}<br/> +\clearpage +</small></code></p> -<p>If you do not use a Dedication (best bet), then the recto immediately following the copyright page should be a Table of Contents, if your book has one. This is discussed below. If you don't have a Table of Contents, then the recto immediately following the copyright page might be an Introduction or Preface or some other part of frontmatter (but it is unusual to have these if you don't have a T of C). -<p>It is a bad idea to go directly from copyright at verso to the opening of your story at recto, because the page spread is awkward: Legal notice on the left, fiction on the right. If you have nothing else to put between them, consider an Epigraph recto, followed by blank verso.</p> -<p>An Epigraph is a (usually) a short quotation from someone else's work, with brief attribution. A good Epigraph can be very effective. Unlike a dedication, an epigraph may be placed almost anywhere, recto or verso.</p> -<p>Since a quotation from someone else's work is likely to be copyrighted, you cannot just use it. The safest thing to do is to use a work that is definitely out of copyright, such as the Bible or Shakespeare, or another work from long ago. Keep in mind that a recent translation can be copyrighted, even if the original is not.</p> -<p>An Epigraph may be pretentious, or it may be fun. Look online for the purposes served by an Epigraph, and for many examples from famous and not-so-famous literature.</p> -<p>In some genres, the story will refer to some fictional other book, which contains magical spells or an ancient legend. You can put a (fictional) quote from that book as an Epigraph, whether or not the quotation is used in the story.</p> -<p>You can also place a few lines of your own story, as an Epigraph. Perhaps the most famous example in Twentieth-Century fiction is the poem regarding magic rings, used as an Epigraph for Tolkien's novels on the subject.</p> +<a id="a9.1.5"></a> +<h4>9.1.5 Other Display Pages</h4> -<p>Dedications and Epigraphs use <code>\thispagestyle{empty}</code>.</p> +<p>Most fictional works do not need other display pages. However, it is bad practice to go directly from the Copyright Page (verso) to the start of your story (recto). If you do not know what else to do, have a look at the Epigraph, below.</p> +<a id="a9.1.5.1"></a> +<p class="h5"><b>9.1.5.1 Dedication:</b> A Dedication is not required. But sadly, nowadays many authors write a Dedication, which is often frivolous and detracts from the book. If you feel that you need a Dedication, why not put it on your web site? Then you can always edit or remove it, if the subject or your affection runs off with someone else.</p> -<a id="a9.2.1"></a> -<h4>9.2.1 Available Methods for Styling Dedications and Epigraphs</h4> +<p>If used, a Dedication is normally on page <code>v</code>, immediately following the Copyright Page. An exception might be if your work is a reprint of someone else's work, in which case you do not want the original author's Dedication to be interpreted as being your own.</p> + +<p><img class="floatright" src="html-resources/dedic.png" width="133" height="205" alt="sample dedication page"/> Keep it simple. If your book is combat fiction, it might be:</p> + +<p class="code"><code><small> +\clearpage<br/> +\thispagestyle{empty}<br/> +\vspace*{12\nbs}<br/> +\begin{center}<br/> +\charscale[1.25]{\textsc{To Those Who Served}}\par<br/> +\end{center}<br/> +\clearpage +</small></code></p> -<p>Command <code>\vspace*{<em>length</em>}</code> (note the asterisk) places vertical space, so that the material is not at the top of the page. The best position is somewhere above the vertical middle, rather then at the exact middle. You may use the <code>parascale</code> environment (see Page <a href="noveldocs-07-text-size-style.html#a7.1.3">7</a>) to change the font size and line skip of included text.</p> -<p style="margin-top:10px"><b>One centered line:</b> Use <code>{\centering <em>...</em> \par}</code> to place a single line of horizontally centered text. If repeated, each line is independently centered.</p> +<a id="a9.1.5.2"></a> +<p class="h5"><b>9.1.5.2 Epigraph:</b> Not every book has an Epigraph page, but it is a very useful way to separate the Copyright Page from the beginning of your story, when you have nothing else to put in front matter. In this case, the Epigraph appears as page <code>v</code> (recto), usually with a blank verso, and then your story begins as main matter on the following recto.</p> -<p style="margin-top:10px"><b>Justified block text:</b> If your dedication or epigraph is justified text (rather than poetry) you can use the <code>adjustwidth</code> environment, described above. However, unless you have also reduced the font size using <code>parascale</code>, you may find that a small-width justified block does not look nice. It is hard for the layout engine to make good-looking line breaks when the width is narrow. It would be better to use the <code>Epigraph</code> environment, described below, and manually insert line breaks using <code>\\</code>.</p> +<p>You can also include an Epigraph, even if your front matter has more material. An Epigraph may go on a recto or verso page. So, if you have Dedication (page <code>v</code>) you may place an Epigraph on page <code>vi</code>, if you wish; but it does not have to go there. It may even go on the final front matter page, facing the beginning of your story, provided that it is particularly well-suited to setting the mood, and is not distracting.</p> -<p style="margin-top:10px"><b>Epigraph environment:</b> <code>novel</code> provides the <code>Epigraph</code> environment. Note the capital E:<p> +<p>The purpose of an Epigraph is to set the mood for your own story. Perhaps it will give a hint of the genre, or of the theme. Or it may be pretentious, by implying that your own work can be compared to the famous work cited. Or, the Epigraph may quote from a fictional work. For example, if your story is sword-and-sorcery set in ancient China, you might quote from the imaginary <em>Grimoire of Wong Dung</em>. You may even quote from your own book: J.R.R. Tolkien's Epigraph for each book of his <em>Lord of the Rings</em> trilogy was the longer form of the ring's inscription.</p> -<p class="code"><code>\begin{Epigraph}[<em>alignment</em>] <em>text, with manual line breaks</em> \end{Epigraph}</code></p> +<p>Use the <code>adjustwidth</code> environment to center the Epigraph on the page, as a block that does not occupy the full width. If you do not need the text to be justified, the <code>legalese</code> environment will provide ragged lines without hyphenation. After the text, place the source of the quotation, right-justified, and perhaps preceded by an em dash. Whether you place only the name of the person quoted, or the title of the book quoted, or something else, is a matter of formal style; see what others have done. But keep in mind that you should not use a work currently under copyright for your Epigraph. Translations of older works may be copyrighted, because the translation is sufficiently recent!</p> + +<p>Here is a sample Epigraph, in which the fictional speaker appears as a character in the book. A glance at this, and you know where the story is headed:</p> + +<p class="code"><img class="floatright" src="html-resources/dorfmcnorf.png" width="131" height="208" alt="sample epigraph"/> +<code><small> +\clearpage<br/> +\thispagestyle{empty}<br/> +\vspace*{10\nbs}<br/> +\begin{adjustwidth}{7em}{7em}<br/> +Let me tell you, there's nothing more exciting than the brouhaha at Mickey's Pub each Saturday night in April.\par<br/> +\stake\hfill---Dorf McNorf\par<br/> +\end{adjustwidth}<br/> +\clearpage +</small></code></p> + +<p style="clear:both; margin-top:1em;">The <code>novel</code> class also provides its own <code>Epigraph</code> (not the capital E) command:</p> + +<p class="code"><code>\Epigraph[<em>alignment,scale,width</em>]{<em>text</em>}</code></p> <p>The optional <em>alignment</em> may be one of <code>l</code>, <code>c</code>, or <code>r</code>, which stand for left, center, right. Default is <code>c</code>. This is the horizontal alignment of the epigraph block <em>as a block</em>, not the alignment of the lines within the epigraph.<p> -<p>Within the epigraph block, alignments <code>l</code> and <code>c</code> produce left-alignment of the lines, with ragged right ends. Alignment <code>r</code> produces right-alignment of the lines, with ragged left ends.</p> + +<p>Within the Epigraph block, alignments <code>l</code> and <code>c</code> produce left-alignment of the lines, with ragged right ends. Alignment <code>r</code> produces right-alignment of the lines, with ragged left ends.</p> + <p>There is no particular width to the Epigraph block. If you write a line that is too long, it will not wrap, but will flow into the page margin. Use <code>\\</code> (not <code>\par</code>) to manually break lines.</p> + <p>Exception: The final line, typically an attribution, should <em>not</em> end in <code>\\</code>. It may be without a closure. But if the final line does not end in punctuation, it may be very slightly to the right of its correct position. In this case, ending the line with <code>\par</code> tweaks it.</p> + <p>In the unlikely event that you need to use the ampersand, be sure to write it as <code>\&</code> rather than as mere <code>&</code>.</p> -<p>There is no provision for horizontal lines, or other styling used by academics.</p> +<p>There is no provision for horizontal lines, or other styling used by academics.</p> -<a id="a9.2.2"></a> -<h4>9.2.2 Example of Epigraph Environment</h4> +<p>Here is an example, which will be horizontally centered on its page. For typical text size on 5.5"x8.5" Trim Size, the Epigraph will be slightly above the middle of the page, and occupy about 50% of the textblock width.</p> -<p>This one will be horizontally centered on its page. For typical text size on 5.5"x8.5" Trim Size, the Epigraph will be slightly above the middle of the page, and occupy about 50% of the textblock width. Note that I subsequently added the black border during image editing; it is not part of the Epigraph.</p> +<p>Note that I subsequently added the black border during image editing; it is not part of the Epigraph.</p> -<p class="code"><code> -\vspace*{10\nbs}% for vertical position<br/> -<img class="floatright" src="html-resources/epigraph.png" width="356" height="120" alt="Epigraph example"/> \begin{Epigraph}[c]<br/> +<p class="code"><img class="floatright" src="html-resources/epigrcom.png" width="131" height="204" alt="Epigraph page"/> +<code><small> +\thispagestyle{empty} % no header or footer<br/> +\vspace*{10\nbs} % for vertical position<br/> +<img class="floatright" src="html-resources/epibjorn.png" width="265" height="91" alt="Epigraph text"/> +\Epigraph[c]{% percent prevents newline</span><br/> When sacred swallows sound at dawn,\\<br/> And eager eagles eye their prey,\\<br/> Then shall Shan-Sun wreak revenge.\\<br/> \hfill---Book of Bjorn\par<br/> -\end{Epigraph} -</code></p> +} % end of Epigraph +</small></code></p> -<p>An Epigraph like that tells you something about what to expect in the book. Actually, it tells you to expect about 350 pages of badly-written prose, interspersed with badly-written poetry.</p> -<p>You can do better than that.</p> +<p>An Epigraph like that tells you something about what to expect in the book. Actually, it tells you to expect about 350 pages of badly-written prose, interspersed with badly-written poetry. You can do better than that.</p> +<p>Note that the Epigraph command may also be used inside the <code>ChapterStart</code> environment, as described farther down this page.</p> -<a id="a9.3"></a> -<h3>9.3 Table of Contents</h3> - -<p>Do not place a table of contents just because you can. A table of contents is more useful when the story consists of discrete episodes. Or, if the book is a collection of short stories, a table of contents is mandatory. When a story is an "action adventure," in which short chapters move along in rapid succession, a table of contents would be unusual. Chapter titles would likely occupy only a small amount of space, and might not even start new pages.</p> -<p>If you use a Dedication (which must be recto), then the Table of Contents will be on the following recto page. The intermediate verso may be blank, or have an Epigraph, or perhaps something such as a map or other illustration. Neither Dedication nor Epigraph is listed in the Table of Contents.</p> +<a id="a9.1.5.3"></a> +<p class="h5"><b>9.1.5.3 Table of Contents:</b> Do not place a table of contents just because you can. A table of contents is more useful when the story consists of discrete episodes with distinctive names, not just numbers. Or, if the book is a collection of short stories, a table of contents is mandatory. When a story is an “action adventure,” in which short chapters move along in rapid succession, a table of contents would be unusual.</p> -<p>If you do not use a Dedication, then place the Table of Contents on the recto page immediately following the copyright page. An Epigraph, if any, may be placed later (it may also be on the verso page that faces the start of your story, if it is not intrusive).</p> +<p>If you use a Table of Contents, it must be on a recto page. That would be page <code>v</code> if your book has no Dedication or Epigraph, or page <code>vii</code> if it has one or both of them.</p> -<p>The TeX academic document classes, and related packages, have means for automatic construction of a table of contents. They do not work, in the <code>novel</code> class! Don't even think about it. If you want a Table of Contents, you have to design it yourself. Its entries are not automatically generated by the structure of your book. There is a reason for this: In fiction, a table of contents is often stylish. There is no single method that is best for all, and certainly no academic standard that must be met.</p> +<p>The Table of Contents does not include itself or anything preceding. If the front matter has textual sections such as Foreword, Preface, or Author's Intoduction, they are listed in the table (and will have lowercase roman numerals). In fiction, you might have at most one or two maps, which may be listed in the Table of Contents, rather than in a separate list of Illustrations.</p> -<p>But you have not been abandoned. In <code>novel</code>, there is an environment for constructing a Table of Contents, and commands that place the individual entries. These are designed with fiction in mind. You do not have to use them, if you have your own method of designing.</p> +<p>If your book has Part Separators (described lower on this page), then each Part Separator is listed in the table, but its page number is <em>not</em> provided unless the separator has a meaningful amount of text. So, <span class="apdk">“PART I. IN THE CASTLE”</span> would not have its page number listed in the table. However, <span class="apdk">“PART I. IN THE CASTLE. We begin our story in Castle McNada, where there has been an altercation between Lord Withens and Sir Nadie regarding the disposition of the gnomes.”</span> provides enough information to deserve its page number in the table. Use your discretion.</p> -<p>In any case, avoid using any of the table environments that come with TeX or its packages. These do not provide the most attractive presentation for fiction, without a lot of work on your part.</p> +<p>In most fiction, the first entry in a Table of Contents will be the first chapter of the story, which will be on page 1, or in some cases, page 3.</p> +<p><b>toc environment:</b> Avoid any of the table environments that come with TeX or its packages. These do not provide the most attractive presentation for fiction, without a lot of work on your part. With <code>novel</code> you have an environment defined specifically to meet the needs of fiction:</p> -<a id="a9.3.1"></a> -<h4>9.3.1 \begin{toc}[<em>extra entry separation</em>]{<em>extra margins</em>} <em>...</em> \end{toc}</h4> +<p class="code"><code>\begin{toc}[<em>extra entry separation</em>]{<em>extra margins</em>} <em>...</em> \end{toc}</code></p> <p>The <code>toc</code> is not indented, and text within it is not indented.</p> @@ -279,15 +478,11 @@ Then shall Shan-Sun wreak revenge.\\<br/> <p>Typically, the label for the <code>toc</code> will not be as bland as "Table of Contents" or even "Contents." One possibility is to use the book's title (and subtitle, if any). You can add a graphic element or a short remark, if you wish.</p> -<p>In most cases, the table's title should not be placed where the first line of text would normally appear. This is because a fictional table of contents rarely fills the page, so it is more attractive to allow some space at top. Another reason is that if you use the <code>\charscale</code> command to increase the size of the topmost text, it will infringe the top margin, unless you provide at least one line of space above it. The <code>\null</code> command is best for this purpose.</p> - -<p>The Table of Contents page has no header, but may include its page number beneath the table. <code>\thispagestyle{footer}</code> or <code>\thispagestyle{dropfoliobeneath}</code> or <code>\thispagestyle{dropfolioinside}</code> are helpful.</p> +<p>In most cases, the table's title should not be placed where the first line of text would normally appear. This is because a fictional table of contents rarely fills the page, so it is more attractive to allow some space at top. Another reason is that if you use the <code>\charscale</code> command to increase the size of the topmost text, it will infringe the top margin, unless you provide at least one line of space above it. The <code>\vspace*{<em>length</em>}</code> command is best for this purpose.</p> +<p><b>\tocitem:</b> The <code>\tocitem</code> command, and its starred version, are used for individual entries in the TOC environment. Do not use this command for general text that is not linked to a page number.</p> -<a id="a9.3.2"></a> -<h4>9.3.2 \tocitem[<em>chapter number</em>]{<em>description</em>}{<em>page number</em>} and starred version</h4> - -<p>The <code>\tocitem</code> command, and its starred version, are used for individual entries in the TOC environment. Do not use this command for general text that is not linked to a page number.</p> +<p class="code"><code>\tocitem[<em>chapter number</em>]{<em>description</em>}{<em>page number</em>} and starred version</code></p> <p>• The optional argument is the chapter number, at most two digits. The number will be left-aligned, with a period automatically added. Following the period will be the amount of space needed to keep the following description aligned.</p> <p>If the optional argument is omitted (or empty), then there is no space, and the following description will align to the left of the table.</p> @@ -296,17 +491,15 @@ Then shall Shan-Sun wreak revenge.\\<br/> <p>• Without the asterisk, <code>\tocitem</code> fills the area between the description and the page number with empty space. The starred <code>\tocitem*</code> command fills with a dotted line, and is very attractive.</p> <p>You may use ordinary style commands, such as <code>\emph{}</code>, in the entries.</p> +<p><b>Example of toc:</b> The use of the <code>toc</code> environment, and the <code>\tocitem</code> commands, are easily understood by looking at an example. The border of the image is where the normal page margins would be (the actual page is larger). The little explanation at top happens to exactly fit the table width, because I tweaked the text and the width until it fit!</p> -<a id="a9.3.3"></a> -<h4>9.3.3 Example of toc</h4> -<p>The use of the <code>toc</code> environment, and the <code>\tocitem</code> commands, are easily understood by looking at an example. The border of the image is where the normal page margins would be (the actual page is larger). The little explanation at top happens to exactly fit the table width, because I tweaked the text and the width until it fit!</p> - -<p class="code" style="text-indent:0px; font-size:small"><img class="floatright" style="padding-top:2em" src="html-resources/toc.png" width="316" height="559" alt="TOC example"/> +<p class="code" style="text-indent:0px; font-size:small"><img class="floatright" src="html-resources/toc.png" width="317" height="490" alt="toc example"/> <code> -\thispagestyle{dropfolioinside}<br/> +\clearpage<br/> +\thispagestyle{empty}<br/> \begin{toc}[0.25]{3em}<br/> -\null\null<br/> -{\centering\charscale{1.25}{The Withens Retaliation}\par}<br/> +\vspace*{4\nbs}<br/> +{\centering\charscale[1.25]{The Withens Retaliation}\par}<br/> \null<br/> In which Lord Withens, fresh from a program in horticulture, unleashes secret desires on the garden.\par<br/> \null\null<br/> @@ -323,110 +516,249 @@ In which Lord Withens, fresh from a program in horticulture, unleashes secret de \tocitem*[10]{Lady Withens Sneezes}{180}<br/> \tocitem*[11]{The Concrete Lawn}{206}<br/> \end{toc}<br/> -\null\null<br/> -\BlockImage{gnome.png}<br/> \clearpage </code> </p> -<a id="a9.4"></a> -<h3>9.4 Foreword, Preface, Introduction, Acknowledgements, Prologue, etc.</h3> +<a id="a9.1.5.4"></a> +<p class="h5"><b>9.1.5.4 Part Separator:</b> A <em>Part Separator</em> is a recto page marking an abrupt change between very different portions of the book. Ordinary new chapters are <em>not</em> Part Separators. Many books have no need of Part Separators.</p> -<p>My casual review of online forums indicates that new authors like to tell their life story in a Preface, or perhaps go into a long narrative about what motivated them to write the book. Don't do it. That's what web sites are for. Tell your story there. It's easier to edit, too.</p> +<p>One kind of Part Separator is the “Inner Half-Title”. This is a recto duplicate of the Half-Title page. It may appear in these situations: (a) You need to put something between the Copyright Page and the start of the story, but you do not want to put anything else there. (b) The front matter has a Foreword or Preface, or other material that takes up a number of pages, and you wish to provide a visual separation between the front matter and the main matter.</p> -<p>There is a genre of fiction, often seen, in which the story is supposed to be a "lost manuscript" recently discovered by the author, or perhaps unearthed by an archaeologist. Or, it may be an "ancient legend" that has been "translated" by a fictional professor. In such a case, it is customary to put remarks from the author, archaeologist, or professor in frontmatter—as if they were real—even though they are just as fictional as the rest of the story.</p> +<p>The other kind of Part Separator is, as you might guess, a means to separate parts of the book. For example, if your book consists of two novellas, then each novella would have its own Part Separator, being a simplified title page for the following story. Or, if you wish to suggest an interruption in the flow of a single story, you might divide it using Part Separators. An example is each book in J.R.R. Tolkien's <em>Lord of the Rings</em> trilogy, in which each bound book is partitioned into two sub-books.</p> -<p>As a general rule, each section that is distinctively different should begin on a recto page. If your frontmatter has many components, then consider rewriting to avoid excessive blank verso pages. Or, violate the general rule.</p> +<p>A Part Separator is part of main matter, and has an arabic page number. However, the page number is not printed (possible exception if the separator also contains substantial text, by way of introduction). Thus, the first Part Separator would be page <code>1</code>, and its story would begin on page <code>3</code>. Wihout a Part Separator, the story would begin on page <code>1</code>. -<p>Also, as a general rule, the first page of any of these components should have no page header. A footer (or dropfolio) is allowed. The page number will be in lowercase roman numerals.</p> +<p class="code"><img class="floatright" src="html-resources/partsep.png" width="134" height="202" alt="part separator"/> +<code><small> +\clearpage<br/> +<span class="ap">% \mainmatter % if needed to begin at page 1</span><br/> +\thispagestyle{empty}<br/> +\vspace*{10\nbs}<br/> +% the tilde provides better separation:<br/> +{\centering\charscale[2]{PART~ I}\par}<br/> +\clearpage +</small></code></p> -<p>If the Foreword (Preface, etc.) is extensive, and if the style of your document has headers, then do use headers on the continuing pages. Always use footers, if that is your document style. You will need to take advantage of the <code>novel</code> commands <code>\SetVersoHeadText</code> and <code>\SetRectoHeadText</code> to control what appears in page headers. For example, if your book has an extensive Foreword, it is <em>not</em> customary to write the author's name verso, or the books's title recto. That is because the person writing the Foreword is not necessarily the book's author, and the text of the Foreword is not part of the main story. You might do something like this, for the continuing pages of a Foreword:</p> +<p>The verso of a Part Separator is usually blank. But you could put a map there, or an Epigraph. It's up to you.</p> -<p class="code"><code> -\SetVersoHeadText{\allsmcp{Foreword}}<br/> -\SetRectoHeadText{\allsmcp{Foreword}} -</code></p> -<p>If you do the above, remember to change the head texts after you leave the Foreword. The above commands are not merely local.</p> +<a id="a9.1.5.5"></a> +<p class="h5"><b>9.1.5.5 Map or Other Illustration:</b> A map, or other illustration, is simply a large image. It must be prepared at 100% scale and actual resolution, according to the detailed requirements described on that documentation page.</p> +<p>Since a (fictional) map is part of the story, it belongs in main matter rather than in front matter. But where you put is is up to you.</p> +<p>A map or illustration may be verso or recto.</p> + + + + +<a id="a9.2"></a> +<h3>9.2 Start Pages: General</h3> + +<p>Start pages begin a section that may continue to additional pages. The key word is "may." A section may be so brief that its start page is its only page.</p> -<a id="a9.5"></a> -<h3>9.5 New Chapters</h3> -<p>If your novel consists of chapters that begin on their own page, or if your book is a collection of stories, then you should use the <code>ChapterDisplay</code> environment to enclose the block of text (and possibly image) that starts each new chapter.</p> +<a id="a9.2.1"></a> +<h4>9.2.1 \thispagestyle{<em>choose</em>}</h4> + +<p>A start page does not have a header. But if the normal page layout has a footer, then a start page will also have the footer. Thus, the page number (folio) will be printed on a start page, or not, depending on whether or not the normal layout has a footer. This is controlled by the following command:</p> + +<p class="code"><code>\thispagestyle{footer}</code></p> + +<p>The above code actually means, “footer, if normally available.” It does not create a footer that would not otherwise be present in your general book layout.</p> + +<p>The <code>novel</code> document class has an additional capability. On a start page, you may create a temporary footer containing just the page number. There are two ways to do that: + +<p class="code"><code>\thispagestyle{dropfolioinside}</code></p> + +<p>When you drop the folio (page number) <em>inside</em>, you reduce the height of the text block by one line, just on that page. The line that would have been the last one there, is moved to the top of the following page. However, if this command is used on a <code>ChapterStart</code> page (see below), then instead of moving that line, the space occupied by the chapter title block is reduced, so that it is not necessary to flow the line to the following page.</p> + +<p>Then, the page number is centered where the last line of text would have been placed.</p> + +<p>The following image shows three pages of a Foreword, from a book that uses header but no footer. On its start page, the folio has been dropped inside. Color added for illustration.</p> + +<p class="centerimg"><img src="html-resources/dfi.png" width="534" height="267" alt="example of inside drop folio"/></p> + +<p class="code"><code>\thispagestyle{dropfoliobeneath}</code></p> + +<p>When you drop the folio <em>beneath</em>, you do not change the height of the textblock. Instead, you place the page number centered where one additional line of text would be. Thus, the number sits within the bottom margin. This is allowable if the width of the bottom margin exceeds the minimum clearance required by the printer. However, if you do not have the excess margin, do not use this command.</p> + +<p>In <em>very rare cases</em>, which I have only seen in some non-fiction, the book has a header but no footer, and its start pages must show the page number (but not text) in the header. There is a command for that:</p> + +<p class="code"><code>\thispagestyle{forcenumber}</code></p> + +<p>With <em>forcenumber</em>, if a footer exists it will be used. Otherwise, the command assumes that the page number is at the outside margin of a header, and allows only that portion to print. Do not use the above command, unless you really need it.</p> + + +<a id="a9.2.2"></a> +<h4>\SetVersoHeadText{<em>new~verso~head</em>} \SetRectoHeadText{<em>new~recto~head</em>}</h4> + +<p>These commands only apply if you chose a header/footer style that includes text in the header. They will not throw an error if you use them with other header/footer styles; but they will have no effect.</p> + +<p>When your document begins, <code>novel</code> automatically places the author as verso header text, and the title as recto header text. They will appear on all pages that have a visible header (but not on pages where <code>\thispagestyle</code> blanks the header). This is the norm for many works o fiction.</p> + +<p>However, there are occasions when something else should appear in the header text. If your book has a Foreword, Preface, or similar section in its front matter, you do not use the author and title there. Instead, you simply place the section title (Foreword, Preface, or whatever) both verso and recto. The reasons are simple: (a) The front matter is not actually part of the story, and (b) It might have been written by someone other than the author.</p> + +<p>In the main matter, you might prefer that the chapter title (or story title, if short stories) appear instead of the author or book title. Or maybe something else. It is up to you, <em>but</em> be aware that some print services object to headers that change from place to place, as it creates the impression that portions of several different books are being assembled in error.</p> + +<p>Only use <code>\SetVersoHeadText</code> or <code>\SetRectoHeadText</code> following <code>\clearpage</code>. The effect will be applied immediately, and continue indefinitely, until the commands are re-issued.</p> + +<p>In the header text, use tilde rather than space to separate words. This improves the inter-word spacing. Perhaps at some future time this will not be necessary.</p> + +<p>The header text will appear in the font chosen as <code>headerfont</code>. You may over-ride that with a local font command. The text may be styled with commands such as <code>\textsc</code> or <code>\textls</code> or <code>\emph</code> if desired. Do not use underline or bold.</p> + +<p><img class="floatright" src="html-resources/preface.png" width="259" height="820" alt="example preface"/> Here is an example, where the author wrote a Preface several pages long, and the book layout uses a header. The <code>ChapterStart</code> environment is used, but this is not a requirement. The <code>lipsum</code> package was used for text fill:</p> + +<p class="code"><code><small> +\clearpage<br/> +\thispagestyle{footer} <span class="ap">% or dropfolioinside or dropfoliobeneath</span><br/> +\SetVersoHeadText{\textsc{Preface}}<br/> +\SetRectoHeadText{\textsc{Preface}}<br/> +\begin{ChapterStart}<br/> +\vspace*{2\nbs}<br/> +\ChapterTitle{Preface}<br/> +\end{ChapterStart}<br/> +The inspiration for this book...\par<br/> +\lipsum<br/> +But while I was held captive...\par<br/> +\lipsum<br/> +Clawing my way to the sunlight...\par<br/> +\lipsum<br/> +... And I hope you will enjoy it.\par<br/> +\null<br/> +\stake\hfill Dirk Hardcase.\par<br/> +\stake\hfill Springfield, March 14, 2017\par<br/> +\clearpage<br/> +<span class="ap">% Be sure to re-set the head texts now!</span> +</small></code></p> + + + +<a id="a9.3"></a> +<h4>9.3 Start Pages in Front Matter: Foreword, Preface, etc.</h4> + +<p>In most cases, a work of fiction will have no <em>start pages</em> in front matter. To put that another way, the front matter will consist entirely of <em>display pages</em>, as I have defined these terms. Example: Page i is the Half-Title; ii is blank; iii is the Title; iv is the Copyright; v is a Dedication, Epigraph, Table of Contents, Map, or duplicate Half-Title; vi is blank. That's all the front matter you need.</p> + +<p>However, if your book has a Foreword, Preface, Introduction, separate Acknowledgements, or similar section in front matter, then each begins with a recto start page. This is the case, even if the section is merely one page. If the section has an odd number of pages, then a blank page is inserted after it, so that the next section begins recto. Thus, if you have several sections like that, there will be several blank pages here and there, creating the impression that your book was padded. Solution: Edit!</p> + +<p>A potential problem arises when your book is of the “discovered lost manuscript” genre: The author pretends to be an archaeologist or professor who has discovered or translated a manuscript, or ancient inscriptions. In some cases, there may be more than one discoverer/translator involved. The author may even use his or her real name, in a fictional introduction. So, should the “archaeologist's” tale of discovery be in front matter, where it would be if it were a true academic work? Or should it belong in main matter, because it is fictional? Same with the “translator's” notes, and author's own introduction. My understanding of the <em>Chicago Manual of Style</em> (hardcover 16.ed., items 1.42, 1.46) is that it all belongs in main matter. But in established, printed fiction I have seen it both ways.</p> + + + +<a id="a9.4"></a> +<h4>9.4 Start Pages in Main Matter: New Chapters</h4> + +<p>In the main matter of most books, the only start pages are new chapters. Actually, I cannot think of an exception to this. Remember that Part Separators are (usually) treated as display pages. Maps are always display pages, unless they are so small that they fit on a page with continued text.</p> + +<p>If your novel consists of chapters that begin on their own page, or if your book is a collection of stories, then you should use the <code>ChapterStart</code> environment to enclose the block of text (and possibly image) that starts each new chapter.</p> + <p>You may place almost anything you like at the beginning of new chapters, but in reality there are only a limited number of useful things. The <code>novel</code> class has special commands for handling them, especially for the needs of fiction.</p> -<p>If your book is actually a quick succession of many short chapters, then it might be better to treat them as scenes. See the following scene commands.</p> -<p>Also see <a href="noveldocs-06-header-footer.html#a6.1.7">Page 6</a> for the <code>\SetChapterDisplay</code> command, which provides a means to globally set how headers and footers are used on <code>ChapterDisplay</code> pages.</p> +<p>If your book is actually a quick succession of many short chapters, then it might be better to treat them as scenes. See the scene commands, lower on this page.</p> -<a id="a9.5.1"></a> -<h4>9.5.1 \begin{<em>ChapterDisplay</em>}[<em>lines</em>] <em>...</em> \end{<em>ChapterDisplay</em>}</h4> -<p>The ChapterDisplay environment reserves a block of space at the top of the textblock. The same space is reserved, no matter how much or how little content you put there. The optional argument set the number of lines displaced by the block. Its default is 10, minimum 4.</p> +<a id="a9.4.1"></a> +<h4>9.4.1 \SetChapterStart{<em>pagestyle</em>}</h4> -<p>If you put a lot of material inside ChapterDisplay, it will not push the story farther down the page. Instead, the material inside the ChapterDisplay will overflow the reserved area, and mingle with the text below. Normally this is very undesirable. However, it might be attractive if your ChapterDisplay contains an image that you wish to dangle underneath the following text.</p> +<p>When you use the <code>ChapterStart</code> environment, described below, it will use <code>\thispagestyle{footer}</code> by default. That is, no header will be printed on that page. If the book layout normally has a footer, it will be displayed (and thus the page number, which is in the footer, will be shown). But if there is normally no footer, no page number will be shown, so the default is equivalent to <code>\thispagestyle{empty}</code>.</p> -<p>ChapterDisplay should use one of the header-less <code>\thispagestyle</code> commands. If you choose <code>dropfolioinside</code>, then a blank line will be removed from the top of the display, so that everything on the page moves upward.</p> +<p>You can globally change the default behavior, with this Preamble command:</p> -<p>If you are using symbolic footnote markers, each <code>ChapterDisplay</code> re-sets the symbols.</p> +<p class="code"><code>\SetChapterStart{<em>some other choice of pagestyle</em>}</code></p> -<p>You will need to use <code>\clearpage</code> prior to the display.</p> +<p>Other choices of pagestyle are <code>dropfolioinside</code>, <code>dropfoliobeneath</code>, or very rarely <code>forcenumber</code>.</p> -<a id="a9.5.2"></a> -<h4 style="clear:none">9.5.2 Pre-Styled Chapter Title Commands</h4> +<a id="a9.4.2"></a> +<h4>9.4.2 \begin{<em>ChapterStart</em>}[<em>lines</em>] <em>...</em> \end{<em>ChapterStart</em>}</h4> + +<p>The <code>ChapterStart</code> environment reserves a block of space at the top of the textblock. The same space is reserved, no matter how much or how little content you put inside. The optional argument sets the number of lines displaced by the block. Its default is 10, minimum 4.</p> + +<p>You will need to use <code>\clearpage</code> prior to each <code>ChapterStart</code>.</p> + +<p>If you put a lot of material inside <code>ChapterStart</code>, it will not push the story farther down the page. Instead, the material inside the <code>ChapterStart</code> will overflow the reserved area, and mingle with the text below. Normally this is very undesirable. However, it might be attractive, if your <code>ChapterStart</code> contains an image that you wish to dangle underneath the following text.</p> + +<p>For a particular chapter, if you wish to use a page style that differs from the one specified by <code>\SetChapterStart</code>, then you must put the <code>\thispageStyle</code> command <em>before</em> <code>\begin{ChapterStart}</code>.</p> + +<p>If you are using symbolic footnote markers, each <code>ChapterStart</code> re-sets the symbols.</p> -<p>These are intended for use in the <code>ChapterDisplay</code> environment. If you use them anywhere else, then the text line grid will be disturbed.</p> +<p>The first line of main text, following <code>ChapterStart</code>, will not be indented.</p> -<p><code>\ChapterTitle{}</code> sets its text using chapterfont. The default is the main font scaled 1.6, with lining numbers.</p> -<p><code>\ChapterSubtitle{}</code> sets its text using subchfont. The default is the main font scaled 1.2, with lining numbers.</p> +<a id="a9.4.3"></a> +<h4>9.4.3 Pre-Styled Chapter Title Commands</h4> -<p><code>\ChapterDeco[]{}</code> does not commit to its contents. Typically a decoration will be used, perhaps from decofont. The optional argument is a scale factor to be applied to the required argument. Many horizontal decorations need to be magnified.</p> +<p>Several commands are specifically designed for use inside the <code>ChapterStart</code> environment. If you use them anywhere else, then the text line grid will be disturbed. So, don't do that, with the possible exception of display pages where the line grid does not matter.</p> <p>Each of these commands may only be used for a single line of contents. If the contents cannot fit on a single line, then you must manually break and issue the command twice. The commands may be used in any order, may be used more than once, or not at all.</p> +<a id="a9.4.3.1"></a> +<p class="h5"><img class="floatright" style="margin-top:40px;" src="html-resources/chapst.png" width="263" height="409" alt="example chapter start"/> +<b>9.4.3.1\ChapterTitle{<em>text</em>}</b> sets its text using <code>chapterfont</code>. The default is the main font scaled 1.6, with lining numbers.</p> +<a id="a9.4.3.2"></a> +<p class="h5" style="clear:none"><b>9.4.3.2\ChapterSubtitle{<em>text</em>}</b> sets its text using <code>subchfont</code>. The default is the main font scaled 1.2, with lining numbers.</p> -<a id="a9.5.3"></a> -<h4>9.5.3 ChapterDisplay With Image</h4> +<a id="a9.4.3.3"></a> +<p class="h5" style="clear:none"><b>9.4.3.3\ChapterDeco[<em>scale</em>]{<em>text</em>}</b> does not commit to its contents. Typically a decoration will be used, perhaps from <code>decofont</code>. The optional argument is a scale factor to be applied to the required argument. Many horizontal decorations need to be magnified.</p> +<p style="margin-top:20px">Example, where <code>\clearpage</code> and <code>\mainmatter</code> were already issued:</p> -<p>You can use an image in chapter titles. If you place an image, be sure to use one of the image commands defined by <code>novel</code> on Page 8 of this documentation. Any other method is likely to push the following text off-grid.</p> +<p class="code"><code><small> +\thispagestyle{dropfolioinside}<br/> +\begin{ChapterStart} <span class="ap">% default 10 lines</span><br/> + \null <span class="ap">% for positioning title</span><br/> + \ChapterTitle{Prologue}<br/> + \ChapterDeco[4]{\decoglyph{r9548}}<br/> + \ChapterSubtitle{The Finding of the Manuscript}<br/> +\end{ChapterStart}<br/> +<span class="ap">% then the main text</span> +</small></code></p> -<p>Be sure that you are licensed to use the image. Many clipart catalogs "for personal use only," prohibit usage in commercial books. One possible source is <a href="http://openclipart.org" rel="external" target="new">openclipart.org</a> (note the <em>.org</em>).</p> +<a id="a9.4.4"></a> +<h4>9.4.4 ChapterStart With Image</h4> -<p><b>Text Over Image</b></p> +<p>You can use an image in chapter titles. If you place an image, use one of the image commands defined by <code>novel</code> elsewhere in the documentation. Any other method is likely to push the following text off-grid.</p> + +<p>Be sure that you are licensed to use the image. Many clipart catalogs "for personal use only," prohibit usage in commercial books. One possible source is <a href="http://openclipart.org" rel="external" target="new">openclipart.org</a> (note the <em>.org</em>).</p> -<p><img class="floatright" src="html-resources/ctimg35.png" width="79" height="196" alt="example of chapter title image, text over"/> You may position text over an image. Be aware that overlapping text and graphics may be interpreted as a mistake, by human reviewers. It is best to use black text, or grayscale text that is much darker than the underlying image. Results are uncertain if you try to place light text over a dark image.</p> + +<a id="a9.4.4.1"></a> +<p class="h5"><img class="floatright" src="html-resources/ctimg35.png" width="79" height="196" alt="example of chapter title image, text over"/><b>9.4.4.1 Text Over Image:</b> You may position text over an image. Be aware that overlapping text and graphics may be interpreted as a mistake, by human reviewers. It is best to use black text, or grayscale text that is much darker than the underlying image. Results are uncertain if you try to place light text over a dark image.</p> <p>Example, where the command <code>\unifrac</code> calls for the font UnifrakturMaguntia.ttf. Note that the font command is <em>outside</em> <code>\charscale</code>:</p> -<p class="code"><code>\begin{ChapterDisplay}<br/> -\BlockImage{sword.png}% centered by default<br/> +<p class="code"><code><small>\begin{ChapterStart}<br/> +\BlockImage{sword.png} <span class="ap">% centered by default</span><br/> {\unifrak\centering\charscale[3,0pt,4\nbs]{35}\par}<br/> -\end{ChapterDisplay}</code></p> - +</small>\end{ChapterStart}</code></p> -<p style="clear:none;"><b>Text as Part of Image</b></p> -<p>If the text is not ordinary black, or not much darker than the background image, then it is better to include the text as part of the raster image. The reason is that there is no "white ink." Although light text over a dark image will appear correctly in PDF, and print that way on most printers, there are exceptions. If in doubt, ask your print service. In this example, the number is built into the image itself:</p> +<a id="a9.4.4.2"></a> +<p class="h5"><b>9.4.4.2 Text as Part of Image:</b> If the text is not ordinary black, or not much darker than the background image, then it is better to include the text as part of the raster image. The reason is that there is no "white ink." Although light text over a dark image will appear correctly in PDF, and print that way on most printers, there are exceptions. If in doubt, ask your print service. In this example, the number is built into the image itself:</p> -<p class="code"><img class="floatright" src="html-resources/smfingerprint8.png" width="86" height="70" alt="example of chapter title image, raster text"/><code>\begin{ChapterDisplay}<br/> +<p class="code"><img class="floatright" src="html-resources/smfingerprint8.png" width="86" height="70" alt="example of chapter title image, raster text"/><code><small>\begin{ChapterStart}<br/> \BlockImage[l]{smfingerprint8.png}<br/> -\end{ChapterDisplay}</code></p> +\end{ChapterStart}</small></code></p> + + + +<a id="a9.5"></a> +<h3>9.5 Continued Pages</h3> + +<p>I define <em>continued page</em> to mean a page that has a noticeable break, but without necessarily starting another page. Thus, the <code>\clearpage</code> and <code>\thispagestyle</code> commands are not used, and it is uncommon to change header text.</p> -<a id="a9.5.4"></a> -<h4>9.5.4 \QuickChapter[<em>linelength</em>]{<em>chapter title</em>}</h4> +<a id="a9.5.1"></a> +<h4>9.5.1 \QuickChapter[<em>linelength</em>]{<em>chapter title</em>}</h4> -<p>If your novel is the kind of story that consists of numerous short chapters in rapid succession, then you probably do not wish to begin each chapter on its own page, with a block of whitespace at the top. The <code>\QuickChapter</code> command provides an alternative to <code>ChapterDisplay</code>.</p> +<p>If your novel is the kind of story that consists of numerous short chapters in rapid succession, then you probably do not wish to begin each chapter on its own page, with a block of whitespace at the top. The <code>\QuickChapter</code> command provides an alternative to <code>ChapterStart</code>.</p> -<p>The <code>\QuickChapter</code> command inserts two blank lines. In the gap, the chapter title is left-justified using <code>subchfont</code> (not <code>chapterfont</code>). It is slightly raised from the normal baseline, because this looks better; but the text in the following chapter is on-grid. The start of the chapter will be un-indented.</p> +<p>The <code>\QuickChapter</code> command inserts two blank lines. In the gap, the chapter title is left-justified using <code>subchfont</code> (not <code>chapterfont</code>). It is slightly raised from the normal baseline, because this looks better; but the following text is back on-grid. The start of the following text will be un-indented.</p> <p>If the optional <code>linelength</code> is provided, then a dash will be written after the title, at the position and thickness typical of the em dash in <code>subchfont</code>. If <code>linelength</code> is specified in units of length, then that will be the length of the line. But if <code>linelength</code> is an asterisk, then the line will fill to the right margin.</p> @@ -434,64 +766,65 @@ In which Lord Withens, fresh from a program in horticulture, unleashes secret de <p>Example:</p> -<p class="code"><code>Then he looked at me with a sneer, and barked, ``You better haul your can over to Vinny's joint, before the Boss finds out.''\par<br/> +<p class="code"><code><small>Then he looked at me with a sneer, and barked, ``You better haul your can over to Vinny's joint, before the Boss finds out.''\par<br/> \QuickChapter[3em]{16. At Vinny's}<br/> So I took his advice, and hauled my can over to Vinny's. It was everything I had expected, and worse.\par<br/> -The bouncer wasn't the biggest one I'd ever seen, but he was the ugliest. ...</code></p> +The bouncer wasn't the biggest one I'd ever seen, but he was the ugliest. ...</small></code></p> <p class="centerimg"><img src="html-resources/quickchapter.png" width="629" height="240" alt="quick chapter"/></p> -<a id="a9.6"></a> -<h3>9.6 Scene Breaks</h3> +<a id="a9.5.2"></a> +<h4>9.5.2 Scene Breaks</h4> <p>There are several commands dedicated to the purpose of scene breaks.</p> -<a id="a9.6.1"></a> -<h4>9.6.1 \scenebreak, \sceneline, \scenestars</h4> +<a id="a9.5.2.1"></a> +<p class="h5"><b>9.5.2.1 \scenebreak</b> inserts a one-line blank skip. The following line of text is not indented.</p> -<p>These commands insert a one-line skip. After the skip, the next line will not be indented.</p> -<p>The first command simply leaves the skip blank. The second places a short line centered in the skip. The third places three widely-spaced asterisks, centered in the skip. Like this:</p> -<p class="code" style="font-size:small"><img style="float:right; margin-left:16px;" src="html-resources/scenebreaks.png" width="424" height="222" alt="scene breaks" /> -<code> +<a id="a9.5.2.2"></a> +<p class="h5"><b>9.5.2.2 \sceneline</b> inserts a one-line skip, containing a short centered line. The following line of text is not indented.</p> + +<a id="a9.5.2.3"></a> +<p class="h5"><b>9.5.2.3 \scenestars</b> inserts a one-line skip, containing three spaced, centered asterisks. The following line of text is not indented.</p> + +<p style="margin-top:20px">Examples:</p> + +<p class="code"><img style="float:right; margin-left:16px;" src="html-resources/scenebreaks.png" width="331" height="236" alt="scene breaks" /> +<code><small> \noindent It was a dark and stormy night.\par<br/> -Lord Withens, the last of his line, hurried through the gloom.\par<br/> +Lord Withens, the last of his line, hurried through the gloom to Castle McWhistle, where Lady McWhistle awaited.\par<br/> \scenebreak<br/> Well, maybe it was not very dark.\par<br/> -But to Lord Withens, it seemed dark enough.\par<br/> +But to Lord Withens, it seemed dark enough. Or rather, he hoped it was dark enough. Lord McWhistle was suspicious.\par<br/> \sceneline<br/> -Actually, it was not all that stormy, either.\par<br/> -But the Withens clan never tolerated drizzle, much less a storm.\par<br/> +Actually, it was not all that stormy, either. But the Withens clan never tolerated drizzle, much less a storm.\par<br/> +Who could blame them? It's not like they lived in Italy.\par<br/> \scenestars<br/> Ah, such ill fortune haunted the Withens!\par<br/> -Novelists of that era had so little to write about, unfortunately.\par -</code></p> +Unfortunately, novelists of that era had so little to write about, or they would have chosen another family to pursue.\par +</small></code></p> -<p style="clear:both">• If you begin the new scene with something such as an enlarged scene number, or a larger than normal letter, then be sure to put the number or letter inside <code>\charscale</code>. This will prevent enlarged characters from spreading the lines apart. And, unless you have a particular style in mind, it is better to use lining numbers instead of old style numbers. Something like this:</p> -<p class="code"><code>\scenebreak<br/> -\charscale[1.2]{\lnum{3.}}— The night was still dark and stormy. ...</code></p> - -<a id="a9.6.2"></a> -<h4>9.6.2 \IndentAfterScenebreak</h4> +<a id="a9.5.3"></a> +<h4>9.5.3 \IndentAfterScenebreak</h4> <p>This global command may only be used in the Preamble.</p> <p>Normally, text begins without a paragraph indent, at each new scene. This is standard in fiction. If you prefer that each new scene begins indented, use this command. It works with <code>\scenebreak</code>, <code>\sceneline</code>, and <code>\scenestars</code>.</p> - -<a id="a9.7"></a> -<h3>9.7 Footnotes</h3> +<a id="a9.6"></a> +<h3>9.6 Footnotes</h3> <p>This document class has <em>limited</em> support for footnotes, because footnotes are hardly ever used in original fiction. Nevertheless, they do appear on occasion.</p> <p>Footnotes appear at the bottom of the page where they are placed. There is no option to accumulate them to another location. Very long footnotes might straddle pages, but that situation is uncommon in fiction.</p> <p>If you have a lot of footnotes, consider endnotes instead. Both may be used.</p> -<a id="a9.7.1"></a> -<h4>9.7.1 \SetMarkers[<em>real,fake</em>]{<em>asterisk, dagger, number</em>} </h4> +<a id="a9.6.1"></a> +<h4>9.6.1 \SetMarkers[<em>real,fake</em>]{<em>asterisk, dagger, number</em>}</h4> <p>This command is used only in the Preamble.</p> <p>A "marker" is a superscript or subscript, however used. Thus, a footnote or endnote is indicated by a marker in the main text (but not in the footnote or endnote itself).</p> @@ -505,15 +838,15 @@ Novelists of that era had so little to write about, unfortunately.\par <p><code>number</code> uses numerical markers. Due to possible conflict, the log file will have a "Big Bad Warning" if you use a numerical footnote marker in a document that also has endnotes, since endnotes alays have numerical markers.</p> -<a id="a9.7.2"></a> -<h4>9.7.2 \realmarker \fakemarker</h4> +<a id="a9.6.2"></a> +<h4>9.6.2 \realmarker \fakemarker</h4> <p>Within the body of the document, you may use <code>\realmarker</code> and <code>\fakemarker</code> to change your preference. The choice remains in effect until you change it again.</p> <p>The option real/fake applies wherever superscripts or subscripts are used, not just for footnotes or endnotes.</p> -<a id="a9.7.3"></a> -<h4>9.7.3 \footnote[<em>option</em>]{<em>text</em>}</h4> +<a id="a9.6.3"></a> +<h4>9.6.3 \footnote[<em>option</em>]{<em>text</em>}</h4> <p>The <code>\footnote{<em>text</em>}</code> command places a "marker" at the place where the command is written. The included text is written at the bottom of the page, beneath a short line that separates it from the main text. The footnote text is at smaller size and line skip, and has the same marker placed before it. All of this is automatic.</p> <p>You may, if necessary, apply some style to the footnote text. For example, if you are referring to another work, its title might be in italics.</p> <p>Normally, no option is used. If you use option <code>0</code> (zero) then no marker will appear in the main text, and the footnote text will appear without a marker. The count of markers is not incremented. This applies whether the markers are numbers or symbols.</p> @@ -523,23 +856,23 @@ Novelists of that era had so little to write about, unfortunately.\par -<a id="a9.8"></a> -<h3>9.8 Endnotes</h3> +<a id="a9.7"></a> +<h3>9.7 Endnotes</h3> <p>Endnotes are sometimes used in fiction, particularly for the kind of novel that pretends to be a lost manuscript, or the translation of an ancient text. The endnotes, by the fictional discoverer or translator, pretend to be an academic discussion of items in the main story. Unlike footnotes, which show quick points that must be immediately known by the reader during the story, endnotes are often a disguised chapter in themselves.</p> <p>You may use both footnotes and endnotes, if you wish. However, if endnotes are used, then footnotes must be marked by symbols, rather than by numbers, to avoid confusion. The counts for endnotes and footnotes are independent.</p> -<a id="a9.8.1"></a> -<h4>9.8.1 \endnote</h4> +<a id="a9.7.1"></a> +<h4>9.7.1 \endnote</h4> <p>The <code>\endnote</code> command inserts a superior number in the text. A running count of the numbers is automatically updated.</p> <p>The endnote numbers run continuously through the text, without reset. If you wish to reset the count (perhaps at new chapters), you have to do it manually, using <code>\ResetEndnote</code>. <p>When you use <code>\endnote</code> there is no provision for the actual note. If you wish to write a reminder to yourself, about why you put an endnote marker there, use <code>\memo{}</code>. The argument of <code>\memo</code> will not be printed, and will not be remembered for later use.</p> -<a id="a9.8.2"></a> -<h4>9.8.2 \endnotetext{<em>number</em>}{<em>text</em>}</h4> +<a id="a9.7.2"></a> +<h4>9.7.2 \endnotetext{<em>number</em>}{<em>text</em>}</h4> <p>The <code>\endnotetext</code> command is a simple way of styling endnotes. You do not have to use it, if you have your own method.</p> <p>The first argument is usually the endnote number. A period and following space will automatically be added, so that the text of the note is block-indented. You may use <code>\emph{<em>number</em>}</code> if you prefer the number to be in italics.</p> @@ -553,11 +886,11 @@ Novelists of that era had so little to write about, unfortunately.\par <p>Example:</p> <p class="code"> -<code> +<code><small> \endnotetext{9}{Yang Sho-Nuff was the twelfth son of the elder god of the ancient Who-Zit Clan, with power over the forces of rust.\par}<br/> \endnotetext{}{\indent However, since this was not yet the Iron Age, the terible might of Yang Sho-Nuff was largely unrecognized.\par}<br/> \endnotetext{10}{As Professor Withens notes in his treatise, \emph{When Sho-Nuff Was Not Enough}, the ceremony of daily human sacrifice had a devastating effect on the tribal population.\par} -</code></p> +</small></code></p> <p class="centerimg"><img src="html-resources/endnotetext.png" width="637" height="219" alt="using endnotetext"/></p> diff --git a/Master/texmf-dist/tex/lualatex/novel/novel-ChapterScene.sty b/Master/texmf-dist/tex/lualatex/novel/novel-ChapterScene.sty index 2ed0a50c957..bbecf3ce63a 100644 --- a/Master/texmf-dist/tex/lualatex/novel/novel-ChapterScene.sty +++ b/Master/texmf-dist/tex/lualatex/novel/novel-ChapterScene.sty @@ -13,7 +13,7 @@ %% %% \ProvidesFile{novel-ChapterScene.sty}% -[2017/03/09 v1.0.7 LaTeX file (chapter and scene macros)] +[2017/03/12 v1.0.8 LaTeX file (chapter and scene macros)] %% @@ -56,7 +56,7 @@ %% Repair \FirstLine{} command from `magaz' package. -% Problem: Conflict with \noindent\nov@AfterGroup as used in ChapterDisplay. +% Problem: Conflict with \noindent\nov@AfterGroup as used in ChapterStart. % The \noindent is carried past \FirstLine to the following paragraph. % Solution: After FirstLine completes, back up one line vertically, then insert % and empty line to restore grid and absorb the noindent. @@ -73,7 +73,7 @@ -%% ChapterDisplay environment. +%% ChapterStart environment. % The most useful way to start a new chapter. Occupies a fixed amount of % vertical space. Also self-adjust when used with dropfolio. Automatically % calls \thispagestyle if set for all chapter displays. @@ -82,13 +82,13 @@ \newif \if@csalignok \@csalignokfalse % % The argument is the number of normal baselineskips high: -\newenvironment{ChapterDisplay}[1][10] +\newenvironment{ChapterStart}[1][10] {% - \FPsub{\@fixlines}{#1}{3}% + \FPsub{\@fixlines}{#1}{2}% \FPsub{\@fixlines}{\@fixlines}{0.001}% fudge to avoid rounding problems - \if@thispagestyleset\else\thispagestyle{\@setchapterdisplay}\fi% - \ResetFootnoteSymbol% resets symbolic markers, but not numeric markers - \if@addCTline\null\else\fi% used with dropfolio + \if@thispagestyleset\else\thispagestyle{\@setchapterstart}\fi% + \ResetFootnoteSymbol% resets symbolic markers, but not numerical markers + \null% \setcounter{@linequarter}{0}% \begin{textblock*}{\textwidth}[0,0](0pt,0pt)% }{% @@ -106,10 +106,12 @@ }{\vspace{0.25\nbs}}{}% \end{textblock*}% \vspace{\@fixlines\nbs}% + \if@addCTline\null\fi% \nov@AfterGroup\NoIndentAfterThis% etextools and noindentafter } %% - +\LetLtxMacro\ChapterDisplay\ChapterStart\relax % deprecated +\LetLtxMacro\endChapterDisplay\endChapterStart\relax % deprecated % \newcommand\ChapterTitle[2][c]{% optional alignment l, c, r @@ -201,7 +203,7 @@ % the right edge of the Epigraph. % The text may be styled with the usual simple commands such as \emph{}. % There is no provision for a horizontal line. -% If used on a stand-alone page, or in the ChapterDisplay environment, +% If used on a stand-alone page, or in the ChapterStart environment, % then the vertical extent of the Epigraph does not much matter. % If mingled with main text (not recommended) you may have to correct % the line grid using some amount of \vspace{}. That's your problem. diff --git a/Master/texmf-dist/tex/lualatex/novel/novel-Footnotes.sty b/Master/texmf-dist/tex/lualatex/novel/novel-Footnotes.sty index 184678f513e..3457596f0f8 100644 --- a/Master/texmf-dist/tex/lualatex/novel/novel-Footnotes.sty +++ b/Master/texmf-dist/tex/lualatex/novel/novel-Footnotes.sty @@ -22,7 +22,7 @@ % In `novel' class, you may place footnotes at the botom of the textblock. % The markers may be symbolic (default begins with asterisk), or % set so that the asterisk is not used, or the markers may be numbers, -% If symbolic, they will be automatically reset by ChapterDisplay. +% If symbolic, they will be automatically reset by ChapterStart. % You can manually reset them at any time. % You can also make a non-marked footnote, which does not increment the count. diff --git a/Master/texmf-dist/tex/lualatex/novel/novel-HeadFootStyles.sty b/Master/texmf-dist/tex/lualatex/novel/novel-HeadFootStyles.sty index a37471d1611..356733fcefa 100644 --- a/Master/texmf-dist/tex/lualatex/novel/novel-HeadFootStyles.sty +++ b/Master/texmf-dist/tex/lualatex/novel/novel-HeadFootStyles.sty @@ -13,7 +13,7 @@ %% %% \ProvidesFile{novel-HeadFootStyles.sty}% -[2017/03/09 v1.0.7 LaTeX file (header and footer styles)] +[2017/03/12 v1.0.8 LaTeX file (header and footer styles)] %% @@ -276,8 +276,7 @@ % \@dropfolioinside reduces the textblock height by one lineskip. At the bottom, % where the last line would have been, the styled page number is centered. \newcommand\@dropfolioinside{% - \thispagestyle{empty}% - \enlargethispage{-\nbs} + \enlargethispage{-\nbs}% \setlength\temp@pgnumwidth{% \widthof{{\headfont\textls[\@looseheadnum]{\pagenumberstyle}}}}% \if@offcenterTrim% @@ -305,7 +304,6 @@ % \@dropfoliobeneath does not change the textblock height. The styled page % number is centered where an extra line would be, within the bottom margin. \newcommand\@dropfoliobeneath{% - \thispagestyle{empty}% \setlength\temp@pgnumwidth{% \widthof{{\headfont\textls[\@looseheadnum]{\pagenumberstyle}}}}% \if@offcenterTrim% diff --git a/Master/texmf-dist/tex/lualatex/novel/novel-LayoutSettings.sty b/Master/texmf-dist/tex/lualatex/novel/novel-LayoutSettings.sty index 8ab84227466..3536ba7cb6a 100644 --- a/Master/texmf-dist/tex/lualatex/novel/novel-LayoutSettings.sty +++ b/Master/texmf-dist/tex/lualatex/novel/novel-LayoutSettings.sty @@ -269,45 +269,45 @@ \fi } % end \@reserveHFspace % Each new chapter generally has its own header/footer style. This allows a -% default setting when chapters begin with ChapterDisplay environment: -\gdef\SetChapterDisplay#1{\gdef\@setchapterdisplay{#1}} -\SetChapterDisplay{footer} % default +% default setting when chapters begin with ChapterStart environment: +\gdef\SetChapterStart#1{\gdef\@setchapterstart{#1}} +\SetChapterStart{footer} % default \AtBeginDocument{% check if user wrote good command or not - \def\@setchapterdisplayOK{false}% - \ifthenelse{\equal{\@setchapterdisplay}{empty}}{% - \def\@setchapterdisplayOK{true}% + \def\@setchapterstartOK{false}% + \ifthenelse{\equal{\@setchapterstart}{empty}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{plain}}{% - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{plain}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{footer}}{% - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{footer}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{fancyplain}}{% - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{fancyplain}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{fancy}}{% - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{fancy}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{forcenumber}}{% - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{forcenumber}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{dropfolio}}{% no footnote there - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{dropfolio}}{% no footnote there + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{dropfoliolater}}{% has footnote(s) there - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{dropfoliolater}}{% has footnote(s) there + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplay}{foliobeneath}}{% - \def\@setchapterdisplayOK{true}% + \ifthenelse{\equal{\@setchapterstart}{foliobeneath}}{% + \def\@setchapterstartOK{true}% }{}% - \ifthenelse{\equal{\@setchapterdisplayOK}{true}}{}{% - \ClassError{novel}{\string\SetChapterDisplay\space bad argument}% - {\string\SetChapterDisplay\space only allows certain choices.^^J}% + \ifthenelse{\equal{\@setchapterstartOK}{true}}{}{% + \ClassError{novel}{\string\SetChapterStart\space bad argument}% + {\string\SetChapterStart\space only allows certain choices.^^J}% }% } % -%% End reserve space for header/footer and set default ChapterDisplay +%% End reserve space for header/footer and set default ChapterStart %% diff --git a/Master/texmf-dist/tex/lualatex/novel/novel-TextMacros.sty b/Master/texmf-dist/tex/lualatex/novel/novel-TextMacros.sty index ae0a0853088..7f47c520063 100644 --- a/Master/texmf-dist/tex/lualatex/novel/novel-TextMacros.sty +++ b/Master/texmf-dist/tex/lualatex/novel/novel-TextMacros.sty @@ -33,7 +33,7 @@ % \thesubtitle or \theSubtitle returns string set by \subtitle{} or \SetSubtitle{} -- See novel-LayoutSettings.sty. % \InlineImage, \BlockImage, \ClearImage -- See novel-Images.sty. % \scenebreak, \sceneline, \scenestars -- See novel-ChapterScene.sty. -% ChapterDisplay, \ChapterTitle{}, \ChapterSubtitle{}, \ChapterDeco{}, \ChapterText -- See novel-ChapterScene.sty. +% ChapterStart, \ChapterTitle{}, \ChapterSubtitle{}, \ChapterDeco{}, \ChapterText -- See novel-ChapterScene.sty. % \DecoChapterTitle{}{}, \SideDecoChapterTitle{}, ModernChapterTitle[]{}{} -- See novel-ChapterScene.sty. % {\chapterfont text} and other pre-defined font selection commands -- See novel-LayoutSettings.sty. % \decoglyph{} and \acronym{} -- See novel-FontDefaults.sty. |
