Template:TTP2Document: Difference between revisions

From The Talos Principle Wiki
automatic DISPLAYTITLE and Category
Now writes one-sentence intro and "Contents" header!
Line 1: Line 1:
{{#if: {{{file|}}} | {{DISPLAYTITLE:{{{file}}}}} }}{| class="infobox"
{{#if:{{{file|}}}|{{DISPLAYTITLE:{{{file}}}}}}}
! style="align:center; background-color: #DFBA78; color: black;" colspan=2| {{{file|{{BASEPAGENAME}}}}}
'''{{{file|{{BASEPAGENAME}}}}}''' is a {{#if:{{{multimedia|}}}|multimedia|text}} document{{#ifeq: {{{force_display_author|}}}|true| by {{{author}}}}}{{#if:{{{loc|}}}| stored in the {{{loc}}} terminal}}.
|-
== Contents ==
| Author:
=== {{{title|}}} ===<noinclude>
| style="text-align:right;" | {{{author|''Unknown''}}}
|-
| Location<span></span>:
| style="text-align:right;" | {{{loc|''Unknown''}}}
|}[[Category:TTP2 Documents]]
{{#if: {{{title|}}} |<big>'''{{{title|}}}'''</big><br>}}
<noinclude>
 
This is a infobox template for a Document.
== Usage ==
<pre>{{TTP2Document
|file = L1C_Niamh
|title = Niamh
|author = Unknown
|loc = [[LOS]]
}}</pre>
 
will show up as the ''box and header'' below:
<div style="width: 300px">
{{TTP2Document
|file = L1C_Niamh
|title = Niamh
|author = Unknown
|loc = [[LOS]]
}}
(document text would appear here)
</div>
<templatedata>
<templatedata>
{
{
Line 73: Line 46:
"type": "string",
"type": "string",
"required": true
"required": true
},
"multimedia": {
"label": "Multimedia?",
"description": "Type \"true\" without quotes if the document includes an image or video or audio.",
"suggestedvalues": [
"false",
"true"
]
},
"force_display_author": {
"label": "Force display of author name?",
"description": "Type \"true\" without quotes *only if* the author's name is not clear from the contents of the document.",
"suggestedvalues": [
"false",
"true"
]
}
}
},
},
"description": "Use this at the 'very top' of every in-universe (terminal) document. It will create the Infobox, format the document's header, and add this page to Category:TTP2 Documents.",
"description": "Use this at the *very top* of every in-universe (terminal) document. It will create the one-sentence intro, the Contents header, and the document title. It will also add this page to Category:TTP2 Documents.",
"paramOrder": [
"paramOrder": [
"file",
"file",
"title",
"title",
"author",
"author",
"loc"
"loc",
"multimedia",
"force_display_author"
],
],
"format": "block"
"format": "block"
}
}
</templatedata></noinclude>
</templatedata></noinclude>

Revision as of 07:36, 16 December 2023

TTP2Document is a text document.

Contents

Use this at the *very top* of every in-universe (terminal) document. It will create the one-sentence intro, the Contents header, and the document title. It will also add this page to Category:TTP2 Documents.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
File Namefile

The in-universe file name, shown on a terminal before selecting the file. This often (but not always) includes underscores.

Example
4.2_kiloyear_event
Stringrequired
Titletitle

The in-universe title, written at the top of a document. Sometimes this is the same as the file name, but sometimes it is not.

Example
The 4.2 Kiloyear Aridification Event
Stringrequired
Authorauthor

The in-universe author of the document. You can make this a link using brackets (example: [[Byron]]). If this field is omitted, "Unknown" will be used.

Unknownsuggested
Locationloc

The area in which this file can be found. If the specific terminal is known (e.g., [[VALA_EXT-1]]), use that. Otherwise use the prefix for the terminals in that area (e.g., [[VALA]]). The brackets will make this a link.

Suggested values
[[HAR]] [[VALA]] [[LOS]] [[GRODNA]] [[THIRIEL]] [[THARMAS]] [[ENITHARMON]] [[UTHA]] [[FUZON]] [[ULRO]] [[RINTRAH]] [[BEULAH]] [[AHANIA]]
Example
VALA_EXT-1
Stringsuggested
Multimedia?multimedia

Type "true" without quotes if the document includes an image or video or audio.

Suggested values
false true
Unknownoptional
Force display of author name?force_display_author

Type "true" without quotes *only if* the author's name is not clear from the contents of the document.

Suggested values
false true
Unknownoptional