The help center
Exponential 6 brings its documentation with it. The help center in the administration shows the help pages of the installation's own version: a user manual with one page per task, guides for each audience, the documentation of the active extensions, and help for the page you are on. It needs no internet connection to the documentation site.
Reading the help needs the policy exphelp/read. Administrators have it, and a new installation gives it to the Editor role. Visitors who are not signed in never see it.
Help for the page you are on
The question mark button in the header opens the help menu:
- a field to search the help;
- Open the Help center;
- Help for this page: the help page that belongs to the page you are looking at, for example Creating and editing content on an item's page;
- Related topics and Quick links, such as Getting started, Keyboard shortcuts and What's new.
The question mark button opens the help for the page you are on, related topics and links into the help center.
The help center's start page
Open it from the help menu, from Help center in the dashboard's left column, or from the quick action on the dashboard.
The help center: a search field, the help for each audience, the categories and the featured pages.
- How can we help?: a search over the titles, headings and text of every page. Press / to jump to the field; results appear while you type.
- For: the help for each audience, such as Editors, Administrators, Developers and End users; More audiences shows the rest.
- Reading in: the language of the help, where pages are translated.
- Browse all help: every page in its book and chapter.
- Further down: the categories, featured pages, the latest changes to the documentation, and how to report an error.
A help page
A page of the help center's user manual: who may do it, the steps, what can go wrong and related pages.
Each page shows its path at the top, the page tree of its section on the left and the headings of the page (On this page) on the right. Below the title: the audiences it is for, its category, when it was last changed and how long it takes to read, with Print this page and Download as PDF. Links lead to the previous and next page of the section.
The user manual in the help center
The category User manual answers one question per page, such as How do I find content in the administration?, always in the same order: who may do it, the steps, what can go wrong, and related pages. The manual you are reading now explains the same tasks with more pictures; its pages link to the matching help pages under Read more.
Documentation of the extensions
Extensions in the help's own left menu lists the documentation that every active extension brings with it, read in the same viewer and found by the same search.
What can go wrong
- There is no question mark button. Your role does not have exphelp/read. Ask an administrator to grant it.
- A page says it was not found. The help shows only the documentation files of the installation; a link to a file that is not part of it ends there.
- You found an error. Use Report an error in the help's left menu: it says where to report it and what to write.
Read more
- The user manual of the help center
- The help system, for administrators and writers of help pages.
- Reading the help in other languages
Contributors
- Graham Brookins Updated Maintainer
Comments
Add a comment