Syndication
PunBB supports syndication of forums and topics in the RSS 2.0 and Atom 1.0 formats as well as a simple, barebones XML format. Additionally, PunBB can generate (X)HTML markup for display on pages outside the forum install (for example, on a website front page). The syndication features are supported via the extern.php script. The script can be called directly via an URL or from a PHP include command or through the use of Server Side Includes (SSI).
Usage
The scripts behaviour is controlled via the following GET parameters:
- "action". Accepted values are:
- "feed" - show most recent topics/posts (HTML or RSS/Atom)
- "online" - show users online (HTML)
- "online_full" - as above, but includes a full list (HTML)
- "stats" - show board statistics (HTML)
- type:
- "rss" - output as RSS 2.0
- "atom" - output as Atom 1.0
- "xml" - output as simple XML
- "html" - output as HTML (<li>'s)
- fid: One or more forum ID's (comma-separated) to specifically include. If ignored, topics from all guest-readable forums will be pulled.
- nfid: One or more forum ID's (comma-separated) that are to be excluded. E.g. the ID of a a test forum.
- tid: A topic ID from which to show posts. If a tid is supplied, fid and nfid are ignored.
- show: Any integer value between 1 and 50. The default is 15. This parameter is ignored for all but type=html.
Examples
- Show the most recently active topics from all guest-readable forums as an RSS 2.0 feed:
http://example.com/forums/extern.php?action=feed&type=rss - Show the most recently active topics from forums with ID 5, 6 and 7 as an Atom 1.0 feed:
http://example.com/forums/extern.php?action=feed&type=atom&fid=5,6,7 - Show the most recently active topics from all guest-readable forums except forum with ID 12 as an RSS 2.0 feed:
http://example.com/forums/extern.php?action=feed&type=rss&nfid=12 - Show users online:
http://example.com/forums/extern.php?action=online - Show users online with full listing of users:
http://example.com/forums/extern.php?action=online_full - Show board statistics:
http://example.com/forums/extern.php?action=stats
