README.txt

   1 === Flattr module ===
   2
   3 The flattr module is not tested enough production environment, but is known to
   4 work.
   5
   6 === How to use ===
   7 The module supplies a new field called Flattr. This field can be attached to
   8 any of your content, although only node entities are currently known to work.
   9 Please report to the issue queue if you test on other entities.
  10
  11 When creating a new instance of your entity type, there will be a checkbox
  12 to determine whether or not to render the button, and a dropdown to select
  13 which Flattr category the content belongs to.
  14
  15 In order to control for example what tags and description are used for the
  16 button, you create a separate field, and tell the Flattr module to use it.
  17 These settings for field are found under the display settings for your
  18 content type, which is /admin/structure/types/manage/[content-type]/display
  19 The list of fields for Flattr username is currently restricted to fields on
  20 the user entity, while other fields are restricted to the current entity.
  21 Both of these restrictions are likely to be lifted together with the fix for
  22 the ctools issue under == Known problems ==.
  23
  24 Please note that after you've updated the display settings, it's necessary
  25 to also press the save button at the bottom of the page.
  26
  27 Some values are required, and some are optional, see Flattrs documentation
  28 here: http://flattr.com/support/integrate/js
  29
  30
  31 === Reporting issues ===
  32 Whenever you report a bug or submit a support request, always provide the code
  33 sent to Flattr in the issue. This should look like
  34 <a href="node/1/" rel="Flattr;">This is node 1</a>
  35 and there's two ways to find this information.
  36 1) Use Devel.
  37 View your content, go to the devel tab, select render, and find
  38 ['name_of_flattr_field'][0]['#markup']
  39
  40 2) Prevent the module from converting the markup to a button.
  41
  42 There's a section of code that looks like this:
  43       '#attached' => array(
  44         'js' => array(
  45           'http://api.flattr.com/js/0.6/load.js?mode=auto' => array(
  46             'type' => 'external',
  47           ),
  48         ),
  49         'css' => array(drupal_get_path('module', 'flattr') . '/flattr.css'),
  50       ),
  51
  52 which you need to enclose in /* */ like this,
  53
  54 /*      '#attached' => array(
  55         'js' => array(
  56           'http://api.flattr.com/js/0.6/load.js?mode=auto' => array(
  57             'type' => 'external',
  58           ),
  59         ),
  60         'css' => array(drupal_get_path('module', 'flattr') . '/flattr.css'),
  61       ),*/
  62
  63 Then when viewing your content, you will get the raw data passed to Flattr,
  64 instead of the button that Flattr returns.
  65
  66
  67 === Known problems ===
  68 Currently doesn't work with Ctools, and as such neither Views and Panels.
  69 This is because in a ctools context the current entity_type normally isn't
  70 known. This module makes certain assumptions about entity_type that then don't
  71 hold true. This will be fixed in a future version.