Template:TTP2Document: Difference between revisions
automatic DISPLAYTITLE and Category |
Now writes one-sentence intro and "Contents" header! |
||
Line 1: | Line 1: | ||
{{#if: {{{file|}}} | {{DISPLAYTITLE:{{{file}}}}} }} | {{#if:{{{file|}}}|{{DISPLAYTITLE:{{{file}}}}}}} | ||
'''{{{file|{{BASEPAGENAME}}}}}''' is a {{#if:{{{multimedia|}}}|multimedia|text}} document{{#ifeq: {{{force_display_author|}}}|true| by {{{author}}}}}{{#if:{{{loc|}}}| stored in the {{{loc}}} terminal}}. | |||
| | == Contents == | ||
| | === {{{title|}}} ===<noinclude> | ||
| | |||
| | |||
| | |||
{{#if: {{{ | |||
== | |||
| | |||
}} | |||
< | |||
<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 | "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.
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 |