LDAPviewer Help - Info Files

Specialized edtors are typically invoked when attributes being edited are complex, confusing or customized. There is frequently the need to provide additional information over and above the standard help file which typically describes only the editing functionality. In order to meet this need in a extensible manner LDAPviewer provides the Help Info system.

When a specialized editor that is Info Ready is loaded on a platform that supports Java 1.8 or higher (JDK 8/JRE 8) for a particular attribute it will look in the help/info (help\info) directory for an HTML file with the name lower-case-attribute-name.html and if present will configure an Info button which, when clicked, will display this file. For example, if the Info Ready editor is loaded for the attribute audio then LDAPviewer will look for, in the help/info (help\info) directory, a file with the name audio.html (help\info\audio.html or help/info/audio.html depending on platform).

Note: In the case where an object has an alias, for instance, cn and its alias commonName, LDAPviewer will only use the primary name not the alias name. So in this case LDAPviewer will look for a file with the name cn.html and will not look for a file with a name commonname.html.

HTML File Notes

The following notes may be useful when building HTML files for use with the Help Info feature. (Note: The Help Info feature is only available on Java 1.8+ (JRE 8+/JDK 8+)):

Use basic HTML 5.0 features. The Help Info is implemented using JavaFX 2.0 and specifically the WebEngine object. Since various version of Java 1.8+ need to be supported (including very early ones) the feature set should avoid exotic capabilities. Consult the relevant JavaFX documentation if in doubt.
Images and embedded content (such as CSS or Java script files) should be placed in the Info directory and use a local reference (such as in the img tag). This is not an absolute restriction but simply ensures that the local user will not require a public internet connection. If it is known or expected that a public internet connection is always available then appropriate resources may be linked from anywhere.
While the HTML file may contain all the required user information, if it is known, or expected, that the user will have external access (public or an intranet) then the loaded HTML file may simply contain a link(s) (anchor or a tag) to one or more existing web page(s) containing appropriate information.