WebHelp Output

DITA Maps can be transformed into WebHelp systems, such as:

WebHelp Output

To publish a DITA Map to WebHelp:
  1. Click Configure Transformation Scenarios.
  2. Select the DITA Map WebHelp scenario from the DITA Map section.
  3. Click Apply associated.

    When the DITA Map WebHelp transformation is complete, the output is automatically opened in your default browser.

To further customize the out-of-the-box transformation, you can edit its parameters:

WebHelp With Feedback Output

To publish a DITA Map as WebHelp with Feedback:
  1. Click Configure Transformation Scenarios.
  2. Select the DITA Map WebHelp with Feedback scenario from the DITA Map section.
  3. Click Apply associated.
  4. Enter the documentation product ID and the documentation version.

    When the DITA Map WebHelp with Feedback transformation is complete, your default browser opens the installation.html file. This file contains information about the output location, system requirements, installation instructions, and deployment of the output.

To further customize the out-of-the-box transformation, you can edit its parameters:
  • use.stemming - Controls whether or not you want to include stemming search algorithms into the published output (default setting is false).
  • clean.output - Deletes all files from the output folder before the transformation is performed (only no and yes values are valid and the default value is no).
  • webhelp.copyright - Adds a small copyright text that appears at the end of the Table of Contents.
  • webhelp.footer.file - You can specify the path to a 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™, 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>
  • webhelp.footer.include - 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 footer is inserted in each WebHelp page.
  • webhelp.logo.image - Specifies a path to an image displayed as a logo in the left side of the output header.
  • 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.search.ranking - If this parameter is set to false then the relevance stars are no longer included in the search results displayed on the Search tab (default setting is true).
  • args.default.language - If the language is not detected in the DITA map, this parameter is used. The default sample value is en-us.
  • webhelp.search.japanese.dictionary - The file path of the user dictionary that will be used by the Kuromoji morphological indexer that is used for indexing Japanese content in the WebHelp pages.

To watch our video demonstration about the feedback-enabled WebHelp system, go to http://oxygenxml.com/demo/Feedback_Enabled_WebHelp.html.

WebHelp Mobile Output

To generate a mobile WebHelp system from your DITA Map:
  1. From the DITA Maps Manager view click Configure Transformation Scenarios.
  2. Select the DITA Map WebHelp - Mobile transformation scenario.
  3. Click Apply associated.
When the DITA Map WebHelp - Mobile transformation is complete, the output is automatically opened in your default browser.
To further customize the out-of-the-box transformation, you can edit its parameters:
  • use.stemming - Controls whether or not you want to include stemming search algorithms into the published output (default setting is false).
  • webhelp.copyright - This parameter specifies the copyright note that is added in the footer of the Table of Contents frame (the left side frame of the WebHelp output).
  • webhelp.indexer.language - This parameter is used to identify the correct stemmer that differs from language to language. For example, for English the value of this parameter is en or for French it is fr, and so on.
  • webhelp.footer.file - You can specify the path to a 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™, 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>
  • webhelp.footer.include - 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 footer is inserted in each WebHelp page.
  • args.default.language - If the language is not detected in the DITA map, this parameter is used. The default sample value is en-us.
  • webhelp.search.japanese.dictionary - The file path of the user dictionary that will be used by the Kuromoji morphological indexer that is used for indexing Japanese content in the WebHelp pages.

Once Oxygen XML Editor finishes the transformation process, the output is automatically opened in your default browser.

Parent topic: DITA Map Transformation Scenarios
Previous topic: DITA Map Transformation Scenarios
Next topic: How to Localize the Interface of WebHelp Output
Related information
WebHelp Output