Help:How to Contribute: Difference between revisions

From SGUTranscripts
Jump to navigation Jump to search
(reorganised sections, added some text)
(moved "things to keep in mind" into the transcription section and renamed "advanced transcription" - need to work on a list of standard comments)
Line 17: Line 17:


If you have trouble deciphering what is said, just put <code>(inaudible)</code> where the speech would be.
If you have trouble deciphering what is said, just put <code>(inaudible)</code> where the speech would be.
=== Advanced transcription ===
Whilst transcribing an episode, it is a good idea to keep in mind other aspects of the transcript 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.
{| class="wikitable"
! width="20%"| Appearance on page
! width="20%"| What you type
|-
|text text text text text text
|<code><nowiki>text text text text text text  <!-- include this in TIL section --></nowiki></code>
|}
<!-- might be worth working on a list of standard comments that can be included in transcripts for picking up later.  Perhaps something like:
SGUQuote
TIL
NeedsLink
rwh86 -->


== Proof-reading ==
== Proof-reading ==
Line 37: Line 59:
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.
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.
<!-- add 'verified' parameter to infobox -->
<!-- add 'verified' parameter to infobox -->
=== 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 transcript 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.
{| class="wikitable"
! width="20%"| Appearance on page
! width="20%"| What you type
|-
|text text text text text text
|<code><nowiki>text text text text text text  <!-- include this in TIL section --></nowiki></code>
|}


== Time-stamps ==
== Time-stamps ==

Revision as of 01:43, 11 August 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. The important thing is that all contributions are welcome, so don't be afraid to contribute, even if you just fix a typo here and there.

If you have any ideas for fun things to include on the site, please let us know in the Community portal.

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, including a section with Tips for Transcription that has specific suggestions for what software and techniques can be used to help you transcribe comfortably.

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

Advanced transcription

Whilst transcribing an episode, it is a good idea to keep in mind other aspects of the transcript 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 -->


Proof-reading

Another easy way to contribute is by proof reading pages. 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. To proof-read a page, simply listen to the podcast and check that the text that has been transcribed matches what you hear. Proof-reading can often be done with playback at full speed, so it's a rather easier task than transcribing.

A list of pages that have yet to be proof-read can be found at Category:Needs proof-reading (currently includes 1 entry).

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.

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

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

Some contributors may prefer to submit unformatted transcriptions, a list of pages needing to be formatted can be found at Category:Needs formatting (currently includes 747 entries).

You can find information on formatting pages using wiki mark-up on the Getting started help page.

Page skeletons

The Episode skeleton contains the general structure of a transcript 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 transcript 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 working links on the relevant 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 or organisation), 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/

Use:

Neurologica: Modern Medical Zombies

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

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 of that page, and it is also automatically added to the relevant category pages.

Episode pages that haven't been added to categories are listed in Category:Needs categories (currently includes 850 entries).

Using templates to add categories

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 categorize segments individually, 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 page 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 other contributors.

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. They should also be in a sentence case format, that is, capitals should not be used for each word, but only at the beginning, after colons and for proper nouns and acronyms. This helps to keep things clear and uniform.

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. It is also good practice to use keywords first, both for clarity and to facilitate sorting on the category page, e.g. Global warming: Heartland Institute scandal follow-up (346).

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 internal link to the segment (which will include the time-stamp), followed by applying the relevant category, or categories.

To find the segment link, click on the entry in the table of contents on the episode page, you will notice that the brackets for the time stamp are replaced by ".28" and ".29" in the URL. The internal link consists of the text after "http://www.sgutranscripts.org/wiki/".

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 before a valid redirect link is added, and once the page is saved.


Today I Learned...

These sections include a bullet-point list of interesting facts that come up in the episode. A list of pages without 'Today I Learned...' fact lists can be found at Category:Needs TIL (currently includes 882 entries).

Entries should be concise, and include links/references where possible so that they are informative and independent of the episode's transcription. To insert bullet-points, simply add an asterisk at the beginning of the line. For an example, see SGU Episode 347#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 Help: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 detailed information on adding quotes can be found at the top of the editing box of the Favorite Rogue Quotes page.