...
By default the window is automatically shown, if the help loaderUrl for the corresponding tabular view is not empty.
The loaderUrl for each tabular view can be defined in the following configurations:
- runtimeOptions.frontend.helpWindow.customeroverview.loaderUrl
- runtimeOptions.frontend.helpWindow.taskoverview.loaderUrl
- runtimeOptions.frontend.helpWindow.useroverview.loaderUrl
- runtimeOptions.frontend.helpWindow.editor.loaderUrl
- runtimeOptions.frontend.helpWindow.languageresource.loaderUrl
The default configuration in translate5 looks like the following:
| Table view | Zf_configuration name | value |
|---|---|---|
| Customers | runtimeOptions.frontend.defaultState.helpWindow.customeroverview | {"doNotShowAgain":false,"loaderUrl":""} |
| Task overview | runtimeOptions.frontend.defaultState.helpWindow.taskoverview | {"doNotShowAgain":false,"loaderUrl":""} |
| User administration | runtimeOptions.frontend.defaultState.helpWindow.useroverview | {"doNotShowAgain":false,"loaderUrl":""} |
| Editor | runtimeOptions.frontend.defaultState.helpWindow.editor | {"doNotShowAgain":false,"loaderUrl":""} |
| Language resources | runtimeOptions.frontend.defaultState.helpWindow.languageresource | {"doNotShowAgain":false,"loaderUrl":""} |
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 loaderUrl config for the tabular view 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 configuration definition
For all tabular views no default loaderUrl config is defined. Thus no help button will be displayed.
...