= Facebook Social plugins
The Facebook Social plugins for Rails 3 consist of:
* Helper::View
* Helper::Script
* Helper::OpenGraph # see https://developers.facebook.com/docs/opengraph/
The `Helper::View` contains methods for inserting the HTML5
elements for Facebook social plugins
The `Helper::Script` contains methods for inserting
=== Add to Timeline
Add to Timeline lets users create a lasting connection between your app and their Timeline on Facebook. When a user clicks Add to Timeline, your app can publish app specific actions to the user's Timeline. As users engage with your app over time, their actions become more prominently displayed on their Timeline. This can become an important part of how people express themselves on Facebook. The experience for users is seamless and fun and requires little effort for them to personalize their identity.
Add to Timeline plugin is available through the Javascript SDK via the
XFBML tag.
There are two different display modes for the Add to Timeline: box (default) and button. You can also configure additional extended permissions for the plugin by adding the perms parameter.
* mode - the display mode - box (default) and button
* show_faces - whether to show faces
=== Facepile
The Facepile plugin displays the Facebook profile pictures of users who have connected with your page via a global or custom action, or can also be configured to display users that have signed up for your site.
If you want to display users who have connected to your page via an action, specify with the action parameter
To display users who have liked your page, specify the URL of your page as the href parameter. To display users who have signed up for your site, specify your application id as the app_id parameter.
* event-app-id - the app id for the event
* action - the action to perform, fx 'og_recipebox:planning_to_make'
* width - the width of the plugin in pixels. Minimum recommended width: 400px.
* href - the referenced page
* max_rows - max rows to display, 1-10 normally
=== Recommendations
* site - the domain to show recommendations for. The XFBML version defaults to the current domain.
* action - a comma separated list of actions to show recommendations for.
* app_id - will display recommendations for all types of actions, custom and global, associated with this app_id.
* width - the width of the plugin in pixels. Default width: 300px.
* height - the height of the plugin in pixels. Default height: 300px.
* header - specifies whether to show the Facebook header.
* colorscheme - the color scheme for the plugin. Options: 'light', 'dark'
* font - the font to display in the plugin. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
* border_color - the border color of the plugin.
* linktarget - This specifies the context in which content links are opened. By default all links within the plugin will open a new window. se to _top or _parent.
* ref - a label for tracking referrals; must be less than 50 characters and can contain alphanumeric characters
* max_age - a limit on recommendation and creation time of articles that are surfaced in the plugins, the default is 0 (days)
=== Send button
* href - the URL to send.
* font - the font to display in the button. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
* colorscheme - the color scheme for the button. Options: 'light', 'dark'
* ref - a label for tracking referrals; must be less than 50 characters and can contain alphanumeric characters
* fb_ref - the ref parameter
* fb_source - the story type ('message', 'group', 'email') in which the click occurred.
=== Subscribe button
* href - profile URL of the user to subscribe to. This must be a facebook.com profile URL.
* layout - there are three options (standard, button_count, box_count).
* show_faces - specifies whether to display profile photos below the button (standard layout only)
* colorscheme - the color scheme for the plugin. Options: 'light' (default) and 'dark'
* font - the font to display in the plugin. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
* width - the width of the plugin.
== Contributing to facebook-social_plugins
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
== Copyright
Copyright (c) 2012 Kristian Mandrup. See LICENSE.txt for
further details.