Summary of HelpSetMaker

1 Introduction

This document will introduce the information of HelpSetMaker, which can be downloaded from http://sourceforge.net/projects/helpsetmaker.

HelpSetMaker - tool for creating structured online help and other help documents. Specially suited for the JavaHelp system. Creates JavaHelp HelpSets, HTML4 webpages and LaTeX source code. Written completely in Java, runs on any Java2-capable platform.

2 HelpSetMaker Usage

Generally we can follow the below steps to construct ourselves documents.

1. Construct a project;
2. Construct some documents in the project;
3. Edit each document in the middle part of HelpSetMaker;
4. Produce the required document, JaveHelpSet, HTML,LaTex or Eclipse HelpSet.

Some common editing methods are introduced in the following.

• Style Sheet Editing
  We can design the style sheet using CSS definitions, include general format and custom format for specified content.
  h1 {
        padding: 2px;
        background-color: #ffff99;
        color: black;
        text-align: center;
        }
  .example {
        height: 100%;
        position: relative;
        bottom: 0;
        text-align: center;
        font-family: Arial;
        font-size: 12px;
        margin-left: 10px;
        margin-right: 10px;
        margin-top: 10px;
        margin-bottom: 10px;
        padding-left: 10px;
        padding-right: 10px;
        padding-bottom: 10px;
        background-color: #dddddd;
        color: black;
        }

• Add Images
  1. Set the root directories of image library;
  2. Place the required images in the directories;
  3. Stand-alone images are always rendered as own entities between paragraphs. They have a name, a sequence number, and a label which can be used to reference them. Stand-alone images are defined by the one-line command ":image":
     eg. :image shots/open.png|Dialog to open files|fileopen;

  4. Inline images are written directly in the text using a scheme similar to bold or italic text. The indicator for an inline image is a double hash, "##".
     eg. ##buttons/ok.png|the "OK" button##.
• Add Links
  A simple link target just points to one of the documents in the help set. You should only put one label in each document. It is also possible to reference not at the begin of another page but somewhere within it. Therefore, an anchor must be defined with the ":anchor" command.
  eg. : title Great inventors
  : label inventors
  { text }
  : anchor zuse
  The link target is defined by the label of the command, surrounded by "<< >>" and accompaigned by the text to write at the source location.
  eg. << inventors#zuse|Konrad //Zuse// >>.

• Add External Links
  It can also be necessary to link to an external document. This is done with the [[ ]] notation:
  eg. [[http://www.cantamen.de|our website]]