README

Provides a Facebook Page Plugin component and sharing button for use with SilverWare.

Contents

• Requirements
• Installation
• Configuration
• Usage
• Issues
• Contribution
• Maintainers
• License

Requirements

• SilverWare
• SilverWare Social Module

Installation

Installation is via Composer:

$ composer require silverware/facebook

Configuration

As with all SilverStripe modules, configuration is via YAML. An extension is applied to site configuration which adds a tab for Facebook settings to the SilverWare Services tab.

Facebook App ID

Before the FacebookPagePlugin component can function, you will first need to create a Facebook App ID using the Facebook for Developers site. To do this:

1. Login to the Facebook for Developers site.
2. Click on "My Apps" and then "Add a New App".
3. Enter the app display name and contact email.
4. Click on the "Create App ID" button.

This will generate a new Facebook App ID. Copy the ID number, and paste it into the "Facebook App ID" field under Settings > SilverWare > Services > Facebook API. Finally, click the "Save" button to store your site settings.

Alternatively, you can enter the Facebook App ID into your YAML configuration files:

SilverWare\Facebook\API\FacebookAPI:
  app_id: '<paste-id-here>'

Usage

Facebook Page Plugin

This module provides a FacebookPagePlugin component which can be added to a SilverWare template or layout using the CMS. For the plugin to work correctly, you will need:

1. A valid Facebook App ID (see above).
2. The name of your Facebook page.
3. The URL of your Facebook page.

Add the component where desired in your template or layout, enter the name of your Facebook page (e.g. "My Company") and the URL of your page on Facebook.

For more information about the Facebook Page Plugin, see the Facebook documentation.

Facebook Sharing Button

Also provided is a FacebookSharingButton which is used with the SharingComponent from the SilverWare Social Module. Simply add this button as a child of SharingComponent using the site tree, and your pages will now be able to be shared via Facebook.

For more information, see the Facebook documentation.

Issues

Please use the GitHub issue tracker for bug reports and feature requests.

Contribution

Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.

Maintainers

Colin Tucker	Praxis Interactive

License

BSD-3-Clause © Praxis Interactive