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