(See also)
(merge from Help:RSS tags - note that only the RSS tag works now.)
Line 1: Line 1:
Displaying a feed in Appropedia can be accomplished with a widget or with RSS tags.
Displaying a feed in Appropedia can be accomplished with a widget or with RSS tags.
== Using [[Help:RSS tags|RSS tags]] ==
:''See also [[Help:RSS tags]].''
Simplest example:
<pre>
<rss>http://blogs.appropedia.org/feed/</rss>
</pre>
<rss>http://blogs.appropedia.org/feed/</rss>
With set number of posts:
<pre>
<rss number=3>http://feeds.feedburner.com/afrigadget</rss>
</pre>
<rss number=3>http://feeds.feedburner.com/afrigadget</rss>
===RSS tag options===
You can add more than one feed in a single ''<nowiki><rss></nowiki>'' tag to have them display in columns. Do so by adding "|" between the feed urls. Thus, ''<nowiki><rss>firsturl|secondurl|thirdurl</rss></nowiki>'' will create a reader with 3 columns, displaying items from all 3 feeds. Inside the ''<nowiki><rss></nowiki>'' tag you can include optional settings, which are detailed below:
;''number''
:By default, the reader will display all the items in the feed. If you want to display up to a maximum of a certain number of items, then add ''number='''n''''' (where '''n''' is the max number) inside the rss tag: ''<nowiki><rss number=10>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss></nowiki>'' will display the last 10 stories from BBC World.
;''time''
:By default, the reader will take the value of ''$egCacheTime'' as the amount of time (in seconds) between each local caching of the RSS feed. If you want a certain feed to refresh its cache more or less frequently, then add ''time='''t''''' (where '''t''' is the refresh time in seconds) inside the rss tag: ''<nowiki><rss time=7200>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss></nowiki>'' will refresh the cache of stories from BBC World every 7200 seconds (2 hours). <br />The max and min time allowed for the time argument is governed by ''$egCacheTimeMin'' and ''$egCacheTimeMax'' in ''LocalSettings.php''. If the specified time falls outside this range, then it will revert to the default ''$egCacheTime'' value.
;''desc=off''
:Hides the description provided by the feed.
;''width''
:If set to a legal value (between ''$egWidthMin'' and ''$egWidthMax'') it turns the RSS section into a floating div, alligned to the right, of the width specified (in pixels)
;''title=off''
:Hides the title (and description in <code>desc=off</code> of the feed.
==Bugs==
E.g. 1 - the following code:
<pre>
<rss number=5>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss>
</pre>
Creates:
<rss number=5>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss>
The feed works elsewhere, so it's not clear why it breaks here.
<nowiki><rss number=5>http://blogs.appropedia.org/feed/</rss></nowiki>
==See also==
*See http://www.mediawiki.org/wiki/Extension:RSS_Reader#The_.3Crss.3E_tag for the most up to date information on reading RSS feeds.


== Using a "widget" ==
== Using a "widget" ==
'''BROKEN''' - use the RSS tag instead.
This method appears to be broken - no output is given. The code ([[Widget:Feed]]) relies on an [http://feed2js.org/ external service] which is possibly not working the same way now.


:''See also [[Appropedia:Widgets]].''
:''See also [[Appropedia:Widgets]].''
Line 28: Line 81:
}}
}}


== Using [[Help:RSS tags|RSS tags]] ==
:''See also [[Help:RSS tags]].''
<pre>
<rss number=3>http://blogs.appropedia.org/feed/</rss>
</pre>
<rss number=3>http://blogs.appropedia.org/feed/</rss>




[[Category:Appropedia help|{{PAGENAME}}]]
[[Category:Appropedia help|{{PAGENAME}}]]

Revision as of 05:27, 6 June 2010

Displaying a feed in Appropedia can be accomplished with a widget or with RSS tags.

Using RSS tags

See also Help:RSS tags.

Simplest example:

<rss>http://blogs.appropedia.org/feed/</rss>

<rss>http://blogs.appropedia.org/feed/</rss>

With set number of posts:

<rss number=3>http://feeds.feedburner.com/afrigadget</rss>

<rss number=3>http://feeds.feedburner.com/afrigadget</rss>

RSS tag options

You can add more than one feed in a single <rss> tag to have them display in columns. Do so by adding "|" between the feed urls. Thus, <rss>firsturl|secondurl|thirdurl</rss> will create a reader with 3 columns, displaying items from all 3 feeds. Inside the <rss> tag you can include optional settings, which are detailed below:

number
By default, the reader will display all the items in the feed. If you want to display up to a maximum of a certain number of items, then add number=n (where n is the max number) inside the rss tag: <rss number=10>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss> will display the last 10 stories from BBC World.
time
By default, the reader will take the value of $egCacheTime as the amount of time (in seconds) between each local caching of the RSS feed. If you want a certain feed to refresh its cache more or less frequently, then add time=t (where t is the refresh time in seconds) inside the rss tag: <rss time=7200>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss> will refresh the cache of stories from BBC World every 7200 seconds (2 hours).
The max and min time allowed for the time argument is governed by $egCacheTimeMin and $egCacheTimeMax in LocalSettings.php. If the specified time falls outside this range, then it will revert to the default $egCacheTime value.
desc=off
Hides the description provided by the feed.
width
If set to a legal value (between $egWidthMin and $egWidthMax) it turns the RSS section into a floating div, alligned to the right, of the width specified (in pixels)
title=off
Hides the title (and description in desc=off of the feed.

Bugs

E.g. 1 - the following code:

<rss number=5>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss>

Creates: <rss number=5>http://www.appropedia.org/index.php?title=Special:Recentchanges&feed=rss</rss>

The feed works elsewhere, so it's not clear why it breaks here.

<rss number=5>http://blogs.appropedia.org/feed/</rss>


See also


Using a "widget"

BROKEN - use the RSS tag instead.

This method appears to be broken - no output is given. The code (Widget:Feed) relies on an external service which is possibly not working the same way now.

See also Appropedia:Widgets.

E.g.:

{{#widget:Feed
|feedurl=http://blogs.appropedia.org/feed/
|chan=y
|num=3
|desc=50
|date=n
|targ=y
}}

Creates:

Cookies help us deliver our services. By using our services, you agree to our use of cookies.