ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / contrib / flattr.mdwn
1 [[!template id=plugin name=flattr author="[[jaywalk]]"]]
2
3 [flattr.com](http://flattr.com/) is a flatrate micropayment service, which revolves around the idea of having flattr buttons everywhere that people visiting your site can use to "flattr" you.
4
5 This plugin makes it easier to put flattr buttons in ikiwiki. It supports both the static kind as well as the counting dynamic javascript version. The dynamic version does not work if [[htmlscrubber|/plugins/htmlscrubber]] is active on the page.
6
7 The dynamic button does not require creation of the page on flattr before being added to a page, the static one does.
8
9 I wrote some notes on [jonatan.walck.se](http://jonatan.walck.se/software/ikiwiki/plugin/flattr/) and put the source here: [flattr.pm](http://jonatan.walck.se/software/ikiwiki/flattr.pm)
10
11 This plugin is licensed under [CC0](http://creativecommons.org/publicdomain/zero/1.0/) (public domain).
12
13 Note that there is now a [[plugins/flattr]] plugin bundled with ikiwiki. It
14 is less configurable, not supporting static buttons, but simpler to use.
15
16 # Usage #
17
18     # [[!flattr args]] where args are in the form of arg=value.
19     # Possible args:
20     # type - static or dynamic. Defaults to static.
21
22     # vars in static mode:
23     # --------------------
24     # Required:
25     # url - URL to flattr page,
26     # e.g. http://flattr.com/thing/1994/jaywalks-weblog
27     # Optional: 
28     # style - Set to compact for compact button.
29
30     # vars in dynamic mode:
31     # ---------------------
32     # Required:
33     # None.
34     # Optional:
35     # uid - Set the default in the plugin, override if needed.
36     # title - The title defaults to $wikiname/some/path (like on the top of
37     #   the wiki).
38     # desc - A description of the content. Defaults to " ".
39     # cat - Category, this can be text, images, video, audio, software or
40     #   rest. Defaults to text.
41     # lang - Language, list of available choises is on
42     #   https://flattr.com/support/integrate/languages. Defaults to en_GB.
43     # tag - A list of comma separated tags. Empty per default.
44     # url - URL to thing to flattred,
45     #   e.g. http://jonatan.walck.se/weblog
46     # style - Set it to compact to get the small button, big for any other
47     #   value including empty.
48