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: 100% Orange Juice, Insurgency: Sandstorm, and More! - 2019/01/18 19:00

Ready for another heaping helping of awesome new games? You know what time it is! It’s another exciting installment of Gamepedia’s Official Wiki Round-Up! We’ve got quite the selection of titles...

Build Your Own Space Hangout with Meeple Station - 2019/01/17 17:00

Ever wanted to build and manage your very own space station with inhabitants and staff you're in charge of? Who hasn't, right? You can do all that and more with Meeple Station, available now on PC and...

Restore the Balance in Rift Keeper - 2019/01/15 00:00

Fans of roguelite's are currently enjoying a golden age with countless quality games being released. Rift Keeper looks to be another great addition to the list....

Weekly Official Wiki Roundup: ATLAS, Cheapshot, and More! - 2019/01/11 17:00

Welcome to 2019, loyal Gamepedia readers! We're happy to be here with you in another new year, where we've got plenty of awesome new Official Wikis to bring your way....

Weekly Official Wiki Roundup: Creatures of Enderia, Furtual, and More! - 2018/12/21 16:00

The Gamepedia crew are running around, eggnog in hand and gift wrap flying everywhere – the holidays are pretty much here! But before we go off on a brief break, we thought we'd bring you another we...

Weekly Official Wiki Roundup: Eternity: The Last Unicorn, Shardhunters, and More! - 2018/12/14 18:00

Have you gotten all your holiday shopping finished yet? Looking forward to walking in a winter wonderland? Us too, and we can't wait to spend it with our friends and family. But we've still got a litt...

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.