User:Vaileasys/Sandbox: Difference between revisions

From PZwiki
(Starting new section for Help:Style guide)
(Completed and ready for commit?)
Line 21: Line 21:


===Introduction===
===Introduction===
* This section should contain a brief introduction to the subject in question.
* It should begin with an [[wikipedia:Article (grammar)#Indefinite article|indefinite article]] ('a' or 'an'), followed by the singular form of the subject in '''bold''' and lowercase.
** An exception is if the in-game name of the item/object/mechanic is pluralised or contains a [[wikipedia:Article (grammar)#Proper article|proper article]], in which case 'a' or 'an' should be removed.
** If the item/object/mechanic is a [[wikipedia:Proper noun|proper noun]], then it should be written in uppercase.
* [[wikipedia:Help:Example|Links]] to other pages within the wiki should be added where appropriate.
===Table of contents===
===Table of contents===
A table of contents (TOC) is automatically added to articles with at least 4 sections. It is positioned on the left-side above the first section by default.
* If the TOC is not needed then, then it can be removed with: <code><nowiki>__</nowiki>NOTOC__</code>
* Alternatively, the TOC can be positioned manually with: <code><nowiki>__</nowiki>TOC__</code>
===Article sections===
===Article sections===
*'''Overview''' or '''Mechanics'''
*'''Overview''' or '''Mechanics''': this section should only be included if there is a significant amount of detail that needs to be covered and cannot be placed in the [[#Introduction|introduction]].
*'''Usage'''
*'''Usage''': This section should contain all the uses for the item. Topics can be separated into additional sections if required, no matter how little information there might be.
**'''Recipes'''
*'''Crafting''': All the crafting recipes the item is involved in should be included in this section.
*'''Obtaining'''
*'''Distribution''': How/where the item/object is distributed should be included within this section. This can be broken down further into "buildings" and "vehicles" if necessary.
**'''Item distribution'''
*'''Gallery''': An assortment of relevant images, organised within the <gallery></gallery> container.
***'''Buildings'''
*'''Trivia''': A list of interesting facts directly related to the subject of the article. Try not to duplicate information already included in the other sections of the article and avoid points that may be considered common-sense.
***'''Vehicles'''
*'''Code''': Code directly related to the subject found in txt files should be placed here.
**'''Crafting'''
*'''See also''': Links to any articles that may be related to the subject of the article and weren't mentioned in the article, should be listed here.
*'''Gallery'''
*'''References''': A list of any references used to suppоrt any statements made with in the article. Read more about [https://www.mediawiki.org/wiki/Help:Cite citing sources].
*'''Trivia'''
*'''Code'''
*'''References'''
===Navigation footer===
===Navigation footer===
Many articles will require having a ''navigation footer'', recognised as a [[Template:Navbox|navbox]], which lists all similar items/objects.

Revision as of 16:28, 18 July 2018

Article Layout

Titles

Pages must have appropriate titles.

  • Articles about items, tiles, structures, non-player characters, locations, quests or stories should be titled exactly how the name appears in-game.
    • This includes, but is not limited to, capitalisation, spelling mistakes and UK English vs US English.
  • Articles about in-game characters should contain their first and last names, rather than their nickname. For example, rather than Bob or Baldspot, the article would be called Bob Smith.
    • The exception is if the full name is not known, therefore only the first name is required, otherwise the nickname.

Language bar

This section is for the language bar. The languages section is used to link all the different languages that article can be found in. For example: {{languages|Nails}} displays a link to every page that is connected with /## on the end (e.g. Clous), even if the article contains redirects.

Header/Navbar

The header/navbar displays a navigation bar, when the article was last updated and a background for the article. Due to current wiki policy, articles that are about an in-game item or mechanic must include a version category based on when they were last updated in the wiki. This allows us to track which articles may be outdated.

Infobox

This section is for the infobox which will be positioned on the right-side of the page. The infobox provides a quick summary of important points and are easy-to-read.

Notices and notice boxes

Notices can be anything from a notice box, which alerts both readers and editors of something important about the article, to a disambiguation link, which is used to present a link to what the reader may have been searching for instead.

Introduction

  • This section should contain a brief introduction to the subject in question.
  • It should begin with an indefinite article ('a' or 'an'), followed by the singular form of the subject in bold and lowercase.
    • An exception is if the in-game name of the item/object/mechanic is pluralised or contains a proper article, in which case 'a' or 'an' should be removed.
    • If the item/object/mechanic is a proper noun, then it should be written in uppercase.
  • Links to other pages within the wiki should be added where appropriate.

Table of contents

A table of contents (TOC) is automatically added to articles with at least 4 sections. It is positioned on the left-side above the first section by default.

  • If the TOC is not needed then, then it can be removed with: __NOTOC__
  • Alternatively, the TOC can be positioned manually with: __TOC__

Article sections

  • Overview or Mechanics: this section should only be included if there is a significant amount of detail that needs to be covered and cannot be placed in the introduction.
  • Usage: This section should contain all the uses for the item. Topics can be separated into additional sections if required, no matter how little information there might be.
  • Crafting: All the crafting recipes the item is involved in should be included in this section.
  • Distribution: How/where the item/object is distributed should be included within this section. This can be broken down further into "buildings" and "vehicles" if necessary.
  • Gallery: An assortment of relevant images, organised within the

container.

  • Trivia: A list of interesting facts directly related to the subject of the article. Try not to duplicate information already included in the other sections of the article and avoid points that may be considered common-sense.
  • Code: Code directly related to the subject found in txt files should be placed here.
  • See also: Links to any articles that may be related to the subject of the article and weren't mentioned in the article, should be listed here.
  • References: A list of any references used to suppоrt any statements made with in the article. Read more about citing sources.

Navigation footer

Many articles will require having a navigation footer, recognised as a navbox, which lists all similar items/objects.