DITA Map to WebHelp Output

DITA maps can be transformed into WebHelp systems.

WebHelp Output

To publish a DITA map to WebHelp, follow these steps:

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

WebHelp With Feedback Output

To publish a DITA map as WebHelp with Feedback:

Click Configure Transformation Scenarios.
Select the DITA Map WebHelp with Feedback scenario from the DITA Map section.
Click Apply associated.
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 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:

From the DITA Maps Manager view click Configure Transformation Scenarios.
Select the DITA Map WebHelp - Mobile transformation scenario.
Click Apply associated.

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

Once Oxygen XML Editor finishes the transformation process, 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.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.

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

webhelp.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), such as: 0.3, 0.5, 0.8, etc. 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.

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.

webhelp.google.search.script

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

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

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.

webhelp.head.script

URL value that specifies the location of a well-formed XHTML file containing the custom script that will be copied in the <head> section of every WebHelp page.

webhelp.body.script

URL value that specifies the location of a well-formed XHTML file containing the custom script that will be copied in the <body> section of every WebHelp page.

fix.external.refs.com.oxygenxml (Only supported when the DITA OT transformation process is started from Oxygen XML Editor)

The DITA Open Toolkit usually has problems processing references that point to locations outside of the directory of the processed DITA map. This parameter is used to specify whether or not the application should try to fix such references in a temporary files folder before the DITA Open Toolkit is invoked on the fixed references. The fix has no impact on your edited DITA content. Allowed values: true or false (default).