DITA WebHelp Publishing Solution Advantages
23 Feb 2022
Read time: 4 minute(s)
Oxygen XML Editor's own user guide is generated from DITA XML content and published as WebHelp Responsive output: https://www.oxygenxml.com/doc/ug-editor/.
Below, I tried to compile a list of advantages that the published WebHelp output obtained
from DITA XML content has:
- It's a pure HTML5+Javascript publishing solution without the need of any server-side component.
- The WebHelp output can be used both offline and online.
- It's compatible with all browser vendors: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/wh_getting_started.html.
- It has a responsive layout, adjusts to the screen size, and can be used on a wide variety of devices (mobile devices, tablets, or desktops).
- The WebHelp layout can be fully customized: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/webhelp-responsive-description.html.
- The WebHelp publishing comes with 7-8 pre-configured color themes, but you can also create your own publishing templates: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr_publishing_templates.html.
- You can also use the free Oxygen Styles Basket website to customize the WebHelp output: https://styles.oxygenxml.com/.
- It contains its own search engine implemented in Javascript (with support for AND, OR, exact match, auto complete, and highlights). The search engine can assign various weights and priorities to various elements.https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr_searching.html.
- It automatically generates an Index page if the DITA content contains
<index>
elements. - For each section contained inside a topic, a mini table of contents is generated: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr-html5-pages.html#whr-topic-page-layout__topic-topic-toc.
- Inner topics, sections, and topics can be folded.
- Code block content can be automatically syntax highlighted when publishing: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/add-syntax-highlights-codeblocks.html.
- Tracked changes and comments made in the DITA XML content can be published as side notes in the WebHelp output: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/webhelp-responsive-plugin-additional-parameters.html#webhelp-responsive-plugin-additional-parameters__webhelp_show_changes_and_comments.
- The WebHelp output comes with support for the following built-in languages: English, French, German, Japanese, and Chinese, while support for additional languages can be added. It can also be used with right-to-left text orientation: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr-localization.html.
- It can be used for context-sensitive help, called with various help IDs from an application:https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr-context-sensitive.html.
- The WebHelp Feedback system can be integrated in every WebHelp page and provides support for users to add comments and offer feedback (create account, post message, moderate, manage multiple versions of documentation): https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr-feedback-system.html.
- You can embed Facebook, Twitter, or Google Analytics: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/webhelp-social-media-integration.html.
- WebHelp documentation can also be produced on the server side: https://www.oxygenxml.com/xml_webhelp/download_oxygenxml_webhelp.html.
- The WebHelp output was tested for Accessibility problems, it works well with a screen narrator, and one of the WebHelp color themes is fully 508 compliant for people with reduced vision: https://www.oxygenxml.com/doc/ug-webhelp-responsive/topics/whr-accessibility.html.
The following past webinars may further help people who want to customize the WebHelp
output: