Editing Template:Quality/doc

__NOTOC__
This template includes links to accompanying '''Gain''' and '''Loss''' categories.

*'''Icon''' is the filename of the in-game image associated with the quality. This should include the extension ".png" but not the Namespace "File:" that is used by MediaWiki for images.
*'''Quality type''' is the category this quality belongs to. If blank, will categorize under [[:Category:Qualities with Unknown Type]].
*'''Attribute''' if set to yes will enable further text related to attributes only
:*'''Cap Raise''' Only usable if Attribute is set to yes this will create a line with an link regarding the qualities cap raise. Sets [[Property:Has cap raise]] to the value.
*'''Has cap''' The absolute maximum cap beyond which the quality cannot be raised. Usually signified with the notation x/y on your "Myself" tab (e.g. for "[[Notability]] 11/15", this parameter would be set to 15). For qualities that have more that one cap, take the highest value. Also sets [[Property:Has cap]] to the value.
*'''Description''': The Quality's description.
*'''Game Instructions''': For adding non-narrative game instructions.
*'''Wiki Note''': For adding notes by wiki editors.
*'''Unlocked with'''  (optional): Will create a link to a starting storylet/action which provides this quality. More can be listed using '#' as a separator.
*'''Unlocks'''  (optional): Will create a link to storylets/cards unlocked by this quality. More can be listed using '#' as a separator.
*'''Raise''': If "yes" (the default), will create a link to the "Gains" (or "Sources") category of the quality.
*'''Lower''': If "yes" (the default), will create a link to the "Loss" category of the quality.
*'''Discrete''': If "no" (the default), the quality increments by Change Points. Otherwise, it increments by discrete levels.
*'''ID''' is the numerical ID associated with the quality. If blank, will categorize under [[:Category:Qualities with Unknown ID]].
*'''Access''' - Optional description for qualities that cannot be obtained through regular gameplay. Possible values are Fate, for Fate-locked qualities; Festival, for qualities from time-limited events; Legacy, for qualities that are now Fate-locked but could once be obtained for free; Retired, for no-longer-obtainable qualities; Code, for qualities only obtained through access codes; Location, for qualities only possessed in a limited location; Failbetter Games, for qualities only distributed by the developers; Developer, for qualities only possessed by developers themselves.
**'''Access info''' -  Optional link to more specific info on how the quality might be obtained, such as the Guide page for a Festival.
***'''Origin''' - Optional link for Seasonal qualities, to record their event of origin (usually the festival's historical page) for archival purposes, if it's different then the current '''Access info'''. Most prominent for [[Summer festivals]] which merge multiple events occupying the same time-period.

<noinclude>[[Category:Template documentation]]</noinclude>
<templatedata>
{
	"params": {
		"Discrete": {
			"label": "Discrete",
			"description": "If \"no\" (the default), the quality increments by Change Points. Otherwise, it increments by discrete levels.",
			"example": "yes",
			"type": "string",
			"default": "no",
			"suggested": true
		},
		"Description": {
			"label": "Description",
			"description": "The Quality's description.",
			"type": "content",
			"required": true
		},
		"Game Instructions": {
			"label": "Game Instructions",
			"description": "For adding non-narrative game instructions."
		},
		"Wiki Note": {
			"label": "Wiki Notes",
			"description": "For adding notes by wiki editors.",
			"type": "content"
		},
		"Raise": {
			"label": "Raise",
			"description": "If \"yes\" (the default), will create a link to the \"Gains\" (or \"Sources\") category of the quality.",
			"example": "no",
			"type": "line",
			"default": "yes"
		},
		"Lower": {
			"label": "Lower",
			"description": "If \"yes\" (the default), will create a link to the \"Loss\" category of the quality.",
			"example": "no",
			"type": "line",
			"default": "yes"
		},
		"Unlocked with": {
			"label": "Unlocked with",
			"description": "Will create a link to a starting storylet/action which provides this quality. More can be listed using '#' as a separator.",
			"type": "content",
			"suggested": true
		},
		"Quality type": {
			"label": "Quality type",
			"description": "The category this quality belongs to, as displayed on the \"Myself\" tab in the game, or as the subcategory of Category:Qualities.",
			"example": "Dreams",
			"type": "line",
			"default": "If blank, will categorize under Category:Qualities with Unknown Type.",
			"required": true
		},
		"Icon": {
			"label": "Icon",
			"description": "The filename of the in-game image associated with the quality. This should include the extension \".png\" but not the Namespace \"File:\" that is used by MediaWiki for images.",
			"example": "Bat.png",
			"type": "line",
			"required": true
		},
		"ID": {
			"label": "ID",
			"description": "The numerical ID associated with the quality.",
			"example": "42",
			"type": "number",
			"suggested": true
		},
		"Available At": {},
		"Attribute": {
			"description": "If yes, will generate a link to \"<attribute name> Items\". Please don't use it if there are only very few items boosting the quality.",
			"example": "yes",
			"type": "boolean"
		},
		"Cap Raise": {
			"description": "Other quality that allows to raise this quality beyond the usual cap.",
			"example": "Glasswork Studies",
			"type": "wiki-page-name"
		},
		"Has cap": {
			"description": "Hard cap, beyond which the quality cannot be raised",
			"example": "15 (for Notability)",
			"type": "number"
		},
		"Access": {
			"description": "Optional description for qualities that cannot be obtained through regular gameplay. Possible values are Fate, Festival, Legacy, Retired, Code, Location, Failbetter Games, and Developer.",
			"example": "Festival",
			"type": "string"
		},
		"Access info": {
			"description": "Optional link to more specific info on how the quality might be obtained, such as the Guide page for a Festival.",
			"example": "Hallowmas (Guide)",
			"type": "wiki-page-name"
		},
		"Origin": {
			"description": "Optional link for Seasonal qualities, to record their event of origin (usually the festival's historical page) for archival purposes if it's different then the current [Access info].",
			"example": "Hallowmas (historical)#Hallowmas 2016 (1894)",
			"type": "wiki-page-name"
		},
		"Unlocks": {
			"label": "Unlocks",
			"description": "Will create a link to storylets/cards unlocked by this quality. More can be listed using '#' as a separator.",
			"type": "content"
		}
	},
	"description": "This template displays informations for Qualities that a player may acquire through gameplay, including links to relevant categories about how the Quality is used.",
	"paramOrder": [
		"Icon",
		"Description",
		"ID",
		"Quality type",
		"Game Instructions",
		"Available At",
		"Wiki Note",
		"Discrete",
		"Unlocked with",
		"Unlocks",
		"Raise",
		"Lower",
		"Attribute",
		"Cap Raise",
		"Has cap",
		"Access",
		"Access info",
		"Origin"
	],
	"format": "block"
}
</templatedata>