====== structpublish Plugin ======

---- plugin ----
description: Manage publishing workflow using struct
author     : Anna Dabrowska, Andreas Gohr
email      : dokuwiki@cosmocode.de
type       : 
lastupdate : 2024-05-20
compatible : Igor, Jack Jackrum
depends    : struct
conflicts  : 
similar    : approve, publish
tags       : moderation

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-structpublish/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-structpublish/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-structpublish/

----

This plugin lets you manage the workflow of page approval and publishing. It stores its information as [[struct]] data, which integrates well into [[plugin:struct:aggregations]].

===== Installation =====

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png|A CosmoCode Plugin}}]]

:!: You need to install an up-to-date [[struct]] plugin first.

Search and install the plugin using the [[plugin:extension|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          ^
| <nowiki>handbook:**</nowiki>  | approve  | @approver, @admin, me   |
| <nowiki>handbook:**</nowiki>  | 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.

<code>
---- structpublish ----
----
</code>

You can use [[plugin:struct:filters|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 ====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-structpublish/commits/master.atom date}}