History: Feeds User

            !RSS Feeds User: 
A Feeds feed is a summary of a Website's news, files, and other activities that it distributes or ''syndicates'' to other Websites and individual users. Feeds is an acronym for ''Really Simple Syndication''.  Indeed, Feeds files are a nearly painless way to syndicate news and articles from one site to many.  For instance, Feeds files can be used to gather Slashdot news and Freshmeat releases, and display them on your Tiki. 

Tiki is remarkably flexible when it comes to RSS.  It can ''both'' display external Feeds feeds from other sites in user modules and elsewhere ''and'' syndicate its activities (blogs, articles, forums, etc.) to other Websites via RSS.

The configuration of outgoing Feeds feeds is explained in ((Feeds)) main page.  In this document, we'll cover the configuration of incoming Feeds feeds from external sources.

__To access__: Click the __Feeds__ icon {icon name="admin_rss" size="2" title="Image may vary depending on icon set in use."}  on the ((Admin Panels|Admin Panel)) %%% or Access __http://example.org/tiki-admin.php?page=rss__

^
-=Brief summary=-
To add an Feeds feed from another site in to your tikiwiki site:
#Admin > Feeds Modules > Create new Feeds module 
#Complete the form using a descriptive title and proper Feeds URL. Save.
# Note the Feeds Channel ID
# On the wiki page, add {rss id=n} when "n" is the Feeds channel ID. Put a title above. Preview. OR Add in Admin > Modules > User Module, create a new user modules with the Feeds channel ID.
^

!!Create Feeds Modules

First you have to configure the Feeds feeds that you want to use. As an admin-level user, click the __RSS feeds__ link from the __Admin (click!)__ section of the __Application__ menu to enter the __Admin Feeds modules__ screen.

::{img src=http://tikiwiki.org/img/wiki_up//CreateRSSModule.png}::

The __Create a new Feeds module__ panel can be used to create and configure incoming Feeds feeds.  Complete the fields on the form to create a new Feeds module: 

||__Field__|__Description__
Name|Name of the Feeds feed. This could be the website or publisher.
Description|Short description of the Feeds feed.
URL|The URL of the Feeds feed. Normally this will be an XML file. E.g., ''http://slashdot.org/slashdot.rdf''. You can use also TikiWiki feed(ex: hhtP//my.com/tiki-tracker_rss.php?trackerId=1)
Refresh rate|Specify how often Tiki should refresh the feed, from once per minute to once per day. Normally you don't want to refresh the feed each time you display it since that can make the site offering the feed slower. So Tiki caches Feeds feeds and refreshes them using the interval of time you indicate here.
Show feed title|Specify if the feed's title (as defiend by the publisher) should be displayed when you include the Feeds module on a wiki page.
Show publish date|Specify if the publication date for each item in the feed should be displayed when you include the Feeds module on a wiki page.||

The module (the Feeds feed from another site) can then be included in a Tiki wiki page. When you save the new module, Tiki will assign a unique ID to the module and your new module will appear in __RSS channels__. 

::{img src=http://tikiwiki.org/img/wiki_up//RSSChannels.png width=700}::

* In this example we have 2 feeds configured: 
** The Slashdot feed is refreshed each 60 minutes and the URI is http://slashdot.org/slashdot.rdf 
** The Salon feed is refreshed each 360 minutes and the URL is http://xml.newsisfree.com/feeds/83/783.xml
* The righthand column of this table contains __actions__ you can do to your channels:  __remove__, __edit__, and __view__.
**Clicking __view__ previews the feed--showing a bullet list of a site's content.  E.g., from Slashdot:

::{img src=http://tikiwiki.org/img/wiki_up//RSSPreview.png}::

* __RSS Channels__ also shows the last time the feed was updated. Unlike other weak Feeds systems, Tiki won't crunch the cache if it cannot connect to the external site when it needs to refresh it.  If a site goes down, Tiki will show the last cached version of the feed without errors or problems to your site. 
* Note that the __RSS channels__ panel also assigns an __ID__ number to each channel.  You'll use this to import Feeds feeds into your Tiki.

!!RSS own Tikiwiki feeds
* tiki-tracker_rss.php with the following parameters
||trackerId|Id of the tracker
sort_mode|
filterfield|fieldId separated by : you want the items filtered with
filervalue|the associated 'like' filtered values
exactvalue|teh associated exact filtered values
status|o or op or opc or pc or p or c|
noId|y or n|if n do not show the tracker Id information| Default: y||



!! Incorporate Feeds Channels Into Your Tiki

!!! User Modules

Now your Tiki is ready to receive Feeds feeds.  So, how do you insert them into your site?  If you'd like to have them appear as a module in one of your columns, you must create a new user ((module)).  For full information on ((module)) creation, please see ((Module Admin)).

As an admin-level user, click the __Modules__ link from the __Admin (click!)__ section of the __Application__ menu to enter the __Admin Modules__ screen.  Scroll down to the __Create new user module__ panel.

^First time administrators of Tiki may think that this means you are creating a module for a ''new user''.  But no!  You are creating a ''user module'' for the first time--that is, a new one!^

::{img src=http://tikiwiki.org/img/wiki_up//CreateNewModule.png}::

Enter:

* A __Name__ for your module, which will be used to identify it later.
** E.g., ''Slashdot''
* A __Title__, which will appear on screen when the module is displayed.
** E.g., ''Slashdot News''
* __data__, that is, a bit of code--HTML permitted--that incorporates your channel(s) into the module.  RSS-channel data is displayed using the following syntax (remember the __ID__ number that we created for each Feeds channel?): 
** ''{rss id=x max=y}''
** Replace ''x'' with the __ID__ number of the channel.
** Replace ''y'' with the maximum number of items that you want displayed.
*** In this example, we've used the channel-feed __ID__ number for Slashdot on our system and limited it to five items.
** Tiki will automate this process for you:
*** From the __Objects that can be included__ side of the panel, pick a channel from the drop-down list labelled __RSS modules__.  Then click the link, __use rss module__ to automatically insert the channel data into the __data__ box.
****''However'', it will not set a ''max'' number for you.
** You may now embellish the module data by adding HTML tags.  In this example, we wanted the Slashdot headlines to be numbered and so we added a ''ordered list'' tag to it.
*** Tiki provides a basic WYSIWYG (''What You See Is What You Get'') editor to facilitate HTML coding.  Click __Use wysiwyg editor__ to try it out.
*** __Tip:__ You can include more than one Feeds channel in a single module.
* Click __create/edit__ to complete the module-creation step.

Next, you must tell Tiki where to display this new module.  In other words, you must ''assign'' it to the Tiki layout.

::{img src=http://tikiwiki.org/img/wiki_up//AssignNewModule.png}::

* Once you've create your Feeds user module, it'll appear in the __Module name__ drop-down list in the __Assign new module__ panel.  Select it.
* Decide on its __Position__ in the left, center or right column of your Tiki.
* Give it a number to determine its relative __Order__ (top to bottom) in the column.
* Select which __Groups__ will be permitted to see this module.  Select more than one group by Control-clicking.
** Group permissions are explained further in PermissionAdmin.
* Click __preview__ to see what your module will look like.  When you're satisfied, click __assign__.
** For example, here's how our Slashdot module turned out:
::{picture file=img/wiki_up//AssignNewModulePreview.png}::

Once it's been assigned, it'll appear in the __Assigned Modules__ panel, where it may be __edited__, moved __up/down__, or deleted (the __x__ link).

::{img src=http://tikiwiki.org/img/wiki_up//AssignedModule.png}::

!!!Wiki Pages

You can include Feeds channels in a Wiki page through the same syntax as in modules (using ((PluginRSS))):

{CODE()}{rss id=x max=2}{CODE}

!!! Search results as a feed
Since 2011 (r35006 for Tiki 7?) you can access search results as a simple RSS feed using an extra  -+httpaccept+- parameter. Note the plus sign and slash in the mime type -+application/rss+xml+- need to be url encoded.

{CODE()}tiki-searchindex.php?httpaccept=application%2Frss%2Bxml&filter~content=foo{CODE}

!! See also
* ((Article Generator))

!!Alias
*(alias(RSS User))