RSS feeds block: Difference between revisions

From MoodleDocs
m (Tsala moved page Remote RSS feeds block to RSS feeds block over redirect: simpler title)
mNo edit summary
 
Line 1: Line 1:
{{Blocks}}
{{Blocks}}
{{Note|The Remote RSS feeds block is disabled in new installations of Moodle 4.x.}}
{{Note|The RSS feeds block is disabled in new installations of Moodle 4.x.}}
==Enabling the Remote RSS feeds block==
==Enabling the RSS feeds block==
An administrator can enable the block from ''Site administration > Plugins > Blocks'' and opening the 'eye' of Remote RSS feeds.
An administrator can enable the block from ''Site administration > Plugins > Blocks'' and opening the 'eye' of RSS feeds.


From the Settings link, certain defaults may be specified:
From the Settings link, certain defaults may be specified:
* ''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_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.
* ''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.
==Using the Remote RSS feeds block==
==Using the RSS feeds block==
A course teacher can add the block by enabling Edit mode, and adding the Remote RSS feeds block from the block drawer.
A course teacher can add the block by enabling Edit mode, and adding the RSS feeds block from the block drawer.
==Configuring the Remote RSS feeds block==
==Configuring the RSS feeds block==
After adding the block, click the action menu and select Configure Remote news feed blcok.  
After adding the block, click the action menu and select Configure block.  
;Display each link's description?
;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.
: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.
Line 29: Line 29:
: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 all RSS feeds ==
==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.
All the Moodle site's RSS feeds can be managed on the ''Manage all my feeds'' tab in the RSS feeds 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
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

Latest revision as of 10:41, 31 July 2024

Note: The RSS feeds block is disabled in new installations of Moodle 4.x.

Enabling the RSS feeds block

An administrator can enable the block from Site administration > Plugins > Blocks and opening the 'eye' of RSS feeds.

From the Settings link, certain defaults may be specified:

  • 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.

Using the RSS feeds block

A course teacher can add the block by enabling Edit mode, and adding the RSS feeds block from the block drawer.

Configuring the RSS feeds block

After adding the block, click the action menu and select Configure block.

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 feeds 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.

See also

Showing announcements from a course on the site homepage with an RSS feeds block (forum discussion)