NBITTRPG Wiki:Manual of Style: Difference between revisions

Help

Revision as of 11:33, 19 February 2025

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

When looking for resources to help style templates or wiki pages, it's more effective to refer to documentation labeled for MediaWiki as opposed to labeled for Fandom. While both Fandom and NBITTRPG Wiki are both built on MediaWiki, they do not share the exact same extensions or capabilities as one another.

See this page for help on creating templates.
If you are familiar with CSS, Javascript, and understand what functions are and aren't available between NBITTRPG Wiki and Fandom, you can use Fandom-related style guides, like here.

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.

It usually does not matter whether pages use American or British English, but direct quotes must be kept as they are.

Citations

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.

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 page on MediaWiki for more general information on templates.

Below is a guide on how to use common message/maintenance templates on this wiki. For information on other template categories, refer to this page.

Stub

{{Stub}}

The template above is used for incomplete or pages with a lot of incorrect information. This is placed on top of the page, above all other templates. Please be liberal with your usage of this template and add it to anything that's not finished. It helps people find pages to work on.

If you need to specify a reason for marking something as a stub, write:

{{Stub|Reason}}

...and replace "Reason" with a sentence explaining why.

Spoilers

{{Spoilers}}

The template above is used for pages that have content that may spoil major plot points in their related campaign. This may be used for deaths, identity reveals, and much more if applicable. You may also be liberal with usage of this template. This also does not need to be listed at the top of the page and can be moved downwards.

Delete

{{Delete}}

The template above is used for pages that are unnecessary or have been made on accident. This is to make sure the people with permissions to delete the page can see it and can be useful for allowing discussion before it's deleted.

Page Formatting

For in-depth information on how to format pages, please see this page.

@@ Line 3: / Line 3: @@
 == 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.
-* 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].
@@ Line 12: / Line 12: @@
 == Citations ==
 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.
 == 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.
+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.
-=== 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.
+Below is a guide on how to use common message/maintenance templates on this wiki. For information on other template categories, refer to [[Manual of Style/Templates|this page]].
+=== Stub ===
+<syntaxhighlight>{{Stub}}</syntaxhighlight>
+The template above is used for incomplete or pages with a lot of incorrect information. This is placed on top of the page, above all other templates. Please be liberal with your usage of this template and add it to anything that's not finished. It helps people find pages to work on.
+If you need to specify a reason for marking something as a stub, write: <syntaxhighlight>{{Stub|Reason}}</syntaxhighlight> ...and replace "Reason" with a sentence explaining why.
-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.
+=== Spoilers ===
-=== Navigation Boxes ===
+<syntaxhighlight>{{Spoilers}}</syntaxhighlight>
-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.
+The template above is used for pages that have content that may spoil major plot points in their related campaign. This may be used for deaths, identity reveals, and much more if applicable. You may also be liberal with usage of this template. This also does not need to be listed at the top of the page and can be moved downwards.
-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.
+=== Delete ===
-=== Message Templates ===
+<syntaxhighlight>{{Delete}}</syntaxhighlight>
-Message templates inform users regarding information contained on a page. These are the templates like the [[Template:Stub|Stub]] or [[Template:Spoilers|Spoilers]] template.
+The template above is used for pages that are unnecessary or have been made on accident. This is to make sure the people with permissions to delete the page can see it and can be useful for allowing discussion before it's deleted.
-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.
-=== 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 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 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.
+When adding categories, you may use the "Advanced Options" tool in the visual editor or simply place something like [[[[:Category:Category Name]]]] at the bottom of the page. It does not matter what order tags are added, as they're sorted alphabetically thanks to one of this wiki's extensions.
 === Character Pages ===
 Characters should be tagged with:
@@ Line 50: / Line 54: @@
 * [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.
+For in-depth information on how to format pages, please see [[Manual of Style/Page Formatting|this page]].
-=== 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 ====
-For now, all I have to say about these pages is that they use [[Template:NPCInfobox]], but in this specific way:
-<syntaxhighlight>
-{{NPC
-|campaign=Spireloft
-|image=[File:Placeholder.png]
-|created by=CStatic
-|othernames=
-|first appearance=
-|age=
-|species=
-|nationality=
-|occupation=
-}}
-</syntaxhighlight>
-Any unavailable information will be automatically omitted from the infobox, so don't worry about that. But please do not add more data than this, because I do not want their latest appearance to be listed so high on their page. Age ranges are also preferred over specific ages.
-==== 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__

NBITTRPG Wiki:Manual of Style: Difference between revisions

Help

Revision as of 11:33, 19 February 2025

Contents

External Resources

Writing Style

Citations

Templates

Stub

Spoilers

Delete

Categories

Character Pages

Locations

Sessions

Page Formatting

Recent changes