wiki:subscription_help

You are here: start » wiki » subscription_help
This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

<h1>Subscription Help</h1>
<div class="level1">

<p>
Subscribing to the wiki is straightforward and fairly easy to do. At the bottom of every page is a button labeled "RSS XML FEED". Clicking on this loads "feed.php" which generates a list of recently updated documents on the wiki. By default, the feed format is RSS 1.0. One can then subscribe to the page that is loaded to be informed of updates to the wiki.
<br/>
<br/>

How the feed is generated can be influenced through various URL parameters.
</p>

<span class='np_break'> </span>
<div class="table"><table class="inline">
	<thead>
	<tr class="row0">
		<th class="col0"> Parameter </th><th class="col1"> Valid values </th><th class="col2"> Default </th><th class="col3"> Description </th>
	</tr>
	</thead>
	<tr class="row1">
		<td class="col0"> type </td><td class="col1"> rss, rss1, rss2, atom, atom1 </td><td class="col2"> rss1 </td><td class="col3"> This is the Document-Type the feed is using </td>
	</tr>
	<tr class="row2">
		<td class="col0"> mode </td><td class="col1"> recent, list </td><td class="col2"> recent </td><td class="col3"> What should be exported? The recent changes or a list of documents </td>
	</tr>
	<tr class="row3">
		<td class="leftalign"> num  </td><td class="col1"> <em>any integer</em> </td><td class="col2"> "recent" option<br/>
(currently 20) </td><td class="col3"> How many items should be included (ignored in list mode)</td>
	</tr>
	<tr class="row4">
		<td class="leftalign"> ns   </td><td class="col1"> <em>a namespace</em> </td><td class="col2"> * </td><td class="col3"> which namespace should be exported </td>
	</tr>
	<tr class="row5">
		<td class="col0"> linkto </td><td class="col1"> page, rev, diff </td><td class="col2"> diff </td><td class="col3"> where should the itemlink point to </td>
	</tr>
	<tr class="row6">
		<td class="col0"> minor </td><td class="col1"> true,false </td><td class="col2"> false </td><td class="col3"> Display minor changes or not </td>
	</tr>
</table>
<span class='np_break'> </span>
</div>
</div>

<h2>Examples</h2>
<div class="level2">
<ul>
<li class="level1"> <a href="https://wiki.mcmaster.ca/avenue/oIWIKIofeed.php?type=rss2&num=5cIWIKIc" class="interwiki iw_this" title="https://wiki.mcmaster.ca/avenue/oIWIKIofeed.php?type=rss2&num=5cIWIKIc">feed.php?type=rss2&num=5</a> returns a <a href="http://backend.userland.com/rss" class="urlextern" title="http://backend.userland.com/rss"  rel="nofollow">RSS 2.0</a> feed of the 5 most recent changes</li>
<li class="level1"> <a href="https://wiki.mcmaster.ca/avenue/oIWIKIofeed.php?mode=list&type=atom&linkto=page&ns=wikicIWIKIc" class="interwiki iw_this" title="https://wiki.mcmaster.ca/avenue/oIWIKIofeed.php?mode=list&type=atom&linkto=page&ns=wikicIWIKIc">feed.php?mode=list&type=atom&linkto=page&ns=wiki</a> list all pages in the wiki namespace as an <a href="http://intertwingly.net/wiki/pie/FrontPage" class="urlextern" title="http://intertwingly.net/wiki/pie/FrontPage"  rel="nofollow">ATOM 0.3</a> feed with all items linking to the page directly</li>
</ul>

</div>
Print/export

Printable version
Search

Navigation

Print/export

Tools

QR Code
