novel (22mar17)

git-svn-id: svn://tug.org/texlive/trunk@43575 c570f23f-e606-0410-a88d-b1316a301751
author: Karl Berry <karl@freefriends.org> 2017-03-22 21:56:20 +0000
committer: Karl Berry <karl@freefriends.org> 2017-03-22 21:56:20 +0000
commit: ae46a827762636210d21328b3c5a75b826924a1e (patch)
tree: 3ca985adeeb78ff035c139f928e8a442cbabb80b /Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html
parent: 9be209067b3b2ae9f128567279fffa136f353e7a (diff)
1 files changed, 72 insertions, 55 deletions
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 9b8eb5d5ea7..0a994b5678b 100644
--- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html
+++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html
@@ -1,9 +1,9 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
+<meta http-equiv="content-type" content="text/html; charset=UTF-8">
 <title>Class novel - 1 - Overview</title>
-<link rel="stylesheet" type="text/css" href="html-resources/novel-doc.css"/>
+<link rel="stylesheet" type="text/css" href="html-resources/novel-doc.css">
 </head>
 
 <body>
@@ -22,12 +22,13 @@
     <li><a href="#a1.1.1">1.1.1 Licensing</a></li>
     <li><a href="#a1.1.2">1.1.2 Installation</a></li>
     <li><a href="#a1.1.3">1.1.3 Credits</a></li>
+    <li><a href="#a1.1.4">1.1.4 Useful Tools</a></li>
   </ul></li><!-- end 1.1 -->
 <li><a href="#a1.2">1.2 Differences. Important!</a>
   <ul>
-    <li><a href="#a1.2.1">1.2.1 LuaLaTeX, fontspec,<br/><span style="visibility:hidden">1.2.1 </span>utf-8, Open Type</a></li>
+    <li><a href="#a1.2.1">1.2.1 LuaLaTeX, fontspec,<br><span style="visibility:hidden">1.2.1 </span>utf-8, Open Type</a></li>
     <li><a href="#a1.2.2">1.2.2 $ = dollar, not math mode</a></li>
-    <li><a href="#a1.2.3">1.2.3 TeX Size Commands<br/><span style="visibility:hidden">1.2.3 </span>Are Disabled</a></li>
+    <li><a href="#a1.2.3">1.2.3 TeX Size Commands<br><span style="visibility:hidden">1.2.3 </span>Are Disabled</a></li>
     <li><a href="#a1.2.4">1.2.4 Raster Images Only</a></li>
     <li><a href="#a1.2.5">1.2.5 Academic Structure Disabled</a></li>
     <li><a href="#a1.2.6">1.2.6 Think for Yourself</a></li>
@@ -48,10 +49,10 @@
     <li><a href="#a1.4.2">1.4.2 Main Matter</a></li>
     <li><a href="#a1.4.3">1.4.3 Back Matter</a></li>
   </ul></li><!-- end 1.4 -->
-<li><hr/></li>
+<li><hr></li>
 <li><a href="#a1.5">1.5 Command Summary: Preamble</a>
   <ul>
-    <li><a href="#a1.5.1">1.5.1 Class Options</a><br/>
+    <li><a href="#a1.5.1">1.5.1 Class Options</a><br>
       <ul>
         <li>draft, graytext, shademargins, cropmarks, cropview, closecrop, xml</li>
       </ul>
@@ -85,9 +86,9 @@
         <li>\frontmatter, \mainmatter, \backmatter</li>
       </ul>
     </li>
-    <li><a href="#a1.6.2">1.6.2 Display Pages</a>
+    <li><a href="#a1.6.2">1.6.2 Special Pages</a>
       <ul>
-        <li>\begin{legalese}, \begin{toc}, \tocitem, \begin{ChapterDisplay}, \ChapterTitle, \ChapterSubtitle, \ChapterDeco, \thispagestyle, \FirstLine, \clearpage</li>
+        <li>\begin{legalese}, \begin{toc}, \tocitem, \begin{ChapterStart}, \ChapterTitle, \ChapterSubtitle, \ChapterDeco, \thispagestyle, \FirstLine, \clearpage</li>
       </ul>
     </li>
     <li><a href="#a1.6.3">1.6.3 Block-Level Breaks and Styling</a>
@@ -138,7 +139,7 @@
 <div id="main">
 <a id="thetop"></a>
 <h1>Documentation for <code>novel</code> document class</h1>
-<p>Documentation version: 1.0.7.</p>
+<p>Documentation version: 1.0.9.</p>
 
 <div class="pagetopage">
 <p><b>User Guide</b></p>
@@ -147,11 +148,11 @@
 <p><a href="noveldocs-03-metadata-pdfx.html">3. Metadata, PDF/X</a></p>
 <p><a href="noveldocs-04-layout.html">4. Page Layout</a></p>
 <p><a href="noveldocs-05-fonts.html">5. Choosing Fonts</a></p>
-<p><a href="noveldocs-06-header-footer.html">6. Headers, Footers</a><br/>
+<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. Display, Start Pages;<br/>
-<span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br/>
+<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>
 
@@ -178,27 +179,39 @@
 
 <p>If you are ready to typeset your great detective novel, or your collection of sci-fi short stories, then <code>novel</code> is for you.</p>
 
-
+<a id="a1.1.1"></a>
 <h4>1.1.1 Licensing</h4>
 
 <p>The <code>novel</code> document class, including software, examples, documentation and supporting images, is distributed under the terms of the LaTeX Project Publc License, either version 1.3c of this license or (at your option) any later version. The exception is the included font NovelDeco.otf, which is distributed under terms of the SIL Open Font License, v.1.1. Small portions of the software use code placed on the Internet under terms of Creative Commons 3.0-by-sa license; attributions are provided at the places where such code is used.</p>
 <p>To ensure that your book may be sold commercially, be careful to use only fonts that allow commercial usage. That may exclude some of the fonts in the LaTeX font catalog.</p>
 
-
+<a id="a1.1.2"></a>
 <h4>1.1.2 Installation</h4>
 
-<p>Unless and until <code>novel</code> becomes part of TeX distributions, it must be manually installed in a "local" or "home" TeX directory. If obtained as a single compressed archive, the internal folder tree is already in correct configuration.</p>
-<p>Fonts from the <code>libertinus</code> package are required. They may be obtained through your TeX distribution. Note that neither <code>\RequirePackage{libertinus}</code> nor <code>\usepackage{libertinus}</code> will be effective. You must obtain and install the fonts yourself, or manually through your distribution's package manager.</p>
-<p>Depending on how you obtain the files, you may need to update the file name database. In TeXlive, try command line <code>mktexlsr</code>. In MiKTeX, use the <code>Options &gt; Update FNDB</code> button.</p>
-<p>Since you will be using LuaTeX, the font cache will be updated to include the newly-installed fonts, the next time you run this software. However, I recommend that you force a full cache refresh, by locating the <code>luatex-cache</code> directory, and discard its contents. The cache may be anywhere (sadly), so you will have to hunt for it. If you have never used LuaTeX before, it may not exist. If there are any updates to the fonts, then a manual cache refresh is necessary.</p>
+<p>Your TeX installation must be based on TeXLive 2016 or later. This is the case if you have manually installed TeXLive directly from its site, or if you are using MiKTeX. However, if you are on Linux and your distro is not the latest and greatest, the distribution may be based on TeXLive 2015 or earlier. Then, you will not be able to use <code>novel</code>.
 
+<p>The TeX code will be placed in (texroot)/tex/lualatex/novel/, the custom font will be placed in (texroot)/fonts/opentype/novel/, and the documentation will be placed in (texroot)/doc/lualatex/novel/.</p>
 
+<p>The <code>novel</code> class can now be installed like any other TeX package, through your distribution's package manager. The installation will provide the code, documentation, and a custom font.</p>
+
+<p>Fonts from the <code>libertinus</code> package are required, and may be installed via your TeX package manager. Note that a <code>novel</code> document does not request the package! Instead, if you have not manually specified which fonts to use, it will automatically look for pre-installed libertinus fonts (or Linux Libertine O) as defaults.</p>
+
+<p>Since you will be using LuaTeX, the font cache will be updated to include the newly-installed fonts, the next time you run this software. However, I recommend that you force a full cache refresh, by locating the <code>luatex-cache</code> directory, and discard its contents. The cache may be anywhere (sadly), so you will have to hunt for it. If you have never used LuaTeX before, it may not exist. If there are any updates to the fonts, then a manual cache refresh is necessary.</p>
+
+<a id="a1.1.3"></a>
 <h4>1.1.3 Credits</h4>
 
 <p>My method of "programming" (note the scare quotes) largely involves looking for solutions on the Internet, then using or modifying code provided by others with allowable license terms. Thus, within the TeX code files, you will find places where small or large pieces of code are the work of someone else, released by them for LaTeX purposes. Names or organizations are credited where the code is used.</p>
 <p>Various clipart graphics were obtained from openclipart.org. The NovelDeco.otf font is partly derived from [Linux] Libertine O, using FontForge.</p>
 
+<a id="a1.1.4"></a>
+<h4>1.1.4 Useful Tools</h4>
+
+<p>Before sending your PDF file anywhere, you should always open it in Adobe Reader, and inspect it. If you are on a system that does not have that software, then find a friend who has it. The reason is that some other PDF readers will not object to problem files, but Adobe Reader will complain.</p>
+
+<p>In commercial printing, it is not necessary that your file be "optimized for fast web view" or "linearized." Nevertheless, some services do a lot of work with e-books, and may request that printer files be optimized or linearized, out of force of habit. The free <code>qpdf</code> command-line tool, available for Linux and Windows, is your friend.</p>
 
+<p>Your PDF cannot be encrypted or password-protected for commercial printing. Only you and the printer are supposed to see it. So, it is always possible to extract the text, not as a TeX document, but as plain text. Adobe Reader probably will not do what you expect. Adobe Acrobat Pro does a good job, if you first "add tags" via its accessibility features. Otherwise, the free Okular PDF reader does a reasonable job, as does the <code>pdftotext</code> command-line program (part of <code>xpdf</code>. Be sure to request that layout be preserved. You may need to review the exported text for words that were broken by hyphenation, and re-assemble the words.</p>
 
 
 
@@ -207,11 +220,13 @@
 
 <p>There are several ways that <code>novel</code> is very different from other TeX document classes. Before you wonder why your document doesn't work, you need to understand the differences. All of these are features, not bugs. They are done with the intent of making <code>novel</code> best for its intended purpose.</p>
 
+<p><b>About TeX editors:</b> If you usually use a TeX editor GUI, such as Lyx or TeXstudio, avoid using it with the <code>novel</code> class. Those editors are capable of inserting standard LaTeX code from menus. However, <code>novel</code> does not necessarily use that standard LaTeX code. The result may be unexpected. Instead, create your document in an ordinary ut-8 plain text editor, and compile with <code>lualatex</code> from the command line. Or, you can use the TeXWorks editor, as long as you turn off features such as automatic smart quotes.</p>
+
 
 <a id="a1.2.1"></a>
 <h4>1.2.1 LuaLaTeX, fontspec, utf-8, and Open Type fonts</h4>
 
-<p><img class="floatright" src="html-resources/doordie.png" width="279" height="300" alt="Thou Shalt"/> With <code>novel</code>, you will be using the LuaLaTeX engine, whether you like it or not. No pdfTeX, no XeTeX, no dvips. You do not have to understand Lua code, since the heavy lifting is already done for you.</p>
+<p><img class="floatright" src="html-resources/doordie.png" width="279" height="300" alt="Thou Shalt"> With <code>novel</code>, you will be using the LuaLaTeX engine, whether you like it or not. No pdfTeX, no XeTeX, no dvips. You do not have to understand Lua code, since the heavy lifting is already done for you.</p>
 <p>Forget about <code>fontenc</code> and <code>OT1</code> and other TeX exotica that go so far back in time, most folks did not have a cell phone. The built-in <code>fontspec</code> package handles modern Open Type fonts, and is able to access their internal features. The syntax is easy to learn, and very powerful. And, you can directly include text with diacritical marks, Greek, Cyrillic, and most other utf-8 encoded characters in your document. All you need are the fonts. You will wonder why you never did this before. The method for loading fonts is described on Page 5.</p>
 <p>You must use utf-8 (Unicode) encoding in all parts of your code and document. No choice. Only utf-8, without BOM. Instead of typing TeX codes such as <code>\`{e}</code> you can simply paste <code>&egrave;</code> from a Unicode character map. Other alphabets such as Greek and Cyrillic are directly supported, if your fonts support those character sets.</p>
 <p>Be sure that your editor uses utf-8 encoding without BOM. If you are on Linux (and presumably OS/X) then this is the default for your system. If you are on Windows, do not use Notepad! The free Notepad++ program (also Portable version) does the job. Configure it as specified.</p>
@@ -220,7 +235,7 @@
 <a id="a1.2.2"></a>
 <h4 style="clear:both">1.2.2 A dollar is a dollar, not math mode</h4>
 
-<p><img class="floatright" src="html-resources/trdol.png" width="238" height="67" alt="a dollar is a dollar"/> When you type <code>$</code> in the document body, with or without a preceding backslash, <em>you do not enter or leave math mode</em>. What you get is the dollar symbol. This has no effect in the Preamble, where the dollar sign has its usual TeX special meaning.</p>
+<p><img class="floatright" src="html-resources/trdol.png" width="238" height="67" alt="a dollar is a dollar"> When you type <code>$</code> in the document body, with or without a preceding backslash, <em>you do not enter or leave math mode</em>. What you get is the dollar symbol. This has no effect in the Preamble, where the dollar sign has its usual TeX special meaning.</p>
 <p>If you really need math mode, you can use <code>\(</code> ... <code>\)</code>. But, why? You are writing a novel, yes? You shouldn't need math mode.</p>
 
 
@@ -241,7 +256,7 @@
 <a id="a1.2.5"></a>
 <h4>1.2.5 Numerous academic-purpose commands are disabled</h4>
 
-<p><img class="floatright" src="html-resources/fpaper.png" width="134" height="215" alt="flunked math"/> Commands such as <code>\section</code>, <code>\chapter</code>, <code>\abstract</code>, <code>\index</code>, <code>\tableofcontents</code>, <code>\maketitle</code>, and many other structural commands will not work with <code>novel</code>. Those are for academic papers. The results they would produce (if enabled) would be inappropriate for fiction. If you attempt to use them, you will either get an error message, or they will simply be ignored.</p>
+<p><img class="floatright" src="html-resources/fpaper.png" width="134" height="215" alt="flunked math"> Commands such as <code>\section</code>, <code>\chapter</code>, <code>\abstract</code>, <code>\index</code>, <code>\tableofcontents</code>, <code>\maketitle</code>, and many other structural commands will not work with <code>novel</code>. Those are for academic papers. The results they would produce (if enabled) would be inappropriate for fiction. If you attempt to use them, you will either get an error message, or they will simply be ignored.</p>
 <p>Novelists do not need many ways to distinguish chapters. With <code>novel</code> there are commands specifically created for the needs of fictional works. They are described on <a href="noveldocs-09-chapters-displays.html#a9.5">Page 9</a>.</p>
 <p>Also, the <code>float</code> and <code>table</code> environments are ineffective.</p>
 
@@ -271,7 +286,7 @@
 
 <p>A <b>sheet</b> of paper is a single, physical piece of paper, regardless of whether anything is printed on it, or where. Often, paper starts out as a large sheet that will subsequently be cut into smaller sheets. The size doesn't matter. A sheet of paper is, in ordinary understanding, a piece of paper.</p>
 
-<p><img class="floatright" src="html-resources/page-leaf.png" width="490" height="155" alt="page, leaf"/> In a finished book, a <b>page</b> is one side of a <b>leaf</b>. Thus, there are always exacttly twice as many pages are there are leaves. From the manufacturer's point of view, a 240-page (double-sided printing) book has 120 leaves, regardless of whether or not anything is printed on the pages, or how they are numbered.</p>
+<p><img class="floatright" src="html-resources/page-leaf.png" width="490" height="155" alt="page, leaf"> In a finished book, a <b>page</b> is one side of a <b>leaf</b>. Thus, there are always exacttly twice as many pages are there are leaves. From the manufacturer's point of view, a 240-page (double-sided printing) book has 120 leaves, regardless of whether or not anything is printed on the pages, or how they are numbered.</p>
 
 <p>If you take a sheet of 8.5" x 11" paper, and fold it in half across its width, you create a <b>folio</b>, consisting of one sheet of paper (as before), two leaves (previously one), and four pages (previously two), sized 5.5" x 8.5". Now, think about how those four pages must be numbered. Page 1 and page 4 are printed on the same side of the sheet, with pages 2 and 3 on the opposite side of the sheet. This is not the order they would be printed, if you were merely shrinking the text so that twice as much fit on one side of the sheet. The process of re-arranging the pages, and placing them in the correct positions (often involving rotation) is called <b>imposition</b>. Your home printer can do it, for the simple example described. But in the case of commercial book preparation, the imposition process is much more involved, and uses advanced software.</p>
 
@@ -281,13 +296,13 @@
 <a id="a1.3.2"></a>
 <h4>1.3.2 Page Spread, Recto, Verso, Line Grid</h4>
 
-<p><img class="floatright" src="html-resources/linegrid.png" width="303" height="234" alt="line grid"/> When a book is opened somewhere in its middle, you see a <b>page spread</b>. At right is the <b>recto</b> odd-numbered page, and at left is the <b>verso</b> even-numbered page. With continuous text, the lines of text on the verso must be in the same vertical position as the lines of text on the recto, and each line must be equally spaced. This is the <b>line grid</b>. Maintaining a proper line grid is essential to the <code>novel</code> class, and is why some <code>novel</code> commands differ from how they are used in academic works with other document classes.</p>
+<p><img class="floatright" src="html-resources/linegrid.png" width="303" height="234" alt="line grid"> When a book is opened somewhere in its middle, you see a <b>page spread</b>. At right is the <b>recto</b> odd-numbered page, and at left is the <b>verso</b> even-numbered page. With continuous text, the lines of text on the verso must be in the same vertical position as the lines of text on the recto, and each line must be equally spaced. This is the <b>line grid</b>. Maintaining a proper line grid is essential to the <code>novel</code> class, and is why some <code>novel</code> commands differ from how they are used in academic works with other document classes.</p>
 
 
 <a id="a1.3.3"></a>
 <h4>1.3.3 Perfect Binding, Spine, Signature</h4>
 
-<p><img class="floatright" src="html-resources/perfectbinding.png" width="160" height="290" alt="perfect binding"/> Most modern softcover books (and some inexpensive hardcovers) are manufactured using a process named <b>Perfect Binding</b>. The finished book has individual foils, glued together at the <b>spine</b>. There are several stages to the process. First, the books is subdivided into a number of <b>signatures</b>, each of which is a group of folios (typically 6). The imposition software calculates which page goes at which position on each folio, and also tweaks the positions to allow for the slight displacement of each folio, due to paper thickness. In each signature, the folios are like nested V. The signatures are clamped together in a block. Then the folded area is removed by a machine, so that there are no longer any signatures or folios, just individual leaves. Finally they are glued together, possibly with a reinforcement, and the cover is attached.</p>
+<p><img class="floatright" src="html-resources/perfectbinding.png" width="160" height="290" alt="perfect binding"> Most modern softcover books (and some inexpensive hardcovers) are manufactured using a process named <b>Perfect Binding</b>. The finished book has individual foils, glued together at the <b>spine</b>. There are several stages to the process. First, the books is subdivided into a number of <b>signatures</b>, each of which is a group of folios (typically 6). The imposition software calculates which page goes at which position on each folio, and also tweaks the positions to allow for the slight displacement of each folio, due to paper thickness. In each signature, the folios are like nested V. The signatures are clamped together in a block. Then the folded area is removed by a machine, so that there are no longer any signatures or folios, just individual leaves. Finally they are glued together, possibly with a reinforcement, and the cover is attached.</p>
 
 <p>If you order your book in hardcover, it is likely to use the same production method, but with harder covers. So, don't think that your hadcover book will be like the expensive reference books you see in the library. Those books use a different, and much more expensive, binding method.</p>
 
@@ -295,14 +310,14 @@
 <a id="a1.3.4"></a>
 <h4>1.3.4 Gutter</h4>
 
-<p><img class="floatright" src="html-resources/whichgutter.png" width="276" height="219" alt="perfect binding"/> To allow for the fact that most binding cannot be opened flat, the spine edge of each page must have an allowance for the loss of visible area there. The word <b>gutter</b> is used in this context.</p>
+<p><img class="floatright" src="html-resources/whichgutter.png" width="276" height="219" alt="perfect binding"> To allow for the fact that most binding cannot be opened flat, the spine edge of each page must have an allowance for the loss of visible area there. The word <b>gutter</b> is used in this context.</p>
 <p>Alas, some folks use <em>gutter</em> to mean the extra allowance for each page; others use it to mean the combined allowance for a two-page spread; and others use it to mean the full spine-side margin from the text, which is a larger value. So if you read about the gutter from different sources, the numbers may not make sense, because the word is being used with different meanings. It could be any of A, B, C, or D in the accompanying diagram. I won't be using the term, except indirectly.</p>
 
 
 <a id="a1.3.5"></a>
 <h4>1.3.5 Trim Size</h4>
 
-<p><img class="floatright" src="html-resources/tbrectomar.png" width="144" height="223" alt="trim size recto"/> <b>Trim Size</b> is the finished size of your book, width and height (but not thickness). In the case of hardcover books, where the cover is larger than the contents, it is (usually) the cover size that is measured, with the internal trim size being slightly smaller than nominal</p>
+<p><img class="floatright" src="html-resources/tbrectomar.png" width="144" height="223" alt="trim size recto"> <b>Trim Size</b> is the finished size of your book, width and height (but not thickness). In the case of hardcover books, where the cover is larger than the contents, it is (usually) the cover size that is measured, with the internal trim size being slightly smaller than nominal</p>
 
 <p>In the USA, 5.5" x 8.5" is often used for softcover fiction. This is the default setting in <code>novel</code>. It seems to be the case that nonfiction prefers the slightly larger 6" x 9" trim size. Both of these are known as "trade" sizes.</p>
 
@@ -314,7 +329,7 @@
 <a id="a1.3.6"></a>
 <h4>1.3.6 Media Size, TrimBox</h4>
 
-<p style="clear:both"><img class="floatright" src="html-resources/mbcrectomar.png" width="202" height="264" alt="media size recto"/> In a few cases, the commercial printer will request that the PDF page size be something larger than the Trim Size of your book. In PDF terminology, the larger dimensions are the <b>Media Size</b>. Typically, the Media Size will be U.S. Letter, or A4, and the Trim Size must be floated in the center, horizontally and vertically. As an alternative, the Trim Size will be at the edge. Something of the sort happens when you print a copy of your PDF at home, where your printer's paper tray has letter or A4, not the Trim Size.</p>
+<p style="clear:both"><img class="floatright" src="html-resources/mbcrectomar.png" width="202" height="264" alt="media size recto"> In a few cases, the commercial printer will request that the PDF page size be something larger than the Trim Size of your book. In PDF terminology, the larger dimensions are the <b>Media Size</b>. Typically, the Media Size will be U.S. Letter, or A4, and the Trim Size must be floated in the center, horizontally and vertically. As an alternative, the Trim Size will be at the edge. Something of the sort happens when you print a copy of your PDF at home, where your printer's paper tray has letter or A4, not the Trim Size.</p>
 <p>Do not use a Media Size larger than the Trim Size, unless the commercial printer requests it.</p>
 <p>Since your PDF is being prepared for commercial print production, it will have an invisible <code>TrimBox</code> automatically encoded. This information tell the printer where the Trim Size is located. If (as usual) the Trim Size and Media Size are identical, then the TrimBox is the full size of the PDF page. But when the Trim Size is smaller than the Media Size, the TrimBox defines where the paper will be trimmed. Although it is not normally marked on the PDF page and never appears in print, some PDF viewers allow you make the TrimBox visible.</p>
 <p>In the accompanying diagram, the TrimBox is shown as a green line. The margins, shaded gray, are measured relative to the Trim Size, not relative to the Media Size. The excess area beyond the Trim Size is "wasted paper" that will not become part of the book.</p>
@@ -472,10 +487,10 @@
 <p>Default: off (no compliance set)</p>
 <p>PDF/X describes a set of industry standards for print-ready PDF files. Your print service will probably require you to use it.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetApplication{<em>software that created the source document</em>}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetApplication{<em>software that created the source document</em>}</pre>
 <p>Default: an identifying string, automatically inserted by TeX.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetProducer{<em>software that compiled the PDF</em>}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetProducer{<em>software that compiled the PDF</em>}</pre>
 <p>Default: an identifying string, automatically inserted by TeX.</p>
 
 
@@ -514,19 +529,19 @@
 <p>Default: Calculated automatically from other layout settings.</p>
 <p>Main text, not including header/footer. Note than baseline skip (leading) is always calculated, not set by user.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetMediaSize[alignment]{width}{height}</pre> 
+<pre class="noindentcmd">Advanced:<br>\SetMediaSize[alignment]{width}{height}</pre> 
 <p>Default: Identical to Trim Size.</p>
 <p>When Trim Size is on larger Media Size.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetCropmarkGap{<em>size of gap</em>}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetCropmarkGap{<em>size of gap</em>}</pre>
 <p>Default: <code>0.125in</code> (only effective with cropmarks class option)</p>
 <p>Sets gap between TrimBox and cropmarks, when cropmarks are used.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\ReworkTrimSize{width}{height}</pre>
+<pre class="noindentcmd">Advanced:<br>\ReworkTrimSize{width}{height}</pre>
 <p>For emergency use only.</p>
 <p>Re-sizes an already-finished layout.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\ReworkMargins{top}{outside}{bottom}{inside}</pre>
+<pre class="noindentcmd">Advanced:<br>\ReworkMargins{top}{outside}{bottom}{inside}</pre>
 <p>For emergency use only.</p>
 <p>Re-sizes an already-finished layout.</p>
 
@@ -558,21 +573,21 @@
 <p>Default: <code>[Numbers=Lining, Scale=1.2]{*}</code></p>
 <p>Used in <code>\ChapterSubtitle{}</code> command.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetDecoFont[features]{font}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetDecoFont[features]{font}</pre>
 <p>Default: <code>NovelDeco</code> (any setting must used a derivative of NovelDeco)</p>
 <p>Automatically applied as <code>{\decofont...}</code> by certain other commands.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetSansFont[features]{font family}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetSansFont[features]{font family}</pre>
 <p>Default: <code>Libertinus Sans</code></p>
 <p>Alternate: <code>Linux Biolinum O</code></p>
 <p>Rarely used in fiction.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetMonoFont[features]{font family}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetMonoFont[features]{font family}</pre>
 <p>Default: <code>Libertinus Mono</code></p>
 <p>Alternate: <code>Linux Libertine Mono O</code></p>
 <p>Rarely used in fiction.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\NewFontFamily\<i>yourfontcommand</i>[features]{font family}</pre>
+<pre class="noindentcmd">Advanced:<br>\NewFontFamily\<i>yourfontcommand</i>[features]{font family}</pre>
 <pre class="noindentcmd2">\NewFontFace\<i>yourfontcommand</i>[features]{font}</pre>
 <p>These use <em>fontspec</em> to define your own font commands.</p>
 
@@ -590,15 +605,15 @@
 <p>Default: Adjusted author, in small caps</p>
 <p>The text appears in verso headers, if the page style has headers. This command may also be used from time to time in the document body.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetEmblems{<em>verso</em>}{<em>recto</em>}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetEmblems{<em>verso</em>}{<em>recto</em>}</pre>
 <p>Default: both empty</p>
 <p>Applies a decoration (emblem) near the page number. Only for selected header/footer styles.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetPageNumberStyle{<em>code using \thepage</em>}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetPageNumberStyle{<em>code using \thepage</em>}</pre>
 <p>Default: <code>\thepage</code></p>
 <p>Allows page number to be styled (such as italics).</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetLooseHead{number}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetLooseHead{number}</pre>
 <p>Default: <code>50</code></p>
 <p>Tweaks tracking of header text, 0 to 200.</p>
 
@@ -606,19 +621,19 @@
 <p>Default: <code>footer</code> (no header, footer only if used)</p>
 <p>Sets the default page style for the start of new chapters. May be locally changed.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetIndentAfterScenebreak</pre>
+<pre class="noindentcmd">Advanced:<br>\SetIndentAfterScenebreak</pre>
 <p>Default: unset (new scenes do not begin with indent)</p>
 <p>If set, new scenes start with paragraph indent.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\SetMarkerStyle[real/fake]{asterisk/dagger/number}</pre>
+<pre class="noindentcmd">Advanced:<br>\SetMarkerStyle[real/fake]{asterisk/dagger/number}</pre>
 <p>Default: <code>[real]{asterisk}</code>
 <p>Used for superscripts, subscripts, footnote markers.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\microtypesetup{<em>see microtype package docs</em>}</pre>
+<pre class="noindentcmd">Advanced:<br>\microtypesetup{<em>see microtype package docs</em>}</pre>
 <p>Default: <code>config=novel-microtype,stretch=20,shrink=20,final,tracking</code></p>
 <p>Defaults are set for moderate typography suited to fiction. Options <code>final,tracking</code> will always be in effect.</p>
 
-<pre class="noindentcmd">Advanced:<br/>\setmainlanguage{<em>language</em>} and related commands</pre>
+<pre class="noindentcmd">Advanced:<br>\setmainlanguage{<em>language</em>} and related commands</pre>
 <p>Default: <code>english</code></p>
 <p>Several commands from the <code>polyglossia</code> package may be used for language choices.</p>
 
@@ -646,9 +661,8 @@
 
 
 <a id="a1.6.2"></a>
-<h4>1.6.2 Display Pages</h4>
+<h4>1.6.2 Special Pages</h4>
 
-<p>A <em>display page</em> is one that either stands by itself (such as the book's copyright page), or provides a distinctive opening to new content (such as a chapter title page). In other words, a display page is one that does not merely contain the continuation of flowing text.</p>
 
 <pre class="noindentcmd">\begin{legalese} <em>...</em> \end{legalese}</pre>
 <p>Changes text alignment to left (ragged right), and disables hyphenation. Useful for copyright page. See also <code>parascale</code> environment.</p>
@@ -659,7 +673,7 @@
 <pre class="noindentcmd">\tocitem[<em>number</em>]{<em>title</em>}{<em>page</em>}</pre>
 <p>Item, such as chapter, in the toc environment.</p>
 
-<pre class="noindentcmd">\begin{ChapterDisplay}[<em>line count</em>] <em>...</em> \end{ChapterDisplay}</pre>
+<pre class="noindentcmd">\begin{ChapterStart}[<em>line count</em>] <em>...</em> \end{ChapterStart}</pre>
 <p>Creates an area of fixed height, into which items such as <code>\ChapterTitle</code> may be placed.</p>
 
 <pre class="noindentcmd">\ChapterTitle{<em>text</em>}</pre>
@@ -711,14 +725,14 @@
 <pre class="noindentcmd">\endnotetext{<em>number</em>}{<em>note text</em>}</pre>
 <p>Write the endnote text.</p>
 
-<pre class="noindentcmd">\realmarker<br/>\fakemarker</pre>
+<pre class="noindentcmd">\realmarker<br>\fakemarker</pre>
 <p>Changes whether marker style is real or fake.</p>
 
 
 <a id="a1.6.5"></a>
 <h4>1.6.5 Images</h4>
 
-<pre class="noindentcmd">\InlineImage[<em>hoffset</em>][<em>voffset</em>]{<em>filename.ext</em>}<br/>\InlineImage*[<em>hoffset</em>][<em>voffset</em>]{<em>filename.ext</em>}</pre>
+<pre class="noindentcmd">\InlineImage[<em>hoffset</em>][<em>voffset</em>]{<em>filename.ext</em>}<br>\InlineImage*[<em>hoffset</em>][<em>voffset</em>]{<em>filename.ext</em>}</pre>
 <p>Places an image that may be mingled in-line with text.</p>
 
 <pre class="noindentcmd">\BlockImage[<em>alignment,hoffset,voffset</em>]{<em>filename.ext</em>}[<em>accompanying text</em>]</pre>
@@ -737,7 +751,7 @@
 <p>Applies the font defined as <code>\somefontcommand</code> to the included text.</p>
 <p>Example: <code>{\headfont <em>text</em>}</code> is automatically used for headers/footers.</p>
 
-<pre class="noindentcmd">\forceindent<br/>\backindent</pre>
+<pre class="noindentcmd">\forceindent<br>\backindent</pre>
 <p>May be used in situations where ordinary <code>\indent</code> or <code>\noindent</code> fail.</p>
 
 <pre class="noindentcmd">\hangindent{<em>text</em>}</pre>
@@ -749,10 +763,10 @@
 <pre class="noindentcmd">\decoglyph{}</pre>
 <p>Selects a decorative glyph from the decofont. Glyphs are chosen from a code table.</p>
 
-<pre class="noindentcmd">\squeeze{<em>text</em>}<br/>\crush{<em>text</em>}</pre>
+<pre class="noindentcmd">\squeeze{<em>text</em>}<br>\crush{<em>text</em>}</pre>
 <p>Horizontally shrinks text by 1% or 2%, respectively.</p>
 
-<pre class="noindentcmd">\color[<em>gray</em>]{<em>name or code</em>} <em>... until group ends</em><br/>\textcolor[<em>gray</em>]{<em>name or code</em>}{<em>text</em>}</pre>
+<pre class="noindentcmd">\color[<em>gray</em>]{<em>name or code</em>} <em>... until group ends</em><br>\textcolor[<em>gray</em>]{<em>name or code</em>}{<em>text</em>}</pre>
 <p>These commands from package <code>xcolor</code> have been modified so that they will only accept grayscale, and only when the <code>graytext</code> class option is used. Otherwise, K black is produced. Images are unaffected.</p>
 
 <pre class="noindentcmd">\memo{<em>text</em>}</pre>
@@ -761,7 +775,7 @@
 <pre class="noindentcmd">$ (dollar symbol)</pre>
 <p>In document body: <code>$</code> means dollar, not math mode.</p>
 
-<pre class="noindentcmd">\nfs<br/>\nbs</pre>
+<pre class="noindentcmd">\nfs<br>\nbs</pre>
 <p>These are abbreviations for the lengths <em>normal font size</em> and <em>normal baseline skip</em>.</p>
 
 
@@ -770,6 +784,9 @@
 
 <p>These commands are defined by LaTeX or by a package that is automatically loaded with <code>novel</code>, or are standard commands given an alias for convenience. There are many other LaTeX commands that may be used, but these are most likely to be useful. Most of these are not documented by <code>novel</code>, since their usage is well-known.</p>
 
+<pre class="noindentcmd">\textit{<em>text</em>}, \emph{<em>text</em>}, \itshape{<em>text</em>}</pre>
+<p>Various ways to implement italics.</p>
+
 <pre class="noindentcmd">\textsc{<em>text</em>}, \smcp{<em>text</em>}</pre>
 <p>Lowercase to small caps. Novel uses the <code>smcp</code> Open Type feature, and does not fake small caps.</p>
 
@@ -843,7 +860,7 @@
 <pre class="noindentcmd">\maketitle</pre>
 <p>Sorry, but you have to do it yourself.</p>
 
-<pre class="noindentcmd">bibliography, index, etc.<br/>part, chapter, section, etc.<br/>floats, captions, tables</pre>
+<pre class="noindentcmd">bibliography, index, etc.<br>part, chapter, section, etc.<br>floats, captions, tables</pre>
 <p>This ain't no stinking thesis. LaTeX "academic layout" commands don't work.</p>
 
 
@@ -853,7 +870,7 @@
 <p>These commands may be used, but are likely to interfere with other commands defined by <code>novel</code>, or are likely to disturb the constant baseline grid. Only use them when you are willing to carefully inspect the output at magnification. These are less likely to be problematic when used on a display-only page, such as the book's title page.</p>
 <p>This is not a comprehensive list. It includes only popular commands.</p>
 
-<pre class="noindentcmd">\parbox<br/>\minipage</pre>
+<pre class="noindentcmd">\parbox<br>\minipage</pre>
 <p>Perhaps the <code>adjustwidth</code> environment will sui your needs.</p>
 
 <pre class="noindentcmd">center environment</pre>
author	Karl Berry <karl@freefriends.org>	2017-03-22 21:56:20 +0000
committer	Karl Berry <karl@freefriends.org>	2017-03-22 21:56:20 +0000
commit	ae46a827762636210d21328b3c5a75b826924a1e (patch)
tree	3ca985adeeb78ff035c139f928e8a442cbabb80b /Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html
parent	9be209067b3b2ae9f128567279fffa136f353e7a (diff)