Transformation parameters
You can also set one or more WebHelp transformation parameters in the descriptor
file.
<publishing-template>
...
<webhelp>
...
<parameters>
<parameter
name="webhelp.show.main.page.toc"
value="yes"/>
<parameter
name="webhelp.top.menu.depth"
value="3"/>
<parameter
name="webhelp.fragment.welcome"
value="html-fragment/webhelp.fragment.welcome.html"
type="filePath"/>
</parameters>
</webhelp>
The following information can be specified in the parameter
element:
- Parameter name
-
The name of the parameter. It may be one of the WebHelp Responsive transformation parameters or a DITA Open Toolkit HTML-based output parameter.
Note: It is not recommended to specify an input/output parameter in the descriptor file (such as the input Map, DITAVAL file, or temporary directory).Attention: JVM arguments like -Xmx cannot be specified as a transformation parameter. - Parameter Value
- The value of the parameter. It should be a relative path to the template root folder for file paths parameters.
- Parameter Type
- The type of the parameter:
string
orfilepath
. Thestring
value is default.
After creating a publishing template and adding it to the templates gallery, when you select the template in the transformation scenario dialog box in Oxygen XML Editor/Author, the Parameters tab will automatically be updated to include the parameters defined in the descriptor file. These parameters are displayed in italics.