...
The HTML-files that are provided as help content are loaded by AJAX and displayed in Popup Window in translate5.
When the configuration URL loaderUrl for the help files (details see below) is empty, the help buttons are not shown at all.
...
By default the window is automatically shown, if the help URL loaderUrl for the corresponding tabular view is not empty.
...
| Table view | Zf_configuration name | value |
|---|---|---|
| Customers | runtimeOptions.frontend.defaultState.helpWindow.customeroverview | {"doNotShowAgain":false,"urlloaderUrl":""} |
| Task overview | runtimeOptions.frontend.defaultState.helpWindow.taskoverview | {"doNotShowAgain":false,"urlloaderUrl":""} |
| User administration | runtimeOptions.frontend.defaultState.helpWindow.useroverview | {"doNotShowAgain":false,"urlloaderUrl":""} |
| Editor | runtimeOptions.frontend.defaultState.helpWindow.editor | {"doNotShowAgain":false,"urlloaderUrl":""} |
| Language resources | runtimeOptions.frontend.defaultState.helpWindow.languageresource | {"doNotShowAgain":false,"urlloaderUrl":""} |
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 loaderUrl 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.
...
loaderUrl definition
For all tabular views no default URL loaderUrl 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 loaderUrl with protocol and domain like https://www.youtube.com/yourvideo, this URL loaderUrl will be shown as content of your help page.
...
The current locale of the authenticated user can also be passed to the URL loaderUrl via the optional placeholder "{1}". This fragment is replaced with the current users locale.
Also the whole URL loaderUrl can point to a completely different web page:
...
You can also make translate5 to pass the current tabular view name in translate5 as parameter in the help page URL loaderUrl via the optional parameter "{0}". The passed value is the last part of the Zf_configuration name for that view (see above table).
...