]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/contrib/flattr.mdwn
flattr: New plugin.
[ikiwiki.git] / doc / plugins / contrib / flattr.mdwn
index d40465971b44cd4cf8e648291605481b10d38689..e9b4bf85728e2d7d771f4ac37094e45d667b5b82 100644 (file)
@@ -6,9 +6,12 @@ This plugin makes it easier to put flattr buttons in ikiwiki. It supports both t
 
 The dynamic button does not require creation of the page on flattr before being added to a page, the static one does.
 
-I wrote some notes on [jonatan.walck.se](http://jonatan.walck.se/software/ikiwiki/plugins/flattr/) and put the source here: [flattr.pm](http://jonatan.walck.se/software/ikiwiki/flattr.pm)
+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)
 
-This plugin is licensed under CC0.
+This plugin is licensed under [CC0](http://creativecommons.org/publicdomain/zero/1.0/) (public domain).
+
+Note that there is now a [[plugins/flattr]] plugin bundled with ikiwiki. It
+is less configurable, not supporting static buttons, but simpler to use.
 
 # Usage #
 
@@ -22,7 +25,7 @@ This plugin is licensed under CC0.
     # url - URL to flattr page,
     # e.g. http://flattr.com/thing/1994/jaywalks-weblog
     # Optional: 
-    # btn - Set to compact for compact button.
+    # style - Set to compact for compact button.
 
     # vars in dynamic mode:
     # ---------------------
@@ -30,16 +33,16 @@ This plugin is licensed under CC0.
     # None.
     # Optional:
     # uid - Set the default in the plugin, override if needed.
-    # tle - The title defaults to $wikiname/some/path (like on the top of
+    # title - The title defaults to $wikiname/some/path (like on the top of
     #   the wiki).
-    # dsc - A description of the content. Defaults to " ".
+    # desc - A description of the content. Defaults to " ".
     # cat - Category, this can be text, images, video, audio, software or
     #   rest. Defaults to text.
-    # lng - Language, list of available choises is on
+    # lang - Language, list of available choises is on
     #   https://flattr.com/support/integrate/languages. Defaults to en_GB.
     # tag - A list of comma separated tags. Empty per default.
     # url - URL to thing to flattred,
     #   e.g. http://jonatan.walck.se/weblog
-    # btn - Set it to compact to get the small button, big for any other
+    # style - Set it to compact to get the small button, big for any other
     #   value including empty.