User:Embri/sandbox

From GT New Horizons
< User:Embri
Revision as of 03:07, 4 June 2023 by Embri (talk | contribs) (→‎Writing & Tone: more number cases.)

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. If you need help, visit the GT:NH Discord and drop a note in the #wiki-dev channel.

General good practices apply:

  1. Use common sense
  2. Edit in good faith
  3. Don't copy things without permission
  4. Honor the Miraheze Code of Conduct

Scope

The scope of the average article on this wiki is broader than most other Minecraft wikis. The GregTech: New Horizons (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. Numbers expressing an area in (#x#) format, Pack and Mod versions should always use numerals (2.2.8, not two point two point eight).
      • The farm covers a 9x9 area... (yes)
      • There are three variants of the... (yes)
      • There are 3 variants of the... (no)
      • 2.3.0 is the most recent stable... (yes)
    • 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...
    • Exception: Acronyms that are primarily used over their full forms or used in-game.
      • GT:NH / GTNH (GregTech: New Horizons)
      • NEI (Not Enough Items)
      • MC (Minecraft)
      • SP & MP (Single Player, Multiplayer)
      • A & EU (Amps, Energy Units)
      • Tiers; LV, MV, HV, etc.
    • Non-Minecraft related abbreviations are to be avoided.
      • Examples: Do not use BTW, YSK, IIRC, etc.

Page Layout

Starting a Page

Before starting a new article, check and see if one already exists on the wiki. Try a few related search terms to get a feel for what pages are present or might be good candidates to link to the new topic. If unsure about what to write, picking something off the Wiki TODO list is a good place to start.

Pages should start with a lead paragraph - a few sentences describing the scope of the page and giving an overview of its content. A relevant image is also strongly encouraged to help orient readers. Contributors should avoid making lots of pages that are only stubs or placeholders. In-progress pages can be flagged with the {{WIP}} template. The bulk of the article should be broken into one or more sections, each with a section header, and conclude with External Links, See Also or References, if relevant.

Page Names

If the page name is an in-game item, always write it exactly as it appears in-game. This overrides any other rule.

Page names (namespaces) should:

  • Be singular
    • Example: Item Conduit, not Item Conduits
  • 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)
  • Never begin with A, An, or The, nor end with punctuation
  • Have all words capitalized except for syncategorematic connecting words like a, and, of, for, to, etc.
  • If multiple articles could occupy the page name, a {{disambig}} template should be used, and pages differentiated with suffixes of their mod or type.
    • Example: Wrench (GregTech) and Wrench (BuildCraft). Too specific a scope for this wiki, but illustrates the point.

Section Headers

Articles should be broken up into sections unless they are very short (1-2 paragraphs)

  • Section headers should be capitalized similar to page names
  • Item names in articles should be capitalized. (Item Conduit, not item conduit)
    • Partial item names used as groups should also be capitalized. i.e. Assemblers or Drones/Princesses

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.

  • Images are encouraged where relevant to the section

Links

  • Pages should be interlinked with appropriate [[Page Name]] links whenever possible. Double brackets around any word(s) will link to the page of that name.
  • 's' or 'es' can be added to the end without changing the linking behavior.
    • Example: [[Horse]] and [[Horse]]s both go to the page 'Horse'.
  • To link to a page with different words, add a pipe | after the page name, inside the double brackets.
    • Example: [[Ore Generation|how to find ores]] links to the page Ore Generation with how to find ores. This can improve sentence flow, but direct page names are preferable whenever possible.
  • Even if a page doesn't exist, consider making a link anyways if the topic is likely to need its own article
    • Long pages should use anchors [[#Section|text]] to reference other sections of the same page
  • A redirect #REDIRECT [[Page_Name]] should be created if a page needs to be moved to a better namespace or has more than one likely link
  • After making a new article, do a search of the wiki to see if any other pages might reference it and insert links as appropriate

Tables & Lists

Tables should use the Template:STDT template whenever possible. This replaces class="wikitable". Table captions override the colour formatting of the STDT. Lists can be made with lines starting with # for a numbered list, or * for a bulleted list. Lists should be used for sequential steps or short groups where a table isn't necessary. If multiple pieces of information per line are being presented, a table is preferred. MediaWiki Table formatting options elaborates on wiki table syntax.

Examples:

  • Bulleted List
  • Used for point form
  • Items of equal importance
    • Can be nested by adding multiple asterisks (**, ***, etc.)
  1. This is a numbered list.
  2. If a list has sentences, use periods at the end.
  3. If a list is just nouns or point form, no periods.
  4. Entire articles should not be formatted as lists.
    1. Nested numbered lists can get confusing, not recommended.
Header Header Header
Example Example Example
Example Example Example
Example Example Example

Steps

For articles that list a set of discrete steps, one of two formats should be used. For short steps that can fit on 1-2 lines, use a numbered list. For paragraph style steps, use Heading 5 (==== Step 1 ====) and {{clear}} to ensure any tables or images do not wrap into the next step.

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.
  • Brief captions should be included for standard sized images.
    • Captions that are labels should omit punctuation; don't end with a period.
  • 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 or background. Use F1 mode.
    • 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)
    • Machine setups or systems should follow best practices; i.e. no pipe spaghetti, properly shuttered pipes, sufficient clearance left for access, good cable management, etc.
  • Large quantities of images (3+ for a section) should be presented as a <gallery>.

Example:

  • a square room with heavily patterned grey green walls with a ring of yellow circles mid-way up. A glowing question mark block floats in the center of the room with particle effects.

    Lootgames Dungeon

  • A one block wide tunnel through grass and dirt down to a lootgames dungeon.

    Generated tunnel

  • Four wooden chests between dungeon lantern blocks with yellow circles on them.

    Reward chests

  • a grid of dark blue tiles in a square room with heavily textured walls.

    Level 1 Minesweeper

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.

Templates

Templates are premade bits of formatting that can be dropped into pages to create complex elements with little effort. They are also used to automatically categorize and navigate pages. Some templates are static, others accept parameters, where text or other settings can be passed along to change what the template does.

Some useful templates:

  • {{stub}} Flags a page as a Stub, needing more information.
  • {{WIP}} Works in Progress, help welcome.
  • {{Navbar GTNH}} Template used to make a navigation box of related pages.
  • {{disambig}} For disambiguation of shared namespaces.
  • {{delete|explain why page should be deleted here.}} Flag low effort or irrelevant pages for removal.
  • {{box-round|title=The Title content=Type text here.}} Adds a rounded box with a title that spans the page.

Categories

All pages should be placed in at least one Category. Pages can be in more than one; apply all that are relevant. Place category tags at the bottom of the page. The most commonly used categories are Guides, Mods, and Mechanics. Almost any article should fit one of these three if nothing else.

Format: [[Category:CategoryName]]

  • Replace CategoryName with the appropriate word(s) for the desired category, just like a standard inter-article link.

Does it belong in Guides?

Does it belong in Mechanics?

  • Articles in Mechanics should answer the question "How does X work?" in detail.
  • Usually covers multiple mods and/or items, but might just be one like Quest Book.
  • They may be aggregate pages for more specific articles, such as Automated Farming.
  • Good choice for articles that don't have an associated item/block/mod, like GT Calculations.
  • Can be very technical, expect lots of tables, flow charts or math.
  • There are sub-categories for Prospecting and Useful Crops

Does it belong in Category:Mods or a specific Mod sub-category?

Specialty Categories:

External Links

If the scope of the article is covered by another wiki, github or other external documenation, add references to an "External Links", 'See Also" or "References" section at the bottom of the page with a main section header. Links should be presented as a bulleted list or numbered <ref> anchors. Use a short descriptive caption to tell the reader where the link goes. Single brackets [ ] are used for external links.

Examples:

Retrieved from "https://wiki.gtnewhorizons.com/wiki/User:Embri/sandbox?oldid=6676"