|
Syntax
|
Description
|
Example
|
|
<HR Break>
|
This is for page break! Placing text after this tag will cause the text to be written to the next page.
|
<HR Break>
Next Page Text Here
|
<!-- FOOTER LEFT "foo" -->
<!-- FOOTER CENTER "foo" -->
<!-- FOOTER RIGHT "foo" -->
|
Sets the left, center, and/or right footer text; the test is applied to the current page if empty,
or the next page otherwise.
|
<!-- HEADER LEFT "PDF Document Footer Text" -->
<!-- HEADER RIGHT "Page 1" -->
|
<!-- HEADER LEFT "foo" -->
<!-- HEADER CENTER "foo" -->
<!-- HEADER RIGHT "foo" -->
|
Sets the left, center, and/or right header text; the test is applied to the current page if empty,
or the next page otherwise.
|
<!-- HEADER CENTER "Gilgamesh Solutions" -->
<!-- HEADER RIGHT "Page 1" -->
|
--footer lcr
--header lcr
|
l: Left Alignment
c: Center Alignment
r: Right Alignment
The --footer option specifies the contents of the page footer. --header
option is for the header of
the page.
In place of the l, c, and r, you can put one
of these options:
| lcr | Description |
|---|
| . | A period indicates that the field
should be blank. |
| : | A colon indicates that the field should
contain the current and total number of pages in the chapter (n/N). |
| / | A slash indicates that the field should
contain the current and total number of pages (n/N). |
| 1 | The number 1 indicates that the field
should contain the current page number in decimal format (1, 2, 3, ...) |
| a | A lowercase "a" indicates that the
field should contain the current page number using lowercase letters. |
| A | An uppercase "A" indicates that the
field should contain the current page number using UPPERCASE letters. |
| c | A lowercase "c" indicates that the
field should contain the current chapter title. |
| C | An uppercase "C" indicates that the
field should contain the current chapter page number. |
| d | A lowercase "d" indicates that the
field should contain the current date. |
| D | An uppercase "D" indicates that the
field should contain the current date and time. |
| h | An "h" indicates that the field should
contain the current heading. |
| i | A lowercase "i" indicates that the
field should contain the current page number in lowercase roman
numerals (i, ii, iii, ...) |
| I | An uppercase "I" indicates that the
field should contain the current page number in uppercase roman
numerals (I, II, III, ...) |
| l | A lowercase "l" indicates that the
field should contain the logo image. |
| t | A lowercase "t" indicates that the
field should contain the document title. |
| T | An uppercase "T" indicates that the
field should contain the current time. |
Setting the footer to "..." disables the footer entirely.
|
--footer DIt
This will produce a footer with current date and time on the left,
current page number in uppercase roman
numerals in the center, and the
document's title on the right side.
|
|
--headfootfont font
|
The --headfootfont option specifies the font that is used for the header and footer text. The font parameter
can be one of the following:
* Courier
* Courier-Bold
* Courier-Oblique
* Courier-BoldOblique
* Times
* Times-Roman
* Times-Bold
* Times-Italic
* Times-BoldItalic
* Helvetica
* Helvetica-Bold
* Helvetica-Oblique
* Helvetica-BoldOblique
This option is only available when generating PostScript or PDF files.
|
--headfootfont "Courier"
|
|
--headfootsize size
|
The --headfootsize option sets the size of the header and footer text in points (1 point = 1/72nd inch).
This option is only available when generating PostScript or PDF files.
|
--headfootsize 1
|
|
--headingfont typeface
|
The --headingfont options sets the typeface that is used for headings in the document. The typeface
parameter can be one of the following:
typeface Actual Font
Arial: Helvetica
Courier: Courier
Helvetica: Helvetica
Monospace: Courier
Sans-Serif: Helvetica
Serif: Times
Symbol: Symbol
Times: Times
|
--headingfont "Symbol"
|
|
<!-- NEED length -->
|
Break if there is less than length units left on the current page. The length value defaults to lines of
text but can be suffixed by in, mm, or cm to convert from the corresponding units.
|
<!-- NEED 3 -->
If there are 3 lines left on the page, break to the next page.
|
|
<!-- NUMBER-UP nn -->
|
Sets the number of pages that are placed on each output page. Valid values are 1, 2, 4, 6, 9, and 16.
|
<!-- NUMBER-UP 4 -->
|
|
-t format
|
Format Description
html: Generate one or more indexed HTML files.
pdf: Generate a PDF file (default version - 1.3).
pdf11: Generate a PDF 1.1 file for Acrobat Reader 2.0.
pdf12: Generate a PDF 1.2 file for Acrobat Reader 3.0.
pdf13: Generate a PDF 1.3 file for Acrobat Reader 4.0.
pdf14: Generate a PDF 1.4 file for Acrobat Reader 5.0.
ps: Generate one or more PostScript files (default level).
ps1: Generate one or more Level 1 PostScript files.
ps2: Generate one or more Level 2 PostScript files.
ps3: Generate one or more Level 3 PostScript files.
|
-t pdf14
|
|
--linkcolor color
|
The --linkcolor option specifies the color of links in HTML and PDF output. The color can be specified by
name or as a 6-digit hexadecimal number of the form #RRGGBB.
|
--linkcolor "#ffff00"
|
|
--links
|
The --links option specifies that PDF output should contain hyperlinks.
|
--links
|
|
--linkstyle style
|
The --linkstyle option specifies the style of links in HTML and PDF output. The style can be "plain" for
no decoration or "underline" to underline links.
|
--linkstyle "plain"
|
|
--browserwidth pixels
|
The --browserwidth option specifies the browser width in pixels. The browser width is used to scale images
and pixel measurements when generating PostScript and PDF files. It does not affect the font size of text.
The default browser width is 680 pixels which corresponds roughly to a 96 DPI display. Please note that
your images and table sizes are equal to or smaller than the browser width, or your output will overlap
or truncate in places.
|
--browserwidth 800
|
|
--charset charset
|
The --charset option specifies the 8-bit character set encoding to use for the entire document. HTMLDOC
comes with the following character set files:
charset Character Set
cp-874 Windows code page 874
cp-1250 Windows code page 1250
cp-1251 Windows code page 1251
cp-1252 Windows code page 1252
cp-1253 Windows code page 1253
cp-1254 Windows code page 1254
cp-1255 Windows code page 1255
cp-1256 Windows code page 1256
cp-1257 Windows code page 1257
cp-1258 Windows code page 1258
iso-8859-1 ISO-8859-1
iso-8859-2 ISO-8859-2
iso-8859-3 ISO-8859-3
iso-8859-4 ISO-8859-4
iso-8859-5 ISO-8859-5
iso-8859-6 ISO-8859-6
iso-8859-7 ISO-8859-7
iso-8859-8 ISO-8859-8
iso-8859-9 ISO-8859-9
iso-8859-14 ISO-8859-14
iso-8859-15 ISO-8859-15
koi8-r KOI8-R
|
--charset "iso-8859-4"
|
--bottom margin
--top margin
--right margin
--left margin
|
The --bottom/--top/--right/--left option specifies the bottom/top/right/left margin. The default units
are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters,
and millimeters, respectively. This option is only available when generating PostScript or PDF files.
|
--bottom 1
|
|
--logoimage filename
|
The --logoimage option specifies the logo image for the HTML navigation bar and page headers and footers
for PostScript and PDF files. The supported formats are BMP, GIF, JPEG, and PNG.
|
--logoimage "logo.jpg"
|
|
--bodyimage filename
|
The --bodyimage option specifies the background image for all pages in the document. The supported formats
are BMP, GIF, JPEG, and PNG.
|
--bodyimage "bg.gif"
|
|
--bodycolor color
|
The --bodycolor option specifies the background color for all pages in the document. The color can be
specified by a standard HTML color name or as a 6-digit hexadecimal number of the form #RRGGBB.
|
--bodycolor "lightblue"
|
|
--bodyfont typeface
|
The --bodyfont option specifies the default text font used for text in the document body. The typeface
parameter can be one of the following:
typeface Actual Font
Arial: Helvetica
Courier: Courier
Helvetica: Helvetica
Monospace: Courier
Sans-Serif: Helvetica
Serif: Times
Symbol: Symbol
Times: Times
|
--bodyfont "Arial"
|
|
--compression[=level]
|
The --compression option specifies that Flate compression should be performed on the output file(s).
The optional level parameter is a number from 1 (fastest and least amount of compression) to 9
(slowest and most amount of compression). This option is only available when generating Level 3 PostScript
or PDF files.
|
--compression 2
|
|
--encryption
|
The --encryption option enables encryption and security features for PDF output. This option is only
available when generating PDF files.
|
--encryption
|
|
--jpeg[=quality]
|
The --jpeg option enables JPEG compression of continuous-tone images. The optional quality parameter
specifies the output quality from 0 (worst) to 100 (best). This option is only available when generating
Level 2 and Level 3 PostScript or PDF files.
|
--jpeg 50
|
|
<META NAME="AUTHOR" CONTENT="..." >
|
Specifies the document author.
|
<META NAME="AUTHOR" CONTENT="Gilgamesh Solutions" >
|
|
<META NAME="COPYRIGHT" CONTENT="...">
|
Specifies the document copyright.
|
<META NAME="COPYRIGHT" CONTENT="2003 © Gilgamesh Solutions">
|
|
<META NAME="DOCNUMBER" CONTENT="..." >
|
Specifies the document number.
|
<META NAME="DOCNUMBER" CONTENT="3A" >
|
|
<META NAME="GENERATOR" CONTENT="..." >
|
Specifies the application that generated the HTML file.
|
<META NAME="GENERATOR" CONTENT="ColdFusion MX" >
|
|
<META NAME="KEYWORDS" CONTENT="..." >
|
Specifies document search keywords.
|
<META NAME="KEYWORDS" CONTENT="Gilgamesh, Solutions, DynamicPDF 1.0" >
|
|
<META NAME="SUBJECT" CONTENT="..." >
|
Specifies document subject.
|
<META NAME="SUBJECT" CONTENT="DynamicPDF 1.0" >
|
<!-- MEDIA BOTTOM nnn -->
<!-- MEDIA LEFT nnn -->
<!-- MEDIA RIGHT nnn -->
<!-- MEDIA TOP nnn -->
|
Sets the left/right/top/bottom margin of the page. The "nnn" string can be any standard measurement value,
e.g. 0.5in, 36, 12mm, etc. Breaks to a new page if the current page is already marked.
|
<!-- MEDIA TOP 1.5in -->
|
|
<!-- MEDIA LANDSCAPE [NO|Yes] -->
|
If "Yes", choose Landscape orientation for the page; If "No", choose Portrait.
breaks to a new page if the current page is already marked.
|
<!-- MEDIA LANDSCAPE Yes -->
|
|
<!-- MEDIA SIZE foo -->
|
Sets the media size to the specified size. The "foo" string can be "Letter", "Legal", "Universal", or "A4"
for standard sizes or "WIDTH x HEIGHT units" for custom sizes, e.g. "8.5x11in"; breaks to a new page or sheet
if the current page is already marked.
|
<!-- MEDIA SIZE "8.5x11in" -->
|
|
<!-- MEDIA DUPLEX [NO|YES] -->
|
Chooses single-sided or double-sided printing for the page; breaks to a new page or sheet if the current
page is already marked.
|
<!-- MEDIA DUPLEX YES -->
|
|
<!-- MEDIA TYPE "foo" -->
|
Sets the media type attribute for the page. The "foo" string is any type name that is supported by the
printer, e.g. "Plain", "Glossy", etc. Breaks to a new page or sheet if the current page is already marked.
|
<!-- MEDIA TYPE "Plain" -->
|
|
--no-compression
|
The --no-compression option specifies that Flate compression should not be performed on the output files.
|
--no-compression
|
|
--no-duplex
|
The --no-duplex option specifies that the output should be formatted for one sided printing. This option is
only available when generating PostScript or PDF files. Use the --pscommands option to generate
PostScript duplex mode commands.
|
--no-duplex
|
|
--no-embedfonts
|
The --no-embedfonts option specifies that fonts should not be embedded in PostScript and PDF output.
|
--no-embedfonts
|
|
--no-encryption
|
The --no-encryption option specifies that no encryption/security features should be enabled in PDF
output. This option is only available when generating PDF files.
|
--no-encryption
|
|
--no-jpeg
|
The --no-jpeg option specifies that JPEG compression should not be performed on large images.
|
--no-jpeg
|
|
--no-links
|
The --no-links option specifies that PDF output should not contain hyperlinks.
|
--no-links
|
|
--no-xrxcomments
|
The --no-xrxcomments option specifies that Xerox PostScript job comments should not be written to the
output files. This option is only available when generating PostScript files.
|
--no-xrxcomments
|
|
--owner-password password
|
The --owner-password option specifies the owner password for a PDF file. If not specified or the empty
string (""), a random password is generated. This option is only available when generating PDF files.
|
--owner-password "mypassword"
|
|
--pageduration seconds
|
The --pageduration option specifies the number of seconds that each page will be displayed in the
document. This option is only available when generating PDF files.
|
--pageduration 2
|
|
--pageeffect effect
|
The --pageeffect option specifies the page effect to use in PDF files. The effect parameter can be one of
the following:
effect Description
none No effect is generated.
bi Box Inward
bo Box Outward
d Dissolve
gd Glitter Down
gdr Glitter Down and Right
gr Glitter Right
hb Horizontal Blinds
hsi Horizontal Sweet Inward
hso Horizontal Sweep Outward
vb Vertical Blinds
vsi Vertical Sweep Inward
vso Vertical Sweep Outward
wd Wipe Down
wl Wipe Left
wr Wipe Right
wu Wipe Up
This option is only available when generating PDF files.
|
--pageeffect "wr"
|
|
--pagelayout layout
|
The --pagelayout option specifies the initial page layout in the PDF viewer.The layout parameter can be one
of the following:
layout Description
single A single page is displayed.
one A single column is displayed.
twoleft Two columns are displayed with the first page on the left.
tworight Two columns are displayed with the first page on the right.
This option is only available when generating PDF files.
|
--pagelayout "tworight"
|
|
--pagemode mode
|
The --pagemode option specifies the initial viewing mode in the PDF viewer. The mode parameter can be one
of the following:
mode Description
document The document pages are displayed in a normal window.
outline The document outline and pages are displayed.
fullscreen The document pages are displayed on the entire screen in
"slideshow" mode.
This option is only available when generating PDF files.
|
--pagemode "document"
|
|
--path dir1;dir2;dir3;...;dirN
|
The --path option specifies a search path for files that are loaded by HTMLDOC. It is usually used to get
images that use absolute server paths to load. Directories are separated by the semicolon (;) so that
drive letters and URLs can be specified. Quotes around the directory parameter are optional. They are
usually used when the directory string contains spaces.
|
--path "C:/;D:/MyDir"
|
|
--permissions permission
|
The --permissions option specifies the document permissions. The available permission parameters are
listed below:
Permission Description
all All permissions
annotate User can annotate document
copy User can copy text and images from document
modify User can modify document
print User can print document
no-annotate User cannot annotate document
no-copy User cannot copy text and images from document
no-modify User cannot modify document
no-print User cannot print document
none No permissions
The --encryption option must be used in conjunction with the --permissions parameter.
--permissions no-print --encryption
Multiple options can be specified with multiple --permissions entries as needed.
--permissions no-print --permissions no-copy --encryption
This option is only available when generating PDF files.
|
--permissions no-print --permissions no-copy --encryption
|
