=== WPBook ===
Contributors: johneckman, davelester, bandonrandon
Tags: facebook, platform, application, blog, mirror
Stable tag: 1.3.1
Tested up to: 2.7.1
Requires at least: 2.5

Plugin to embed Wordpress Blog into Facebook Platform.

== Overview ==

WPBook enables users to add your (self-hosted, not wordpress.com) wordpress 
blog as a Facebook application. Facebook users will see your posts in a 
Facebook look and feel, and can leave comments with their Facebook identity. 

Comments are shared - meaning comments made by users on your blog at its 
regular domain and comments made by users inside Facebook are all shown to 
users of either "view" of your content. 

Facebook users can also - at their option - add a profile box to their profile,
using the "add to profile" button at the top of the default canvas page. 

That profile box shows the 5 most recent posts from your blog, as links. 

NOTE: These 2 plugins have been reported to conflict with WPBook:
	- Bad Behavior 
	- Facebook Connect (from Sociable.es)

I'm working on identifying and eliminating conflict, but you should not
try to use WPBook with either of these plugins in the current state. 

(Note there is a workaround for the Sociable.es Facebook Connect plugin
 described here: http://bit.ly/hhach)

Finally, if one of your other plugins (Kaltura's Interactive Video for
example) uses CSS and sets the height of either the body or html elements
to 100%, the auto-resizing javascript in Facebook may fail. You can 
fix this by removing the plugin or editing the css. 

== Installation ==

(Note: installation instructions are also included in HTML and as a PDF
 along with the plugin)

1. Copy the entire wpbook directory into your wordpress plugins folder,
   /wp-content/plugins/

   You should have a directory structure like this:
   /wp-content/plugins/wpbook/wpbook.php
   /wp-content/plugins/wpbook/theme/
   /wp-content/plugins/wpbook/client/
   /wp-content/plugins/wpbook/php4client/

   NOTE: If you've used previous versions, you no longer need to copy
   the wp-facebook folder (which no longer exists) to your themes directory. 
   
   If you've used versions prior to 0.9.5, you can DELETE the following 
   directory and all it's contents: 
		/wp-content/themes/wp-facebook/ 

2. Set up a New Application at http://www.facebook.com/developers/, obtaining
   a secret and API key.  

   Set the callback url to your blog url, including  a trailing slash. 
       (http://www.yourblogurl.com/)
   For canvas url, you just need something *all lower case*, unique, with
   no spaces, and no trailing slash. Remember it. 
   
   Set the application type to "website"
      
   Set the application to use an iFrame, not fbml, and to "resizable"
   (Using iFrames lets you use javascript, objects, and other tags 
    not allowed in FBML inside blog posts)

3. Login to Wordpress Admin and activate the plugin

4. Using the WPBook menu, (Dashboard->Settings->WPBook) fill 
   in the appropriate information including Facebook application secret 
   and API keys, as well as your application canvas url. 

   Enabling the "Show Invite Friends Link" will show a link inside 
   Facebook when viewing your application which allows users to send
   invites to their friends. 

   Comments inside Facebook can be enabled or disabled without any impact
   on comments when your blog is viewed outside Facebook. If you have comments
   enabled, you can optionally require users to provide their email address. 
   (Facebook does not allow access to the user's email address, so you can 
   really only ask users to provide one, not prefill it automatically). 

   The "Give WPBook credit" option adds a line at the bottom of your Facebook
   application pages which says "This Facebook application powered by the 
   WPBook plugin for Wordpress" - I'd love it if you would leave this enabled
   but it is not required.  

   The "Share this post" links can also be enabled or disabled. If they are
   enabled, they will allow the user to "share" your blog posts using the 
   built in Facebook Share mechanism, including sending a message to friends
   or posting in their profile. 

   The "Enable 'view post at external site' link" enables a link to each blog post 
   at your full blog url (outside Facebook). This is useful to get folks going
   to your blog outside Facebook, to see it full size/theme etc. 

   The "Link position for share button and external link button" option determines
   where, within each post, those two links will appear - either at the top of the 
   post (before the post content) or at the bottom of the post (after the post
   content). 

   "Enable Facebook users to add your app to their profile" will show an "Add to 
   Profile" button for users viewing the app inside Facebook - this lets them choose
   to add the application to their profile. 

5. To add the application to "Pages" not just "Profiles" - see the instructions linked to from the "settings" page for the plugin. 
     
== Frequently Asked Questions ==

= How do I edit the way my Facebook Application (mirrored blog) looks? =

In the wpbook/theme directory, there is an index.php file.  Most of 
what you want is there.  

There's also a default/style.css which basically mimics Facebook's styles, 
as well as some other files for processing comments and the like.  

== Version History ==

= Version 1.3.1 = 
* Fix for XAMPP Windows users - add ABSPATH to include for config.php
* Fix for users who have the application name *in* the permalink structure
* Cleanup for images in instructions that were too wide for layout
* Cleanup button title for submit on invite friends page
* Remove unnecessary second 'include_once' in comments.php

= Version 1.3 =
* Mostly improvements to the admin interface user experience - better 
  separation of options into required, customization, social, and advanced. 
* Ability to include a custom header/footer for each post, including author,
  date, time, category, and tags. 
* Bugfix: No longer echoing blog name twice on the invite friends screen. 
* Bugfix: Caught case where profile box could get updated with links to 
  the original source (outside FB). 
* Note: This is expected to be the final PHP4 compatible version. Facebook's 
  client only supports PHP5, and I need to be able to wrap certain client
  calls in Try/Catch, which requires PHP5, to avoid nasty "uncaught exception"
  bugs. (Yes, there are unofficial PHP4 clients, but they are unsupported).
  If someone wants to create a PHP4 only version which trails the ongoing
  development, they are welcome to, taking this as the place from which to
  begin a fork.  

= Version 1.2 =
* Changed the mechanism for "Add to Profile" to avoid issues with
  the fb:ref url method, using fb:ref handle instead
* Eliminated /wpbook/theme/recent_posts.php
* Incorporated Brandon Dukes' fixes to admins screens
* Added timestamp to posts

= Version 1.1.1 =
* Fixed minor bug which broke FB resize javascript when 'add to profile'
  option was off
* Fixed minor bug in the description of the plugin (display). 

= Version 1.1 =
* Fixed (I hope!) Profile.setFBML issues for pages, profiles
  Eliminated the need to copy defaultFBML into settings
* Added option to view link in external site
* Added option to move links (share, external) top or bottom
* Added option to enable "add to profile"
* Created documentation with photos

= Version 1.0 =
* Added simplexml44 library (BSD Licensed) for php4client
* Added option for "Give Credit" 
* Added option for "Enable Share"
* Added option for "Allow Comments"
* Moved "Invite Friends" to top of page
* Cleaned up CSS for "recent posts" in main page
* Added fix to facebookapi_php5_restlib.php which affected hosts where
  curl libraries were not present or enabled
* Jumped version to 1.0 - functionally complete

= Version 0.9.7 =
* template_directory deprecated in 2.7, use bloginfo('wpurl') instead

= Version 0.9.6 = 
* Clean up from moving plugin in to directory
* Added Share button to share posts on FB
* Added fix for conflict with other Facebook-based plugins

= Version 0.9.5 = 
* Moved plugin into wpbook dir in subversion
* Moved theme subdirectory inside plugin subdir
*   Required several function changes
* Added check for existing FacebookRestClient

= Version 0.9.4 =
* Bug in javascript (NULL isn't the same as null) for profile

= Version 0.9.3 =
* Bug in commenting inside Facebook due to $facebook->redirect
* Now redirects to the post on which the user commented
* Added instruction for adding to FB Pages to settings page in WordPress

= Version 0.9.2 =
* Didn't realize I had set default FBML inside Facebook, masked a bug
* Should now set profile FBML before calling add profile box

= Version 0.9.1 =
* Fixed xd_reciever.html versus xd_receiver.html issue
* (You'd think a guy with a PhD in English would know how to spell.) 

= Version 0.9  = 
* Added profile boxes
* Shows 5 most recent posts in profile box
* Also sets FBML for "pages" profile boxes

= Version 0.8.2 =
* Added option to require email address of comment author
* Can be set separately only for Facebook comment authors
* Functionality added by Brandon Dukes. 

= Version 0.8.1 =
* Oops. Typo in README.txt - Brandon Dukes.
* Issue with some text not being displayed
  on the invite form
* Tested with Wordpress 2.6.2

= Version 0.8 =
* Thanks to Brandon Dukes for contributing facebook invites - if you
  select 'display invite friends link' checkbox in the wp-admin 
  settings for WPBook, you can invite facebook friends!
* Display email box for commentors (optional)

= Version 0.7.5 = 
* bug fix: style.css is in template directory, not necessarily
  based on /wp-content/themes/wp-facebook - account for subdirs
* Same goes for the FB.XdComm.Server.init call

= Version 0.7.4 =
* bug fix for subdirectory based blogs
* fixed hardcoded offset of permalinks
* added note to readme to update theme when updating plugin
* Updated javascript in theme to reflect "new" facebook js 0.4
  (See http://wiki.developers.facebook.com/index.php/Resizable_IFrame#New_Profile_Update)
* Fixed erroneous link in "theme not installed" check
* Added ABSPATH as appropriate to catch the right includes
* Removed hard dependency on specific Avatars plugin, now uses default gravatar

= Version 0.7.3 =
* bug fix
* adding namespacing to plugin function
* anded min version to readme

= Version 0.7.2 =
* bug fix
* no try { } catch {} in PHP4

= Version 0.7.1 =
* bug fix
* comments_facebook.php was not being found
* created fb_comments_template function instead

= Version 0.7 =
* Major architecture changes
* Relies on a theme, not creation of a page
* Inspired by Alex King's mobile plugin (http://alexking.org/projects/wordpress)
* Enables recent posts and post navigation
* Added app canvas url to options for use as redirect post-comment submission

= Version 0.6 =
* Added support for posting comments
* Switched to iFrame to allow more code in blog posts
* Added Facebook javascript for resizing iFrame
* Added style.css for styling
* fixed bug in storing options
* consolidated Facebook client stuff in config.php
* auto detect php version and set client include accordingly

= Version 0.5 =
* Added support for PHP4 Facebook Client Library
* Options combined into associative array to speed-up and remove 
  interference w/ other plugins

= Version 0.4 =
* First push to WP-Plugins Directory

== To Do ==
* Update instructions in readme to match new options available in 1.3
* Leverage new Facebook API to set user's status when a new blog post
  gets posted. 
* Capture Facebook Profile picture of user commenting in
  Facebook, display instead of Gravatar. (I think this 
  will require actually fetching and storing the picture,
  not just its url, as it may not be available outside
  Facebook, and may change). 
* Deal with non-standard front pages (where user has set
  a static page in WordPress options)
* Enable pages for things like cateories and tags, and enable links to 
  those pages from the header/footer of the post (since 1.3). 
* Add notification to wall/notes when user publishes
  a new post - for all users. (May require user to grant additional 
  permissions). 
