Dashboard > BobsGear Main Space > Home > Projects In Progress > Confluence Republisher
Confluence Republisher
Added by Garnet R. Chaney, last edited by Garnet R. Chaney on Aug 23, 2007  (view change)
Labels: 
(None)


Description

The Confluence Republisher handles republishing an HTML copy of all the pages of a Confluence wiki space to an external location, such as a directory, or an external FTP account. It runs external to Confluence, and uses the Confluence Remote API to access pages and attachments for republishing.

The content for several websites domains can be managed from within a single copy of Confluence, by setting up a separate wiki space for each domain.

When publishing the wiki pages to an external website, it can optional insert the rendered wiki pages into a simple template. The simple template is maintained within the wiki space as a specially named wiki page that is not published to the external website. If no template is supplied, then the body of each page is published with no embelishments.

Operation

List of publishing targets

A publishing target contains all the information about how to access the destination where the rendered wiki pages are to be placed. It could be a directory specification in the local file system for PUBLISH_FILE targets, or it could be FTP login information for a PUBLISH_FTP target.

A single publishing target can be used by several wiki spaces.

List of wiki spaces to republish

A list of wiki spaces is defined with information including space key of wiki space to be republished, and the name of the publishing target to use, and a subdirectory specification that is concatenated to whatever directory is specified in the publishing target. For PUBLISH_FTP targets, this allows for publishing to "Add On" domains within a single account under Cpanel, or publishing to individual directories under a main directory for PUBLISH_FILE targets.

Special Wiki Space Pages

Pages with titles that begin with _cr are not published to the external website.

Wiki Page Title  
_crtemplate Template for republishing.

Templates

Template Substitutions
String Description
%CONFLUENCEREPUBLISHERHTML% An HTML link to this page.
%VERSION% The version number of the Confluence Republisher used to publish the site.
%TITLE% This is the page title.
%SITETITLE% This is the title for the site specified in the space definition
%EDITHTML% HTML for edit link back to the wiki for that page
%BODY% HTML rendered version of the wiki page
%HEAD% The HTML to go in the head section of the webpage, including style, title, etc.
%PUBDATE% Date and time the Content Republisher was run to create the output webpage.
%INCLUDE:pagename% Includes another wiki page at this point, for example Navigation, in a template that immitates the Left Name theme.
%WIKIPEDIAARTICLELIST% A list of the wikipedia article titles mentioned in the space definition.
%DOMAIN% Domain defined in the space information.
Template Substitution Overrides

Many of the above template variables can be overridden in the body of the wiki page. For example, the index page of the site probably should have a more informative title, like this:

%TITLE=Welcome To The Home Page!%
Simple Template Example
{html}
<html><head><title>%TITLE%</title>%HEAD</head>
<body>
%INCLUDE:headermenu%
<h1>%TITLE%</h1>
%BODY%

<br>
<h6><i>%EDITHTML% Published:%PUBDATE% by %CONFLUENCEREPUBLISHER% %VERSION%</i></h6>
</body></html>
{html}

Future Feature Planning

More CMS Features

Setting Publish After / Publish Until attribute on pages

Allow a "Publish after" attribute of pages. Until the page publish date is reached, links to the article render as regular text.

Examples of Confluence Republisher Managed Sites

Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.4.3 Build:#705 Mar 21, 2007) - Bug/feature request - Contact Administrators
Complete Wiki Notation Guide