Confirmedusers, editor
2,831
edits
Help:Style guide: Difference between revisions
From Vintage Story Wiki
Expanding on categories + templates, redirs
(initial creation) |
(Expanding on categories + templates, redirs) |
||
| Line 4: | Line 4: | ||
Wikipedia already offers a general [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style style manual], though further guidelines are required for ''Vintage Story'' related articles. This page will reiterate a handful of concepts covered in the aforementioned manual to facilitate the definition of this wikis' look and feel. | Wikipedia already offers a general [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style style manual], though further guidelines are required for ''Vintage Story'' related articles. This page will reiterate a handful of concepts covered in the aforementioned manual to facilitate the definition of this wikis' look and feel. | ||
== Article titles == | == Titles == | ||
Section and article titles should both be written in '''sentence case''', where only the first word is capitalized. This is because MediaWiki automatically capitalizes the first letter of links. Therefore, when trying to insert links into sentences, it is far easier if the page title in question is in sentence case. For example, if the page on helve hammers was titled <code><nowiki>Helve hammer</nowiki></code>: | |||
: <code><nowiki>One example of a mechanism is the [[helve hammer]].</nowiki></code> | |||
But if the page was titled <code><nowiki>Helve Hammer</nowiki></code>: | |||
: <code><nowiki>One example of a mechanism is the [[Helve Hammer|helve hammer]].</nowiki></code> | |||
This greatly simplifies adding links and avoids incorrect capitalization. | |||
=== Article titles === | |||
Article titles should generally be in the singular form. Never prefix them with ''The'', ''A'', ''An'' or so on, unless it is part of the name, such as most of the game update names. The title should follow normal phrase capitalization unless it is a proper noun. | Article titles should generally be in the singular form. Never prefix them with ''The'', ''A'', ''An'' or so on, unless it is part of the name, such as most of the game update names. The title should follow normal phrase capitalization unless it is a proper noun. | ||
* reflect the name of the item in the game, for example: 'Ore blasting bomb' not 'Bomb'. | |||
* be complete noun or verb phrases, for example: 'Tool Strength Chart' not 'Chart: Tool Strength'. | |||
* '''In English:''' singular nouns. For example, the page is "Axe", not "Axes", and "Berry", not "Berries". | |||
=== Section headings === | |||
Section headings should always follow sentence style capitalization. Main sections in an article should have a level 2 heading (<code>== Heading ==</code>) and increase by one for any sub-sections. | |||
== Writing == | == Writing == | ||
| Line 15: | Line 36: | ||
==== Items, blocks and mobs ==== | ==== Items, blocks and mobs ==== | ||
All item (materials, weapons, tools, etc.), block and mob names are considered common nouns and should not be capitalized unless it is at the beginning of a sentence. | All item (materials, weapons, tools, etc.), block and mob names are considered common nouns and should not be capitalized unless it is at the beginning of a sentence. | ||
==== Game ==== | ==== Game ==== | ||
''Vintage Story'' should always follow title case capitalization, as well as formal update names (eg. [[The De-Jank and Game Juice Update]]). Gamemodes like [[Survival]] or [[Creative]] should also be capitalized. | ''Vintage Story'' should always follow title case capitalization, as well as formal update names (eg. [[The De-Jank and Game Juice Update]]). Gamemodes like [[Survival]] or [[Creative]] should also be capitalized. | ||
=== | == Linking == | ||
Where appropriate, topics relating to ''Vintage Story'' should be made into links, as long as this doesn't negatively affect article readability. Ultimately, the goal is to neither overlink, nor underlink, as either can negatively impact the reading experience. | Where appropriate, topics relating to ''Vintage Story'' should be made into links, as long as this doesn't negatively affect article readability. Ultimately, the goal is to neither overlink, nor underlink, as either can negatively impact the reading experience. | ||
Here are some general loose guidelines when it comes to linking in an article: | Here are some general loose guidelines when it comes to linking in an article: | ||
* Generally, a link should only appear ''once'' in an article, but may appear multiple times if helpful to the reader. This applies more heavily to larger articles, where links are more likely to no longer be visible on a users' screen as they scroll. Providing repeat links this way can help prevent frustration and the need to use the search bar if and when they may want to read on about a related topic. | * Generally, a link should only appear ''once'' in an article, but may appear multiple times if helpful to the reader. This applies more heavily to larger articles, where links are more likely to no longer be visible on a users' screen as they scroll. Providing repeat links this way can help prevent frustration and the need to use the search bar if and when they may want to read on about a related topic. | ||
* Two links should not be immediately next to | * Two links should not be immediately next to each other, as this can cause them to appear as a single link instead. If you feel it necessary to use both links, either try to rephrase or - when applicable - use a single, larger link instead (eg. [[Stone Blocks|stone blocks]] instead of [[Stone|stone]] [[Blocks|blocks]]). | ||
== Redirects == | == Redirects == | ||
''Note: the wiki currently has an extension installed which replaces the display text of redirect pages with their destination page instead. For the time being, and if applicable, use piped links with a lowercase display name in order to display the appropriate link text (eg. <code>[[Trunk|trunk]]</code>). | Redirects help readers find pages that may have many common synonyms, or where the topic in question is covered as a subsection of a larger page. Redirects should be used where a short stub page would be inappropriate, or where that topic is already covered in depth on another page. For example, instead of having a page for every type of flower, common flower names should redirect to the central [[Flower]] page. | ||
''Note: the wiki currently has an extension installed which replaces the display text of redirect pages with their destination page instead. For the time being, and if applicable, use piped links with a lowercase display name and a space in order to display the appropriate link text (eg. <code>[[Trunk| trunk]]</code>). | |||
== Article layout == | == Article layout == | ||
Unless an article fits into a more defined style guide (such as [[Vintage_Story_Wiki:Style_guide/Versions|Style_guide/Versions]]), almost all pages on the site should attempt to follow the following layout, in order : | |||
Unless an article fits into a more defined style guide (such as [[Vintage_Story_Wiki:Style_guide/Versions|Style_guide/Versions]]), almost all pages on the site should attempt to follow the following layout, in order: | |||
# '''[[Template:Hatnotes|Hatnotes]]''' | # '''[[Template:Hatnotes|Hatnotes]]''' | ||
# '''[[Template:Message boxes|Message boxes]]''' | # '''[[Template:Message boxes|Message boxes]]''' | ||
| Line 52: | Line 77: | ||
Certain articles may fit into particular article categories which have received unique style guides that do not fully respect the previous layout order. These unique style guides are: | Certain articles may fit into particular article categories which have received unique style guides that do not fully respect the previous layout order. These unique style guides are: | ||
* [[Vintage_Story_Wiki:Style_guide/Versions|Versions]] | * [[Vintage_Story_Wiki:Style_guide/Versions|Versions]] | ||
[[Category: | == Categories and templates == | ||
[[Category: | |||
=== Categories === | |||
If manually adding categories, include them at the very end of an article. Categories should follow sentence case capitalization, and be '''plural''' (e.g. "Metals" instead of "Metal"). Categories on pages that are marked for translation will need the addition of the <code><nowiki>{{#translation:}}</nowiki></code> tag. | |||
=== Maintenance templates === | |||
== See also == | |||
* [[Vintage_Story_Wiki:How_to_translate_the_wiki|How to translate the wiki]] | |||
[[Category:Style guides]] | |||
[[Category:Wiki editing]] | |||
