OJS Plugin: External RSS Feeds

The Plugin Gallery is a venue for users of PKP software to share their plugins.

Moderators: jmacgreg, michael, John

Forum rules
The Public Knowledge Project Support Forum is moving to http://forum.pkp.sfu.ca

This forum will be maintained permanently as an archived historical resource, but all new questions should be added to the new forum. Questions will no longer be monitored on this old forum after March 30, 2015.
michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

OJS Plugin: External RSS Feeds

Postby michael » Wed Oct 14, 2009 11:48 pm

Publish content from external Atom/RSS web syndication feeds in OJS.

This plugin can be used to include in your journal any content that is published using an Atom/RSS feed. Feed items can be displayed on the journal homepage and/or in the sidebars.

For example:
- Include blog postings in OJS from an external WordPress or Drupal install.
- Include announcements in OJS from an external OCS install.
- Include announcements and/or table of contents items in OJS sidebars from OJS-generated feeds (via announcementFeed and webFeed plugins).

There are two versions of this plugin, depending on your OJS install (either 2.2.x or 2.3+).

Please find some attached screenshots below.

Author: Michael Felczak
Software: OJS
Versions: 2.2+
Multilingual: yes


external_feed_1.png
External Feed Plugin Screenshot 1
external_feed_1.png (101.02 KiB) Viewed 9467 times

external_feed_2.png
External Feed Plugin Screenshot 2
external_feed_2.png (109.27 KiB) Viewed 9467 times
Last edited by michael on Thu Oct 15, 2009 12:27 am, edited 2 times in total.

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

External Feed Plugin: OJS 2.2.x

Postby michael » Wed Oct 14, 2009 11:59 pm

Download this version of the plugin if you are using OJS 2.2.x.

Installation :: Existing OJS Install

1) Copy the plugin package to your root OJS directory.

2) Unpack the plugin package to the generic plugin directory:

Code: Select all

tar xfz externalFeed.tar.gz -C plugins/generic/
This should create the directory plugins/generic/externalFeed.

3) Manually add the plugin tables to your OJS database:

Code: Select all

php5 tools/dbXMLtoSQL.php -schema execute plugins/generic/externalFeed/schema.xml

4) Delete the plugin package from your root OJS directory:

Code: Select all

rm externalFeed.tar.gz


Installation :: New OJS Install

1) Copy the plugin package to your root OJS directory.

2) Unpack the plugin package to the generic plugin directory:

Code: Select all

tar xfz externalFeed.tar.gz -C plugins/generic/
This should create the directory plugins/generic/externalFeed.

3) Delete the plugin package from your root OJS directory:

Code: Select all

rm externalFeed.tar.gz

4) Complete the standard OJS installation.

Setup

1) Log in as Journal Manager.

2) Enable the plugin under System Plugins -> Generic Plugins.

3) External feeds can be added via the Journal Manager admin interface.

4) To display in sidebars, go to Setup -> The Look and ensure that the External
Feed Block is included in either the left or right sidebar.

Customization

This plugin includes a default CSS stylesheet, externalFeed.css, which can be
modified and uploaded using the plugin to customize the look and feel of included
RSS content.
Attachments
externalFeed.tar.gz
External Feed Plugin (1.0.0.0) for OJS 2.2.x
(79.35 KiB) Downloaded 473 times
Last edited by michael on Thu Oct 15, 2009 12:07 am, edited 1 time in total.

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

External Feed Plugin: OJS 2.3+

Postby michael » Thu Oct 15, 2009 12:06 am

Download this version of the plugin if you are using OJS 2.3+.

Installation

1) Log in as Journal Manager.

2) Go to System Plugins, click on 'Install A New Plugin'.

3) Select and upload externalFeed.tar.gz to complete the installation.

Setup

1) Log in as Journal Manager.

2) Enable the plugin under System Plugins -> Generic Plugins.

3) External feeds can be added via the Journal Manager admin interface.

4) To display in sidebars, go to Setup -> The Look and ensure that the External
Feed Block is included in either the left or right sidebar.

Customization

This plugin includes a default CSS stylesheet, externalFeed.css, which can be
modified and uploaded using the plugin to customize the look and feel of included
RSS content.
Attachments
externalFeed.tar.gz
External Feed Plugin (1.0.0.0) for OJS 2.3+
(79.26 KiB) Downloaded 462 times

newone
Posts: 140
Joined: Tue Nov 17, 2009 2:30 am

Re: OJS Plugin: External RSS Feeds

Postby newone » Wed Dec 16, 2009 11:35 am

I tried your plugin and it produces an error. You may need to re-package the zip file again.

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

Re: OJS Plugin: External RSS Feeds

Postby michael » Wed Dec 16, 2009 9:16 pm

Hi newone,

Can you please provide some additional details, in particular which version of OJS you are using and the error that you encountered?

Please note that if installing in OJS 2.3.x, you will need to save the plugin zip file using the provided filename in order to be able to use it via the Install Plugin feature.

Cheers,
Michael

newone
Posts: 140
Joined: Tue Nov 17, 2009 2:30 am

Re: OJS Plugin: External RSS Feeds

Postby newone » Thu Dec 17, 2009 10:38 pm

michael wrote:Hi newone,

Can you please provide some additional details, in particular which version of OJS you are using and the error that you encountered?

Please note that if installing in OJS 2.3.x, you will need to save the plugin zip file using the provided filename in order to be able to use it via the Install Plugin feature.

Cheers,
Michael



I tried this sometime back. I downloaded the file from PKP and uploaded it with using plugin management. I will try it again. BTW, I am on 2.3.0.

Kaitlin
Posts: 10
Joined: Wed Nov 25, 2009 10:06 pm

Re: OJS Plugin: External RSS Feeds

Postby Kaitlin » Thu Jan 14, 2010 3:39 pm

Is there a way to install this plugin without using command line (which my web host doesn't allow).

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

Re: OJS Plugin: External RSS Feeds

Postby michael » Sat Jan 16, 2010 1:19 pm

Hi Kaitlin,

Kaitlin wrote:Is there a way to install this plugin without using command line (which my web host doesn't allow).



If you're running OJS 2.2.x, you can create the necessary plugin database table manually by executing the following in MySQL:

Code: Select all

CREATE TABLE `external_feeds` (
  `feed_id` bigint(20) NOT NULL AUTO_INCREMENT,
  `journal_id` bigint(20) NOT NULL,
  `url` varchar(255) NOT NULL,
  `seq` double NOT NULL DEFAULT '0',
  `display_homepage` tinyint(4) NOT NULL DEFAULT '0',
  `display_block` smallint(6) NOT NULL DEFAULT '0',
  `limit_items` tinyint(4) DEFAULT '0',
  `recent_items` smallint(6) DEFAULT NULL,
  PRIMARY KEY (`feed_id`),
  KEY `external_feeds_journal_id` (`journal_id`)
);


Cheers,
Michael

Kaitlin
Posts: 10
Joined: Wed Nov 25, 2009 10:06 pm

Re: OJS Plugin: External RSS Feeds

Postby Kaitlin » Thu Feb 25, 2010 3:53 pm

michael wrote:Hi Kaitlin,

Kaitlin wrote:Is there a way to install this plugin without using command line (which my web host doesn't allow).



If you're running OJS 2.2.x, you can create the necessary plugin database table manually by executing the following in MySQL:

Code: Select all

CREATE TABLE `external_feeds` (
  `feed_id` bigint(20) NOT NULL AUTO_INCREMENT,
  `journal_id` bigint(20) NOT NULL,
  `url` varchar(255) NOT NULL,
  `seq` double NOT NULL DEFAULT '0',
  `display_homepage` tinyint(4) NOT NULL DEFAULT '0',
  `display_block` smallint(6) NOT NULL DEFAULT '0',
  `limit_items` tinyint(4) DEFAULT '0',
  `recent_items` smallint(6) DEFAULT NULL,
  PRIMARY KEY (`feed_id`),
  KEY `external_feeds_journal_id` (`journal_id`)
);


Cheers,
Michael


Thanks, Michael! I also had to add this to make it work:

Code: Select all

    CREATE TABLE external_feed_settings (
    feed_id                  BIGINT NOT NULL,
    locale                   VARCHAR(5) NOT NULL DEFAULT '',
    setting_name             VARCHAR(255) NOT NULL,
    setting_value            TEXT,
    setting_type             VARCHAR(6) NOT NULL

    );


I'm thrilled to be able to customize it with CSS. Thanks for making this plugin!

Best,
Kaitlin

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

Re: OJS Plugin: External RSS Feeds

Postby michael » Wed Mar 03, 2010 7:47 pm

Hi Kaitlin,

Thanks for the follow-up and the additional MySQL to get things going. I'm sure it'll be useful to others with similar server limitations.

Cheers,
Michael

gerbenzaagsma
Posts: 6
Joined: Thu Jan 19, 2012 6:36 am

Re: OJS Plugin: External RSS Feeds

Postby gerbenzaagsma » Thu Jan 19, 2012 6:41 am

Is it possible to modify the display of feeds on the homepage when not displayed as a block?

We find the teasers too long and would prefer a simple list of headers or only a small teaser.

Thanks and best,
Gerben

thebigaym
Posts: 46
Joined: Thu Apr 09, 2009 8:25 am
Contact:

Re: OJS Plugin: External RSS Feeds

Postby thebigaym » Thu Jan 19, 2012 9:24 am

I'm interested in this plug-in. Would someone post URLs to OJS implementations using it so I can see how it looks?

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

Re: OJS Plugin: External RSS Feeds

Postby michael » Fri Jan 20, 2012 10:11 am

Hi Gerben,

There are a few ways in which you can customize this plugin for your journal.

There's an included CSS file in the plugin directory that lists the styles introduced by the plugin which you can use as a basis for controlling display.

gerbenzaagsma wrote: We find the teasers too long and would prefer a simple list of headers or only a small teaser.


To remove the description, you would need to modify the displayHomepage function in ExternalFeedPlugin.inc.php. In particular, you could remove the call to $item->get_description(); and the surrounding HTML tags.

This plugin relies on an external library, SimplePie, to process RSS feeds. Future versions of the library will include the option to control description lengths and we can include this as an option in the plugin itself. If you'd like a workaround for the time being, please see this guide for more information.

Cheers,
Michael

michael
Posts: 409
Joined: Thu Mar 29, 2007 2:09 pm
Contact:

Re: OJS Plugin: External RSS Feeds

Postby michael » Fri Jan 20, 2012 10:13 am

Hi thebigaym,

thebigaym wrote:I'm interested in this plug-in. Would someone post URLs to OJS implementations using it so I can see how it looks?


Please see the images included in the initial posts in this thread.

Cheers,
Michael

gerbenzaagsma
Posts: 6
Joined: Thu Jan 19, 2012 6:36 am

Re: OJS Plugin: External RSS Feeds

Postby gerbenzaagsma » Thu Jan 26, 2012 4:07 am

Hi Michael,

thanks for the reply, I will start working on it.

Do you have any idea when an updated version of the plugin with the option included will be ready? We are going live only late March so I would not want to implement a workaround when the plugin is updated soon.

Best,
Gerben


Return to “Plugin Gallery”

Who is online

Users browsing this forum: No registered users and 0 guests