As of version 0.3.0 there have been some changes to the syntax of the Flatr Shortcode Widget so I have rewritten this guide accordingly! There are still the 3 methods that there were before for inserting the widget however for this guide, I have simplified it down to two!

Simple

The simple method (as the name suggests) is the easiest way to add a widget to your blog posts and pages! It will use all the default settings and all you have to do is insert the code!

[flattr /]

When you use this simple widget, here is how your widget will be configured:

  • The button type will be set to large
  • The User ID will be set to the author’s flattr id (if it is set and enabled in the settings), failing that it will be set to the default flattr ID set on the settings page or through the official Flattr plugin.
  • The title will be set to the Page/Post title
  • The description will be set to the Page/Post excerpt
  • The category will be set to text
  • The language will be set to English
  • Tags will not be set
  • The url will be set to the Page/Post’s permalink
  • The thing will not be hidden from listings on flattr.com

Advanced

You can also customise this code so that you can manually set the variables when calling the shortcode.

[flattr uid='{uid}' btn='{btn}' tle='{tle}' dsc='{dsc}' cat='{cat}' lng='{lng}' tag='{tag}' url='{url}' hide='{hide}' anc={anc} setanc={setanc} qty={qty} /]

All variables are optional (defaults will be used if left blank). If, for example, you wanted the default url you could exclude all “url=’{uid}’ ” and the default would be used. Leaving a variable empty will also result in the default being used but it is probably best practise to remove variables you are not going to be using.

To use edit the shortcode you should change the parameter values (indicated with curly brackets surrounding them). The parameters are:

  • btn – This is the type of button you would like to display. To get the compact button use ‘compact’ otherwise the default (large) button is displayed.
  • uid – This is your personal user id. If not defined, it The User ID will be set to the author’s flattr id (if it is set and enabled in the settings), failing that it will be set to the default flattr ID set on the settings page or through the official Flattr plugin, otherwise the widget will fail and return an error!
  • tle – This is the title of the thing you want to submit. This is typically the title of your blog entry or software name. If undefined the title of your Post/Page will be used.
  • dsc – This is the full excerpt of the content. Some blog text or information about your song you’ve written or so forth. If undefined excerpt title of your Post/Page will be used.
  • cat – This is the flattr category the content belongs to. You can choose between the following: text, images, video, audio, software, rest. If undefined text will be used.
  • lng – Language of the submitted thing. List of available languages. If undefined Enlgish (en_GB) will be used.
  • tag – This is the tags of the thing, to help people finding your content easier on the Flattr website. If you want to use multiple tags, separate using a normal comma (,) sign. If undefined no tags will be used.
  • url – This is the URL of the thing, if this is not always the same on your site. Maybe you have multiple domains with the same content. This is to lock the content to always be recognized as the same content for Flattr. If undefined the permalink of your Post/Page will be used. If you have an anchor that you want to append, it would be best practice to append it using the ‘anc’ parameter.
  • hide – Use this to hide the thing from listings on flattr.com. The value ‘true’ or ‘t’ will hide the thing. If undefined the the thing will be shown on listings on flattr.com.
  • anc – Appends an anchor to the url (saves you having to write the whole URL just to add an anchor). If a unique anchor is used on each widget it allows for multiple widget on the same URL. This must be unique otherwise 2 widgets with the same ‘url’ and ‘anc’ they will be the for the same flattr. Default is blank.
  • setanc – This value is ignored if no anchor is set, if it is set then it will add a code to the top of the widget so that the defined anchor redirects to the widget’s location. This means that when people follow the link from flattr.com, they will be taken to the location of the widget on the page. This is good if you want to have multiple flattrs for different sections and you put the flattr widget at the top of each section. Set to ‘1’ to set to true, ‘0’ to set to false. Set to false if you want to manually input the anchor code (if for example you wanted it elsewhere rather than at the point of the widget or you just wanted the backlink from flattr.com to go to your page as normal)
  • qty – Allows for you to have as many Flattr widgets as you want. Whatever number you set the value to will be the ammount of unique flattr widgets that will be created. Uses anchors to make them unique and is compatible with the ‘anc’ variable – it may cause problems if an anchor is set in the ‘url’ variable. Default is ‘1’.


Contents
    • New Features
      • Flattr Shortcode Syntax Modified
      • Flattr Shortcode Widget Settings
    • Change Log
    • Bugs
    • Features
    • Download

Sorry for the dellay in posting an accompanying blog post to the recent update of the Flattr Shortcode Widget! I must say I am very excited about this new build as it is the start of a lot of great new features that will be coming soon so watch this space!

Click here to go to the download page.

New Features

Flattr Shortcode Syntax Modified

This is not a new feature but is certainly something any existing users should be aware of! The syntax for the shortcode has changed! It is only a minor change and the widget is still backwards compatible but I do plan to eventually remove backwards compatibility all together so it would be best to update to the new syntax. The new syntax stops a lot of common bugs that was happening and makes it all a lot clearer. To find out more about the new syntax view the new syntax information.

Flattr Shortcode Widget Settings

There is now a Flattr Shortcode Settings Page which can be found under the settings tab of your WordPress administration. From this page you can edit/set the default UID for the blog. Currently this is still linked to the official flattr widgets setting however this will soon become independent! The main advantage of this new feature is that you can now set a default flattr UID to be used even if you do not have the official Flattr Widget.

On this page you also have the option to enable/disable author specific UIDs. Having this feature enabled adds a new option to the profile page for a user’s flattr ID. When users who have set their flattr ID make a post their UID will automatically be used for shortcodes they use within their posts! This makes it great for use on multi-author sites!

Change Log

0.3.0

  • NEW: Flattr UID option for induvidual users allowing each user to have their own default Flattr UID
  • NEW: Options Page to set the default Flattr UID for the blog
  • UPDATE: Flattr Shortcode modified – new uid tag added

0.2.3

  • UPDATE: More tags added

0.2.2

  • BUG FIX: Feeds would try and render the javascript button.
  • NEW: RSS displays a Flattr this image in substitute of the js widget but this links to the flattr home page due to Flattr API restictions
  • BUG FIX: Default widget size is not reset to large after creating a compact widget if the Official Flattr Widget is not installed.
  • BUG FIX: Name change was not fully migrated

0.2.1

  • BUG FIX: Anchor now set when used with multi-flattr feature
  • BUG FIX: Anchors <a> tag is now closed properly
  • UPDATE: Additional flattrs made by multi-flattr are hidden from listing on flattr.com to stop spamming
  • BUG FIX: Further whitespace removal to all variables

0.2.0

  • NEW: Anchors added so that multiple flattrs can be used on the same URL
  • NEW: Your backlink from flattr can link straight back to the widget rather than just back to the page (uses anchors)
  • NEW: You can define how many flattr widgets you want to be generated and each work independantly (allows multiple flattrs)
  • NEW: You can use multiple flattrs and anchor features simultaniously
  • UPDATE: All true/flase values must now be set to ‘1’ (true) or ‘0’ (flase)
  • BUG FIX: Hide not always set to true
  • BUG FIX: Default language now works
  • UPDATE: Arrays now used instead of lots of independant variables
  • BUG FIX: Whitespace in variables that would cause the widget to fail is now removed

0.1.4

  • BUG FIX: Decription was not filled in if not manually set and was therefore required

0.1.3

  • BUG FIX: Problems with svn sync fixed
  • BUG FIX: Version numbers corrected

0.1.2

  • UPDATE: Widget name changed from “Flattr Widget” to “Flattr Shortcode Widget”

0.1.1

  • UPDATE: Major updates to readme.txt
  • NEW: Added to WordPress Plugin Directory
  • BUG FIX: Bug that interfered default size of widget for official plugin has been corrected

Bugs

Please report bugs in the comments

Known Bugs

  • None

Features

If there are any features you would like then please request them in the comments

Features in development

  • More development on the Settings pages to allow default setting for the shortcode widget to be set
  • Separation from the official widget
  • Graphical shortcode generator

Download

Click here to go to the download page.


Earlier today I released the 0.2.0 build of the Flattr Shortcode Widget and it includes a whole bunch of new features as well as a couple of minor bug fixes!

Click here to go to the download page.

New Features

New features include Anchors and Multi-Flattr which bring extra functionality which can be timely to manually set up and are not yet offered by any other widget.

Anchors

The main purpose for the anchors feature is to allow you to enable users to flattr sections of a page individually. Previously this was difficult as working around the limit of one flattr per url is tricky. The new feature adds an additional variable, ‘anc’ that can be set to easily give each a flattr widget their unique identifier. When you have set the ‘anc’ variable, you are also then able to define the ‘setanc’ variable. If this is set to true, then an anchor will be placed before the widget that is inserted. This will mean that when the backlink from flattr is followed, they are taken straight to the widget. If you want to set the exact location of the anchor by manually adding the code or just want this disable then make sure ‘setanc’ is false.

Eample:

This feature also allows you to create (and be given) multiple flattr’s allowing (if you feel you deserve it) for people to give you more than one of their flattrs. You could manually set up lots of widgets with different anchors but whether you are setting lots of variables in each or just lots of basic widgets this will become time consuming and difficult to manage so I created the created the Multi-Flattr feature.

Multi-Flattr

This is a very simple new feature that allows you to generate more than one flattr widget that exploit the anchors feature to make each unique so that each is unique. If no ‘anc’ is set then the ‘anc’ will be set to a range of numbers (however the first widget will have no number so to avoid problems with any other widgets you may put on the page you can set the ‘anc’). If you have set the ‘anc’ then  the unique number will be appended to the end of it.

This feature allows you to generate unlimited flattr widgets, that are all unique meaning you can give users the option to flattr you as many times as you feel you deserve! To use this feature all you have to do is define how many widgets you want with

Example:

Change Log

0.2.0

  • NEW: Anchors added so that multiple flattrs can be used on the same URL
  • NEW: Your backlink from flattr can link straight back to the widget rather than just back to the page (uses anchors)
  • NEW: You can define how many flattr widgets you want to be generated and each work independantly (allows multiple flattrs)
  • NEW: You can use multiple flattrs and anchor features simultaniously
  • UPDATE: All true/flase values must now be set to ‘1’ (true) or ‘0’ (flase)
  • BUG FIX: Hide not always set to true
  • BUG FIX: Default language now works
  • UPDATE: Arrays now used instead of lots of independant variables
  • BUG FIX: Whitespace in variables that would cause the widget to fail is now removed

0.1.4

  • BUG FIX: Decription was not filled in if not manually set and was therefore required

0.1.3

  • BUG FIX: Problems with svn sync fixed
  • BUG FIX: Version numbers corrected

0.1.2

  • UPDATE: Widget name changed from “Flattr Widget” to “Flattr Shortcode Widget”

0.1.1

  • UPDATE: Major updates to readme.txt
  • NEW: Added to WordPress Plugin Directory
  • BUG FIX: Bug that interfered default size of widget for official plugin has been corrected

Bugs

Please report bugs in the comments

Known Bugs

  • Anchor’s <a> tag is not closed. (Fixed in update 0.2.1)

Features

If there are any features you would like then please request them in the comments

Features in development

  • Configuration page with custom default settings
  • Graphical shortcode generator


Just thought I would quickly sum up how to use the Flattr shortcode for a ‘thing’ that you have already added to flattr.com. It is really simple, all you need to do is set the “url” variable! Nothing else needs to be set (unless you want to customise the btn type).


Okay so one of the previous builds (0.1.1) might have been a little unstable. It was all caused after I got into the WordPress Plugin Directory. I was having difficulty getting used to how the svn system worked and it resulted in me uploading an unstable build without testing it! This latest build has been tested and double tested for all the previous bugs I had and I am now happy to say that I just updated to build 0.1.4 and that it is bug free as far as I know!

To also help reduce future problems I am going to set up a private testing blog that I can use to test plugins without giving this site downtime!

Click here to go to the download page.

Change Log

0.1.4

  • BUG FIX: Decription was not filled in if not manually set and was therefore required

0.1.3

  • BUG FIX: Problems with svn sync fixed
  • BUG FIX: Version numbers corrected

0.1.2

  • Widget name changed from “Flattr Widget” to “Flattr Shortcode Widget”

0.1.1

  • Major updates to readme.txt
  • Added to WordPress Plugin Directory
  • Bug that interfered default size of widget for official plugin has been corrected

Bugs

Please report bugs in the comments

Known Bugs

  • None

Features

If there are any features you would like then please request them in the comments

Features in development

  • Configuration page with custom default settings
  • Graphical shortcode generator
  • Add a unique ID system so that multiple Flattrs can be used for the same URL


The WordPress Flattr Widget that I posted earlier today, is now listed here in the WordPress Plugin Directory and has a new name “Flattr Shortcode Widget”. This change in name was made to stop confusion between the official Flattr Widget and this one. This newer version contains some bug fixes so it will be worth updating!

Click here to go to the download page.

Change Log

0.1.2

*Widget name changed from “Flattr Widget” to “Flattr Shortcode Widget”

0.1.1

*Major updates to readme.txt
*Added to WordPress Plugin Directory
*Bug that interfered default size of widget for official plugin has been corrected

Bugs

Please report bugs in the comments

Known Bugs

  • Automatic update does not work
  • Description is a required variable

Features

If there are any features you would like then please request them in the comments

Features in development

  • Configuration page with custom default settings
  • Graphical shortcode generator
  • Add a unique ID system so that multiple Flattrs can be used for the same URL


Here it is, my first ever plug-in for WordPress. Please note that this is a very early release beta and there may be bug and there will be improvements to be made.

Click here to Download Version 0.1

Description

This is a widget that allows you to quickly and easily create a flttr widget within posts and pages using a simple shortcode. The advantage of having a shortcode is that it can be customised for every use. The short code has lots of customisability and can be used in a very basic way or with more advanced features.

The way the widget works is that within a post or page you include the shortcode and then that shortcode will generate all the javascript needed to embed the widget. That means you don’t need any knowledge of coding or js. As opposed to the official Flattr Widget, you do not need to embed a php function to get the widget or have it included in every post. You can call the shortcode from within a post or page and the most important thing is that you have the option to customise the widget every time! This does not mean that the official Flattr Widget does not have its place, and I actually recommend using both in conjunction!

This means that you can insert widgets that will Flattr pages other than the one you are on (for example some external content) and it will also allow you to set the Flattr User ID per widget meaning you can have multiple widgets for multiple people, or allow blogs that have multiple authors to add a Flattr widget that will flattr them (rather than the site) for their content.

How to Use

There are a few ways that the Widget can be used going up in complexity.

Super Simple (Requires official Flattr Plugin)

Super Simple Shortcode

Super Simple Shortcode

There are various ways that the Flattr Widget can be used. The most simple is to just include the code in the image on the right anywhere in a post. Using this will require that you have the official Flattr Widget installed and have set your Flattr UID on that (an independent setting will come in a later version).

Settings will be automatically set as stated:

  • The button type will be set to large
  • The User ID (as mentioned above) will be set to that which is set up in the official plugin
  • The title will be set to the Page/Post title
  • The description will be set to the Page/Post excerpt
  • The category will be set to text
  • The language will be set to English
  • Tags will not be set
  • The url will be set to the Page/Post’s permalink
  • The thing will not be hidden from listings on flattr.com

In a future build, some of these default settings will be customisable.

Simple

Simple Shortcode

Simple Shortcode

Simple is the most simple way of using my Flattr Widget if you do not have/want to install the official Flattr Plugin. It is also what you would use if you have multiple bloggers blogging on the same blog and each want to earn their own Flattry. To use this option, use the code shown in the image on the left replacing {uid} with your Flattr User ID. The only difference between this simple option and the super simple option is that you are defining your Flattr User ID independently.

Settings will be automatically set as stated:

  • The button type will be set to large
  • The User ID will be set to whatever you have defined as {UID} in the shortcode
  • The title will be set to the Page/Post title
  • The description will be set to the Page/Post excerpt
  • The category will be set to text
  • The language will be set to English
  • Tags will not be set
  • The url will be set to the Page/Post’s permalink
  • The thing will not be hidden from listings on flattr.com

In a future build, some of these default settings will be customisable.

Advanced… but still pretty simple!

Finally, there is the advanced option. You can use the advanced shortscode shown bellow. All variables are optional (defaults will be used if left blank). If, for example, you wanted the default url you could exclude all ” url='{uid}’ ” and the default would be used. Leaving a variable empty will also result in the default being used but it is probably best practise to remove variables you are not going to be using. Note that if you do not set {uid} you do not need the final “[/flattr]“

Advanced Shortcode

Advanced Shortcode

To use edit the shortcode you should change the parameter values (indicated with curly brackets surrounding them). The parameters are:

  • btn – This is the type of button you would like to display. To get the compact button use ‘compact’ otherwise the default (large) button is displayed.
  • uid – This is your personal user id. If not defined, it will be set to that which is set up in the official plugin providing that is set up and installed, otherwise the widget will fail!
  • tle – This is the title of the thing you want to submit. This is typically the title of your blog entry or software name. If undefined the title of your Post/Page will be used.
  • dsc – This is the full excerpt of the content. Some blog text or information about your song you’ve written or so forth. If undefined excerpt title of your Post/Page will be used.
  • cat – This is the flattr category the content belongs to. You can choose between the following: text, images, video, audio, software, rest. If undefined text will be used.
  • lng – Language of the submitted thing. List of available languages. If undefined Enlgish (en_gb) will be used.
  • tag – This is the tags of the thing, to help people finding your content easier on the Flattr website. If you want to use multiple tags, separate using a normal comma (,) sign. If undefined no tags will be used.
  • url – This is the URL of the thing, if this is not always the same on your site. Maybe you have multiple domains with the same content. This is to lock the content to always be recognized as the same content for Flattr. If undefined the permalink of your Post/Page will be used.
  • hide – Use this to hide the thing from listings on flattr.com. The value ‘true’ or ‘t’ will hide the thing. If undefined the the thing will be shown on listings on flattr.com.

Download

Click here to Download Version 0.1

Flattr Me

If you use my plugin, you can show your appreciation by flattring me:

Bugs

Please report bugs in the comments

Known Bugs

  • Can affect the size of some of the widgets created using the official plugin (change some from large to compact)

Features

If there are any features you would like then please request them in the comments

Features in development

  • Configuration page with custom default settings
  • Graphical shortcode generator


That’s right, I have made my first WordPress plugin and I must say, it wasn’t too hard at all! Sure, what I have made is very basic but making plugins seems simple enough so you might want to expect a few more! I will be posting a blog with the link to download the new plugin that is designed to make on-the-fly integration between your WordPress pages and posts even easier. UPDATE: Plugin now posted!

Currently the plugin will be hosted here, on my servers but I am currently trying to get it onto the WordPress Plugin Directory. Since this is my first plugin I am not 100% sure about what is happening with that but from what I can tell, I am just waiting for my plugin to be approved as it is listed as a request and the svn directory has not been created for me.


Just like when Google Wave came out and I offered wave invites in return for cracking a simple puzzle, I am doing the same thing again but this time for the new service Flattr!

I have 3 invites up for grabs and all you gotta do is decode this:

Encrypted Flattr puzzle!

Can you crack it?

Not only will you win a Flattr invite but you will also receive a complimentary Flattr from me as a thanks for cracking the code! Good Luck! Winner’s names and a flattr widget for each will be posted here.

Winners

  • Daniel Miessler
  • Dennis
  • Brandon Odegard


I have now integrated Flattr and the Facebook Like Button into my blog. This will allow easier sharing of the things you read on my blog as well help towards the running of my blog! The new Like button appears the top and bottom of each blog post. If you have a flattr account and want to flattr me then you can flattr my blog by using the widget in the sidebar, or flattr my posts by using the button at the bottom of each.

Dont know what Flattr is? I will be posting another blog with info about Flattr as well as giving away 3 invites to Flattr! Watch this space and subscribe to my blog for updates when I post my blogs about it!

If you would be interested in getting flattr for comments where you can earn by commenting, then please leave a comment outlining your interest bellow and it will be considered!