Help:Getting Started
This page is in progress, any feedback welcomed.
"???" denotes points to be revisited
Also, this is clearly no longer an FAQ, it's turned into a general 'getting started' page
Thanks for your interest in helping out with the SGU transcript project!
As you probably know, there are over 350 full episodes of the SGU, and over 100 5x5 episodes, so we appreciate any and all of the help we get.
We want to make it clear that we welcome all contributions, regardless of whether you can tell the difference between Jay and Bob, don't have time to do all the formatting, or can only transcribe parts of episodes.
We encourage everyone to contribute just as much or as little as they wish.
This page covers the basics of setting up and editing a page. For more detailed information, see the list of useful links below.
Getting started
First things first, find an episode that you want to transcribe, make sure it isn't already listed on the Main Page, and create a page for it.
If you'd like to just try your hand at transcribing, start with an SGU 5x5 as these are much shorter.
???what about marking episodes for section work only???
Creating new episode pages
It's best to create a page before you start any of the work in order to make sure that no-one else is working on the same episode. You don't want to put in all that effort only to find out someone submitted the same transcript just before you did!
It's easy to create a page, just enter the name of the page you want to create in the search bar, for example:
- "SGU Episode ###" or "5X5 Episode ##"
Searching for this will let you know if the page has already been created by someone else - in which case you should find another episode to transcribe.
If no-one has created a page for that episode, then the search results page will say:
- There were no results matching the query.
- Create the page "SGU Episode ###" on this wiki!
Click on the red link to open the new page's editing box, and type ''page in progress'' in the editing window.
Saving this page creates a new page for your episode that notifies people viewing it that someone is working on it.
- Add to Main Page -
Before you start work on your transcription, you should add your new page to the Main Page. This makes it extra clear to other contributors that you've called dibs on this episode.
Find the section on the Main Page where your episode should go, click on the edit link to the right of that section header, and enter the link to your page, the date and mark it as incomplete. For example:
[[SGU Episode 352]], Apr 14 2012 (incomplete)
- or, if you are transcribing a 5X5 episode, also include the episode name:
[[5X5 Episode 110]], Apr 11 2012, Naturalistic Fallacy (incomplete)
Putting the page name between double square brackets inserts the link to the page (see links section)
Editing pages
You can edit pages by clicking the 'edit' tab at the top of the page, which allows you to edit the whole page. If you just want to edit one section, you can also click on the 'edit' link to the right of the relevant section heading.
After entering your content into the edit box, click 'preview' to ensure that your work is being displayed as intended.
It's generally best to check the preview before saving a page in order to avoid excessive entries in the Recent changes log. This log shows all changes made to the website, and is useful for checking for new additions, such as messages in the Community portal.
When you're happy with the page, or want to save your progress and come back to it later, click 'save page', which will show your newly edited page in all it's glory.
Edit summary
When saving a page, it is considered good practice to add a brief summary of the edit in the field above the save and preview buttons. For example, "Interview segment added", "page formatted" or "transcript completed".
Adding a summary helps to distinguish between different revisions of the page should users wish to compare edits or return to an earlier version. All versions of a page are automatically saved in their revision history, and can be viewed by clicking on the 'View history' tab of the page itself, or from the link in the Recent changes log.
You can set your user preferences to show an alert if you try to save a page without entering a summary. When you are logged in, a 'My preferences' link appears at the top of the screen. If you click on this, and go to the 'Editing' tab, you will see a list of check-boxes, including one stating "Prompt me when entering a blank edit summary".
Adding comments
If you would like someone to look over your transcription to help with distinguishing the Rogues, or to help with any parts of the transcription, it is helpful if you can insert a comment stating the time in the podcast at that point, and post a message on the Community portal. Comments are entered between "<!--" and "-->" in the editing box and do not appear on the saved page. For exmple:
<!-- Help needed to distinguish Rogue speaking at 1:02:48 -->
makes that text visible only in the editing box, not the page itself. This means that any user that tries to help with this problem will be able to get to the root of the issue quickly.
Comments can also be very useful when you want to come back to a section later, or add links.
Wiki mark-up
Here, we briefly describe the most commonly used wikitext markup and html tags for pages on this site. For more detail, see wikimedia: Advanced_editing
- ⊗ If you would like to leave the mark-up to some-one else, or if you have any questions or suggestions, just put a note in the Community portal, and someone will be happy to help out. (see notes on the Community portal below)
Headers
These are used to mark the different podcast segments, and are automatically incorporated into a table of contents that appears at the top of the page.
An example of the different headers used in transcription pages can be found at Episode templateTK
| Description | Appearance on page | What you type |
|---|---|---|
| Headers for each of the different segments of the podcast are made by using 2 'equals' signs. |
Podcast Segment |
==Podcast Segment== |
| Headers for subsections within the podcast segments are made by using 3 'equals' signs. |
Segment subsection |
===Segment subsection=== |
We also include the time at which podcast segments start in a small font using the <small> tags.
(to be confirmed) |
News Item 2 (24:32) |
=== News Item 2 <small>(24:32)</small>=== |
Line breaks and paragraphs
| Description | Appearance on page | What you type |
|---|---|---|
| Starting a new line in the editing window does not appear on the actual page as a line break. | This is my first lineThis is my second line | This is my first line This is my second line |
To start a new line, use the <br> tag.
This tag does not need a closing tag. You can use this on the same line, or on a new line. |
This is my first line |
This is my first line <br>This is my second line |
| To start a new paragraph, leave an empty line between text in the editing window. | This is my first line
This is my second line |
This is my first line This is my second line |
Text Formatting
| Description | Appearance on page | What you type |
|---|---|---|
| Words in italics are indicated by double apostrophes.
These can be used to signify when a speaker emphasizes a word. |
We want to emphasize words | We want to ''emphasize'' words |
| Words in bold are indicated by triple apostrophes. | We want to emphasize words | We want to '''emphasize''' words |
Superscript text is placed between <sup> and </sup> tags
|
November 15th 2011 | November 15<sup>th</sup> 2011 |
Subscript text is placed between <sub> and </sub> tags
|
Water: H2O | Water: H<sub>2</sub>O |
Quotes
| Description | Appearance on page | What you type |
|---|---|---|
Long quotes are defined using the <blockquote> tags.
This indents the text from both margins. |
|
<blockquote>All the world's a stage, And all the men and women merely players</blockquote> |
Links
| Description | Appearance on page | What you type |
|---|---|---|
| Internal links (pages on sgutranscripts.org) are given within double square brackets. | Main Page | [[Main Page]] |
| If an internal link is used, but no such page exists, the link is displayed in red. | Birds vs Monkeys | [[Birds vs Monkeys]] |
| To use different text for internal links, add a pipe-line between the page name and the text. | Community portal | [[SGUTranscripts:Community_portal|Community portal]] |
| URLs are automatically detected from the editing text. | http://www.theskepticsguide.org/ | http://www.theskepticsguide.org/ |
| To assign external links to text, add a space after the URL, insert the required text and enclose using single square brackets.
Internal links can be named in the same way when full URLs are given. |
SGU website | [http://www.theskepticsguide.org/ SGU website] [http://www.sgutranscripts.org/wiki/Main_Page go here] |
| If no text is assigned to a link within single brackets, it appears numbered.
However, this should be avoided, and references should be used in cases where it is not appropriate to embed the link in text. (see below) |
[1] | [http://www.theskepticsguide.org/] |
References
When it does not make sense to assign a link to words in the transcription, you can use references. (???agree criteria???)
References can include both text and URLs, and appear as super-scripted numbered links on the page. These link to a reference section, usually inserted at the bottom of the page, which in turn links back to the point in the text where the reference was made.
References are usually placed after punctuation. (???insert link for conventions of referencing???)
| Description | Appearance on page | What you type |
|---|---|---|
Mark each reference separately with <ref> tags, at the relevant point in the text.
Clicking on the reference links in this example will take you to the examples in the next row. |
I read that article.[1]
Their website is great.[2] |
I read that article.<ref>Example 1</ref> Their website is great.<ref>Example 2</ref> |
Pages with references must contain a section for listing these including the <references/> tag.
This automatically lists all references on the page. Clicking on the arrows takes you back to the place where the reference was made in the above row. If |
References |
== References == <references/> |
For more information on references, see Wiki Help:Footnotes.
Tips for Transcription
You should use whatever method of transcription you find suits you best. So far, we don't know of any speech recognition software available to do the task for us, so the following is for manual transcription only. Here's some quick info on what we've found useful so far.
Please let us know if you have any suggestions to add.
Audio software
(copied)My method of transcription is to use VLC media player, and dial down the speed until I can type comfortably. A quick alt-tab, then shift-left a couple of times will skip back a few seconds if you missed something.
ExpressScribe is a free program that allows you a lot of control over the audio playback, whilst using the text editor of your choice. You can assign hot-keys to actions such as play, pause, speed up, skip back etc. that are system-wide (i.e. they work no matter what other program you're in at the time). You can also use this program with a foot pedal.
You can find an overview of ExpressScribe functions in this article
Text editing software
Ultimately, it doesn't matter what program you use for writing your transcription, but some have their advantage and disadvantages.
Here are some things you might want to consider:
- Spell-checking - the editing box on this site underlines unrecognized and/or misspelled words with a dotted red line, but is limited.
- Automatic correction of common typos (e.g. with MS Word)
- Grammar checking - not for the podcast content itself, but for errors such as lower case letters after full-stops and two spaces in a row etc.
- Formatting - e.g. only 'straight' (or 'typewriter') apostrophes are recognised in wiki-markup for bold and italics etc., 'curly' (or typographic) apostrophes are not.
Community Portal
The Community portal is a page where you can post messages about the website. This is the place to ask for help, make suggestions etc.
You can post a message here by editing and saving the page like any other, entering new posts at the bottom. If you are replying to a post, you should indent your text by including one or more colons, ":"
You can automatically insert your user name and the time of the post by using 4 tildas "~~~~", or by clicking the signature button at the top of your editing box.
Useful links
- Consult the User's Guide for information on using the wiki software.
- Configuration settings list
- MediaWiki FAQ
- MediaWiki release mailing list
- Wikimedia Help:Advanced editing