Main module for managing setup of admin help pages

AdminHelp module for ProcessWire

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.

Instructions


Overview:

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.

!Important If you are planning on using the AdminHelpTab module, then you should install the FieldtypeTemplates prior to running setup.

Getting Started

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.

Using the Help Tab

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.

Using the Process Admin Help

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.

Help Setup Module (AdminHelp)


This is how the setup module looks before setup is completed: Desc

If you use the automated setup, it will create the field, templates and pages, and will auto-set the module configuration: Desc

Example Help Tab (when using AdminHelpTab)


Desc

Admin Help page (ProcessAdminHelp)


This shows all help docs in accordion; it is capable of displaying child pages also but this is not currently implemented in the module;

Desc

Accordion opened: Desc

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #401
    In the 401st issue of ProcessWire Weekly we'll cover the latest core updates, check out a brand new module called Lister Native Date Format, and more. Read on!
    Weekly.pw / 15 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer