Meta:Writing Conventions - Revision history

Theadamabrams: removed "Categories" section

2023-12-15T08:07:49Z

removed "Categories" section

← Older revision		Revision as of 04:07, 15 December 2023
Line 32:		Line 32:
	As mentioned [[Meta:Writing Conventions#Capitalization\|above]], article titles (and section headers) should not capitalize the second word and later words unless they are proper nouns (including all puzzle names) or acronyms. Note that MediaWiki always displays the first letter of the title on an article's page as a capital. Thus, although "pressure plate" is the correct format to use in a paragraph or a link, the [[Pressure plate\|article itself]] shows "Pressure plate" at the very top.		As mentioned [[Meta:Writing Conventions#Capitalization\|above]], article titles (and section headers) should not capitalize the second word and later words unless they are proper nouns (including all puzzle names) or acronyms. Note that MediaWiki always displays the first letter of the title on an article's page as a capital. Thus, although "pressure plate" is the correct format to use in a paragraph or a link, the [[Pressure plate\|article itself]] shows "Pressure plate" at the very top.

	~~== Categories ==~~
	~~In general, pages should list any super-categories that their categories belong to. Example:~~

	~~<blockquote>The [[1k (1000)]] article uses <pre>[[Category:New Human]]~~
	~~[[Category: TTP2 Characters]]~~
	~~[[Category: Characters]]~~
	~~[[Category: TTP2]]</pre></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.~~
	== Templates ==		== Templates ==

Theadamabrams: Added sections on capitalization

2023-12-09T11:58:04Z

Added sections on capitalization

← Older revision		Revision as of 07:58, 9 December 2023
Line 3:		Line 3:
	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.

			== Capitalization ==
			Following Wikipedia's style, this wiki strives to avoid unnecessary capitalization. In particular, article titles and section headers should use lowercase for words after the first word, unless there are proper nouns or acronyms. Puzzle elements should be written in lower case (again with exception for acronyms) in a paragraph, for example:<blockquote>
			The first room of this puzzle contains a red [[emitter]], an [[RGB converter]], and a [[pressure plate]] that controls access to a second room.</blockquote>
			The names of all puzzles are considered proper nouns and are thus written in title case ("Title Case"). Category names are sometimes written in title case. Certain phrases, such as "the Simulation" and "the Founder" are capitalized to match the formatting of the game. Also to match the game's format, the playable character of the sequel is "1k" with a lowercase k.

	== Screenshots ==		== Screenshots ==
Line 24:		Line 28:
	=== Collectibles ===		=== Collectibles ===
	Although every terminal document and puzzle has its own article, the [[Lost Lab\|lost labs]] and [[Star (TTP2)\|star monuments]] are described on their respective [[:Category:TTP2 Areas\|area pages]] and should ''not'' have their own articles.		Although every terminal document and puzzle has its own article, the [[Lost Lab\|lost labs]] and [[Star (TTP2)\|star monuments]] are described on their respective [[:Category:TTP2 Areas\|area pages]] and should ''not'' have their own articles.

			=== Capitalization ===
			As mentioned [[Meta:Writing Conventions#Capitalization\|above]], article titles (and section headers) should not capitalize the second word and later words unless they are proper nouns (including all puzzle names) or acronyms. Note that MediaWiki always displays the first letter of the title on an article's page as a capital. Thus, although "pressure plate" is the correct format to use in a paragraph or a link, the [[Pressure plate\|article itself]] shows "Pressure plate" at the very top.

	== Categories ==		== Categories ==
Line 34:		Line 41:

	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.		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.


	== Templates ==		== Templates ==

	There are ~~many~~ [[Special:PrefixIndex/Template:\|helpful templates]] you can use on this site.		There are [[Special:PrefixIndex/Template:\|many helpful templates]] you can use on this site.

	=== Hex Strings ===		=== Hex Strings ===

Alf: Typos

2023-12-01T13:13:15Z

Typos

← Older revision		Revision as of 09:13, 1 December 2023
Line 60:		Line 60:
	Example 2:		Example 2:
	<blockquote><pre>{{ProgressiveHint		<blockquote><pre>{{ProgressiveHint
	\| topic = If you ~~are~~ cannot find an item to place on the pressure plate		\| topic = If you cannot find an item to place on the pressure plate
	\| hint = The fan is ~~detachable~~.		\| hint = The fan is dettachable.
	}}</pre>		}}</pre>
	produces		produces

	{{ProgressiveHint		{{ProgressiveHint
	\| topic = If you ~~are~~ cannot find an item to place on the pressure plate		\| topic = If you cannot find an item to place on the pressure plate
	\| hint = The fan is ~~detachable~~.		\| hint = The fan is dettachable.
	}}</blockquote>		}}</blockquote>

Alf: See last edit

2023-12-01T13:12:51Z

See last edit

← Older revision		Revision as of 09:12, 1 December 2023
Line 66:		Line 66:

	{{ProgressiveHint		{{ProgressiveHint
	\| topic = If you are cannot find an item to place on the pressure plate:		\| topic = If you are cannot find an item to place on the pressure plate
	\| hint = The fan is detachable.		\| hint = The fan is detachable.
	}}</blockquote>		}}</blockquote>

Alf: /* Templates */ Remove extra colon from the progressive hint example

2023-12-01T13:12:26Z

Templates: Remove extra colon from the progressive hint example

← Older revision		Revision as of 09:12, 1 December 2023
Line 60:		Line 60:
	Example 2:		Example 2:
	<blockquote><pre>{{ProgressiveHint		<blockquote><pre>{{ProgressiveHint
	\| topic = If you are cannot find an item to place on the pressure plate:		\| topic = If you are cannot find an item to place on the pressure plate
	\| hint = The fan is detachable.		\| hint = The fan is detachable.
	}}</pre>		}}</pre>

Theadamabrams: Many changes

2023-11-25T15:32:54Z

Many changes

← Older revision		Revision as of 11:32, 25 November 2023
Line 3:		Line 3:
	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>~~		== 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.

			== Links ==

			General practice on wiki sites is to only use a link for the first occurrence of a term in a paragraph or article. For example, the second use of "New Jerusalem" towards the end this paragraph is ''not'' a link:

	There is ~~also an automatically-generated~~ [[~~:Category:Pages_with_untranslated_hex_strings~~\|~~list of pages with untranslated hex strings~~]].		<blockquote>The softness of [[New Jerusalem]] becomes more and more pronounced. There is a kind of madness in what we are doing, going to a place that is so hostile to our existence. That does not mean there is nothing to love here. There is in fact a great beauty, but it is a hateful beauty, a beauty you can only love because there are places that are not like this. And yet it is precisely this hateful beauty that the people of New Jerusalem fail to see, and so cannot understand their own blessings.</blockquote>

			However, in puzzles it may be helpful to provide link to elements like [[connector\|connector]]s and [[fan\|fan]]s multiple times throughout the article. You can use your best judgement for this.

	== Article titles ==		== 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>

			In general, article titles should not use dashes and 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. Example: [[Byron (7)\|Byron (7)]].

	== ~~Screenshots~~ ==		=== Underscores ===
	~~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~~.		Because [[mediawikiwiki:Manual:PAGENAMEE_encoding\|MediaWiki URLs use underscores for spaces]], spaces and underscores are conflated. For pages with underscored titles, remember to add, for example, <code><nowiki>{{DISPLAYTITLE:Article_title}}</nowiki></code> to the source code when creating ''Article title''. (For terminal documents this is done automatically by using the template [[#Terminal Documents\|described below]]).

			=== Collectibles ===
			Although every terminal document and puzzle has its own article, the [[Lost Lab\|lost labs]] and [[Star (TTP2)\|star monuments]] are described on their respective [[:Category:TTP2 Areas\|area pages]] and should ''not'' have their own articles.

	== ~~Terminal Documents and Audio Logs~~ ==		== Categories ==
	~~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.~~		In general, pages should list any super-categories that their categories belong to. Example:

	~~Text files should use~~ [[:Category:~~TTP1 Documents~~]] or [[:Category:TTP2 ~~Documents~~]].		<blockquote>The [[1k (1000)]] article uses <pre>[[Category:New Human]]
			[[Category: TTP2 Characters]]
			[[Category: Characters]]
			[[Category: TTP2]]</pre></blockquote>

	~~<blockquote>Example: [[Baby_Steps]] begins with <code><nowiki>{{DISPLAYTITLE:Baby_Steps}}</nowiki></code>~~ and ~~ends with <code><nowiki>[[Category:TTP2 Documents]] [[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.

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

	* Lost Labs		== Templates ==
	* Star Monuments
	* Ancient Human Artifacts

	are ~~described on their respective~~ [[:~~Category~~:~~TTP2 Areas~~\|~~area pages~~]] ~~and should ''not'' have their own articles~~.		There are many [[Special:PrefixIndex/Template:\|helpful templates]] you can use on this site.

	~~Pages such as~~ [[~~Star (TTP2)\|Star~~]] ~~and [[Ancient Human Artifact]] will include links to the relevant sections of~~ the ~~area pages~~.		=== Hex Strings ===
			The games often contain strings of hexadecimal characters. Please use [[Template:HexString]] for all such strings, omitting the second argument if a translation is not known. Example:

			<blockquote><code><nowiki>{{HexString\|00}}</nowiki></code> becomes {{HexString\|00}} (no translation).<br><code><nowiki>{{HexString\|48656c6c6f\|Hello}}</nowiki></code> becomes {{HexString\|48656c6c6f\|Hello}} (translation available as tooltip).</blockquote>

	~~== Categories ==~~		There is also an automatically-generated [[:Category:Pages_with_untranslated_hex_strings\|list of pages with untranslated hex strings]].
	~~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>~~		=== Terminal Documents ===

	~~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~~.		Every entry for a terminal document from the second game should start with [[Template:TTP2Document]] at the very top of the page (the Visual Editor can help you enter the expected information correctly). This will create the infobox ''and'' the header (in-universe document title) as well as add the page to the proper categories.

	== Spoilers ==		=== Spoilers and hints ===
	For content that involves ~~spoilers,~~ hints or ~~locations,~~ that you would like to be initially hidden, use ~~the~~ [[Template:Spoiler~~\|Spoiler template~~]].		For content that involves puzzle hints or other potential spoilers that you would like to be initially hidden, use [[Template:Spoiler]] or [[Template:ProgressiveHint]].

	Example:		Example 1:
	<blockquote><pre>{{Spoiler\|Santa lives in the North Pole\|secret location}}</pre>		<blockquote><pre>{{Spoiler\|Santa lives in the North Pole\|secret location}}</pre> produces
	{{Spoiler\|Santa lives in the North Pole\|secret location}}</blockquote>		{{Spoiler\|Santa lives in the North Pole\|secret location}}</blockquote>

			Example 2:
			<blockquote><pre>{{ProgressiveHint
			\| topic = If you are cannot find an item to place on the pressure plate:
			\| hint = The fan is detachable.
			}}</pre>
			produces

			{{ProgressiveHint
			\| topic = If you are cannot find an item to place on the pressure plate:
			\| hint = The fan is detachable.
			}}</blockquote>

Alf at 19:42, 19 November 2023

2023-11-19T19:42:22Z

← Older revision		Revision as of 15:42, 19 November 2023
Line 44:		Line 44:
	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.		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.

	Spoilers		== Spoilers ==

	For content that involves spoilers, hints or locations, that you would like to be initially hidden, use the [[Template:Spoiler\|Spoiler template]].		For content that involves spoilers, hints or locations, that you would like to be initially hidden, use the [[Template:Spoiler\|Spoiler template]].

	Example:		Example:
	<blockquote><pre>{{Spoiler\|Santa lives in the North Pole\|secret location}}</pre>		<blockquote><pre>{{Spoiler\|Santa lives in the North Pole\|secret location}}</pre>
	{{Spoiler\|Santa lives in the North Pole\|secret location}}		{{Spoiler\|Santa lives in the North Pole\|secret location}}</blockquote>
	</blockquote>

Alf at 19:41, 19 November 2023

2023-11-19T19:41:49Z

← Older revision		Revision as of 15:41, 19 November 2023
Line 43:		Line 43:

	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.		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.

			Spoilers

			For content that involves spoilers, hints or locations, that you would like to be initially hidden, use the [[Template:Spoiler\|Spoiler template]].

			Example:
			<blockquote><pre>{{Spoiler\|Santa lives in the North Pole\|secret location}}</pre>
			{{Spoiler\|Santa lives in the North Pole\|secret location}}
			</blockquote>

Theadamabrams: changed example from Trevor_01 (no longer used!) to Baby_Steps

2023-11-19T07:52:34Z

changed example from Trevor_01 (no longer used!) to Baby_Steps

← Older revision		Revision as of 03:52, 19 November 2023
Line 23:		Line 23:
	Text files should use [[:Category:TTP1 Documents]] or [[:Category:TTP2 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 Documents]] [[Category:TTP2]]</nowiki></code>.</blockquote>		<blockquote>Example: [[Baby_Steps]] begins with <code><nowiki>{{DISPLAYTITLE:Baby_Steps}}</nowiki></code> and ends with <code><nowiki>[[Category:TTP2 Documents]] [[Category:TTP2]]</nowiki></code>.</blockquote>


	== Collectibles ==		== Collectibles ==

Theadamabrams: added link to list of pages with untranslated hex strings

2023-11-19T07:51:11Z

added link to list of pages with untranslated hex strings

← Older revision		Revision as of 03:51, 19 November 2023
Line 8:		Line 8:
	<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>		<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>

			There is also an automatically-generated [[:Category:Pages_with_untranslated_hex_strings\|list of pages with untranslated hex strings]].

	== Article titles ==		== Article titles ==