Writing Documentation

From Bioclipse
Jump to: navigation, search

Write Content for the Help System

This page will show how documentation for the inbuild Help System can be written. The Help System will setup a local webserver, and access from Bioclipse is provided by pointing an external webbrowser to this webserver.

A Table of Contents

First step is to create a table of contents as a XML file:

  <?xml version="1.0" encoding="UTF-8"?>
  <?NLS TYPE="org.eclipse.help.toc"?>
  
  <toc label="Sample Table of Contents">
  	<topic label="Main Topic"  href="doc/maintopic.html"> 
  		<topic label="Sub Topic" href="doc/subtopic.html"/> 
  	</topic>
  	<topic label="Main Topic 2"/>
  </toc>

This points to a number of HTML pages of which the format looks like:

  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  
  <html>
  <head>
  	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  	<title>Main Topic</title>
  </head>
  
  <body>
    <h1>Main Topic</h1>
    Please enter your text here.
  </body>
  </html>


The Help TOC extension point

Then comes the issue of connecting it to the connection point.

1. Add 'org.eclipse.help.[webapp|ui|appserver|base]' as dependencies

2. Add an extension 'org.eclipse.help.toc' with this content:

a. File := your new toc.xml file
b. primary := true

This should give you the following content in the plugin.xml source:

  <extension point="org.eclipse.help.toc">
     <toc file="toc.xml" primary="true"/>
  </extension>