Template:Career/doc: Difference between revisions

From Archaelund Wiki
(Created page with "== Description == This is the main template for all career pages. It determines the layout of the individual page and provides functionality for extracting specific career information for use in other pages. == Usage == <pre> {{Career |Mode = {{{1|Page}}} |Param1 = {{{2|}}} |Param2 = {{{3|}}} <!-- Quick Facts --> |Name = |Pagename = |Status = |Type = |Version = |VersionUpdate = |Category = |Levels = |Requisites = |Related = <!-- Media --> |Image = |Icon =...")
 
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 12: Line 12:
|Name =  
|Name =  
|Pagename =  
|Pagename =  
|Translation =
|Status =  
|Status =  
|Type =  
|Type =  
Line 18: Line 19:
|Category =  
|Category =  
|Levels =  
|Levels =  
|Requisites =  
|Prerequisites =  
|Related =  
|Related =  


Line 31: Line 32:
<!-- Stats -->
<!-- Stats -->
|Skills =  
|Skills =  
|BonusStats =  
|Disciplines =
|CareerBonus =  
|BonusTalent =  
|BonusTalent =  
|BonusDP =  
|BonusDP =  
|BonusArmor =  
|BonusArmor =  
|BonusOther =  
|BonusOther =  
 
}}
</pre>
</pre>


== Parameters ==
== Parameters ==
<table class="wikitable">
<table class="wikitable">
<tr><th>Name</th><th>Required</th><th>Description</th><th>Values</th></tr>
<tr><th>Name</th><th>Prerequired</th><th>Description</th><th>Values</th></tr>
<tr><td>Mode</td><td>Yes</td><td>Determines the mode of execution of the template ([[#Extracting specific career information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{1|Page}}}</nowiki> (should not be changed)</td></tr>
<tr><td>Mode</td><td>Yes</td><td>Determines the mode of execution of the template ([[#Extracting specific career information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{1|Page}}}</nowiki> (should not be changed)</td></tr>
<tr><td>Param1</td><td>Yes</td><td>Used for routing a selection parameter to the template in certain modes ([[#Extracting specific career information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{2|}}}</nowiki> (should not be changed)</td></tr>
<tr><td>Param1</td><td>Yes</td><td>Used for routing a selection parameter to the template in certain modes ([[#Extracting specific career information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{2|}}}</nowiki> (should not be changed)</td></tr>
Line 49: Line 51:
<tr><td>Name</td><td>Yes</td><td>The name of the career as used in the game. Will be displayed in the infobox of the page.</td><td>arbitrary text</td></tr>
<tr><td>Name</td><td>Yes</td><td>The name of the career as used in the game. Will be displayed in the infobox of the page.</td><td>arbitrary text</td></tr>
<tr><td>Pagename</td><td>Yes</td><td>The title of the career page, needed for linking purposes. Note: Do not use magic words such as <nowiki>{{PAGENAME}}</nowiki> here, as this prevents proper linking when transcluding information from this page on other pages.</td><td>arbitrary text</td></tr>
<tr><td>Pagename</td><td>Yes</td><td>The title of the career page, needed for linking purposes. Note: Do not use magic words such as <nowiki>{{PAGENAME}}</nowiki> here, as this prevents proper linking when transcluding information from this page on other pages.</td><td>arbitrary text</td></tr>
<tr><td>Translation</td><td>No</td><td>If the career is named differently in other languages, those names can be listed here.</td><td>internationalization string according to the format described in [[Template:Translation]]</td></tr>
<tr><td>Status</td><td>No</td><td>If the page has a special status, it can be set here. A corresponding box will be displayed at the top of the page.</td><td>one of the values defined in [[Template:PageStatus]]</td></tr>
<tr><td>Status</td><td>No</td><td>If the page has a special status, it can be set here. A corresponding box will be displayed at the top of the page.</td><td>one of the values defined in [[Template:PageStatus]]</td></tr>
<tr><td>Type</td><td>Yes</td><td>The specific type of the career. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:CareerType]] (other values are ignored): {{ListFormat|{{CareerType|TagList}}|Bullets}}</td></tr>
<tr><td>Type</td><td>Yes</td><td>The specific type of the career. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:CareerType]] (other values are ignored): {{ListFormat|{{CareerType|TagList}}|Bullets}}</td></tr>
<tr><td>Version</td><td>Yes</td><td>The game version in which the career was first introduced. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
<tr><td>Version</td><td>Yes</td><td>The game version in which the career was first introduced. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the career was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the career was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
<tr><td>Category</td><td>Yes</td><td>The category to which this career belongs.</td><td>one of the values defined in [[Template:CareerCategory]] (other values are ignored): {{ListFormat|{{CareerCategory|TagList}}|Bullets}}</td></tr>
<tr><td>Category</td><td>Yes</td><td>The category to which this career belongs to.</td><td>one of the values defined in [[Template:CareerCategory]] (other values are ignored): {{ListFormat|{{CareerCategory|TagList}}|Bullets}}</td></tr>
<tr><td>Levels</td><td>Yes</td><td>The total number of levels in this career.</td><td>positive number</td></tr>
<tr><td>Levels</td><td>Yes</td><td>The total number of levels in this career.</td><td>positive number</td></tr>
<tr><td>Requisites</td><td>No</td><td>If specific requisites have to be fulfilled to choose this career, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of requisites</td></tr>
<tr><td>Prerequisites</td><td>No</td><td>If specific prerequisites have to be fulfilled to choose this career, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of prerequisites</td></tr>
<tr><td>Related</td><td>No</td><td>If other careers are in some way related to this one, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of <nowiki>[[Career]]s</nowiki></td></tr>
<tr><td>Related</td><td>No</td><td>If other careers are in some way related to this one, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of <nowiki>[[Career]]s</nowiki></td></tr>


Line 68: Line 71:
<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>
<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>
<tr><td>Skills</td><td>Yes</td><td>The available skills in this career.</td><td>a semicolon-separated list of <nowiki>[[Skill]]s</nowiki></td></tr>
<tr><td>Skills</td><td>Yes</td><td>The available skills in this career.</td><td>a semicolon-separated list of <nowiki>[[Skill]]s</nowiki></td></tr>
<tr><td>BonusStats</td><td>Yes</td><td>The stats bonus granted at each level of the career. See [[Template:CareerBonus]] for further information.</td><td>a vector of 9 comma-separated numbers (e.g. "2,5,5,3,3,0,1,2,4")</td></tr>
<tr><td>Disciplines</td><td>No</td><td>The available disciplines in this career (relevant for spellcasters only).</td><td>a semicolon-separated list of Disciplines</td></tr>
<tr><td>CareerBonus</td><td>Yes</td><td>The stats bonus granted at each level of the career. See [[Template:CareerBonus]] for further information.</td><td>a vector of 9 comma-separated numbers (e.g. "2,5,5,3,3,0,1,2,4")</td></tr>
<tr><td>BonusTalent</td><td>Yes</td><td>The sequence (in ascending level order) of [[Talents]] granted at specific levels of the career.</td><td>a semicolon-separated list of <nowiki>[[Talents]]s</nowiki> (if there's no bonus at a specific level, leave the corresponding entry in the list blank)</td></tr>
<tr><td>BonusTalent</td><td>Yes</td><td>The sequence (in ascending level order) of [[Talents]] granted at specific levels of the career.</td><td>a semicolon-separated list of <nowiki>[[Talents]]s</nowiki> (if there's no bonus at a specific level, leave the corresponding entry in the list blank)</td></tr>
<tr><td>BonusDP</td><td>Yes</td><td>The sequence (in ascending level order) of [[Discipline Points]] granted at specific levels of the career.</td><td>a semicolon-separated list of numbers (if there's no bonus at a specific level, set the corresponding entry in the list to zero)</td></tr>
<tr><td>BonusDP</td><td>Yes</td><td>The sequence (in ascending level order) of Discipline Points granted at specific levels of the career.</td><td>a semicolon-separated list of numbers (if there's no bonus at a specific level, set the corresponding entry in the list to zero)</td></tr>
<tr><td>BonusArmor</td><td>Yes</td><td>The sequence (in ascending level order) of additional points in [[Armor Training]] granted at specific levels of the career.</td><td>a semicolon-separated list of numbers (if there's no bonus at a specific level, set the corresponding entry in the list to zero)</td></tr>
<tr><td>BonusArmor</td><td>Yes</td><td>The sequence (in ascending level order) of additional points in [[Character Stats#Defense Stats|Armor Training]] granted at specific levels of the career.</td><td>a semicolon-separated list of numbers (if there's no bonus at a specific level, set the corresponding entry in the list to zero)</td></tr>
<tr><td>BonusOther</td><td>Yes</td><td>The sequence (in ascending level order) of other bonuses granted at specific levels of the career.</td><td>a semicolon-separated list of arbitrary entries (if there's no bonus at a specific level, leave the corresponding entry in the list blank)</td></tr>
<tr><td>BonusOther</td><td>Yes</td><td>The sequence (in ascending level order) of other bonuses granted at specific levels of the career.</td><td>a semicolon-separated list of arbitrary entries (if there's no bonus at a specific level, leave the corresponding entry in the list blank)</td></tr>
</table>
</table>

Latest revision as of 13:43, 25 February 2024

Description

This is the main template for all career pages. It determines the layout of the individual page and provides functionality for extracting specific career information for use in other pages.

Usage

{{Career
|Mode = {{{1|Page}}}
|Param1 = {{{2|}}}
|Param2 = {{{3|}}}

<!-- Quick Facts -->
|Name = 
|Pagename = 
|Translation = 
|Status = 
|Type = 
|Version = 
|VersionUpdate = 
|Category = 
|Levels = 
|Prerequisites = 
|Related = 

<!-- Media -->
|Image = 
|Icon = 

<!-- Info -->
|Description = 
|Notes = 

<!-- Stats -->
|Skills = 
|Disciplines = 
|CareerBonus = 
|BonusTalent = 
|BonusDP = 
|BonusArmor = 
|BonusOther = 
}}

Parameters

NamePrerequiredDescriptionValues
ModeYesDetermines the mode of execution of the template (see below). Changing the predefined value may lead to unexpected behavior.{{{1|Page}}} (should not be changed)
Param1YesUsed 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)
Param2YesUsed for routing a selection parameter to the template in certain modes (see below). Changing the predefined value may lead to unexpected behavior.{{{3|}}} (should not be changed)
Quick Facts
NameYesThe name of the career as used in the game. Will be displayed in the infobox of the page.arbitrary text
PagenameYesThe title of the career 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
TranslationNoIf the career is named differently in other languages, those names can be listed here.internationalization string according to the format described in Template:Translation
StatusNoIf 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
TypeYesThe specific type of the career. Will be displayed in the infobox of the page.one of the values defined in Template:CareerType (other values are ignored): Basic • Advanced
VersionYesThe game version in which the career was first introduced. Will be displayed in the infobox of the page.version number in the form X.Y.Z
VersionUpdateNoThe game version in which the career was last updated. Will be displayed in the infobox of the page.version number in the form X.Y.Z
CategoryYesThe category to which this career belongs to.one of the values defined in Template:CareerCategory (other values are ignored): Warrior • Wanderer • Scoundrel • Sage
LevelsYesThe total number of levels in this career.positive number
PrerequisitesNoIf specific prerequisites have to be fulfilled to choose this career, they can be listed here. Will be displayed in the infobox of the page.a semicolon-separated list of prerequisites
RelatedNoIf other careers are in some way related to this one, they can be listed here. Will be displayed in the infobox of the page.a semicolon-separated list of [[Career]]s
Media
ImageYesThe image (PNG or JPG) to be displayed in the infobox of the page.image name (including file extension)
IconNoThe image (PNG or JPG) to be displayed as an icon in career tables, lists, etc. If nothing is specified, a small version of Image is used instead.image name (including file extension)
Info
DescriptionYesA concise description of the career itself. Is used as an introductory paragraph and should not be too excessive (2−3 sentences are usually enough).arbitrary text
NotesNoAny kind of ancillary information (which does not seem appropriate anywhere else) can be provided here.arbitrary text, ideally formatted as a bullet list (using *)
Stats
SkillsYesThe available skills in this career.a semicolon-separated list of [[Skill]]s
DisciplinesNoThe available disciplines in this career (relevant for spellcasters only).a semicolon-separated list of Disciplines
CareerBonusYesThe stats bonus granted at each level of the career. See Template:CareerBonus for further information.a vector of 9 comma-separated numbers (e.g. "2,5,5,3,3,0,1,2,4")
BonusTalentYesThe sequence (in ascending level order) of Talents granted at specific levels of the career.a semicolon-separated list of [[Talents]]s (if there's no bonus at a specific level, leave the corresponding entry in the list blank)
BonusDPYesThe sequence (in ascending level order) of Discipline Points granted at specific levels of the career.a semicolon-separated list of numbers (if there's no bonus at a specific level, set the corresponding entry in the list to zero)
BonusArmorYesThe sequence (in ascending level order) of additional points in Armor Training granted at specific levels of the career.a semicolon-separated list of numbers (if there's no bonus at a specific level, set the corresponding entry in the list to zero)
BonusOtherYesThe sequence (in ascending level order) of other bonuses granted at specific levels of the career.a semicolon-separated list of arbitrary entries (if there's no bonus at a specific level, leave the corresponding entry in the list blank)

Extracting specific career information for use in other pages

Syntax

You can transclude information from a career page in any other page by using the following syntax:

{{:<pagename>|<mode>|<param1>|<param2>}}

Here, <pagename> is the career's full page name (in main namespace), <mode> determines the type of information to be transcluded, and <param1> & <param2> represent selection parameters required by certain modes.

Modes and parameters

ModeDescriptionParameter 1Parameter 2
PageOutputs the full career page. This is the default mode.nonenone
TableHeadOutputs the header of a career table (intended for constructing overview tables).nonenone
TableEntryOutputs a table row containing specific career information (intended for constructing overview tables). If a selector is specified in <param1>, output is only generated if the selector of a specific career matches the value of <param2>. If no selector is specified, output is always generated.one of the following selectors: Type • Categoryone of the possible values of the specified selector