Confluence Blogging RPC Plugin

Name Blogging RPC Plugin
Vendor Atlassian Software Systems (Website)
Authors Shannon Krebs
Homepage http://confluence.atlassian.com/display/CONFEXT/Confluence+Blogging+RPC+Plugin
Issue Management http://developer.atlassian.com/jira/browse/BLOG
Continuous Integration n/a
Categories Remote Access
Most Recent Version 1.2.4
Availability Confluence v2.2.9 to v2.10
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Confluence+Blogging+RPC+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/bloggingrpc-plugin/tags/bloggingrpc-1.2.4/
Download JAR bloggingrpc-1.2.4.jar
Blogging RPC Plugin

The Blogging RPC Plugin implements the Blogger 1.0 API and the MetaWeblog API for Confluence to let you post Confluence news pages from any client that implements these APIs

Compatibility With Confluence

Plugin Versions 2.4 2.5 2.6 2.7 2.8 2.9 2.10
1.2.4    
1.2.3    
1.2.2    

Installation

This plugin can be installed via the plugin repository, uploaded via the normal web interface or installed in the confluence WEB-INF/lib directory.

All of the released plugin versions before 1.2.3 are available to download from svn: http://svn.atlassian.com/svn/public/contrib/confluence/bloggingrpc-plugin/jars/. For version 1.2.3 and above, they can be downloaded from https://maven.atlassian.com/contrib/com/atlassian/confluence/plugins/xmlrpc/bloggingrpc/bloggingrpc/.

Version 1.2.1 of this plugin is currently bundled with Confluence

Configuration

  • Once you have installed the plugin point your blog client at the confluence rpc url:
    http://yourhost:port/rpc/xmlrpc
    
  • Select either the Blogger API or the MetaWeblog option as the blogging tool. (You may need to select a custom configuration for clients that already have the address for popular sites such as Blogger configured.)
  • Once you have setup your client and authenticated you should see every space you have permission to edit news items on as a list of blogs for the confluence site

Instructions for various blog clients follow:

Usage

Once you have your blog client configured, you can edit your blog posts as though you were using the wiki-markup mode on the website. If you write your post in standard wiki-markup, it will all be translated normally when posted, including macros. Note, however, that your blog client will not be able to interpret the markup and will present it as plain text.

Also, be careful that your client does not any html tags to your content before you save it. There is currently no conversion of html so be sure to configure your client to send only plain text (wiki markup).

Blog Post Titles
You cannot repeat the same blog post title on the same day in Confluence.
The following sections detail how the specific API methods relate to confluence functionality:

MetaWeblog Method Functionality

Method Description
newPost Creates a new blog page in Confluence. Any categories set on the blog post will be converted to confluence labels.
editPost Edits a post. The categories specified on the updated blog post will replace any labels that currently exist on the page in Confluence.
getPost Returns a blog post specified by a given Id. The labels attached to the page in Confluence are returned as MetaWeblog categories.
getRecentPosts Returns a list of recent blog posts for the specified space
getCategories Returns all of the labels from the specified space as well as the 20 most popular global labels (if not already included) as metaweblog categories.
newMediaObject This method is not currently implemented. You will need to use the confluence web interface to add attachments to blog pages.

Blogger Method Functionality

Method Description
getUserBlogs Returns a list of spaces in which the specified user can create or edit blog pages.
newPost Creates a new blog page in Confluence.
editPost Edits a post.
getRecentPosts Returns a list of recent posts for a specified space. The client can specify how many posts are returned.
deletePost Puts the specified post in the trash. A space administrator needs to purge the trash to remove the post permanantly
getPost Returns a struct containing information about a single news page
getUserInfo Returns a struct containing information about the authenticated user.
getTemplate This method is not supported. You need to use the normal confluence admin screens to view/change templates.
setTemplate This method is not supported. You need to use the normal confluence admin screens to view/change templates.
For all methods the publish flag must be set to true. You can not save a draft of your changes for publication later.
For the Blogger API the title tag must be specified in the content like <title>My Title<title>. Some blog clients do this automatically, but others (like MarsEdit) require you to put this in the body of the post. Don't worry, it will appear correctly in confluence after you post.

Open Issues

Plugin Versions

Version Date State License Price
Show description 1.2.4 (#105) 12 Nov 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

release notes

Contributors

  • Shannon Krebs — Developer

Show description 1.2.3 (#104) 09 Jul 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

release notes

Contributors

  • Shannon Krebs — Developer

Show description 1.2.2 (#103) 09 Aug 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Bug fix release. This release fixes the following issues:

  • [BLOG-10] - link url for blog is wrong
  • [BLOG-11] - order blogs alphabetically

Contributors

  • Shannon Krebs — Developer

Show description 1.2.1 (#102) 06 Mar 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Bug fix release. Fixes BLOG-7 which prevented new posts from being created if the client didn't supply a created date.

Contributors

  • Shannon Krebs — Developer

Show description 1.2 (#101) 11 Feb 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This release removes the restrictions on changing the title and publish date of a blog post.

Contributors

  • Shannon Krebs — Developer

Show description 1.2_dr1 (#100) 26 Jan 2007 Beta Freeware / Open Source (BSD) Free

Release Notes

Developer Release for testing new functionality. This release removes the restrictions on changing the title and publish date of a blog post.

Contributors

  • Shannon Krebs — Developer

Show description 1.1.1 (#4) 17 Jan 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This release fixes a bug with the 1.1 release that allows users to view other users private labels on a blog post. This is a highly recommended upgrade for all users

Contributors

  • Shannon Krebs — Developer

Show description 1.1 (#3) 13 Dec 2006 Stable Freeware / Open Source (BSD) Free

Release Notes

The major changes in the 1.1 release are:

  • MetaWeblog API implementation
  • Ability to install plugin via web interface

Contributors

  • Shannon Krebs — Developer

Show description 1.0 (#1) 27 Nov 2006 Stable Freeware / Open Source (BSD) Free

Release Notes

This is the initial version of the Blogging RPC Plugin containing an implementation of the Blogger 1.0 API. This version of the plugin cannot be installed via the web interface or the plugin repository. Please visit the documentation page for instructions on manual download and installation in the confluence WEB_INF/lib directory.

Contributors

  • Shannon Krebs — Developer

Labels

blogger blogger Delete
rpc rpc Delete
confluence22 confluence22 Delete
plugin plugin Delete
atlassian-supported atlassian-supported Delete
confluence23 confluence23 Delete
metaweblog metaweblog Delete
bloggingrpc bloggingrpc Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Nov 05, 2006

    Miles Metcalfe says:

    Woah! Very cool! I would like to be able to post to ordinary pages as well as n...

    Woah! Very cool!

    I would like to be able to post to ordinary pages as well as news pages via a blogging API - though I appreciate that thinking this through is a bit tricky - how do you represent the hierarchy of pages in a space in a blog-like manner? I thought the best way might be to use something similar to Blojsom meta-data so you could add things like "meta-confluence-parent=home", "meta-confluence-tags=cool, blogging, amazing". Or should these be represented as wiki markup for consistency's sake?

    The reason I'm keen to see all of Confluence exposed through a blogging API is that it's quite attractive to leverage the organisational and offline composition features of a desktop blogging client. At present, I write wiki pages in BBEdit, then paste them in to the web form on Confluence.

    1. Nov 05, 2006

      Mike Cannon-Brookes says:

      Miles - the first step here is just to get it working for the blogs within Confl...

      Miles - the first step here is just to get it working for the blogs within Confluence, then we can look at pages once that's done. There are quite a few challenges (like tags for example) already without bringing pages into the equation