The Official TWiT Wiki:Manual of Style

From The Official TWiT Wiki
Jump to: navigation, search

We here at The Official TWiT Wiki like things to be uniform and everything, so this Manual of Style is here to set things straight.

For information on the most basic writing techniques and styles, which are used here, see Wikipedia's Manual of Style.

Below are some basic formatting do's and don't's.

Layout guide

Most articles should be structured as follows:

Podcasts

  1. Infobox
  2. Detailed Introduction
  3. History (if needed)
  4. Segments (if needed)
  5. Music Used (if needed)
  6. Trivia
  7. External Links

Show Notes

Each show should have a pre-configured template called a "preload" associated with it. When you create a new page you will see a heading called "Show Notes" right above the text box. Click on the title of the show you want to start a new show note for and it will automatically add that shows template to the text box. All you have to do is fill in the blanks and you're done.

People (staff/person)

  1. Infobox
  2. Detailed Introduction
  3. History
    1. Certain sections (books, tv, etc.)
  4. Trivia
  5. External Links

If it's awkward or impossible to use this layout on your article try to find a similar article and model it after that. If there is no similar article, just lay it out in a way that seems logical to you.

Naming articles

There are some rules regarding how articles on The Official TWiT Wiki should be named.

  • Article names should be in singular form, not plural.
  • Words differentiating it from something else, like Network. Should be in parenthesis like so... "(network)"
  • Articles titles must be spelled the way it should exactly be spelled
    • Misspellings or alternate titles can be used as redirects.
  • Episode articles should be titled as such: Podcast_Name Episode_Number, except for This WEEK in TECH, which uses "TWiT" as the shortened Podcast_Name.

Headings

Use the == (heading) markup for headings, not the ''' (bold) markup. Example:

===This is a heading===

which produces:

This is a heading

If you mark headings this way, a table of contents is automatically generated from the headings in an article. Sections can be automatically numbered for users with that preference set and words within properly marked headings are given greater weight in searches. Headings also help readers by breaking up the text and outlining the article.

  • Capitalize the first letter only of the first word and of any proper nouns in a heading, and leave all of the other letters in lower case.
  • Avoid links within headings.
  • Avoid overuse of sub-headings.

Linking

Before an article can be found by users you have to make sure it can be reached by normal browsing on the wiki. This means that at least one other page on the wiki has to link to the article in order for it to be considered complete, otherwise it's referred to as an 'orphaned page'. Usually this isn't an issue because most articles are created because they're already referenced from other pages. If this isn't the case you will have to find a related page and work a link to the orphaned article into it.

An article must also link to at least one other Official TWiT Wiki article. If an article has no links or only external links it is referred to as a 'dead end. If an article is a dead end you should reword it so it references another related article.

Usage and spelling

Though the readers and editors speak many varieties of English, we mandate standard American English spelling, grammar, punctuation, and word usage. This is the variety of English used in the first printings of most primary sources.

If a word has two acceptable variants in American English, the one that is considered "more American" is to be used. Such example is the spelling of judgement as judgment. The only exception of this rule is the spelling of words ending in -ogue: while dialog is an acceptable version of dialogue, the latter is preferred.

If the title of an article differs in different varieties of English, the American title should be the article title, with alternate names being used as redirects.

If a source's title is in British English, it must not be converted into American English must always be referred to as such. Also, if a direct quotation from a British source has a word which is spelled differently in American English, the original British spelling must be preserved. However, a [sic] sign may be put after the word.

Apostrophes and possessives ending in "s"

While plural nouns ending in "s" should be made possessive by adding only an apostrophe, singular nouns ending in "s" can be made possessive by adding either an apostrophe followed by another "s" or simply an apostrophe, providing each article is consistent throughout. Users are encouraged, but not required, to use only an s' for possessive nouns ending in a Z-sound.

Maintenance Templates

If you come across an article that you believe does not meet the standards of The Official TWiT Wiki you are free to edit the article so it conforms with this style guide. If you don't have the information or time necessary to fix the article yourself, however, there is an easy way to show other maintainers that you believe the article is in need of their attention. This section does not apply to organizational templates. More information about them can be found at The Official TWiT Wiki:Deletion policy.

Important: If a problem is not immediately obvious then you should add a comment to the articles talk page stating why you added the maintenance template.

Spelling and Grammar

If an article has multiple spelling and grammar mistakes you can add it to Category:Articles needing to be fixed. If the spelling and grammar mistakes are throughout the entire article, add "{{fix}}" to the very top of the page. If it's limited to a single section, add "{{fix}}" to the top of that section. Once added, you should see the Template:Fix template where you entered the tag:



Formatting Issues

If an article doesn't meet the standard described in this style guide then it should be added to Category:Articles needing to be improved. You should add this to the top of a page with formatting issues using the "{{improve}}" tag. Once added, you should see the Template:Improve template where you entered the tag:



Short Articles

If an article is only contains only a single paragraph and can be drastically expanded then it is considered to be a stub and should be added to Category:Articles needing to be expanded. If you believe that a short article should be expanded you can use "{{stub}}. Once added, you should see the Template:Stub template where you entered the tag: