how to publish help pages

Help?

A GUI-application without help pages is not state of the art. But documentation and writing help pages is not the favorite job of a developer, so I decided to use the HTML-language for help files. It is well known and the best - java has HTML-support out of the box :)

So I only had to add a tiny webbrowser to SRStarter and support for help pages is there without any coding at application level.

top

Organisation

The main page, that is displayed at startup of the help browser is called general.html, the localized german page is de-general.html. These files are located in the resource root res.

All further help pages are located in the directory help, or localized for german help.de (just change de to the country code of the language of your choice).

The directory tree below help will be shown at the help browser and filenames can be translated using MessageSource-mechanism.

top

Format

Each help page should be considered a standalone HTML-page. You don't need to code the <Header>-section, but you need to code the body:

<html>
   <body>
      <p>Your help stuff comes here</p>
   </body>
</html>

top