Confluence Page State Plugin

Description/Features

The page state plugin can be used to associate page versions with specific states, such as Submit, Accepted, Rejected, Set Outdated.
The pluging provides the following features:

• associate page states with pages
• page state history for single page as well as child pages
• notifications on page state changes
• integration into reporting templates

Video

Usage

The screen above shows how a typical spaces page looks like, when the page state plugin is enabled. As you can see, each page now has a status field that displays the current page status (1). You can edit (change) the page status by clicking on the EDIT button (2). You can also view the page states for all page versions and all page children by clicking on the page status tab.

Setting the Page Status

As mentioned above, when clicking on the EDIT button the change page status menu will be opened that allows you to edit (change) the page status.
To set a new page status, you can write a comment (1) and click on one of the buttons Submit, Approve, Reject or Set Outdated (2).
To remove the current page status, you can click on the red cross (3).
To close the menu without changing the current page status, you can click on the Cancel button (4).

After setting for example the page status to Approved, the status field will show the changed page status (1).

Getting Notifications on Page Status Changes

You usually get a notification via e-mail, when someone changes the page status of a page that you changed before. However, you only get the notification, if you activated the receive notifications option for the page. This option will automatically be enabled as soon as you edit the page. However, you can also manually enable the option by clicking on the notification icon (1).

With the receive notifications option enabled, you will receive a similar notification e-mail as the one shown above on each page status change of the corresponding page.

Viewing Page States

As already explained, you are not only able to set page states, but you can also see which page states where set to the different versions of a page. To see the page states of a page, you have to click on the Page Status tab. You will then see a list of page states for each page version (1). By clicking on one of the state links (2) you can filter the list and only display list entries for the selected state. By clicking on the Children link (3), you can switch to viewing the page's children instead of the page's versions.

Having clicked on the Children link, you will see the page status information for all page children (1).

Using the Page Status inside Pages and Templates

You can display the page status of a page by using the page-state-info macro. Using the macro without providing additional parameters will display the page status of the current page. Using the macro with providing a pageId will display the page state of that page. You can use the macro as follows:

Current page's page status:            {page-state-info}
Page status for page with id 12098984: {page-state-info}12098984{page-state-info} or
                                       {page-state-info:pageId=12098984}
Show color:                            {page-state-info:showColor=true}

Usage example in templates are:

{report-table}
  ...
  {report-column:title=Status|width=100px}{page-state-info:showColor=true}{report-info:content:id}{page-state-info}{report-column}
{report-table}

Configuration

In order to get the plugin running on your machine, you need to modify your page template, i.e. page.vmd (see sample file), a little bit and some lines of code that add the page state field to your pages. Just copy the example below to your page template:

<div class="smalltext">
        #editReport()
        #parse ("/labels/labels-include.vm")
    --- start of code to insert ---
        #if ($pspHelper)
            $pspHelper.renderPageStatePanel($page)
        #end
    --- end ---
</div>

Version History

1.0.5 Changed Modified By user name from Anonymous to - on page state overview page.
1.0.4 Hopefully bug fixed that led to displaying username Anonymous even if a logged in user changed the page state.
1.0.3 Basic stable version

Screenshots

Screenshots