How to write the help entries your team sees
Add or edit a help entry. Point it at the right page.
Browse
On this page
How to do it
Open the help drawer.
Click the question mark icon in the page header. The drawer shows the help entries for that page. Use the search box to filter.
Open Admin Tools.
Go to Settings, then System, then Admin Tools, and scroll to Help Entries. The help editor sits there. Settings for the nav and the system version sit beside it.
Press New Entry.
Pick the page from the Page list. It stays in sync with the current navigation, so new pages appear on their own. Write a Question and an Answer, and set the Sort Order. Each entry has a page, a question, an answer and an order.
Press Create and check the drawer.
Entries show in that page's help drawer in sort order. Open the page and click the question mark icon to read yours.
Edit, turn off or cover more pages.
Edit an entry, or turn it on or off. One entry has one page. An entry saved at one page shows only on that exact page. To cover many pages with one topic, add one entry for each page.
What you will have
- Open the help drawer from any page.
- Add a help entry for a page.
- Edit an entry, set its order and turn it on or off.
- Cover many pages with one topic.
Why it works this way: How to write the help entries your team sees
Every entry shows to all who open its page. We retired per-role views.
The drawer matches a page path exactly, not by prefix. An entry never rolls down to the pages under it.
If it did not work: How to write the help entries your team sees
- The buttons are greyed out: you can view these settings but not change them. You need Edit access. Delete needs the highest level of access.
- An entry does not show on a sub page: it matches one page exactly. Add an entry for that page.
Questions this page answers
How do I add or edit help entries?
Go to Settings, then System, then Admin Tools. Press New Entry, pick the page, write a question and answer, and set the sort order.
Can one help entry show on multiple pages?
No. Each entry has one page and the drawer matches it exactly. Add a separate entry for each page.
Why are the buttons greyed out on Admin Tools?
You can view the page but not change it. You need Edit access to add, edit or turn off a help entry. Delete needs the highest level of access.
Was this helpful?