summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex/novel/novel-documentation.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/novel/novel-documentation.html')
-rw-r--r--Master/texmf-dist/doc/lualatex/novel/novel-documentation.html166
1 files changed, 56 insertions, 110 deletions
diff --git a/Master/texmf-dist/doc/lualatex/novel/novel-documentation.html b/Master/texmf-dist/doc/lualatex/novel/novel-documentation.html
index c2f454e47a8..8493194b5c9 100644
--- a/Master/texmf-dist/doc/lualatex/novel/novel-documentation.html
+++ b/Master/texmf-dist/doc/lualatex/novel/novel-documentation.html
@@ -170,7 +170,7 @@ function closeall() {
<ul id="u1.1">
<li><a href="#h1.1.1">1.1.1 LuaLateX Compiler</a></li>
<li><a href="#h1.1.2">1.1.2 UTF-8 Encoding</a></li>
- <li><a href="#h1.1.3">1.1.3 Polyglossia</a></li>
+ <li><a href="#h1.1.3">1.1.3 Language Support</a></li>
<li><a href="#h1.1.4">1.1.4 Open Type Fonts</a></li>
<li><a href="#h1.1.5">1.1.5 Book Design</a></li>
</ul>
@@ -203,6 +203,7 @@ function closeall() {
<li><a href="#h2.7">2.7 xml</a></li>
<li><a href="#h2.8">2.8 coverart</a></li>
<li><a href="#h2.9">2.9 developer options</a></li>
+ <li><a href="#h2.10">2.10 revert</a></li>
</ul>
</li><!-- end 2 -->
@@ -565,18 +566,20 @@ function closeall() {
<div id="main">
<!-- **************************************************************************************** -->
-<h1 id="h0" style="padding-top:16px">Document class <i>novel</i> - documentation. &nbsp; <span style="font-size:75%">V. 1.52, 2018/04/26</span></h1>
+<h1 id="h0" style="padding-top:16px">Document class <i>novel</i> - documentation. &nbsp; <span style="font-size:75%">V. 1.80, 2023/02/08</span></h1>
<p class="noindent"><span id="screennoscript" class="screennoscript"><b>For enhanced navigation of this file, turn on JavaScript.</b></span></p>
<div><script>if(document.getElementById("screennoscript")){document.getElementById("screennoscript").style.display="none";}</script></div>
-<p class="item">ALERT: If you have been using this document class prior to version 1.50, see <a href="#hZ">Appendix Z</a> for important changes.</p>
+<p class="item">ALERT: If you have been using this document class prior to version 1.80 (February 2023), see <a href="#hZ">Appendix Z</a>.</p>
+
+<p class="item">ALERT: New user? Little knowledge of LaTeX? Try the simpler "novelette" document class. Expected in March, 2023.</p>
<!-- ********************************************************************** -->
<div id="page01" class="page">
<p class="noindent">The <i>novel</i> document class is for authors of text-intensive original fiction, such as detective novels, murder mysteries, romance, sci-fi, and collections of short stories. Academic works and graphic novels are excluded.</p>
<p>The resulting PDF uses built-in technology to produce PDF/X compliant files for print-on-demand (P.O.D.) services. There is no capability for E-books, and never will be.</p>
-<p>To use <i>novel</i>, you need TeXLive 2016 or later, or recent MikTeX. Open your TeX package manager, and install both <i>novel</i> and <i>libertinus</i>.</p>
+<p>To use <i>novel</i>, you need TeXLive 2016 or later, or recent MikTeX. Open your TeX package manager, and install both <i>novel</i> and <i>libertinus-fonts</i>.</p>
<h2 id="h1">1. Before You Begin</h2>
@@ -592,12 +595,12 @@ function closeall() {
<h4 id="h1.1.1">1.1.1. Use the LuaLaTeX Compiler</h4>
<div class="d4" id="d1.1.1">
<p class="item"><b>A.</b> At the top of your *.tex main document, before the document class, place these lines:</p>
-<p class="code"><code>% !TeX TS-program = LuaLaTeX</code><br/>
+<p class="code"><code>% !TeX TS-program = lualatex</code><br/>
<code>% !TeX encoding = UTF-8</code></p>
<p>Those instructions are read and understood by many TeX editors, and also serve as a reminder to yourself.</p>
<p class="item"><b>B.</b> If you compile by command line, try this:</p>
-<p class="code"><code>lualatex yourdocument.tex</code><p>
-<p class="item"><b>C.</b> If using a service such as ShareLaTeX online, open the Menu, and scroll down to where you can choose the compiler. Set it to LuaLaTeX.</p>
+<p class="code"><code>lualatex your-document.tex</code></p>
+<p class="item"><b>C.</b> If using a service such as ShareLaTeX online, open the Menu, and scroll down to where you can choose the compiler. Set it to lualatex.</p>
</div><!-- end 1.1.1 -->
<h4 id="h1.1.2">1.1.2. Use UTF-8 Encoding</h4>
@@ -608,16 +611,23 @@ function closeall() {
<p class="item"><b>D.</b> If you are on Windows, <i>do not</i> use Notepad! The free <a class="external" rel="external" target="new" href="https://notepad-plus-plus.org">Notepad++</a> (also <a class="external" rel="external" target="new" href="https://portableapps.com/apps/development/notepadpp_portable">Portable</a> version) is a suitable plain text editor. Configure it as specified, with utf-8 but without BOM. Does not matter whether UNIX or DOS line endings, as long as you are consistent.</p>
</div><!-- end 1.1.2 -->
-<h4 id="h1.1.3">1.1.3. Use Polyglossia Language Support</h4>
+<h4 id="h1.1.3">1.1.3. Language Support</h4>
<div class="d4" id="d1.1.3">
-<p class="item"><b>A.</b> The pre-loaded <i>polyglossia</i> package provides language support. By default, <i>novel</i> is configured for American English.</p>
-<p class="item"><b>B.</b> If your document's language is something else, or if you will be writing in multiple languages, see the <i>polyglossia</i> package documentation regarding <code>\setdefaultlanguage</code> and related commands.</p>
+<p class="item"><b>A.</b> The <i>polyglossia</i> package is loaded automatically. Do not load it yourself.</p>
+<p class="item"><b>B.</b> Language is loaded like this default:</p>
+<p class="code"><code>\setdefaultlanguage[variant=american]{english}</code></p>
+<p class="item"><b>C.</b> For other possibilities, see polyglossia documentation.</p>
+<p class="item"><b>D.</b> Polyglossia does not always load language hyphenation patterns.
+If it does not, be sure that your system has the hyphenation patterns for your language or languages.
+For example, <code>hyphen-latin</code> is used when you insert <code>lipsum</code> text.
+And, you may need to use the polyglossia <code>\setotherlanguage</code> if extended text
+is not your default.</p>
</div><!-- end 1.1.3 -->
<h4 id="h1.1.4">1.1.4. Use Open Type Fonts</h4>
<div class="d4" id="d1.1.4">
<p class="item"><b>A.</b> The built-in <i>fontspec</i> package requires utf-8 encoding. It is able to load Open Type fonts, and access their internal feature sets. Forget Type 1 fonts and special encodings! If you wish to use Greek or Cyrillic, all you need are compatible fonts.</p>
-<p class="item"><b>B.</b> If you accept the pre-configured fonts (from <i>libertinus</i>), then you do not need to know anything about <i>fontspec</i>. But if you wish to configure your own fonts, <a href="#hE">Appendix E</a> reviews the most important parts of <i>fontspec</i> syntax.</p>
+<p class="item"><b>B.</b> If you accept the pre-configured fonts (from package <i>libertinus-fonts</i>), then you do not need to know anything about <i>fontspec</i>. But if you wish to configure your own fonts, <a href="#hE">Appendix E</a> reviews the most important parts of <i>fontspec</i> syntax.</p>
<div style="clear:both"></div>
</div><!-- end 1.1.4 -->
@@ -715,7 +725,7 @@ function closeall() {
<h3 id="h2.2">2.2. sandbox</h3>
<div class="d3" id="d2.2">
-<p class="noindent">New in version 1.50. You work in <code>sandbox</code> mode as a class option:</p>
+<p class="noindent">You may work in <code>sandbox</code> mode as a class option:</p>
<p class="code"><code>\documentclass[sandbox]{novel}</code></p>
<p class="item"><b>A.</b> In <code>sandbox</code> mode, you can use many packages that would otherwise be prohibited. This will allow you to create tables and diagrams using nearly any methods ordinarily available in most other document classes. Of course, you may have to load some additional packages.</p>
<p>Also, when in <code>sandbox</code> mode, many glues and lengths are set to values that are typical of other document classes, rather than the special values ordinarily used by <i>novel</i>.
@@ -787,11 +797,17 @@ function closeall() {
<div class="d3" id="d2.9">
<p class="noindent">These options are primarily used for developer testing, not user production. Using them may cause compilation to fail, or produce an undesirable result. That is not considered a bug.</p>
<p class="item"><b>A.</b> <code>mtoff</code> The <i>microtype</i> package will not be loaded.</p>
-<p class="item"><b>B.</b> <code>polyoff</code> The <i>polyglossia</i> package will not be loaded.</p>
-<p class="item"><b>C.</b> <code>test</code> Only used with file <i>novel-testsuite.tex</i>.</p>
-<p class="item"><b>D.</b> <code>unblock</code> Allows use of some packages that would otherwise be blocked.</p>
+<p class="item"><b>B.</b> <code>test</code> Only used with file <i>novel-testsuite.tex</i>.</p>
+<p class="item"><b>C.</b> <code>unblock</code> Allows use of some packages that would otherwise be blocked.</p>
</div><!-- end 2.9 -->
+<h3 id="h2.10">2.10. revert</h3>
+<div class="d3" id="d2.10">
+<p class="noindent">Version 1.80 has some minor tweaks, so that documents compile faster.
+In most cases, a document compiled with earlier version 1.52 will look the same.
+If it does not, the class option <code>revert</code> will undo the tweaks.</p>
+</div><!-- end 2.10 -->
+
</div><!-- end 2 -->
</div><!-- end page02 -->
@@ -1074,7 +1090,7 @@ OSX: <code>/Library/Colorsync/Profiles/</code> or hidden <code>(username)/Librar
<h5 id="h4.2.1.1">4.2.1.1. <code>\SetParentFont[<em>features</em>]{<em>fontname</em>}</code></h5>
<div class="d5" id="d4.2.1.1">
<p class="item"><b>A.</b> In <i>novel</i> you set a parent font, which is the ancestor of several pre-defined font styles, including the main font. In Preamble:</p>
-<p class="code"><code>\SetParentFont[<em>features</em>]{<em>fontname</em>}</code><p>
+<p class="code"><code>\SetParentFont[<em>features</em>]{<em>fontname</em>}</code></p>
<p class="item"><b>B.</b> The command uses <i>fontspec</i> syntax, which is reviewed in <a href="#hE">Appendix E</a>, and described in full detail by the <i>fontspec</i> package documentation.</p>
<p class="item"><b>C.</b> Whether you use <code>\SetParentFont</code> or accept the default, the features and fontname are stored as strings in macros <code>\parentfontfeatures</code> and <code>\parentfontname</code>. You may use <code>\parentfontfeatures</code> and <code>\parentfontname</code> as arguments to other font commands.</p>
<p class="item"><b>D.</b> If you have the proper license, you can use a commercial font. For example:</p>
@@ -1085,7 +1101,7 @@ OSX: <code>/Library/Colorsync/Profiles/</code> or hidden <code>(username)/Librar
<h5 id="h4.2.1.2">4.2.1.2. <code>\SetFontSize{<em>length</em>}</code></h5>
<div class="d5" id="d4.2.1.2">
<p class="item"><b>A.</b> In the <i>novel</i> document class, you do not set point size as a class option. Instead you use <code>\SetFontSize</code> in the Preamble. It applies to the parent (main) font, and is used as the basis for scaling font sizes.</p>
-<p class="item"><b>B.</b> The size may be any units TeX understands, including decimal values. So, <i>12.8bp</i> and <i>13.1pt</i> are acceptable. This is because you will be using scalable, Open&nbsp;Type and TrueType fonts throughout your document. They do not need TeX metrics.<p>
+<p class="item"><b>B.</b> The size may be any units TeX understands, including decimal values. So, <i>12.8bp</i> and <i>13.1pt</i> are acceptable. This is because you will be using scalable, Open&nbsp;Type and TrueType fonts throughout your document. They do not need TeX metrics.</p>
<p class="item"><b>C.</b> If you insist on using ancient TeX fonts, then you may need to specify a convenient integer font size such as 11pt or 12pt. But why? Forget those fonts! Welcome to the Twenty-First Century.</p>
<p class="item"><b>D.</b> The minimum global font size is <i>8pt</i>, and the maximum is <i>18bp</i>. On a local basis, text may be larger or smaller than this.</p>
<p class="item"><b>E.</b> If you do not use <code>\SetFontSize</code>, the default will be <i>11.4pt</i> more or less. That is, the size is calculated from other layout settings. When there is less available text area, the default size is <i>11pt</i>. For larger books, the default is <i>12pt</i>.</p>
@@ -1100,7 +1116,7 @@ OSX: <code>/Library/Colorsync/Profiles/</code> or hidden <code>(username)/Librar
<p>For example, the <i>main font</i> uses the <i>parent font</i> family. It has TeX Ligatures and Kerning (inherited from the <i>parent font</i>), and also Common Ligatures and OldStyle numbers.</p>
<p class="item"><b>B.</b> The <i>main font</i> is not configured directly. Instead, configure the <i>parent font</i>, then the <i>main font</i> (and other descendants) will obey. For example, if you don't want OldStyle numbers:</p>
<p class="code"><code>\SetParentFont[<em>Numbers=Lining</em>]{<em>fontname</em>}</code></p>
-<p>Then, Lining numbers will be used for the <i>main font</i> (and other descendants).<p>
+<p>Then, Lining numbers will be used for the <i>main font</i> (and other descendants).</p>
<p class="item"><b>C.</b> If you don't like the defaults, you can set the other descendant fonts directly, in Preamble:</p>
<p class="code">
<code>\SetChapterFont[<em>features</em>]{<em>fontname</em>}</code> &nbsp; % <em>see section <a href="#h5.1.3.1">5.1.3.1</a></em><br/>
@@ -1655,7 +1671,7 @@ Who could blame them? It's not like they lived in Italy.\par<br/>
Ah, such ill fortune haunted the Withens!\par<br/>
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 class="item"><b>C.</b> From version 1.52, a badly-placed scene break will be detected, and a Warning message will be issued.</p>
+<p class="item"><b>C.</b> A badly-placed scene break will be detected, and a Warning message will be issued.</p>
<p>If <code>\scenebreak</code> is positioned at the very top or bottom of a page, then the Warning will advise you to substitute it with either <code>\scenestars</code> or <code>\sceneline</code>. The substitution is not automatic.</p>
<p>If any of <code>scenebreak</code>, <code>\sceneline</code>, or <code>\scenestars</code> appears just one line away from the top or bottom of a page, you will get a Warning.</p>
@@ -1829,7 +1845,7 @@ Even after his jodphurs had finally uncurled, Lord Withens could not master his
<div class="d4" id="d6.2.2">
<p class="item"><b>A.</b> <code>\bfshape{<em>text, may cross paragraphs</em>}</code> is a general-purpose command for bold.</p>
<p class="item"><b>B.</b> <code>\textbf{<em>text</em>}</code> will not cross paragraphs.</p>
-<p class="item"><b>C.</b> The default main font in <i>novel</i> is <i>Libertinus Serif</i>, which has both bold and semibold weights. The semibold weight is pre-configured to substitute for bold.</p>
+<p class="item"><b>C.</b> The default main font in <i>novel</i> is <i>Libertinus Serif</i>, which has both bold and semibold weights. In versions prior to 1.80 (2023), The semibold weight is pre-configured to substitute for bold. Version 1.80 does not make this substitution.</p>
<p class="item"><b>D.</b> If you use a different font, and it has an alternative to bold weight, see <a href="#hE.1.1">Appendix E.1.1</a> <i>file name combinations</i> for how to configure the choice. Bold is not faked by thickening.</p>
<p class="item" style="position:relative"><b>E.</b> <img src="html-resources/info18.png" width="18" height="18" style="position:relative; bottom:-3px" title="tech info" alt="tech info"/> Bold is rare in fiction. It <em>might</em> be the case that this weight is useful for titles, but you ought to consider a fancy-looking font for that purpose, rather than mere Bold. Or, make the letters big and bold, but balance the effect by using gray.</p>
</div><!-- end 6.2.2 -->
@@ -1934,7 +1950,7 @@ This text is in lightgray, until the group ends.<br/>
<p>Images have built-in positioning arguments.</p>
<p class="item"><b>F.</b> Do not use floats (except in <a href="#h2.2">sandbox</a>). Use <i>novel's</i> own <code>\FloatImage</code>.</p>
<p class="item"><b>G.</b> Do not use tables (except in <a href="#h2.2">sandbox</a>). But <i>novel</i> has its <a href="#hD.3.2.7">own provision</a> for a Table of Contents, and the code may be used for other purposes as well.</p>
-<p class="item"><b>H.</b> Do not use picture environment (except in <a href="#h2.2">sandbox</a>). Use only the image commands provided by novel: <code><a href="#h7.2.2">\InlineImage</a></code>, <code><a href="#h7.2.4">\FloatImage</a></code>, and <code><a href="#h7.2.5">\WrapImage</a></code>. There is also a special provision for <a href="#h7.1.2">color cover artwork</a>.<p>
+<p class="item"><b>H.</b> Do not use picture environment (except in <a href="#h2.2">sandbox</a>). Use only the image commands provided by novel: <code><a href="#h7.2.2">\InlineImage</a></code>, <code><a href="#h7.2.4">\FloatImage</a></code>, and <code><a href="#h7.2.5">\WrapImage</a></code>. There is also a special provision for <a href="#h7.1.2">color cover artwork</a>.</p>
</div><!-- end 6.3.1 -->
<h4 id="h6.3.2">6.3.2. Some Useful Commands</h4>
@@ -1943,6 +1959,7 @@ This text is in lightgray, until the group ends.<br/>
<p style="margin-top:10pt"><code>\begin{adjustwidth}{<em>left</em>}{<em>right</em>} ... \end{adjustwidth}</code></p>
<p>This environment, from the included <i>changepage</i> package, is the most useful way to create block indents. The included text may have multiple paragraphs and span pages. The left and right arguments are lengths, being the amount to <em>increase</em> the respective margins from their normal values.</p>
<p style="margin-top:10pt"><code>\rotatebox{<em>text</em>}</code></p>
+<p>NOTE: Do not use rotation unless you really need it. Some P.O.D. printers robot-screen files, and a rotated box may be rejected (even though it is good).</p>
<p>This command is from the included <i>graphicx</i> package. It rotates the text, about an axis at the lower left of the text. If you wish to rotate the text about its center, use <code>\rotatebox[origin=c]{text}</code>.</p>
<p>This command plays nicely with <code>\charscale</code>, so you can size, rotate, and displace a string of text (single line). It makes a difference which command goes inside the other. More likely than not, the effect you want is obtained by using <code>\charscale</code> on the outside, with <code>\rotatebox</code> inside.</p>
<p>To avoid disturbing the line grid, <code>\rotatebox</code> is best used with <a href="#h6.1.2">\charscale</a> and a few blank lines.</p>
@@ -2037,7 +2054,7 @@ This text is in lightgray, until the group ends.<br/>
<p class="item"><b>F.</b> Most print services require that images must be stripped of private metadata (such as EXIF), and that the color space be DeviceGray, rather than specified by a transfer profile.</p>
<p class="item"><b>G.</b> Black/White images must be in <i>png</i> file format. Grayscale images may be in either <i>png</i> or <i>jpg</i> file format.</p>
<p class="item" style="position:relative"><b>H.</b> <img src="html-resources/info18.png" width="18" height="18" style="position:relative; bottom:-3px" title="tech info" alt="tech info"/> In the documentation <i>extras</i> folder, <i style="white-space:nowrap">novel-scripts.zip</i> will help you comply with these requirements. Complete usage information is provided there.</p>
- <p class="item"><b>I.</b> From version 1.52, <i>novel</i> detects whether or not an interior image was pre-processed using <i>novel-scripts</i>. If yes, it is "known good". If no, it is "unknown" and may be good or bad.</p>
+ <p class="item"><b>I.</b> Now <i>novel</i> detects whether or not an interior image was pre-processed using <i>novel-scripts</i>. If yes, it is "known good". If no, it is "unknown" and may be good or bad.</p>
<p>If your document has any "unknown" images, you will get a Warning. The list of "unknown" images is written near the bottom of the log file.</p>
<p>If you know that an image meets specs (because you are a graphic artists who knows these things), but it wasn't processed by <i>novel-scripts</i>, you can manually add it to the list of "known good" images. In Preamble:</p>
<p class="code"><code>\SetKnownGoodImages{somefile.png anotherfile.jpg}</code></p>
@@ -2066,7 +2083,7 @@ This text is in lightgray, until the group ends.<br/>
<h4 id="h7.2.2">7.2.2. <code>\InlineImage[<em>hoffset,voffset</em>]{<em>imageFile.png or .jpg</em>}</code> and starred version</h4>
<div class="d4" id="d7.2.2">
-<p class="item"><b>A.</b> This command places the image as an inline element, at 100% scale. The use of <i>png</i> or <i>jpg</i> images, with file extension, is required.<p>
+<p class="item"><b>A.</b> This command places the image as an inline element, at 100% scale. The use of <i>png</i> or <i>jpg</i> images, with file extension, is required.</p>
<p class="item"><b>B.</b> You may offset the image horizontally or vertically. Positive direction is to the right and up. If you use one offset, then you must use both (if necessary, <i>0em</i>). Any units of length may be used, but the preferred units are <i>em</i> or <code>\textwidth</code> for horizontal, and <i>em</i> or <code><span style="cursor:help" title="normal baseline skip">\nbs</span></code> for vertical.</p>
<p class="item"><b>C.</b> By default, the <em>top</em> of the image is at the text baseline. If you prefer that the <em>bottom</em> of the image be at the text baseline, use voffset <i>b</i>. Example:</p>
<p class="code"><code>\InlineImage[0em,b]{imageFile.png}</code></p>
@@ -2287,7 +2304,7 @@ There are many other commands available, but they are not specific to novel clas
<p>Non-empty default values are <em>shown like this</em>.<br/>
&nbsp;</p>
<p style="text-indent:0">
-<a href="#h1.1.1">% !TeX TS-program = LuaLaTeX</a><br/>
+<a href="#h1.1.1">% !TeX TS-program = lualatex</a><br/>
<a href="#h1.1.2">% !TeX encoding = UTF-8</a><br/>
<a href="#h2">\documentclass{novel}</a> % See list of class options; usually none needed.<br/>
%%% METADATA (FILE DATA):<br/>
@@ -2345,7 +2362,7 @@ There are many other commands available, but they are not specific to novel clas
% <a href="#h4.2.5">\NewFontFace[]{}</a> % Optional command.<br/>
% <a href="#hE.2.3">\CreateFontFeature{}{}</a> % Optional command.<br/>
%%% OTHER:<br/>
-<a href="#h1.1.3">\setdefaultlanguage[<em>variant=american</em>]{<em>english</em>}</a> % polyglossia<br/>
+<a href="#h1.1.3">Language Support</a>
<a href="#h6">\microtypesetup{<em>config=novel-microtype,stretch=20,shrink=20,final</em>}</a> % microtype<br/>
%%% BEGIN DOCUMENT:<br/>
\begin{document}<br/>
@@ -2451,7 +2468,7 @@ It was a dark and stormy night, etc.<br/>
<p>You have numerous fonts already installed in your operating system, and perhaps others that came bundled with a particular application. If you intend to use those fonts, carefully read their licenses. It is often the case that fonts bundled with an application may <em>only</em> be used for documents created within, or processed by, that application. Or, the fonts may be OK to use for printing directly by your own home printer, but not for embedding in a PDF that will go to a commercial printer.</p>
<p>Although it does not pertain to TeX, another issue can arise if you later publish an ebook version. Fonts licensed for printing are often not licensed for an ebook. Indeed, the ebook distributor may ban them.</p>
<p>Always look for a Copyright notice, which can be identified with a particular person or organization. Copyright is good! It means that someone is claiming authorship of the font software. Only the Copyright owner has the right to give the font away for free, or license it to you after payment (often through an intermediary).</p>
-<p>If you prefer free fonts, the most widely accepted license is the <a class="external" rel="external" target="new" href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL">SIL Open Font License</a>. This allows you to use the font for commercial purposes, embed it in PDF, modify it to suit your needs (if you change the font name), and even re-distribute the modifications. The recommended default <i>Libertinus Serif</i> bears this font license. So does the included font <i>NovelDeco</i>.</p>
+<p>If you prefer free fonts, the most widely accepted license is the <a class="external" rel="external" target="new" href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&amp;id=OFL">SIL Open Font License</a>. This allows you to use the font for commercial purposes, embed it in PDF, modify it to suit your needs (if you change the font name), and even re-distribute the modifications. The recommended default <i>Libertinus Serif</i> bears this font license. So does the included font <i>NovelDeco</i>.</p>
</div><!-- end C.1 -->
<h3 id="hC.2">C.2. &nbsp; Technical Issues</h3>
@@ -2635,7 +2652,7 @@ It was a dark and stormy night, etc.<br/>
<p>Alternatively, you can quote from your own book, or make up something entirely new. One famous Epigraph is used in J.R.R. Tolkien's <i>Lord of the Rings</i> trilogy, in which each book uses the long form of the Ring's incantation as its Epigraph.</p>
<p>One possible use of an Epigraph is on recto page v, in books that lack a Dedication, a Table of Contents, or other important front matter beyond the Copyright Page. Alternatively, if a book has both Dedication and Table of Contents, an Epigraph may be placed on the otherwise-blank verso page vi between them. Or, an Epigraph may appear in some later convenient place in front matter.</p>
<p>In general, an Epigraph is set as a centered block, not occupying the full page width. The <i>adjustwidth</i> environment serves this purpose. You will have to manually adjust the widths at left and right, for best visual effect.</p>
-<p>The source of the quotation should be right-justified within the block, and may be preceded by an emdash. Typically, names of people are not italicized, but titles of books are. It is not necessary to give elaborate details; this is not a bibliography.<p>
+<p>The source of the quotation should be right-justified within the block, and may be preceded by an emdash. Typically, names of people are not italicized, but titles of books are. It is not necessary to give elaborate details; this is not a bibliography.</p>
<p>It is not necessary to load the <i>epigraph</i> package. Simply construct your own style of epigraph using other methods. But if you do load <i>epigraph</i>: Only use <code>\epigraph</code>, or the <code>epigraphs</code> environment, within the ChapterStart environment, or on a display page. Commands <code>\epigraphhead</code>, <code>\dropchapter</code>, <code>\undocrop</code> do not work in <i>novel</i>. The <code>\cleartoevenpage[<i>option</i>]</code> command does work. Ignore the material regarding epigraphs on part pages or in bibliographies.</p>
<h6 id="hD.3.2.6.1"><span class="n"></span>D.3.2.6.1. Example Epigraph: Real Quotation</h6>
@@ -2920,7 +2937,7 @@ Dirk Hardcase is a former... etc.\par<br/>
<p>Document Body:</p>
<p class="code"><code>{\rwayi I came, \textbf{I saw}, \emph{I conquered}, \textsc{I left}.}</code></p>
<p style="margin-top:10px"><b>File Name Combinations:</b></p>
-<p><img class="floatright" style="padding-top:12px" src="html-resources/frankenfont.png" width="312" height="41" alt="frankenfont"/> What you write is what you get. You can customize a font family by individually selecting its members. Here is the syntax.</p>
+<p><img class="floatright" style="padding-top:12px" src="html-resources/frankenfont.png" width="312" height="41" alt="frankenfont"/> What you write is what you get. You can customize a font family by individually selecting its members. Here is the syntax. Case-sensitive, so what you see here may differ from what you have.</p>
<p>Preamble:</p>
<p class="code" style="clear:both"><code>\NewFontFamily\frankenfont[% note the % at linebreaks<br/>
&nbsp; ItalicFont=BaskervilleF-Italic.otf,%<br/>
@@ -3080,7 +3097,6 @@ Some text {\baskf\addfontfeature{Numbers=Monospaced} hello 123} is here.
<h3 id="hF.2">F.2. &nbsp; \dropcap[<em>options</em>]{<em>letter or image</em>}</h3>
<div class="d3" id="dF.2">
-<p class="noindent">To ensure that this command works as described here, verify that font <i>NovelDeco.otf</i> is at least version 1.48. If you use your own <i>deco font</i>, be sure that it is based on at least that version. Also, clear <i>luatex-cache</i> so that the version is updated. If you do not do that, the <code>\dropcap</code> command still works, but the appearance of the result will differ.</p>
<p class="item"><b>A.</b> The <code>\dropcap</code> command is based on <i>lettrine</i> technology, but has different options and behavior.</p>
<p class="item"><b>B.</b> The <code>\dropcap</code> command accepts the following options as <span style="white-space:nowrap">comma-separated</span> key values:</p>
<p class="code"><code>lines=<em>integer</em></code> &nbsp; Number of lines indented by the drop cap. Default 3.</p>
@@ -3124,7 +3140,7 @@ Some text {\baskf\addfontfeature{Numbers=Monospaced} hello 123} is here.
<p class="code"><code>\NewFontFace\mynicedc[<em>features</em>]{font file name}</code></p>
<p>Then, you set the font. This may be changed anywhere:</p>
<p class="code"><code>\SetDropCapFont{\mynicedc}</code></p>
-<p class="item"><b>D.</b> Do not use Type1 or Metafont fonts. If the desired font is only available in one of those formats, you can use a font editor such as <a href="https://fontforge.github.io/en-US/" class="external" rel="external" target="new">FontForge</a> to convert it to Open Type or TrueType format. Then, as described above, load the converted file by its exact file name. If the font has mssing extrema, that is almost never a problem. Overlapped hints are rarely a problem. But self-intersecting glyphs and open paths may be a problem, if you use those glyphs.</p>
+<p class="item"><b>D.</b> Do not use Type1 or Metafont fonts. If the desired font is only available in one of those formats, you can use a font editor such as <a href="https://fontforge.org" class="external" rel="external" target="new">FontForge</a> to convert it to Open Type or TrueType format. Then, as described above, load the converted file by its exact file name. If the font has mssing extrema, that is almost never a problem. Overlapped hints are rarely a problem. But self-intersecting glyphs and open paths may be a problem, if you use those glyphs.</p>
<p class="item"><b>E.</b> Default drop cap color is black. To change it, use <i>xcolor</i> syntax. Either of these:</p>
<p class="code"><code>\SetDropCapColor[<em>color model</em>]{<em>color value</em>}</code></p>
<p class="code"><code>\SetDropCapColor{<em>color name</em>}</code></p>
@@ -3162,7 +3178,7 @@ Some text {\baskf\addfontfeature{Numbers=Monospaced} hello 123} is here.
<p class="item"><b>B. Credits:</b> Within the TeX code files, you will find places where small or large pieces of code are the work of someone else. Names or organizations are credited in-place within the TeX code, according to license.</p>
<p>Various clipart graphics were obtained from <a class="external" rel="external" target="new" href="https://openclipart.org">openclipart.org</a>.</p>
-<p>Font <i>NovelDeco.otf</i> was created using <a class="external" rel="external" target="new" href="https://fontforge.github.io/en-US/">FontForge</a>. The font is partly derived from <a class="external" rel="external" target="new" href="https://github.com/khaledhosny/libertinus"><span style="white-space:nowrap"><i>Libertinus Serif</i></span></a>, which in turn is derived from <a class="external" rel="external" target="new" href="http://www.linuxlibertine.org/"><span style="white-space:nowrap"><i>Linux Libertine O</i></span></a>.</p>
+<p>Font <i>NovelDeco.otf</i> was created using <a class="external" rel="external" target="new" href="https://fontforge.org">FontForge</a>. The font is partly derived from <i>Libertinus Serif</i>, which in turn is derived from <a class="external" rel="external" target="new" href="http://www.linuxlibertine.org/"><span style="white-space:nowrap"><i>Linux Libertine O</i></span></a>.</p>
<p>In places, I offer opinions or make suggestions regarding design. These are largely based on my own inspection of popular fiction books, at my local public library. In some cases, I follow the <a class="external" rel="external" target="new" href="http://www.chicagomanualofstyle.org/home.html"><i>Chicago Manual of Style</i></a> (CMoS), hardcover 16th edition. However, please do not regard my opinions and suggestions as authoritative.</p>
<p>&nbsp;</p>
@@ -3173,88 +3189,18 @@ Some text {\baskf\addfontfeature{Numbers=Monospaced} hello 123} is here.
<div id="pageZ" class="page">
-<h2 id="hZ">Appendix Z. &nbsp; Changes in v.1.50 and Later</h2>
+<h2 id="hZ">Appendix Z. &nbsp; Changes in v.1.80.</h2>
<div class="d2" id="dZ">
-<h4>Changes in version 1.52</h4>
-<div class="d4">
-<p>The <code>linegap</code> environment is deprecated. It will still be honored in code, but has been removed from the documentation. It was never very useful.</p>
-<p>The <code>parascale</code> environment now measures how much it disturbs the line grid. Although it cannot automatically correct the disturbance, it does provide a useful warning so that you can make the change yourself.</p>
-<p>Best practice avoids scene breaks too close to the top or bottom of a page, unless you place something visible there. Now, a badly-placed <code>\scenebreak</code> can be detected, and a warning will be issued.</p>
-<p>Version 1.50 already included an advanced method for PDF/X-1a color covers. In version 1.52, this is extended to non-color interior book blocks. Now, any image placed in your document will be inspected, and classified either as <i>known-compliant</i> or <i>unknown</i>. Images with <i>unknown</i> compliance will be reported in the log file, and if any were detected, there will be a warning.</p>
-<p>There have been some miscellaneous small tweaks, unlikely to be noticeable by most users.</p>
-<p>Documents that successfully compiled with version 1.50 should look the same in version 1.52, but you may see more warnings.</p>
-</div>
-
-<h4>Changes in Version 1.50</h4>
+<h4>Important Changes</h4>
<div class="d3">
-<p>Version 1.50 introduced many new features, and some changes, from version 1.46.2.</p>
-
-<p class="noindent"><b>Post-Release Reversion to Old</b></p>
-<p>If you have an existing document created with version prior to 1.50, in rare circumstances the layout will change. </p>
-<p>If the only change is the number of lines per page, then you can simply fix it manually, using the <code>\SetLinesPerPage</code> command. But if version 1.50 creates problems, you can run the old and new versions side-by-side. Be sure to keep the new version installed.</p>
-<p>In the short term, an older version of <i>novel</i> can be found <a href="https://github.com/RobtAll/novel">here</a>, in the archives folder. Be sure that the zip file is named "novel-old".</p>
-<p>1) Unpack novel-old.zip into your texmf-local directory.</p>
-<p>2) Refresh your file name database.</p>
-<p>3) Change your document class from <i>novel</i> to <i>novel-old</i>.</p>
-<p>If performed correctly, you will be using version 1.46.2 of <i>novel</i>, when you change the document class to <i>novel-old</i>. To avoid version conflict, be sure that you do not duplicate font <i>NovelDeco.otf</i> in texmf-local; <i>novel-old</i> will rely on the current version installed with <i>novel</i>.</p>
-<p>Any document using <i>novel</i> will get the installed version, rather than <i>novel-old</i>.</p>
-<p>In the long term, the older version will be removed. No particular time frame. I do not believe that many users (if any) will be affected.</p>
-<p>If your existing documents have no problem with version 1.50, then use the newer version.</p>
-
-<p class="noindent"><b>Cover Art Methods Changed</b></p>
-<p>From version 1.50, the method used for cover art has changed. If you have existing cover artwork using the older syntax, it will still be honored, but it is no longer documented.</p>
-<p>The new cover art syntax requires you to pre-process your image using a script, included in the documentation <i>extras</i> folder. The scripts works on Windows, Linux, and Mac OSX. The processed image will be PDF, separated to CMYK, at 240% ink limit.</p>
-<p>To obtain PDF/X, you post-process the above PDF in lualatex, using a template. Complete instructions are in the zip file containing the scripts.</p>
-<p>Of course, you don't need to use TeX at all, if your print service accepts an ordinary RGB image.</p>
-
-<p class="noindent"><b>New Class Option: sandbox</b></p>
-<p><i>Novel</i> does not permit things such as TikZ diagams, tables (other than its own method), imported PDf pages, and some other TeX effects. The purpose of the prohibition is to maintain grid layout, and ensure PDF/X compliance.</p>
-<p>From version 1.50, the <code>sandbox</code> class option allows you to do nearly anything, provided that the result is no more than four pages. Then, you can create drawings or whatever, convert to raster images, and place the images in your main document.</p>
-
-<p class="noindent"><b>\BlockImage Obsolete</b></p>
-<p>From version 1.50 the \BlockImage command is obsolete. It was never a very good macro. If you have an existing document that uses \BlockImage, it will be honored, but it is no longer documented.</p>
-<p>You may prefer the new <code>\FloatImage</code> and <code>\WrapImage</code> commands.</p>
-
-<p class="noindent"><b>\FloatImage Added</b></p>
-<p>Better than <code>\BlockImage</code>: Version 1.50 now has <code>\FloatImage</code>, which can place an image "here" or float it to the next page, if it doesn't immdiately fit. Full-page floats are supported. See the full documentation, above.</p>
-<p>The <code>\InlineImage</code> command remains unchanged, and will probably remain forever. It's a good macro.</p>
-
-<p class="noindent"><b>\WrapImage Added</b></p>
-<p>The new <code>\WrapImage</code> command provides limited support for wrapping text around an image. It is all you need in the context of fiction writing.</p>
-<p>The <i>wrapfig</i> package is automatically loaded, and provides the layout engine. However, do not directly use the commands and environments from that package (they won't work). Instead, <i>novel</i> provides macro <code>\WrapImage</code>, which will format your input so that it can be processed correctly.</p>
-
-<p class="noindent"><b>Drop Caps Added</b></p>
-<p>As before, you may use the <i>lettrine</i> package, if you wish. From version 1.50, <i>novel</i> now has built-in support for a certain style of drop caps, as a special interface to the <i>lettrine</i> layout engine.</p>
-<p>Since the new <code>\dropcap</code> command requires an updated version of the <i>NovelDeco.otf</i> font, be sure to update your <span style="white-space:nowrap">luatex-cache</span>.</p>
-
-<p class="noindent"><b>\Rework Obsolete</b></p>
-<p>From its early days, <i>novel</i> had an exotic built-in method for preserving layout if your book's Trim Size changed. It was a complicated piece of code, and even though it worked, it was inherently incapable of addressing some layout situations.</p>
-<p>In version 1.46.1 it was quietly removed from the documentation. In the short term, existing documents that rely on <code>\Rework</code> commands will still compile. In the long term, forget it. To my knowledge, nobody is using it.</p>
-
-<p class="noindent"><b>Class Option <i>graytext</i> Obsolete</b></p>
-<p>Formerly, you could use a class option to specify whether or not the use of grayscale text (anything other than solid black) was permitted. There was never any good reason for having that choice, so it has been removed. Now, you can always use grayscale text, if you wish.</p>
-
-<p class="noindent"><b>\SetCropmarkGap Obsolete</b></p>
-<p>Formerly, there was a minimal ability to configure crop marks. It was not very useful, and made the code more complex. Now, the size of cropmarks is fixed.</p>
-
-<p class="noindent"><b>New Error Messages for Endnotes</b></p>
-<p>Prior to version 1.50, incorrect use of <a href="#h9.2"><code>\endnote</code></a> commands would simply produce bad typesetting, without warning.</p>
-<p>New error messages have been added. If you use <a href="#h9.2"><code>\endnote</code></a>, and get error messages that did not appear before, then be sure to read the command documentation again. The most likely reason for error is that you are using the commands according to the syntax of some other package, rather than using <i>novel's</i> own syntax.</p>
-
-<p class="noindent"><b>New Algorithm for Layout Calculations</b></p>
-<p>Under the hood, version 1.50 uses a more accurate method for page layout. In most cases, the change is microscopic, and will not affect existing documents.</p>
-<p>Books that use widely-spaced lines are most likely to show a noticeable change for the better. In a few cases, the default number of lines per page will change. If you have an existing document using default lines per page, and it has changed, then simply specify the exact number manually.</p>
-
-<p class="noindent"><b>Revised Documentation Format</b></p>
-<p>This documentation has been slightly revised. Now, long sections are broken down into items, marked A, B, etc. This is for the convenience of translators.</p>
-<p>Under the hood, in the TeX code, there has been some cleanup, for the benefit of future package maintainers.</p>
-
-<p class="noindent"><b>What's Unchanged</b></p>
-<p>Most of <i>novel</i> is just as before, and will be...</p>
-<p>In particular, there is no support for tables (other than novel's own Table of Contents), no support for automatic divisions into sections and other kinds of partitions, no support for automatic index or bibliography, and generally no support for the "academic" structure used by other document classes.</p>
-</div>
-
+<p>Version 1.80 (2023) tweaks some internal code, for faster compiling.
+No new features or bugs. If you have a document built with the earlier
+version 1.52, use class option <code>revert</code> to avoid using the tweaks.
+In any case, if you are re-building an earlier document, pay careful attention
+to line breaks and pagination. Due to various adjustments in component
+packages and fonts, a document built in the past may look slightly different
+if re-built now.</p>
</div><!-- end Z -->
</div><!-- end Appendix Z -->