Building a help plug-in
In this example, we assume that a documentation author has already supplied you with the raw documentation in the form of HTML files. The granularity and structure of these files is completely up to the documentation team. Once the documentation is delivered, setting up the plug-in and topics can be done independently.
We start by assuming that the documentation has already been provided in the following tree.
html/
concepts/
concept1.html
concept1_1.html
concept1_2.html
tasks/
task1.html
task2.html
task3_1.html
task3_2.html
ref/
ref1.html
ref2.html
We will assume that the plug-in name is com.example.helpexample.
The first step is to create a plug-in directory, com.example.helpexample underneath the platform plugins directory. The doc\ sub tree shown above should be copied into the directory.
Documentation plug-ins need a manifest just like code plug-ins. The following markup defines the documentation plug-in.
<?xml version="1.0" ?>
<plugin name="Online Help Sample"
id="com.example.helpexample"
version="1.0"
provider-name="MyExample" />