About Admin Help Setup
Main module for managing setup of admin help pages
|Category 1||Admin Helpers|
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
|Category 2||Process Modules|
Process modules are apps that run in the ProcessWire admin.
Close to stable, but users are advised to be cautious and test thoroughly.*
|Compatibility||2.6, 2.7, 3.0|
|Date Added||January 5, 2016|
|Last Updated||August 2, 2018|
This module's files should be placed in /site/modules/AdminHelp/
How to install or uninstall modules
Processwire helper modules for managing site documentation in ProcessWire CMS.
Currently beta state - please use with caution and report all errors or things that don't work as expected.
There are 3 modules included with this: the master module holds the settings for the other 2.
The Admin Help Setup module is capable of assisting in the creation of the fields, templates and pages needed for setting up documentation.
!ImportantIf you are planning on using the AdminHelpTab module, then you should install the FieldtypeTemplates prior to running setup.
If you already setup a hidden part of your page tree for help documentation you can simply specify the templates and root page of the help section in the module settings.
Otherwise you can run the setup and it will auto-create the template_select field, help-index template and help-doc template, and the example help pages. Once created you can move those pages out of the root into any area you want, such as below a 'config' or 'settings' branch.
Once you have setup your docs template, template_select field and some help pages, you should install the AdminHelpTab module, then select the template(s) to show the docs on, as well as the root page of your docs.
At this point the 'Help' tab should show up for the relevant template (as specified with the template_select field), and show the help docs that have that template specified.
To have a global help page, which renders all of the help docs in an accordion view, you can install the ProcessAdminHelp module, which will setup a page to view the help docs, under setup.
This shows all help docs in accordion; it is capable of displaying child pages also but this is not currently implemented in the module;
Your e-mail is kept confidential and not included with your comment. Website is optional.
- Admin Helpers
- Core Modules
- Development Tools
- Field Types
- Input Fields
- Language Modules
- Language Packs
- Markup Generation
- Premium Modules
- Process Modules
- Proof of Concept
- Site Profiles
- Social, Feeds, Services
- Text Formatters
- Other Modules
- Users and Access
*Use modules at your own risk. There are no guarantees or warranties. It is recommended that you backup your site and database before installing new modules.