Conflickr

Name Conflickr Plugin
Vendor Midori.hu (Website)
Authors Aron Gombas
Homepage http://confluence.atlassian.com/display/CONFEXT/Conflickr
Issue Management http://developer.atlassian.com/jira/browse/FLKR
Continuous Integration n/a
Categories Content Macros
Most Recent Version 0.4
Availability Confluence v2.1 to v2.10
State Beta
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Conflickr
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/conflickr-plugin/tags/conflickr-0.4/
Download JAR conflickr-0.4.jar

Description/Features

Flickr is groovy, just like wikis (not to mention Confluence). So why not leverage both?This Confluence macro plugin helps you to integrate Flickr photos to your wiki pages.
Add images and move your cursor over the photos to get more detailed info about their tags, dates and such.
You can use these macros also to create PDFs or Word documents from your photos.
Just for fun, it provides you also with a Google AdSense (http://www.google.com/adsense) macro.
Using these together with the standard built-in blog macros, you can turn your wiki to a more complete blog experience.

Note that the URL of the img tag in the resulting HTML code is of the form: http://. When using this macro in a Confluence installation that you want to access using HTTPS instead of HTTP your users may get browser warnings of the sort "This page contains both secure and nonsecure items" because you are serving "mixed content".

Installation

  1. Download the binary distribution (see above) and expand it to a temporary dir
  2. Copy conflickr.jar to CONFLUENCE_DATA/plugins
  3. Restart Confluence

(For advanced users: you can hot-deploy the plugin, of course.)

Parameters

This help is available also in the "notation guide" popup window of Confluence.

Common

This set is supported by all macros (see details below):

  • title: (optional) title text.
  • size: (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
  • showDetails: (optional) show title, tags, number of comments and such, defaults to true.

This set is supported by all, but flickr-photo macro:

  • maxPhotos: (optional) the maximum number of photos to download, defaults to 5.
  • columns: (optional) number of columns in the table, defaults to 4.
flickr-photo macro

Supports the common parameters and:

  • id: Flickr ID of the photo.
flickr-photoset macro

Supports the common parameters and:

  • id: Flickr ID of the photoset.
flickr-group macro

Supports the common parameters and:

  • id: Flickr ID of the group.
flickr-user-photos macro

Supports the common parameters and:

  • userName: Flickr user name (not ID!).
flickr-tag-photos macro

Supports the common parameters and:

  • tags: (optional) comma-separated list of tags, defaults to the page labels. If neither of those is specified, it uses some default tags.
flickr-favourites macro

Supports the common parameters and:

  • userName: Flickr user name (not ID!).
flickr-contacts-photos macro

Supports the common parameters and:

  • userName: Flickr user name (not ID!).
flickr-text macro

Supports the common parameters and has body to specify the text to render.

Examples

Displays the photo #12345:

{flickr-photo:id=12345\|size=large}

Displays 8 photos as thumbnail from photoset #67890:

{flickr-photoset:id=67890\|maxPhotos=8}

Displays 7 photos with the tags "Hungary" or "Japan":

{flickr-tag-photos:tags=Hungary,Japan|maxPhotos=7}

Displays the 20 favourite photos of user "milesdavis":

{flickr-user-favourites:title=Miles' favs\|userName=milesdavis\|maxPhotos=20\|size=thumbnail\|columns=6}

Displays the text "wiki" composed of images (see the first screenshot):

{flickr-text:showDetails=false}wiki{flickr-text}

Implementation notes

Currently, these macros access Flickr by using the flickrj library, a thin wrapper around the REST API
of Flickr. Unfortunately, the current version of the library does not support the latest API provided by Flicker.
(As an example, sorting by "interestingness" is not possible.)
However, this blocks the implementation of some more advanced features, it may change any time soon.

For the sake of simplicity, Conflickr is packaged to a single jar bundled together with 'flickrj', its only dependency not contained by a plain vanilla Confluence deployment.

Caching

These macros use a very simple caching approach: unless you change the macro parameters, image information is not reloaded from Flickr for 5 minutes.
Please note that also the (physical) image itself might be cached by your browser, but it has nothing to do with these macros.

Version History

Ver. Date Notes
0.3 2006 Mar 17 Initial Release
0.4 2006 May 18 Ported to java 1.4 by MCB and JN

Screenshots

Labels

macro macro Delete
plugin plugin Delete
contest contest Delete
flickr flickr Delete
midori midori Delete
codegeist codegeist Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jun 12, 2006

    Mircea Botez says:

    Hi, I'm currently using this behind a proxy server, which is an user-authenticat...

    Hi, I'm currently using this behind a proxy server, which is an user-authenticated one.
    (I'm getting a connection timed out error, and my guess is on the proxy server).
    Any idea how this can be worked around / fixed?

  2. Aug 14, 2006

    ES says:

    Has anyone else gotten the userName field to work? I always just get flickr-us...

    Has anyone else gotten the userName field to work? I always just get

    flickr-user-photos: com.aetrion.flickr.FlickrException: 1: User not found

    as an error message.

    1. Aug 17, 2006

      Aron Gombas says:

      Are you sure you're using the Flickr username and not user ID? Can you give me ...

      Are you sure you're using the Flickr username and not user ID?

      Can you give me what username you're trying? 

      1. Nov 02, 2006

        ES says:

        I finally got it figured out.

        I finally got it figured out.

        1. Nov 03, 2006

          Aron Gombas says:

          Cool.

          Cool.

  3. Nov 10, 2006

    Ricardo Sueiras says:

    When using the {flickr-photo} macro the URL's we are getting the pictures back, ...

    When using the {flickr-photo} macro the URL's we are getting the pictures back, but the URL's generated on the picture when you hover them is wrong. What you get is

    hostname/confluence/display/ukxlosphoto/${photo.url}

    Any ideas?

    1. Nov 13, 2006

      Aron Gombas says:

      This is caused by Flickr API changes that has been made since the release of the...

      This is caused by Flickr API changes that has been made since the release of the plugin. With the next release (1.0-rc1), we will update our code to use the uptodate version of the Flickr API.

  4. Jan 23, 2007

    matthew venn says:

    I would love to be able to get tagged photos from my photostream. So I'd like to...

    I would love to be able to get tagged photos from my photostream. So I'd like to have the username argument an optional argument to flickr-tag-photos

    likely?

    1. Jan 23, 2007

      Aron Gombas says:

      Could you add a feature request to our JIRA? (Then it'd be available in the nex...

      Could you add a feature request to our JIRA?

      (Then it'd be available in the next release.)

  5. Jan 24, 2007

    matthew venn says:

    done!

    done!

  6. Feb 02, 2007

    Edgar Vonk says:

    Is there any alignment possible for the photo shown? Similar to the "align" attr...

    Is there any alignment possible for the photo shown? Similar to the "align" attribute of the Confluence-standard image support.

    1. Feb 02, 2007

      Ferenc Kiss says:

      Not, at least not in the current version. If you need this, please add a feature...

      Not, at least not in the current version.
      If you need this, please add a feature request to the JIRA database. Thanks.

  7. Apr 27, 2007

    Mark says:

    Using Confluence v2.4.5 When attempting to install from the plugin directory, i...

    Using Confluence v2.4.5

    When attempting to install from the plugin directory, it throws an error:
    "The plugin key expected is not what I found"

    So one must install this manually then? 

    1. May 01, 2007

      Jonathan Nolen says:

      No – that was a bug in the plugin repository that has since been corrected...

      No – that was a bug in the plugin repository that has since been corrected. Please try again.

  8. Jul 11, 2007

    Martin Sweitzer says:

    FWIW: Using Confluence v2.5.4 I still get the same error "The plugin key expec...

    FWIW: Using Confluence v2.5.4 I still get the same error "The plugin key expected is not what I found"