Exporting a Confluence space as a Website

Size: px

Start display at page:

Download "Exporting a Confluence space as a Website"

Brandon Bailey
5 years ago
Views:

Exporting a Confluence space as a Website This how-to explains how to export a Confluence space using the AutoExport Plugin. How it works. What it does.

1 Exporting a Confluence space as a Website This how-to explains how to export a Confluence space using the AutoExport Plugin. How it works. What it does. The AutoExport Plugin for Confluence is a plugin for Confluence 2.x that constantly keeps the content edited through the wiki interface in sync with a copy stored into a directory. It converts the content in HTML that can be directly plugged into your Apache web server. Technically, the plugin core is implemented using a listener to Confluence events. Once a page is created or updated, the listener detects this event, and triggers an "export" operation (much like the same "export" you would normally trigger manually from Confluence's menus) and save a copy of the content you just edited as HTML on the disk. The conversion from wiki content into HTML pages is done using a template (with Velocity instructions) that can easily be customized. How to set it up. Install the plugin The AutoExport plugin is already installed on the Apache Software Foundation's Confluence. Download the latest version of the AutoExport Plugin for Confluence at Installing the AutoExport Plugin: 1. Login to Confluence To set up the necessary setting you'll need Adminstrator rights on Confluence. 2. Select the Administration panel 3. Select the Plugins Configuration

4. At the top of the plugins list, use the " Browse" button to select the AutoExport Plugin you just downloaded and hit "

Configuring the plugin Select " Configure plugin" on the Plugins Configuration panel. 6.

In the " Export root directory" field indicate the place where you want confluence to export your space.

2 4. At the top of the plugins list, use the " Browse" button to select the AutoExport Plugin you just downloaded and hit " Upload" to install it. The plugin is now correctly installed. Configuring the plugin Select " Configure plugin" on the Plugins Configuration panel. 6. Here is the AutoExport Plugin Configuration panel. In the " Export root directory" field indicate the place where you want confluence to export your space. In the " Confluence user" field indicate the name of the user accessible the content. In the " Export encoding" list, select the correct encoding Click " Save Changes". The AutoExport works with templates. A template combines HTML tags and Velocity instructions to create an HTML page. Changing the template

A template can be applied to all Confluence spaces or to a specific Confluence space.

Exporting the space Once the template has been set up, each modification will automaticaly trigger the plugin to

If you make changes to a template, you may want to re-export the entire associated space to apply your changes to

3 A template can be applied to all Confluence spaces or to a specific Confluence space. To modify a template, click on the " Edit template". Edit the template and click "Save Changes". Exporting the space Once the template has been set up, each modification will automaticaly trigger the plugin to export the modified page to the specified location. If you make changes to a template, you may want to re-export the entire associated space to apply your changes to all the pages of this space. To do so, select the space you want to export in the "Rebuild exported spaces" panel and click " Export Space(s) ". About the Apache Directory Website template Here are some explanations about our template.

footer part Header ant footer parts are static html

4 The template is divided into 4 main areas: the header part the navigation part the page content part the footer part Header ant footer parts are static html part. Navigation and page content parts are dynamic parts.

5 The nagivation consists in displaying a special page we have called "Navigation" which contains our navigation links. The page content consists in rendering the currently selected page content from the wiki data. To better understand how the template is made, here is its source code : <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" " w3.org/tr/html4/loose.dtd">  #set ($images = " #set ($siteroot = " #set ($pagecontentheaderenabled = false) #if ( $page.title.equals("index") ) #set ($title = "Home") #else #set ($title = $page.title) #macro (renderpage $title) #set($globalhelper = $action.getglobalhelper()) #set($renderer = $globalhelper.getwikistylerenderer()) FIXME: Must be a more efficent way to find a page... #foreach ($child in $page.space.pages) #if ( ($child.title.equals($title)) && ( $child.contentstatus. equals("current") ) ) #set ($content = $renderer.convertwikitoxhtml($child. topagecontext(), $child.content).trim()) HACK: Remove the leading <P> and trailing </P>

6 #set ($content = $content.replaceall("^<[pp]> </[pp]>$", "") ) set ($content = $content.substring(3, $content.length())) set ($end = $content.length() - 4) set ($content = $content.substring(0, $end)) $content <html> <head>  <title>apache Directory Apache Directory Studio - $title</title> <link href=" rel="stylesheet" type="text/css"> <meta http-equiv="content-type" content="text/html;charset=utf-8"> </head> <body> <a name="top"></a> <div id="container"> <div id="header"> <div id="subprojectsnavbar"> <a href=" Directory</a> <a href=" >ApacheDS 1.0</a> <a href=" >ApacheDS 1.5</a> <a href=" >Triplesec</a> <a href=" ><strong>apache Directory Studio</strong></a> </div> </div> <div id="content"> <div id="leftcolumn"> <div id="navigation"> #renderpage("navigation") </div> <br /> <hr width="75%"/> <br /> <div align="center"> <a href=" target=" _top"> <img src=" /2007-europe-125x125.png" border="0" width="125" height="125" alt="apachecon Europe 2007">

7 </a> <a href=" html#200711" target="_top"> <img src=" /2007-usa-125x125.png" border="0" width="125" height="125" alt="apachecon US 2007"> </a> </div> </div> <div id="rightcolumn"> <div id="editpage"> <a href="$confluenceuri/pages/editpage.action? pageid=$page.id" onmouseover="document.getelementbyid ('editpageimage').src=' /edit_over.png';" onmouseout="document.getelementbyid ('editpageimage').src=' /edit_out.png';"> <img id="editpageimage" src=" apache.org/staticresources/images/edit_out.png" width="16" height="16" border="0" title="edit this page" alt="edit this page"> </a> </div> $body </div> <div id="endcontent"></div> </div> <div id="footer"> , <a href=" org">the Apache Software Foundation</a></div> </div> </body> </html>

Introduction to HTML5

Introduction to HTML5 History of HTML 1991 HTML first published 1995 1997 1999 2000 HTML 2.0 HTML 3.2 HTML 4.01 XHTML 1.0 After HTML 4.01 was released, focus shifted to XHTML and its stricter standards.