1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
<HTML>
<BODY>
<!-- FOOTER RIGHT "B-$CHAPTERPAGE" -->
<DIV ALIGN="justify">
<H1 ALIGN="RIGHT"><A NAME="BOOKFORMAT">Appendix B - Book File Format</A></H1>
<P>This appendix describes the HTMLDOC <VAR>.book</VAR> file format.
<H2>Introduction</H2>
<P>The HTMLDOC <VAR>.book</VAR> file format is a simple
text format that provides the command-line options and files
that are part of the document. These files can be used from the
GUI interface or from the command-line using the
<CODE>--batch</CODE> option:
<PRE>
htmldoc filename.book
htmldoc --batch filename.book
</PRE>
<P>The first form will load the book and display the GUI interface, if configured.
Windows users should use <VAR>ghtmldoc.exe</VAR> executable to show the GUI and
<VAR>htmldoc.exe</VAR> for the batch mode:
<PRE>
ghtmldoc.exe filename.book
htmldoc.exe --batch filename.book
</PRE>
<H2>The Header</H2>
<P>Each <VAR>.book</VAR> file starts with a line reading:
<PRE>
#HTMLDOC 1.9
</PRE>
<P>The version number (1.9) is optional.
<H2>The Options</H2>
<P>Following the header is a line containing the options for the book. You can
use any valid command-line option on this line:
<PRE>
-f htmldoc.pdf --titleimage htmldoc.png --duplex --compression=9 --jpeg=90
</PRE>
<P>Long option lines can be broken using a trailing backslash (<TT>\</TT>) on
the end of each continuation line:</P>
<PRE>
-f htmldoc.pdf --titleimage htmldoc.png --duplex \
--compression=9 --jpeg=90
</PRE>
<H2>The Files</H2>
<P>Following the options are a list of files or URLs to include in the document:
<PRE>
1-intro.html
2-using.html
3-cmdref.html
4-htmlref.html
5-mdref.html
a-license.html
b-book.html
</PRE>
<H2>Putting It All Together</H2>
<P>The following is the complete book file needed to generate this documentation:
<PRE>
#HTMLDOC 1.9
-f htmldoc.pdf --titleimage htmldoc.png --duplex --compression=9 --jpeg=90
1-intro.html
2-using.html
3-cmdref.html
4-htmlref.html
5-mdref.html
a-license.html
b-book.html
</PRE>
</DIV>
</BODY>
</HTML>
|