lee/hpr_generator
1
0
Fork 0
forked from HPR/hpr_generator
Code Pull Requests Activity

Documentation update

Browse Source
This commit is contained in:
Ken Fallon
2026-05-31 21:12:13 +02:00
parent 0eefb633a5
commit dc6c96f5bb
2 changed files with 259 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

415
templates/content-contribute.tpl.html
View File

@@ -16,11 +16,11 @@
<li><a href="<!--% absolute_url(baseurl,'contribute.html#international') %-->">Your show will be heard by an International Audience</a></li>
</ul>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#pick_a_topic') %-->">Pick a Topic</a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#recording_a_podcast') %-->">Recording a Podcast</a></li>
<ul>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
</ul>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
@@ -187,6 +187,43 @@ which describes the agreed approach to this topic.
You can pick a day, or put it in the reserve pool and let the Janitors use it there are free slots.</p>
</details>
<details>
<summary id="email_address">Your <strong>email</strong> will be made <strong>public</strong><a href="<!--% absolute_url(baseurl,'contribute.html#email_address') %-->">.</a></summary>
<p>
The mail is just a way for us to get back to you if there was an issue posting the show.
This email address will be published on the HPR website and will be given out in the feeds,
so please use a <strong>public email</strong> address for this purpose.
</p>
<p>
Where we publish it we pad it with dot nospam at-sign nospam dot.
For example <em>hpr@example.com</em> becomes <em>hpr.nospam@nospam.example.com</em>.
</p>
<p>
If you do not want to have your email exposed, please contact the admin@hpr team to arrange a alias.
If you trust the janitors to know your real email,
then we can just use an alias for you on the web site.
Any inbound mail to that alias will be automatically forwarded to your personal email.
That runs the risk that were the redirect list compromised then your real email would get exposed.
We would do our best to protect your email but we can't guarantee anything.
</p>
<p>
The other option is to use an a throwaway email, like
<a href="https://www.guerrillamail.com/">https://www.guerrillamail.com/</a>
for your show. This will be up for enough time to get the key necessary for to post the show.
However keep in mind that we will be very suspicious of any submission done this way
and will be checking it in detail,
so expect delays in processing.
</details>
<details>
<summary id="schedule">You <strong>IP Address</strong> and User Agent will logged.<a href="<!--% absolute_url(baseurl,'contribute.html#schedule') %-->">.</a></summary>
<p>
The information we log is sent at the end of the emails we send to you.
Your IP address is linked to your show until it is posted.
Once we verify the show is a genuine contribution we remove the reference.
</p>
</details>
<details>
<summary id="utf8">We use <strong>UTF-8</strong> end to end<a href="<!--% absolute_url(baseurl,'contribute.html#utf8') %-->">.</a></summary>
<blockquote>See the video "<a href="https://www.youtube.com/watch?v=MijmeoH9LT4">Characters, Symbols and the Unicode Miracle -
@@ -249,32 +286,233 @@ If you have any questions please join one of our <a href="<!--% absolute_url(bas
</header>
<p>
The first thing you will need to do is decide on a topic for your show.
The first thing you will need to do is decide on a topic for your show.
</p>
<p>
We recommend that your first show be a introductory episode to the
<a href="<!--% absolute_url(baseurl,'series/0029.html') %-->">How I got into tech</a> series.
First tell us your <strong>name</strong>,
how you <strong>found out about HPR</strong>,
and the begin with your <strong>earliest</strong> introduction to tech.
Cover all the <strong>systems</strong> you used,
and mention all the <strong>people</strong>
and <strong>events</strong> who had a role in shaping your journey.
We will make sure you get lots of suggestions for your next submission in the comments for your show,
and in the next <a href="<!--% absolute_url(baseurl,'series/0047.html') %-->">HPR Community News</a> monthly overview.
</p>
<p>
You can see in our
<a href="<!--% absolute_url(baseurl,'eps/index.html') %-->">Complete Episode Overview</a> page
that we a wide variety of topics, ranging from "OMG I just learned/broke/hacked/discovered/etc, this cool thing and no one in my house gets it",
to <a href="<!--% absolute_url(baseurl,'eries/index.html') %-->">in depth series</a> where a particular topic can be explored in more detail.
</p>
<p>
To find a overview of the topics you can also search by keyword on our
<a href="<!--% absolute_url(baseurl,'search.html#tags') %-->">tags page</a>.
</p>
OMG I just learned, broke, hacked, discovered this cool thing and noone in my house get’s it.
Check out our 91 in depth series, or 6,938 unique tags for ideas.
You might already have an idea,
but if not you can have a look at our <a href="<!--% absolute_url(baseurl) %-->eps/index.html">Archive</a> page for examples of shows people have recorded in the past.
<p id="requested topics">
<p id="requested_topics">
We maintain a page of <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/requested_topics">requested topics</a>
that have been sent in by the community.
Feel free to add it to the list via <a href="<!--% absolute_url(baseurl,'about.html#contact') %-->">the contact channels</a>.
</p>
<a href="<!--% absolute_url(baseurl,'contribute.html#requested_topics') %-->">Requested Topics</a>, or our
<a href="<!--% absolute_url(baseurl) %-->series/index.html">Series</a> page to see if you can add your knowledge to the pool.
</p>
<p>
If you are worried that your show may not be of interest to Hackers then you can <a href="<!--% absolute_url(baseurl) %-->will-my-show-be-of-interest-to-hackers.html">click here</a> to check if it is.
</p>
<p>
If you can't think of anything to talk about then please just record a show telling us
<a href="<!--% absolute_url(baseurl) %-->series/0029.html">how you got into tech</a>
as a way to introducing yourself to the community.
</p>
</article>
<hr class="no-css">
<article>
<header>
<p class="index-link"><a href="/contribute.html#TOP">↑ Go to top</a></p>
<h1 id="recording_a_podcast">Recording a Podcast</h1>
</header>
<p>
On this page you will find information on how to record a podcast.</p>
<details>
<summary id="flac_is_best">FLAC is best, we accept the rest<a href="<!--% absolute_url(baseurl,'contribute.html#flac_is_best') %-->">.</a></summary>
<p>
Our recommended setting for recording is 44100 Hz, 24 bit depth, saved as Lossless FLAC Level 8 (best).
</p>
<p>
If your recording setup can't do that, then pick a lossless format, with the highest sample rate you can.
If you only have access to a lossfull format like mp3, then please send that in as is.
</p>
<p>
For more tips see the <a href="<!--% absolute_url(baseurl,'series/0045.html') %-->">In-Depth Series: Podcasting HowTo</a>.
</p>
</details>
<details>
<summary id="golden_rule">Any audio is better than no audio<a href="<!--% absolute_url(baseurl,'contribute.html#golden_rules') %-->">.</a></summary>
<p>
We all want to produce the best quality we can.
We encourage you to record using the best equipment you have.
However if the show is audible then that is sufficient.
The show <a href="<!--% absolute_url(baseurl,'eps/hpr2627/index.html') %-->">hpr2627 :: Home Phone Setup!!</a> is a perfect example of this.
</p>
</details>
<details>
<summary id="procrastination">Procrastination is the enemy<a href="<!--% absolute_url(baseurl,'contribute.html#procrastination') %-->">.</a></summary>
<p>
If it's taking too long to edit the episode then you are less likely to submit the show.
Send this show in, and employ your lessons learned in the next one.
</p>
<p>
A rule of thumb is to never spend more time editing than recording.
</p>
</details>
<details>
<summary id="introduce_yourself">Introduce yourself in each show<a href="<!--% absolute_url(baseurl,'contribute.html#introduce_yourself') %-->">.</a></summary>
<p>
Don't forget to <strong>introduce yourself</strong> in your show.
We have hundreds of hosts and thousands of episodes.
While you may have done many shows, people randomly listen to shows,
so this may be the first time to hear your voice.
</p>
<h2 id="portable_media_player">Recording with a portable media player
<a href="<!--% absolute_url(baseurl,'contribute.html#portable_media_player') %-->">.</a></h2>
<p>
Many of today's <a href="https://wiki.xiph.org/PortablePlayers">portable media players</a> support recording audio out of the box.
Search for "Voice Recorder", to see if there is an application for your smartphone.
Whichever option you have close to hand, try and set the recording to the best quality format
(<a href="https://en.wikipedia.org/wiki/WAV">WAV</a> or <a href="https://en.wikipedia.org/wiki/FLAC">FLAC</a>),
and set everything else to the highest setting.
It's always the goal to get the best quality audio but here at Hacker Public Radio we value content over quality
and so long as it's audible we'll take it.
</p>
<p>
Then just record your show, <a href="<!--% absolute_url(baseurl,'contribute.html#requesting_slot') %-->">request a slot</a>,
and we'll do the rest.
</p>
<h2 id="smart_phone">Recording with a portable media player<a href="<!--% absolute_url(baseurl,'contribute.html#smart_phone') %-->">.</a></h2>
<p>
Some of our hosts recommend <a href="https://gitlab.com/axet/android-audio-recorder">Android Audio Recorder</a> on my android phone.
It's available on <a href="https://f-droid.org/en/packages/com.github.axet.audiorecorder/">F-Droid</a>
and <a href="https://play.google.com/store/apps/details?id=com.github.axet.audiorecorder">Google Play</a>.
These are the recommended settings:
</p>
<ul>
<li>Recording Source - Unprocessed</li>
<li>Sample Rate - 44.1 kHz</li>
<li>Encoding - .flac</li>
<li>Audio Channels - Mono</li>
</ul>
<h2 id="editing">Recording/Editing using your Computer<a href="<!--% absolute_url(baseurl,'contribute.html#editing') %-->">.</a></h2>
<p>
The majority of podcasters use <a href="https://audacity.sourceforge.net/download/">Audacity</a>.
First set the Project Rate to 44100Hz, then you can either record your show in Audacity itself or
import the file you recorded earlier and edit it as you wish.
</p>
<p>
<img srcset="images/contribute-audacity-record-sm.png 460w, images/contribute-audacity-record.png 640w"
sizes="(max-width: 460px) 95vw, 640px"
src="images/contribute-audacity-record.png" alt="Audacity Can Record" title="Audacity Screenshot of Recording" >
</p>
<blockquote>Audacity is a free, easy-to-use and multilingual audio editor and recorder for
Windows, Mac OS X, GNU/Linux and other operating systems.</blockquote>
<iframe id="youtube" src="//www.youtube.com/embed/ss8CyTwBOPY"></iframe>
<p>
When you have finished editing your podcast you can export it.
</p>
<ol>
<li>Confirm that the Project Rate is set to 44100 Hz (bottom left).</li>
<li><em>File -> Export</em> and select <strong>FLAC File</strong>.</li>
<li>Click <em>Options...</em> to reveal FLAC Export Setup.</li>
<li>Set <em>Level</em> to <strong>8 (best)</strong>.</li>
<li>Set <em>Bit depth</em> to <strong>24</strong>.</li>
</ol>
<p>
<img srcset="images/contribute-audacity-export-sm.png 460w, images/contribute-audacity-export.png 640w"
sizes="(max-width: 460px) 95vw, 640px"
src="images/contribute-audacity-export.png" alt="Audacity Export Settings" title="Audacity Screenshot of an Export" >
</p>
<h2 id="phone_interviews">Recording Interviews with the Phone<a href="<!--% absolute_url(baseurl,'contribute.html#phone_interviews') %-->">.</a></h2>
<p>
If you want to record a one-to-one interview with someone then you can use
<a href="https://www.skype.com/en/">Skype</a> in conjunction with <a href="https://atdot.ch/scr/">Skype Call Recorder</a>.
If everyone is using skype then it won't cost you anything otherwise you will need to pay for SkypeOut service.
Although the quality is usually terrible, you could also put your phone on hands free and
record with a <a href="https://wiki.xiph.org/PortablePlayers">portable media player</a>.
</p>
<h2 id="round_table">Recording round table discussions<a href="<!--% absolute_url(baseurl,'contribute.html#round_table') %-->">.</a></h2>
<p>
If you would like to record with multiple participants then you can use <a href="https://www.mumble.com/">Mumble</a>.
Connect to <strong>chatter.skyehaven.net</strong> Port: <strong>64738 </strong>.<br>
Walk through the audio wizard and then pop into the <strong>Hacker Public Radio</strong> room.
Once you are ready press the <strong>recording</strong> button, select <em>multichannel</em> and then <em>start</em>.
That will record multiple tracks, one for each participant which you can edit and then submit.
<br>
Kwisher made a <a href="<!--% absolute_url(baseurl) %-->mumble-howto">Mumble tutorial</a>
which you might find useful and <a href="<!--% absolute_url(baseurl) %-->correspondents/0228.html">Delwin</a>
has produced a number of short shows on how to configure the audio quality.
</p>
<p>
<img srcset="images/contribute-mumble-record-sm.png 460w, images/contribute-mumble-record.png 640w"
sizes="(max-width: 460px) 95vw, 640px"
src="images/contribute-mumble-record.png" alt="Audacity Can Record" title="Audacity Screenshot of Recording" >
</p>
<h2 id="background_music">Avoid Bedding/background music<a href="<!--% absolute_url(baseurl,'contribute.html#background_music') %-->">.</a></h2>
<p>
You may include backing music but it's best if you don't. Most long time podcast listeners speed up their shows,
as this allows them to cram more shows into a day. Having bedding music makes it more difficult to understand,
and prevents tools like <em>truncate silence</em> from working correctly.<br/>
Others will convert shows to mono to listen in one ear leaving the other free to carry out their other chores.
Still more slow the shows down so that they can improve their English.
Others are hard of hearing and backing music makes it difficult to understand the text.
</p>
<h2 id="encoding">We mix down to Mono<a href="<!--% absolute_url(baseurl,'contribute.html#encoding') %-->">.</a></h2>
<p>
We will by default mix down your show to one channel mono and we will
<a href="https://gitorious.org/hpr-scheduling-system/hpr-scheduling-system/source/2d526e000d31e79afa3d863ea8659503e2074267:transcoding/hprtranscode">transcode</a> to MP3, ogg and spx formats. If you want to control this in more detail then please email admin at Hacker Public Radio for more information.
</p>
<h2 id="no_metadata">No need to add Metadata to the file<a href="<!--% absolute_url(baseurl,'contribute.html#no_metadata') %-->">.</a></h2>
<p>
There is no need to add any information to the file as that will be inserted based on the information you fill in when you upload the show.
</p>
</article>
<h2 id="record_your_show">3. Record your show<a href="<!--% absolute_url(baseurl,'contribute.html#record_your_show') %-->">.</a></h2>
<p>
@@ -303,8 +541,6 @@ After you have selected a date you will be redirected to the <a href="<!--% hub_
where you will be asked to select your show and email address.
We will send a link to where you can upload your show to this address and so it must be a valid working address
that you can access quickly.
We intend to use <a href="https://www.gnupg.org/">GPG</a> to speed up the validation of hosts,
so you may wish to use an email address that has an associated public key available on public key servers.
</p>
<p>
<a href="<!--% absolute_url(baseurl,'contribute.html#requesting_slot') %-->">More Information</a>.
@@ -435,8 +671,7 @@ so you may wish to use an email address that has an associated public key availa
Once you have selected a date you will be redirected to the <a href="<!--% hub_baseurl %-->request.php">request page</a>,
where you will be asked to select your show and email address.
We will send a link to where you can upload your show to this address and therefore it must be a valid working address
that you can access quickly. We intend to use <a href="https://www.gnupg.org/">GPG</a> to speed up the validation of hosts,
so you may wish to use an email address that has an associated public key available on public key servers.
that you can access quickly.
</p>
<p>
The audio of your show will not be moderated, however <em>the information provided in the upload form
@@ -490,125 +725,7 @@ and chat with a live person 24/7.
</p>
</article>
<hr class="no-css">
<article>
<header>
<p class="index-link"><a href="/contribute.html#TOP">↑ Go to top</a></p>
<h1 id="recording_a_podcast">Recording a Podcast</h1>
</header>
<p>
On this page you will find information on how to record a podcast. Our golden rule is <strong>Any audio is better than no audio.</strong>
so keep that in mind. Don't forget to <strong>introduce yourself</strong> in your show.
</p>
<h2 id="portable_media_player">Recording with a portable media player
<a href="<!--% absolute_url(baseurl,'contribute.html#portable_media_player') %-->">.</a></h2>
<p>
Many of today's <a href="https://wiki.xiph.org/PortablePlayers">portable media players</a> support recording audio out of the box.
Search for "Voice Recorder", to see if there is an application for your smartphone.
Whichever option you have close to hand, try and set the recording to the best quality format
(<a href="https://en.wikipedia.org/wiki/WAV">WAV</a> or <a href="https://en.wikipedia.org/wiki/FLAC">FLAC</a>),
and set everything else to the highest setting.
It's always the goal to get the best quality audio but here at Hacker Public Radio we value content over quality
and so long as it's audible we'll take it.
</p>
<p>
Then just record your show, <a href="<!--% absolute_url(baseurl,'contribute.html#requesting_slot') %-->">request a slot</a>,
and we'll do the rest.
</p>
<h2 id="smart_phone">Recording with a portable media player<a href="<!--% absolute_url(baseurl,'contribute.html#smart_phone') %-->">.</a></h2>
<p>
Some of our hosts recommend <a href="https://gitlab.com/axet/android-audio-recorder">Android Audio Recorder</a> on my android phone.
It's available on <a href="https://f-droid.org/en/packages/com.github.axet.audiorecorder/">F-Droid</a>
and <a href="https://play.google.com/store/apps/details?id=com.github.axet.audiorecorder">Google Play</a>.
These are the recommended settings:
</p>
<ul>
<li>Recording Source - Unprocessed</li>
<li>Sample Rate - 44.1 kHz</li>
<li>Encoding - .flac</li>
<li>Audio Channels - Mono</li>
</ul>
<h2 id="editing">Recording/Editing using your Computer<a href="<!--% absolute_url(baseurl,'contribute.html#editing') %-->">.</a></h2>
<p>
The majority of podcasters use <a href="https://audacity.sourceforge.net/download/">Audacity</a>.
First set the Project Rate to 44100Hz, then you can either record your show in Audacity itself or
import the file you recorded earlier and edit it as you wish.
</p>
<p>
<img srcset="images/contribute-audacity-record-sm.png 460w, images/contribute-audacity-record.png 640w"
sizes="(max-width: 460px) 95vw, 640px"
src="images/contribute-audacity-record.png" alt="Audacity Can Record" title="Audacity Screenshot of Recording" >
</p>
<blockquote>Audacity is a free, easy-to-use and multilingual audio editor and recorder for
Windows, Mac OS X, GNU/Linux and other operating systems.</blockquote>
<iframe id="youtube" src="//www.youtube.com/embed/ss8CyTwBOPY"></iframe>
<p>
When you have finished editing your podcast you can export it.
</p>
<ol>
<li>Confirm that the Project Rate is set to 44100 Hz (bottom left).</li>
<li><em>File -> Export</em> and select <strong>FLAC File</strong>.</li>
<li>Click <em>Options...</em> to reveal FLAC Export Setup.</li>
<li>Set <em>Level</em> to <strong>8 (best)</strong>.</li>
<li>Set <em>Bit depth</em> to <strong>24</strong>.</li>
</ol>
<p>
<img srcset="images/contribute-audacity-export-sm.png 460w, images/contribute-audacity-export.png 640w"
sizes="(max-width: 460px) 95vw, 640px"
src="images/contribute-audacity-export.png" alt="Audacity Export Settings" title="Audacity Screenshot of an Export" >
</p>
<h2 id="phone_interviews">Recording Interviews with the Phone<a href="<!--% absolute_url(baseurl,'contribute.html#phone_interviews') %-->">.</a></h2>
<p>
If you want to record a one-to-one interview with someone then you can use
<a href="https://www.skype.com/en/">Skype</a> in conjunction with <a href="https://atdot.ch/scr/">Skype Call Recorder</a>.
If everyone is using skype then it won't cost you anything otherwise you will need to pay for SkypeOut service.
Although the quality is usually terrible, you could also put your phone on hands free and
record with a <a href="https://wiki.xiph.org/PortablePlayers">portable media player</a>.
</p>
<h2 id="round_table">Recording round table discussions<a href="<!--% absolute_url(baseurl,'contribute.html#round_table') %-->">.</a></h2>
<p>
If you would like to record with multiple participants then you can use <a href="https://www.mumble.com/">Mumble</a>.
Connect to <strong>chatter.skyehaven.net</strong> Port: <strong>64738 </strong>.<br>
Walk through the audio wizard and then pop into the <strong>Hacker Public Radio</strong> room.
Once you are ready press the <strong>recording</strong> button, select <em>multichannel</em> and then <em>start</em>.
That will record multiple tracks, one for each participant which you can edit and then submit.
<br>
Kwisher made a <a href="<!--% absolute_url(baseurl) %-->mumble-howto">Mumble tutorial</a>
which you might find useful and <a href="<!--% absolute_url(baseurl) %-->correspondents/0228.html">Delwin</a>
has produced a number of short shows on how to configure the audio quality.
</p>
<p>
<img srcset="images/contribute-mumble-record-sm.png 460w, images/contribute-mumble-record.png 640w"
sizes="(max-width: 460px) 95vw, 640px"
src="images/contribute-mumble-record.png" alt="Audacity Can Record" title="Audacity Screenshot of Recording" >
</p>
<h2 id="background_music">Avoid Bedding/background music<a href="<!--% absolute_url(baseurl,'contribute.html#background_music') %-->">.</a></h2>
<p>
You may include backing music but it's best if you don't. Most long time podcast listeners speed up their shows,
as this allows them to cram more shows into a day. Having bedding music makes it more difficult to understand,
and prevents tools like <em>truncate silence</em> from working correctly.<br/>
Others will convert shows to mono to listen in one ear leaving the other free to carry out their other chores.
Still more slow the shows down so that they can improve their English.
Others are hard of hearing and backing music makes it difficult to understand the text.
</p>
<h2 id="encoding">We mix down to Mono<a href="<!--% absolute_url(baseurl,'contribute.html#encoding') %-->">.</a></h2>
<p>
We will by default mix down your show to one channel mono and we will
<a href="https://gitorious.org/hpr-scheduling-system/hpr-scheduling-system/source/2d526e000d31e79afa3d863ea8659503e2074267:transcoding/hprtranscode">transcode</a> to MP3, ogg and spx formats. If you want to control this in more detail then please email admin at Hacker Public Radio for more information.
</p>
<h2 id="no_metadata">No need to add Metadata to the file<a href="<!--% absolute_url(baseurl,'contribute.html#no_metadata') %-->">.</a></h2>
<p>
There is no need to add any information to the file as that will be inserted based on the information you fill in when you upload the show.
</p>
</article>
<hr class="no-css">
<article>
@@ -967,28 +1084,6 @@ Your show information is used to process the media files, on the website, in the
</ul></li>
</ul>
<h2 data-number="0.15" id="faq_anonymous_post"><span class="header-section-number">0.15</span> I'd like to post a show but I would
rather not have my email address published on the site.?</h2>
<p>
The mail is just a way for us to get back to you if there was an issue posting the show.
</p>
<p>
If you trust the janitors to know your real email we can just use an alias for you on the web site and have it
forward the email to you automatically. That runs the risk that were the redirect list compromised then your
real email would get exposed.
</p>
<p>
If you prefer, we can use the janitor email for your shows with your own host id. Then if any emails come in we can manually
forward them at some point. The risk is that you are trusting the janitors to protect your email but again it could be compromised.
</p>
<p>
In both cases we would do our best to protect your email but we can't guarantee anything.
</p>
<p>
The other option is to use an a throwaway email, like <a href="https://www.guerrillamail.com/">https://www.guerrillamail.com/</a>
for your show. This will be up for enough time to get the key necessary for to post the show.
However keep in mind that we will be very suspicious of any submission done this way and will be checking it in detail,
so expect delays in processing.
</p>
</article>
</div>