The flattr plugin provides a syntax for adding a flattr button to arbitrary wiki pages, like the one you see on the right.

The Git repository of the plugin can be found at Github.

Last updated: 2011/05/31

• 2011/05/31:
  • Removed restriction to numbers for user id since flattr now demands usage of flattr login name (see also Issue #10). Many thanks to Stéphane Gully for the patch.
• 2010/08/22:
  • Adapted to use new Flattr JS API (Issue #7)
  • Use SSL version of API if accessed via secure connection (Issue #6)
  • Allow usage from within templates (Issue #2, many thanks to Adrian Lang and Andreas Gohr for their contribution)
• 2010/06/29:
  • Added ability to create static (HTML only) buttons (Implements Issue #4)
• 2010/06/16:
  • Introduced helper plugin (as preparation for Issue #2)
  • Fixed Issue #1, Issue #3
• 2010/05/17:
  • Initial release

Let the manager do the dirty work, just give him this link to eat: plugin-flattr.tar.gz

1. Download the plugin: plugin-flattr.tar.gz
2. Extract it into your dokuwiki plugin folder (eg lib/plugins)

The flattr plugin has three configurable options:

The general command syntax for both is the following:

<flattr>
[parameter1]=[value1]
[parameter2]=[value2]
...
</flattr>

with a shorthand <flattr /> provided that creates a dynamic button using page title, page abstract and configured uid, category and language with a minimum of user input required.

The supported parameters are the following:

The flattr plugin allows creation of two types of buttons: dynamic (Javascript based) and static (HTML only) ones. While the dynamic buttons make use of the flattr JavaScript API and by this can take care of registering your “thing” with flattr themselves, the static button needs a little extra work.

First, login onto flattr and add your thing using the "Submit your thing" form. After you have done this, take a look at your newly created thing's url. It will look something like this:

https://flattr.com/thing/<thing's id>/<thing's title>

The ”thing's id” part is what you will need to insert for the thing parameter in your static button. The markup for a static button for the thing created for the flattr plugin (URL: https://flattr.com/thing/2735/DokuWiki-Flattr-Plugin) would thus look something like this²⁾:

<flattr>
button=static
thing=2735
</flattr>

You can see an example button right on this page ³⁾. The code used to create this one was the following:

<flattr>
title=DokuWiki Flattr Plugin
description=The DokuWiki Flattr Plugin provides a syntax [...] 
category=software
align=right
</flattr>

with the uid and language configured in the settings being used.

Thanks to the contribution of Adrian Lang and Andreas Gohr, you can use the new helper plugin function tpl_flattrbtn($params = array(), $ret = false). Using the $params parameter you can define button parameters, missing ones will be automatically inserted (as far as possible, make sure to set the default values for uid, language and category in your configuration in order for this to work properly). Setting $ret to true will return the button embed code instead of directly printing it.

Here is a short example for embedding a compact button in your template:

$flattr =& plugin_load('helper', 'flattr');
$flattr->tpl_flattrbtn(array('button' => 'compact'));