[ContextHelp]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [ContextHelp] of settings/exphelp.ini.
File
settings/exphelp.ini; override it in settings/override/exphelp.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| Providers[] | expHelpContentProvider | Context help: the "?" link in the header of the administration opens the page that answers "help for this page" (expHelpContextRegistry; doc/eng-us/features/6.0/help-system.md, "Context help"). One entry per key: Map[<module>/<view>]=<page id>[#<heading anchor>] Map[<module>]=... every view of the module without an entry of its own Map[<design>:<module>/<view>]=... only in that design (admin4l, editor, admin, adminui ...); wins over the Map[<design>:<module>]=... same key without a design A page id is the path below doc/eng-us/, the same in every language (ext/<extension>/<path> for an extension's doc directory, [IndexSettings] ExtensionDocDirs[]); the anchor is the heading's anchor as the viewer makes it. The lookup: Providers[], then design:module/view, module/view, design:module, module, then the help dashboard. An entry whose page the help does not serve (not written yet, not git-tracked, outside doc/) is skipped, so the next key answers. Extensions register the help of their own modules in their settings/exphelp.ini.append.php in the same way. Classes implementing expHelpContextProviderInterface, asked before the map, in this order |
| CheckPages | enabled | enabled: an entry counts only when the help index serves its page; disabled: syntax checks only (faster) |
| MenuTopics | 6 | The header's Help menu (the "?" button): how many topics related to the page it lists (the module's other entries of this map, then [FeaturedSettings] PageList[]), and its quick links, key => page id[#anchor] or an exphelp view. The kernel's keys are named in the menu's template; an extension's own key shows the page's title. |
| MenuLinks[<key>] | getting_started=help/getting-started.md; keyboard_shortcuts=help/keyboard-shortcuts.md; whats_new=changelogs/6.0/6.0.15.md; report=exphelp/report; git=install/03-getting-the-code.md#b-git-clone-and-composer-install | |
| Map[<key>] | content=guides/content-model-and-editing.md; content/dashboard=help/admin-tour.md; content/view=help/editing-content.md; content/edit=help/editing-content.md; content/multiedit=guides/content-model-and-editing.md#6-edit-many-items-in-one-form-multi-node-edit; content/versionview=guides/content-history.md; content/history=guides/content-history.md; ... | Content |
| ReportSecurityAnchor | security-problems | Where a siteaccess switches the view exphelp/report off (site.ini [SiteAccessRules]), "Report an error" opens the page of Map[exphelp/report] instead and its security link this heading of it (on a translated page the heading in the same position: #sicherheitsprobleme in German). expHelp::reportLinks(), fetch( 'exphelp', 'report_links' ). |
See also
Generated example: exphelp.ini [ContextHelp]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/exphelp.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment