...
The online help files of a plugin must be located in the /help directory of the plugin’s resources. Typically the help file sources will be located in /src/main/resources/help. This is a fixed location and cannot be configured. Within that help directory, a subdirectory must be created for each supported locale using the Java i8N notation. Some examples of this notation are:
| Locale Identifier | Description |
|---|---|
en_US | English (U.S) |
en_GB | English (United Kingdom) |
fr_FR | French (France) |
de_DE | German (Germany) |
nl_NL | Dutch (Netherlands) |
es_ES | Spanish (Spain) |
Within that subdirectory either a file called index.html or index.jsp should exist. If both files are present, index.jsp will be used. This file represents the online help file in that particular locale. The help directory may contain all kinds of resources used in the help file like images or ZIP files. These can be referred to by the XHTML or XML JSP document. Paths must be relative to the location of the XHTML or XML JSP Document file. The following is an example online help directory structure:
...
| Code Block | ||
|---|---|---|
| ||
public class
CustomElementFBO extends ElementFBO {
...
public String getHelpTopicsId() {
return Activator.OH_ANCHOR_INTRODUCTION;
}
}
|
| Note |
|---|
In the above example, the ID of the actual help topic is defined statically (as |
...