(reformatted for the wiki.) |
mNo edit summary |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}}A feature of SMF is its news feeds. However, many people are unaware of how many options there are, or that this is even available. Below is a list of available options and what they do: | ||
==Enable the Feeds== | ==Enable the Feeds== | ||
Admin -> News and Newsletters -> Settings | This should be enabled by default, but you can check by going to ''Admin -> News and Newsletters -> Settings'' and ensuring that there is a tick in box next to "Enable XML/RSS News". | ||
The "Maximum post length" value determines how many characters of a post are output in the feeds. The default value (255) should be sufficient in most cases. | |||
The "Maximum post length" value determines how many characters of a post are output in the feeds. The default value (255) | |||
==URL options for showing XML content== | ==URL options for showing XML content== | ||
Line 15: | Line 13: | ||
*'''type=rss2''' - RSS 2.0 | *'''type=rss2''' - RSS 2.0 | ||
The default feed is the | The default feed is the five most recent posts: | ||
http://www.simplemachines.org/community/index.php?action=.xml | http://www.simplemachines.org/community/index.php?action=.xml | ||
Line 23: | Line 21: | ||
Displays the most recent posts that you can see: | Displays the most recent posts that you can see: | ||
*'''Sub-action''': recent | *'''Sub-action''': recent | ||
*'''Default''': | *'''Default''': shows the five most recent posts | ||
*'''Available options''': | *'''Available options''': | ||
**'''limit=x''' - display the "x" most recent posts (if number is less than | **'''limit=x''' - display the "x" most recent posts (if the number is less than five, it will display five. If number is larger than 255, it will display 255). | ||
**'''board=y''' - display only the recent posts from board "y" | **'''board=y''' - display only the recent posts from board "y". | ||
**'''boards=x,y,z''' - display only the recent posts from the specified boards | **'''boards=x,y,z''' - display only the recent posts from the specified boards. | ||
**'''c=x or c=x,y,z''' - display only the recent posts from boards in the specified category/categories | **'''c=x or c=x,y,z''' - display only the recent posts from boards in the specified category/categories. | ||
*'''Example''': <nowiki>http://www.simplemachines.org/community/index.php?action=.xml;sa=recent;board=72;limit=10</nowiki> | *'''Example''': <nowiki>http://www.simplemachines.org/community/index.php?action=.xml;sa=recent;board=72;limit=10</nowiki>. | ||
====News==== | ====News==== | ||
Line 35: | Line 33: | ||
*'''Sub-action''': news | *'''Sub-action''': news | ||
*'''Available options''': | *'''Available options''': | ||
**'''limit=x''' - display only "x" items | **'''limit=x''' - display only "x" items. | ||
**'''board=y''' - display only news topics from board "y" | **'''board=y''' - display only news topics from board "y". | ||
**'''boards=x,y,z''' - display only news topics from the specified boards | **'''boards=x,y,z''' - display only news topics from the specified boards. | ||
**'''c=x or c=x,y,z''' - display only news topics from boards in the specified category/categories | **'''c=x or c=x,y,z''' - display only news topics from boards in the specified category/categories. | ||
*'''Example''': <nowiki>http://www.simplemachines.org | *'''Example''': <nowiki>http://www.simplemachines.org/index.php?action=.xml;sa=news;board=1;limit=10</nowiki>. | ||
====Members==== | ====Members==== | ||
Line 45: | Line 43: | ||
*'''Sub-action''': members | *'''Sub-action''': members | ||
*'''Available options''': | *'''Available options''': | ||
**'''limit=x''' - display only the "x" most recent members | **'''limit=x''' - display only the "x" most recent members. | ||
*'''Example''': <nowiki>http://www.simplemachines.org/community/index.php?action=.xml;sa=members;limit=10</nowiki> | *'''Example''': <nowiki>http://www.simplemachines.org/community/index.php?action=.xml;sa=members;limit=10</nowiki>. | ||
====Profile==== | ====Profile==== | ||
Line 52: | Line 50: | ||
*'''Sub-action''': profile | *'''Sub-action''': profile | ||
*'''Required option''': | *'''Required option''': | ||
**'''u=x''' - display the profile info for user whose ID is "x" | **'''u=x''' - display the profile info for user whose ID is "x". | ||
*'''Example''': <nowiki>http://www.simplemachines.org/community/index.php?action=.xml;sa=profile;u=150</nowiki> | *'''Example''': <nowiki>http://www.simplemachines.org/community/index.php?action=.xml;sa=profile;u=150</nowiki>. | ||
[[category:FAQ]] | [[category:FAQ]] |
Latest revision as of 10:18, 3 June 2016
A feature of SMF is its news feeds. However, many people are unaware of how many options there are, or that this is even available. Below is a list of available options and what they do:
Enable the Feeds
This should be enabled by default, but you can check by going to Admin -> News and Newsletters -> Settings and ensuring that there is a tick in box next to "Enable XML/RSS News". The "Maximum post length" value determines how many characters of a post are output in the feeds. The default value (255) should be sufficient in most cases.
URL options for showing XML content
All of the XML content is accessed via the ".xml" action... Other formats can be achieved by adding one of the following to the URL:
The default feed is the five most recent posts: http://www.simplemachines.org/community/index.php?action=.xml
Sub-actions
Add sa=<sub-action> to the URL query string to use these sub-actions.
Recent Posts
Displays the most recent posts that you can see:
- Sub-action: recent
- Default: shows the five most recent posts
- Available options:
- limit=x - display the "x" most recent posts (if the number is less than five, it will display five. If number is larger than 255, it will display 255).
- board=y - display only the recent posts from board "y".
- boards=x,y,z - display only the recent posts from the specified boards.
- c=x or c=x,y,z - display only the recent posts from boards in the specified category/categories.
- Example: http://www.simplemachines.org/community/index.php?action=.xml;sa=recent;board=72;limit=10.
News
Displays the first post from the most recent topics that you can see:
- Sub-action: news
- Available options:
- limit=x - display only "x" items.
- board=y - display only news topics from board "y".
- boards=x,y,z - display only news topics from the specified boards.
- c=x or c=x,y,z - display only news topics from boards in the specified category/categories.
- Example: http://www.simplemachines.org/index.php?action=.xml;sa=news;board=1;limit=10.
Members
Displays most recent members:
- Sub-action: members
- Available options:
- limit=x - display only the "x" most recent members.
- Example: http://www.simplemachines.org/community/index.php?action=.xml;sa=members;limit=10.
Profile
Displays the "profile summary" data in a nice XML feed for the specified user:
- Sub-action: profile
- Required option:
- u=x - display the profile info for user whose ID is "x".
- Example: http://www.simplemachines.org/community/index.php?action=.xml;sa=profile;u=150.