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>

Defeat the Immortals in Death's Gambit - 2018/08/14 15:00

Working as the right hand man to Death themself is a pretty big task. Especially since this was one of the Ghost Rider-type bargains where you maybe made a bad choice in a desperate moment and now the...

Keep Calm and Pop Those Joy Pills in We Happy Few - 2018/08/10 17:00

Real life getting you down? Wish you could find a way to keep a smile on your face at all times so you don't have to worry about the low points of everyday life? In Compulsion Games' trippy dystopian...

Weekly Official Wiki Roundup: Elteria Adventures and Rapture Rejects - 2018/08/10 16:00

The gaming world has been relatively quiet over the past week, but there are a few shining gems out there that definitely deserve your attention, like, say, a topdown battle royale to get into heaven?...

Path of Exile: Delve Will Bring New Skills, Items, and an Infinitely Deep (and Dark) Dungeon - 2018/08/09 21:00

Path of Exile players will soon have the opportunity to descend into the deepest, darkest parts of Wraeclast come August 31. As part of the upcoming Delve expansion, those who can effectively wield th...

Post Scriptum Recounts World War II With Meticulous Attention to Detail - 2018/08/09 16:00

Since March of 2016, Periscope Games has been developing what they hoped would become the catalyst for a new wave of hardcore, historically accurate shooters based on World War II. Modders from the Ba...

Be the Master of Your Own Tiny World in Deiland - 2018/08/09 15:00

Back when the universe was still young, small, magic planets were dispersed throughout it. Children were tasked to travel to these worlds to search for magic crystals. As Arco, you search the eponymou...


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