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 on this matter.)
To do this, you will need to prepare a special HTML pattern file with the content as the following:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<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 -->
' and
'<!-- docflex-html-body -->
' are obligatory
because they are replaced with the actual HTML head and
body blocks generated by DocFlex.
The LINK
element is optional.
The macro '${docflex-doc-root}
', which you can see within it,
will be expanded to the relative pathname
leading from the given HTML file to the documentation root directory. That 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 now supported. See "Output | Generate style sheet file | CSS pattern file" option. |
Once your HTML pattern file is ready, you should specify it with this option. Then, it will be used to generate all HTML document files.
Note that the generation of the frameset HTML file (normally 'index.html') is not affected by this setting.
See Also:
"Output | Generate style sheet file | CSS pattern file" option