Stack2RSS 1.0
A simple web application that creates an RSS feed given an API route.
|
00001 <?php 00002 00003 /// \file index.php Default landing page with usage information. 00004 00005 require 'header.inc'; 00006 00007 ?> 00008 <h2>What exactly <i>is</i> Stack2RSS?</h2> 00009 <p>Stack2RSS is an online feed generator that creates an RSS feed given an API route from the <a href='http://stackapps.com'>Stack Exchange API</a>. These feeds contain the data that is returned from the API.</p> 00010 <h2>Why would I use Stack2RSS?</h2> 00011 <p>Because Stack2RSS always contains the most up to date information from the API, one obvious use for the tool would be subscribing to the questions route to keep up to date on new questions. Because Stack2RSS exposes <b>all</b> routes and parameters in the API, you can create very flexible queries that return only a subset of the information that a route would normally return.</p> 00012 <h2>How do I use it?</h2> 00013 <p>The first place to stop is the <a href='http://api.stackoverflow.com/1.1/usage'>API documentation page</a>, which contains a comprehensive list of routes and expected parameters.</p> 00014 <p>The next step is to construct your feed URL using the following syntax:</p> 00015 <pre><?php echo CONFIG_DOMAIN . CONFIG_DOCUMENT_ROOT; ?>/<span class='param'>{site}</span>/<span class='param'>{method}</span>?<span class='param'>{parameters}</span></pre> 00016 <table> 00017 <tr> 00018 <td class='param-name'>{site}</td> 00019 <td class='param-desc'>the domain name of the Stack Exchange site without the 'http://' prefix (the TLD may be omitted)</td> 00020 </tr> 00021 <tr> 00022 <td class='param-name'>{method}</td> 00023 <td class='param-desc'>the API route to query</td> 00024 </tr> 00025 <tr> 00026 <td class='param-name'>{parameters}</td> 00027 <td class='param-desc'>the parameters for the API route above that will be passed along to the API</td> 00028 </tr> 00029 </table> 00030 <br /> 00031 <p>It should be noted that in addition to the parameters documented in the API, there is one additional parameter that you can include:</p> 00032 <table> 00033 <tr> 00034 <td class='param-name'>api_version</td> 00035 <td class='param-desc'>the version of the API to use when making the query (accepted values are 1.0 and 1.1)</td> 00036 </tr> 00037 </table> 00038 <h2>I'm still confused. Can I see an example?</h2> 00039 <p>Sure! Here is an example that fetches recent questions asked on Server Fault with the tag <span class='sf-tag'>iis</span>.</p> 00040 <pre><?php echo CONFIG_DOMAIN . CONFIG_DOCUMENT_ROOT; ?>/serverfault/questions?tagged=iis&body=true</pre> 00041 <p>You can view the feed <a href="<?php echo CONFIG_DOMAIN . CONFIG_DOCUMENT_ROOT; ?>/serverfault/questions?tagged=iis&body=true">here</a>.</p> 00042 <?php 00043 00044 require 'footer.inc'; 00045 00046 ?>