Editing Template:Variant table/doc
From Fallen London Wiki
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 9: | Line 9: | ||
The value of the '''Condition''' parameter is used to generate links and Categories. The '''Condition alias''' parameter can be used to change how the Condition Quality appears when displayed in the header row. If not supplied, the Quality is displayed as its own name. If no Quality is supplied, the column header will be "Condition." | The value of the '''Condition''' parameter is used to generate links and Categories. The '''Condition alias''' parameter can be used to change how the Condition Quality appears when displayed in the header row. If not supplied, the Quality is displayed as its own name. If no Quality is supplied, the column header will be "Condition." | ||
| − | In cases where the values are always simple (like plain numbers), the '''Compact''' parameter can save redundant typing. When this parameter is set, then parameter '''Value ''N''''' on its own creates a matching pair of '''''N''''' and the value of the parameter, and the '''Effect ''N''''' parameter is not used. In other words, <code><nowiki>|Value N = Foo</nowiki></code> is shorthand for <code><nowiki>|Value N = N|Effect N = Foo</nowiki></code>. Compact values are | + | In cases where the values are always simple (like plain numbers), the '''Compact''' parameter can save redundant typing. When this parameter is set, then parameter '''Value ''N''''' on its own creates a matching pair of '''''N''''' and the value of the parameter, and the '''Effect ''N''''' parameter is not used. In other words, <code><nowiki>|Value N = Foo</nowiki></code> is shorthand for <code><nowiki>|Value N = N|Effect N = Foo</nowiki></code>. Compact values are only allowed for Text or Math condition types. |
Sometimes a single Quality has multiple effects on the page, such as altering both the title and description. A third column can be added, with a header set by '''Second effect''' and values set by '''Second effect ''N'''''. | Sometimes a single Quality has multiple effects on the page, such as altering both the title and description. A third column can be added, with a header set by '''Second effect''' and values set by '''Second effect ''N'''''. | ||
| − | Occasionally, the table summarizes the effects of multiple Qualities, and each row lists the impact of an individual quality. In this case, the '''Condition type''' should be "Quality." The '''Value ''N''''' parameter is used to create links | + | Occasionally, the table summarizes the effects of multiple Qualities, and each row lists the impact of an individual quality. In this case, the '''Condition type''' should be "Quality." The '''Value ''N''''' parameter is used to create links and Categories, and the '''Alias ''N''''' parameter can be used to change how it is displayed. The '''Alias ''N''''' parameter has no effect unless the '''Condition type''' is "Quality." An effect caused by the absence of any relevant quality can be represented by the '''Value ''N''''' parameter being present but empty. |
| − | Depending on the '''Condition type''', values supplied to the '''Condition''' or '''Value ''N''''' parameters are used to create links and add categories | + | Depending on the '''Condition type''', values supplied to the '''Condition''' or '''Value ''N''''' parameters are used to create links and add categories. To suppress this behavior (or manually create your own links and categories), set '''Condition type''' to "Raw." |
==Best Practices== | ==Best Practices== | ||
| Line 56: | Line 56: | ||
"Condition type": { | "Condition type": { | ||
"label": "Condition type", | "label": "Condition type", | ||
| − | "description": "The type of effect the condition causes. Should be one of Text, Math, Quality | + | "description": "The type of effect the condition causes. Should be one of Text, Math, Quality, or Raw.", |
"required": false, | "required": false, | ||
"suggested": true, | "suggested": true, | ||
