HPR/hpr_generator
8
1
Fork 5
Code Issues 38 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

Documentation Update

Browse Source
This commit is contained in:
Ken Fallon
2026-06-02 22:22:19 +02:00
parent 130588bad9
commit 431ec2b946
2 changed files with 82 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -22,7 +22,7 @@
</header>
<p>Well you've come to the right place.
Our goal here at HPR is to make it as easy as possible for you to get your show released.
Our goal here at HPR is to make it as <strong>easy as possible</strong> for you to get your show released.
We take care of the hard bits so you don't need to.
</p>
@@ -72,11 +72,11 @@ or editing pages relating to
<p>
HPR is founded on the principle of Hackers sharing knowledge, so we are not a media aggregation site.
For this reason we are only releasing material created exclusively for HPR.
Once released, the creative commons license will allows sharing it to other locations.
Once released, the creative commons license will allow sharing it to other locations.
</p>
<p>
We will continue to promote new podcasts, and other creative commons material,
throught our sister site <a href="https://freeculturepodcasts.org/">Free Culture Podcasts</a>.
through our sister site <a href="https://freeculturepodcasts.org/">Free Culture Podcasts</a>.
</p>
<p>
We do allow <strong>promotion of one example</strong> episode of creative commons content.
@@ -93,7 +93,6 @@ All our shows are now released under a
<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)</a>
license, which means that while you continue to retain the copyright to your show,
you are allowing us (and everyone else) to use it provided we give you attribution and that we release it under the same license.
Click the <a href="https://creativecommons.org/licenses/by-sa/4.0/">link</a> for more information.
</p>
</details>
@@ -128,13 +127,13 @@ and <strong>probably will</strong> be edited.
<p>
There is no guarantee that we will accept your show.
Even after it is processes, <strong>any material that is reported as harming HPR may be unlisted until such a time as the situation can be resolved</strong>.
Even after it is processed, <strong>any material that is reported as harming HPR may be unlisted until such a time as the situation can be resolved</strong>.
You can expect your show to be rejected for (incomplete list):
<ul>
<li>Inaudible audio</li>
<li>Containing Copyright Content, even <em>Fair Use</em></li>
<li>Not a HPR Episode</li>
<li>Containing Harassment, Trolling, Spamming, etc, Content</li>
<li>Content Containing Harassment, Trolling, Spamming, etc</li>
</ul>
</p>
<p>
@@ -168,8 +167,8 @@ which describes the agreed approach to this topic.
<details>
<summary id="schedule">You determine when your show will be <strong>scheduled</strong><a href="<!--% absolute_url(baseurl,'contribute.html#schedule') %-->">.</a></summary>
<p>You decide when you upload your show <a href="<!--% absolute_url(baseurl,'contribute.html#upload_your_show') %-->">when it should be released</a>.
You can pick a day, or put it in the reserve pool and let the Janitors use it there are free slots.</p>
<p>You decide when <a href="<!--% absolute_url(baseurl,'contribute.html#upload_your_show') %-->">your show should be released</a>.
You can pick a day, or put it in the reserve pool so that the Janitors can use it when there are gaps in the schedule.</p>
</details>
<details>
@@ -199,7 +198,6 @@ The following are standing reservations:
<li>Anniversary episodes.</li>
<li>HPR Community News on the first Monday of the month.</li>
<li>The first day of the fourth month.</li>
<li>The days following new year.</li>
</ul>
</details>
@@ -258,15 +256,16 @@ Once we verify the show is a genuine contribution we remove the reference.
<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 -
Computerphile</a>" for an interesting background to ASCII and <a href="https://en.wikipedia.org/wiki/UTF-8">UTF-8</a>.
</blockquote>
<p>
See the video "<a href="https://www.youtube.com/watch?v=MijmeoH9LT4">Characters, Symbols and the Unicode Miracle - Computerphile</a>"
for an interesting background to ASCII and <a href="https://en.wikipedia.org/wiki/UTF-8">UTF-8</a>.
</p>
</details>
<details>
<summary id="accessibility">Keep <strong>accessibility</strong> in mind<a href="<!--% absolute_url(baseurl,'contribute.html#accessibility') %-->">.</a></summary>
<p>
When you includes output from the command line in the show notes,
When you include output from the command line in the show notes,
posting screen-shots of console or terminal output
makes it impossible for screen readers to access the text.
Always try to include the raw output ( eg: embedded in &lt;pre&gt; tags)
@@ -318,7 +317,7 @@ 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 <strong>decide on a topic</strong> for your show.
</p>
<p>
We recommend that your first show be a introductory episode to the
@@ -413,8 +412,8 @@ A rule of thumb is to never spend more time editing than recording.
<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.
While you may have done many shows, some people listen randomly,
so this may be the first time they hear your voice.
</p>
</details>
@@ -446,7 +445,7 @@ If you want to control this in more detail then please email admin at Hacker Pub
<details>
<summary id="no_metadata">No need to add Metadata to the file<a href="<!--% absolute_url(baseurl,'contribute.html#no_metadata') %-->">.</a></summary>
<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.
There is no need to add any information to the file as that will be inserted based on the information you provide when you upload the show.
</p>
</details>
@@ -522,7 +521,7 @@ If you would like to record with multiple participants then you can use <a href=
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.
That will record a single track which you can edit and then submit.
<br>
The <a href="<!--% absolute_url(baseurl) %-->mumble-howto">Mumble tutorial</a> has more information.
Thanks to <a href="<!--% absolute_url(baseurl) %-->correspondents/0228.html">Delwin</a> for providing the server.
@@ -556,7 +555,7 @@ New hosts, Interviews, and other time critical shows should use the <a href="<!-
</p>
<p>
Otherwise, when the queue is filling up then <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/queue.md">leave some slots free slots</a>
Otherwise, when the queue is filling up then <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/queue.md">leave some free slots</a>
for new contributors.
</p>
@@ -564,14 +563,14 @@ for new contributors.
<summary id="reserve_pool">If you <strong>do not care</strong> when your show will be released,
then you can just <a href="https://hub.hackerpublicradio.org/request.php?id=9999">add it to the reserve pool</a><a href="<!--% absolute_url(baseurl,'contribute.html#reserve_pool') %-->">.</a></summary>
<p>
This is intended for <strong>non urgent show that are timeless</strong>, as there may be a year or more before the show gets aired.
This is intended for <strong>non urgent shows that are timeless</strong>, as there may be a year or more before the show gets aired.
Reserve shows should <strong>not be dependant</strong> on others in the reserve pool, as they may be posted out of order.
</p>
<p>
The reserve pool shows will be used when there is a gap in the schedule.
Empty slots might be filled by reserve shows up to ten days prior to release.
Shows from the reserve pool may have hosts that have submitted shows in the last two weeks.
They will normally be used on a first come first go basis, but there is no guarentee of the posting order.
(Reserve shows are not considered in the "two week" rule).
They will normally be used on a first come first go basis, but there is no guarantee of the posting order.
</p>
<p>
These shows will contain a message alerting listeners to the fact that a reserve show is in use.
@@ -604,7 +603,7 @@ The thank you page, and confirmation email, both contain all the information we
</header>
<p>
You will then send you a <strong>unique link</strong> which you can use to upload your show.
We will then send you a <strong>unique link</strong> which you can use to upload your show.
</p>
<details>
@@ -624,7 +623,7 @@ the email address <em>robot@hobbypublicradio.com</em>.
<details>
<summary id="reservation_time_limit">The reservation expires after <strong>15 Minutes</strong><a href="<!--% absolute_url(baseurl,'contribute.html#reservation_time_limit') %-->">.</a></summary>
<p>
You have 15 minutes to open this link or your show will automatically be deleted so that the slot can become available to another host.
You have 15 minutes to open this link or your reservation will automatically be deleted so that the slot can become available to another host.
</p>
</details>
@@ -642,7 +641,7 @@ If you do not do so then the entire reservation will be removed so another host
As a security measure, you must upload your show for the same IP Address as your reservation.
</p>
<p>
This can be caused by
Errors resulting from this may be caused by:
<ul>
<li>Making a request on one network (work), and processing it on another (home)</li>
<li>Your ISP is using NAT, and is assigning a new ip from the pool for the next request</li>
@@ -733,7 +732,8 @@ Otherwise you can upload a profile image.
</details>
<details>
<summary id="profile_name_handle"><strong>Name/Handle:</strong> How you wish to be know<a href="<!--% absolute_url(baseurl,'contribute.html#profile_name_handle') %-->">.</a></summary>
<summary id="profile_name_handle"><strong>Name/Handle:</strong> How you wish to be known<a href="<!--% absolute_url(baseurl,'contribute.html#profile_name_handle') %-->">.</a></summary>
<p><em>Mandatory</em></p>
<p>
It should be the name you wish to be known as on HPR. It can be your real name, an Internet handle or both.
<a href="<!--% absolute_url(baseurl,'about.html#contact') %-->">Contact</a> the Janitors and they will change your Handle for you.
@@ -768,8 +768,8 @@ We allow the following licenses:
</p>
<p>
Enter some text about yourself with links to your blog or other online presence.
You can use the <a href="https://en.wikipedia.org/wiki/WYSIWYG">what you see is what you get</a>.
Format your profile as you would like it rendered.
You can use the <a href="https://en.wikipedia.org/wiki/WYSIWYG">what you see is what you get</a>/WYSIWYG
editor to format your profile as you would like to see it rendered.
</p>
</details>
@@ -841,7 +841,7 @@ We allow the following licenses:
<summary id="episode_show_notes"><strong>Show Notes:</strong> Enter a description about your show, including links to the topics you discussed.<a href="<!--% absolute_url(baseurl,'contribute.html#episode_show_notes') %-->">.</a></summary>
<p><em>Mandatory</em></p>
<p>
You can use the <a href="https://en.wikipedia.org/wiki/WYSIWYG">what you see is what you get</a>/WYSIWYG editor buttons to add additional formatting.
If you allow JavaScript, you can use the <a href="https://en.wikipedia.org/wiki/WYSIWYG">what you see is what you get</a>/WYSIWYG editor buttons to add additional formatting.
It supports, Headings, Number and Bullet lists, Bold, Italic, Underline, and Strike through formatting, Code Blocks, Blockquotes, and links.
</p>
<p>
@@ -864,11 +864,16 @@ You have taken the time to record a show on a topic, so many people will want to
therefore you should include links to give more information. It is not enough to just give it in the show itself
as people may be listening while away from the Internet, and they may have forgotten or misheard your links.
</li>
<li><strong>They ensure your show gets posted on time.</strong><br>
If you do not supply show notes then your show notes will need to be edited manually by an HPR volunteer,
and this will most likely result in delays.
During that time other shows will be processed and may get posted before your show.
It is always better if you send us show notes yourself as you know best what information you are trying to convey.</li>
<li><strong>You are making more work for the Janitors.</strong><br>
It is always better if you send us show notes yourself as you know best what information you are trying to convey.
If you do not supply show notes then your show notes will need to be edited manually by an HPR volunteer.
As we do not listen to the show when posting, your show will first be added without show notes.
Once it has been published in the <a href="<!--% absolute_url(baseurl,'syndication.html#feed_future') %-->">Future Feed</a>
we can listen to it and create the show notes.
Once they are done we then need to go back and republish the show to the website.
We also need to edit the Internet Archive page created for your show.
This runs the risk that the podcast platforms will not pick up the change.
</li>
<li><strong>They encourage people to download your show.</strong><br>
We produce a lot of shows and many people download based on the text in the show notes.
If the show notes are not descriptive then it is less likely that
@@ -878,7 +883,7 @@ Search engines cannot determine the content of your show from the audio alone.
The only way for your show to be indexed is for you to describe in the associated text what you say in the audio.</li>
<li><strong>They make your show accessible to the deaf and hard of hearing.</strong><br>
Your audio is completely inaccessible to those who have hearing problems,
so the only way for your show to be of help to them is if you distill the essence of the show into the show notes.
It helps them if you distill the essence of the show into the show notes.
If you are using a script to prepare your show then include that.</li>
</ul>
</p>
@@ -898,7 +903,7 @@ See if your show fits into a <a href="<!--% absolute_url(baseurl) %-->series/ind
<p>
Pick the most important words from the show notes.
Your tags are added as <a href="https://en.wikipedia.org/wiki/Hashtag">#hashtags</a> on social media.
Helps people find your show by topic keyword on our
This helps people find your show by topic keyword on our
<a href="<!--% absolute_url(baseurl,'search.html#tags') %-->">tags page</a>.
</p>
</details>
@@ -909,7 +914,7 @@ Helps people find your show by topic keyword on our
<ul>
<li id="episode_upload_method_browser"><strong>Upload now via this browser</strong><br>
You can upload single or multiple files using this method.
Chrome will display the percentage uploaded but to see this in Firefox you will need to just wait.
Chrome will display the percentage uploaded, but in Firefox you will need to just wait.
</li>
<li id="episode_upload_method_url"><strong>Provide a url for us to get it from</strong><br>
Using this option may cause delays as a HPR volunteer will need to troubleshoot any issues that may occur,
@@ -920,9 +925,35 @@ Helps people find your show by topic keyword on our
</ul>
<p>
If you want to submit an additional file with your show, then put them in a zip, or tgz file.
Link to them using just the file name "<em>example_output.pdf</em>" without any paths.
Do not add any additional images this way, just include them in the show notes.
If you need to link to them use just the file name "<em>example._output.pdf</em>", without any paths.
</p>
<p>
If you provide a subtitle, transcript with your upload we will automatically use that.
<code>
<pre>
whisper --language en --output_format srt myshow.flac
</pre>
</code>
</p>
<p>
Will produce a <em>srt</em> file with the same name as your audio.
You can then edit the text but leave the timing in place.
</p>
<p>
<code>
<pre>
$ ls myshow.*
myshow.flac myshow.srt
</pre>
</code>
</p>
<p>
During the upload hold the <em>Ctrl</em> key and click on both files.
You should see <em>Two Files Selected</em> next to the Browse button.
</p>
</details>
@@ -934,7 +965,7 @@ Any missing information can result in a show missing the requested slot.
<p>
Press <strong>submit</strong> and your show will be sent to the HPR Volunteers to be processed.
Keep an eye on the <a href="<!--% hub_baseurl %-->calendar.php">calendar</a> for when it is posted.
For more information on the the process of <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/workflow/uploading_a_show.md">Uploading a show</a>.
For more information on the process of <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/workflow/uploading_a_show.md">Uploading a show</a>
and <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/workflow/processing_a_show.md">Show Processing</a> can be found on our GitTea repo.
</p>