exphelp
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The exphelp module: the help system of the administration (doc/eng-us/features/6.0/help-system.md).
Description
The exphelp module: the help system of the administration (doc/eng-us/features/6.0/help-system.md).
It reads the git-tracked text and Markdown files under doc/ and the documentation of the active extensions (exphelp.ini [IndexSettings] ActiveExtensionDocs, ExtensionDocDirs[]) and shows them rendered, searchable and filtered by audience.
exphelp/dashboard the help start page: search, audiences, featured pages, recent changes, trackers
exphelp/audience/<audience> the landing page of an audience (expHelpLanding)
exphelp/viewer/<page id> one page; <page id> is its path below doc/ (features/6.0/help-system.md);
(lang)/<key> shows it in another language (the English original)
exphelp/contents every help page as one tree (all folders open), with a filter box
exphelp/navigation/<folder> one folder of the tree; (fViews
| Name | Summary |
|---|---|
| asset | |
| audience | the landing page of an audience (expHelpLanding) |
| contents | every help page as one tree (all folders open), with a filter box |
| context | |
| dashboard | the help start page: search, audiences, featured pages, recent changes, trackers |
| extensions | |
| feedback | |
| image | |
| manual | |
| navigation | one folder of the tree; (f |
| report | |
| search | |
| state | |
| topic | |
| viewer |
Policy functions
| Function | Limitations |
|---|---|
| read | - |
| context | - |
| feedback | - |
Fetch functions
| Name | Summary |
|---|---|
| context | expHelpFunctionCollection::fetchContext() |
| context_menu | The header's Help menu: fetch( 'exphelp', 'context_menu', hash( 'module', ..., 'view', ..., 'design', ... |
| license | fetch( 'exphelp', 'license', hash( 'id', $page_id ) ): the documentation license of a page (expHelpLicense::forPage()) |
| reading_key | The /(lang)/ value the help's links keep in this request, '' when none: fetch( 'exphelp', 'reading_key' ) (expHelp::readingKey(): a reader without the ... |
| report_links | Where "Report an error" and its security link lead on this siteaccess: fetch( 'exphelp', 'report_links' ) (url, security, view; expHelp::reportLinks(): the ... |
| site_map | expHelpFunctionCollection::fetchSiteMap() |
| site_topic | Help maintained as content on the site's own pages (the node templates of help_*, extension exphelpsite): fetch( 'exphelp', 'site_topic', hash( 'object_id', ... |
Source
kernel/exphelp/module.php
See also
Help: features/6.0/help-system.md
Generated examples: the views of exphelp
Generated examples: the policies of exphelp
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this module.
In this section
Contributors
- Graham Brookins Updated
Comments
Add a comment