Extension:RSSPie

From Gamepedia Help Wiki
Jump to: navigation, search

The RSSPie extension fetches and displays RSS feeds 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.

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>

Weekly Official Wiki Roundup: Stranded Deep, Cartoon Strike, and Spacequests.io - 2018/06/15 16:00

Oh, we've put on our shoes and we're ready for the weekend here at Gamepedia, just like that catchy pop song goes. Before we head out and soak up all the awesome gaming goodness from this week's caval...

Life Finds a Way in Dinosaur Park Simulator Jurassic World Evolution - 2018/06/12 15:00

Dinosaur fans have been sitting and watching the Jurassic Park franchise on the big screen for decades. On the small screen, players have taken on the role of hunters, trappers, and even the dinos th...

Weekly Official Wiki Roundup: Adventure Time: Pirates of the Enchiridion, DARCO - Reign of Elements, and More! - 2018/06/08 15:00

It's true that everybody's workin' for the weekend, but at Gamepedia we're also working to make sure you've got the freshest gaming content around to get you through yours. With that said, it's time f...

Vampyr Will Take a Bite Out of Your Own Moral Code - 2018/06/05 17:12

From Dontnod Entertainment, the studio responsible for both Remember Me and Life is Strange, comes Vampyr, an action-RPG that tackles the romantic monstrosity of vampirism....

Push the Demon Hordes Back into the Warp in Warhammer 40,000 Inquisitor - Martyr - 2018/06/05 15:00

There has been no greater transition from table top to digital screens than Games Workshop's Warhammer 40K. The uber goth sci-fi world translates almost perfectly to the realm of video games. There ar...

Weekly Official Wiki Roundup: Underworld Ascendant, MachiaVillain, and MapleStory M - 2018/06/01 19:00

It's the freakin' weekend and we're about to have us some fun here at Gamepedia! But before we do, we've got another roundup of all the latest games to have received Official Wiki status. Come take a...


Whitelisting Feeds[edit | edit source]

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.

https://www.gamepedia.com/news.rss
*/news.rss
https://www.gamepedia.com/*.rss

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.
Promotional Content