Help:How to Contribute: Difference between revisions
(general editing; added number of 'needs...' category members) |
(general edit - feedback/additions welcome!) |
||
Line 29: | Line 29: | ||
(needs better section title) | (needs better section title) | ||
Whilst transcribing an episode, it is a good idea to keep in mind other aspects of the transcription page that you might want to | Whilst transcribing an episode, it is a good idea to keep in mind other aspects of the transcription page that you might want to include, as you will be familiar with the content, and able to identify the most important points. For example, it can be easy to note the times at which each segment begins and the topic categories that are covered when transcribing. In the same way, when an interesting fact comes up, you might want to add it to the 'Today I Learned' list for the episode (see [[#Today I Learned...|below]]). | ||
If you'd like to transcribe without adding other features, that's absolutely fine, and plenty of work in itself. If you come across something you want to point out to others editing the page, you can insert a comment in the editing box. For example, if you come across a fact for the 'Today I Learned' list, or a good quote from one of the Rogues, you can insert a comment using <code><nowiki><!--</nowiki></code> and <code><nowiki>--></nowiki></code>. This won't show on the regular page, but will be included in the page's edit box. | If you'd like to transcribe without adding other features, that's absolutely fine, and plenty of work in itself. If you come across something you want to point out to others editing the page, you can insert a comment in the editing box. For example, if you come across a fact for the 'Today I Learned' list, or a good quote from one of the Rogues, you can insert a comment using <code><nowiki><!--</nowiki></code> and <code><nowiki>--></nowiki></code>. This won't show on the regular page, but will be included in the page's edit box. | ||
Line 61: | Line 61: | ||
== Formatting == | == Formatting == | ||
''(not sure what else, if anything, should be included here)'' | |||
A list of pages needing to be formatted can be found at [[:Category:Needs formatting]] (currently includes {{PAGESINCATEGORY:Needs formatting}} {{#ifeq: {{PAGESINCATEGORY:Needs formatting}}|1|entry|entries}}). | A list of pages needing to be formatted can be found at [[:Category:Needs formatting]] (currently includes {{PAGESINCATEGORY:Needs formatting}} {{#ifeq: {{PAGESINCATEGORY:Needs formatting}}|1|entry|entries}}). | ||
=== Wiki Mark-up === | === Wiki Mark-up === | ||
===Page skeletons=== | ===Page skeletons=== | ||
[[Episode skeleton]] | The [[Episode skeleton]] contains the general structure of a transcription page, including section headings, infobox (see next section), outro and navigation templates. For 5X5 episodes, use the [[5X5 skeleton]]. These pages can be copied to new transcript pages and built upon by changing headers and adding text and links. | ||
=== Infobox === | === Infobox === | ||
[[Help:Episode infobox]] | The infobox appears on the right-hand side of every transcription page, outlining certain information about the podcast, including, among other things, the broadcast date, any guests on the show, a key for speakers and links to the shownotes, podcast and SGU forum page. | ||
The [[Help:Episode infobox]] page gives an explanation of how to enter input into an infobox to customize it for each episode. For help customizing the infobox for 5X5 episodes, see [[Help:5X5 infobox]]. | |||
== Links == | == Links == | ||
Line 74: | Line 79: | ||
Transcript pages should include all of the links available in the podcast show notes page at [http://www.theskepticsguide.org/archive/podcast.aspx?mid=1 theskepticsguide.org]. | Transcript pages should include all of the links available in the podcast show notes page at [http://www.theskepticsguide.org/archive/podcast.aspx?mid=1 theskepticsguide.org]. | ||
Enter these immediately after the relevant segment title, and use a descriptive format for the linking text, instead of the raw URL. For example, instead of: | Enter these immediately after the relevant segment title, and use a descriptive format for the linking text, instead of the raw URL. An easy way of doing this is to include the name of the source of the page (e.g. the website), followed by a colon and the title of the page or article. For example, instead of: | ||
:http://theness.com/neurologicablog/index.php/modern-medical-zombies/ | :http://theness.com/neurologicablog/index.php/modern-medical-zombies/ | ||
Line 93: | Line 98: | ||
<br>''(are wiki links prefered???)'' | <br>''(are wiki links prefered???)'' | ||
Most of these links can be added to text in the transcript itself, however, there are some cases for which there is no appropriate | Most of these links can be added to text in the transcript itself, however, there are some cases for which there is no appropriate text to turn into the link. For these, use references, see [[Help:Getting Started#References]]. | ||
==Categories == | ==Categories == | ||
A nice easy way to search through SGUTranscripts is to browse through categories, see the [[User:Teleuteskitty/Draft_Browse_Categories| browse categories]] page. <!-- update link when apt --> | A nice easy way to search through SGUTranscripts is to browse through categories, see the [[User:Teleuteskitty/Draft_Browse_Categories| browse categories]] page. <!-- update link when apt --> | ||
When a page has been categorized, the relevant categories are automatically listed at the bottom. | |||
Episode pages that haven't been added to categories are listed in [[:Category:Needs categories]] (currently includes {{PAGESINCATEGORY:Needs categories}} {{#ifeq: {{PAGESINCATEGORY:Needs categories}}|1|entry|entries}}). | Episode pages that haven't been added to categories are listed in [[:Category:Needs categories]] (currently includes {{PAGESINCATEGORY:Needs categories}} {{#ifeq: {{PAGESINCATEGORY:Needs categories}}|1|entry|entries}}). | ||
===Using template === | ===Using template === | ||
To add categories to a full SGU episode, include [[Template:Page categories]], for 5X5 episodes, use [[Template:5X5 categories]]. The template pages show the available categories and | To add categories to a full SGU episode, include [[Template:Page categories]], for 5X5 episodes, use [[Template:5X5 categories]]. The template pages show the available categories and the input needed. The category templates add the page to the available categories, and apply a sort key based on the page name to separate out full episodes from section links on the category pages, and keep numbered order (e.g. see [[:Category:Nature & Evolution]]). | ||
For this reason, if you are applying a category to any other | For this reason, if you are applying a category to any page other than an episode transcription, you should use the regular way of applying categories (e.g. <code><nowiki>[Category:Nature & Evolution]</nowiki></code>). This will avoid using an inappropriate sorting key. | ||
=== Categorized segment redirects === | === Categorized segment redirects === | ||
SGU podcasts cover a multitude of topics | SGU podcasts cover a multitude of topics in a single episode, which can make it difficult to find exactly what you're looking for. To allocate individual segments to categories, and list them on category pages under a relevant title, a redirect page is needed. | ||
For example, episode 1 contains a segment on exploding toads, and was entered into the category 'Nature & Evolution'. However, on the category page for 'Nature & Evolution', listing 'SGU Episode 1' is not very informative. However, making a page with the title 'Exploding toads baffle scientists (1)' that redirects straight to the segment, and categorizing ''that'' under 'Nature & Evolution', will make it much clearer. | For example, episode 1 contains a segment on exploding toads, and was entered into the category 'Nature & Evolution'. However, on the category page for 'Nature & Evolution', listing 'SGU Episode 1' is not very informative. However, making a page with the title 'Exploding toads baffle scientists (1)' that redirects straight to the segment, and categorizing ''that'' under 'Nature & Evolution', will make it much clearer. | ||
Line 125: | Line 130: | ||
*'''Science or Fiction''' segments can have a redirect for each topic, but as these present information differently to other podcast segments, you should also include "SoF" in the brackets to inform readers, e.g. [[Black holes: Mass limit calculated (165 SoF)]] | *'''Science or Fiction''' segments can have a redirect for each topic, but as these present information differently to other podcast segments, you should also include "SoF" in the brackets to inform readers, e.g. [[Black holes: Mass limit calculated (165 SoF)]] | ||
Other titles should be short and informative, and | Other titles should be short and informative, and can often be based on the segment heading in the SGU show notes, but remember that they need to be unique, and descriptive in order to differentiate between them on a category listing page. | ||
If you are not creating the redirect pages, simply add your proposed titles to the talk page for the episode | If you are not creating the redirect pages, simply add your proposed titles to the talk page for the episode, and someone will do this for you. | ||
==== Creating redirect pages ==== | ==== Creating redirect pages ==== | ||
Create a page | Create a page by searching for the appropriate title and selecting the link in "Create the page "xxxx" on this wiki!". In the editing box for the page, include "#REDIRECT" and then the link to the segment (which will include the time-stamp), followed by applying the relevant category, or categories. | ||
For example, the redirect page [[Black holes: Mass limit calculated (165 SoF)]] contains: | For example, the redirect page [[Black holes: Mass limit calculated (165 SoF)]] contains: | ||
Line 143: | Line 148: | ||
A list of pages that have yet to be proof-read can be found at [[:Category:Needs proof-reading]] (currently includes {{PAGESINCATEGORY:Needs proof-reading}} {{#ifeq: {{PAGESINCATEGORY:Needs proof-reading}}|1|entry|entries}}). | A list of pages that have yet to be proof-read can be found at [[:Category:Needs proof-reading]] (currently includes {{PAGESINCATEGORY:Needs proof-reading}} {{#ifeq: {{PAGESINCATEGORY:Needs proof-reading}}|1|entry|entries}}). | ||
It can be a long, hard task to transcribe a whole episode, and it's easy to miss typos and attribute lines to the wrong speakers. That | It can be a long, hard task to transcribe a whole episode, and it's easy to miss typos and attribute lines to the wrong speakers. That's why it's good to have a second contributor proof-read pages. | ||
As with transcribing, proof-reading a page should not include re-writing the transcription into a regular writing style, but should stay close to what is said on the podcast. | As with transcribing, proof-reading a page should not include re-writing the transcription into a regular writing style, but should stay close to what is said on the podcast. | ||
Line 166: | Line 171: | ||
The weekly Skeptical Quote is a great homage to outstanding thinkers and orators, but what about all the great quotes that come from the Rogues themselves? | The weekly Skeptical Quote is a great homage to outstanding thinkers and orators, but what about all the great quotes that come from the Rogues themselves? | ||
To celebrate the profound and humorous utterances of our friends at the SGU, we're building a list of our | To celebrate the profound and humorous utterances of our friends at the SGU, we're building a list of our [[Favorite Rogue Quotes]]. | ||
To add to this list, first check that the quote isn't already in the list, then enter the quote into the table, adding the speaker(s), the relevant episode, and the topic. Use the [[Special:Categories|Categories]] list to help define the primary topic for the quote, that way, the table can be sorted easily. For example, if it's a joke, use "humor", if they're deploring the state of science education, use "Science & Education". | To add to this list, first check that the quote isn't already in the list, then enter the quote into the table, adding the speaker(s), the relevant episode, and the topic. Use the [[Special:Categories|Categories]] list to help define the primary topic for the quote, that way, the table can be sorted easily. For example, if it's a joke, use "humor", if they're deploring the state of science education, use "Science & Education". More information on the format for entries can be found at the top of the editing box of the [[Favorite Rogue Quotes]] page. |
Revision as of 07:14, 1 July 2012
This page is very much "in progress", I'm just chucking in ideas for now, and will clean it up later. If you have any suggestions / comments, please add them to the discussion page.--Teleuteskitty (talk) 19:58, 1 June 2012 (UTC)
SGUTranscripts.org aims to help SGU fans search and reference topics, and to make the SGU episodes as accessible as possible. There are lots of different ways to contribute, this page describes some of them.
If you have any ideas for fun things to include on the site, please let us know in the Community portal.
'Editing Required' template
Pages that include the 'Editing required' template (orange box saying "This episode needs:...") show what aspects of the page need to be completed. These pages will also be listed in the relevant subcategory of Category:Needs attention, which is a good place to look for any loose ends that need tying up.
Once an issue has been addressed, it can be removed from the 'Editing required' template by deleting the input line in the page's editing box. If it is the last issue to be resolved, then the template can be removed from the page entirely.
Transcription
The most obvious way to help out is to transcribe an episode, or sections of an episode.
If you're new to transcribing, you might want to start with a 5X5 episode, or a segment of an episode. The Help:Getting Started page gives information on setting up and editing pages.
We don't have any rules for transcribing, but we try to keep as true to the podcast as possible.
While you don't need to include all the fillers, such as "um", "er", "you know", it's generally a good idea to stick to what is actually said, and not interpret the Rogues' dialogue. The way a person speaks is often very different to how you would read or write text, and can be very messy, even non-sensical. However, with so many people contributing transcriptions, re-writing podcasts in a more 'readable' format would be heavily influenced by the writing style and interpretation of the transcriber, which would soon become impossible to monitor. Therefore, it's probably best to leave it to the reader to interpret, and to use punctuation (such as commas, dashes and "...") to indicate broken sentences, change of tack etc.
To help convey the tone of the dialogue, emphasis of words can be shown by including them in italics (see Help:Getting_Started#Text_Formatting).
Where the Rogues laugh - and they often do - include (laughter)
in the transcript.
If you have trouble deciphering what is said, just put (inaudible)
where the speech would be.
Things to keep in mind
(needs better section title)
Whilst transcribing an episode, it is a good idea to keep in mind other aspects of the transcription page that you might want to include, as you will be familiar with the content, and able to identify the most important points. For example, it can be easy to note the times at which each segment begins and the topic categories that are covered when transcribing. In the same way, when an interesting fact comes up, you might want to add it to the 'Today I Learned' list for the episode (see below).
If you'd like to transcribe without adding other features, that's absolutely fine, and plenty of work in itself. If you come across something you want to point out to others editing the page, you can insert a comment in the editing box. For example, if you come across a fact for the 'Today I Learned' list, or a good quote from one of the Rogues, you can insert a comment using <!--
and -->
. This won't show on the regular page, but will be included in the page's edit box.
Appearance on page | What you type |
---|---|
text text text text text text | text text text text text text <!-- include this in TIL section --> |
Time-stamps
One of the main advantages of transcribing the SGU podcasts is for reference. By including time-stamps at the beginning of each segment, readers can revisit topics of interest, or point other people to the section, without going through the whole podcast (not that that's ever much of a chore).
Some transcriptions need time-stamps added to them, you can find a list of these pages at Category:Needs time-stamps (currently includes 450 entries).
Time-stamps take the format:
- m:ss for times under 10 minutes, e.g. (0:37) and (2:34)
- mm:ss for times between 10 minutes and an hour, e.g. (17:42)
- h:mm:ss for times over an hour, e.g. (1:09:42)
They are added in a small font in the section header, for example:
Appearance on page | What you type |
---|---|
Science or Fiction (45:16) |
== Science or Fiction <small>(45:16)</small> == |
Formatting
(not sure what else, if anything, should be included here)
A list of pages needing to be formatted can be found at Category:Needs formatting (currently includes 747 entries).
Wiki Mark-up
Page skeletons
The Episode skeleton contains the general structure of a transcription page, including section headings, infobox (see next section), outro and navigation templates. For 5X5 episodes, use the 5X5 skeleton. These pages can be copied to new transcript pages and built upon by changing headers and adding text and links.
Infobox
The infobox appears on the right-hand side of every transcription page, outlining certain information about the podcast, including, among other things, the broadcast date, any guests on the show, a key for speakers and links to the shownotes, podcast and SGU forum page.
The Help:Episode infobox page gives an explanation of how to enter input into an infobox to customize it for each episode. For help customizing the infobox for 5X5 episodes, see Help:5X5 infobox.
Links
A list of pages needing links can be found at Category:Needs links (currently includes 843 entries).
Links provided in the show notes
Transcript pages should include all of the links available in the podcast show notes page at theskepticsguide.org.
Enter these immediately after the relevant segment title, and use a descriptive format for the linking text, instead of the raw URL. An easy way of doing this is to include the name of the source of the page (e.g. the website), followed by a colon and the title of the page or article. For example, instead of:
Use:
This allows the reader to see clearly where the link will take them, and is generally more inviting.
General links
There are many occasions where a link can be a useful addition to the transcript. Generally, these include:
- Technical jargon
- Key concepts that may not be immediately obvious (e.g. argumentum ad hominem)
- People / organisations
- Websites
- Articles / blogs
For the first three of these, it is best to start looking for a link in Wikipedia, unless there is reason to use an alternative source. This helps to keep things uniform across transcript pages, and also means that you don't have to search for the ultimate website to explain this or that.
(are wiki links prefered???)
Most of these links can be added to text in the transcript itself, however, there are some cases for which there is no appropriate text to turn into the link. For these, use references, see Help:Getting Started#References.
Categories
A nice easy way to search through SGUTranscripts is to browse through categories, see the browse categories page.
When a page has been categorized, the relevant categories are automatically listed at the bottom.
Episode pages that haven't been added to categories are listed in Category:Needs categories (currently includes 850 entries).
Using template
To add categories to a full SGU episode, include Template:Page categories, for 5X5 episodes, use Template:5X5 categories. The template pages show the available categories and the input needed. The category templates add the page to the available categories, and apply a sort key based on the page name to separate out full episodes from section links on the category pages, and keep numbered order (e.g. see Category:Nature & Evolution).
For this reason, if you are applying a category to any page other than an episode transcription, you should use the regular way of applying categories (e.g. [Category:Nature & Evolution]
). This will avoid using an inappropriate sorting key.
Categorized segment redirects
SGU podcasts cover a multitude of topics in a single episode, which can make it difficult to find exactly what you're looking for. To allocate individual segments to categories, and list them on category pages under a relevant title, a redirect page is needed. For example, episode 1 contains a segment on exploding toads, and was entered into the category 'Nature & Evolution'. However, on the category page for 'Nature & Evolution', listing 'SGU Episode 1' is not very informative. However, making a page with the title 'Exploding toads baffle scientists (1)' that redirects straight to the segment, and categorizing that under 'Nature & Evolution', will make it much clearer.
Episode pages that do not have categorized redirects for their segments are listed in Category:Needs segment redirects (currently includes 874 entries).
There are a couple of ways of contributing to these, you can propose a title for the redirect page and/or create the redirect page itself.
When adding categorized redirects, first check that they haven't already been created by clicking on 'What links here' to the left of the page. Redirects are marked as "(redirect page) (← links)". You should also look in the episode's talk page and the editing box for suggestions made by others.
Redirect page titles
There are a few conventions to follow for naming redirect pages, the most important being the inclusion of the episode number in brackets at the end of the title. This keeps things clear and uniform.
- Guest Rogues titles are simply the name of the guest, e.g. James Randi (355)
- Live Recording titles are the name of the event they are recording at, e.g. NECSS 2012 (354)
- Interview titles should start with the interviewee's name and include some clues as to what they spoke about, e.g. Neil deGrasse Tyson interview: Spaghettification and education (156)
- Science or Fiction segments can have a redirect for each topic, but as these present information differently to other podcast segments, you should also include "SoF" in the brackets to inform readers, e.g. Black holes: Mass limit calculated (165 SoF)
Other titles should be short and informative, and can often be based on the segment heading in the SGU show notes, but remember that they need to be unique, and descriptive in order to differentiate between them on a category listing page.
If you are not creating the redirect pages, simply add your proposed titles to the talk page for the episode, and someone will do this for you.
Creating redirect pages
Create a page by searching for the appropriate title and selecting the link in "Create the page "xxxx" on this wiki!". In the editing box for the page, include "#REDIRECT" and then the link to the segment (which will include the time-stamp), followed by applying the relevant category, or categories.
For example, the redirect page Black holes: Mass limit calculated (165 SoF) contains:
#REDIRECT [[SGU_Episode_165#Science or Fiction .281:04:43.29]] [[Category:Astronomy & Space science|{{PAGENAME}}]]
Nb. Categories are not shown when previewing redirect pages, these are visible only once the page is saved.
Proof-reading
A list of pages that have yet to be proof-read can be found at Category:Needs proof-reading (currently includes 1 entry).
It can be a long, hard task to transcribe a whole episode, and it's easy to miss typos and attribute lines to the wrong speakers. That's why it's good to have a second contributor proof-read pages.
As with transcribing, proof-reading a page should not include re-writing the transcription into a regular writing style, but should stay close to what is said on the podcast.
Things to look out for when proof-reading include:
- Typos
- Inclusion of appropriate and working links, with relevant text
- Misattribution of speakers
You should also look out for comments made by the transcriber in the editing box, as they may point out sections which they found difficult to transcribe or find links for etc.
Today I Learned...
A list of pages without 'Today I Learned...' fact lists can be found at Category:Needs TIL (currently includes 882 entries).
These sections include a bullet-point list of interesting facts that come up in the episode.
They should be concise, and include links/references where possible so that they are informative and independent of the episode's transcription.
For an example, see SGU Episode 346#Today I Learned...
Favorite Rogue Quotes
The weekly Skeptical Quote is a great homage to outstanding thinkers and orators, but what about all the great quotes that come from the Rogues themselves?
To celebrate the profound and humorous utterances of our friends at the SGU, we're building a list of our Favorite Rogue Quotes.
To add to this list, first check that the quote isn't already in the list, then enter the quote into the table, adding the speaker(s), the relevant episode, and the topic. Use the Categories list to help define the primary topic for the quote, that way, the table can be sorted easily. For example, if it's a joke, use "humor", if they're deploring the state of science education, use "Science & Education". More information on the format for entries can be found at the top of the editing box of the Favorite Rogue Quotes page.