Main Help → Browser Style / Using the GEDitCOM Editor→ Documentation

Documentation

A browser style can include web or html files to document the use of the style. This help information will be available to the user of GEDitCOM II by choosing its "Documentation..." menu command. The entry point for accessing the help will be the (language).html file where (language) is the name of the currently selected language. If no file can be found for the current language, the help will start in the English.html file.

Some additional information on documentation is:

1. The documentation files can include any number of files. These files will all be in the same folder and you can link between the files using standard html link commands with href pointing to the file name. For example, if you add a file called settings.html to describe the browser style's settings options, you can link to that file from another file using <a href="settings.html">browser style settings</a>.
2. To include one of the browser styles's images in the help information, you can use an img element as follows:
   
           <img src="images/imagename.tiff" alt="Icon Name">
   
   where imagename is the name of the image (all images are saved as tiff files and thus the tiff extension is required). Note that all images are in a subfolder named images.
3. Help for multiple languages is created be adding each language's entry file (e.g., add French.html to add help in French). Each language can reuse other language files or can have entirely separate files.
4. Advanced users are free to add other types of files as well, such as a css file for cascading style sheets.
5. When a new browser style is created, it is preloaded with an English.html file. This file is required. You cannot delete it or change its name.
6. You can preview the documentation file results in a browser by selecting the template as using the "Preview Help In → Browser" menu command. This command will save the entire browser style and then open the selected documentation file in your browser. A new browser style has to be saved once before this feature is enabled.

If you are writing a browser style that also works in GEDitCOM, you should customize the documentation to show appropriate help for users of both GEDitCOM and GEDitCOM II.

Adding Documentation for a Browser Style or an Extension

To create a new documentation file:

• Choose "Template→New Documentation File" menu command. Enter the full file name for the documentation file. The file must be a standard web site file and thus have extension .html, .htm, or .css.
• See the section above for details on editing the new file.