Additional Oxygen XML WebHelp Plugin Parameters for DITA

You can append the following parameters to the command line that runs the transformation:

-Dwebhelp.copyright

Adds a small copyright text that appears at the end of the Table of Contents pane.

-Dwebhelp.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.

-Dwebhelp.favicon

The file path that points to an image to be used as a favicon in the WebHelp output.

-Dwebhelp.footer.file (not available for WebHelp Responsive systems)

Path to an XML file that includes the footer content for your WebHelp output pages. You can use this parameter to integrate social media features (such as widgets for Facebook™, Twitter™, Google Analytics, or Google+™). The file must be well-formed, each widget must be in separate div or span element, and the code for each script element is included in an XML comment (also, the start and end tags for the XML comment must be on a separate line). The following code exert is an example for adding a Facebook™ widget:

<div id="facebook">
    <div id="fb-root"/>
    <script>
            <!-- (function(d, s, id) { var js, fjs = d.getElementsByTagName(s)[0]; if (d.getElementById(id)) return; 
            js = d.createElement(s); js.id = id; js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.0"; 
            fjs.parentNode.insertBefore(js, fjs); }(document, 'script', 'facebook-jssdk')); -->
    </script>
    <div data-share="true" data-show-faces="true" data-action="like" data-layout="standard" class="fb-like"/>
</div>

-Dwebhelp.footer.include (not available for WebHelp Responsive systems)

Specifies whether or not to include footer in each WebHelp page. Possible values: yes, no. If set to no, no footer is added to the WebHelp pages. If set to yes and the webhelp.footer.file parameter has a value, then the content of that file is used as footer. If the webhelp.footer.file has no value then the default Oxygen XML Editor footer is inserted in each WebHelp page.

-Dwebhelp.google.search.results

URL value that specifies the location of a well-formed XHTML file containing the Google Custom Search Engine element gcse:searchresults-only. You can use all supported attributes for this element. It is recommend to set the linkTarget attribute to frm for frameless (iframe) version of WebHelp or to contentWin for the frameset version of WebHelp. The default value for this attribute is _blank and the search results will be loaded in a new window. If this parameter is not specified, the following code will be used

<gcse:searchresults-only
                linkTarget="frm"></gcse:searchresults-only>

-Dwebhelp.google.search.script

Specifies the location of a well-formed XHTML file containing the Custom Search Engine script from Google. The value must be a URL.

-Dwebhelp.logo.image.target.url (not available for WebHelp Classic Mobile systems)

Specifies a target URL that is set on the logo image. When you click the logo image, you will be redirected to this address.

-Dwebhelp.logo.image (not available for WebHelp Classic Mobile systems)

Specifies a path to an image displayed as a logo in the left side of the output header.

-Dwebhelp.product.id (available only for Feedback-enabled systems)

This parameter specifies a short name for the documentation target, or product (for example, mobile-phone-user-guide, hvac-installation-guide).

Note: You can deploy documentation for multiple products on the same server.

Restriction: The following characters are not allowed in the value of this parameter:

< > / \ ' ( )
                  { } = ; * % + &

.

-Dwebhelp.product.version (available only for Feedback-enabled systems)

Specifies the documentation version number (for example, 1.0, 2.5, etc.). New user comments are bound to this version.

Note: Multiple documentation versions can be deployed on the same server.

Restriction: The following characters are not allowed in the value of this parameter: < > / \ ' ( ) { } = ; * % + &.

-Dwebhelp.search.japanese.dictionary

The file path of the dictionary that will be used by the Kuromoji morphological engine that Oxygen XML Editor uses for indexing Japanese content in the WebHelp pages. This indexer does not come bundled with Oxygen XML Editor or the Oxygen XML WebHelp plugin. To use it, you need to download it from http://mvnrepository.com/artifact/org.apache.lucene/lucene-analyzers-kuromoji/4.0.0 and add it in the DITA_OT_DIR/plugins/com.oxygenxml.webhelp/lib directory.

-Dwebhelp.search.ranking

If this parameter is set to false then the 5-star rating mechanism is no longer included in the search results that are displayed on the Search tab (default setting is true).

-Dwebhelp.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 is no.

-Dwebhelp.sitemap.base.url

Base URL for all the loc elements in the generated sitemap.xml file. The value of a loc element is computed as the relative file path from the href attribute of a topicref element from the DITA map, appended to this base URL value. The loc element is mandatory in sitemap.xml. If you leave this parameter set to its default empty value, then the sitemap.xml file is not generated.

-Dwebhelp.sitemap.change.frequency

The value of the changefreq element in the generated sitemap.xml file. The changefreq element is optional in sitemap.xml. If you leave this parameter set to its default empty value, then the changefreq element is not added in sitemap.xml. Allowed values: <empty string> (default), always, hourly, daily, weekly, monthly, yearly, never.

-Dwebhelp.sitemap.priority

The value of the priority element in the generated sitemap.xml file. It can be set to any fractional number between 0.0 (least important priority) and 1.0 (most important priority). For example, 0.3, 0.5, or 0.8. The priority element is optional in sitemap.xml. If you leave this parameter set to its default empty value, then the priority element is not added in sitemap.xml.

-Dwebhelp.skin.css (available only for WebHelp Classic and WebHelp Classic with Feedback systems)

Path to a CSS file that sets the style theme in the output WebHelp pages. It can be one of the predefined skin CSS from the OXYGEN_INSTALL_DIR\frameworks\docbook\xsl\com.oxygenxml.webhelp\predefined-skins directory, or it can be a custom skin CSS generated with the Oxygen Skin Builder web application.

Parameters Specific to WebHelp Responsive Output (available only for WebHelp Responsive and WebHelp Responsive with Feedback systems)

-Dwebhelp.fragment.after.body: Specifies an XML fragment (or a path to a file that contains well formed XML content) that will be displayed after the body in the output.
-Dwebhelp.fragment.after.logo_and_title: Specifies an XML fragment (or a path to a file that contains well formed XML content) that will be displayed after the logo and title in the output.
-Dwebhelp.fragment.after.main.page.search: Specifies an XML fragment (or a path to a file that contains well formed XML content) that will be displayed after the search field in the output.
-Dwebhelp.fragment.after.toc_or_tiles: Specifies an XML fragment (or a path to a file that contains well formed XML content) that will be displayed after the table of contents or tiles in the main page of the output.
-Dwebhelp.fragment.after.top_menu: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed after the top menu in the output.
-Dwebhelp.fragment.before.body: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed before the body in the output.
-Dwebhelp.fragment.before.logo_and_title: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed before the logo and title in the output.
-Dwebhelp.fragment.before.main.page.search: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed before the search field in the output.
-Dwebhelp.fragment.before.toc_or_tiles: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed before the table of contents or tiles in the main page of the output.
-Dwebhelp.fragment.before.top_menu: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed before the top menu in the output.
-Dwebhelp.fragment.footer: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed as the footer in the output
-Dwebhelp.fragment.head: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed as the header in the output.
-Dwebhelp.fragment.welcome: Specify an XML fragment (or a path to a file that contains well formed XML content) that will be displayed as a welcome message (or title) in the output.
-Dwebhelp.show.breadcrumb: Specifies if the breadcrumb component will be presented in the output. The default value is yes.
-Dwebhelp.show.indexterms.link: Specifies if an icon that links to the index will be presented in the output. The default value is yes.
-Dwebhelp.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.
-Dwebhelp.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.
-Dwebhelp.show.navigation.links: Specifies if navigation links will be presented in the output. The default value is yes.
-Dwebhelp.show.print.link: Specifies if a print link or icon will be presented within each topic in the output. The default value is yes.
-Dwebhelp.show.side.toc: Specifies if a side table of contents will be presented on the right side of each topic in the output. The default value is yes.
-Dwebhelp.show.top.menu: Specifies if a menu will be presented at the topic of the main page in the output. The default value is yes.
-Dwebhelp.top.menu.depth: Specifies the maximum depth level of the topics that will be included in the top menu. The default value is 2.

Note: Note that the fix.external.refs.com.oxygenxml parameter is not supported in Oxygen XML WebHelp plugin.

If you need to further customize the transformation process, you can append other DITA-OT parameters as well. Any parameter that you want to append must follow the -D model of the above parameters. For example, to append the args.hdr parameter, use:

-Dargs.hdr=[HEADER_FILE_DIR]

where [HEADER_FILE_DIR] is the location of the directory that contains the header file.