Jump to content
Macrura

AdminDocsTab

Recommended Posts

** replaced with this: https://processwire.com/talk/topic/11817-module-adminhelp/ **

This is a new module, work in progress/alpha (not for use on live site):

[github link deleted]

AdminDocsTab module for ProcessWire

Processwire helper modules for managing site documentation.

Instructions

This is a helper module which expects you to have already setup a hidden part of your page tree to establish your documentation, using any template (e.g. 'docs') and a body field (ckeditor).

The docs template does not need to have an output template, as the module will only echo the body field inside the admin.

In addition this 'docs' template will require a template select field (separate module: FieldtypeTemplates) which should be named template_select.

Once you have setup your docs template, template_select field and some docs pages, you should install the AdminDocsTab module, then select the template(s) to show the docs on, as well as the root page of your docs.

At this point the 'Docs' tab should show up for the relevant template (as specified in the Doc), and show the docs that have that template specified.

To have a global docs overview page (e.g. 'Docs'), which renders all of the docs in an accordion view, you can install the ProcessDocsView module, which will setup a page to view the docs (under Setup).

  • Like 15

Share this post


Link to post
Share on other sites

Nice.  So this is similar to the Templates Notes module, except the management of the docs is done via ProcessWire rather than HTML files.  Would that be a fair way to explain it?

One module idea I had around documentation was more of an admin help section not tied directly to a page template.  Basically a PW version of WordPress's "WP Help" plugin:

https://wordpress.org/plugins/wp-help/

Share this post


Link to post
Share on other sites

Nice.  So this is similar to the Templates Notes module, except the management of the docs is done via ProcessWire rather than HTML files.  Would that be a fair way to explain it?

yes, this way you can manage your docs using the standard page editor and all of the development team, users etc can keep on contributing to them;

One module idea I had around documentation was more of an admin help section not tied directly to a page template.  Basically a PW version of WordPress's "WP Help" plugin:

https://wordpress.org/plugins/wp-help/

if you install the ProcessDocsView module, then it makes a documentation area that shows all of the docs (help);

it is similar to the wordpress thing, but not as advanced; it just has collapsed accordions for each help topic; but it could be expanded, e.g. maybe a separate process module, like DocsViewAdvanced which has some left menu with heirarchy and then loads each content by ajax..

if you don't want any docs to show up on the page editor then you just wouldn't need to select any templates when making the docs; only thing is that the Process module gets the settings from the DocsTab module currently

Share this post


Link to post
Share on other sites

So maybe this should be renamed and some of the wording changed for clarity - like AdminHelp instead of docs;

as J. Lahijani brings up, what if you only want the main help page but not the help tab on the editor.

So rethinking this setup to where there would be 3 modules:

1.)  AdminHelp

this would hold the settings for the AdminHelp sub-modules:

- template being used for help pages (for sites with existing help pages)

- root page of help pages

it could possibly:

- create the 'help' and 'help-index' templates if not found, and add the title and body fields and set the family rules.

- create a default help page.

2.) AdminHelpTab

- requires the FieldtypeTemplates and AdminHelp modules.

- creates the field for the template_select on the template that is specified in the main module, and add it to that template;

- holds the setting for which templates to allow help tab on

- handles hooking into the page editor and adding the Help tab, and the scoped CSS for the display of the help text.

3.) ProcessAdminHelp

- requires AdminHelp module

- handles creation and display of the main help page

Edited by Macrura
So this is almost done, rendering this module/thread obsolete shortly; will post new module in a few days, per the above 'brainstorm'..
  • Like 2

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

×
×
  • Create New...