Style Guide: Difference between revisions

From Unofficial werewolv.es How To Play
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
Before editing the wiki you should familiarise yourself with the basics of [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki markup]. It's very simple to learn and it is the same as [https://www.wikipedia.com Wikipeida].
=Wiki Markup=


Before editing the wiki you should familiarise yourself with the basics of [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki markup]. It's very simple to learn and it is the same as [https://www.wikipedia.com Wikipeida].


=Rules=


There are some general rules about editing that you must follow:
There are some general rules that you must follow:


1) '''You must keep your account name the same as your account on ww.es or Discord'''
'''1) You must keep your account name the same as your account on ww.es or Discord'''


To edit a page you need to make an account. To make an account you must use the same name as your account on werewolv.es or Discord and be a member of the ww.es discord server.  
To edit a page you need to make an account. To make an account you must use the same name as your account on werewolv.es or the ww.es discord server.  


2) '''Do not edit or create a page whilst you are in an active game.''' - NO EXCEPTIONS
'''2) Do not edit or create a page whilst you are in an active game. NO EXCEPTIONS.'''  


For example if you have a new role or item you '''must''' wait until after the game has finished to add it to the wiki.
For example if you have a new role or item you '''must''' wait until after the game has finished to add it to the wiki.


3) '''Do not copy/paste from the official How to Play.'''
'''3) Do not copy/paste from the official How to Play.'''


You must write your own text and description, rather than copying from the official H2P. Text from in-game (e.g role text, item text etc is okay to copy/paste exactly as it is in the game).
You must write your own text and description, rather than copying from the official H2P. Text from in-game (e.g role text, item text etc) is okay to copy/paste exactly as it is in the game.


==Guidelines==
=Guidelines=


The most important thing to remember when writing an article or editing an existing one is to '''keep it factual'''. You should avoid opinions and strategy guidance as these are subjective and not always relevant.
The most important thing to remember when writing an article or editing an existing one is to '''keep it factual'''. You should avoid opinions and strategy guidance as these are subjective and not always relevant.
Line 23: Line 25:
For example if editing information about the [[Protector]] you might add:
For example if editing information about the [[Protector]] you might add:


* The protector is able to protect a target once per night but not the same target twice in a row
* ''The protector is able to protect a target once per night but not the same target twice in a row''


Which is factual, but you shouldn't add:
Which is factual, but you shouldn't add:


* The protector is best protecting themselves on the first night  
* ''The protector is best protecting themselves on the first night''


because this is subjective and strategy based.
because this is subjective and strategy based.


==Templates==
 
Other tips:
 
* It's good practice to avoid putting too much information on a page that is duplicated elsewhere. For example, each individual Rune page (e.g [[Hvísla Rune]], [[Sjón Rune]] etc) does not contain information about how Runes work generally. Instead the [[Runes]] page is linked from here. This means that if ever Rune mechanics change, we only have to update one place and not find every mention of how Runes work on the wiki.
 
* When creating a new page Capitalise Every Word. The wiki is case sensitive so [[Aura Seer]] is a different page to [[aura seer]]. The convention is to capitalise every word in a page name.
 
* If you are adding a new role or item, it's usually easier to just copy/paste from a similar existing role or item and change the details, to ensure the formatting is consistent.
 
=Templates=


When editing there are some templates you can use to make life easier. Templates are special pages that can be edited by searching for Template:<name> in the search box. Once edited, the changes appear in all instances of the template, so they are useful for when information is needed in multiple places at once, or to make editing easier and less repetitive.
When editing there are some templates you can use to make life easier. Templates are special pages that can be edited by searching for Template:<name> in the search box. Once edited, the changes appear in all instances of the template, so they are useful for when information is needed in multiple places at once, or to make editing easier and less repetitive.
Line 37: Line 48:
Current templates are:
Current templates are:


===Info Boxes===
==Info Boxes==


'''<nowiki>{{roleinfo}}</nowiki>''' is a template for role pages which includes the basic info about that role. It has options which are set by using the <nowiki>|</nowiki> symbol followed by the option name and an equals sign (e.g. |alignmentstatus=) and then whatever comes after the equals sign is included on that line. It is included near the top of every role page.
'''<nowiki>{{roleinfo}}</nowiki>''' is a template for role pages which includes the basic info about that role. It has options which are set by using the <nowiki>|</nowiki> symbol followed by the option name and an equals sign (e.g. |alignmentstatus=) and then whatever comes after the equals sign is included on that line. It is included near the top of every role page.
Line 47: Line 58:
'''<nowiki>{{Runehelp}}</nowiki>''' is a template which simply informs the user that the item being viewed is a rune and links to the [[Runes]] page for more information on the mechanics of runes.
'''<nowiki>{{Runehelp}}</nowiki>''' is a template which simply informs the user that the item being viewed is a rune and links to the [[Runes]] page for more information on the mechanics of runes.


===Lists===
==Lists==


'''<nowiki>{{Auralist}}</nowiki>''' is a template for listing the known auras in the game. Having this as a template allows us to update it once and it can appear on numerous pages. It is a table with no specific variables.
'''<nowiki>{{Auralist}}</nowiki>''' is a template for listing the known auras in the game. Having this as a template allows us to update it once and it can appear on numerous pages. It is a table with no specific variables.
Line 54: Line 65:




===Notifications===
==Notifications==


'''<nowiki>{{missing info}}</nowiki>''' should be put within a section of an article that is missing non-essential information. Non-essential information are things like role text, ability text and item text. <small> [https://unofficialhowtoplay.co.uk/index.php?title=Special%3AWhatLinksHere&target=Template%3Amissing+info&namespace= Show all pages that include this] </small>
'''<nowiki>{{missing info}}</nowiki>''' should be put within a section of an article that is missing non-essential information. Non-essential information are things like role text, ability text and item text. <small> [https://unofficialhowtoplay.co.uk/index.php?title=Special%3AWhatLinksHere&target=Template%3Amissing+info&namespace= Show all pages that include this] </small>

Latest revision as of 03:16, 25 November 2020

Wiki Markup

Before editing the wiki you should familiarise yourself with the basics of MediaWiki markup. It's very simple to learn and it is the same as Wikipeida.

Rules

There are some general rules that you must follow:

1) You must keep your account name the same as your account on ww.es or Discord

To edit a page you need to make an account. To make an account you must use the same name as your account on werewolv.es or the ww.es discord server.

2) Do not edit or create a page whilst you are in an active game. NO EXCEPTIONS.

For example if you have a new role or item you must wait until after the game has finished to add it to the wiki.

3) Do not copy/paste from the official How to Play.

You must write your own text and description, rather than copying from the official H2P. Text from in-game (e.g role text, item text etc) is okay to copy/paste exactly as it is in the game.

Guidelines

The most important thing to remember when writing an article or editing an existing one is to keep it factual. You should avoid opinions and strategy guidance as these are subjective and not always relevant.

For example if editing information about the Protector you might add:

  • The protector is able to protect a target once per night but not the same target twice in a row

Which is factual, but you shouldn't add:

  • The protector is best protecting themselves on the first night

because this is subjective and strategy based.


Other tips:

  • It's good practice to avoid putting too much information on a page that is duplicated elsewhere. For example, each individual Rune page (e.g Hvísla Rune, Sjón Rune etc) does not contain information about how Runes work generally. Instead the Runes page is linked from here. This means that if ever Rune mechanics change, we only have to update one place and not find every mention of how Runes work on the wiki.
  • When creating a new page Capitalise Every Word. The wiki is case sensitive so Aura Seer is a different page to aura seer. The convention is to capitalise every word in a page name.
  • If you are adding a new role or item, it's usually easier to just copy/paste from a similar existing role or item and change the details, to ensure the formatting is consistent.

Templates

When editing there are some templates you can use to make life easier. Templates are special pages that can be edited by searching for Template:<name> in the search box. Once edited, the changes appear in all instances of the template, so they are useful for when information is needed in multiple places at once, or to make editing easier and less repetitive.

Current templates are:

Info Boxes

{{roleinfo}} is a template for role pages which includes the basic info about that role. It has options which are set by using the | symbol followed by the option name and an equals sign (e.g. |alignmentstatus=) and then whatever comes after the equals sign is included on that line. It is included near the top of every role page.

{{iteminfo}} is a template for item pages which includes the basic info about that item. It has options which are set by using the | symbol followed by the option name and an equals sign (e.g. |itempassivestatus=) and then whatever comes after the equals sign is included on that line. It is included near the top of every item page.

{{Aurainfo}} is a template for showing what auras are present when holding an item or under the effect of a specific mechanic.

{{Runehelp}} is a template which simply informs the user that the item being viewed is a rune and links to the Runes page for more information on the mechanics of runes.

Lists

{{Auralist}} is a template for listing the known auras in the game. Having this as a template allows us to update it once and it can appear on numerous pages. It is a table with no specific variables.

{{RuneList}} is a template which simply lists the known runes, so that it can be easily displayed on the Items page and on the Runes page without having to be updated twice.


Notifications

{{missing info}} should be put within a section of an article that is missing non-essential information. Non-essential information are things like role text, ability text and item text. Show all pages that include this

{{incomplete}} should be put at the top of any article that you're leaving as a work in progress and is missing essential information. This essentially means there is not enough information to adequately understand this page. Show all pages that include this

{{uncertain}} should be put at the top of any article which contains information that is unknown or uncertain and needs discussion. This is especially useful for new roles or items where not all the details are yet known. The "Discussion" tab on that page should be where this is then discussed and a convention agreed. Show all pages that include this

{{formatting}} should be put at the top of any article that needs formatting correctly or contains formatting errors Show all pages that include this