Note: You are currently viewing documentation for Moodle 3.3. Up-to-date documentation for the latest stable version of Moodle is probably available here: Remote RSS feeds block.

Remote RSS feeds block: Difference between revisions

From MoodleDocs
 
(23 intermediate revisions by 10 users not shown)
Line 1: Line 1:
The '''RSS feeds''' block enables [[RSS]] feeds from external websites to be displayed within Moodle. As the information on the other site (e.g. news headlines, recently added documents) is updated the block will update to show the latest info.
{{Blocks}}The '''RSS feeds''' block enables [[RSS]] feeds from external websites to be displayed within Moodle. As the information on the other site (for example, news headlines or recently added documents) is changed the block will update to show the latest information.


==Configure RSS Feeds (''Configure this block'' tab)==
[[File:Rssexample.png]]


After adding an RSS feed block, you will need to configure which feeds will be displayed, by clicking the edit icon for the block.
 
One or more RSS feeds can be added to a course by selecting them from an existing list.  Site and course home pages are common places to place an RSS feed block(s).
 
==Configuring RSS feeds block==
 
After adding an RSS feed block, select the edit icon on the Remote News Feed block.  The default will open up the '''Configure this block''' tab.


;Display each link's description?
;Display each link's description?
Line 20: Line 25:
:Each article headline should link to the full article, but you can also display a link to the original site where available.
:Each article headline should link to the full article, but you can also display a link to the original site where available.


;Diplay channel image?
;Show channel image?
:Some feeds supply an image or logo from the original site which you can choose to display when available.
:Some feeds supply an image or logo from the original site which you can choose to display when available.


==Add/Manage RSS feeds (''Manage all my feeds'' tab)==
==Add/Manage all RSS feeds ==
All the Moodle site's RSS feeds can be managed on the ''Manage all my feeds'' tab in the RSS News Feed edit menu. The site administrator may give other roles permission to use this tab.  This tab creates a list of RSS feeds that can be selected for display in every course on the Moodle site.
 
Copy and paste (or type) the URL address of the RSS feed in the space provided. This the generating site's actual RSS page address. For example here is a Moodle RSS feed address : http://moodle.org/rss/file.php/1/1/forum/1/rss.xml
 
Adding a custom title will take the place of the one supplied by the generating site.There is a validation tool included to confirm the feed URL is accurate.
 
When checked, the Shared Feed checkbox makes the feed available (although not necessarily visible) to all courses on the Moodle site.  This would be useful, for example, when a college has an urgent announcements feed that would be of interest to all students, regardless of the Moodle course in which they are enrolled.  Leave unchecked if the feed is of interest only to a single course.
 
Click the ''Add'' button to submit the feed.
 
==Site administration settings==
 
The RSS feeds block has some settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Blocks > RSS client''.


The site [[administrator]] may configure the block to allow [[Teacher|teachers]] to add/manage feeds, otherwise you will have to contact an administrator to add a new feed.
* ''block_rss_client_num_entries'' - The default number of entries to show per feed shown in the block. This can be overridden when you actually set up a block in a course.
* ''block_rss_timeout'' - The time in minutes between a reread of the feed by Moodle. Since some feeds on busy sites can take long to load, it can slow down the load of your course page. Therefore it is wise to set this time rather high, so only every now and then a visitor of your course is the victim of the slow remote server. Time is in minutes here.


Adding a new feed requires you to copy and paste (or type) the URL address of the RSS feed in the space provided. You will find this on the original site generating the feed. You can then choose a custom title if you would prefer to use your own in place of the one generated by the feed.
==See also==


Click the ''Add'' button to submit the feed. There is a validation tool included to confirm the feed URL is accurate.  
* [[RSS feeds]]
*[http://www.youtube.com/watch?v=wiwSZNgXuzo RSS feeds and how to add them to your course video]
*[http://tracker.moodle.org/browse/MDL-31599 RSS feeds on front page not working]


NB: To add the new feed to your course you will have to configure an RSS feed block to include the new feed.
[[Category:RSS]]
[[Category:Site administration]]


[[Category:Teacher]]
[[de:RSS-Client-Block]]
[[Category:Block]]
[[eu:RSS_jarioak_blokea]]
[[fr:Bloc Fil RSS]]
[[es:Bloque de canales RSS remotos]]

Latest revision as of 13:34, 16 June 2015

The RSS feeds block enables RSS feeds from external websites to be displayed within Moodle. As the information on the other site (for example, news headlines or recently added documents) is changed the block will update to show the latest information.

Rssexample.png


One or more RSS feeds can be added to a course by selecting them from an existing list. Site and course home pages are common places to place an RSS feed block(s).

Configuring RSS feeds block

After adding an RSS feed block, select the edit icon on the Remote News Feed block. The default will open up the Configure this block tab.

Display each link's description?
Choose yes or no from the drop-down menu to determine whether the block will display a description of each article, or just the title of the article. Both the title and description are generated by the external feed.
Max number of entries to show per block
Determines how many articles will be displayed. The most recent will be displayed first.
Choose the feeds to make available
Check the box next to each feed you would displayed in this block. You can have more than one instance of the RSS feed block if you would like to break them up.
Title
Enter a title for the block. If you leave this blank a title will be taken from the RSS feeds, which can be confusing if there are multiple feeds in one block.
Display a link?
Each article headline should link to the full article, but you can also display a link to the original site where available.
Show channel image?
Some feeds supply an image or logo from the original site which you can choose to display when available.

Add/Manage all RSS feeds

All the Moodle site's RSS feeds can be managed on the Manage all my feeds tab in the RSS News Feed edit menu. The site administrator may give other roles permission to use this tab. This tab creates a list of RSS feeds that can be selected for display in every course on the Moodle site.

Copy and paste (or type) the URL address of the RSS feed in the space provided. This the generating site's actual RSS page address. For example here is a Moodle RSS feed address : http://moodle.org/rss/file.php/1/1/forum/1/rss.xml

Adding a custom title will take the place of the one supplied by the generating site.There is a validation tool included to confirm the feed URL is accurate.

When checked, the Shared Feed checkbox makes the feed available (although not necessarily visible) to all courses on the Moodle site. This would be useful, for example, when a college has an urgent announcements feed that would be of interest to all students, regardless of the Moodle course in which they are enrolled. Leave unchecked if the feed is of interest only to a single course.

Click the Add button to submit the feed.

Site administration settings

The RSS feeds block has some settings which may be changed by an administrator in Settings > Site administration > Plugins > Blocks > RSS client.

  • block_rss_client_num_entries - The default number of entries to show per feed shown in the block. This can be overridden when you actually set up a block in a course.
  • block_rss_timeout - The time in minutes between a reread of the feed by Moodle. Since some feeds on busy sites can take long to load, it can slow down the load of your course page. Therefore it is wise to set this time rather high, so only every now and then a visitor of your course is the victim of the slow remote server. Time is in minutes here.

See also