Table of Contents
structpublish Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" yes
- 2022-07-31 "Igor" yes
- 2020-07-29 "Hogfather" unknown
This plugin lets you manage the workflow of page approval and publishing. It stores its information as struct data, which integrates well into aggregations.
Installation
You need to install an up-to-date struct plugin first.
Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.
Usage
In the Admin Interface you configure which pages and namespaces should be under the plugin's control and you can grant publishing rights to specific users and groups.
Admin interface
Example configuration for a handbook
namespace:
Pattern | Status | User or @group |
---|---|---|
handbook:** | approve | @approver, @admin, me |
handbook:** | publish | @publisher, @admin, me |
Workflow
Publishable pages display a banner with approval status of the currently viewed revision. Users with appropriate permissions can use action buttons in the banner to change the status, i.e. approve or publish the given revision.
By default the banner displays verbose information about relevant revisions. There is a configuration setting to switch to a compact view.
Syntax
Minimal syntax to display a table of all available structpublish information.
---- structpublish ---- ----
You can use filters to refine the results.
Notifications
Sometimes it is useful to notify some users when the publishing status of a page changes. The most obvious case is when a page is reviewed and awaits final approval. You may notify users who are assigned to the next due workflow step.
Optional email notifications can be activated in the main configuration of the plugin. In that case you also need to choose which transitions will trigger notifications.
Changes
- Version upped (2024-05-20 23:51)
- Fix diff link in banner (format of rev param) (2024-05-20 19:43)
- Version upped (2024-04-04 23:51)
- Code style fixes (2024-04-04 12:48)
- Fix fetching email recipients not working with some auth backends (2024-04-04 12:41)
- Version upped (2023-12-20 23:51)
- Merge pull request #14 from andreabz/italian_translation (2023-12-20 15:10)
- italian translation refined in lang.php (2023-09-12 09:25)