DocBook 5 to WebHelp Output

DocBook 5 documents can be transformed into WebHelp systems, such as:

WebHelp Output

To publish DocBook 5 to WebHelp, follow these steps:

Click the Configure Transformation Scenario(s) action from the toolbar (or the Document > Transformation menu.
Select the DocBook WebHelp scenario from the DocBook 5 section.
Click Apply associated.
When the DocBook WebHelp transformation is complete, the output is automatically opened in your default browser.

WebHelp With Feedback Output

To publish DocBook 5 to WebHelp With Feedback, follow these steps:

Click Configure Transformation Scenarios.
Select the DocBook WebHelp with Feedback scenario from the DocBook 5 section.
Click Apply associated.
Enter the documentation product ID and the documentation version.
When the DocBook 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.

For further information about all the DocBook transformation parameters, go to http://docbook.sourceforge.net/release/xsl/current/doc/fo/index.html.

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 DocBook 5 document, follow these steps:

Click Configure Transformation Scenarios.
Select the DocBook WebHelp - Mobile scenario from the DocBook 5 section.
Click Apply associated.

When the DocBook WebHelp - Mobile transformation is complete, the output is automatically opened in your default browser.

To further customize these out-of-the-box transformation, you can edit the following most commonly used parameters:

webhelp.copyright

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

webhelp.footer.file

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>

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 XML Editor footer is inserted in each WebHelp page.

webhelp.logo.image (not available for the WebHelp Mobile transformation)

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

webhelp.logo.image.target.url (not available for the WebHelp Mobile transformation)

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 (not available for the WebHelp Mobile transformation)

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

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

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

args.default.language

This parameter is used if the language is not detected in the DITA map. The default value is en-us.

l10n.gentext.default.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.product.id (available only for the WebHelp with Feedback transformation)

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.

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

webhelp.product.version (available only for the WebHelp with Feedback transformation)

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.

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

webhelp.skin.css (not available for the WebHelp Mobile transformation)

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.