Difference between revisions of "Paperbook"

From ADF Docs
Jump to: navigation, search
 
(7 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
* [[json]]
 
* [[json]]
  
The ADF must be configured correctly for your site. The [[Site Level ADF Component]] wiki page has instructions for configuration.
+
The ADF must be configured correctly for your site. The [[Site Configuration (ADF.cfc)]] wiki page has instructions for configuration.
  
 
== Contents ==
 
== Contents ==
Line 20: Line 20:
  
 
=== Facebook Considerations ===
 
=== Facebook Considerations ===
Part of the Paperbook Application uses a Facebook API called Connect.  It is the easiest and fastest way to add Facebook integration into any site. In order to make this work you need to [[How to create a Facebook Application| create a Facebook Application]].
+
Part of the Paperbook Application requires a Facebook API Key to enable your site to use a feature called Connect.  Facebook Connect is the easiest and fastest way to add Facebook integration into any site.
 +
 
 +
If you do not have a Facebook API Key you will need to [[How to create a Facebook Application| create a Facebook Application]].
  
 
== Installation/Setup ==
 
== Installation/Setup ==
 
Each of the following steps should be completed fully and in the order presented:
 
Each of the following steps should be completed fully and in the order presented:
  
# Import the "Facebook Fan Page" and "Facebook Share" Custom ElementNote: The "Facebook Pages" Custom Field Type will be imported as a part of the "Facebook Fan Page" Custom Element.
+
* Import the "Facebook Fan Page" Custom Element
#
+
* Import the "Facebook Share" Custom Element
 +
<pre>
 +
Note: The "Facebook Pages" Custom Field Type will be imported as a part of the
 +
"Facebook Fan Page" Custom Element.
 +
</pre>
 +
* Add the following to your template-basepage.head
 +
<pre>
 +
<cfset application.paperbook.pbService.addFBNamespace(headStruct)>
 +
</pre>
 +
* Add the following to the bottom of your template-basepage.cfm
 +
<pre>
 +
<cfset application.paperbook.pbService.initFacebook()>
 +
</pre>
 +
* [[Build Facebook Cross-Domain Communication Channel]]
 +
* [[Paperbook Configuration Element]]
 +
 
 +
== Using the Paperbook Application ==
 +
* [[Fan a Page]]
 +
* [[Share on Facebook]]
  
 +
<!-- //
 
== Features ==
 
== Features ==
The profile application provides the following features:
+
The Paperbook application provides the following features:
<!-- // LIST ANY ADDITIONAL OPTIONS/FEATURES YOU CAN ADD TO YOUR APPLICATION -->
+
-->
  
<!-- // [[Category:Project]][[Category:###PROJECT NAME ###]] -->
+
[[Category:Project]][[Category:Paperbook]]

Latest revision as of 04:56, 15 April 2010

Overview

Paperbook is an ADF Application that is designed to integrate you CommonSpot content with Facebook. Some of the work that you can do with the Paperbook Application:

  • Allow site visitors to share CommonSpot pages with Facebook
  • Allow site visitors to Fan your Facebook Pages directly from your site

Requirements

ADF Library components that are required for the Profile:

The ADF must be configured correctly for your site. The Site Configuration (ADF.cfc) wiki page has instructions for configuration.

Contents

  • Facebook Fan Page Custom Element
  • Facebook Share Custom Element
  • Facebook Pages Custom Field Type

Pre-installation Considerations

This installation guide assumes that you have no Custom Elements/Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)

Facebook Considerations

Part of the Paperbook Application requires a Facebook API Key to enable your site to use a feature called Connect. Facebook Connect is the easiest and fastest way to add Facebook integration into any site.

If you do not have a Facebook API Key you will need to create a Facebook Application.

Installation/Setup

Each of the following steps should be completed fully and in the order presented:

  • Import the "Facebook Fan Page" Custom Element
  • Import the "Facebook Share" Custom Element
Note: The "Facebook Pages" Custom Field Type will be imported as a part of the
"Facebook Fan Page" Custom Element.
  • Add the following to your template-basepage.head
 <cfset application.paperbook.pbService.addFBNamespace(headStruct)>
  • Add the following to the bottom of your template-basepage.cfm
 <cfset application.paperbook.pbService.initFacebook()>

Using the Paperbook Application