From 756151908dd4a08d9d6792f4c44180236ed39264 Mon Sep 17 00:00:00 2001 From: Ken Fallon Date: Mon, 1 Jun 2026 21:52:04 +0200 Subject: [PATCH] Documentation Update --- templates/content-about.tpl.html | 2 +- templates/content-contribute.tpl.html | 1092 +++++++++++-------------- 2 files changed, 467 insertions(+), 627 deletions(-) diff --git a/templates/content-about.tpl.html b/templates/content-about.tpl.html index 4a987e2..353271a 100644 --- a/templates/content-about.tpl.html +++ b/templates/content-about.tpl.html @@ -96,7 +96,7 @@ If you listen to HPR, then we would love you to contribute<

We trust you not to do anything that will harm HPR. We don't tolerate Harassment, Trolling, etc. If you notice anything of concern, -first see if a response episode is sufficient to address the grievance. +first see if a response episode is sufficient to address the grievance. If not then please bring it to the attention of the janitors. Any material that is reported as harming HPR may be unlisted until such a time as the situation can be resolved.

diff --git a/templates/content-contribute.tpl.html b/templates/content-contribute.tpl.html index 2280326..5b43aea 100644 --- a/templates/content-contribute.tpl.html +++ b/templates/content-contribute.tpl.html @@ -3,30 +3,15 @@
@@ -187,6 +172,53 @@ 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.

+
+Your audio must be ready before you pick a slot. +

+Any host can select any free slot a up to year in advance, +but the audio must be ready at time of picking a slot. +

+

+In exceptional circumstances it may be necessary to reserve a slot while not having the audio available. +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: +

+
    +
  • Anniversary episodes.
    • +
  • HPR Community News on the first Monday of the month.
    • +
  • The first day of the fourth month.
    • +
  • The days following new year.
    • +
+
+ +
+Leave two weeks between your shows. +

+All hosts must leave at least 9 slots (approximately two weeks) between their shows. +This is to avoid a given host, or topic taking over the queue. +

+
+ +
+We will not move shows once they are scheduled. +

+Once a show has been posted it is not possible to move them +to another slot. +

+
+
Your email will be made public.

@@ -335,7 +367,11 @@ On this page you will find information on how to record a podcast.

Recording Tips.

-FLAC is best, we accept the rest. +Lossless FLAC Level 8 (best) 44100 Hz, 24 bit depth. + +

+FLAC is best, we accept the rest. +

Our recommended setting for recording is 44100 Hz, 24 bit depth, saved as Lossless FLAC Level 8 (best).

@@ -348,9 +384,6 @@ and set everything else to the highest setting.

If your recording setup can't do that, then pick a lossless format, with the highest sample rate you can.

-

-For more tips see the In-Depth Series: Podcasting HowTo. -

@@ -385,20 +418,49 @@ so this may be the first time to hear your voice.

- -

Recording with a Smartphone.

+
+Avoid Bedding/background music.

-Search for "Voice Recorder", to see if there is an application for your smartphone. - +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 truncate silence from working correctly.

-Then just record your show, request a slot, -and we'll do the rest. +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.

+
+
+We mix down to Mono. +

+We will by default mix down your show to one channel mono and we will +transcode to opus, 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. +

+
-

+
+No need to add Metadata to the file. +

+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. +

+
+
+Do not add any Theme to the show. +

+The HPR Intro, and the Outro will be added automatically. +While we did ask people to add it in the past, this is no longer the case. +

+
+ +

Recording.

+
+Recording with a Smartphone.

Some of our hosts recommend Audio Recorder by Dmytro Ponomarenko on Android. It's available on F-Droid @@ -417,8 +479,12 @@ These are the recommended settings:

  • Recording Mode: Mono
  • Audio Quality: Lossless
    • +
    -

    Recording/Editing using your Computer.

    +
    +Recording/Editing using your Computer. +

    +

    The majority of podcasters use Audacity. First set the Project Rate to 44100Hz, then you can either record your show in Audacity itself or @@ -431,7 +497,7 @@ import the file you recorded earlier and edit it as you wish.

    Audacity is a free, easy-to-use and multilingual audio editor and recorder for Windows, Mac OS X, GNU/Linux and other operating systems.
    - +Video of hpr1404 Ken Fallon Editing prerecorded audio in Audacity

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

    @@ -447,17 +513,10 @@ When you have finished editing your podcast you can export it. sizes="(max-width: 460px) 95vw, 640px" src="images/contribute-audacity-export.png" alt="Audacity Export Settings" title="Audacity Screenshot of an Export" >

    +
    -

    Recording Interviews with the Phone.

    -

    -If you want to record a one-to-one interview with someone then you can use -Skype in conjunction with Skype Call Recorder. -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 portable media player. -

    - -

    Recording round table discussions.

    +
    +Recording round table discussions.

    If you would like to record with multiple participants then you can use Mumble. Connect to chatter.skyehaven.net Port: 64738 .
    @@ -465,637 +524,418 @@ Walk through the audio wizard and then pop into the Hacker Public Radio< Once you are ready press the recording button, select multichannel and then start. That will record multiple tracks, one for each participant which you can edit and then submit.
    -Kwisher made a Mumble tutorial -which you might find useful and Delwin -has produced a number of short shows on how to configure the audio quality. +The Mumble tutorial has more information. +Thanks to Delwin for providing the server.

    Audacity Can Record

    +
    -

    Avoid Bedding/background music.

    -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 truncate silence from working correctly.
    -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. +For more tips see the In-Depth Series: Podcasting HowTo.

    -

    We mix down to Mono.

    -

    -We will by default mix down your show to one channel mono and we will -transcode 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. -

    - -

    No need to add Metadata to the file.

    -

    -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. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    3. Record your show.

    -

    -Please select more detailed information -on how to record a show: -

    - -

    Don't forget to introduce yourself in your show.

    - -

    4. Upload your show.

    +
    +
    +
    +

    ↑ Go to top

    +

    Deciding when your show is released

    +

    +The HPR Schedule is entirely community driven, so you decide when your show will be released. Once you have your audio ready you can post your show by going to the Calendar -page or press the ⇧Upload⇧ button. +page.

    -After 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 so it must be a valid working address -that you can access quickly. +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 slots +for new contributors. +

    + +
    +If you do not care when your show will be released, +then you can just add it to the reserve pool. +

    +This is intended for non urgent show that are timeless, as there may be a year or more before the show gets aired. +Reserve shows should not be dependant on others in the reserve pool, as they may be posted out of order.

    -More Information. +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. +

    +

    +These shows will contain a message alerting listeners to the fact that a reserve show is in use. +The severity of the message +will increase as the number of reserve shows decrease. +

    + +
    +

    +

    - - - -
  • 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: -

    -
      -
    • Anniversary episodes.
      • -
    • HPR Community News on the first Monday of the month.
      • -
    • The first day of the fourth month.
      • -
    • The days following new year.
      • -
    - - -

    .

    -

    .

    -

    .

    -

    .

    -

    .

    - -
    -
    -
    -

    ↑ 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. -

    -

    - 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. -

    - -
      - - -

      Questions ?.

      +
      +You should then see a thank you page.

      -Got any questions not covered here, then just email "admin" at "HPR", -and we'll get in touch with you with all you need to know about getting your show published.
      -You can chat with other podcasters using IRC in the #oggcastplanet channel on the -libera.chat network. -Follow us on Mastodon (use the tag #hpr) -and on Twitter (use the tag #hpr). -We have a Facebook and -LinkedIn group, -so please join and spread the word.

      - -

      Response Episode

      - -https://lists.hackerpublicradio.com/pipermail/hpr/2021-September/004250.html - -

      Our Mottos

      -
      Any audio is better than no audio.
      -
      Any topic of intrest to s.
      -
      It ain't a show unless it's on the server.
      -
      If you tell us you are doing a show, then you owe us a show.
      - -

      You don't need anyones permission to upload a show, but if you have any questions then drop into the -#oggcastplanet channel on libera.chat -and chat with a live person 24/7. + +

      +
      +

      +The thank you page, and confirmation email, both contain all the information we collect about you.

    - -
    -
    -

    ↑ 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

    - +
    +

    ↑ Go to top

    +

    Confirmation Email

    +
    -

    New Year Promo

    +

    +You will then send you a unique link which you can use to upload your show. +

    + +
    +The Confirmation Email may be marked as spam. +

    +The email should arrive within seconds of you pressing next above. +We have had reports that sometimes gmail and hotmail consider the messages as spam. +If it is not there within five minutes, then please check your spam folder. +

    + +

    +Please consider whitelisting +the email address robot@hobbypublicradio.com. +

    +
    + +
    +The reservation expires after 15 Minutes. +

    +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. +

    +
    + +
    +The slot will be released after 4 hours. +

    +Once you open the link, you have a maximum of 4 Hours to post your show. +If you do not do so then the entire reservation will be removed so another host can avail of the slot. +

    +
    + +
    +You must upload from the same IP Address. +

    +As a security measure, you must upload your show for the same IP Address as your reservation. +

    +

    +This can be caused by

      -
    • HPR New Years Promo
      • +
    • Making a request on one network (work), and processing it on another (home)
      • +
    • Your ISP is using NAT, and is assigning a new ip from the pool for the next request
      • +
    • You are using a VPN, and the IP address changed.
      • +
    • Your router rebooted and you got a new IP address.
      • +
    • You switched from 5G to WiFi.
    +

    +
    + +
    +You can only reserve one show at a time. +

    +As a security measure, we do not allow multiple reservations. +Your first show must be posted before you can reserve a slot for your second. +

    +
    + +
    +We share what we log. +

    +We log the date you uploaded, from which IP Address you used, and your user agent. +Once your show is processed this information is removed from the database. +

    +
    + +
    +You can also delete the reservation. +

    +Click on the link supplied, and select "Delete this reservation ..." at the bottom of the page. +

    +
    + +

    + +

    +
    - -
    -
    -

    ↑ Go to top

    -

    Adding an Episode

    -
    +
    +

    ↑ Go to top

    +

    Uploading 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: +When you click on the link sent by email, you can manage both the episode, and information about yourself that is displayed on HPR.

    -

    Personal Information

    -Remember All information will be displayed publicly. The only exception is that your email address will be sent -in the feed with some anti-spam additions.
    +All information you provide will be displayed publicly. +

    +

    +The only exception is that your email address will be sent +in the feed with some anti-spam additions. For example hpr@example.com will become hpr.nospam@nospam.example.com

    -
      -
    • email: already populated
      - See notes above
      -
      • -
    • image: Optional
      - If you have associated a Gravatar image with an email address, - then it will be displayed here. - Otherwise you can upload a 80x80 image .
      • -
    • Name/Handle: Mandatory
      - It should be the name you wish to be known as on HPR. It can be your real name, an Internet handle or both.
      • -
    • Your Default license: Mandatory
      - This field tells us what your work is normally licensed under. 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.
      • -
    • Profile: Optional
      - Enter some text about yourself with links to your blog or other online presence.
      • -
    + +

    Personal Information

    +

    -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. +Your profile information is used on the website, in the RSS feeds, and on social media sites.

    + +
    +email: already populated. +

    +Your email is the one provided in the request form earlier. +

    +

    +Please always use the same email for HPR, as otherwise we will consider you a new host. +Contact the Janitors and they will change your email address for you. +

    +

    +Some hosts like to set up an email alias, or add a +hpr after their email name. +Expand the notes above for more information. +

    +
    + +
    +image: Your profile picture/avatar. +

    +Optional +

    +

    +If you have a Gravatar image associated with an email address, then we will use that. +Otherwise you can upload a profile image. +

    +
    + +
    +Name/Handle: How you wish to be know. +

    +It should be the name you wish to be known as on HPR. It can be your real name, an Internet handle or both. +Contact the Janitors and they will change your Handle for you. +

    +
    + +
    +Your Default license: defaults to CC-BY-SA. +

    +This field tells us what your work is normally licensed under. +

    +

    +We recommend you use a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license. +That 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. +

    +

    +We allow the following licenses: +

      +
    • CC 0 - This is a public domain license.
      • +
    • CC BY - This license is similar to a MIT/BSD source software license.
      • +
    • CC BY-SA - This license is similar to a copyleft free and open source software license and is our default license.
      • +
    • Other - This is for other OSI Approved Licenses.
      • +
    +

    +
    + +
    +Profile: Where people can find more information about you. +

    +Optional +

    +

    +Enter some text about yourself with links to your blog or other online presence. +You can use the what you see is what you get. +Format your profile as you would like it rendered. +

    +
    + +

    +You can change your profile information at any time, by submitting another show. +

    + + +

    Episode Information

    +

    +Your show information is used on the website, in the RSS feeds, and on social media sites. +

    + + +
    +Title: A descriptive title. +

    Mandatory

    +

    +This will be a short 100 character descriptive title and will be used everywhere to identify your show. +Any valid utf-8 character is acceptable, but keep the length short and clear. +

    +
    + +
    +Summary: A short summary of what your show is about. +

    Mandatory

    +

    +This is a short 100 character summary of what your show is about. +Please fill this out as it is used once the show has gone off the main page, on the mobile site, +on printed brochures, on text to speech announcements, on Mastodon etc.
    +Please refer to yourself in the third person. Instead of "I talk ...", rather use ""Bob talks ...". +

    +
    + +
    +Explicit: If your show is Explicit or Clean. +

    Mandatory

    +

    +See iTunes for more information. +We flag HPR as Explicit by default but you are free to mark it Clean if you wish. +Expand the note about explicit content above. +

    +
    + +
    +License: defaults to CC-BY-SA. +

    Mandatory

    +

    +This field tells us what your work is licensed under. +

    +

    +We recommend you use a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license. +That 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. +

    +

    +We allow the following licenses:

      -
    • Title: Mandatory
      - This will be a short descriptive title and will be used everywhere to identify your show. Any valid UTF-8 character is acceptable, but keep the length short and clear.
      • -
    • Summary: Mandatory
      - This is a short 100 character summary of what your show is about. - Please fill this out as it is used once the show has gone off the main page, on the mobile site, - on printed brochures, on text to speech announcements, on twitter, Mastodon etc.
      • -
    • Theme: Automatic
      - The Intro, and the Outro will be added automatically. Please do not add it. +
    • CC 0 - This is a public domain license.
      • +
    • CC BY - This license is similar to a MIT/BSD source software license.
      • +
    • CC BY-SA - This license is similar to a copyleft free and open source software license and is our default license.
      • +
    • Other - This is for other OSI Approved Licenses.
      • +
    +

    +
    + +
    +Show Notes: Enter a description about your show, including links to the topics you discussed.. +

    Mandatory

    +

    +You can use the what you see is what you get/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. +

    +

    +You can include images as well. We automatically create thumbnails, +so please upload and place the full size images in the notes. +Add the descriptive text under the image. +

    +

    +Optionally - You can paste in Rendered HTML but we will remove any styling. +

    +

    +Do not paste un-rendered markup (HTML, Markdown, RestructuredText) unless your intention is to have un-rendered markup as shownotes. +

    + +

    +It is important to provide good show notes because: +

      +
    • They provide the listeners with more information on the topic.
      +You have taken the time to record a show on a topic, so many people will want to find out more on the subject, +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. +
      • +
    • They ensure your show gets posted on time.
      +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.
      • +
    • They encourage people to download your show.
      +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 +it will get as many downloads as other shows with good show notes.
      • +
    • They allow your show to be indexed by search engines.
      +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.
      • +
    • They make your show accessible to the deaf and hard of hearing.
      +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. +If you are using a script to prepare your show then include that.
      • +
    +

    +
    + +
    +Series: Select a series from the drop down. +

    Optional

    +

    +See if your show fits into a series. +

    +
    + +
    +Tags: Add a list of comma separated tags. +

    Mandatory

    +

    +Pick the most important words from the show notes. +Your tags are added as #hashtags on social media. +Helps people find your show by topic keyword on our +tags page. +

    +
    + +
    +Upload Method: How you are going to send us your audio. +

    Mandatory

    +
      +
    • Upload now via this browser
      + 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.
      • -
    • Explicit: Mandatory
      - See iTunes - for more information.
      • -
    • License: Mandatory
      - 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.
      • -
    • show notes: Mandatory
      - It is important to provide good show notes because: -
        -
      • They provide the listeners with more information on the topic.
        - You have taken the time to record a show on a topic, so many people will want to find out more on the subject, - 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. -
        • -
      • They ensure your show gets posted on time.
        - 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.
        • -
      • They encourage people to download your show.
        - 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 - it will get as many downloads as other shows with good show notes.
        • -
      • They allow your show to be indexed by search engines.
        - 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.
        • -
      • They make your show accessible to the deaf and hard of hearing.
        - 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. - If you are using a script to prepare your show then include that.
        • -
      • Adding the shownotes -
          -
        • Add text and use the WYSIWYG editor buttons to add additional formatting
          • -
        • Optionally - You can paste in Rendered HTML
          • -
        • Do not paste un-rendored markup (HTML, Markdown, - RestructuredText) unless your intention is to have un-rendored - markup as shownotes.
          • -
        -
        • -
      -
      • -
    • Series: Optional
      - Select the series if any that your show is a part of.
      • -
    • Tags: Optional
      - Add a list of comma separated tags. Pick the most important words from the shownotes. - These are used to find shows via the tags page.
      • -
    • Upload Method: Optional
      - You have the choice of the following options:
      -
        -
      • Upload now via this browser
        - 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 install a - plugin, or just wait. -
        • -
      • Provide a url for us to get it from
        - Using this option may cause delays as a HPR volunteer will need to troubleshoot any issues that may occur, - and this can result in your show not been posted on time. - This must be publicly accessable using a curl or wget command. - Please avoid services that require login or downloading via a browser. -
        • -
      • Other
        - The postal information will be sent to you after submission. -
        • -
      -
      - If you want to submit an additional file with your show, then put them in a zip, or tgz file. - This should expand to a directory with a index.html file that refers to the other files. - This will be hosted in the eps directory under a new directory with the episode number. - 
      -    eps/hpr9999/full_shownotes.html
-    eps/hpr9999/other-file.pdf
-    eps/hpr9999/yet-other-file.c
-    ...
-
      - Ensure that all links are full urls, as relative urls will not work in RSS feeds. - Adding additional files will delay processing as they need to be verified manually.
      • +
    • Provide a url for us to get it from
      + Using this option may cause delays as a HPR volunteer will need to troubleshoot any issues that may occur, + and this can result in your show not been posted on time. + This must be publicly accessable using a curl or wget command. + Please avoid services that require login or downloading via a browser.

    -Press submit and your show will be sent to the HPR Volunteers to be processed. +If you want to submit an additional file with your show, then put them in a zip, or tgz file. +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 "example._output.pdf", without any paths. +

    +
    + + +

    +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. +

    + +

    +Press submit and your show will be sent to the HPR Volunteers to be processed. Keep an eye on the calendar for when it is posted. -Your show information is used to process the media files, on the website, in the RSS feeds, and on social media sites. +For more information on the the process of Uploading a show. +and Show Processing can be found on our GitTea repo.

    -
    -
    -
    -
    -

    ↑ 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. -
    -
    - -
    -
    -
    -

    ↑ Go to top

    -

    Frequently Asked Questions

    -
    - -

    0.2 What is a show?

    -
      -

    • A show is your audio presentation (which we do not moderate), - with an intro, outro, a title and a summary.

      • -

    • The audio is the recording you have made and sent in to HPR.

      • -

    • The intro (introduction) is a piece of audio introducing the show. The components are:

      -
        -
      • a synopsis taken from the details submitted with the show (added automatically)
        • -
      • acknowledgement of our hosting provider (added automatically)
        • -
      • HPR introduction music (added automatically)
        • -
      • -

    • The outro is added automatically. It contains the HPR outro music.

      • -

    • Each show needs a title to describe what it is about.

      • -

    • Similarly, a summary helps to add more information describing the show so a potential listener - can decide whether to listen to it or not.

      • -

    • Each show is expected to have certain mandatory attributes listed - below.

      • -

    • HPR shows are usually expected to be informative or educational, and as such some sort of accompanying written material - is highly desirable. This might consist of brief notes, links to relevant web sites, or possibly longer notes - and examples. Photographs, diagrams and example files are also welcome if the host feels - it helps to get the message across.

      • -

    • Shows are released under a Creative Commons Attribution-ShareAlike 3.0 Unported license. - See Stuff you need to know - for much more detail about this and related issues.

      • -

    • As a contributor you can choose when your show will be released. - We only release one show a day, during week days, - but if a slot is free you can claim it. Go to the calendar - page to do this. You need to have your show ready to upload before you reserve a slot though.

      • -
    - -

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

    -
      -
    • If you create material and post it first on HPR then it meets the requirements of "being produced for HPR". - That means once you upload it to the HPR server you can publish it anywhere else you like.
      • -
    -

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

    -
      -

    • See Picking a slot for your show - for the full details of how to submit a show and what information is required.

      • -

    • A quick summary of the main components is:

      -
        -
      • A show title
        • -
      • A summary of what the show is about
        • -
      • The explicit/clean flag
        • -
      • License
        • -
      • Show notes
        • -
      • Tags
        • -
      • Audio
        • -
      • -
    -

    0.6 What are tags?

    -
      -

    • We are trying to maintain a collection of tags to allow people to find shows on the same (or similar) topic.

      • -

    • Tags are simple words or short phrases describing aspects of a show such as what topics are covered in it. - To get hints about what tags have already been used you can view all the current tags in alphabetical order on this page: - Tag summary

      • -

    • Some examples are: android, creative commons and gaming.

      • -

    • Are there any tags that are best avoided?

      • -
    -

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

    -
      -
    • Please don't do that. It is important to provide good show notes for reasons described on the - Picking a slot for your show page: -
        -
      • They provide the listeners with more information on the topic your show is covering
        • -
      • They ensure your show gets posted on time (the volunteers don't have to make notes for you)
        • -
      • They encourage people to download your show
        • -
      • They allow your show to be indexed by search engines
        • -
      • They make your show accessible to the deaf and hard of hearing
        • -
      • -
    -

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

    -
      -
    • TBA
      • -
    -

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

    -
      -

    • We don't listen to the audio before posting a show to the website, so we don't change the content.

      • -

    • Unless you have done so and told us you have, we add an introduction to the audio announcing what it is. - Similarly we add an outro. This is not editing since we don't change the content.

      • -

    • We may make changes to the show title, summary or tags. Usually these are minor changes such as spelling corrections. - The intention is not any sort of censorship, merely to make these items more understandable or easier to index.

      • -

    • Depending on the form the show notes take we may modify these.

      -
        -
      • If what is submitted is plain text we convert it to Markdown in order to generate HTML.
        • -
      • If the notes are one of the permitted markup formats (mostly Markdown flavours) we may adjust this to ensure - that valid HTML is generated.
        • -
      • If the notes are HTML we run them through an HTML checker and correct any mistakes it highlights.
        • -
      • We may correct spelling, grammar and punctuation if this clarifies anything which might otherwise be unclear.
        • -
      • If despite the request for show notes of some kind, none are provided, we may add notes which help to clarify - the content of the show. This may be done after the show is released (when we have had a chance to listen to it).
        • -
      • -

    • We are working on the production of reports about any changes made, which will be sent to the host after we have - processed the show.

      • -

    • We may make changes to a show's metadata if the host requests it (see the item on - - fixing errors after upload).

      • -

    • If a show contains links to resources which disappear after a period of time, we may at some future time change - the notes to refer to any Wayback Machine copy that can be found.

      • -
    -

    0.10 - What are some common errors in show notes?

    -

    It depends on the note format to some extent:

    -

    0.10.1 HTML notes

    -
      -

    • It's very easy to hand-write bad HTML. That's why we use an HTML checker on it, and fix the errors it reports.

      • -

    • A common fault is to write <code><pre> to define a pre-formatted block of text using a fixed-width font. - However it's illegal because the <pre> tag can't be enclosed in other tags like - <code>. Use <pre><code> instead.

      • -
    -

    0.10.2 Markdown notes

    -
      -
    • This is quite a forgiving format. Some people embed HTML in the Markdown, and the HTML used suffers from some - of the issues discussed in this document. These are much harder to spot. The HTML checker can't - really help unless it's run on the output from Pandoc.
      • -
    -

    0.10.3 General errors

    -
      -

    • Spelling is often an issue in notes. As the notes are processed they are edited in the Vim editor with the - spell check option turned on. In most cases spelling problems flagged by Vim are corrected.

      • -

    • Grammar and punctuation can also be issues. We do not have very effective grammar checking tools in the note - preparation workflow. Modifications may be made to split up extra-long (often comma-spliced) sentences, - rationalise the use of capital letters and similar.

      • -
    -

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

    -
      -

    • The HPR administrators can make changes to show titles, summaries, notes and so forth. Ideally send an - email to admin at publicradio.org explaining what the problem is and we'll fix it for you. - We'll also ensure that the changes are propagated to the relevant page on archive.org.

      • -

    • Don't be tempted to send in your corrections as a comment. Comments are not propagated to archive.org, so people - referring to that copy will not see the changes.

      • -
    -

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

    -
      -

    • Some environments prevent access to sites which use the word 'hacker' or 'hackers' - in their names (or content in extreme cases). The site names hobbypublicradio.{com,net,org} have been created, - which link to the main HPR site, in order to get around this restriction.

      • -

    • See the mailing list thread here: - - https://lists.hackerpublicradio.com/pipermail/hpr/2015-February/002493.html

      • -
    -

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

    -
      -
    • You have a number of choices: -
        -
      • The mailing list is where various - policy matters are discussed and announcements made. You need to be a member of the list to post to it. - Visit the listinfo page to sign up.
        • -
      • You can join the #oggcastplanet channel on IRC. - Visit the freenode.net network to sign up.
        • -
      • A number of HPR messages may be found on Twitter and - Mastodon.
        • -
      • There is a chat group on Telegram
        • -
      • An HPR tradition exists where we record a 26-hour show at the turn of the year celebrating the - arrival of the New Year around the world. We use Mumble to record the show and anyone can connect - to the Mumble server and speak to other HPR listeners and hosts. The recording is used to make multiple - shows which are released when they are ready.
        • -
      • -
    - -

    -