oXygen WebHelp for DITA and DocBook
oXygen offers support for transforming DITA
and DocBook resources into WebHelp output. WebHelp consists of a series of HTML pages,
neatly integrated into a system that offers table of contents, index navigation, text
search capabilities, and various delivery formats (including feedback-enabled
A WebHelp system is the result of running a transformation scenario.
However, if you require an automated process that produces the WebHelp output, the
same result can be obtained by running the transformation inside oXygen XML
WebHelp Plugin, which is a command-line interface application that requires its own
You can transform DITA and DocBook documents into three types of WebHelp
- Desktop WebHelp (using the predefined DITA/DocBook WebHelp transformation
- 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 and mobile transformation scenarios)
The WebHelp Responsive system features a very flexible layout and is designed to adapt
to any device and screen size to provide an optimal viewing and interaction experience. It
is based upon the Bootstrap responsive front-end framework and is
available for DITA document types.
The layout of the WebHelp Responsive system is platform independent and is highly
customizable. It relies on a template mechanism that allows you to control the position of
various functional components in the output to suit your particular requirements. You can
select from several different styles of layouts and each of these layouts include a
collection of skins that you can choose from, or you can even customize your own.
WebHelp Responsive with Feedback
The WebHelp Responsive with Feedback system includes the same features as the WebHelp
Responsive system but also includes a feedback system that allows your users to add
comments to your output. It is available for DITA document types.
The layout of the feedback-enabled WebHelp output contains a Comments
section at the bottom of the pane where you can interact with users through a discussion
thread system. The interface and concepts of the Comments section is
similar to common forum systems and it includes an administration panel that allows you to
manage comments and users.
WebHelp Classic for Desktop
The WebHelp Classic system is designed for desktop systems and it features a familiar
tri-pane layout. You can use the system to publish DITA and DocBook
documents and oXygen includes predefined transformation scenarios to make it a
single-source publishing solution. oXygen also includes a WebHelp Skin Builder that
allows you to visually customize the look and feel of your WebHelp output. To see our
video demonstration of the WebHelp Skin Builder, click here.
The left and upper panes of the default layout in a WebHelp Classic system contains a
table of contents, search tab, index tab, navigation links, and some options for selecting
the type of frames and for printing the content.
The main pane presents the current topic and you can easily navigate through the
content using the navigation arrows at the top of the pane, the table of contents, or
links within the topics. A short sample of a WebHelp Classic for Desktop system is
WebHelp Classic with Feedback for Desktop
oXygen has the ability to transform DITA and DocBook documents into
feedback-enabled WebHelp systems. 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
The layout of the WebHelp Classic with Feedback system features a familiar
tri-pane layout and it also contains a Comments
section at the bottom of the main pane where you can interact with users through a
discussion thread system. The interface and concepts of the Comments
section is similar to common forum systems and it includes an administration panel that
allows you to manage comments and users. A short sample of a WebHelp Classic with Feedback
system is available here.
WebHelp Classic for Mobile Devices
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 common touch screen gestures
are supported. The functionality of the desktop WebHelp layout is preserved, it is
organized in an intuitive layout, and offers table of contents, search capabilities, and
index navigation. A short sample of a WebHelp Classic Mobile system is available here.
You can swipe, scroll up and down, copy content and so on.