Hello there! We are conducting a survey to better understand the user experience in making a first edit. If you have ever made an edit on Gamepedia, please fill out the survey. Thank you!

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>

UnderMine Is Launching Into Early Access On August 20th! - 2019/08/17 02:09

UnderMine is an action-adventure rogue-like RPG where players take on the role of a lowly peasant who is sent down into the "UnderMine" by Arkanos the Archmage to investigate recent earthquake activit...

Resist the Evil Mind Flayers in Neverwinter: Uprising - 2019/08/13 19:00

The long-running, Dungeons and Dragons-themed MMO, Neverwinter, has been basking in the success of what has been its biggest expansion launch ever. Earlier this year, players got to explore one of the...

Ready Yourself for an Outlaw’s Career in the Rebel Galaxy! - 2019/08/13 15:00

Rebel Galaxy Outlaw has just hit the market, giving everyone and their moms a chance to step into the shoes of Juno Markev, a down-on-her luck pilot on the fringes of space civilization. Saddled with...

Face The Final Boss In The Big Bad Update For Hades - 2019/08/07 19:00

The Big Bad Update for Hades has just released. This update adds the last major zone to the game, an epic final boss fight, new enemies, music, boons, and a tool for getting rid of unwanted boons! Alo...

Take On the Cold War as CEO in Market Dominion - 2019/08/07 15:00

It's 1960. You've just been signed on as the CEO of a brand-new company that's looking to completely dominate the market in the midst of tensions between the United States and the Soviet Union. With t...

Plagues and Mummies Haunt Hearthstone in the Saviors of Uldum Expansion - 2019/08/06 19:00

Hearthstone has come a long way from the in-house side project it started as. It’s consistently the most watched card game on Twitch and it’s intensely popular at the competitive level. It also seems...




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:Writing templates - 2019/08/19 20:16

‎Limit on number of parameters: re ← Older revision Revision as of 20:16, 19 August 2019 Line 10: Line 10:   == Limit on number of parameters ==   == Limit on number of parameters =...

Talk:Requesting extensions - 2019/08/19 15:31

← Older revision Revision as of 15:31, 19 August 2019 (One intermediate revision by the same user not shown) Line 10: Line 10:       : We need this on [https://wildstar.gamepedia.com W...

Talk:Writing templates - 2019/08/19 14:58

← Older revision Revision as of 14:58, 19 August 2019 Line 7: Line 7:   There should be a short section here describing how to write template documentation. [[User:TheSatanicSanta|TheSatan...

Galactic Empire of Funk - 2019/08/19 14:01

GRASP bot deleted page Galactic Empire of Funk GRASP: Deleted for "Game specific", requested by MarkusRost....

Category:Reading - 2019/08/19 12:58

← Older revision Revision as of 12:58, 19 August 2019 Line 1: Line 1:   [[Category:Help]]   [[Category:Help]]       + [[de:Kategorie:Lesen]]   [[fr:Catégorie:Lecture]]   [[fr:Catég...

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.