Meta:Writing Conventions: Difference between revisions

Revision as of 18:06, 16 November 2023

Below are writing conventions that should be consistent throughout the wiki.

The #writing-conventions channel on Discord is used to discuss existing and new conventions before they are added here.

Article titles

In general, article titles should not use parentheses unless required for disambiguation. One significant exception to this is the articles for New Humans, which should be formatted as Name (Number) when the serial number is known.

Example: Byron (7)

Screenshots

Use Photomode to remove HUD elements and Ultra settings. Use 4k resolution (3840 × 2160) if your display supports it. Otherwise use the highest 16:9 aspec ratio you can use. Convert PNG screenshots to JPEG before uploading.

Terminal Documents

Many of the terminals and their entries use underscores. Because MediaWiki URLs use underscores for spaces, spaces and underscores are conflated to spaces in titles. To remedy this remember to add {{DISPLAYTITLE:Article_title}} when creating Article title if there should be an underscore.

The articles for these documents should use the [[Category:TTP1 Terminal Documents]] or [[Category:TTP1 Terminal Documents]] category.

Example: Trevor_01 begins with {{DISPLAYTITLE:Trevor_01}}.

Collectibles

Every terminal document, audio log, and puzzle has its own article. However,

Lost Labs
Star Monuments
Ancient Human Artifacts

are described on their respective area pages and should 'not' have their own articles.

Pages such as Star and Ancient Human Artifact will include links to the relevant sections of the area pages.

@@ Line 4: / Line 4: @@
 == Article titles ==
+In general, article titles should not use parentheses unless required for disambiguation. One significant exception to this is the articles for New Humans, which should be formatted as <code>Name (Number)</code> when the serial number is known. <blockquote>Example: [[Byron (7)|Byron (7)]]</blockquote>
-=== Areas ===
-The title for area articles should use the following template.<blockquote>Zone Name – Zone Code</blockquote>Note: This is an [[wikipedia:Dash#En_dash|En da sh]], not a [[wikipedia:Hyphen-minus|hypen-minus]].
-Example: [[Grasslands Ring – East 1]]
+== Screenshots ==
+Use Photomode to remove HUD elements and Ultra settings. Use 4k resolution (3840 × 2160) if your display supports it. Otherwise use the highest 16:9 aspec ratio you can use. Convert PNG screenshots to JPEG before uploading.
+== Terminal Documents ==
+Many of the terminals and their entries use underscores. Because [[mediawikiwiki:Manual:PAGENAMEE_encoding|MediaWiki URLs use underscores for spaces, spaces and underscores are conflated]] to spaces in titles. To remedy this remember to add <code><nowiki>{{DISPLAYTITLE:Article_title}}</nowiki></code> when creating ''Article title'' if there should be an underscore.
+The articles for these documents should use the <code><nowiki>[[Category:TTP1 Terminal Documents]]</nowiki></code> or <code><nowiki>[[Category:TTP1 Terminal Documents]]</nowiki></code> category.
+<blockquote>Example: [[Trevor_01]] begins with <code><nowiki>{{DISPLAYTITLE:Trevor_01}}</nowiki></code>.</blockquote>
-=== Puzzles ===
+== Collectibles ==
-The title for puzzle articles should use the following template.<blockquote>Puzzle Name (Zone Code - Puzzle number)</blockquote>Example: [[RGB Shifting (East 1 - 1)]]
+Every terminal document, audio log, and puzzle has its own article. However,
-=== Terminal Entries ===
+* Lost Labs
-Many of the terminals and their entries use underscores. Because [[mediawikiwiki:Manual:PAGENAMEE_encoding|MediaWiki URLs use underscores for spaces, spaces and underscores are conflated]] to spaces in titles. To remedy this remember to add <code><nowiki>{{DISPLAYTITLE:Article_title}}</nowiki></code> when creating ''Article title'' if there should be an underscore. Links to articles with underscores need to be manually adjusted, too.
+* Star Monuments
+* Ancient Human Artifacts
-Example: [[Trevor_01 (East 1 - VALA_EXT-1)]]
+are described on their respective [[:Category:TTP2 Areas|area pages]] and should 'not' have their own articles.
+Pages such as [[Star (TTP2)|Star]] and [[Ancient Human Artifact]] will include links to the relevant sections of the area pages.
-== Screenshots ==
-Use Photomode to remove HUD elements and Ultra settings. Use 4k resolution (3840 × 2160) if your display supports it. Otherwise use the highest 16:9 aspec ratio you can use. Convert PNG screenshots to JPEG before uploading.
 == Categories ==
+In general, pages should list any super-categories that their categories belong to.
+<blockquote>Example: [[1k (1000)]] lists <code><nowiki>[[Category:New Human]] [[Category:TTP2 Characters]] [[Category:Characters]] [[Category:TTP2]]</nowiki></code>.</blockquote>
+There is no super-category for Terminal Documents because there is no desire to see a list of documents from both TTP1 and TTP2 together.