Download Oxygen XML Author Eclipse Plugin 15.2

Oxygen XML Author plugin | The DocBook 5 Document Type | 216
Figure 113: DocBook WebHelp
To publish DocBook 5 to WebHelp, use the DocBook WebHelp transformation. To further customize the out-of-the-box
transformation, you can edit some of its parameters:
•
•
•
•
•
root.filename - identifies the root of the HTML file when chunking. The root.filename is the base filename
for the chunk created for the root of each processed document;
use.stemming - controls whether you want to include stemming search algorithms into the published output.
Stemming is the process for reducing inflected (or sometimes derived) words to their stem, base or root form
– generally a written word form. 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, and punctuation that
differs from language to language. For example, for English the value of this parameter is en, for French it is fr,
and so on
xml.file - this parameter specifies the path to the DocBook XML file.
The Search tab is enhanced with a rating mechanism that computes scores for every page that matches the search criteria.
These scores are then translated into a 5-star rating scheme. The search results are sorted depending on:
•
•
number of keywords found in a single page. The higher the number, the better;
context - if a word is found in a title or emphasized section of text it scores better than a word found in an unformatted
text.