diff options
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/novel')
19 files changed, 558 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/example-adobergb.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/example-adobergb.png Binary files differnew file mode 100644 index 00000000000..b00879c2f1f --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/example-adobergb.png diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/example-cmyk238.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/example-cmyk238.png Binary files differnew file mode 100644 index 00000000000..8915e3513cc --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/example-cmyk238.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 7971004d93f..e512f0e14bd 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 @@ -2,9 +2,9 @@ /* Style sheet for "novel" class documentation. */ -body {font-family:sans-serif; line-height:150%; background:#cccccc none;} +body {font-family:sans-serif; line-height:150%; font-size:16pt; background:#cccccc none;} #master {position:relative;} -#toc {width:30%; background:#ffffff none; position:fixed; overflow:scroll; height:98%;} +#toc {font-size:14pt; width:30%; background:#ffffff none; position:fixed; overflow:scroll; height:98%;} #toc p {margin-left:8px; margin-top:8px; margin-bottom:8px; font-weight:bold; text-indent:0px;} #toc ul {list-style-type:none; margin-left:8px;} #toc li {list-style-type:none; margin-left:8px; margin-top:3px;} @@ -32,6 +32,8 @@ div.h5 {margin:0px 0px 16px 16px; padding-bottom:0.5em; border-left:1px dotted # div.h6 {margin:0px 0px 16px 16px; padding-bottom:0.5em; border-left:1px dotted #666666; border-bottom: 1px dotted #666666;} div.pagetopage {float:right; border:1px solid #000000; margin-left:12px; margin-right:16px; margin-top:32px;} div.pagetopage p {text-indent:0px; margin:4px;} +div.codeblock {overflow:auto; margin:16px; padding: 8px; border: 1px solid #000000;} +div.codeblock p {text-indent:0px; white-space:nowrap;} p {font-family:serif;} pre, code {font-family:monospace,monospace; font-size:1em;} p, pre {margin: 0px 16px 0px 16px; text-indent: 16px;} diff --git a/Master/texmf-dist/doc/lualatex/novel/html-resources/verified238.png b/Master/texmf-dist/doc/lualatex/novel/html-resources/verified238.png Binary files differnew file mode 100644 index 00000000000..8c28ea6edbb --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/html-resources/verified238.png diff --git a/Master/texmf-dist/doc/lualatex/novel/novel-cover-template.tex b/Master/texmf-dist/doc/lualatex/novel/novel-cover-template.tex new file mode 100644 index 00000000000..9853733e3a0 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/novel-cover-template.tex @@ -0,0 +1,13 @@ +% !TeX program = LuaLaTeX +% !TeX encoding = UTF-8 +\documentclass[coverart]{novel} % v. 1.2 or later +\SetMediaSize{width}{height} % includes bleed +\SetTrimSize{width}{height} % without bleed +\SetTitle{example} % title required, might not be book title +% \SetAuthor{you} % optional +\SetPDFX[CGATSTR001]{X-1a:2001} % or whatever +\SetCoverImage{yourimage-cmyk240.jpg} % CMYK jpg, if PDF/X-1a. +% \SetApplication{whatever} % rarely used +% \SetProducer{whatever} % rarely used +\begin{document}\end{document} % nothing else in between + diff --git a/Master/texmf-dist/doc/lualatex/novel/novel-example.tex b/Master/texmf-dist/doc/lualatex/novel/novel-example.tex new file mode 100644 index 00000000000..589b196b747 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/novel-example.tex @@ -0,0 +1,135 @@ +% !TeX program = LuaLaTeX +% !TeX encoding = UTF-8 +% +% EXAMPLE OF NOVEL DOCUMENT CLASS +% Uses mostly default layout. +\documentclass{novel} % v. 1.1.1 or later +\SetTitle{Dark and Stormy} +\SetSubtitle{A Tale of Nights} +\SetAuthor{Dirk Hardcase} +\SetPDFX[CGATSTR001]{X-1a:2001} +% This example document picks a \titlepagefont for the book's title, +% depending on what you have installed. Not necessarily a good choice! +\begin{document} + +\frontmatter + +% i. Half-Title page: +\thispagestyle{empty} +\vspace*{6\nbs} +\hfill\charscale[1.8]{\textbf{Dark and}}\par +\vspace{\nbs} +\hfill\charscale[2.4]{\textbf{Stormy}}\par +\clearpage + +% ii. Blank page: +\thispagestyle{empty} +\null +\clearpage + +% iii. Full Title page: +\thispagestyle{empty} +\vspace*{5\nbs} +\begin{center} +\charscale[3.6]{\textbf{Dark and}}\par +\vspace{2\nbs} +\charscale[4.8]{\textbf{Stormy}}\par +\vspace{1.5\nbs} +\charscale[1.6]{A Tale of Nights}\par +\vspace{4\nbs} +\ChapterDeco[6]{\decoglyph{n9548}} +\vspace{4\nbs} +{\addfontfeature{Scale=3}\theAuthor} +\vfill +{\addfontfeature{Scale=1.25} Nonexistent Publications\\ +Anytown • Anyplace • Anywhere}\par + +\end{center} +\clearpage + + +% iv. Copyright page: +\thispagestyle{empty} +\begin{center} +\itshape{ +\null +\vfill +Copyright ©2017 Dirk Hardcase.\par % Whichever year, copyright holder. +All Rights Reserved.\par % Usually no need to be elaborate. +\null +This is a work of fiction.\\ +All persons and events are\\ +from the author's imagination.\\ +Resemblance to any real person,\\ +living or dead, is coincidental.\par % Or similar language. +\null +Printed on acid-free paper.\par % If true. Usually is true. +Printed in the United States of America.\par % Or whichever nation. +\null +ISBN 0-12345678-9\par % Whatever it is. No barcode, just number. +\null + +Published by Dirk Hardcase,\par % Publisher is you, not the print/distribution service. +Anytown, Anystate USA\par % Publisher's location. +www.example.com/dhardcase/publications/\par % Contact for publisher or author. +\null +Publisher's Cataloging-In-Publication Data\\ +available upon request.\par +% Fiction often does not need catalog data. +} % end itshape +\end{center} +\clearpage + +% v. Epigraph, Dedication, Table of Contents, or repeated Half-Title: +\thispagestyle{empty} +\vspace*{6\nbs} +\hfill\charscale[1.8]{\textbf{Dark and}}\par +\vspace{\nbs} +\hfill\charscale[2.4]{\textbf{Stormy}}\par +\clearpage + +% vi. Blank page: +\thispagestyle{empty} +\null +\clearpage + +% Must use even number of pages in frontmatter. +% Now to begin your story: +\mainmatter + +% Chapter One: +\begin{ChapterStart} +\vspace*{3\nbs} +\ChapterTitle{Chapter One} +\end{ChapterStart} + +It was a dark and stormy night. Lord Withens rode his horse through the gloom, which was, as heretofore mentioned, dark. Most gloom is dark, eh wot? + +Moving right along, his horse arrived at the back door of Lady Wishintale's quarters. Sadly, Lord Withens was not on it, having slipped off his saddle along the way. That was because the weather was stormy. + +\lipsum + +% Chapter Two: +\clearpage +\begin{ChapterStart} +\vspace*{3\nbs} +\ChapterTitle{Chapter Two} +\end{ChapterStart} + +The night was still dark and stormy. This should not be surprising, seeing as how only half an hour has elapsed since the first chapter. That information was necessary, in case you put the book down and haven't read any of it for the last two weeks. + +Lord Withens, wet and bruised, finally arrived at his destination. The reason he was wet was because, as has been noted, the weather was stormy. It was dark, too. + +\lipsum + +% Don't forget: The final page must be verso, and must be blank. +\clearpage +\thispagestyle{empty} +\null +% If necessary, insert an additional blank page, so that the total page count is even: +\clearpage +\thispagestyle{empty} +\null + +\end{document} + diff --git a/Master/texmf-dist/doc/lualatex/novel/novel-template.tex b/Master/texmf-dist/doc/lualatex/novel/novel-template.tex index 61b0dea5511..0d4c842db2c 100644 --- a/Master/texmf-dist/doc/lualatex/novel/novel-template.tex +++ b/Master/texmf-dist/doc/lualatex/novel/novel-template.tex @@ -1,6 +1,6 @@ % !TeX program = LuaLaTeX % !TeX encoding = UTF-8 -\documentclass{novel} % v. 1.1 or later +\documentclass{novel} % v. 1.2 or later % You may put this wherever your installation keeps templates. % Many packages are pre-loaded. Nearly all settings are pre-configured. % Some popular user settings: diff --git a/Master/texmf-dist/doc/lualatex/novel/novel.pdf b/Master/texmf-dist/doc/lualatex/novel/novel.pdf Binary files differindex 9dfca37850a..24982f218d9 100644 --- a/Master/texmf-dist/doc/lualatex/novel/novel.pdf +++ b/Master/texmf-dist/doc/lualatex/novel/novel.pdf diff --git a/Master/texmf-dist/doc/lualatex/novel/novel.tex b/Master/texmf-dist/doc/lualatex/novel/novel.tex new file mode 100644 index 00000000000..7cfb2d8fc89 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/novel.tex @@ -0,0 +1,155 @@ +% !TeX program = LuaLaTeX +% !TeX encoding = UTF-8 +% +% SOURCE CODE FOR FILE novel.pdf, the cover info +% for novel document class. +\documentclass{novel} % v. 1.2 or later +% Almost all settings are defaults. +\SetHeadFootStyle{3} +\SetTitle{Novel Document Class} % only footer, with page number +% Uncomment the following line, to compile as PDF/X for USA: +% \SetPDFX[CGATSTR001]{X-1a:2001} +\begin{document} +\begin{ChapterStart}[14] +\vspace{2\nbs} % \nbs is normal baselineskip +\ChapterTitle{NOVEL} +\null +\ChapterSubtitle{A Document Class for the Rest of Us} +\vspace{2.5\nbs} +\ChapterDeco[4]{\decoglyph{r9554}} +\null +{\centering\textit{It was a dark and stormy night.}\par} +\end{ChapterStart} + +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 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{1. Features} + +Throughout, it is assumed that the purpose of your writing is a +commercially printed book of fiction. + +A new \emph{novel} is pre-configured to produce a standard trade book +size of 5.5in W x 8.5in H, with layout margins that are likely to be +acceptable to the most widely-used print services. The file 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 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 prefer to use +a professional font, it will be easy to load and use in utf-8. + +Many standard LaTeX commands are disabled. This will be surprising +at first. But \emph{novel} is focused on one thing only. Anything +that might interfere with that purpose may have been tossed aside. +So, be sure that you read the documentation! If you take an existing +LaTeX document and just change the class to \emph{novel,} it is very +unlikely to work as expected. + +Many new commands are provided. They are focused on the +needs of print fiction writers, period. And, \emph{novel} has built-in PDF/X +technology that exceeds the capabilities currently available via other +LaTeX packages. + +\QuickChapter{2. Complete Documentation} + +What you are reading now, is only an introduction. The complete +documentation is in HTML format, directly written +in HTML rather than extracted from code. There are numerous +examples and images, too detailed to be presented as PDF. + +\QuickChapter{3. Project Page} + +The 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 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{4. License} + +The LaTeX code, and accompanying documentation, is released +under the LateX Project Public License, version 1.3c or later. + +The companion font \emph{NovelDeco.otf} is licensed under the SIL +Open Font License, version 1.1. + +\QuickChapter{5. Version} + +The initial CTAN version was released February 28, 2017. +Users should upgrade to the latest via their TeX package manager. + +\QuickChapter{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 \emph{novel.cls} file, located in (your TeX +distro)/tex/lualatex/novel. + +\QuickChapter{7. FAQs} + +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{Q. }Can this document class be used for E-books? +\end{adjustwidth} +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{A. }No. And, that feature will never be added, as the technology +is inherently incompatible. +\end{adjustwidth} + +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{Q. }My thesis advisor told me--- +\end{adjustwidth} +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{A. }Stop right there. This document class is very different from +anything used for theses and other academic publications. +\end{adjustwidth} + +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{Q. }If I use TikZ for Feynman diagrams, then--- +\end{adjustwidth} +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{A. }Go away. +\end{adjustwidth} + +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{Q. }When I woke up this morning, my head felt like a toddler had +been pounding it in a sandbox. I rolled over and look at the mug shot +on the wall. It was a woman in her forties with a drug habit that +was bad, and an attitude that was even worse. She had seen better +days, like the time I took her to the eighth grade sock hop. Then I +got up, washed, and dragged my lonely butt down to the one-man +detective agency that I jokingly called my means of living. +You know what I mean? +\end{adjustwidth} +\begin{adjustwidth}{\parindent}{0pt} +\backindent\makebox[\parindent][l]{A. }Yeah. Stick with me, kid. This document class is for you. +\end{adjustwidth} + +\end{document} + + + + + + + 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 b49e4049452..0945dd75361 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-01-overview.html @@ -139,7 +139,7 @@ <div id="main"> <a id="thetop"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> <p><b>User Guide</b></p> @@ -154,6 +154,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 c3f43ce7b46..f35755d3a03 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 @@ -37,7 +37,7 @@ <a id="thetop"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> @@ -53,6 +53,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 15a618ba5b7..54c1d534947 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 @@ -58,7 +58,7 @@ <div id="main"> <a id="thetop"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> @@ -74,6 +74,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 369ceddda8f..c9194f9d253 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-04-layout.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-04-layout.html @@ -65,7 +65,7 @@ <div id="main"> <a id="thetop"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> @@ -81,6 +81,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 869a67aff37..da79d2ff6a0 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,7 @@ <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> <p><b>User Guide</b></p> @@ -93,6 +93,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</a></p> </div> 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 f17197db1cb..b319f5af4b9 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 @@ -47,7 +47,7 @@ <a id="a6"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> @@ -63,6 +63,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 30351441f4f..a308cd13585 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 @@ -58,7 +58,7 @@ <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> <p><b>User Guide</b></p> @@ -73,6 +73,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 5b5d974fc9e..e02ee0e4224 100644 --- a/Master/texmf-dist/doc/lualatex/novel/noveldocs-08-images.html +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-08-images.html @@ -48,7 +48,7 @@ <div id="main"> <a id="thetop"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> <p><b>User Guide</b></p> @@ -63,6 +63,7 @@ <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, Endnotes.</a></p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</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 c7bd98fdfb7..d1314cb3320 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 @@ -29,7 +29,7 @@ Footnotes and Endnotes</a></p> <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.2">9.1.5.2 Epigraph - OBSOLETE</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> @@ -112,7 +112,7 @@ Footnotes and Endnotes</a></p> <div id="main"> <a id="a9"></a> <h1>Documentation for <code>novel</code> document class</h1> -<p>Documentation version: 1.1.</p> +<p>Documentation version: 1.2.</p> <div class="pagetopage"> @@ -128,6 +128,7 @@ Footnotes and Endnotes</a></p> <p>9. Display, Start Pages;<br> <span style="visibility:hidden">9. </span>Chapters; Continued Pages;<br> <span style="visibility:hidden">9. </span>Footnotes, Endnotes.</p> +<p><a href="noveldocs-10-cover-art.html">10. Cover Artwork</a></p> </div> @@ -396,7 +397,11 @@ http://example.com/bigdealauthor.html\par<br> <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 class="h5"><b>9.1.5.2 Epigraph: OBSOLETE</b> + +<p style="color:#cc0000">Sometime between March and May 2017, either I changed something in the underlying code, or TeX changed something, that caused the Epigraph command to stop functioning. I have not been able to hunt it down yet. Unless and until you have a code version 1.3 or greater (current is 1.2), do not use the Epigraph command, and remove it from any prior documents. You can emulate it using the adjustwidth environment, and some other easy code.</p> + +<p>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>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> diff --git a/Master/texmf-dist/doc/lualatex/novel/noveldocs-10-cover-art.html b/Master/texmf-dist/doc/lualatex/novel/noveldocs-10-cover-art.html new file mode 100644 index 00000000000..2900d58c2d1 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/novel/noveldocs-10-cover-art.html @@ -0,0 +1,226 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<meta http-equiv="content-type" content="text/html; charset=UTF-8"> +<title>Novel class documentation - Cover Artwork, CMYK 240 percent ink, PDF/X</title> +<link rel="stylesheet" type="text/css" href="html-resources/novel-doc.css"> +</head> + +<body> +<div id="master"> + + +<div id="toc"> + +<p>Document class "novel"</p> + +<p><a href="#a10">Cover Artwork;<br> +CMYK 240% Ink Limit;<br> +PDF/X Compliance</a></p> + +<ul> + + <li><a href="#a10.1">10.1 Begin With PNG</a></li> + <li><a href="#a10.2">10.2 Get Some Software</a></li> + <li><a href="#a10.3">10.3 Convert to CMYK 240% Ink</a></li> + <li><a href="#a10.4">10.4 Convert to PDF/X</a></li> + <li><a href="#a10.5">10.5 Final Check</a></li> + +</ul> + +<p> </p> +</div><!-- end toc --> + + + +<div id="main"> +<a id="a10"></a> +<h1>Documentation for <code>novel</code> document class</h1> +<p>Documentation version: 1.2.</p> + + +<div class="pagetopage"> +<p><b>User Guide</b></p> +<p><a href="noveldocs-01-overview.html">1. Overview</a></p> +<p><a href="noveldocs-02-class-options.html">2. Class Options</a></p> +<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-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> +<span style="visibility:hidden">9. </span>Footnotes, Endnotes.</a></p> +<p>10. Cover Artwork</p> +</div> + + + +<h2 style="clear:none">Cover Artwork, CMYK 240% Ink Limit;<br> +PDF/X Compliance</h2> + +<p>This page serves a limited purpose. It is for the benefit of those who need to submit color print cover artwork in the form of a PDF/X-1a:2001 file, with the artwork as CMYK and 240% ink limit. This is the format required by some American print-on-demand services. It is also generally acceptable to others, whose requirements are less restrictive.</p> + +<p>The <em>novel</em> document class does not provide any support for creating the original artwork, either image or text. In fact, TeX is not the best way to do that. Use a graphics program (such as the free GIMP) to do your artwork, including text. In the end, your text will be rasterized, just like any background image.</p> + +<p>DO NOT PLACE A BARCODE. Create the required white rectangle, where the barcode will go. Almost every print service is willing to create the barcode from your ISBN, and place the barcode image into your PDF during post-processing. Some of them even demand that they do it themselves. Do-it-yourself barcodes are incompatible with the following instructions.</p> + +<p><b>DISCLAIMER:</b> This documentation, and its accompanying software, is offered AS-IS, WITHOUT WARRANTY EXPRESS OR IMPLIED. USE ONLY AT YOUR OWN RISK. The author is an amateur who does not profess expertise in these matters.</p> + + + +<a id="a10.1"></a> +<h3>10.1 Begin With PNG</h3> + +<p>Create your artwork, including all text (but not barcode or barcode text) using whatever means you have. How you do it is not relevant. To follow these instructions, you must provide the artwork as a flattened (no transparency) PNG format image, at correct size (including bleed area) and resolution (dpi).</p> + +<p style="margin-top:8px"><b>Example:</b> Suppose your book is 5.5" x 8.5" softcover, a typical size for American fiction. Based on its page count and paper, you are told that the spine width must be 0.62". The required beed width, on all four sides, must be 0.125".</p> + +<p>Then, the image is 0.125 + 5.5 + 0.62 + 5.5 + 0.125 = 11.87in wide.</p> + +<p>The image is 0.125 + 8.5 + 0.125 = 8.75in high.</p> + +<p>At 300dpi resolution (a typical value) the image must be 11.87 x 300 = 3561 picels wide, and 8.75 x 300 = 2625 pixels high. In case of fractional pixels, round upward. The exact pixel count is important.</p> + +<p style="margin-top:8px"><img src="html-resources/example-adobergb.png" class="floatright" width="445" height="328" alt="example rgb image"> It is best to use the AdobeRGB1998 color workspace, or equivalent. But you can also use sRGB, or equivalent, and in many cases you will not notice much difference. It is helpful to attach (embed) the workspace color profile in your PNG image, especially if it is something other than AdobeRGB1998 or sRGB. Note that the workspace is NOT the color profile of your monitor (if you have it). If you do not attach (embed) the workspace color profile, then remember whether you were using AdobeRGB1998 or sRGB. If you make a mistake here, it is not fatal. It merely means that some colors (particularly bright greens and blue-greens) will print somewhat brighter or duller than you were expecting.</p> + +<p>When done, export it as a flattened PNG. An example image of this size can be found in the EXTRAS/novel-coverart-demo folder of the author's <a href="https://github.com/RobtAll/novel/" rel="external" target="new">GitHub site</a>.</p> + +<p>If you are provided with an image other than PNG, you have to convert it to PNG. No alternative. It is easy enough to use GIMP to convert most image formats. If you have a PDF (which is not already in the required format), GIMP can probably open it as an image. Be sure you import it with the correct resolution. Again, the pixel width and height are important.</p> + + +<a id="a10.2"></a> +<h3>10.2 Get Some Software</h3> + +<p>You need the 238% ink limit color profile from <a href="http://www.newselfpublishing.com/TotalInkLimit.html" rel="external" target="new">Aaron Shepard</a>. This does the magic of ensuring that you comply with the 240% ink limit (the profile provides a little headroom, which seems necessary). It can also be used for softproofing, if you know how to do that.</p> + +<p>You might (or might not) need the <a href="https://www.adobe.com/support/downloads/iccprofiles/iccprofiles_win.html" rel="external" target="new">Adobe icc profiles</a> (for end users). This link works for Windows or Linux (even though it says "for <p>Windows"). I am told that there is a different link for Mac, but I don't have a Mac.</p> + +<p>Get GraphicsMagick. On Linux, you can install it via your system package manager. On Windows, get the Q16 binaries for your system (32 or 64 bit) from <a href="https://sourceforge.net/projects/graphicsmagick/files/graphicsmagick-binaries/" rel="external" target="new">SourceForge</a>. I am told that versions for Mac are available via homebrew and macports, but again, I do not have a Mac, so I cannot check that.</p> + + + +<a id="a10.3"></a> +<h3>10.3 Convert Your Image to CMYK at 240% Ink Limit</h3> + +<p><img src="html-resources/example-cmyk238.png" class="floatright" width="445" height="328" alt="example cmyk238 image, back to rgb"> At right, you can see an emulation of the above cover artwork, softproofed to CMYK at 238% ink limit. It is not the CMYK file itself, but an RGB image that is supposed to help you visualize what happens during conversion. You will notice that the colors are less intense, because the original image contained colors that didn't fit the gamut of the printing process. Colors don't always change; I could have planned ahead, and selected from a palette of colors that fit within the gamut.</p> + +<p><b>Get ready:</b> Make a copy of the above 238% ink limit color profile, and re-name the copy as "238.icc". + +<p>I will call your original PNG image "yourimage.png". Put this image, the 238.icc file, and (if necessary) the AdobeRGB1998.icc file in a single working folder.</p> + +<p>I will also assume that the image resolution is 300dpi. If it is something else, then modify 300 to the other number, when you see it below.</p> + +<p style="margin-top:16px"><b>Step 1:</b> Open a Terminal (Command Prompt) and navigate to that folder. In the following commands, the initial "gm" calls GraphicsMagick. Code:</p> + +<div class="codeblock"> +<p><code>gm convert yourimage.png embedded.icc</code></p> +</div> + +<p>The above command may return the message "No color profile available" and generate a zero-byte embedded.icc file. Not a problem. Discard the zero-byte file. But if it generates a non-zero embedded.icc file, keep it.</p> + +<p style="margin-top:16px"><b>Step 2:</b> Next (note the file extensions):</p> + +<div class="codeblock"> +<p><code>gm convert -strip yourimage.png yourimage-stripped.tif</code></p> +</div> + +<p style="margin-top:16px"><b>Step 3:</b> At this point, there are three possibilities:</p> + +<p>(a) You have a non-zero embedded.icc file. In this case:</p> + +<div class="codeblock"> +<p><code>gm convert -profile embedded.icc -profile 238.icc yourimage-stripped.tif yourimage-temp.tif</code></p> +</div> + +<p>(b) No embedded.icc, but you know that the artwork was create using AdobeRGB1998 workspace, or equivalent. Then:</p> + +<div class="codeblock"> +<p><code>gm convert -profile AdobeRGB1998.icc -profile 238.icc yourimage-stripped.tif yourimage-temp.tif</code></p> +</div> + +<p>(c) Neither of the above. The image is probably sRGB (default), so:</p> + +<div class="codeblock"> +<p><code>gm convert -profile 238.icc yourimage-stripped.tif yourimage-temp.tif</code></p> +</div> + +<p style="margin-top:16px"><b>Step 4:</b> Now, regardless of which possibility you used above:</p> + +<div class="codeblock"> +<p><code>gm mogrify -strip yourimage-temp.tif</code></p> +</div> + +<p style="margin-top:16px"><b>Step 5:</b> And finally:</p> + +<div class="codeblock"> +<p><code>gm convert -units PixelsPerInch -density 300 -quality 100 yourimage-temp.tif yourimage-cmyk240.jpg</code></p> +</div> + +<p style="margin-top:16px"><b>Step 6:</b> Now verify your work:</p> + +<div class="codeblock"> +<p><code>gm identify -verbose yourimage-cmyk-240.jpg</code></p> +</div> + +<p>The report should show that the image is CMYK, that it is at 300 pixels/inch, and that there is NO entry for "Profile-color". It will not have anything to say about ink limit, or SWOP.</p> + + + + +<a id="a10.4"></a> +<h3>10.4 Convert your CMYK Image to PDF/X.</h3> + +<p>Up to now, you did not need TeX. Now you do. Be sure that you have a working TeX installation, with the <em>novel</em> document class package.</p> + +<p>In folder (your TeX root)/doc/lualatex/novel you will find file "novel-coverart-template.tex". Place a copy in the same working folder as your image, and modify it as needed.</p> + +<p><code>\SetMediaSize</code> refers to the full size of the image, with units (usually in). This includes the bleed box. For the example image, <code>\SetMediaSize{11.87in}{8.75in}</code>.</p> + +<p><code>\SetTrimSize</code> refers to the trimmed image, without bleed. For the example image, <code>\SetTrimSize{11.62in}{8.5in}</code>.</p> + +<p><code>\SetPDFX[CGATSTR001]{X-1a:2001}</code> will get you "Us Web Coated SWOP v2" output intent (most common the USA), and PDF/X-1a:2001 compliance. The Output Intent *.icc color profile will NOT be embedded, because this is almost always the way that print services want it. The PDF contains a code identifying the intent, so there is no need to embed the color profile (and disadvantages to embedding it). In the unlikely event that they demand the Output Intent color profile embedded, put an asterisk on the command.</p> + +<p>For compliance you need to use <code>\SetTitle</code>. The title for this file might not be the title of your book, because this file isn't your book. Ask you print service what they want. Same with <code>\SetAuthor</code>.</p> + +<p>You can use <code>\SetApplication</code> and <code>\SetProducer</code> to change internal identifiers. Don't use these unless you have a reason.</p> + +<p><code>\SetCoverImage</code> is self-explanatory. Must have file extension jpg, jpeg, JPG, or JPEG. Must be CMYK. Note that TeX cannot verify whether the image is in correct color space. It will compile, even if the image is wrong. Beware!</p> + +<p>Do not attempt to write anything between <code>\begin{document}</code> and <code>\end{document}</code>. If you erroneously put something there, the document will probably compile, and it may even be a valid PDF/X file. However, the resulting color will almost surely be wrong. If so, the problem will be detected when you submit your file (wrong ink limit or color space).</p> + +<p>Compiling may take a little longer than expected. If your TeX system opens a PDF viewer automatically, the image might be missing (or partial) until a few seconds after the viewer opens. Be patient.</p> + + + +<a id="a10.5"></a> +<h3>10.5 Final Check</h3> + +<p>Open the PDF in Adobe Reader, which does a trick that no other free software will do, to my knowledge. If your platform does not have Adobe Reader, then find a friend who has it. May be a different platform.</p> + +<p>In Adobe Reader, go to Edit, Preferences, Documents. Check "Save As optimizes for fast web view." Then go to Edit, Preferences, Page Disaply. Check "Show art, trim, and bleed boxes." Then OK.</p> + +<p>Open your PDF. You should see a light green box, just inside the image boundary. This shows the Trim Area. This box does not print; it is only for visualization. Go to File, Properties, Fonts. There should be no fonts listed.</p> + +<p>Then, "Save As" the same file name (or another one, if you prefer). This will optimize the file. You probably do not need to do that, but it does not hurt, and a few services expect it.</p> + +<p><b>Remember the Disclaimer!</b> Your PDF file should now be ready for submission. Only "should," not "is," because this documantation and its accompanying software comes without warranty. Submit at your own risk!</p> + +<p>All I can say is that it "works for me":</p> + +<p class="centerimg"><img src="html-resources/verified238.png" width="700" height="446" alt="works for me"></p> + + + + + +</div><!-- end main --> + +<div id="finish"></div> + +</div><!-- end master --> + +</body> +</html> + |
