...

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:

runtimeOptions.helpUrl

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

/help

...

How to configure the help button

For each tabular view in translate5 (task overview, user administration, clients, editor and language resource) the corresponding help page can be configured separately.

By default the window is automatically shown, if the help URL for the corresponding tabular view is not empty.

The default configuration in translate5 looks like the following:

Define "automatic show"-behaviour of the help page with the "doNotShowAgain" config option

The value "doNotShowAgain" is by default set to false for all tabular views. This means:

• as soon as a URL is defined, the help page will automatically be shown once, as soon as the user enters the relevant section.
• After each new login it will be again shown once.
• For each help page the user can click a checkbox, that he for himself does not want to see this help page again automatically

If the value "doNotShowAgain" is set to "true" for a tabular view in Zf_configuration, the corresponding help page of that tabular view will never pop up automatically for any user.

URL definition

For all tabular views no default URL is defined. Thus no help button will be displayed.

If you want to display a help button for a tabular view, enter a value.

If you enter complete URL with protocol and domain like https://www.youtube.com/yourvideo, this URL will be shown as content of your help page.

If you enter a relative value, this needs to start with /help/ and translate5 will look in the folder

/application/modules/default/views/scripts/help/

...

for a phtml-file that is rendered.
However you should not place your custom phtml file in this folder, because it will be overwritten/deleted with the next update.
Instead use the feature to Implement a custom translate5 skin and put your custom phtml help page in the client-specific folder, where it will not be overwritten.
(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 content, 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, languageresources, taskoverview, useroverview
Example:
runtimeOptions.helpUrl = "/help/{0}"
When pressing the help button in the taskoverview the following relative URL would be loaded:
...
Help page localization
The current locale of the authenticated user can also be passed to the URL via the optional placeholder "{1}". This fragment is replaced with the current users locale.
Also the whole URL can point to a completely different web page:
Example:
runtimeOptions.helpUrl = "http://www.example.com/translate5-help/?section={0}&language={1}
Pass section by parameter
You can also make translate5 to pass the current tabular view name in translate5 as parameter in the help page URL via the optional parameter "{0}". The passed value is the last part of the Zf_configuration name for that view (see above table).
So for example for the task overview in the above table you see, that the Zf_configuration name is "runtimeOptions.frontend.defaultState.helpWindow.taskoverview" and thus the passed value for the task overview would be "taskoverview".
Zf_acl_rules
Please only change these settings, if you really know, what you do.
...