This option allows you to frame the output generated by DocFlex into your own HTML file. This may be useful when you need to insert into the generated HTML some extra lines with special settings.
(For instance, you can specify a custom Mark of the Web comment to appear in all generated HTML documents. See also "Add Mark of the Web" option for this matter.)
To do this, you will need to prepare a special HTML pattern file with the content as follows:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<!-- a custom style sheet -->
<link href="${docflex-doc-root}/mystyle.css"
rel="stylesheet" type="text/css">
...
<!-- docflex-html-head -->
</head>
<body>
<!-- docflex-html-body -->
</body>
</html>
<!-- docflex-html-head -->
<!-- docflex-html-body -->
Anything else is up to you to fill in. Just make sure your markup is valid HTML or XHTML (if you selected one; see "Output | Markup" option).
You may also use a few macros expanded to the values provided by DocFlex:
Macro | Description |
${docflex-doc-root} |
Expanded to the relative pathname leading from the given HTML file
to the documentation root directory.
That macro will allow you, for instance, to specify your custom CSS file, which you can place in the documentation root and use it to format the HTML markup embedded in your descriptions/annotations. Note: A different possibility to add your custom styles is via the CSS pattern file. See option: "Output | CSS | Generate style sheet file | CSS pattern file". |
${docflex-encoding} |
Expanded to the name of the character set used in the generated HTML document
(e.g. UTF-8 ).
It is the same as specified with the option: "Output | Character Encoding". This macro may be useful particularly in case of XHTML to specify the XML declaration in your HTML pattern file, e.g.:
|
Note that the generation of the frameset HTML file (normally 'index.html'
)
is not affected by this setting.
Related Options: