Difference between revisions of "Help:Style Guide"

From WNY Wildlife Wiki
Jump to: navigation, search
(For Species)
(Text)
Line 38: Line 38:
 
==Text==
 
==Text==
  
Text may be styled to improve the appearance of the article.
+
Text may be styled to improve the appearance of the article, but should be kept simple and to a minimum.  Bold and italics should be used sparingly, and colorization should be avoided.
  
 
==Font colour==
 
==Font colour==

Revision as of 01:08, 28 January 2011

The style guide exists to ensure all entries and edits on the WNYWildlife Wiki are consistent. Although one way is often as good as another, keeping the articles consistent means that they will be easier to read and to use.

Article Titles

Article Titles must be the simplest, most common expression someone would use to look for the subject matter on that page. For a plant, animal, or other organism, the local common name should be used, if any.

All words major contained within the page title should be capitalized. The only words that should not be capitalized are smaller words (such as "and", "or", "the", etc.). The word "and" should be spelled out instead of using an ampersand ("&").

Titles of individual species should not be pluralised; Groups of organisms should always be pluralized, though some use the same word, such as "Deer".

Examples:

  • Fishes (a class of vertabrates)
  • Sheephead (a type of fish)
  • Salamanders (could refer to many species)
  • Red-Backed Salamander

The subject of the article should be in bold only in the first occurrence of the word. Any subsequent occurrences are left as plain text.


Sections and Subsections

Where appropriate, articles should be split up into sections. This makes them easier to read and edit. Each section should have a title. The title of each section should follow the same guidelines as article titles. There should not be links in the title, and the title should be as short as possible.

Use two equal signs (==) style markup for main headings. Start with ==, add the heading title, then end with ==. Subsections use three equal signs (===). Except for listing a single species within a group, subsections should ideally be used when there is more than one logical grouping of information within the section.

For Species

For any individual species (other than on a page of its own), the listing is always treated as a subsection, meaning three equal signs, even if there is only one species listed in the group. If there is only one group on the page (the group will likely be the page itself in this case), the above rule still holds, even if there are no sections.

  • This section's heading was created with the markup:
== Sections and Subsections ==
  • This subsection's heading was created with the markup:
=== Species ===

Text

Text may be styled to improve the appearance of the article, but should be kept simple and to a minimum. Bold and italics should be used sparingly, and colorization should be avoided.

Font colour

In rare cases, font colour can be used in articles. Dark colours should be used to emphasize certain points. Using bold is a preferred alternative to using colours. Do not use light colours, as the do not show up well on the white background.

Bulleted lists

Bullet points can be used to create a list. To use a bullet point, put an asterisk (*) before each point. For example:

*Point 1
*Point 2
*Point 3
**Sub-point 3

Comes out as:

  • Point 1
  • Point 2
  • Point 3
    • Sub-point 3

Numbered lists

Numbered lists are similar to bulleted lists. They should be used to order items or in step-by-step instructions. To create a number list, put a number sign (#) before each point. For example:

#Point 1
#Point 2
#Point 3

Comes out as:

  1. Point 1
  2. Point 2
  3. Point 3

Bold and italics

Put two apostrophes (''italics'') around text to make it italic. Italics should be used to emphasise single word or phrases. It should not be used for long bits of text.

Put three apostrophes ('''bold''') around text to make it bold. Bold should be used to emphasise longer parts of text, or where italics is not enough. The first appearance of an article's title should be in bold. Any subsequent appearances should be left as plain text.

Links

A link is places by putting square brackets ([[link]]) around words. This will make a link to the article, using the exact words in the link. A link can also be made with a different word as the link, by putting the title, a | symbol then the word you want to appear in square brackets. For example, [[farmer|player]] appears as player but is linked to the farmer article.

  • Links should be added to any articles on a page
  • Links should not be made to the same article multiple time. This means that if the word farmer is mentions 5 times, only the first appearance of the word should be linked.
  • Plurals can be linked to by placing the s outside the box. For example, [[farmer]]s will link to farmer and will display as farmers.

Writing articles

The following should be kept in mind when writing articles.

  • Nobody owns the articles. This means that words such as 'I' should be left out.
  • Keep bias out of articles. The Wiki should remain neutral and any personal opinions must be kept out. Useful ideas are allowed in articles.
  • Do not add any unverifiable facts without sourcing the proof.

Introductory Sentence

Every article should start with an introductory sentence, naming the thing this article is about (cp. page name), what kind of thing it is (game function, item type, etc.), where users may find/obtain it and when it has been released. Please make sure to use a determiner ("the", etc.) at the beginning of a sentence. Example: "The FarmVille Wiki is a..." instead of "FarmVille Wiki is a...".

Basic form of an item introductory sentence: "The (page name) is a (type of item) [optional: on FarmVille], that has been released on (date) and is available (way to access/get this item)."

Examples

"The Kensington Bench is a decoration that has been released on the 3rd of March 2010 and is available by gifting. -OR- The Kensington Bench is a giftable decoration on FarmVille that has been released on the 3rd of March 2010."

"The Biplane is a vehicle that has been released on June 3rd 2010 and can be purchased for 30,000 coins in the market or obtained as a reward for the Peanut Butter Jelly Co-Op."

"The Farmer's Market is a new feature on FarmVille that has been introduced on May 26th 2010, which is available to farmers of Level 15 and above and can be accessed from a Market Stall."

Sizing Conventions

To keep consistency across the Wiki, the following sizing conventions should be used:

  • Squares are used to determine size
  • A hay bale has an area of 1x1
  • A plot has an area of 4x4
  • Therefore, a fence has an area of 1x5