Diff: Help/RssFeedPlugin

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

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

Other diffs: Previous Revision, Previous Author

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

version 3

Synopsis

A Help:WikiPlugin to display external RSS feeds.

Usage

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

Plugin Arguments

Argument Default Value Description
url (empty) RSS Feed URL
feed (empty) RSS Feed Name
description (empty) Description of the RSS Feed
maxitem 0 Max. number of entries (0 = unlimited)

Sourcecode (since v1.3.8):

Examples

  <?plugin RssFeed feed=PhpWikiRss description="PhpWiki:RecentChanges"
                   url=http://phpwiki.sourceforge.net/phpwiki/RecentChanges?format=rss ?>
  • Page name “PhpWikiDemo:sidebar/” cannot end with a slash. Example as sidebar box

PhpWikiDocumentation Help:WikiPlugin