WebHelp Responsive Transformation Parameters
In addition to the common DITA-OT transformation parameters and the HTML-based Output Parameters, there are numerous other supported parameters that are specific to the WebHelp Responsive output.
Publishing Template Parameters
- webhelp.publishing.template
- Specifies the path to the ZIP archive
(or root folder) that contains your custom WebHelp Responsive template.Note: The built-in templates are stored in the DITA-OT-DIR/plugins/com.oxygenxml.webhelp.responsive/templates folder.Note: Relative paths are resolved based on the current working directory.
- webhelp.publishing.template.descriptor
- Specifies the name of the descriptor to be loaded from the WebHelp Responsive template package. If it is not specified, the first encountered descriptor will be automatically loaded.
Custom Resource Parameters
- webhelp.custom.resources
- The file path to a directory that contains resources files. All files from this directory will be copied to the root of the WebHelp output.
- webhelp.favicon
- The file path that points to an image to be used as a favicon in the WebHelp output.
- webhelp.logo.image.target.url
- Specifies a target URL that is set on the logo image. When you click the logo image, you will be redirected to this address.
- webhelp.logo.image
- Specifies a path to an image displayed as a logo in the left side of the output header.
- webhelp.logo.image.alt
- Specifies a value that will be set in the
@alt
attribute of the logo image. If the parameter is not specified, the@alt
attribute will contain the publication title. Note that this parameter makes sense only in conjunction with thewebhelp.logo.image
parameter.
Oxygen Feedback Parameter
- webhelp.fragment.feedback
- You can integrate Oxygen Feedback with your WebHelp Responsive output to provide a comments area at the bottom of each page where readers can offer feedback. When you create an Oxygen Feedback site configuration, an HTML fragment is generated during the final step of the creation process and that fragment should be set as the value for this parameter.
Context Sensitive Help Parameter
- webhelp.csh.disable.topicID.fallback
- Specifies whether or not topic ID
fallbacks are enabled when computing the mapping of context sensitive
help and
resourceid
information is not available. Possible values are false (default) and true.
HTML Fragment Extension Parameters
- webhelp.enable.html.fragments.cleanup
- Enables or disables the automatic conversion of HTML fragments to well-formed XML. If set to true (default), the transformation automatically converts non-well-formed HTML content to a well-formed XML equivalent. If set to false, the transformation will fail if at least one HTML fragment is not well-formed.
- webhelp.enable.scroll.to.search.term
- Specifies whether or not the page should scroll to the first search term when opening the search results page. Possible values are no (default) and true.
- webhelp.fragment.after.body
- This parameter can be used to display a given XHTML fragment after the body in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.body.main.page
- This parameter can be used to display a given XHTML fragment after the body in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.body.search.page
- This parameter can be used to display a given XHTML fragment after the body in the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.body.terms.page
- This parameter can be used to display a given XHTML fragment after the body in the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.body.topic.page
- This parameter can be used to display a given XHTML fragment after the body in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.feedback
- This parameter can be used to display a given XHTML fragment after the Oxygen Feedback commenting component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.header
- This parameter can be used to display a given XHTML fragment after the header section in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.header.main.page
- This parameter can be used to display a given XHTML fragment after the header section in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.header.search.page
- This parameter can be used to display a given XHTML fragment after the header section in the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.header.terms.page
- This parameter can be used to display a given XHTML fragment after the header section in the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.header.topic.page
- This parameter can be used to display a given XHTML fragment after the header section in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.logo_and_title
- This parameter can be used to display a given XHTML fragment after the logo and title in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.main.content.area
- This parameter can be used to display a given XHTML fragment after the main content section in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.main.content.area.main.page
- This parameter can be used to display a given XHTML fragment after the main content section in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.main.content.area.topic.page
- This parameter can be used to display a given XHTML fragment after the main content section in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.main.page.search (deprecated)
- This parameter is deprecated. Use
webhelp.fragment.after.search.input.main.page
instead. - webhelp.fragment.after.publication.toc
- This parameter can be used to display a given XHTML fragment before the publication's table of contents component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.search.input
- This parameter can be used to display a given XHTML fragment after the search field in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.search.input.main.page
- This parameter can be used to display a given XHTML fragment after the search field in all the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.search.input.search.page
- This parameter can be used to display a given XHTML fragment after the search field in all the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.search.input.terms.page
- This parameter can be used to display a given XHTML fragment after the search field in all the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.search.input.topic.page
- This parameter can be used to display a given XHTML fragment after the search field in all the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.toc_or_tiles
- This parameter can be used to display a given XHTML fragment after the table of contents or tiles in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- This parameter can be used to display a given XHTML fragment after the top menu in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.topic.breadcrumb
- This parameter can be used to display a given XHTML fragment after the breadcrumb component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.topic.content
- This parameter can be used to display a given XHTML fragment after the topic's content in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.topic.toc
- This parameter can be used to display a given XHTML fragment after the topic's table of contents component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.after.topic.toolbar
- This parameter can be used to display a given XHTML fragment after the toolbar buttons above the topic content in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.body
- This parameter can be used to display a given XHTML fragment before the page body in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.body.main.page
- This parameter can be used to display a given XHTML fragment before the page body in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.body.search.page
- This parameter can be used to display a given XHTML fragment before the page body in the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.body.terms.page
- This parameter can be used to display a given XHTML fragment before the page body in the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.body.topic.page
- This parameter can be used to display a given XHTML fragment before the page body in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.feedback
- This parameter can be used to display a given XHTML fragment before the Oxygen Feedback commenting component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.logo_and_title
- This parameter can be used to display a given XHTML fragment before the logo and title. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.main.content.area
- This parameter can be used to display a given XHTML fragment before the main content section in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.main.content.area.main.page
- This parameter can be used to display a given XHTML fragment before the main content section in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.main.content.area.search.page
- This parameter can be used to display a given XHTML fragment before the main content section in the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.main.content.area.terms.page
- This parameter can be used to display a given XHTML fragment before the main content section in the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.main.content.area.topic.page
- This parameter can be used to display a given XHTML fragment before the main content section in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.main.page.search (deprecated)
-
This parameter is deprecated.
Use
webhelp.fragment.before.search.input.main.page
instead. - webhelp.fragment.before.publication.toc
- This parameter can be used to display a given XHTML fragment before the publication's table of contents component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.search.input
- This parameter can be used to display a given XHTML fragment before the search field in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.search.input.main.page
- This parameter can be used to display a given XHTML fragment before the search field in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.search.input.search.page
- This parameter can be used to display a given XHTML fragment before the search field in the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.search.input.terms.page
- This parameter can be used to display a given XHTML fragment before the search field in the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.search.input.topic.page
- This parameter can be used to display a given XHTML fragment before the search field in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.toc_or_tiles
- This parameter can be used to display a given XHTML fragment before the table of contents or tiles in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- This parameter can be used to display a given XHTML fragment before the top menu in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.topic.breadcrumb
- This parameter can be used to display a given XHTML fragment before the breadcrumb component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.topic.content
- This parameter can be used to display a given XHTML fragment before the topic's content in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.topic.toc
- This parameter can be used to display a given XHTML fragment before the topic's table of contents component in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.before.topic.toolbar
- This parameter can be used to display a given XHTML fragment before the toolbar buttons above the topic content in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.custom.search.engine.results
- This parameter can be used to replace the search results area with custom XHTML content. The value of the parameter is the path to an XHTML file that contains your custom content.
- webhelp.fragment.custom.search.engine.script
- This parameter can be used to replace WebHelp's built-in search engine with your own custom search engine. The value of the parameter is the path to an XHTML file that contains the scripts required for your custom search engine to run.
- This parameter can be used to display a given
XHTML fragment as the page footer in all types of pages. The value of the parameter
can be either a well-formed XHTML fragment or a path to a file that contains a
well-formed XHTML fragment.Important: This parameter should only be used if you are using a valid, purchased license of Oxygen XML Author Eclipse plugin (do not use it with a trial license).
- webhelp.fragment.head
- This parameter can be used to display a given XHTML fragment in the header section in all types of pages. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.head.main.page
- This parameter can be used to display a given XHTML fragment in the header section in the main page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.head.search.page
- This parameter can be used to display a given XHTML fragment in the header section in the search results page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.head.terms.page
- This parameter can be used to display a given XHTML fragment in the header section in the index terms page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.head.topic.page
- This parameter can be used to display a given XHTML fragment in the header section in the topic page. The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
- webhelp.fragment.welcome
- This parameter can be used to display a given XHTML fragment as a welcome message (or title). The value of the parameter can be either a well-formed XHTML fragment or a path to a file that contains a well-formed XHTML fragment.
Output Component Parameters
- webhelp.default.collection.type.sequence
- Specifies if the sequence value
will be used by default when the
@collection-type
attribute is not specified. This option is helpful if you want to have Next and Previous navigational buttons generated for all HTML pages. Allowed values are no (default) and yes. - webhelp.enable.sticky.header
- Controls whether or not the header section will remain sticky in the output. Possible values are yes (default) or no.
- webhelp.enable.sticky.publication.toc
- Controls whether or not the publication table of contents will remain sticky in the output. Possible values are yes (default) or no.
- webhelp.enable.sticky.topic.toc
- Controls whether or not the topic table of contents will remain sticky in the output. Possible values are yes (default) or no.
- webhelp.figure.title.placement
- Controls the placement of the title for figures (relative to the image). Possible values include top (default) and bottom.
- webhelp.labels.generation.mode
-
Controls whether or not labels are generated in the output. These labels are useful because users can easily search for topics with the same label by simply clicking on the label presented in the output. Possible values are:
- keywords-label - Generates labels for each defined
<keyword>
element that has the@outputclass
attribute value set to label. - keywords - Generates labels for each defined
<keyword>
element. If the topic contains<keyword>
elements with the@outputclass
attribute value set to label, then only these elements will have labels generated for them in the output. - disable - Disables the generation of labels in the Webhelp Responsive output.
- keywords-label - Generates labels for each defined
- Specifies if the related links
from nested topics will be merged with the links in the parent topic. Thus the links
will be moved from the topic content to the related links component and all of the
links from the same group (for example, Related Tasks, Related
References, Related Information) are merged into a single group. The
default value is
yes
. - webhelp.publication.toc.hide.chunked.topics
- Specifies if the table of contents
will contain links for chunked topics. The default value is
yes
. - webhelp.publication.toc.links
- Specifies which links will be included in the
table of contents. The possible values are:
- chapter (default) - The TOC will include links for the current topic, its children, its siblings, and its direct ancestor (including the direct ancestor's siblings), and the parent chapter.
- topic - The TOC will only include links for the current topic and its direct children.
- all - The TOC will include all links.
- webhelp.publication.toc.tooltip.position
- By default, if a topic contains a
<shortdesc>
element, its content is displayed in a tooltip when the user hovers over its link in the table of contents. This parameter controls whether or not this tooltip is displayed and its position relative to the link. The possible values are:- left
- right (default)
- top
- bottom
- hidden - The tooltip will not be displayed.
- webhelp.rellinks.group.mode
- Specifies the related links grouping mode. All links can be grouped into a single "Related Information" heading or links can be grouped by their target type (topic, task, or concept). Allowed values: single-group (default) or group-by-type.
- webhelp.show.breadcrumb
- Specifies if the breadcrumb component will be
presented in the output. The default value is
yes
. - webhelp.show.changes.and.comments
- When set to
yes
, user comments, replies to comments, and tracked changes are published in the WebHelp output. The default value isno
. - webhelp.show.child.links
- Specifies if child links will be generated in
the output for all topics that have subtopics. The default value is
no
. - webhelp.show.full.size.image
- Specifies if responsive images that are
displayed with a smaller dimension than their original size can be clicked to see an
enlarged version of the image. The default value is
yes
. - webhelp.show.indexterms.link
- Specifies if an icon that links to the index
terms page will be displayed in the output. The default value is
yes
(meaning the index terms icon is displayed). If set tofalse
, the index terms icon is not displayed in the output and the index terms page is not generated. - webhelp.show.main.page.tiles
- Specifies if the tiles component will be
presented in the main page of the output. For a tree style layout, this
parameter should be set to
no
. - webhelp.show.main.page.toc
- Specifies if the table of contents will be
presented in the main page of the output. The default value is
yes
. - Specifies if navigation links will be
presented in the output. The default value is
yes
. - webhelp.show.print.link
- Specifies if a print link or icon will be
presented within each topic in the output. The default value is
yes
. - webhelp.show.publication.toc
- Specifies if a table of contents will be presented
on the left side of each topic in the output. The default value is
yes
. - webhelp.show.topic.toc
- Specifies if a topic table of contents will be
presented on the right side of each topic in the output. This table of contents
contains links to each
<section>
within the current topic that contains an@id
attribute and the section corresponding to the current scroll position is highlighted. The default value isyes
. - Specifies if a menu will be presented at the topic
of the main page in the output. The default value is
yes
. - webhelp.skip.main.page.generation
- If set to
true
, the default main page is not generated in the output. The default value isfalse
. - webhelp.table.title.placement
- Controls the placement of the title for tables. Possible values include top (default) and bottom.
- When this parameter is activated (set to
yes
), clicking an item in the top menu will expand the submenu (if available). You can then click on a submenu item to open the item (topic). You can click outside the menu or press ESC to hide the menu. When set tono
(default), hovering over a menu item displays the menu content. - Specifies the maximum depth level of the topics
that will be included in the top menu. The default value is
3
. A value of0
means that the menu has unlimited depth.
- webhelp.topic.collapsible.elements.initial.state
- Specifies the initial
state of collapsible elements (tables with titles, nested topics with titles, sections
with titles, index term groups). The possible values are
collapsed
orexpanded
(default value).
Publishing Speedup Parameters
- parallel
- A common parameter with other transformation types. When set to true (default value is false), the publishing pre-processing stages are run in parallel slightly improving the publishing time.
- store-type
- A common parameter with other transformation types. When set to memory, the processing stages use internal memory to store temporarily processed documents, thus decreasing the publishing time but slightly increasing the amount of internal memory used for the process. When publishing on Windows, setting this parameter can decrease the publishing times by about one-third.
Note: The
fix.external.refs.com.oxygenxml
parameter is not supported when
running the transformation from a command line. This parameter is normally used to specify
whether or not the application tries to fix such references in a temporary files folder
before the DITA Open Toolkit is invoked on the fixed references.Parameters for Adding a Link to PDF Documentation in WebHelp Responsive Output
The following transformation parameters can be used to generate a PDF link component in the WebHelp Responsive output (for example, it could link to the PDF equivalent of the documentation):
- webhelp.pdf.link.url
- Specifies the target URL for the PDF link component.
- webhelp.pdf.link.text
- Specifies the text for the PDF link component.
- webhelp.pdf.link.icon.path
- Specifies the path or URL of the image icon to be used for the PDF link component. If not specified, a default icon is used.
- webhelp.pdf.link.anchor.enabled
- Specifies whether or not the current topic ID should be appended as the name destination at the end of the PDF link. Allowed values are: yes (default) and no.
- webhelp.show.pdf.link
- Specifies whether or not the PDF link component is shown in the WebHelp Responsive output. Allowed values are: yes (default) and no.