This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.

Content Publishing Plugin

Name Content Publishing Plugin
Vendor Comala Technology Solutions, Inc. (Website)
Authors
Homepage http://confluence.atlassian.com/display/CONFEXT/Content+Publishing+Plugin
Issue Management http://developer.atlassian.com/jira/browse/CCPP
Continuous Integration n/a
Categories Content Macros
Most Recent Version 1.2
Availability Confluence v2.3.3 to v2.8.2
State Stable
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs n/a
Java API Docs n/a
Download Source https://svn.atlassian.com/svn/public/contrib/confluence/contentpublishing/
Download JAR contentpublishing-1.2.jar

The Content Publishing Plugin allows draft pages to be published in public Spaces. The public Space can be kept synchronized through a workflow using the Approvals Workflow Plugin, or manually.

Confluence Administrators can define what Spaces can be publish and by what users.

Installation

Plugin Configuration

The configuration can be access through the Plugin Manager or through Administration -> Administration -> Content Publishing.

Publishers Group Only Space Administrators that are member of the Publishers Group are allowed to publish a space. Only the spaces indicated in the publishing groups list can be published
Publishable Spaces A comma-separated list of keys of the Spaces than can be published
Properties prefixes Plugins such as Metadata and Scaffold store information as Content Properties and each property has its own name. You can define here the prefixes of those properties you want to get copied

Usage

The Publish Space link is available to the Spaces listed in the Publishable Spaces setting and for those Space Administrators members of the group defined in the Publishers Group setting:

The public Space associated to the drafts space must be selected. The Space Administrator can determine:

  • whether or not page properties have to be copied. Only properties with prefixes defined in the Property prefixes setting will be copied.
  • whether or not labels are to be copied.
  • what to do with pages that exist in the public Space but not in the current Space

The space can be published by pressing the Publish button:

The first time a Space is published, all the pages and their attachments will be copied to the public space.

After a Space has been published, only those pages (or attachments) that have been changes will be updated. You can also review the changes:

{publish-page} Macro

The Space can be kept synchronized by using the {publish-page} macro within a workflow (using the Approvals Workflow Plugin):

{workflow}
    {approval:Publish|final=true|group=Publishers}
    {trigger:pageapproved|approval=Publish}
        {publish-page}
    {trigger}
{workflow}

Whenever a page is given the Publisher approval, the page will be published to the public Space defined by the Space Administrator.

Version History

Version Date State License Price
Show description 0.9 (#1) 29 Oct 2007 Beta Freeware / Open Source (BSD) Free

Release Notes
First Beta release

Show description 1.0 (#2) 29 Nov 2007 Stable Freeware / Open Source (BSD) Free

Release Notes
Stable release

Show description 1.1 (#3) 05 Jan 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

What is new?

  • Labels are now copied when publishing
  • Pages added in the Public Space can now be kept (Default). They can be also removed to keep both spaces in sync.
  • Page excerpts are copied whenever pages are added or updated

Jira Issues

Jira Issues
Type Key Summary Assignee Reporter Priority Status Resolution Created Updated Due
Improvement CCPP-5 Deletion of pages created in destination space must be optional Roberto Dominguez Roberto Dominguez Major Resolved Fixed Jan 05, 2008 Jan 05, 2008
Bug CCPP-3 Only Confluence admins can publish content through the {publish-macro} Roberto Dominguez Roberto Dominguez Major Resolved Fixed Dec 10, 2007 Jan 05, 2008
Improvement CCPP-2 page excerpts to be copied when publishing Roberto Dominguez Roberto Dominguez Major Resolved Fixed Dec 09, 2007 Jan 05, 2008
Improvement CCPP-1 Labels to be copied when publishing Roberto Dominguez Roberto Dominguez Major Resolved Fixed Dec 09, 2007 Jan 05, 2008

Show description 1.1.1 (#4) 02 Feb 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues

Jira Issues
Type Key Summary Assignee Reporter Priority Status Resolution Created Updated Due
Bug CCPP-6 Publishers require Site Administrators Permissions Roberto Dominguez Stephen Morad Blocker Resolved Fixed Jan 14, 2008 Feb 02, 2008

Show description 1.2 (#5) 09 May 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues

Jira Issues
Type Key Summary Assignee Reporter Priority Status Resolution Created Updated Due
Improvement CCPP-15 Ability to publish spaces in batches Roberto Dominguez Roberto Dominguez Major Resolved Fixed May 09, 2008 May 09, 2008
Bug CCPP-9 Changes on Blog Posts Titles not get published properly Albert Wong Roberto Dominguez Critical Resolved Fixed Mar 18, 2008 Apr 04, 2008
New Feature CCPP-7 Supporting Blog posts Albert Wong Roberto Dominguez Major Resolved Fixed Feb 17, 2008 May 09, 2008

Open Issues

Labels

comalatech comalatech Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Nov 22, 2007

    Egon Nijns says:

    What is the way to go forward if we want publishing (to a different space) to wo...

    What is the way to go forward if we want publishing (to a different space) to work together with approvals?

    Can we use publishspace=bla from the approvals workflow plugin or should we install this plugin as well and make it work together??

    I'm not eager to install yet another plugin, certainly not if will not keep working (expires 29th of November). Can we get some clarifications on these issues??

    1. Nov 22, 2007

      Roberto Dominguez says:

      You need to use the {publish-page} macro. See the example above. Rather than ty...

      You need to use the {publish-page} macro. See the example above.

      Rather than tying content publishing to the Approvals Workflow Plugin, I decided to release it as separate plugin to facilitate upgrading and to allow for separated road map.

      Because this plugin appeals to clients of the Approvals Workflow Plugin I make sure this plugin is maintained.

      A newer version of the plugin will be released prior to the expiration time.

  2. Nov 23, 2007

    Egon Nijns says:

    Thank you for the clarification, maybe it's a good idea to update the Publishing...

    Thank you for the clarification, maybe it's a good idea to update the Publishing demo page?

    Are your intentions to make this plugin commercial? We already have a license for the Approvals Workflow Plugin and had hoped to be able to use this plugin for publishing as well. This was (and still is) announced as 'coming soon' when we bought the Approvals Workflow Plugin.

    1. Dec 09, 2007

      Roberto Dominguez says:

      There is now a Publishing Workflow Tutorial that explain how both plugins are up...

      There is now a Publishing Workflow Tutorial that explain how both plugins are updated.

      This plugin is going to remain open source, but will be maintained, as it is to the best interest of my company.

  3. Dec 12, 2007

    David Dembo says:

    Hey Roberto, your favourite subject - draft-view model vs view-published model ...

    Hey Roberto, your favourite subject - draft-view model vs view-published model

    As it stands, this plug-in probably doesn't give us the functionality that we ideally need - the integration between the two just isn't seamless enough (e.g. breadcrumb/usability issues, confusion, etc). I just had an idea though - could these integration problems be addressed with a sort of 'connector' module for the Approvals plug-in? This should allow a draft-view model to be realised.

    Draft permissions for regular users would be defined in one of the existing plug-in configuration screens, not in the Space Administration console. Confluence permissions would only be directly granted for Published spaces (e.g. Draft spaces would not be visible in the space list or directly accessible by regular users).

    Connector module would seamlessly integrate Published & Draft spaces via some new UI elements:

    • No change to the 'View' tab behaviour (e.g. it will always show published version)
    • No change to the 'Edit' tab behaviour (e.g. it will generally be invisible since space permissions will be view only - although a bonus is that users could be 'excluded' from workflows by explicitly being given edit permissions)
    • New 'Draft' tab - this would basically be a window (provided by the connector) into the 'View' tab from the corresponding page in the draft space
    • An 'Edit Draft' link - just below the page tabs on the 'Draft' view itself to avoid conflicts/confusion with the regular 'Edit' tab (visible only if the user has been granted edit access via the plug-in's configuration console)

    The additional module could also be enabled/disabled via the plugin repository - neither plug-in's individual functionality would be affected with this approach, so any of your clients that don't want to change to this model will be happy too.

    What do you think? Let me know if you want me to clarify any of that... it all makes perfect sense in my head.

    1. Dec 12, 2007

      Roberto Dominguez says:

      Hey, gotta work around the technical limitations I have Thanx for the feedba...

      Hey, gotta work around the technical limitations I have

      Thanx for the feedback.

      Yeah, I had thought of something similiar too... more on the lines of page actions (those funny icons on the right) to indicate the status of a sync'd page (from draft to public or the other way around).

      You're looking at version 1.0... there's more coming

  4. Dec 21, 2007

    David Page says:

    Is there a means of copying labels when publishing a page? I have a configuratio...

    Is there a means of copying labels when publishing a page? I have a configuration using the approvals and content publishing macros where I have a staging space and a public space. When a page is published the labels associated are not preserved in the public space.

    1. Dec 22, 2007

      Roberto Dominguez says:

      That's coming in the next version, early next year.

      That's coming in the next version, early next year.

      1. Jan 03, 2008

        David Page says:

        Many thanks for the immediate feedback. Can you be any clearer on timeframes? I ...

        Many thanks for the immediate feedback. Can you be any clearer on timeframes? I had hoped to use this plugin for a portal that is expected to go live early Feb.

        1. Jan 06, 2008

          David Page says:

          I just noticed the update to version 1.1 - great! I just installed it - this is ...

          I just noticed the update to version 1.1 - great! I just installed it - this is working for me

      2. Jan 07, 2008

        Carlos Caballero says:

        Hola, Roberto, Does the 1.1 version (now available) allow Publishing to copy la...

        Hola, Roberto,

        Does the 1.1 version (now available) allow Publishing to copy labels for pages as well as metadata? If so, what is the configuration prefix to add labels to the list of properties to copy?

        If 1.1 does not do it, can I humbly but VERY ENTHUSIASTICALLY request that you add it ASAP? As you know, using the metadata macro for any non-trivial purpose requires using labels to select pages... then again, if those labels are not copied the published pages just show lots of empty tables.

        Cheers, and keep up the great job you are doing

        UPDATE: Ooops, just tried 'labels' and found that the new version asks if I want to copy the labels as well. I decided to leave the comment on so that others may find out. Cheers!

        1. Jan 07, 2008

          Roberto Dominguez says:

          No problem. I also updated the documentation. Regards, Roberto

          No problem. I also updated the documentation.

          Regards,

          Roberto

  5. Jan 14, 2008

    Stephen Morad says:

    What permissions are required for someone to be able to publish using this plugi...

    What permissions are required for someone to be able to publish using this plugin? Reading the documentation, it appears that Site Administrators configure the publishable spaces and the publishers group. Then the publishers need to be a Space Administrator and in the Publishers Group to use the plugin.

    Our testing (Confluence 2.6.0 & Content Publishing Plugin 1.1) requires the user to also be a Site Administrator to use the plugin. If the user isn't in the confluence-adminstrators group, they don't see the Publish Space option under Browse Space->Advanced, and attempting to go directly to the Publish Space URL returns a "page does not exist" error.

    Requiring Site Administration rights to publish a space is a non-starter for us.

    1. Jan 14, 2008

      Roberto Dominguez says:

      In order to publish a Space, you need to be Site administrator or: Be member ...

      In order to publish a Space, you need to be Site administrator or:

      • Be member of the publishers group, and
      • have Space Administration permissions in the Draft/Source Space, and
      • have Space Administration permissions in the Public/Destination Space

      If this doesn't work, then it is a bug, could you submit a Jira issue on http://developer.atlassian.com/jira/browse/CCPP ?

      1. Feb 02, 2008

        Roberto Dominguez says:

        CCPP-6 is fixed on 1.1.1

        CCPP-6 is fixed on 1.1.1

  6. Jan 23, 2008

    Kevin Crosby says:

    I guess this is really an enhancement request, but it would be nice to have an o...

    I guess this is really an enhancement request, but it would be nice to have an option to create a sitemap.xml file during the publishing process.

  7. Jan 31, 2008

    Kevin Crosby says:

    I can't get my Scaffold data to be published. Where can I find the prefixes to u...

    I can't get my Scaffold data to be published. Where can I find the prefixes to use so the Scaffold fields are published to the new space? Is there an example of this anywhere?

    1. Feb 17, 2008

      Roberto Dominguez says:

      Oops! sorry I missed your question. You need add the following property prefixe...

      Oops! sorry I missed your question.

      You need add the following property prefixes in the plugin's configuration: scaffold and ~metadata, and the select the Copy Properties option when publishing the space.

  8. Feb 26, 2008

    Jon Nermut says:

    Hi Roberto, Can this plugin propogate page renames and deletes? Thanks, Jon

    Hi Roberto,
    Can this plugin propogate page renames and deletes?

    Thanks,

    Jon

    1. Feb 27, 2008

      Roberto Dominguez says:

      Yep, it should be able to do that. Make sure you enable the "Delete Pages added ...

      Yep, it should be able to do that. Make sure you enable the "Delete Pages added in public space" to make sure the two spaces are kept in sync.

  9. Mar 24, 2008

    Jessica Britton says:

    This is a great plugin. Thank you! I only wish that there was a way to spec...

    This is a great plugin. Thank you!

    I only wish that there was a way to specify a global comment that would be added to the all of the page history entries that are generated when you publish a space. That would make it easy for our customers to find the appropriate version of our docs without us having to manually archive and link to them.

    Any chance of implementing something like that?