Meta:Writing Conventions: Difference between revisions

From The Talos Principle Wiki
m updated categories
Hex Strings
Line 2: Line 2:


The [https://discord.gg/UrRgWXjuSt #writing-conventions channel on Discord] is used to discuss existing and new conventions before they are added here.
The [https://discord.gg/UrRgWXjuSt #writing-conventions channel on Discord] is used to discuss existing and new conventions before they are added here.
== Hex Strings ==
The games often contain strings of hexadecimal characters. Please use <code><nowiki>{{HexString|hex|plain}}</nowiki></code> for all such strings, omitting the second argument if a translation is not known.
<blockquote>Example: <code><nowiki>{{HexString|00}}</nowiki></code> becomes {{HexString|00}} (no translation).<br/>Example: <code><nowiki>{{HexString|48656c6c6f|Hello}}</nowiki></code> becomes {{HexString|48656c6c6f|Hello}} (translation available as tooltip).</blockquote>


== Article titles ==
== Article titles ==
Line 14: Line 20:
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.
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.


Text files should use [[:Category:TTP1 Terminal Documents]] or [[:Category:TTP2 Terminal Documents]].
Text files should use [[:Category:TTP1 Documents]] or [[:Category:TTP2 Documents]].


<blockquote>Example: [[Trevor_01]] begins with <code><nowiki>{{DISPLAYTITLE:Trevor_01}}</nowiki></code> and ends with <code><nowiki>[[Category:TTP2 Terminal Documents]] [[Category:TTP2]]</nowiki></code>.</blockquote>
<blockquote>Example: [[Trevor_01]] begins with <code><nowiki>{{DISPLAYTITLE:Trevor_01}}</nowiki></code> and ends with <code><nowiki>[[Category:TTP2 Documents]] [[Category:TTP2]]</nowiki></code>.</blockquote>




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


* Lost Labs
* Lost Labs
Line 26: Line 32:
* Ancient Human Artifacts
* Ancient Human Artifacts


are described on their respective [[:Category:TTP2 Areas|area pages]] and should 'not' have their own articles.
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.
Pages such as [[Star (TTP2)|Star]] and [[Ancient Human Artifact]] will include links to the relevant sections of the area pages.

Revision as of 13:58, 17 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.

Hex Strings

The games often contain strings of hexadecimal characters. Please use {{HexString|hex|plain}} for all such strings, omitting the second argument if a translation is not known.

Example: {{HexString|00}} becomes 00 (no translation).
Example: {{HexString|48656c6c6f|Hello}} becomes 48656c6c6f (translation available as tooltip).


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 and Audio Logs

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.

Text files should use Category:TTP1 Documents or Category:TTP2 Documents.

Example: Trevor_01 begins with {{DISPLAYTITLE:Trevor_01}} and ends with [[Category:TTP2 Documents]] [[Category:TTP2]].


Collectibles

Every terminal document 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.


Categories

In general, pages should list any super-categories that their categories belong to.

Example: 1k (1000) lists [[Category:New Human]] [[Category:TTP2 Characters]] [[Category:Characters]] [[Category:TTP2]].

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.