Difference between revisions of "User:Anonymax/Style"

From CWCki
Jump to navigation Jump to search
m
Line 88: Line 88:
Using a template is simple - just place the name of the template between curly brackets <nowiki>{{ }}</nowiki> e.g.
Using a template is simple - just place the name of the template between curly brackets <nowiki>{{ }}</nowiki> e.g.
'''<nowiki>{{Honest}}</nowiki>''' will insert the {{tl|Honest}} template, which appears as {{Honest|nocat=true}}
'''<nowiki>{{Honest}}</nowiki>''' will insert the {{tl|Honest}} template, which appears as {{Honest|nocat=true}}
=== Parameters ===
=== Parameters ===
Some templates are more dynamic, and have additional parameters. These parameters can either be to customise a template's text or style, or to insert additional text into the template. Parameters are separated by vertical pipes | and are added before the closing curly brackets.
Some templates are more dynamic, and have additional parameters. These parameters can either be to customise a template's text or style, or to insert additional text into the template. Parameters are separated by vertical pipes | and are added before the closing curly brackets.
Line 96: Line 97:
:* Unnamed parameter example: '''<nowiki>{{Protip|This template doesn't have named parameters}}</nowiki>''' (this unnamed parameter simply changes the text shown in the protip box)
:* Unnamed parameter example: '''<nowiki>{{Protip|This template doesn't have named parameters}}</nowiki>''' (this unnamed parameter simply changes the text shown in the protip box)
{{Protip|This template doesn't have named parameters}}
{{Protip|This template doesn't have named parameters}}
=== Substitution ===
When you substitute a template, saving the page causes the wikimarkup from the template's page to be inserted into the article. Substitution is useful for templates such as the {{tl|welcome}} template, because substituting leaves behind all the body text from that template on a user's talk page - which helps them to see how wikimarkup works, rather than simply seeing <nowiki>{{welcome}}</nowiki>.
* Substituting a template is as simple as adding '''subst:''' after the opening curly brackets but before the template name e.g. '''<nowiki>{{subst:welcome}}</nowiki>'''.
* When the page is saved, the wikimarkup from the template will be inserted into the page you just saved.
* Only certain templates are suitable for substitution. The vast majority are not suitable. Check the usage notes for each template before deciding whether to substitute it or not.

Revision as of 22:55, 21 September 2011

These style guidelines are generally accepted by the CWCki community, and are used as a reference to help keep the CWCki consistent.

Article names

Main article: CWCki:Article naming

Almost everything should follow:

Video articles

The long-standing convention is to make the article title for a video the same as Chris named it on YouTube. So if the video is named 100_2357.MOV, that should be the article title. There are occasions where this policy does not apply:

  • When Chris uploads two videos of the same or very similar name which are unrelated - it is usually wise to choose a different article title.
  • When Chris gives a video a very long name - see Cleveland Show Voice Rant for an example.
  • When Chris uploads several related videos within a short space of time - usually on the same day:
  • The article title should either borrow its name from part of the video titles (The MovingFoward videos) or
  • Be named appropriately to cover the main subject of the videos (Cwcsicle).

Categories

Link all appropriate categories at the bottom of an article. For example, [[Category:Family Members]] at the bottom of any article about a family member of Chris's.

  • Note that many templates add categories to articles automatically, and you may therefore not need to add certain categories manually.
  • Categories should always be at the very bottom of an article - after all other Wikimarkup, templates, references.
  • Each category should be placed on its own line.

Capitalisation

Just a reminder that proper nouns (including names of people, places and even Sonichu) should always be capitalised.

  • The first word of every sentence should begin with a capital letter, unless the sentence starts with the name of something intentionally spelt with an initial lowercase letter.
  • Section headings should not be fully capitalised. Only the first word and subsequent proper nouns should be capitalised.

English: American & British spelling

To do

People

Chris

When referring to Chris in articles, you should always use Chris as opposed to "Chris-chan" or other variations.

  • Christian is also acceptable, where appropriate.
  • Christopher should only be used when writing about Chris's name change. His current, full legal name is Christian Weston Chandler.
  • Of course, if you're referring to Chris-Chan Sonichu (one of Chris's alter egos), then Chris-Chan is fine.

Possessive (Chris's vs Chris')

Long-standing CWCki convention means that we use Chris's as opposed to the (grammatically correct) Chris'. Yes we understand it may seem like a stupid rule, but that's part of following the Chris saga.

Barbara "Barb" Chandler

When referring to Chris's mother, we usually use the nickname Barb.

  • Her birth name is Barbara Anne Weston
  • Referring to her as "Barbara" is tedious - both to editors and readers of articles where her name appears repeatedly, such as in transcripts.
  • She has also been referred to by followers as "Snorlax", but refrain from using it unless absolutely appropriate.

Bob Chandler

When referring to Chris's late father, we usually use Bob.

  • His full name is Robert Franklin Chandler Jr.
  • He is also known as The Internet Lumberjack following an infamous audio recording. Unless relevant to the article, its use should be limited.
  • Since his death in September 2011, care should be taken to ensure articles that mention him do so in the past tense where necessary.

More to add

Section headings

The wikimarkup for creating a section heading is simple: == Section name ==.

  • The first heading within an article should always start with two ='s either side of the heading text (that is, be a level 2 heading).
  • Adding an extra = to each end of the heading text will create a sub-heading:

Markup: === Example sub-heading ===

Example sub-heading

Markup: ==== Example sub-sub-heading ====

Example sub-sub-heading

Heading text

Some guidelines for writing good section headings - with examples taken from the Chris article.

Capitalisation

As with article names, section headings should only have the initial word capitalised, along with any names.

  • Life as a Tomgirl as opposed to Life As A Tomgirl or Life as a tomgirl. Tomgirl is a name, and is therefore capitalised.

Simplicity

Your aim with the heading is to describe the text within that section in the simplest possible way. Here are two examples:

  • Aliases as opposed to something like The many aliases of Christian Weston Chandler.
  • Early life as opposed to something like His early life or Chris's younger years.

Spacing

There are four spacing issues to consider:

  • To make section headings easier to read for editors, place a space either side of the section header text:
    • == Example heading == rather than ==Example heading==
  • The heading should be on its own line - with the article body text starting on the line below. There is no need to leave an extra blank line after the section heading.
  • When creating a new section heading, leaving a blank line after the previous section text can help editors.
  • If the previous section made use of images, but the section text was fairly short - this can cause the image to overflow onto the section below it. To prevent this from happening, you can use the {{clear}} (Usage) template - placing it at the end of the particularly short section.

Templates

Main article: CWCki:Templates

Templates are used to insert content into articles without having to use a bunch of, what is usually, long and complex wikimarkup. The various templates we have on the CWCki can be found on the main article linked above. Using a template is simple - just place the name of the template between curly brackets {{ }} e.g. {{Honest}} will insert the {{Honest}} (Usage) template, which appears as

HonestContent.jpg
This article is rated M for Honest Content

It may contain content deemed not safe for work. Reader discretion is advised.

Parameters

Some templates are more dynamic, and have additional parameters. These parameters can either be to customise a template's text or style, or to insert additional text into the template. Parameters are separated by vertical pipes | and are added before the closing curly brackets.

  • Read a template's usage notes to learn more about what parameters, if any, the template has and how to use them
  • There are named and unnamed parameters:
  • Named parameter example: {{Honest|nocat=true}} (this named parameter prevents the template from adding a category to the article)
HonestContent.jpg
This article is rated M for Honest Content

It may contain content deemed not safe for work. Reader discretion is advised.
  • Unnamed parameter example: {{Protip|This template doesn't have named parameters}} (this unnamed parameter simply changes the text shown in the protip box)
Protip.jpg
PROTIP:

This template doesn't have named parameters

Substitution

When you substitute a template, saving the page causes the wikimarkup from the template's page to be inserted into the article. Substitution is useful for templates such as the {{welcome}} (Usage) template, because substituting leaves behind all the body text from that template on a user's talk page - which helps them to see how wikimarkup works, rather than simply seeing {{welcome}}.

  • Substituting a template is as simple as adding subst: after the opening curly brackets but before the template name e.g. {{subst:welcome}}.
  • When the page is saved, the wikimarkup from the template will be inserted into the page you just saved.
  • Only certain templates are suitable for substitution. The vast majority are not suitable. Check the usage notes for each template before deciding whether to substitute it or not.