The Facebook Instant Articles modules allow administrators to add content from a Drupal site to Facebook, to be viewed on mobile devices as Instant Articles.
About the Facebook Instant Articles service
Facebook has introductory information for publishers
as well as in-depth documentation for developers.
About Drupal integration
Before installing this module or packaged sub-modules, there are two methods to
choose from for how to add your content to Facebook as Instant Articles (either
via a RSS feed or Facebook's API). The Drupal 7 and 8 versions differ slightly in how each method is implemented, so read on according to your Drupal version.
Drupal 8
1. RSS feed method
On a basic Drupal site, with one or more article-like content types that you
wish to post to Facebook as Instant Articles, the simplest way is to create a
feed from your Drupal site and then have your Facebook page admin configure
the Instant Articles options to point to your website to ingest the feed.
You'll need to configure which content types you want to be allowable as Instant
Articles, then configure a view mode to specify which fields you want to map to
which region of the Instant Article format, then you're all ready to create the
feed.
To create the actual feed, simple enable the Facebook Instant Articles Views module. This module ships with a default view which creates an RSS feed of your content accessible at /instant-articles.rss. If you require more customized filtering, simply edit the view.
2. API method
If you're a publisher who wants more control over exact timing of publishing -
editing, modifying public access, or removing content from your Facebook Instant
Articles library - the API approach allows for greater control.
Simply enable the Facebook Instant Articles API module. After enabling, configure your API settings on the configuration page at /admin/config/services/fb_instant_articles/api_settings. After that, the module will begin creating/editing/deleting content in Instant Articles as you create/edit/delete your Facebook Instant Articles enabled content types.
Drupal 7
1. RSS feed method
On a basic Drupal site, with one or more article-like content types that you
wish to post to Facebook as Instant Articles, the simplest way is to create a
feed from your Drupal site and then have your Facebook page admin configure
the Instant Articles options to point to your website to ingest the feed.
You'll need to configure which content types you want to be allowable as Instant
Articles, then configure a view mode to specify which fields you want to map to
which region of the Instant Article format, then you're all ready to create the
feed.
To create the actual feed, there are two main options: a simple RSS feed, or a
more advanced feed using the Views module.
RSS feed (simple)
If you enable the fb_instant_articles_rss.module you will have a feed created
for you automatically. You will then have the option to either add all published
content of one or more types to the feed, or else select individual pieces of
content to be included in the feed.
Views feed (advanced)
Alternately, if you enable the fb_instant_articles_views.module you will be able
to choose more advanced filtering rules for which content is included in the
feed. Currently only a rendered view mode (not a fields view) is supported.
2. API method
If you're a publisher who wants more control over exact timing of publishing -
editing, modifying public access, or removing content from your Facebook Instant
Articles library - the API approach allows for greater control.
API Rules integration (optional)
If you're using the API you will need to determine under what conditions the API
creates, edits or removes content from Facebook's Instant Articles library. This
submodule adds actions (both Drupal core actions and Rules
module actions) which can be triggered based on your chosen configurations.
Alternately, If you do not choose to use this module to trigger API actions, you
will want to trigger them some other way (via a custom module implementing
entity CRUD hooks checking your own custom conditions in code, etc).
API Report (optional)
Optionally enable this module to give a report of API interactions, so that for
example any content that fails Facebook Instant Article format validation will
be easier to find and fix.
Dependencies
Facebook Instant Articles PHP SDK
Provides necessary support for ensuring Drupal content is added to Facebook in
the required format for Instant Articles. The module ships with a composer.json file covering this dependency.
Strongly recommended (Drupal 7):
- Composer Manager (Drupal 7 only)
autoload's classes needed for the Facebook Instant Articles SDK, and downloads the SDK
automatically when you enable the base module. Composer manager is not a
literal dependency so that developers with custom Composer workflows can choose
to manage dependencies and autoloading themselves (if this is the case you will
need to include Composer's autoload file somewhere in your code, and set the
variable 'fb_instant_articles_bypass_composer_manager' to TRUE).
Installation
Before installing the Drupal Facebook Instant Articles modules, see "About
Drupal integration" above to help choose which modules are right for you. Then
see "Dependencies" above. Then:
- Install Composer dependencies. See Installing modules' composer dependencies.
- Install the submodules you choose as you would normally install a contributed
Drupal module. See Installing modules for further information.
Configuration
See the README in your selected submodules for configuration help.
Issues and Development
- Issues should be made in the project's issue queue on Drupal.org.
- All development is happening in the project's issue queue on Drupal.org.
Maintainers
This module is maintained by the Drupal community.
Project information
- Project categories: Content editing experience, Import and export, Integrations
91 sites report using this module- Created by vgardner on , updated
Stable releases for this project are covered by the security advisory policy.
There are currently no supported stable releases.
