Debian Codegraph @

doc/help.html

raw
1 <HTML>
2 <HEAD>
3 <TITLE>HTMLDOC On-Line Help</TITLE>
4 <STYLE>
5 BODY { font-family: serif }
6 H1, H2, H3, H4, H5, H6 { font-family: sans-serif }
7 SUP, SUB, PRE { font-size: smaller }
8 </STYLE>
9 </HEAD>
10 <BODY>
11
12 <H1><A NAME="CONTENTS">HTMLDOC On-Line Help</A></H1>
13
14 <UL>
15
16 <LI><A HREF="#LOADSAVE">Loading and Saving Books</A>
17
18 <LI><A HREF="#INPUT">The Input Tab</A>
19
20 <LI><A HREF="#OUTPUT">The Output Tab</A>
21
22 <LI><A HREF="#PAGE">The Page Tab</A>
23
24 <LI><A HREF="#TOC">The TOC Tab</A>
25
26 <LI><A HREF="#COLORS">The Colors Tab</A>
27
28 <LI><A HREF="#FONTS">The Fonts Tab</A>
29
30 <LI><A HREF="#PS">The PS Tab</A>
31
32 <LI><A HREF="#PDF">The PDF Tab</A>
33
34 <LI><A HREF="#SECURITY">The Security Tab</A>
35
36 <LI><A HREF="#OPTIONS">The Options Tab</A>
37
38 </UL>
39
40 <HR>
41
42 <P><A NAME="LOADSAVE"><A HREF="#CONTENTS">Contents</A></A>
43
44 <H1>Loading and Saving Books</H1>
45
46 HTMLDOC stores the HTML files, settings, and options you have
47 chosen in <CODE>.BOOK</CODE> files. The buttons on the bottom of the
48 HTMLDOC window allow you manage these files and generate
49 formatted documents.
50
51 <TABLE>
52 <TR>
53 <TH WIDTH="80">Button</TH>
54 <TH WIDTH="300">Description</TH>
55 </TR>
56 <TR>
57 <TD>Help</TD>
58 <TD>Displays this on-line help.</TD>
59 </TR>
60 <TR>
61 <TD>New</TD>
62 <TD>Creates a new <CODE>.BOOK</CODE> file.</TD>
63 </TR>
64 <TR>
65 <TD>Open...</TD>
66 <TD>Opens an existing <CODE>.BOOK</CODE> file.</TD>
67 </TR>
68 <TR>
69 <TD>Save</TD>
70 <TD>Saves the current <CODE>.BOOK</CODE> file to disk.</TD>
71 </TR>
72 <TR>
73 <TD>Save As...</TD>
74 <TD>Saves the current <CODE>.BOOK</CODE> file to disk using
75 the name you specify.</TD>
76 </TR>
77 <TR>
78 <TD>Generate</TD>
79 <TD>Generates the current <CODE>.BOOK</CODE> file into a HTML,
80 PDF, or PostScript file.</TD>
81 </TR>
82 <TR>
83 <TD>Close</TD>
84 <TD>Exits HTMLDOC.</TD>
85 </TR>
86 </TABLE>
87
88 <HR>
89
90 <P><A NAME="INPUT"><A HREF="#CONTENTS">Contents</A> |
91 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
92
93 <H1>The Input Tab</H1>
94
95 The input tab lists all of the source files that are used to generate the
96 document. You can also specify the type of document (book or web page) and the
97 title and logo images.
98
99 <H2>Setting the Document Type</H2>
100
101 Normally HTMLDOC generates indexed documents from your structured source files.
102 To convert a single unstructured document (or "web page") click on the
103 <I>Continuous</I> or <I>Web Page</I> radio buttons. The <I>Web Page</I> type
104 inserts page breaks between each file or URL, while the <I>Continuous</I> type
105 does not.
106
107 <P>Structured HTML files use heading elements (<CODE>H1</CODE>, <CODE>H2</CODE>,
108 etc.) to delineate chapters and headings within a document.
109
110 <H2>Adding Input Files</H2>
111
112 <P>Click on the <I>Add File(s)...</I> button to add one or more HTML or Markdown
113 files to your <CODE>.BOOK</CODE> file.
114
115 <H2>Adding URLs</H2>
116
117 <P>Click on the <I>Add URL(s)...</I> button to add one or more URLs to your
118 <CODE>.BOOK</CODE> file.
119
120 <H2>Deleting Input Files</H2>
121
122 <p>Highlight the file(s) in the input file list and then click on the
123 <I>Delete</I> button to remove one or more source files from your document. The
124 files are removed from your document but are <I>not</I> deleted from disk.</p>
125
126 <H2>Editing Input Files</H2>
127
128 <p>Highlight the file(s) in the input file list and then click on the
129 <I>Edit...</I> button to edit one or more source files in your document. By
130 default this starts the <I>gedit</I> editor under Linux, the <i>bbedit</i>
131 editor under macOS, and the <I>Notepad</I> editor under Windows.</p>
132
133 <P>The editor can be changed in the <A HREF="#OPTIONS">Options Tab</A>.
134
135 <H2>Reordering Input Files</H2>
136
137 Highlight the file(s) in the input file list and then click on the <I>Move
138 Up</I> or <I>Move Down</I> buttons to change the order of the input files.
139
140 <H2>Selecting a Letterhead Image</H2>
141
142 <p>The letterhead image can be shown in the header or footer of pages in the
143 PostScript and PDF output files. Click on the <I>Browse</I> button to select a
144 letterhead image file using the file chooser.</p>
145
146 <H2>Selecting a Logo Image</H2>
147
148 <p>The logo image can be shown in the header or footer of pages in the
149 PostScript and PDF output files. Click on the <I>Browse</I> button to select a
150 logo image file using the file chooser.</p>
151
152 <H3>Selecting a Title File or Image</H3>
153
154 <p>The title file or image is used for the title page. Click on the
155 <I>Browse</I> button to select a title file using the file chooser.</p>
156
157 <HR>
158
159 <P><A NAME="OUTPUT"><A HREF="#CONTENTS">Contents</A> |
160 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
161
162 <H1>The Output Tab</H1>
163
164 <p>The output tab specifies where your document will be generated, the output
165 format, and some of the output options.</p>
166
167 <H2>Selecting File or Directory Generation</H2>
168
169 <p>HTMLDOC can generate a single EPUB, HTML, PDF, or PostScript file, or a
170 series of files to a directory when generating HTML or PostScript output.</p>
171
172 <P>Click on the <I>File</I> radio button to select single file output.
173 Click on the <I>Directory</I> radio button to generate multiple files
174 to a directory.</p>
175
176 <H2>Selecting an Output File or Directory</H2>
177
178 <p>The output file is the EPUB, HTML, PostScript, or PDF file you wish to
179 generate from your source files. Click on the <I>Browse</I> button to select an
180 output file using the file chooser.</p>
181
182 <H2>Selecting the Output Format</H2>
183
184 <p>Click on the corresponding <I>Output Type</I> radio button to select an
185 output format. You can select the PostScript language level in the
186 <A HREF="#PS">PS Tab</A> and the PDF version in the <A HREF="#PDF">PDF Tab</A>.
187
188 <H2>Selecting Grayscale Output</H2>
189
190 <p>When generating PostScript or PDF files you can choose to convert all images
191 to grayscale. This is necessary for many Level 1 printers that do not support
192 color images and can reduce the size of output files considerably.</p>
193
194 <P>Click in the <I>Grayscale</I> check box to enable or disable grayscale
195 output.</p>
196
197 <H2>Title Page</H2>
198
199 <p>The title page is the first page in your generated file. Click in the
200 <I>Title Page</I> check box to turn the title page on or off.</p>
201
202 <H2>JPEG Big Images</H2>
203
204 <p>JPEG compression is a great way to reduce the size of large photographic
205 or continuous-tone images. It is supported when generating PDF, PostScript
206 Level 2, and PostScript Level 3 output. HTMLDOC uses JPEG compression when the
207 output image cannot be reduced to 256 colors or less.</p>
208
209 <P>Click in the <I>JPEG Big Images</I> check box to enable or disable
210 JPEG compression.</p>
211
212 <H2>JPEG Quality</H2>
213
214 <p>Drag the <I>JPEG Quality</I> slider to change the JPEG quality setting.
215 The JPEG quality setting determines the relative quality of the compressed
216 image. Since JPEG is a <I>lossy</I> compression algorithm, higher
217 compression generally yields lower quality. Typically a quality of 75 or
218 higher provides excellent image quality with a high amount of compression.</p>
219
220 <H2>Compression</H2>
221
222 <p>PDF 1.2, PDF 1.3, PDF 1.4, and Level 3 PostScript files can be compressed
223 using Flate (a.k.a. ZIP) compression to substantially reduce the size of files.
224 Drag the <I>Compression</I> slider to set the amount of compression to use.</p>
225
226 <P>Unlike JPEG, the Flate algorithm is lossless and will not cause any
227 loss of visual quality at any level of compression.</p>
228
229 <HR>
230
231 <P><A NAME="PAGE"><A HREF="#CONTENTS">Contents</A> |
232 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
233
234 <H1>The Page Tab</H1>
235
236 <P>The page tab defines the page header, footer, size, and margins for
237 PostScript and PDF output.
238
239 <H2>Page Size</H2>
240
241 <P>The page size option is only available for PostScript and PDF output.
242 HTMLDOC supports the following standard page size names:
243
244 <UL>
245 <LI>A3 - 11.69x16.54in (297x420mm)
246 <LI>A4 - 8.27x11.69in (210x297mm)
247 <LI>Legal - 8.5x14in (216x356mm)
248 <LI>Letter - 8.5x11in (216x279mm)
249 <LI>Tabloid - 11x17in (279x432mm)
250 <LI>Universal - 8.27x11in (210x279mm)
251 </UL>
252
253 <P>Click on the <I>Page Size</I> arrow button to select a standard page
254 size. You can specify a custom page size by double-clicking on the page
255 size text and entering the page width and length separated by the letter
256 "x". Append the letters "in" for inches, "mm" for millimeters, or "cm"
257 for centimeters.
258
259 <P><B>Note:</B> This option does not set the page size on the printer.
260 It only generates pages using the specified size. See the <A HREF="#PS">PS
261 Tab</A> to enable printer commands for PostScript printers.
262
263 <H2>2-Sided</H2>
264
265 <P>Click in the <I>2-Sided</I> check box to select double-sided (duplexed)
266 output.
267
268 <P><B>Note:</B> This option does not select duplexing on the printer.
269 It only generates pages with the left/right margins swapped on even
270 numbered pages and forces all chapters (and the table-of-contents) to
271 start on an odd-numbered page. See the <A HREF="#PS">PS Tab</A> to enable
272 printer commands for PostScript printers.
273
274 <H2>Landscape</H2>
275
276 <P>Click in the <I>Landscape</I> check box to select landscape output.
277
278 <H2>Page Margins</H2>
279
280 <P>The left, right, top, and bottom margins can be changed by clicking in the
281 appropriate text field and entering a new margin. Append the letters "in"
282 for inches, "mm" for millimeters, or "cm" for centimeters.
283
284 <H2>Header and Footer</H2>
285
286 <P>Select the desired text from each of the option buttons to customize the
287 header and footer for the document/body pages. The left option buttons
288 set the text that is left-justified, the middle buttons set the text
289 that is centered, and the right buttons set the text that is right-justified.
290
291 <P>The left and right header and footer are swapped automatically when
292 generating duplexed output.
293
294 <H2>Number Up</H2>
295
296 <P>The <I>Number Up</I> chooser selects the number of document
297 pages that will appear on each output page. Click on the chooser
298 to select a different number of pages.
299
300 <HR>
301
302 <P><A NAME="TOC"><A HREF="#CONTENTS">Contents</A> |
303 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
304
305 <H1>The Table-Of-Contents Tab</H1>
306
307 The table-of-contents tab defines the number of levels in the
308 table-of-contents and the page header and footer that are used when
309 generating PostScript and PDF files.
310
311 <H2>Customizing the Table of Contents</H2>
312
313 To change the number of header levels listed in the table of contents, or to
314 turn off table-of-contents generation entirely, click on <I>Table of Contents</I>
315 chooser and select the number of levels desired.
316
317 <H2>Numbering Table of Contents Headings</H2>
318
319 To number the headings in your document, click on the <I>Numbered Headings</I>
320 toggle button.
321
322 <H2>Customizing the Header and Footer</H2>
323
324 To customize the header and footer for the table-of-contents pages, select the
325 desired text from each of the option buttons. The leftmost option buttons
326 set the text that is left-justified, while the middle buttons set the text that
327 is centered and the right buttons set the text that is right-justified.
328
329 <H3>Title</H3>
330
331 Enter the desired title for the table-of-contents in the <I>Title</I>
332 field.
333
334 <HR>
335
336 <P><A NAME="COLORS"><A HREF="#CONTENTS">Contents</A> |
337 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
338
339 <H1>The Colors Tab</H1>
340
341 The colors tab specifies the colors and background image that should be
342 used for the document.
343
344 <H2>Body Color</H2>
345
346 The <VAR>Body Color</VAR> field specifies the default background color. It
347 can be a standard HTML color name or a hexadecimal RGB color of the
348 form <CODE>#RRGGBB</CODE>. Click on the <VAR>Lookup...</VAR> button to
349 pick the color graphically.
350
351 <H2>Body Image</H2>
352
353 The <VAR>Body Image</VAR> field specifies the default background image.
354 Click on the <VAR>Browse...</VAR> button to pick the background image using
355 the file chooser.
356
357 <H2>Text Color</H2>
358
359 The <VAR>Text Color</VAR> field specifies the default text color. It
360 can be a standard HTML color name or a hexadecimal RGB color of the
361 form <CODE>#RRGGBB</CODE>. Click on the <VAR>Lookup...</VAR> button to
362 pick the color graphically.
363
364 <H3>Link Color</H3>
365
366 The <VAR>Link Color</VAR> field specifies the default link color. It
367 can be a standard HTML color name or a hexadecimal RGB color of the
368 form <CODE>#RRGGBB</CODE>. Click on the <VAR>Lookup...</VAR> button to
369 pick the color graphically.
370
371 <H3>Link Style</H3>
372
373 The <VAR>Link Style</VAR> chooser specifies the default link decoration.
374
375 <HR>
376
377 <P><A NAME="FONTS"><A HREF="#CONTENTS">Contents</A> |
378 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
379
380 <H1>The Fonts Tab</H1>
381
382 The fonts tab contains all of the document font options. The default options
383 roughly correspond to those used by most browsers.
384
385 <H2>Base Font Size</H2>
386
387 Click on the left arrow buttons to decrease the font size and the right
388 arrow buttons to increase the font size.
389
390 <P>The font size value is in points (there are 72 points per inch).
391
392 <H2>Line Spacing</H2>
393
394 Click on the left arrow buttons to decrease the line spacing and the
395 right arrow buttons to increase the line spacing.
396
397 <H2>Body Typeface</H2>
398
399 The body typeface is the font used for paragraphs and most other text
400 in a document. Click on the <I>Body Typeface</I> option button to change
401 the body typeface.
402
403 <H2>Heading Typeface</H2>
404
405 The heading typeface is the font used for headings. Click on the
406 <I>Heading Typeface</I> option button to change the typeface used for
407 headings.
408
409 <H2>Header/Footer Size</H2>
410
411 Click on the left arrow buttons to decrease the heading and footer font
412 size and the right arrow buttons to increase the font size. The font size
413 value is in points (there are 72 points per inch).
414
415 <H2>Header/Footer Font</H2>
416
417 The header/footer font is the font used for headers at the top of
418 the page and footers at the bottom of the page. Click on the
419 <I>Header/Footer Font</I> option button to change the header/footer font.
420
421 <H2>Character Set</H2>
422
423 Click on the <I>Character Set</I> option button to change the encoding
424 of text in the document.
425
426 <H3>Options</H3>
427
428 <P>The <VAR>Embed Fonts</VAR> check box controls whether or not
429 fonts are embedded in PostScript and PDF output.
430
431 <HR>
432
433 <P><A NAME="PS"><A HREF="#CONTENTS">Contents</A> |
434 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
435
436 <H1>The PS Tab</H1>
437
438 The PS tab contains settings specific to PostScript output.
439
440 <H2>Language Level</H2>
441
442 Select the appropriate language level by clicking on the corresponding
443 radio button. Level 1 output is the most portable, however most PostScript
444 printers manufactured in the last 6 years support Level 2. Level 3 output
445 supports Flate compression, however very few printers support Level 3
446 PostScript at this time.
447
448 <H2>Send Printer Commands</H2>
449
450 Click in the <I>Send Printer Commands</I> check box to enable to
451 disable printer commands in the PostScript output files.
452 Printer commands are not supported for PostScript Level 1
453 output.
454
455 <H2>Include Xerox Job Comments</H2>
456
457 <P>The <VAR>Include Xerox Job Comments</VAR> check box controls
458 whether or not the output files contain Xerox job comments.
459 Click in the check box to enable or disable the job comments.
460
461 <P>Job comments are available with all levels of PostScript output.
462
463 <HR>
464
465 <P><A NAME="PDF"><A HREF="#CONTENTS">Contents</A> |
466 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
467
468 <H1>The PDF Tab</H1>
469
470 The PDF tab contains settings specific to PDF output.
471
472 <H2>PDF Version</H2>
473
474 The <VAR>PDF Version</VAR> radio buttons control what version of PDF is
475 generated. PDF 1.4 is the most commonly supported version. Click on the
476 corresponding radio button to set the version.
477
478 <H2>Page Mode</H2>
479
480 The <VAR>Page Mode</VAR> option button controls the initial viewing mode
481 for the document. Click on the option button to set the page mode.
482
483 <P>The <VAR>Document</VAR> page mode displays only the document pages.
484 The <VAR>Outline</VAR> page mode displays the table-of-contents outline
485 as well as the document pages. The <VAR>Full-Screen</VAR> page mode
486 displays the document pages on the whole screen; this mode is used
487 primarily for presentations.
488
489 <H2>Page Layout</H2>
490
491 The <VAR>Page Layout</VAR> option button controls the initial layout of
492 document pages on the screen. Click on the option button to set the page
493 layout.
494
495 <P>The <VAR>Single</VAR> page layout displays a single page at a time.
496 The <VAR>One Column</VAR> page layout displays a single column of pages
497 at a time. The <VAR>Two Column Left</VAR> and <VAR>Two Column
498 Right</VAR> page layouts display two columns of pages at a time; the
499 first page is displayed in the left or right column as selected.
500
501 <H2>First Page</H2>
502
503 The <VAR>First Page</VAR> option button controls the initial page that is
504 displayed. Click on the option button to choose the first page.
505
506 <H2>Page Effect</H2>
507
508 The <VAR>Page Effect</VAR> option button controls the page effect that is
509 displayed in <VAR>Full-Screen</VAR> mode. Click on the option button to
510 select a page effect.
511
512 <H2>Page Duration</H2>
513
514 The <VAR>Page Duration</VAR> slider controls the number of seconds that
515 each page will be visible in <VAR>Full-Screen</VAR> mode. Drag the slider
516 to adjust the number of seconds.
517
518 <H2>Effect Duration</H2>
519
520 The <VAR>Effect Duration</VAR> slider controls the number of seconds
521 that the page effect will last when changing pages. Drag the slider to
522 adjust the number of seconds.
523
524 <H3>Options</H3>
525
526 <P>The <VAR>Include Links</VAR> check box controls whether or
527 not hyperlinks are included in PDF output.
528
529 <HR>
530
531 <P><A NAME="SECURITY"><A HREF="#CONTENTS">Contents</A> |
532 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
533
534 <H1>The Security Tab</H1>
535
536 <P>The security tab allows you to enable PDF document encryption
537 and security features.
538
539 <H2>Encryption</H2>
540
541 <P>The <VAR>Encryption</VAR> buttons control whether or not encryption is
542 performed on the PDF file. Encrypted documents can be password protected and
543 also provide user permissions.
544
545 <H2>Permissions</H2>
546
547 <P>The <VAR>Permissions</VAR> buttons control what operations are allowed by
548 the PDF viewer.
549
550 <H2>Owner Password</H2>
551
552 <P>The <VAR>Owner Password</VAR> field contains the document owner password,
553 a string that is used by Adobe Acrobat to control who can change document
554 permissions, etc.
555
556 <P>If this field is left blank, a random 32-character password is generated
557 so that no one can change the document using the Adobe tools.
558
559 <H2>User Password</H2>
560
561 <P>The <VAR>User Password</VAR> field contains the document user password,
562 a string that is used by Adobe Acrobat to restrict viewing permissions on
563 the file.
564
565 <P>If this field is left blank, any user may view the document without entering
566 a password.
567
568 <HR>
569
570 <P><A NAME="OPTIONS"><A HREF="#CONTENTS">Contents</A> |
571 <A HREF="#LOADSAVE">Loading and Saving Books</A></A>
572
573 <H1>The Options Tab</H1>
574
575 The options tab contains the current HTML editor and allows you to save
576 the current settings as defaults.
577
578 <H2>HTML Editor</H2>
579
580 Type in the program name in the <I>HTML Editor</I> field or click on the
581 <I>Browse...</I> button to change the HTML editor that is used. The "%s"
582 is required and is replaced by the file to edit.
583
584 <H2>Browser Width</H2>
585
586 Drag the <I>Browser Width</I> slider to specify the width of the browser in
587 pixels that is used to scale images and other pixel measurements to the
588 printable page width. You can adjust this value to more closely match the
589 formatting on the screen.
590
591 <P>The default browser width is 680 pixels which corresponds
592 roughly to a 96 DPI display. The browser width is only used
593 when generating PostScript or PDF files.
594
595 <H2>Search Path</H2>
596
597 Enter a list of directories in the <I>Search Path</I> field to specify
598 a search path for files that are loaded by HTMLDOC. This is usually used
599 to get images that use absolute server paths to load.
600
601 <P>Directories are separated by the semicolon (;) so that drive letters
602 and URLs can be specified.
603
604 <H2>HTTP Proxy URL</H2>
605
606 Enter the URL for the HTTP proxy in the <I>HTTP proxy URL</I> field to
607 specify a proxy host for all HTTP requests.
608
609 <H2>Tooltips</H2>
610
611 <P>Check the <I>Tooltips</I> button to enable tooltips on GUI controls.
612
613 <H2>Strict HTML</H2>
614
615 <P>Check the <I>Strict HTML</I> button to enable strict HTML conformance
616 checking in HTMLDOC.
617
618 <H2>Save Options and Defaults</H2>
619
620 Click on the <I>Save Options and Defaults</I> button to save the current
621 HTML editor, page, table-of-contents, color, font, PDF, and PostScript
622 options. Default options are used for new documents and when generating
623 documents from the command-line.
624
625 </BODY>
626 </HTML>