User:Embri/sandbox: Difference between revisions

From GT New Horizons
Content added Content deleted
m (→‎Writing & Tone: numbers.)
(general policies)
Line 1: Line 1:
==General Rules==
This guide outlines the formatting and style guidelines for the GT New Horizons Wiki, to ensure quality, compatibility and consistency across all articles.
This page outlines the formatting and style guidelines for the GT New Horizons Wiki, to ensure quality, compatibility and consistency across all articles. General Wiki good practices apply; use common sense, don't copy things without permission, honor the [https://meta.miraheze.org/wiki/Miraheze_Spaces_Code_of_Conduct Miraheze Code of Conduct], edit in good faith and follow the [[#Page Layout|Page Layout]] guidelines.


==Scope==
==Scope==
The scope of the average article on this wiki is broader than most other minecraft wikis. The GTNH wiki does not seek to document every block, item or feature in its many mods, but to serve as a repository for guides, mechanics and information relevant to the modpack. Exceptions are made for mods that are poorly documented, said documentation is in danger of disappearing, or where there are significant differences between the GTNH fork and standard version of the mod beyond crafting recipes. Content exclusive to GTNH is desirable to document in detail.
The scope of the average article on this wiki is broader than most other Minecraft wikis. The GTNH wiki does not seek to document every block, item or feature in its many mods, but to serve as a repository for guides, mechanics and information relevant to the modpack. Exceptions are made for mods that are poorly documented, said documentation is in danger of disappearing, or where there are significant differences between the GTNH fork and standard version of the mod beyond crafting recipes. Content exclusive to GTNH is desirable to document in detail.


Recipes as a general rule are not necessary unless they are difficult to find, unusual, incorrect in NEI, or are multi-block build instructions.
Recipes as a general rule are not necessary unless they are difficult to find, unusual, incorrect in NEI, or are multi-block build instructions.
Line 62: Line 63:
All pages should be placed in at least one [[:Special:Categories]].
All pages should be placed in at least one [[:Special:Categories]].


Tables should use the [[:Template:STDT]] whenever possible.
Tables should use the [[:Template:STDT]] template whenever possible.



If the scope of the article is covered by another wiki, github or other external documenation, add references to an "External Links" section at the bottom of the page.


[[Category:Guides]]
[[Category:Guides]]

Revision as of 01:50, 25 May 2023

General Rules

This page outlines the formatting and style guidelines for the GT New Horizons Wiki, to ensure quality, compatibility and consistency across all articles. General Wiki good practices apply; use common sense, don't copy things without permission, honor the Miraheze Code of Conduct, edit in good faith and follow the Page Layout guidelines.

Scope

The scope of the average article on this wiki is broader than most other Minecraft wikis. The GTNH wiki does not seek to document every block, item or feature in its many mods, but to serve as a repository for guides, mechanics and information relevant to the modpack. Exceptions are made for mods that are poorly documented, said documentation is in danger of disappearing, or where there are significant differences between the GTNH fork and standard version of the mod beyond crafting recipes. Content exclusive to GTNH is desirable to document in detail.

Recipes as a general rule are not necessary unless they are difficult to find, unusual, incorrect in NEI, or are multi-block build instructions.

Writing & Tone

  • Formal language is preferred, especially for non-guide articles.
    • Use of "I" and "you" are discouraged. Use "the player", direct statements, or singular they.
    • Proper grammar, spelling, and punctuation are required.
  • Information should be accurate.
    • Contributors are expected to either test or have personal experience with the content they are contributing.
    • Precision and clarity should be used when describing mechanics or attributes. Avoid vague statements.
  • American English shall be used as the standard.
    • Numbers are formatted with commas (1,000) for thousands separators and periods (1.55) for decimals.
    • Small/simple numbers should be written out (one, twenty) rather than numerals (1, 20) in text. Pack and mod version numbers should always use numerals (2.2.8, not two point two point eight).
      • There are three variants of the... (yes)
      • There are 3 variants of the... (no)
    • Where in-game item names/metadata differ from American English, use the in-game spelling / capitalization.
    • Aluminium is used over Aluminum, unless it's an in-game item name.
  • Abbreviations should be used sparingly
    • Preferably only in reference to the page's main scope
    • Introduced after their full meaning; The Electric Blast Furnace (EBF) is a multi-block...

Page Names & Links

  • Page names (namespaces) should be singular, unless the namespace is an item that's pluralized in-game.
  • Page names should be kept concise where possible, but accurately describe their scope without being ambiguous.

Examples: Crafting Stuff (vague), Automating a Forestry Worktable in LV with pipes (too long), Worktable Automation (better)

  • All words should be capitalized except for connecting words like and, of, for, etc.
    • Section headers should be similarly capitalized to Page Names.
  • Item names in articles should be capitalized. i.e. Item Conduit, not item conduit.
    • Partial item names used as groups should also be capitalized. i.e. Assemblers or Drones/Princesses.
  • Pages should be interlinked with [[Page Name]] links whenever possible.
    • Long pages should use anchors [[#Section|text]] to reference other sections of the same page.

Images

  • Images should use default textures/fonts at all times.
    • Exception: For illustration of a texture pack or other resource where necessary.
  • The first image on a page should be right aligned. Further images can either be right aligned or alternate, depending on what looks best.
  • Large quantities of images (3+ for a section) should be presented as a <gallery>.
  • Images should be clear and relevant
    • Include at least one image for every page when possible
    • Crop images to focus on the important area
    • Don't include unnecessary parts of the GUI / user interface / background
    • Resize or scale large images down if they are too large
    • If an image is complex or unclear at a glance, annotate it or use arrows/outlines to draw attention. (Example: File:NEI_Interface.png)

Video

  • Linked videos should be focused on the scope of the article.
  • If a video is covering a non-GTNH pack version of the scope, any differences in functionality should be clearly noted.
    • Exception: Crafting recipes. This can be noted but players should assume GTNH uses custom recipes for everything.

Page Layout

Section Headers should be used to separate longer pages into relevant subtopics. Related subtopics should use progressively smaller Headings (Level 2 -> Level 3 -> Level 4 -> Level 5). Not all levels of headings need to be used or are even desirable on a given article.

All pages should be placed in at least one Special:Categories.

Tables should use the Template:STDT template whenever possible.

If the scope of the article is covered by another wiki, github or other external documenation, add references to an "External Links" section at the bottom of the page.