About Admin Help Setup

Main module for managing setup of admin help pages

Category 1Admin Helpers
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
Category 2Process Modules
Process modules are apps that run in the ProcessWire admin.
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authormacrura
Module Version1.0.6
Class NameAdminHelp
Compatibility2.6, 2.7, 3.0
Date AddedJanuary 5, 2016
Last UpdatedJune 23, 2017
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/AdminHelp/
How to install or uninstall modules

README

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.

!ImportantIf 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

Comments

  • Charles Stevens

    Charles Stevens 2 years ago 10

    A great contribution and effective documentation tool. Thanks for creating this.

  • macrura

    macrura 2 years ago 20

    Thanks! It has gotten better on this latest update, and will probably continue to improve and be tweaked over the next month or so..

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.