...

Help Page configuration

It is possible to link custom show a help pages button in translate5. The button opens a pop up window with help content.

The displayed content must be provided as HTML-files to translate5 by the company using translate5.

The HTML-files that are provided as help content are content is loaded by AJAX and displayed in Popup Window in translate5.

When the configuration URL for the help files (details see below) is empty, the help buttons are not shown at all.

General help page for translate5

The configuration parameter in Zf_configuration for this is therefore:

runtimeOptions.helpUrl

This URL can e. g. be set to the value

/help

With this URL the index.phtml view-script would be loaded from this location in translate5: 

/application/modules/default/views/scripts/help/index.phtml

(or from the client-specific overwrite-folder, if the view script does exists there)

Different help pages for each main section in translate5

If the every section in translate5 should have its own help contentIf the help should be dedicated to the different sections in translate5, a placeholder {0} can be provided in the configured URL.

This placeholder is replaced by one of the following values, corresponding to the translate5 sections:

editor, matchresource, taskoverview, useroverview

Example:

runtimeOptions.helpUrl = "/help/{0}"

When pressing the help button in the taskoverview the following relative URL would be loaded:

...

/help/taskoverview

...

When the URL is empty, the help buttons are deactivated.

...

Zf_acl_rules
Please only change these settings, if you really know, what you do.
...