Template:Character/doc: Difference between revisions
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
|Factions = | |Factions = | ||
|Quests = | |Quests = | ||
<!-- Media --> | <!-- Media --> | ||
| Line 24: | Line 23: | ||
<!-- Personal Data --> | <!-- Personal Data --> | ||
|Level = | |||
|Race = | |Race = | ||
|Gender = | |Gender = | ||
| Line 30: | Line 30: | ||
<!-- Interaction --> | <!-- Interaction --> | ||
|Actions = | |||
|Dialogue = | |Dialogue = | ||
|Quotes = | |Quotes = | ||
| Line 56: | Line 56: | ||
<tr><td>Factions</td><td>No</td><td>If the character is affiliated to one or more factions, they can be listed here and will be displayed in the infobox of the page.</td><td>a semicolon-separated list of <nowiki>[[Faction]]s</nowiki></td></tr> | <tr><td>Factions</td><td>No</td><td>If the character is affiliated to one or more factions, they can be listed here and will be displayed in the infobox of the page.</td><td>a semicolon-separated list of <nowiki>[[Faction]]s</nowiki></td></tr> | ||
<tr><td>Quests</td><td>No</td><td>If the character is involved in certain quests, they can be listed here and will be displayed in the infobox of the page.</td><td>a semicolon-separated list of <nowiki>[[Quests]]s</nowiki></td></tr> | <tr><td>Quests</td><td>No</td><td>If the character is involved in certain quests, they can be listed here and will be displayed in the infobox of the page.</td><td>a semicolon-separated list of <nowiki>[[Quests]]s</nowiki></td></tr> | ||
<tr><th colspan="4" style="text-align:left">''Media''</th></tr> | <tr><th colspan="4" style="text-align:left">''Media''</th></tr> | ||
| Line 62: | Line 61: | ||
<tr><td>Icon</td><td>No</td><td>The image (PNG or JPG) to be displayed as an icon in character tables, lists, etc. If nothing is specified, a small version of ''Image'' is used instead.</td><td>image name (including file extension)</td></tr> | <tr><td>Icon</td><td>No</td><td>The image (PNG or JPG) to be displayed as an icon in character tables, lists, etc. If nothing is specified, a small version of ''Image'' is used instead.</td><td>image name (including file extension)</td></tr> | ||
<tr><th colspan="4" style="text-align:left">''Personal Data''</th></tr> | |||
<tr><td>Level</td><td>Yes</td><td>The level of the character. Will be displayed in the infobox of the page.</td><td>positive number</td></tr> | |||
<tr><td>Race</td><td>Yes</td><td>The race of the character. Will be displayed in the infobox of the page.</td><td>one of the in-game <nowiki>[[Race]]s</nowiki></td></tr> | |||
<tr><td>Gender</td><td>No</td><td>The gender of the character (if known). Will be displayed in the infobox of the page. If nothing is specified, the gender is set to "Unkown".</td><td>"Male", "Female", "Neutral" or any other appropriate term</td></tr> | |||
<tr><td>Age</td><td>No</td><td>The age of the character (if known). Will be displayed in the infobox of the page. If nothing is specified, the age is set to "Unkown".</td><td>positive number</td></tr> | |||
<tr><td>Aliases</td><td>No</td><td>If the character is known by more than one name, its aliases can be listed here and will be displayed in the infobox of the page.</td><td>a semicolon-separated list of aliases</td></tr> | |||
<tr><th colspan="4" style="text-align:left">''Interaction''</th></tr> | |||
<tr><td>Actions</td><td>No</td><td>If the character offers any notable services (e.g. trading, crafting, transportation, training, etc.) or performs other actions, those services and actions can briefly be described here.</td><td>a semicolon-separated list of brief descriptions</td></tr> | |||
<tr><td>Dialogue</td><td>No</td><td>If the character has any notable dialogue options (e.g. revealing important information, advancing a quest, etc.), those options and their implications can briefly be described here.</td><td>a semicolon-separated list of brief descriptions</td></tr> | |||
<tr><td>Quotes</td><td>No</td><td>Any memorable quote from this character might be put here.</td><td>a semicolon-separated list of <nowiki>{{Quote|...}}s</nowiki> (using [[Template:Quote]])</td></tr> | |||
<tr><th colspan="4" style="text-align:left">''Info''</th></tr> | |||
<tr><td>Description</td><td>Yes</td><td>A concise description of the character itself. Is used as an introductory paragraph and should not be too excessive (2−3 sentences are usually enough). More detailed information can be provided under ''Backstory''.</td><td>arbitrary text</td></tr> | |||
<tr><td>Backstory</td><td>No</td><td>Here you can put any substancial background information on this character (its past, current intentions and entanglements, etc.), as long as it is derived from in-game sources (no speculation please).</td><td>arbitrary text</td></tr> | |||
<tr><td>Notes</td><td>No</td><td>Any kind of ancillary information (which does not seem appropriate anywhere else) can be provided here.</td><td>arbitrary text, ideally formatted as a bullet list (using <nowiki>*</nowiki>)</td></tr> | |||
</table> | </table> | ||
== Including character stats == | |||
For clarity reasons, information on character stats is outsourced to a subpage <PAGENAME>/stats, where all relevant properties are defined and formatted using [[Template:StatsTable]] (see the corresponding documentation there). If such a subpage exists, it will automatically be transcluded into the character page. | |||
== Including merchant shops == | |||
... | |||
== Extracting specific character information for use in other pages == | == Extracting specific character information for use in other pages == | ||
Revision as of 14:11, 13 December 2020
Description
This is the main template for all character pages. It determines the layout of the individual page and provides functionality for extracting specific character information for use in other pages.
Usage
{{Character
|Mode = {{{1|Page}}}
|Select = {{{2|}}}
<!-- Quick Facts -->
|Name =
|Pagename =
|Status =
|Type =
|Attributes =
|Locations =
|Factions =
|Quests =
<!-- Media -->
|Image =
|Icon =
<!-- Personal Data -->
|Level =
|Race =
|Gender =
|Age =
|Aliases =
<!-- Interaction -->
|Actions =
|Dialogue =
|Quotes =
<!-- Info -->
|Description =
|Backstory =
|Notes =
}}
Parameters
| Name | Required | Description | Values |
|---|---|---|---|
| Mode | Yes | Determines the mode of execution of the template (see below). Changing the predefined value may lead to unexpected behavior. | {{{1|Page}}} (should not be changed) |
| Select | Yes | Used for routing a selection parameter to the template in certain modes (see below). Changing the predefined value may lead to unexpected behavior. | {{{2|}}} (should not be changed) |
| Quick Facts | |||
| Name | Yes | The name of the character as used in the game. Will be displayed in the infobox of the page. If alternative names exist, they can be provided under Aliases. | arbitrary text |
| Pagename | Yes | The title of the character page, needed for linking purposes. Note: Do not use magic words such as {{PAGENAME}} here, as this prevents proper linking when transcluding information from this page on other pages. | arbitrary text |
| Status | No | If the page has a special status, it can be set here. A corresponding box will be displayed at the top of the page. | one of the values defined in Template:PageStatus |
| Type | Yes | The specific type of the character. Will be displayed in the infobox of the page. | one of the values defined in Template:CharacterType (other values are ignored): Main • Side • Generic • Mentioned |
| Attributes | No | One or more attributes which describe certain aspects of the character. Will be displayed in the infobox of the page. | a semicolon-separated list of the values defined in Template:CharacterAttributes (other values are ignored): Merchant • Healer • Trainer • Transport • Companion |
| Locations | Yes | The location(s) in which the character can be encountered during the course of the game. The first entry is assumed to be the initial location and will be displayed in the infobox of the page. | a semicolon-separated list of [[Location]]s |
| Factions | No | If the character is affiliated to one or more factions, they can be listed here and will be displayed in the infobox of the page. | a semicolon-separated list of [[Faction]]s |
| Quests | No | If the character is involved in certain quests, they can be listed here and will be displayed in the infobox of the page. | a semicolon-separated list of [[Quests]]s |
| Media | |||
| Image | Yes | The image (PNG or JPG) to be displayed in the infobox of the page. | image name (including file extension) |
| Icon | No | The image (PNG or JPG) to be displayed as an icon in character tables, lists, etc. If nothing is specified, a small version of Image is used instead. | image name (including file extension) |
| Personal Data | |||
| Level | Yes | The level of the character. Will be displayed in the infobox of the page. | positive number |
| Race | Yes | The race of the character. Will be displayed in the infobox of the page. | one of the in-game [[Race]]s |
| Gender | No | The gender of the character (if known). Will be displayed in the infobox of the page. If nothing is specified, the gender is set to "Unkown". | "Male", "Female", "Neutral" or any other appropriate term |
| Age | No | The age of the character (if known). Will be displayed in the infobox of the page. If nothing is specified, the age is set to "Unkown". | positive number |
| Aliases | No | If the character is known by more than one name, its aliases can be listed here and will be displayed in the infobox of the page. | a semicolon-separated list of aliases |
| Interaction | |||
| Actions | No | If the character offers any notable services (e.g. trading, crafting, transportation, training, etc.) or performs other actions, those services and actions can briefly be described here. | a semicolon-separated list of brief descriptions |
| Dialogue | No | If the character has any notable dialogue options (e.g. revealing important information, advancing a quest, etc.), those options and their implications can briefly be described here. | a semicolon-separated list of brief descriptions |
| Quotes | No | Any memorable quote from this character might be put here. | a semicolon-separated list of {{Quote|...}}s (using Template:Quote) |
| Info | |||
| Description | Yes | A concise description of the character itself. Is used as an introductory paragraph and should not be too excessive (2−3 sentences are usually enough). More detailed information can be provided under Backstory. | arbitrary text |
| Backstory | No | Here you can put any substancial background information on this character (its past, current intentions and entanglements, etc.), as long as it is derived from in-game sources (no speculation please). | arbitrary text |
| Notes | No | Any kind of ancillary information (which does not seem appropriate anywhere else) can be provided here. | arbitrary text, ideally formatted as a bullet list (using *) |
Including character stats
For clarity reasons, information on character stats is outsourced to a subpage <PAGENAME>/stats, where all relevant properties are defined and formatted using Template:StatsTable (see the corresponding documentation there). If such a subpage exists, it will automatically be transcluded into the character page.
Including merchant shops
...
Extracting specific character information for use in other pages
Syntax
You can transclude information from a character page in any other page by using the following syntax:
{{:<pagename>|<mode>|<select>}}
Here, <pagename> is the character's full page name (in main namespace), <mode> determines the type of information to be transcluded, and <select> represents a selector required by certain modes.
Modes and selectors
| Mode | Description | Selector |
|---|---|---|
| Page | Outputs the full character page. This is the default mode. | none |
| TableHead | Outputs the header of a character table (intended for constructing overview tables). | none |
| TableEntryType | Outputs a table row containing specific character information (intended for constructing overview tables). If a character type is specified in the selector, output is only generated if the character matches this type. If no selector is specified, output is always generated. | <select> = one of the following character types: Main • Side • Generic • Mentioned |
| TableEntryAttr | Outputs a table row containing specific character information (intended for constructing overview tables). If a character attribute is specified in the selector, output is only generated if the character carries this attribute. If no selector is specified, no output is generated. | <select> = one of the following character attributes: Merchant • Healer • Trainer • Transport • Companion |