Help for XMA components and pages can be supplied as HTML-Pages. You have to write the HTML-Pages and place them in your web application.

In the guidesigner you define the URI of the help page in the property HelpUri. You can define this property for each page and component. The default for HelpUri is help/<package>/<ClassName>.html . When the user presses F1 in the running application, this URI is opened and showed in a browser window. If you set the HelpUri of a NotebookPage or an EmbeddedPage to the empty string, the HelpUri of the enclosing page is used. If you set the HelpUri of a DialogPage to the empty string, the HelpUri of the component is used.

Typically the HelpUri will be a relative URI. If it does not start with a '/' it will be treated as relative to the uri of the xma-application. If it starts with a '/' it will treated as an uri to the same server as the application, but without the context root. If it starts with a protocol identifier (e.g. http: https: file:), it will be treated as an absolute URI.

The help pages are loaded from the server by the browser window. They are cached by the browser cache and by the proxies.

If you e.g. want to integrate the help pages into a menu, the presentation of the help page corresponding to a page can be triggered by directly calling helpEvent() on this page.

For internationalization of help pages see Translating Help Pages