Documentation

The Publisher add on adds the ability to have a development area in your OpenForum server where you can work on pages and services before they are published.

On publishing a page from the development area, all references to Development are removed, and the pages contents are copied to the production area of your web site and the page rebuilt.


Excluding a Page

Add a file do-not-release.txt to stop a page being published.


Per Page Translation

During the publish process, a translation script can be supplied as a file called development-translation.sjs. This script will be passed each files data to apply the translation to.


/OpenForum/AddOn/Publisher Sevice API Version 1.1.1


Get Actions

Action publish

Parameters

NameDescription
pageName (required=true){{parameter.description}}
practice (required=true){{parameter.description}}
debug (required=false){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Publisher?action=publish

Example Response

Example Error Response

Action getNeedsPublishing

Parameters

NameDescription
pageName (required=false){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Publisher?action=getNeedsPublishing

Example Response

Example Error Response

Action getPublishedPageDifferences

Parameters

NameDescription
pageName (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Publisher?action=getPublishedPageDifferences

Example Response

Example Error Response

Action reversePublish

Parameters

NameDescription
pageName (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Publisher?action=reversePublish

Example Response

Example Error Response


Post Actions