From 640606b8ab1b3d0020e5ce892a4d2272635b8780 Mon Sep 17 00:00:00 2001 From: Ken Fallon Date: Wed, 27 May 2026 17:49:45 +0200 Subject: [PATCH] Updating documentation --- templates/content-about.tpl.html | 43 +- templates/content-contribute.tpl.html | 1533 ++++++++++++------------ templates/content-syndication.tpl.html | 2 + 3 files changed, 782 insertions(+), 796 deletions(-) diff --git a/templates/content-about.tpl.html b/templates/content-about.tpl.html index ea1ca85..efe67f8 100644 --- a/templates/content-about.tpl.html +++ b/templates/content-about.tpl.html @@ -15,6 +15,7 @@
  • Janitors
  • Auditors
    • +
  • Kill Switch
  • Recent Policy Changes
  • How to Help
    • @@ -46,7 +47,11 @@

    The HPR Community.

    -

    Hacker Public Radio is dedicated to sharing knowledge in a welcoming community that offers positive feedback and encourages respectful debate.

    +

    +Hacker Public Radio is a technology focused podcast that releases shows every weekday Monday to Friday. +We are a welcoming community that offers positive feedback and encourages respectful debate. +Our shows are produced by listeners like you and can be on any topic that is of interest to hackers, hobbyists, makers, etc. +

    What differentiates HPR from other podcasts is that the shows are crowd sourced from the community - fellow listeners like you. There is no restriction on how long the show can be, nor on the topic you can cover as long as they are not spam @@ -63,7 +68,6 @@ You can copy and redistribute the shows for free provided you adhere to the Creative Commons Attribution Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) License.

    -

    Our History.

    Public Radio (HPR) is an Internet Radio show (podcast) that releases shows every weekday Monday through Friday. HPR has a long lineage going back to Radio FreeK America, @@ -120,9 +124,42 @@ Anyone who has shown a long term dedication to the project and is trusted by the They are contactable via the contact channels.

    The janitors will contact you if there are issues with the processing of your show.

    +

    +Here are the people who have volunteered their time to keep HPR running. +Enigma, +p0trill0, +droops, +StankDawg, +Klaatu, +dosman, +slick0, +Ken Fallon, +code.cruncher, +Dave Morriss, +Rho`n, +norrist, +Keith Murray, +Kevie, +Archer72, and +Some Guy On The Internet. +

    +

    Auditors.

    If the janitors need to contact you related to the implementation of policies, they will also include the Auditors. The Auditors role is to observe, and report if necessary that the Janitors are been faithful in their communication.

    +

    Kill Switch.

    +

    HPR will stop as a project if there are not enough Shows. +Once that all the reserve shows have been used up and there are no more shows in the queue, +HPR as a project will stop. +This is by design, and is inspired by the episode hpr0560 :: Old soldiers, hosted by +lostnbronx "A discussion of "podfading" - the fading away of once-active podcasts". +

    + +

    +The Janitors Covenant is that they will continue to process and post the shows, so long as you, the HPR community, continue to send them in. +If people stop sending shows in then we will shut the project down with grace and a big send off. +

    +

    Recent Policy Changes.

    Don't forget to introduce yourself in your show.

    @@ -174,6 +347,158 @@ so you may wish to use an email address that has an associated public key availa More Information.

    + + + + +
  • You determine where in the schedule your show will be released.
    • +
  • We use UTF-8 end to end.
    • +
  • Your show will be heard by an International Audience.
    • +
  • We also need reserve shows.
    • +
  • You will no longer be allowed to edit HPR pages on + Wikipedia.
    • + + +

    Deciding when to post your show

    + +

    Y

    + +

    We have a flow diagram if that helps.

    + +

    Please see for more information on the queue.

    + +

    Regular Queue

    +
      +
    1. You must have your audio recording ready to upload before you pick a slot.
      2. +
    2. All hosts must leave at least 9 slots (approximately two weeks) between their shows.
      3. +
    3. New hosts, Interviews, and other time critical shows should use the first free slot. + Otherwise, when the queue is filling up then leave some slots free for new contributors by selecting a slot in the first empty week.
      4. +
    + + +

    Reserve Pool

    + + + +
  • If you have a non urgent show that is timeless, then add it to the reserve pool.
    • + + + future feed + + + + + + +

    + Over the years + + The HPR Schedule is entirely community driven and we recommend that you pick the date or show number + as then you know when your show will be released. + However the slots will only be allocated once the shows have been successfully processed. + Any missing information can result in a show missing the requested slot. +

    +

    + The reserve pool is intended only to be used in the cases where there is still a gap in the schedule one week prior to release. + This was known as the emergency queue, but now can also be used when the hosts don't care when the shows are scheduled. + They will be used on a first come first go basis, when there is no conflict with the scheduling Rules. + These shows contain a message alerting listeners to the fact that we had free slots that were not filled. +

    +

    + not possible to move them. +

    + + + +

    All reservations need to be approved.

    + +

    Regular Queue.

    +

    + Any host can select any free slot a up to year in advance. However the audio must be ready at time of picking a slot + so that it can be upload immediately afterwards. +

    +

    + In exceptional circumstances it may be necessary to reserve a slot while not having the audio available, + but this must be approved by the HPR Mailing List in advance. + Be sure to allow as much time as possible, and include a reason why you feel it is necessary to reserve the slot. +

    +

    + This is intended only for exceptional circumstances, such as a scheduled interview where we would + like the audio to be released as soon after the event as possible, + or to cover an important topical situation that has occurred. + Due to the extended time now needed to post shows to external sites, + the extra work this entails and the disruptive effect of reservations, + we will no longer be allowing them except in very rare cases of the type mentioned above. +

    +

    + The following are standing reservations: +

    + + + +

    .

    +

    .

    +

    .

    +

    .

    +

    .

    + +
    +
    +
    +

    ↑ Go to top

    +

    Picking a slot for your show

    +
    +

    + Any host can select any free slot a up to year in advance, by recording their show and uploading it to the desired slot. + In exceptional circumstances it may be necessary to reserve a slot while not having the audio available, + but this must be approved by the HPR mailing list in advance. + Be sure to allow as much time as possible, and include a reason why you feel it is necessary to reserve the slot. +

    +

    + This is intended only for exceptional circumstances, such as a scheduled interview where we would like the audio to be + released as soon after the event as possible, or to cover an important topical situation that has occurred. + Due to the extended time now needed to post shows to external sites, + the extra work this entails and the disruptive effect of reservations, + we will no longer be allowing them except in very rare cases of the type mentioned above. + [?] +

    +

    + You can post your show by going to the Calendar page. + Once you have selected a date you will be redirected to the request page, + 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 GPG 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. +

    +

    + The audio of your show will not be moderated, however the information provided in the upload form + may be moderated. + All publicly facing material is managed by the HPR Community as a whole, and not just the host providing the show. + The show hpr2210 :: On Freedom of Speech and Censorship + describes the agreed approach to this topic. +

    +

    Note: This email address will be published on the HPR website and will be given out in the feeds, + so please use a public email address for this purpose. + Where we publish it we pad it with dot nospam at-sign nospam dot.
    + i.e. hpr@example.com becomes hpr.nospam@nospam.example.com. + If you do not want to have your email exposed, please contact the admin@hpr team to arrange a alias. +

    +

    + Once you press next, an email will be sent to your email address pointing to where you can upload the show. + You need to open the link within 15 minutes or the temporary lock will be released. + Once you open the link, you can fill in the information at your leisure. + The upload form works on the assumption you will be posting one show at a time, from the same IP address. + Once you have pressed submit you will not be able to edit any of the information. +

    + +
    +
    -
    -

    ↑ Go to top

    -

    Requested topics.

    -
    -

    This is a list of topics that have been requested by the community. -Feel free to add it to the list by emailing admin at hpr or by tweeting us on @HPR.

    - -
    +
    +

    ↑ Go to top

    +

    Requested topics.

    +
    +

    +We maintain a page of requested topics that have been sent in by the community. +Feel free to add it to the list via the contact channels.

    + +
    -
    -

    ↑ Go to top

    -

    Stuff you need to know.

    -
    -

    -This is some important information that you will need to know before uploading to HPR. -

    - -

    You will no longer be allowed to edit HPR pages on Wikipedia - .

    -

    -Once you upload a show, you will no longer be allowed to create or edit pages relating to -Hacker Public Radio in -Wikipedia.
    -See our FAQ about - the HPR Wikipedia page for more information. -

    - -

    All policy decisions are made by the HPR Community - .

    -

    -The community decides the HPR policies. -Please join the HPR Mailing List to participate. -

    - -

    HPR will stop as a project if there are not enough shows - .

    -

    -Hacker Public Radio is dedicated to sharing knowledge. -We release about 260 shows a year, which is probably more than all of the other FOSS podcasts put together. -If you listen to HPR, then we would love you to -contribute -one show a year. -Remember once that all the reserve shows have been used up and there are no more shows in the queue, HPR as a project will stop. - -

    -

    Support our Patrons.

    -

    -Our hosting is kindly provided to us by Josh Knapp -from AnHonestHost.com, and The Internet Archive at Archive.org. -We encourage you to support our Patrons. -Over the years kind people have donated services and supported equipment for our conferences. - -

    -

    We do not syndicate non HPR Shows.

    -

    -HPR is founded on the principle of Hackers sharing knowledge. -For this reason we are only releasing material created exclusively for HPR. -We will continue to promote new podcasts and other creative commons material, -but if you wish to have your show promoted, -then please contact our sister site Free Culture Podcasts. -

    -

    -That said, if there is a piece of creative commons content that you would like to promote, then feel free to record a regular show. -There you can introduce the content and explain why it is important, providing links to where we can get more information etc., -and then include one example episode. -

    - -

    You are agreeing to license your show - CC-BY-SA.

    -

    -All our shows are now released under a -Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) -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 link for more information. -

    - -

    You have permission to redistribute your show in its entirety - .

    -

    -Never include content, for example music, in your show that you do not have permission to redistribute. -Try to avoid using any content in your show that can not be redistributed under a -Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) -license. -If you are redistributing under another Creative Commons license, GNU Free Documentation License, public domain, -or FLOSS software license, then please signal that when you upload your show. We do not post other copyrighted content, -even if it is made available under fair use, or by arranged permission. -

    - -

    The audio of your show will not be - moderated.

    -

    -We do not vet, edit, moderate or in any way censor any of the audio you submit, we trust you to do that. -Aside from checking snippets for audio quality/spam checking, -we have a policy that we don't listen to the shows before they are aired. -This is a long standing tradition arising from the fact that HPR is a community of peers -who believe that any host has as much right to submit shows as any other. -
    -We do transcode the audio into different formats. -

    -

    -Please note that this only relates to the audio you upload. -The rest of the meta-data (branding/summaries/tags/show notes/etc.), are managed by the HPR Community, -and may be edited. -The show hpr2210 :: On Freedom of Speech and Censorship -describes the agreed approach to this topic. -

    - -

    Your show will be signaled as containing explicit content - .

    -

    -Given that we are an open forum for free speech we signal all our shows as "explicit" with the assumption -that the listeners will apply the required discretion when playing the shows in public. -That said the majority of our content is technical in nature and therefore is often considered appropriate for any audience. -If you feel that your show will be considered inoffensive in every region of the world -then you can signal that when you upload the show. -

    - -

    -When dealing with content that is "explicit" or contains material that would best be suited for a mature audience, -it has become traditional to include a short warning at the very beginning of the show before the intro, -to allow listeners time to switch off the episode should they so desire. -

    - -

    -hpr2210 :: On Freedom of Speech and Censorship -describes the agreed approach to this topic. -

    - -

    You determine when your show will be released.

    -

    -The HPR Schedule is entirely community driven and we recommend that you pick the date or show number -as then you know when your show will be released. -However the slots will only be allocated once the shows have been successfully processed. -Any missing information can result in a show missing the requested slot. -Once the slots have been allocated it is not possible to move them. -

    - -

    All reservations need to be approved.

    -

    -Any host can select any free slot a up to year in advance. However the audio must be ready at time of picking a slot -so that it can be upload immediately afterwards. -

    -

    -In exceptional circumstances it may be necessary to reserve a slot while not having the audio available, -but this must be approved by the HPR Mailing List in advance. -Be sure to allow as much time as possible, and include a reason why you feel it is necessary to reserve the slot. -

    -

    -This is intended only for exceptional circumstances, such as a scheduled interview where we would -like the audio to be released as soon after the event as possible, -or to cover an important topical situation that has occurred. -Due to the extended time now needed to post shows to external sites, -the extra work this entails and the disruptive effect of reservations, -we will no longer be allowing them except in very rare cases of the type mentioned above. -

    -

    -The following are standing reservations: -

    - - -

    We use UTF-8 end to end.

    -
    See the video "Characters, Symbols and the Unicode Miracle - - Computerphile" for an interesting background to ASCII and UTF-8. -
    - -

    Keep accessibility in mind.

    -

    -When you includes 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 <pre> tags) -
    -Include descriptive language in any link texts. -
    -Avoid structures like: "For accessibility information click - here"
    -Rather use: "For more information click our - accessibility page" -

    - -

    Your show will be heard by an International Audience - .

    -

    -We have people listening from all over the world, who may not have the same cultural background as yourself, -therefore you should be as clear as possible when giving details. -For example always give temperatures in both Celsius and Fahrenheit, measurements in Metric and Imperial, -dates in YYYY-MM-DD iso8601 format, -and abbreviations using the NATO phonetic alphabet. -Never assume that your audience knows what age a sixth grader is, or how big a 20 Cent Euro coin is. -Keep in mind that keyboard layouts are also different so make sure to specify the key shape or the position -inrelation to a common known standard. -For example: -

    -
    The at sign normally situated above the 2 key on a US keyboard, and has a unicode number of U+0040. - For more information see Wikipedia
    -

    -An xkcd cartoon showing ISO 8601 -

    - -

    Feed the reserve pool.

    -

    -The reserve pool is intended only to be used in the cases where there is still a gap in the schedule one week prior to release. -This was known as the emergency queue, but now can also be used when the hosts don't care when the shows are scheduled. -They will be used on a first come first go basis, when there is no conflict with the scheduling guidelines. -These shows contain a message alerting listeners to the fact that we had free slots that were not filled. -

    - -

    Scheduling Guidelines

    -
      -
    1. You must have your audio recording ready to upload before you pick a slot.
      2. -
    2. New hosts, Interviews, and other time critical shows should use the first free slot.
      3. -
    3. Always try and fill any free slots that are available in the upcoming two weeks.
      4. -
    4. When the queue is filling up then leave some slots free for new contributors.
      5. -
    5. Post non urgent shows into the first empty week.
      6. -
    6. If you are uploading a series of shows then post them one every two weeks.
      7. -
    7. If you have a non urgent show that is timeless, then add it to the reserve pool.
      8. -
    -
    -
    -
    -
    -

    ↑ Go to top

    -

    Recording a Podcast

    -
    +
    +

    ↑ Go to top

    +

    Recording a Podcast

    +

    On this page you will find information on how to record a podcast. Our golden rule is Any audio is better than no audio. so keep that in mind. Don't forget to introduce yourself in your show.

    Recording with a portable media player - .

    + .

    Many of today's portable media players support recording audio out of the box. Search for "Voice Recorder", to see if there is an application for your smartphone. @@ -540,10 +572,10 @@ and

    Audacity is a free, easy-to-use and multilingual audio editor and recorder for - Windows, Mac OS X, GNU/Linux and other operating systems.
    + Windows, Mac OS X, GNU/Linux and other operating systems.

    When you have finished editing your podcast you can export it.

      -
    1. Confirm that the Project Rate is set to 44100 Hz (bottom left).
      2. -
    2. File -> Export and select FLAC File.
      3. -
    3. Click Options... to reveal FLAC Export Setup.
      4. -
    4. Set Level to 8 (best).
      5. -
    5. Set Bit depth to 24.
      6. +
    6. Confirm that the Project Rate is set to 44100 Hz (bottom left).
      7. +
    7. File -> Export and select FLAC File.
      8. +
    8. Click Options... to reveal FLAC Export Setup.
      9. +
    9. Set Level to 8 (best).
      10. +
    10. Set Bit depth to 24.

    +
    -
    -

    ↑ Go to top

    -

    Please promote HPR.

    -
    +
    +

    ↑ Go to top

    +

    Please promote HPR.

    +

    Feel free to use the promotional material to spread the word in your podcasts, or have them played on to other shows.

    General HPR promotion

    New Year Promo

    + + +
    -
    -

    ↑ Go to top

    -

    Picking a slot for your show

    -
    -

    -Any host can select any free slot a up to year in advance, by recording their show and uploading it to the desired slot. -In exceptional circumstances it may be necessary to reserve a slot while not having the audio available, -but this must be approved by the HPR mailing list in advance. -Be sure to allow as much time as possible, and include a reason why you feel it is necessary to reserve the slot. -

    -

    -This is intended only for exceptional circumstances, such as a scheduled interview where we would like the audio to be -released as soon after the event as possible, or to cover an important topical situation that has occurred. -Due to the extended time now needed to post shows to external sites, -the extra work this entails and the disruptive effect of reservations, -we will no longer be allowing them except in very rare cases of the type mentioned above. -[?] -

    -

    -You can post your show by going to the Calendar page. -Once you have selected a date you will be redirected to the request page, -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 GPG 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. -

    -

    -The audio of your show will not be moderated, however the information provided in the upload form - may be moderated. -All publicly facing material is managed by the HPR Community as a whole, and not just the host providing the show. -The show hpr2210 :: On Freedom of Speech and Censorship -describes the agreed approach to this topic. -

    -

    Note: This email address will be published on the HPR website and will be given out in the feeds, -so please use a public email address for this purpose. -Where we publish it we pad it with dot nospam at-sign nospam dot.
    -i.e. hpr@example.com becomes hpr.nospam@nospam.example.com. -If you do not want to have your email exposed, please contact the admin@hpr team to arrange a alias. -

    -

    -Once you press next, an email will be sent to your email address pointing to where you can upload the show. -You need to open the link within 15 minutes or the temporary lock will be released. -Once you open the link, you can fill in the information at your leisure. -The upload form works on the assumption you will be posting one show at a time, from the same IP address. -Once you have pressed submit you will not be able to edit any of the information. -

    -
    -
    -
    -
    -

    ↑ Go to top

    -

    Adding an Episode

    -
    +
    +

    ↑ Go to top

    +

    Adding an Episode

    +

    The unique link sent by email will allow you to manage both the episode and information about yourself that is displayed on HPR. The following information will be requested: @@ -713,119 +700,119 @@ in the feed with some anti-spam additions.
    For example hpr@example.com will become hpr.nospam@nospam.example.com

    Your profile information is used on the website, in the RSS feeds, and on social media sites. You can change your profile information at any time, by submitting another show.

    Episode Information

    Press submit and your show will be sent to the HPR Volunteers to be processed. @@ -833,243 +820,203 @@ Keep an eye on the calendar for Your show information is used to process the media files, on the website, in the RSS feeds, and on social media sites.

    +
    -
    -

    ↑ Go to top

    -

    Workflow

    -
    +
    +

    ↑ Go to top

    +

    Workflow

    +
      -
    1. REQUEST_UNVERIFIED -
      2. -
    2. REQUEST_EMAIL_SENT - email sent
      3. -
    3. EMAIL_LINK_CLICKED - pending upload
      4. -
    4. SHOW_SUBMITTED - upload complete
      5. -
    5. METADATA_PROCESSED - shownotes.{json,txt} processed to html
      6. -
    6. SHOW_POSTED - show in the database
      7. -
    7. MEDIA_TRANSCODED - audio all generated
      8. -
    8. UPLOADED_TO_IA - on the IA and visible
      9. -
    9. UPLOADED_TO_RSYNC_NET - archived on rsync.net
      10. +
    10. REQUEST_UNVERIFIED -
      11. +
    11. REQUEST_EMAIL_SENT - email sent
      12. +
    12. EMAIL_LINK_CLICKED - pending upload
      13. +
    13. SHOW_SUBMITTED - upload complete
      14. +
    14. METADATA_PROCESSED - shownotes.{json,txt} processed to html
      15. +
    15. SHOW_POSTED - show in the database
      16. +
    16. MEDIA_TRANSCODED - audio all generated
      17. +
    17. UPLOADED_TO_IA - on the IA and visible
      18. +
    18. UPLOADED_TO_RSYNC_NET - archived on rsync.net
    +
    -
    -

    ↑ Go to top

    -

    Frequently Asked Questions

    -
    -

    0.1 What is Hacker Public Radio?

    - +
    +

    ↑ Go to top

    +

    Frequently Asked Questions

    +
    +

    0.2 What is a show?

    -

    0.3 - Can I submit a show made for another podcast?

    - +

    0.4 - What defines a show as being "Produced for Hacker Public Radio"?

    + What defines a show as being "Produced for Hacker Public Radio"?

    0.5 - What are the mandatory elements of an HPR show?

    + What are the mandatory elements of an HPR show?

    0.6 What are tags?

    0.7 - Is it OK if I don't include notes with my show?

    + Is it OK if I don't include notes with my show?

    0.8 - How do I include photographs or other files with my show?

    + How do I include photographs or other files with my show?

    0.9 - What is and is not edited in a show after submission?

    + What is and is not edited in a show after submission?

    0.10 - What are some common errors in show notes?

    + What are some common errors in show notes?

    It depends on the note format to some extent:

    0.10.1 HTML notes

    0.10.2 Markdown notes

    0.10.3 General errors

    0.11 - If I notice an error in my show's details how can it be fixed?

    + If I notice an error in my show's details how can it be fixed?

    0.12 - Does hobbypublicradio.com have anything to do with HPR?

    + Does hobbypublicradio.com have anything to do with HPR?

    0.13 - How can I talk to other HPR hosts and listeners?

    + How can I talk to other HPR hosts and listeners? -

    0.14 Why has HPR not got a Wikipedia page?

    -

    -Once someone contributes to Public Radio, the Wikipedia rules prevent us from editing a page. -You can of course create one prior to contributing a show, or ask for one to be created. -

    -

    -We do of course believe that Public Radio should have a Wikipedia entry. -We are one of the longest running podcasts having started as Today with a Techie on 2005-09-19. -We also are unique in our community driven approach to producing shows. -And of course the fact that Wikipedia itself references us as a source -[1], -[2], -[3], -[4], -[5]

    0.15 I'd like to post a show but I would - rather not have my email address published on the site.?

    + rather not have my email address published on the site.?

    The mail is just a way for us to get back to you if there was an issue posting the show.

    diff --git a/templates/content-syndication.tpl.html b/templates/content-syndication.tpl.html index 6ec5332..0c04d4e 100644 --- a/templates/content-syndication.tpl.html +++ b/templates/content-syndication.tpl.html @@ -134,5 +134,7 @@
  • mp3:
    curl 'eps/hpr[0001-].mp3' -o "hpr#1.mp3"
    • +
    +