Template:TTP2Document: Difference between revisions
No edit summary |
no longer automatically adds article to Category:TTP2 Documents |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{ | {{#if:{{{file|}}}|{{DISPLAYTITLE:{{{file}}}}}}} | ||
'''{{{file|{{BASEPAGENAME}}}}}''' is a {{#if:{{{multimedia|}}}|multimedia|text}} document{{#ifeq:{{{force_display_author|}}}|true| by {{{author}}}}}{{#ifeq:{{{force_display_author|}}}|True| by {{{author}}}}}{{#if:{{{loc|}}}| stored in the {{{loc}}} terminal}}. | |||
| | == Contents == | ||
| | === {{{title|}}} === | ||
| | |||
| | |||
| | |||
| | |||
<noinclude> | <noinclude> | ||
<templatedata> | |||
This is | { | ||
"params": { | |||
"file": { | |||
"label": "File Name", | |||
"description": "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", | |||
"type": "string", | |||
} | "required": true | ||
}, | |||
"author": { | |||
"label": "Author", | |||
{{ | "description": "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.", | ||
"suggested": true | |||
}, | |||
"loc": { | |||
"label": "Location", | |||
}} | "description": "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.", | ||
(document | "example": "VALA_EXT-1", | ||
</ | "type": "string", | ||
"suggestedvalues": [ | |||
"[[HAR]]", | |||
"[[VALA]]", | |||
"[[LOS]]", | |||
"[[GRODNA]]", | |||
"[[THIRIEL]]", | |||
"[[THARMAS]]", | |||
"[[ENITHARMON]]", | |||
"[[UTHA]]", | |||
"[[FUZON]]", | |||
"[[ULRO]]", | |||
"[[RINTRAH]]", | |||
"[[BEULAH]]", | |||
"[[AHANIA]]" | |||
], | |||
"suggested": true | |||
}, | |||
"title": { | |||
"label": "Title", | |||
"description": "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", | |||
"type": "string", | |||
"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 one-sentence intro, the Contents header, and the document title. It will also add this page to Category:TTP2 Documents.", | |||
"paramOrder": [ | |||
"file", | |||
"title", | |||
"author", | |||
"loc", | |||
"multimedia", | |||
"force_display_author" | |||
], | |||
"format": "block" | |||
} | |||
</templatedata> | |||
</noinclude> | </noinclude> |
Latest revision as of 07:25, 16 June 2024
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
File Name | file | The in-universe file name, shown on a terminal before selecting the file. This often (but not always) includes underscores.
| String | required |
Title | title | 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.
| String | required |
Author | author | 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. | Unknown | suggested |
Location | loc | 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.
| String | suggested |
Multimedia? | multimedia | Type "true" without quotes if the document includes an image or video or audio.
| Unknown | optional |
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.
| Unknown | optional |