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


  Quick Facts
Status Beta
Price $49 - Unlimited use by one Confluence license holder on their own licensed installations.
Free - Up to 50 pictures may be published at a time. Output pages will include links to this page.

Description

The Confluence Pictures To Pages Utility allows easy creation of pages for pictures, and uploads of pictures as attachments to those pages. Conflunce Pictures To Pages Utility requires the user to prepare a directory containing the pictures to upload. Page names are controlled by renaming the pictures with meaningful filenames. The filename of each picture is then used to generate the page name for it's page.

All pictures are created as children of a parent page. Words from the page titles, that are not stop words, are also added as labels for each page.

A user defineable template controls the actual content generated for each page.

Multiple upload operations can be defined for one run of the program to process.

Suggested Uses

  • Uploading a series of screen shots to develop a tutorial.
  • Upload a collection of Internet Bumper Stickers
  • Upload pictures for a school field trip
  • Upload a numbered set of pictures showing a process.

Operation

The first step is to develop XML to describe the desired program operation. The upper half of the application has a series of fields that can be filled out to control the program operation. After XML is generated, cut and paste can be used to save the XML for future runs.

Development of XML specification for operation

There are two kinds of XML blocks:

  • default - defines certain default settings. Only the first of these in the definition will be processed.
  • upload - specifies at a minimum a directory, space key, and parent page for an upload operation.
XML Block - default

This sets up defaults for various configuration items: The wiki base url, the username/password for the Remote API access to the wiki, and a default template to use for page generation. These items can be overridden by specifying them explicitly in an upload block. The default block is not required.

Example of default block
<default>
  <wikibase>http://www.aconfluencewiki.com</wikibase>
  <username>myname</username>
  <password>mypassword</password>
  <template>{excerpt}!%SPACE%:%PAGETITLE%^%ATTACHMENT%!{excerpt}
Other related:
{children:page=%PARENT%}
Next [%LASTPAGE%]...
{amazonsearch:~randomfromtitle}
_This page produced by %CONFLUENCEPICTURESTOPAGESUTILITYHTML% v%VERSION%_
</template>
</default>
XML Block - upload

Templates

Template Substitutions
String Description
%CONFLUENCEPICTURESTOPAGESUTILITYHTML% An HTML link to this page.
%VERSION% The version number of the Confluence Pictures To Pages Utility used to publish the site.
%TITLE% This is the page title.
%DATE% Date the Confluence Pictures To Pages Utility was run to create the output wiki pages.
%TIME% Time the Confluence Pictures To Pages Utility was run to create the output wiki pages.
Default Template

The default template uses the Amazon Web Services Plugin to provide variable content for each generated picture page.

Default Template
  <template>{excerpt}!%SPACE%:%PAGETITLE%^%ATTACHMENT%!{excerpt}
Other related:
{children:page=%PARENT%}
Next [%LASTPAGE%]...
{amazonsearch:~randomfromtitle}
_This page produced by %CONFLUENCEPICTURESTOPAGESUTILITYHTML% v%VERSION%_
  </template>

Picture File Naming

Mention illegal filename characters in confluence wiki page titles

Starting the Upload

Examples of wiki sites that use the Confluence Pictures To Pages Utility

Version history

Future Feature Planning

  • Sort the pictures and upload them in order
  • Make deletion of previous child pages optional
  • Make adding labels optional
  • Make configurable stop words list
  • Check filenames for illegal characters

    Bugs

  • None known...
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