ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / ikiwiki / directive / flattr.mdwn
1 The `flattr` directive is supplied by the [[!iki plugins/flattr desc=flattr]] plugin.
2
3 This directive allows easily inserting Flattr buttons onto wiki pages.
4
5 Flattr supports both static buttons and javascript buttons. This directive
6 only creates dynamic javascript buttons. If you want to insert a static
7 Flattr button, you can simply copy the html code for it from Flattr, instead.
8 Note that this directive inserts javascript code into the page, that
9 loads more javascript code from Flattr.com. So only use it if you feel
10 comfortable with that.
11
12 The directive can be used to display a button for a thing you have already
13 manually submitted to Flattr. In this mode, the only parameter you need to
14 include is the exact url to the thing that was submitted to Flattr.
15 (If the button is for the current page, you can leave that out.) For
16 example, this is the Flattr button for ikiwiki. Feel free to add it to all
17 your pages. ;)
18
19         \[[!flattr url="http://ikiwiki.info/" button=compact]]
20
21 The directive can also be used to create a button that automatically
22 submits a page to Flattr when a user clicks on it. In this mode you
23 need to include parameters to specify your uid, and a title, category, tags,
24 and description for the page. For example, this is a Flattr button for
25 a blog post:
26         
27         \[[!flattr uid=25634 title="my new blog post" category=text
28         tags="blog,example" description="This is a post on my blog."]]
29
30 Here are all possible parameters you can pass to the Flattr directive.
31
32 * `button` - Set to "compact" for a small button.
33 * `url` - The url to the thing to be Flattr'd. If omitted, defaults
34   to the url of the current page.
35 * `uid` - Your numeric Flattr userid. Not needed if the flattr plugin
36   has been configured with a global `flattr_userid`.
37 * `title` - A short title for the thing, to show on its Flattr page.
38 * `description` - A description of the thing, to show on its Flattr
39   page.
40 * `category` - One of: text, images, video, audio, software, rest.
41 * `tags` - A list of tags separated by a comma.
42 * `language` - A language code.
43 * `hidden` - Set to 1 to hide the button from listings on Flattr.com.
44
45 [[!meta robots="noindex, follow"]]