Difference between revisions of "MHWiki:Manual of Style"
(→History and Trivia: more automation in template) |
(→Combined Trap Statistics: automatic categories for bases) |
||
Line 375: | Line 375: | ||
|} | |} | ||
;Categorization and Table of contents | ;Categorization and Table of contents | ||
− | * Lastly comes proper categorization. This does not have a section on its own. The infobox automatically includes the Bases | + | * Lastly comes proper categorization. This does not have a section on its own. The infobox automatically includes the Bases, Limited Edition, Craftable, and Smashable categories, as appropriate. Thus no further categorization is needed. |
− | * The table of contents | + | * The infobox automatically hides the table of contents with a <nowiki>__NOTOC__</nowiki> tag. This is to prevent the page from looking odd by having a TOC above the infobox. |
<!-- The complete Bases page ends just before this comment. Ignore everything else below when using as template. --> | <!-- The complete Bases page ends just before this comment. Ignore everything else below when using as template. --> | ||
|} | |} |
Revision as of 14:28, 19 July 2014
The Manual of Style contains the general formatting for the different categories of pages in use at the moment, and lists down the basic structure of an article in that category.
Mice
The Mouse pages are as laid out below. This can also be used as the basic structure in creating a new Mouse page. Note that the sections should always be laid out in the order in which they are shown below, which is in the order of importance that most players will consider the information.
The article starts by using the editor's descriptions of the mouse. Does not have its own section header since it is the first set of text on the page. Differs from the in-game description. Normally contains the following:
This information is followed by the Mouse Template.
Preferred CheeseThis section should always be included, clearly stating if a mouse has any preferences. A sample writeup would be, While the Student of the Cheese Claw can be attracted by standard cheese, it has a distinct preference for SUPER|brie+ and Maki. Thus clearly explaining that while there is a bait preference, standard cheese can be used. This is information that is not covered by the infobox. Hunting StrategyThis section is optional, since not all mice need a strategy. An example would be, It is typically recommended that a hunter who wishes to find the elusive Mole should use White Cheddar cheese and hunt in the Meadow. Unlike the Town of Digby, this area is overrun with White, Grey, and Brown mice which are not attracted to White Cheddar cheese. The theory is that eliminating them as potential trap visitors will dramatically increase a hunter's chance of encountering a Mole mouse or, at the very least, another breed more valuable in terms of points and gold. This section differs from the preferred cheese section, and should be considered for inclusion if there is a bait preference. Event ParticipationThis section is optional since not all mice will participate in any events. Items should be listed in reverse chronological order with the most recent information listed first. The curent event location, bait preferences, and loot drops of Event mice should also be included in the InfoBox. Use Bullet Points to list each individual event. Example of Format:
History and TriviaThis section is optional, since not all mice have any associated history or trivia. The two terms are consolidated into one section as they are typically associated in MouseHunt. Items should be listed chronologically with the oldest information first. An example of trivia might be The Burglar Mouse was -really- named after a particularly nasty forum scammer. An example of history would be The Birthday Mouse was introduced to commemorate MouseHunt's first anniversary on 7 March 2009. These two examples are both part of MouseHunt and their respective mouse's history, as well as the trivia about it. Additional examples of items to include:
ImagesThis section is optional. If a mouse has more than 1 image, such as the Dwarf, this section should be included, along with the list of the different images the mouse has taken over time. Additionally, include a time-elapsed drawing video if available, such as in the Harpy article.
|
Locations
The various locations are as laid out below. This can also be used as the basic structure in creating a new Location page. Note that the sections should always be laid out in the order in which they are shown below, which is in the order of importance that most players will consider the information.
Article starts with the in-game description for the location in italics. Description and RequirementsThis section should always be included. It contains these basic elements:
ShopsThis section should always be included. It should have either a list of the shops, or state that there aren't any. For example, There are no shops available in the Mountain. The nearest available shops in the region are in the Town of Gnawnia and the Harbour. An introductory line that can be used for shops: The following shops can be found in the Town of Gnawnia: followed by the list of shops sorted in alphabetical order. Any shops should also be linked to the exact shop location. For example, the Cheese Shoppe in the Town of Gnawnia. Linking directly to Cheese Shoppe#Town of Gnawnia Cheese Shoppe is more useful than a generic Cheese Shoppe link. Location MiceThis section should always be included. It basically contains a table of all the mice that can be found here, as well as information on the amount of gold, points, power type, and loot. Mice infrequently encountered in the location should be highlighted in the table. A rough gauge of frequency would be if a mouse is not encountered at least once every 100 hunts (1/100), using its most preferred cheese. For example, in the Pinnacle Chamber, neither the Master of the Dojo nor the Hapless are considered infrequently encountered as they can be easily attracted when using the correct cheese. It should be noted that the encounter frequency is a term mentioned only on the MH Wiki, and is not an official in-game definition. It is meant to highlight to players which mice would pose more of a challenge to encounter and thus require more patience to catch. Encounter frequency should also not be confused with Rare Breeds. While some rare breeds such as Black Widow mice are infrequently encountered, others are can be described as event specific mice, for example Cupid and Hollowhead mice, which are not too difficult to encounter when released. Bait preference (or dislike) should be covered in the Hunting Strategy section below, and not in this table. A sample table is shown below. Notice that Black Widow mice are shaded. The table is properly formatted and should be used. Full links to the loot, even if repetitive, should always be included. Note that short mice name links should be used here, as there is no need to bloat the page using [[Bionic Mouse|Bionic]] when [[Bionic]] will suffice. This cuts down on page size for links that are not frequently used.
Hunting StrategyThis section should always be included, and bait preference must be written up. If there are no hunting strategies available (unlikely due to game design), it should state so. Hunting strategy covers a broad scope, and can be something like: Monster mice can only be encountered in the Laboratory if the hunter uses Radioactive Blue cheese as bait. Cheese UsageThis section should always be included as a subsection under Hunting Strategy. It covers the nuances of cheese usage in the location. For example: Hunting tips by LarryThis section should always be included as a subsection under Hunting Strategy. Simply copy Larry's words from the Camp Page and link the important terms. For example: If you need to purchase more cheese or buy a new part for your trap, you will have to travel back to town and visit the shops there. When you graduate from Novice and become an Apprentice, you may want to travel to the Harbour. Location-Specific EffectsThis section is optional; it should be included if any weapon, base, charm, or cheese has a location-specific effect triggered while hunting in this area. For example:
History and TriviaThis section is optional. Self descriptive. This section can be used to hold information on the previous visits of Ronza's for example. It can also contain information like, The Abominable Snow Mouse could be found in this location for a brief period of time around Christmas 2008. LinksThis section is optional. It may contain Trap Setup Options link for the location. It may also contain a link to the location banner image.
Finally, the navbox needs to be updated and added to the bottom of the page using "{{location}}". The navbox template will automatically insert the Locations category, so the only text that needs to be added is {{location}}. |
Weapons
The Weapon pages are as laid out below. This can also be used as the basic structure in creating a new Weapon page. Note that the sections should always be laid out in the order in which they are shown below, which is in the order of importance that most players will consider the information.
Article starts with a brief editor's description of the weapon. Typical entries can be something like, The 500 Pound Spiked Crusher is one of the first few weapons readily available to a hunter., or The High Tension Spring is one of original weapons that came with first version of MouseHunt. It is also one of the two weapons that new players can choose from. Further information on the locations the weapon is usually used in can also be included. For example, The Sinister Portal is most often used by hunters in the Mousoleum. Follow that info with the Weapon Template.
Obtained ViaThis section must always be included. There are a few possibilities in this section:
Formula
Any additional notes about the crafting formula should come here, such as, The total cost of crafting only includes direct vendor costs. Variable costs in acquiring the ingredients are not included, such as the cost of SUPER|brie+ to get Magic Essence. Related WeaponsThis section is optional. It should be included when there's a good substitute for the weapon, such as Ambrosial/Sinister, DeathBot/Forcefield, Tacky Glue/High Tension and so on. Ideally, a brief comparison of the weapons should also be made, such as, Ambrosial Portal - The Ambrosial Portal has a fresher cheese effect and better attraction bonus but lower power bonus. SkinsThis section is optional. It should be included when there is a skin available for the weapon, such as Costumed Ambush Skin for Ambush. Hunter's HammerThis section is optional. It should be included when the weapon is available for smashing, such as Obelisk of Slumber and Mouse DeathBot. The section header should also include a link to the Hunter's Hammer article. History and TriviaThis section is optional. Some of the information it can contain is, The Snow Barrage was only available for sale in Ronza's for a brief period in December 2008. Combined Trap StatisticsThis section should always be included, and must be at the bottom of the page due to it's size. It is basically a table of the Weapon values when combined with the respective base. It should be in alphabetical order on the base names and contain the following headers: Base, Power, Power Bonus, Attraction Bonus, Luck, Cheese Effect. A sample from the Swiss Army Mouse Trap is shown below. The standard writeup (less italics) for this section is:
|
Skins
The Skin pages are as laid out below. This can also be used as the basic structure in creating a new Skin page. Note that the sections should always be laid out in the order in which they are shown below, which is in the order of importance that most players will consider the information.
WeaponArticle starts with the Skin Template, followed by the Weapon section to mention which Weapon the skin modifies, and a brief editor's description of the skin. Typical entries can be something like, The Extremely Enraged Rhinobot Skin can be used on the Enraged RhinoBot. The trap's stats (power, power bonus, attraction bonus, etc.) do not change at all. Related SkinsThis section is optional. It should be included when more than one skin can be applied to the same weapon. History and TriviaThis section should always be included, with a minimum entry of the date the skin was introduced into the game.
|
Bases
The Base pages are as laid out below. This can also be used as the basic structure in creating a new Base page. Note that the sections should always be laid out in the order in which they are shown below, which is in the order of importance that most players will consider the information.
Article starts with a brief editor's description of the base. Common topics such as, The Wooden Base is the first base available for hunters. Followed by Base Template.
Obtained ViaThis section must always be included. There are a few possibilities in this section:
Formula
Any additional notes about the formula should come here. For example, The total cost of crafting only includes direct vendor costs. Variable costs in acquiring the ingredients are not included, such as the cost of cheese used in obtaining Splintered Wood as loot. History and TriviaThis section is optional. Some of the information it can contain is, The Dehydration Base was introduced 4 December 2008. Combined Trap StatisticsThis section should always be included, and must be at the bottom of the page due to it's size. It is basically a table of the Base values when combined with the respective weapons, and should be organized in alphabetical order on the weapon name. A sample from the Stone Base table is shown below. The standard writeup (less italics) for this section is:
|
Charms
The Charm pages are as laid out below. This can also be used as the basic structure in creating a new Charm page. Note that the sections should always be laid out in the order in which they are shown below, which is in the order of importance that most players will consider the information.
Article starts with inclusion of a brief editor's description of the charm. Common topics such as, The Power Charm is one of the first charms available for hunters. This info is followed by the Charm Template.
Obtained ViaThis section must always be included. There are a few possibilities in this section:
Formula
Any additional notes about the formula should come here. Location-Specific EffectsThis section is optional, but should be included if the charm affects gameplay in a specific area. For example, The Black Powder Charm allows the hunter to attract Black Powder Thief mice in the Daredevil Canyon phase of the Gnawnian Express Station. This section can be titled Special Effects if the effect is not specific to a location (for example, the Eggscavator Charge Charm works anywhere). Hunter's HammerThis section is optional, but should be included if the charm is smashable. For example, Smashing an Eggscavator Charge Charm with the Hunter's Hammer yields 5 Dark Chocolate Charms. Related ItemsThis section is optional, but can be included if other charms are closely associated with this charm. For example, the Black Powder Charm lists other charms also used in Daredevil Canyon: History and TriviaThis section is optional but recommended. Some of the information it can contain is, The Power Charm was introduced 12 January 2011.
|
General Formatting
The general formatting section provides basic guidelines for the following aspects of the MH Wiki:
Dates
The dates in MH Wiki should be in the following format:
- 5 March 2009
This is to keep in line with the format used by the Developers.
In-Game Spelling
In general, all in-game text quoted on the wiki is an exact copy, spelling mistakes included, if any. Editors should avoid correcting any spelling or grammar mistakes, such as when posting in the MHWiki:Current events page. (sic) must also be avoided as it is condescending and makes the Developers look bad. Some exceptions to this is when it involves a critical element of gameplay, such as the description of Attraction Bonus as Accuracy Bonus. If you spot any mistakes, inform the Developers on the Tech Support forums.
Linking
- How many links is too many?
- In general, linking to another page should be done once per article. Exceptions are when each section is self contained, such as in the Location Quick Reference, or the Mouse pages, such as the Monster Mouse page, where links already in the infobox are repeated in the main write up. The main idea is to provide accessible links without overdoing it.
- What to look out for when linking
- When linking articles, make sure to link to the actual name as much as possible, rather than linking to a centralized article. For example, when linking to Combat cheese, which currently resides in the centralized article Crafted cheese, you would use the link [[Combat]]. Avoid using the link [[Crafted cheese|Combat]]. This is to prevent broken links if the section name is changed. In this way, only the redirect in [[Combat]] needs to be updated.
- Mouse page links
- When linking to a mouse page, it is acceptable to use either the short or long name depending on your needs. For example, you can link to either [[Bat]] or [[Bat Mouse]], since Bat is a redirect to Bat Mouse. There is no need to use [[Bat Mouse|Bat]], which adds unnecessary bulk to the page. However, do be cautious when using ambiguous links like [[Gold]] which may not link to the intended page.
- Linking other pages/external websites
- Always provide a link description in order to aid ease of navigation. For example, linking to the Cheese Effect page from the Stale Cheese article, it can be written as:
- Cheese Effect – Information on how cheese goes stale.
- As can be seen from the example, it explains the link in a quick summary. This is much more informative than just tossing in a link itself. Additionally, please use the en-dash '–' ('–') rather than the standard minus '-' sign for consistency in the wiki.
Lists
In general, when there's a long list of items in a table or sub-category, the list should be alphabetized from A to Z. If it's mixed format with numbers, that should come before the alphabets. Using some of the weapons for example:
- 500 Pound Spiked Crusher
- Ambrosial Portal
- High Tension Spring
- Mouse Mary O'Nette
The exception to this is when the article intends to preserve the natural order. For example, the natural order of locations in Gnawnia would be:
- Town of Gnawnia
- Meadow
- Harbour
- Mountain
Numbers
Large numbers should always have a comma ',' at the thousands and millions mark and so on, for example:
- 250
- 6,000
- 1,200,000
Editor's Corner | |
---|---|
Attention Articles: | Pending Tasks • Completed Tasks • Images Needed Missing Image (auto) • Missing ID (auto) |
Manual of Style: | Mice • Location • Weapon • Base • Charm • Skin • General |
Data Links: | New Mice • New Loot • New Locations • New Cheese |
How-To: | Editing • Categorization • Tables • Tag Reference |