oXygen WebHelp for DITA and DocBook

Introduction

oXygen offers built-in support to create online documentation. This website-friendly presentation of the XML content features table of contents, index navigation, and text search capabilities.

WebHelp Devices

Single-Source Publishing

You can transform DITA and DocBook documents into three types of WebHelp systems:

  • Desktop WebHelp - using the predefined DITA/DocBook WebHelp transformation scenario;
  • Desktop WebHelp with feedback - using the predefined DITA/DocBook WebHelp with feedback transformation scenario;
  • WebHelp for mobile devices (supported over multiple platforms) - using the predefined DITA/DocBook WebHelp - Mobile transformation scenario.

WebHelp for Desktop

The left side of the output contains the table of contents, the text search tab, and the index tab.

Table of Contents
Table of Contents
Search
Search
Search Index Terms
Index

The right side presents the current topic and all its comments. You can easily navigate through the content using the arrows from the top of the page. A short sample WebHelp for Desktop is available here.

WebHelp with Feedback for Desktop

oXygen has the ability to transform DITA and DocBook documents into Feedback-Enabled WebHelp systems, being the first XML single-source publishing solution which supports this technology. This means that the communication between readers and the online help system that you obtain is bidirectional. The users that visit the documentation web pages are able to insert comments and also see other comments and reply to them. In case you used forum systems before, you will find a similar graphical interface and familiar concepts that should ease the interaction with the Feedback-Enabled WebHelp system even more. A short sample WebHelp with Feedback is available here.

Feedback-Enabled WebHelp Output

WebHelp for the Mobile world

To further improve its ability to create online documentation, oXygen offers support to transform DITA and DocBook documents into mobile WebHelp systems. This feature generates an output that works on multiple platforms (Android, iOS, BlackBerry, Windows Mobile) and is specially designed for mobile devices. All the specific touch screen gestures are supported. The functionality of the desktop WebHelp layout is preserved, offering table of contents, search capabilities, and index navigation, organized in an intuitive layout. A short sample of WebHelp for Mobile is available here.

Browsing contents
Browsing contents
Search
Search
Search Index Terms
Search Index Terms

Recognizes gestures

You can swipe, scroll up and down, copy content and so on.

Recognizes gestures