htmldoc browserwidth

string

If set controlls the width of the page in pixels. Set this to control scaling of tables and pictures. If empty it defaults to 680

htmldoc header_left

string

Sets the left header on all PDF pages. The following special strings are supported:

$$: Inserts a single dollar sign in the header.

$CHAPTER: Inserts the current chapter heading.

$CHAPTERPAGE, $CHAPTERPAGE(format) : Inserts the current page number within a chapter or file. When a format is specified, uses that numeric format (1 = decimal, i = lowercase roman numerals, I = uppercase roman numerals, a = lowercase ascii, A = uppercase ascii) for the page numbers.

$CHAPTERPAGES, $CHAPTERPAGES(format): Inserts the total page count within a chapter or file. When a format is specified, uses that numeric format (1 = decimal, i = lowercase roman numerals, I = uppercase roman numerals, a = lowercase ascii, A = uppercase ascii) for the page count.

$DATE: Inserts the current date.

$HEADING: Inserts the current heading.

$LOGOIMAGE: Inserts the logo image; all other text in the string will be ignored. The path to the logimage has to be set separately (htmldoc logoimage).

$PAGE, $PAGE(format): Inserts the current page number. When a format is specified, uses that numeric format (1 = decimal, i = lowercase roman numerals, I = uppercase roman numerals, a = lowercase ascii, A = uppercase ascii) for the page numbers.

$PAGES, $PAGES(format): Inserts the total page count. When a format is specified, uses that numeric format (1 = decimal, i = lowercase roman numerals, I = uppercase roman numerals, a = lowercase ascii, A = uppercase ascii) for the page count.

$TIME: Inserts the current time.

$TITLE: Inserts the document title.

The header is set by inserting a comment in the html document prior to passing it to htmldoc. See the note in Adminstration about setting the locale if you want to set the format for $DATE and $TIME.

htmldoc header_center

string

Sets the centered header. See above for format.

$TITLE

htmldoc header_right

string

Sets the right header. See above for format.

htmldoc footer_left

string

Sets the left footer. See above for format.

htmldoc footer_center

string

Sets the centered footer. See above for format.

htmldoc footer_right

string

Sets the right footer. See above for format.

$PAGE

htmldoc size

string

Sets the size of the generated PDF. The size can be A4, Letter or Universal. Custom sizes are specified by the page width and length separated by the letter "x" to select a custom page size. Append the letters "in" for inches, "mm" for millimeters, or "cm" for centimeters.

Depends on compilation options of htmldoc

htmldoc top

string

If set specifies the top margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.

htmldoc bottom

string

If set specifies the botttom margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.

htmldoc left

string

If set specifies the left margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.

htmldoc right

string

If set specifies the right margin. The default units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm" specify inches, centimeters, and millimeters, respectively.

htmldoc bodyfont

string

If set specifies the  font that is used for the PDF page unless another font is specified. (Remember, css is not yet supported).

htmldoc fontsize

string

If set specifies the  base fontsize that is used for the PDF page unless another size  is specified. (Remember, css is not yet supported).

htmldoc headfootfont

string

If set specifies the  font that is used for the footers and headers.

htmldoc headfootsize

string

If set specifies the  fontsize that is used for the footers and headers.

htmldoc logoimage

string

Sets the path to the logoimage for the page headers and footers. The supported formats are BMP, GIF, JPEG, and PNG. Don't forget to add $LOGOIMAGE to one of your headers or footers.

htmldoc no_links

boolean

If checked the PDF file will not contain clickable links.

Unchecked

htmldoc additional_params

string

Here you can set additional parameters for the htmldoc command that are not covered by the parameters above.

string_search[1-4]

string

Using this parameter together with string_replace you can remove/replace certain parts of your html-file prior to passing it to htmldoc. One example is to remove the “Back” link in the recipe extension. You can do this (when using english language) with

string_search1 = “<A href="javascript:history.go(-1);">Back</A>”

and  string_replace1 = “”

You can actually use string_search[5-n] as long as they are all set

string_replace[1-4]

string

See string_search[1-4]

regexp_search[1-4]

string

The same as string_search, but for regular expressions. The search and replace parameters must be valid regular expressions that will be passed to preg_replace.

You can actually use regexp_search[5-n] as long as they are all set

regexp_replace[1-4]

string

See regexp_search[1-4]

attachment

int

This controls the setting for the Content-Disposition header. Normally a

Content-Type: application/pdf

Content-Disposition: inline

header is generated. If this parameter is set to 1

Content-Type: application/pdf

Content-Disposition: attachment

and if it is set to 2

Content-Type: application/octet-stream

Content-Disposition: attachment

is sent instead.

Option 1 will force Internet Explorer to open the PDF file in a new Acrobat Reader window. Netscape will open it inline (same as normal). If it is set to 2 both IE and Netscape will query the user what to do with the file. (Tested on win2k with IE6 and Netscape 7)

The change is created by attaching a “attachment=<...>” parameter to the URL.

0

filename

string

Sets the a filename for the Content-Disposition header. Since most browsers seem to ignore this it is of limited use.

include_post_vars

boolean

If set to 1 the received POST variables will be appended as GET variables to the URL. This is useful if you want to generate dynamic data (like search result for example).

IMPORTANT NOTE: if you set this parameter it is possible that passwords and other sensible information will get encoded in the URL and thus be logged in proxy-logs for example.

false

no_blur

boolean

If this is set, no onFocus="blurLink(this); code is added to the link. You can also use noBlur instead.

no_user_int

boolean

If set the generated link will not be a non-cached USER_INT object. Use this for slightly better performance if you have no frontend plugins that act as USER_INTobjects and set GET or POST variables. If you don't understand what i'm writing leave it at default.

This parameter is only supported for the makePdfLink function.

false

simulateStaticPdf

boolean

Overrides the global setting of the extension.

Target

string

Sets the target for the link

ATagParams

string

Ads additional parameters to the <a..> tag.