User:LostInRiverview/Test: Difference between revisions

From The Sims Wiki, a collaborative database for The Sims series
Jump to navigation Jump to search
Content added Content deleted
imported>LostInRiverview
No edit summary
imported>LostInRiverview
No edit summary
Line 1: Line 1:
On The Sims Wiki there are a few rules of style to create a standard feel to all of our articles. The formatting described here is a ''guideline'' and can be overridden where circumstances warrant it. However, please try your best to keep to the advice outlined in this article so others may use your edits as an example when creating and editing their own articles.
Based on a [[Forum:Introducing Metabox|community discussion thread]], The Sims Wiki is retiring its old "standard" message template, otherwise known as {{t|Parthenon}}. In its place, we are rolling out a new template known as '''{{t|Metabox}}'''.


This manual is a summary of the most important style guidelines for this wiki. However, there are instances in which this manual may not provide definitive answers to stylistic questions. In these cases, it is best to consult other similar articles on the wiki, try to determine a proper style based on common sense, or start a discussion on an appropriate talk page or [[Forum:Community discussions|forum]] thread.
Metabox is similar to Parthenon, in that it is intended to be the foundation for other templates on the wiki. Both templates are largely a blank slate, changing to suit the needs of the editors that use them. However, Metabox does introduce a couple changes that need to be understood before setting out to use the template.


==Article and section titles==
;Template type
[[Wikipedia:Wikipedia:Naming conventions|Article naming conventions]] state that each word in an article title or section header should be lowercase, unless it is the first word or the word is always capitalized (Such as names, for example: "Sims", "The Sims", "Will Wright", "Maxis"). The same rules apply to categories, section headings, et cetera. They also state that nouns should always be in singular and verbs in gerund-form (verb + -ing: "'''mak''ing''''' a cake") unless the words are only used in one particular form ("Scissors", for example). An exception to this rule is if the article name is also an official title or name; title case should be used in these instances.
Parthenon required editors to set the background and border colors for the template when first setting it up. Metabox does not require this... however, it ''does'' require that a ''type'' be set.
*''Examples:''
**[[Life state]] - The first word is capitalized. The second word is not a proper noun, so it is not capitalized
**[[Bella Goth]] - Sim names are always capitalized, as they are proper nouns.
**''[[The Sims 3: Into the Future]]'' - ''The Sims 3: Into the Future'' is an official title, so most words in the title are capitalized (note 'the' is lower-case)


One of the main goals of Metabox is to implement a more standardized set of colors for message templates. If you see a green or a blue or a red Metabox, you will be able to immediately have a good idea of what the template is for. This standardization is accomplished through the assigning of types. There are presently six types (listed below). Types are implemented by filling in the <code>type</code> parameter of the template with the general purpose of the template. Is the template administrative? Does it have to do with the page design or a Manual of Style issue? That's the type. Multiple 'golden words' are accepted for each type, but for the sake of ease-of-use, we'll provide some words for you as well.


==Article layout==
The six types are:
Designing a template for the layout of all pages helps to keep things organized and working well so that information can be found more easily. Remember that an outline is generated based on which headings you use (Headings range from level one to six, and are represented as a section title with as many equal signs on either side as the level). The article title is level one, so you should only use level two and higher (<code>==This is level two==</code>).
'''Administrative''' - Produces a green Metabox. ''Reserved for official uses only, mainly by administrators.'' Can be triggered by filling <code>type</code> with:
* 'admin'
* 'official'
* 'administrator'
* 'administrative' or
* 'adm'


Before editors save an article, particularly before adding a new one, the following points should be considered:
'''"Page Change" (Delete, Merge, Move, or Split)''' - Creates a violet Metabox. Used for templates such as {{t|Delete}} or {{t|Move}}. Can be triggered by completing <code>type</code> with:
; Does the article title and headers comply to naming conventions?
* 'delete'
: [http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions Wikipedia's naming conventions] state that each word in the title and headers should be lowercase unless it is the first word or it is always capitalized (Such as names, for example: "Sims", "The Sims", "Will Wright", "Maxis"). The same rules apply to categories, section headings, et cetera. They also state that nouns should always be in singular and verbs in gerund-form (verb + -ing: "'''mak''ing''''' a cake") unless the words are only used in one particular form ("Scissors", for example).
* 'del'
: Articles should be named in such a way that each has a unique title. Articles' titles usually indicate the name of the topic. When additional precision is necessary to distinguish an article from other uses of the topic name, over-precision should be avoided. This can be done by adding a disambiguating tag in parentheses (or sometimes after a comma); however in certain cases it may be done by choosing a different form of the title in order to achieve uniqueness.
* 'move'
; Does the article have a logical structure?
* 'merge'
: The article should be divided into sections and the sections into paragraphs in a way that makes sense to the reader.
* 'split'
; Is the article user-friendly?
: The article should not contain a large amount of images, at least not clumped together (Use galleries for that). Only images which are directly relevant, or the most relevant image if there are several, should be used. It is also important that the article is compatible with all the big browsers (Microsoft Internet Explorer, Mozilla Firefox, Safari).
; Is the article grammatically correct?
: Choice of words, spelling, punctuation...
; Is the article correctly categorized?
: A descriptive category makes it much easier to browse information about a certain subject.


===Layout template===
'''Cleanup or [[TSW:MOS|MOS]] Issue''' - Produces an orange Metabox. Used for templates that address appearance or style issues on the wiki, such as {{t|Cleanup}}. This type can be triggered by filling in <code>type</code> with:
{{See also|The Sims Wiki:Project Sims/Manual of style|The Sims Wiki:Project Simology/Manual of style}}
* cleanup

* mos
<pre>Basic info about the topic. If this topic also exists outside of The Sim series, a link to Wikipedia might be in order.
* style

* design
==Section==
A description of this section. A section should be about a certain aspect of the
topic at hand. If there is only one main aspect, the basic info above should suffice.

===Sub-section===
More details about a certain subject of the current section. More than one sub-section may
occur.

====Sub-sub-section====
Should rarely be needed, but in some cases further division of a subject may be required.

==See also==
*[[Relevant article]]
*[[Relevant article]]
*[[Relevant article]]

==External links==
*[[wikipedia:Example|Relevant wikipedia article]]
*[http://www.example.com/ Relevant external document/site]
*[http://www.example.com/ Relevant external document/site]
</pre>

==Categories==
Adding categories to an article makes it easier for the reader to find information within a specific area. Categories are added by putting <code><nowiki>[[Category:Category name]]</nowiki></code> in an article. An article may be in more than one category, but the editor should make sure not to put an article in categories just because it might be remotely related to them, but rather because it is directly related to them.

==Galleries==
If your article has a large amount of images that are clumped together, making a gallery is generally a good idea. The syntax for a gallery is simple:
<pre>
<gallery>
Image:Wiki.png
Image:Wiki.png|Captioned
Image:Wiki.png
Image:Wiki.png|[[Wikipedia|Links]] can be put in captions.
Image:Wiki.png
Image:Wiki.png|Full [[MediaWiki]]<br />[[syntax]] may now be used…
</gallery>
</pre>
Galleries should be left-aligned, including captions and width set to either 120 or the default (no defined setting)
;See also
*[[:w:c:help:Help:Galleries and slideshows/wikitext|Detailed list of gallery parameter]]

==Using templates==
{{Main|The Sims Wiki:Templates}}
A template in wikicode is basically an inclusion of another article. However, templates are specifically designed to be included, and may take parameters to change their content. There are many templates available to make it easier for the editor when writing an article.

===Stubs===
An article that is a [[:Category:Stubs|stub]] is an article that is incomplete and/or too short. To tag an article as a stub, simply add <code>{{t|stub}}</code> to the bottom of it.

You can find more specific stubs in the [[:Category:Stubs|stubs category]].

Articles that are blank or contain no useful information will be deleted.

===Sim Biographies===
There are several templates that can be added to a Sim's page so that a lot of their biography can be displayed easily.

For information on which templates to use and how to use them see [[The Sims Wiki:Project Sims/Manual of style#Templates|Project Sims/Manual of style]].

===Families===
Use <code>{{t|Family1}}</code>, <code>{{t|Family2}}</code>, or <code>{{t|Family3}}</code> to add an infobox to a family article with their respective games. Use <code>{{t|FamilyPage}}</code> to add additional information for the family.

If the family appears in several games, use <code>{{t|Familybio-start}}</code>, following with any combination between <code>{{t|Familybio1}}</code>, <code>{{t|Familybio2}}</code>, and <code>{{t|Familybio3}}</code>, and ending with <code>{{t|Familybio-end}}</code>

=== Games ===
Articles about game titles in [[The Sims (series)|The Sims]] series use <code>{{t|Game}}</code> to display condensed information about it.

===Unreleased and newly released ===
If an article contains information about an unreleased or newly released product, the under development template should be used. To tag an article, add <code>{{t|under development|release type|game code}}</code>.

===Tagging articles for deletion/merging===
If you come across an article which does not stand on its own (It is too short and cannot be expanded, or it contains very similar information to another article) you may want to tag it for merging with another article. If merging is not possible, then tagging it for deletion might be required.

To tag an article for merging with another article, use {{t|merge|Other article|reason}} where ''Other article'' is the article which the current article should be merged into. To tag an article for deletion, simply add {{t|delete|reason for deletion}}.

==U.S. English and commonwealth English==
Cultural clashes over grammar, spelling, and capitalisation/capitalization are a common experience on wikis. Remember that millions of people have been taught to use a different form of English from yours, including different spellings, grammatical constructions, and punctuation.

Where possible, the preferred use on The Sims Wiki is U.S. English for spellings. Where certain words might cause confusion (see [http://en.wikipedia.org/wiki/American_and_British_English_differences American and British English differences]), it is preferable to avoid the word or phrase altogether. Where possible, international standards are to be used (Dates, names, etc.) to avoid confusion.

Regardless, articles should generally follow the same style throughout. Each article should have uniform spelling and not a haphazard mix of different spellings, which can be jarring to the reader. For example, do not use center in one place and centre in another in the same article (except in quotations or for comparison purposes).

Bear in mind that some words shared by all English speakers are spelled one way by Americans (and at times Canadians and Australians) but are spelt differently in most other English speaking countries; it is generally acceptable to leave an article alone where the style is consistent throughout the article - though changes to important articles to adapt them to house style are occasionally useful, please don't make a point of changing an article to your preferred style.

== Related articles ==

* [[The Sims Wiki:Project Sims/Manual of style]]

Revision as of 00:47, 13 September 2013

On The Sims Wiki there are a few rules of style to create a standard feel to all of our articles. The formatting described here is a guideline and can be overridden where circumstances warrant it. However, please try your best to keep to the advice outlined in this article so others may use your edits as an example when creating and editing their own articles.

This manual is a summary of the most important style guidelines for this wiki. However, there are instances in which this manual may not provide definitive answers to stylistic questions. In these cases, it is best to consult other similar articles on the wiki, try to determine a proper style based on common sense, or start a discussion on an appropriate talk page or forum thread.

Article and section titles

Article naming conventions state that each word in an article title or section header should be lowercase, unless it is the first word or the word is always capitalized (Such as names, for example: "Sims", "The Sims", "Will Wright", "Maxis"). The same rules apply to categories, section headings, et cetera. They also state that nouns should always be in singular and verbs in gerund-form (verb + -ing: "making a cake") unless the words are only used in one particular form ("Scissors", for example). An exception to this rule is if the article name is also an official title or name; title case should be used in these instances.

  • Examples:
    • Life state - The first word is capitalized. The second word is not a proper noun, so it is not capitalized
    • Bella Goth - Sim names are always capitalized, as they are proper nouns.
    • The Sims 3: Into the Future - The Sims 3: Into the Future is an official title, so most words in the title are capitalized (note 'the' is lower-case)


Article layout

Designing a template for the layout of all pages helps to keep things organized and working well so that information can be found more easily. Remember that an outline is generated based on which headings you use (Headings range from level one to six, and are represented as a section title with as many equal signs on either side as the level). The article title is level one, so you should only use level two and higher (==This is level two==).

Before editors save an article, particularly before adding a new one, the following points should be considered:

Does the article title and headers comply to naming conventions?
Wikipedia's naming conventions state that each word in the title and headers should be lowercase unless it is the first word or it is always capitalized (Such as names, for example: "Sims", "The Sims", "Will Wright", "Maxis"). The same rules apply to categories, section headings, et cetera. They also state that nouns should always be in singular and verbs in gerund-form (verb + -ing: "making a cake") unless the words are only used in one particular form ("Scissors", for example).
Articles should be named in such a way that each has a unique title. Articles' titles usually indicate the name of the topic. When additional precision is necessary to distinguish an article from other uses of the topic name, over-precision should be avoided. This can be done by adding a disambiguating tag in parentheses (or sometimes after a comma); however in certain cases it may be done by choosing a different form of the title in order to achieve uniqueness.
Does the article have a logical structure?
The article should be divided into sections and the sections into paragraphs in a way that makes sense to the reader.
Is the article user-friendly?
The article should not contain a large amount of images, at least not clumped together (Use galleries for that). Only images which are directly relevant, or the most relevant image if there are several, should be used. It is also important that the article is compatible with all the big browsers (Microsoft Internet Explorer, Mozilla Firefox, Safari).
Is the article grammatically correct?
Choice of words, spelling, punctuation...
Is the article correctly categorized?
A descriptive category makes it much easier to browse information about a certain subject.

Layout template

See also: The Sims Wiki:Project Sims/Manual of style and The Sims Wiki:Project Simology/Manual of style


Basic info about the topic. If this topic also exists outside of The Sim series, a link to Wikipedia might be in order.

==Section==
A description of this section. A section should be about a certain aspect of the
topic at hand. If there is only one main aspect, the basic info above should suffice.

===Sub-section===
More details about a certain subject of the current section. More than one sub-section may
occur.

====Sub-sub-section====
Should rarely be needed, but in some cases further division of a subject may be required.

==See also==
*[[Relevant article]]
*[[Relevant article]]
*[[Relevant article]]

==External links==
*[[wikipedia:Example|Relevant wikipedia article]]
*[http://www.example.com/ Relevant external document/site]
*[http://www.example.com/ Relevant external document/site]

Categories

Adding categories to an article makes it easier for the reader to find information within a specific area. Categories are added by putting [[Category:Category name]] in an article. An article may be in more than one category, but the editor should make sure not to put an article in categories just because it might be remotely related to them, but rather because it is directly related to them.

Galleries

If your article has a large amount of images that are clumped together, making a gallery is generally a good idea. The syntax for a gallery is simple:

<gallery>
Image:Wiki.png
Image:Wiki.png|Captioned
Image:Wiki.png
Image:Wiki.png|[[Wikipedia|Links]] can be put in captions.
Image:Wiki.png
Image:Wiki.png|Full [[MediaWiki]]<br />[[syntax]] may now be used…
</gallery>

Galleries should be left-aligned, including captions and width set to either 120 or the default (no defined setting)

See also

Using templates

A template in wikicode is basically an inclusion of another article. However, templates are specifically designed to be included, and may take parameters to change their content. There are many templates available to make it easier for the editor when writing an article.

Stubs

An article that is a stub is an article that is incomplete and/or too short. To tag an article as a stub, simply add {{stub}} to the bottom of it.

You can find more specific stubs in the stubs category.

Articles that are blank or contain no useful information will be deleted.

Sim Biographies

There are several templates that can be added to a Sim's page so that a lot of their biography can be displayed easily.

For information on which templates to use and how to use them see Project Sims/Manual of style.

Families

Use {{Family1}}, {{Family2}}, or {{Family3}} to add an infobox to a family article with their respective games. Use {{FamilyPage}} to add additional information for the family.

If the family appears in several games, use {{Familybio-start}}, following with any combination between {{Familybio1}}, {{Familybio2}}, and {{Familybio3}}, and ending with {{Familybio-end}}

Games

Articles about game titles in The Sims series use {{Game}} to display condensed information about it.

Unreleased and newly released

If an article contains information about an unreleased or newly released product, the under development template should be used. To tag an article, add {{under development|<release type>|<game code>}}.

Tagging articles for deletion/merging

If you come across an article which does not stand on its own (It is too short and cannot be expanded, or it contains very similar information to another article) you may want to tag it for merging with another article. If merging is not possible, then tagging it for deletion might be required.

To tag an article for merging with another article, use {{merge|<Other article>|<reason>}} where Other article is the article which the current article should be merged into. To tag an article for deletion, simply add {{delete|<reason for deletion>}}.

U.S. English and commonwealth English

Cultural clashes over grammar, spelling, and capitalisation/capitalization are a common experience on wikis. Remember that millions of people have been taught to use a different form of English from yours, including different spellings, grammatical constructions, and punctuation.

Where possible, the preferred use on The Sims Wiki is U.S. English for spellings. Where certain words might cause confusion (see American and British English differences), it is preferable to avoid the word or phrase altogether. Where possible, international standards are to be used (Dates, names, etc.) to avoid confusion.

Regardless, articles should generally follow the same style throughout. Each article should have uniform spelling and not a haphazard mix of different spellings, which can be jarring to the reader. For example, do not use center in one place and centre in another in the same article (except in quotations or for comparison purposes).

Bear in mind that some words shared by all English speakers are spelled one way by Americans (and at times Canadians and Australians) but are spelt differently in most other English speaking countries; it is generally acceptable to leave an article alone where the style is consistent throughout the article - though changes to important articles to adapt them to house style are occasionally useful, please don't make a point of changing an article to your preferred style.

Related articles