newscoop/publishingplatforms-plugin-bundle

PublishingPlatforms plugin for Newscoop. Converts newscoop article body elements into FBIA and AMP tags.

dev-master 2016-08-16 20:24 UTC

Requires

• php: >=5.3.3
• newscoop/plugins-installer: >=v0.2

GPL-3.0

• Paweł‚ Mikołajczuk

• newscoop
• amp
• amp-html
• publishingplatforms
• Facebook Instant Articles
• FBIA

README

Plugin provides support for Google AMP and Facebook Instant Articles in Newscoop. Plugin creates special route/url for article and enable smarty modifiers which can be used for transforming article body html into AMP/FBIA compatible version.

This plugin is compatible with Newscoop 4.4.7 and higher.

Installation

Installation is a quick process:

1. How to install this plugin?
2. That's all!

Step 1: How to install this plugin?

Run the command:

$ php application/console plugins:install "newscoop/publishingplatforms-plugin-bundle"
$ php application/console assets:install public/

Plugin will be installed to your project's newscoop/plugins/Newscoop directory.

Step 2: That's all!

Go to Newscoop Admin panel and then open Plugins tab. The Plugin will show up there. You can now use this plugin.

Note:

To update this plugin run the command:

$ php application/console plugins:update "newscoop/publishingplatforms-plugin-bundle"
$ php application/console assets:install public/

To remove this plugin run the command:

$ php application/console plugins:remove "newscoop/publishingplatforms-plugin-bundle"

Documentation

Google AMP

Modifier:

{{ $gimme->article->full_text|amp }}

Route for AMP version of Article:

Pattern: /amp/{languageCode}/{issueUrl}/{sectionUrl}/{articleNumber}/{articleSeo}.htm"

Loaded template path: _publishingPlatforms/amp/article.tpl

Route name: newscoop_publishingplatforms_amp_article

Generate link to AMP version:

{{ generate_url route="newscoop_publishingplatforms_amp_article" absolute=true parameters=[
    'languageCode' => $gimme->article->language->code,
    'issueUrl' => $gimme->article->issue->url_name,
    'sectionUrl' => $gimme->article->section->url_name,
    'articleNumber' => $gimme->article->number,
    'articleSeo' => $gimme->article->seo_url_end
] }}

Facebook Instant Articles

{{ $gimme->article->full_text|fbia }}

Change template file used to rendering of images inside article content

Before rendering article content field use this function: {{ set_content_image_template name="editor_image_fbia.tpl" }}

Example of editor_image_fbia.tpl can be found in this plugin: Resources/views/default_templates/fbia/editor_image_fbia.tpl

set_content_image_template will tell for Newscoop to use custom template file for images inside article content.

At end of file reset your changes with {{ reset_content_image_template }}

License

This bundle is under the GNU General Public License v3. See the complete license in the bundle:

LICENSE

About

This Bundle is a Sourcefabric z.ú. initiative.