NBITTRPG Wiki

NBITTRPG Wiki:Manual of Style: Difference between revisions

← Older edit
VisualWikitext
big update
use of the {{t}} template
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{MoSNavBox}}
The '''Manual of Style''' is a resource specifying the guidelines or standards expected of certain pages on the wiki. It will also be a resource for how to use templates and the editor.
The '''Manual of Style''' is a resource specifying the guidelines or standards expected of certain pages on the wiki. It will also be a resource for how to use templates and the editor.


== External Resources ==
== External Resources ==
When looking for resources to help style templates or wiki pages, it's more effective to refer to documentation labeled for '''[https://www.mediawiki.org/wiki/MediaWiki MediaWiki]''' as opposed to labeled for '''Fandom'''. While both Fandom and {{SITENAME}} are both built on MediaWiki, they do not share the exact same extensions or capabilities as one another.
When looking for resources to help style templates or wiki pages, it's more effective to refer to documentation labeled for '''[https://www.mediawiki.org/wiki/MediaWiki MediaWiki]''' as opposed to labeled for '''[https://www.fandom.com/ Fandom]'''. While both Fandom and {{SITENAME}} are both built on MediaWiki, they do not share the exact same extensions or capabilities as one another.
* See [[https://www.mediawiki.org/wiki/Help:Templates|this page]] for help on creating templates.
* See [https://www.mediawiki.org/wiki/Help:Templates this page] for help on creating templates.
* If you are familiar with [https://www.w3schools.com/Css/ CSS], [https://www.w3schools.com/js/DEFAULT.asp Javascript], and understand what functions are and aren't available between {{SITENAME}} and Fandom, you can use Fandom-related style guides, like [https://community.fandom.com/wiki/Help:Contents here].
* If you are familiar with [https://www.w3schools.com/Css/ CSS], [https://www.w3schools.com/js/DEFAULT.asp Javascript], and understand what functions are and aren't available between {{SITENAME}} and Fandom, you can use Fandom-related style guides, like [https://community.fandom.com/wiki/Help:Contents here].


== Writing Style ==
== Writing Style ==
Most pages should be written in past tense. This is to avoid unintentional spoilers for those casually browsing the wiki. Future or present tense may be used for campaigns that have not happened yet.
Most pages should be written in '''past tense'''. This is to avoid unintentional spoilers for those casually browsing the wiki. Future or present tense may be used for campaigns that have not happened yet.
 
It usually does not matter whether pages use American or British English, but '''direct quotes must be kept as they are'''.
 
When referring to the wiki itself, please use {{t|SITENAME}} in place of all mentions. This is so that all references to the wiki name are updated at once if the wiki's name ever changes.  


It usually does not matter whether pages use American or British English.
== Templates ==
== Templates ==
To make a template, go to the URL and after the ".xyz/", type Template:[Template Name]. This will bring you to an entirely new page that you can then create a template on. See [[https://www.mediawiki.org/wiki/Help:Templates|this page]] on MediaWiki for more general information on templates.
'''Templates''' are wiki pages designed to be embedded onto another page. They are useful for creating informational boxes that can be put on multiple pages but changed from one source: the original template page. This wiki uses several templates to organize information. For information on templates and how to use them, refer to [[NBITTRPG_Wiki:Manual_of_Style/Templates|this page]].
=== Infoboxes ===
 
Infoboxes are a type of template that displays information in a box. This is usually a two-column table with a label on the left and page-specific data on the right. We have session infoboxes and character infoboxes as an example of these.  
See [https://www.mediawiki.org/wiki/Help:Templates this page] on MediaWiki for more general information on templates not directly related to this wiki.
 
== Page Formatting ==
To maintain consistency throughout the wiki, pages of similar in content or type should be formatted similarly to one another. Formatting includes '''content order''', '''categorization''', and any other special additions that need to be done for a page of a certain type.  


When making and naming infobox templates, please try and integrate "infobox" somewhere into the name of the template. This helps avoid confusion on what templates do what, as many templates may have similar names.
Please see [[{{SITENAME}}:Manual of Style/Page Formatting|this page]] for in-depth information on how to format pages.
=== Navigation Boxes ===
== Citations ==
Navigation Boxes are a type of template that users can use to navigate between related or similar articles. For example, the session navigation box at the bottom of session pages allow users to click between sessions within a campaign without relying on the session infobox to go in chronological order.
'''Citations''' should primarily be used for '''surprising trivia''' or '''one-off jokes''' that need links to Discord messages. They can also be used to clarify certain choices made in wiki styling or organization.


When making and naming navigation boxes, please try and integrate "navbox" somewhere into the name of the template. This helps avoid confusion on what templates do what, as many templates may have similar names.
The {{t|Cite}} template can be used in areas that might need a citation attributed to it.
=== Message Templates ===
== Magic Words ==
Message templates inform users regarding information contained on a page. These are the templates like the [[Template:Stub|Stub]] or [[Template:Spoilers|Spoilers]] template.
Something like <code><nowiki>__</nowiki>NOEDITSECTION<nowiki>__</nowiki></code> may be found at the bottom of some pages. These are '''magic words''', which may alter a way a page behaves. More information on them can be found [https://www.mediawiki.org/wiki/Help:Magic_words here].  


There are no special rules in regards to naming these upon creation, just that they're kept short, and singular. This is to prevent confusion over categories, which are usually written in plural.
Magic words are usually used on '''special''' pages that are relevant to the wiki itself, not to any pages in the main namespace. This may include the manual of style pages, category pages, or the main page. More information on magic word usage on the wiki can be found on [[{{SITENAME}}:Manual of Style/Magic Words|this page]].
=== Other Templates ===
There may be other template types made to ensure most articles with similar information can be updated at the same time. If you have an idea for a template but don't know how to make one, you can ask CStatic to make one.
== Categories ==
== Categories ==
Categories are a tagging system that allow pages to be organized by certain parameters. Please put tags in the plural, as that avoids confusion with templates. For example, [[Template:Stub|Stub]] denotes the name of a template, while [[:Category:Stubs|Stubs]] refer to the category.
'''Categories''' are a tagging system that allow certain page lists to exist and to organize information better. Please put tags in the '''plural''', as that avoids confusion with templates. For example, [[Template:Stub|Stub]] denotes the name of a template, while [[:Category:Stubs|Stubs]] refer to the category.
 
When adding categories, you may use the "'''Advanced Options'''" tool in the Visual Editor or simply place something like <code><nowiki>[[</nowiki>Category:Category Name<nowiki>]]</nowiki></code> at the bottom of the page. It does not matter what order tags are added, as they're sorted alphabetically due to one of this wiki's extensions.
 
Please see [[{{SITENAME}}:Manual of Style/Categories|this page]] for more information on how pages should be categorized.


When adding categories, you may use the "advanced options" tool or simply place something like [[[[:Category:Category Name]]]] at the bottom of the page. It doesn't matter what order tags are added, as they're usually sorted alphabetically due to one of this site's extensions.
== Redirects ==
=== Character Pages ===
If a page is named a certain way but is colloquially known as something else, a '''redirect page''' for the alternate name can be made. This is the case for <code><nowiki>[[</nowiki>Orpheus<nowiki>]]</nowiki></code>, as it redirects the reader to [[Orpheus]]. This is done by adding <code>#<nowiki>REDIRECT</nowiki> <nowiki>[[</nowiki>page name<nowiki>]]</nowiki></code> onto the former. Feel free to create as many redirect pages as you want.
Characters should be tagged with:
* [World Name]
* [[:Category:Characters|Characters]]
* [[:Category:NPCs|NPCs]] or [[:Category:PCs|PCs]]
* [World Name] NPCs or [World Name] PCs
=== Locations ===
Locations should be tagged with:
* [World Name]
* [[:Category:Locations|Locations]]
* [World Name] Locations
* If applicable, [[:Category:Cities|City]], [[:Category:Nations|Nation]], or something else
=== Sessions ===
Sessions should be tagged with:
* [World Name]
* [[:Category:Sessions|Sessions]]
* [Campaign Name] Session
* If applicable, [[:Category:Oneshots|Oneshots]], [[:Category:Finales|Finales]], or something else
== Page Formatting ==
This section is to make sure every page is consistent with other pages similar to them or of the same category. This section may become its own separate page as this page expands.
=== Character Pages ===
The formatting of character pages is dependent on world and whether they're a PC or NPC.
==== Weathia PCs ====
==== Weathia NPCs ====
==== Spireloft PCs ====
==== Spireloft NPCs ====
==== Renova PCs ====
==== Renova NPCs ====
=== Session Pages ===
The formatting of session pages is dependent on the campaign. However, some things remain the same. Please put the [[Template:SessionInfobox]] template at the top, then place everything else after. Keep the headers in the given order, but feel free to omit headers that have no applicable content. Make sure to also alphabetize the "NPC Appearance" list.
==== Weathia: Resurrection ====
Please refer to [[The Blacklight Archive]] for the general format of session pages for this campaign. Please do not change the format of this page for now, but feel free to fill in the missing information.
==== Weathia: Final Crisis ====
Please refer to [[The Fifth Leader]] for the general format of session pages for this campaign.
==== Spireloft ====
==== Renova: The Forgotten ====
=== Location Pages ===
The formatting of location pages is dependent on the world.
==== Weathia ====
==== Spireloft ====
==== Renova ====
__NOEDITSECTION__
__NOEDITSECTION__
[[Category:{{SITENAME}}]]
Retrieved from "https://nbittrpgwiki.pynappo.xyz/NBITTRPG_Wiki:Manual_of_Style"