Helpset Generation
==================

The respective helpsets for each of the locales (de, en) have been generated 
using JHelpDev 0.62 (see also jhelpdev.sourceforge.net).

JHelpDev (at least up to this version) is somewhat limited in its 
functionality, specifically with regard to location and naming of certain 
JavaHelp meta files and meta directories, which it generates.
For example, the map file (file ending is: .jhm) when generated is always named 
'Map.jhm'; likewise the directory for full text search when generated is always 
named 'JavaHelpSearch'.

In addition, these files are always placed into the project directory, i.e., 
the directory that is given in the JHelpDev XML project configuration/settings 
file.

Given these observations, it is wise to place the contents of a JHelpDev 
helpset project in a directory of their own so that the generated full text 
search data base and the map file match the helpset project and solely contain 
entries for it.
Also, it is a Good Idea(TM) to use another directory within this project 
directory to place the HTML contents of the helpset project into.

Helpset Directories
===================

Due to the above observations:

Helpset Locale         Directory
en                     ./en
de                     ./de

Note that the contents of the './en' directory are duplicated in this directory 
(i.e., '.') to achieve the following default behavior at application runtime:
- whenever the helpset for a given locale is requested, the describing helpset 
file (file ending is: .hs) is searched in a directory that matches the (major) 
locale, i.e., './de' for the 'de' locale, for example
- when there is no matching directory for the given locale, the default helpset 
is used, which resides in this directory (i.e., '.')

Helpset Deployment
==================

Further observations on JavaHelp deployment suggest that the JavaHelp mechanism 
itself expects the JavaHelpSearch directory to reside within the same directory 
as the describing helpset file (file ending is: .hs).

Howto For The Impatient
=======================

1. Download JHelpDev from http://jhelpdev.sourceforge.net and extract it (no
   installation required).

2. Have a look at the project settings files 'de/help_tutorial_en.jhelpdev.xml'
   and 'en/help_tutorial_en.jhelpdev.xml' and the change the path under
   <projectdir> to fit your needs.

3. Run 'jhelpdev.jar' and open the project file. Now, you can either 'view the
   help' or 'create all' the required files.

4. Copy any change from the English localization 'en/' to the default local '.'

5. Make sure to commit only files with real changes. Typically,
   'com.yworks.yfx.yfiles.hs' and 'com.yworks.yfx.yfilesIndex.xml' are
   recreated with identical contents by JHelpDev.
   'Map.jhm', 'com.yworks.yfx.yfilesMap.jhm' and 'com.yworks.yfx.yfilesTOC.xml'
   will change only if a filename or a link name was modified.
   To prevent commit wars, do not commit your project settings.
