User:Embri/sandbox: Difference between revisions
m
→Categories: cleanup
m (→Writing & Tone: more number cases.) |
m (→Categories: cleanup) |
||
(8 intermediate revisions by the same user not shown) | |||
Line 5:
# Use common sense
# Edit in good faith
# Don't copy
# Honor the [https://meta.miraheze.org/wiki/Miraheze_Spaces_Code_of_Conduct Miraheze Code of Conduct] and [https://meta.miraheze.org/wiki/Copyright_Policy Copyright Policy]
==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, where said documentation is in danger of disappearing, or
Recipes as a general rule are not
==Writing & Tone==
* Formal language is
** Use of "I" and "you" are discouraged. Use "the player", direct statements, or singular they.
** Guides can use less formal language, including "you".
** Proper grammar, spelling, and punctuation are required.
Line 22 ⟶ 23:
** Precision and clarity should be used when describing mechanics or attributes. Avoid vague statements.
*American English shall be used as the standard
** Where in-game item names/metadata differ from American English, ''always'' use the in-game spelling / capitalization.▼
** Aluminium (with a second 'i') is used over Aluminum, unless it's an in-game item name that varies.▼
** Numbers are formatted with commas (1,000) for thousands separators and periods (1.55) for decimals.
** Small
** Tables should always use numerals.
*** The farm covers a 9x9 area... (yes)
*** There are three variants of the... (yes)
*** There are 3 variants of the... (no)
*** 2.
▲** 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)
*** WAILA (What Am I Looking At)
*** MC (Minecraft)
*** SP & MP (Single Player, Multiplayer)
Line 49 ⟶ 53:
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|scope]] of the page and giving an overview of its content. If it's an item or block, mention the mod of origin and its [[tier]]. 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 <nowiki>{{WIP}}</nowiki> 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===
Line 55 ⟶ 59:
Page names (namespaces) should:
* Be singular, unless the page scope covers multiples of something.
** Example: [[Item Conduit]], not Item Conduit''s''
** [[Commands and Configurations]] - pluralized, since this is an aggregate page and singular would not make sense.
* Be kept concise where possible, but accurately describe their scope without being ambiguous
** Examples: Crafting Stuff (vague), Automating a Forestry Worktable in LV with
* 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 [[:Template:Disambig|<nowiki>{{disambig}}</nowiki>]] template should be used, and pages differentiated with suffixes of their mod or type in parentheses ().
** Example:
===Section Headers===
Line 68 ⟶ 73:
* 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
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. Level 1 headings are never used, reserved for the main page header which is auto-generated.
* Images are encouraged where relevant to the section
** If many images are needed, use <nowiki><gallery></nowiki> [[#Images|format]].
===Links===
* Pages should be interlinked with appropriate <nowiki>[[Page Name]]</nowiki> 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: <nowiki>[[Horse]]</nowiki> and <nowiki>[[Horse]]s</nowiki> both would 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: <nowiki>[[Ore Generation|how to find ores]]</nowiki> links to the page [[Ore Generation]] with [[Ore Generation|how to find ores]]. This can improve sentence flow, but direct page names are preferable
* 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 <nowiki>[[#Section|text]]</nowiki> to reference other sections of the same page
Line 114 ⟶ 121:
===Images===
*Images should use default
**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.
Line 126 ⟶ 133:
** 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.
** Add <code>|alt=</code> descriptive text to images whenever possible. Briefly explain the image as if someone couldn't see it, including features and colors.
*Large quantities of images (3+ for a section) should be presented as a <nowiki><gallery></nowiki>.
** Gallery format can be controlled with the [https://www.mediawiki.org/wiki/Help:Images#mode_parameter mode parameter].
Line 153 ⟶ 161:
*<nowiki>{{delete|explain why page should be deleted here.}}</nowiki> Flag low effort or irrelevant pages for removal.
*<nowiki>{{box-round|title=The Title content=Type text here.}}</nowiki> Adds a rounded box with a title that spans the page.
*<nowiki>{{notice|image=|header=|text=}}</nowiki> Custom Infobox with configurable image, optional header.
===Categories===
All pages should be placed in at least one [[:Category:GT_new_horizons|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. Categories are follow the page name rules for capitalization and are almost always plural, as they are collections of multiple pages.
Format:
Line 162 ⟶ 171:
'''Does it belong in [[:Category:Guides|Guides]]?'''
* Guides almost always have a broader scope than a single
* Examples: [[Assembly Line Automation - AE2 Decoder]], [[Backups and Recovery]], and [[Bees]]
'''Does it belong in [[:Category:Mechanics|Mechanics]]?'''
*
* 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
'''Does it belong in Category:Mods or a specific Mod sub-category?'''
* If an article is about an ''entire'' mod, it goes in [[:Category:Mods]].
** [[Lootgames]], [[Storage Drawers]] and [[Adventure Backpacks]] are part of [[:Category:Mods]].
* If an article is about a ''part'' of a mod, it goes in that mod's category.
** [[Farming Station]] is part of [[:Category:Ender IO]]
Line 183 ⟶ 195:
'''Specialty Categories:'''
* Multiblocks [[:Category:
* Combat Focused [[:Category:Combat]]
* Modpack Development / Tools [[:Category:Dev]]
|