Hi Gamepedia users and contributors! Please complete this survey to help us learn how to better meet your needs in the future. We have one for editors and readers. This should only take about 7 minutes!

Extension:RSSPie

From Gamepedia Help Wiki
Jump to: navigation, search
RSSPie
Version 2.1.0
Author(s)  • Alexia E. Smith and Hydra Wiki Platform Team
Extension link GitLab
Description
RSS extension based on the SimplePie library.

The RSSPie extension fetches and displays RSS feeds, such as a game's news or changes to wiki pages, on a wiki page using a simple tagging format.

Usage[edit | edit source]

Each RSS feed must use its own set of <rss> element tags. There are optional parameters available for the rss opening tag.

Parameters in the RSS tag
Attribute Description
itemTemplate="PageName" Default: Mediawiki:Rss_item_template
 Item template is used to define the display template for individual items in a feed.  It requires a complete page name including namespace if needed.
max="X" Default: 5
 Show only X number of items from a feed.
sort="newest" Sort direction for feed items. Sorts newest first by default and can be set to oldest.
descriptionLength="200" Default: 200
 Truncates long descriptions automatically to the specified character length.
dateFormat="Y/m/d H:i" Default: Y/m/d H:i
 Formats the date using PHP formatting guidelines.  Please see the PHP date documentation for formatting information.
filterIn="example,words" Default: (None)
 Comma delimited list of search words to filter into the display.  If the item in the feed contains any of the word(s) the item will be shown.
filterOut="example,words" Default: (None)
 Comma delimited list of search words to filter out of the display.  If the item in the feed contains any of the word(s) the item will be hidden.  Any feed items that get caught by filterOut will hide regardless if they get caught by the filterIn parameter.

Whitelisting feeds[edit | edit source]

Before a feed can be used, it must be whitelisted. Whitelisting RSS feeds is controlled through the protected Mediawiki:Rss_Whitelist page. Simply insert one filter per line. A fully qualified URL may be entered or a partial URL using * wildcards. Adding * to its own line will whitelist all URLs.

Here are some examples of whitelisting. Note that the comments should not be included.

https://www.gamepedia.com/news.rss -- A specific rss feed on one site
*/news.rss -- Any news.rss feed from any site
https://www.gamepedia.com/*.rss -- Any feeds ending in .rss on one site
https://www.gamepedia.com/* -- Any feeds from one site

Example[edit | edit source]

This example displays a feed from Gampedia's home page with a maximum of six items displayed.

<rss max="6">https://www.gamepedia.com/news.rss</rss>

Welcome to Hell In Hade's Latest Update - 2019/12/05 18:05

The Welcome to Hell update for Hades, an action-RPG rogue-lite game from Supergiant Games, is available now. This update marks the 8th major update since the game launched into early access a year ago...

Phoenix Point Looks to Move the XCOM-like Tactical RPG Forward - 2019/12/03 19:00

Julian Gollop is somewhat of a legend in the business. His most popular contribution to games is X-COM: UFO Defense, one of the most influential tactical RPGs of all time. Firaxis Games revived the ol...

Life is Strange 2: Episode 5 - The Finale is Out! - 2019/12/03 16:00

It’s been a long road for Life is Strange and after almost one and a half years the story of Sean and Daniel finally draws to a close. Will they reach Mexico? Or will Daniel’s powers prove to be their...

What Exactly is Path of Exile 2? Here's What to Expect - 2019/11/18 16:00

Big changes are coming to Path of Exile. Announced this weekend at the first ever ExileCon, developer Grinding Gear Games is bringing new content, visual improvements and sweeping gameplay system chan...

Path of Exile 2, Path of Exile: Mobile Spearhead ExileCon Announcements - 2019/11/15 22:51

At the first Path of Exile convention, developer Grinding Gear Games dropped a slew of major announcements, including a new story campaign titled Path of Exile 2, Path of Exile: Mobile, and a new chal...

Uncharted, Star Wars, and Light Sabers: Star Wars Jedi: Fallen Order is Out! - 2019/11/15 20:00

Star Wars Jedi: Fallen Order, the latest creation of Respawn Entertainment, is now out! The setup is fairly standard for a Star Wars game, but the story is likely to have numerous twists and turns. Th...




Another common use is creating a feed of a wiki's recent changes, like so:

<rss max="5 - M-d-y">https://help.gamepedia.com/api.php?hidebots=1&days=7&limit=50&action=feedrecentchanges&feedformat=atom</rss>

Talk:MediaWiki 1.33 upgrade - 2019/12/05 22:46

← Older revision Revision as of 22:46, 5 December 2019 Line 4: Line 4:       add portuguese language [[pt:MediaWiki 1.33 upgrade]]--[[User:Eduaddad|Eduaddad]] ([[User talk:Eduaddad|tal...

MediaWiki 1.33 upgrade - 2019/12/05 22:46

pt:MediaWiki 1.33 upgrade ← Older revision Revision as of 22:46, 5 December 2019 Line 28: Line 28:       [[de:MediaWiki 1.33 Aktualisierung]]   [[de:MediaWiki 1.33 Aktualisierung...

File:Famille Daby 1920x1080.png - 2019/12/05 17:32

Pcj deleted page File:Famille Daby 1920x1080.png...

File:Raf.png - 2019/12/05 17:32

Pcj deleted page File:Raf.png...

Gillo Daby - 2019/12/05 17:32

Pcj deleted page Gillo Daby content was: "thumb'''''Présentation:''''' '''Prénom réel: Raphaël''' '''Surnom(s): Raph''' '''Nationalité: Canadien'''...", and the only contributor was "Artionss" (tal...

Template for items in feeds[edit | edit source]

NOTE:
Prof hydra.svg Editing the item template is not required, but allows customization on how the information is displayed.

The template parser will substitute five pieces of information for each feed item as needed. {{{link}}} - The URL

{{{title}}} - Item Title

{{{author}}} - Author's Name

{{{date}}} - Epoch Date(Note: Display formatting is handled by Javascript in the browser.)

{{{description}}} - Full description or summarized content.


Default Mediawiki:Rss_item_template template:

<div class='rss_item'>
'''<span class='plainlinks'>[{{{link}}} {{{title}}}]</span> - {{{author}}} - <span class='date_epoch'>{{{date}}}</span>'''
: {{{description}}}
</div>

Configuration settings[edit | edit source]

Variable Default Value Description
$rpCacheDuration Default: 3600 seconds (One Hour) Cache feed information for the specified amount of seconds. Note: Very short durations will increase server load and the number of requests made to the remote host.

Migration from Extension:RSS[edit | edit source]

  • The date attribute was renamed to dateFormat. Please make sure to update the format to a PHP date compatible format.
  • The template attribute was renamed to itemTemplate and is the only template that needs to be edited. Simply copying the contents of Mediawiki:Rss-item to Mediawiki:Rss_item_template should suffice.