Diff: Help/RssFeedPlugin

Note: You are viewing an old revision of this page. View the current version.

Differences between version 4 and predecessor to the previous major change of Help/RssFeedPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 4 Last edited on 22 May 2014 3:01 by harold Revert
Older page: version 3 Last edited on 25 December 2011 12:46 by harold Revert
@@ -1,47 +1,54 @@
-!! Synopsis  
+The **~RssFeed** [[Help:WikiPlugin|plugin]] allows to display external RSS feeds.  
  
-A Help:WikiPlugin to display external RSS feeds.  
+== Usage ==  
  
-!! Usage  
-<verbatim>  
- <?plugin RssFeed?>  
- <?plugin RssFeed url=http://somesite.tld/linktofeed.rss ? >  
-</verbatim>  
+{{{  
+<<RssFeed url=http://somesite.tld/linktofeed.rss> >  
+}}}  
  
-!! Plugin Arguments  
-Argument|  
- Default Value|  
- Description  
+== Arguments ==  
  
-url|  
- (empty)|  
- RSS Feed URL  
+{| class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| ** url**  
+ | RSS Feed URL  
+| (empty)  
+ |-  
+| **feed**  
+| RSS Feed Name  
+| (empty)  
+|-  
+| **description**  
+| Description of the RSS Feed  
+| (empty)  
+|-  
+| **maxitem**  
+| Max. number of entries (0 = unlimited)  
+| 0  
+|-  
+| **titleonly**  
+| If //true//, do not display item body (boolean)  
+| false  
+|}  
  
-feed|  
- (empty)|  
- RSS Feed Name  
+== Examples ==  
  
-description|  
- (empty)|  
- Description of the RSS Feed  
+=== ~PhpWikiRss feed for [[PhpWiki:RecentChanges]] ===  
  
-maxitem|  
- 0|  
- Max . number of entries (0 = unlimited)  
+{{{  
+<<RssFeed feed=PhpWikiRss description="PhpWiki:RecentChanges"  
+ url=http://phpwiki .sourceforge.net/phpwiki/RecentChanges?format =rss>>  
+}}}  
  
-!! Sourcecode (since v1.3.8):  
-* [PhpWikiCvs:lib/plugin/RssFeed.php]  
-* [PhpWikiCvs:lib/RssParser.php] _fixed for allow_url_fopen =Off_  
+=== Example as sidebar box ===  
  
-!! Examples  
+[[PhpWikiDemo:sidebar/]]  
  
-* PhpWikiRss _feed for PhpWiki:RecentChanges_  
- <verbatim >  
- <?plugin RssFeed feed=PhpWikiRss description="PhpWiki:RecentChanges"  
- url=http://phpwiki.sourceforge.net/phpwiki/RecentChanges?format=rss ?>  
-</verbatim>  
-  
-* [PhpWikiDemo:sidebar/] _Example as sidebar box_  
-  
---------- ----  
-PhpWikiDocumentation Help:WikiPlugin  
+<noinclude >  
+----  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

version 4

The RssFeed plugin allows to display external RSS feeds.

Usage

<<RssFeed url=http://somesite.tld/linktofeed.rss>>

Arguments

Argument

Description

Default value

url

RSS Feed URL

(empty)

feed

RSS Feed Name

(empty)

description

Description of the RSS Feed

(empty)

maxitem

Max. number of entries (0 = unlimited)

0

titleonly

If true, do not display item body (boolean)

false

Examples

PhpWikiRss feed for PhpWiki:RecentChanges

<<RssFeed feed=PhpWikiRss description="PhpWiki:RecentChanges"
                 url=http://phpwiki.sourceforge.net/phpwiki/RecentChanges?format=rss>>

Example as sidebar box

Page name “PhpWikiDemo:sidebar/” cannot end with a slash.