| -Resource Description Framework (RDF) Site Summary __(RSS)__ is a lightweight multipurpose extensible metadata description and syndication format. It allows users to read headlines from your site with a dedicated RSS reader.
|
| +{maketoc} |
| +__Bitweaver's RSS package both generates RSS feeds ''from your site'', and lets you include RSS feeds from other sites ''into your site''.__ Generally speaking, Resource Description Framework (RDF) Site Summary (RSS) allows users to read headlines from your site with a dedicated application. As of bitweaver version 2, the RSS package uses [http://simplepie.org/|SimplePie] library to process feeds. |
|
|
| -__The RSS Package both generates RSS feeds for you site, and lets you suck in RSS feeds from other sites.__
|
| +! Feeds from your site |
| +Feeds ''from'' your site are listed at ''http://yoursite.com/rss/''. Go to ''Administration > RSS > RSS Settings'' to control which content is available as RSS feeds in which formats. |
|
|
| -!!Finding Feeds Of Your Site
|
| -You can find the rss feeds of your site here:
|
| -http://www.yoursite.com/bitweaver/rss/wiki_rss.php
|
| +! Importing feeds into your site |
| +# go to Administration > RSS > RSS Modules |
| +# insert the details from another site's RSS feed |
| +# now, there are 2 ways to display the streams on your own site |
| +** __display feeds in wiki pages__: Upon editing a wiki page, insert the following code and fill in the appropriate parameters (at least ''id''). If the feature ''wiki plugin help'' is enabled, it shows details and examples like the one below. |
| +** __display feeds in columns__: To include a feed from another site into one of your columns (or top or bottom areas), go to ''Administration > Layout'' and find your RSS module in the dropdown of available modules. After you added it, insert parameters into the according input field. The module accepts multiple feeds in one – you can mix items from different feeds and have them displayed by most recently posted. To do that, pass in more values to the ''id'' parameter: ''id=1,2,4''. |
|
|
| -!!Importing RSS Feeds Into Your Site
|
| -You can add RSS feeds to your site by going here:
|
| -http://www.yoursite.com/bitweaver/rss/admin/admin_rssmodules.php
|
| +! Parameters |
| +;__id__: the id of the RSS feed as shown on the admin page |
| +;__max__: number of feed items to display, example: ''max=10'', (standard: 10) |
| +;__desc_length__: if set, a short description of N characters is added to each feed item, example: ''desc_length=200'' |
| +;__desc__: if ''desc'' is set and no desc_length is given, the full description/content of each item is shown, example: ''desc=y'' |
|
|
| -!!!Display them on Wiki Pages or in Columns
|
| -Once you have added a connection to a feed into the site engine, you can display those feeds in both Wiki pages, and in side panel Modules. Both use the same plugin format:
|
| -
|
| -{code} <curlybrace> rss id=n max=n <curlybrace> {/code}
|
| -
|
| -Where id is the id of the rss feed (can be found on the admin page) and max is the number of items to display. There is an example in the Wiki plugin help, which you can see when editing a wiki page. The layout module accepts multiple feeds in one, so that if you would like to mix items from different feeds and have them displayed by most recently posted, you can! Just pass in more values to the id param, for example id=1,2,4
|
| -
|
| -As of bitweaver version R2, the RSS Package uses [http://simplepie.org/|SimplePie] library to process feeds. |
| +! Example |
| +{code} |
| +{RSS id=1,2,3 max=15 desc=y desc_length=200} |
| +{/code} |