1
0
forked from HPR/hpr_generator

Documentation Update

This commit is contained in:
2026-06-02 22:22:19 +02:00
parent 130588bad9
commit 431ec2b946
2 changed files with 82 additions and 51 deletions

View File

@@ -1,6 +1,6 @@
<!--% page_title = "HPR ~ Subscribe to our feeds" %-->
<h1>RSS Syndication</h1>
<h2>Subscribe to our Feeds</h2>
<h1>RSS Syndication<a href="<!--% absolute_path(baseurl) %-->syndication.html">.</a></h1>
<h2 id="subscribe">Subscribe to our Feeds<a href="<!--% absolute_path(baseurl) %-->syndication.html">.</a></h2>
<p>
Great that you want to listen. Have a look below at the feeds that best suite your listening habits.
</p>
@@ -8,7 +8,7 @@
<article>
<header>
<hgroup>
<h2><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> The Community News Summary</h2>
<h2 id="feed_community_news"><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> The Community News Summary<a href="<!--% absolute_path(baseurl) %-->syndication.html#feed_community_news">.</a></h2>
<p>One show a month</p>
</hgroup>
</header>
@@ -28,7 +28,7 @@
<article>
<header>
<hgroup>
<h2><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Two week Audio feed</h2>
<h2 id="feed_regular"><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Two week Audio feed<a href="<!--% absolute_path(baseurl) %-->syndication.html#feed_regular">.</a></h2>
<p>5 shows a week</p>
</hgroup>
</header>
@@ -46,7 +46,7 @@
</article>
<article>
<header>
<h2><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Entire Archive Audio feed</h2>
<h2 id="feed_full"><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Entire Archive Audio feed<a href="<!--% absolute_path(baseurl) %-->syndication.html#feed_full">.</a></h2>
</header>
<p>
Use this feed to get the archived episodes. The feed themselves run over 15Mb in size and so use them to download the archived episodes and when you are up to date switch back to the Two Week Feeds listed above.
@@ -59,7 +59,7 @@
</article>
<article>
<header>
<h2><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Future feed</h2>
<h2 id="feed_future"><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Future Feed<a href="<!--% absolute_path(baseurl) %-->syndication.html#feed_future">.</a></h2>
</header>
<p>
Use this feed to get the shows as they are posted. The shows will be posted out of order as they come in and may be replaced/reposted if errors are found. This is intended as a means to provide find issues with metadata or the audio quality of new shows before they hit the main feed.
@@ -70,7 +70,7 @@
</article>
<article>
<header>
<h2><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Comment feed</h2>
<h2 id="feed_comment"><img src="<!--% absolute_path(baseurl) %-->images/feed.png" alt="rss logo"> Comment Feed<a href="<!--% absolute_path(baseurl) %-->syndication.html#feed_comment">.</a></h2>
</header>
<ul>
<li><a href="<!--% absolute_path(baseurl) %-->comments.rss">Listener contributed comments to the episodes</a></li>
@@ -82,7 +82,7 @@
<div class="lane stack">
<article>
<header>
<h2>Site Replication Sources</h2>
<h2 id="site_replication">Site Replication Sources<a href="<!--% absolute_path(baseurl) %-->syndication.html#site_replication">.</a></h2>
</header>
<ul>
<li><a href="<!--% absolute_path(baseurl) %-->hpr.sql">Daily Database Dump in SQL Format</a></li>
@@ -92,7 +92,7 @@
</article>
<article>
<header>
<h2>External Sources</h2>
<h2 id="external_sources">External Sources<a href="<!--% absolute_path(baseurl) %-->syndication.html#external_sources">.</a></h2>
</header>
<ul>
<li><a href="https://archive.org/details/hackerpublicradio">Archive.org</a></li>
@@ -112,19 +112,19 @@
<article>
<header>
<h2>Download Archive</h2>
<h2 id="download_archive">Download Archive<a href="<!--% absolute_path(baseurl) %-->syndication.html#download_archive">.</a></h2>
</header>
<p>Please be aware that our Archive exceeds <strong>200Gb</strong></em>. We are happy for you to download them, but please make sure that you are not going to incur additional bandwidth charges on your side.</p>
<p>We will be happy to physically send episodes anywhere in the world if bandwidth is an issue.</p>
</article>
<article>
<header><h2>Full Episode Guide</h2></header>
<header><h2 id="full_episode_guide">Full Episode Guide<a href="<!--% absolute_path(baseurl) %-->syndication.html#full_episode_guide">.</a></h2></header>
<p>The <a href="<!--% absolute_path(baseurl) %-->eps/index.html">compete episode guide</a> is available to you, and it lists all the shows on one page going right back to the very first episode.</p>
</article>
<article>
<header><h2>Command line download</h2></header>
<header><h2 id="cli_download">Command line download<a href="<!--% absolute_path(baseurl) %-->syndication.html#cli_download">.</a></h2></header>
<p>You can download the audio of the episodes directly from the command line using the following commands:</p>
<ul>
<li>ogg:<br>