Difference between revisions of "Template:QuAD/doc"
m |
GrampaSwood (talk | contribs) m |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
| − | {{ | + | {{Hatnote|This documentation page is transcluded onto a variety of documentation pages. Please take care in editing it to keep comments general.}} |
| − | </noinclude>== Summary == | + | </noinclude> |
| + | {{Complex template|user=Darkid}} | ||
| + | == Summary == | ||
{{tl|QuAD}} is used to display the '''Qu'''ality '''A'''vailability '''D'''atabase. In other words, it will list the ways to get an item in a given quality. | {{tl|QuAD}} is used to display the '''Qu'''ality '''A'''vailability '''D'''atabase. In other words, it will list the ways to get an item in a given quality. | ||
| − | This particular template is a wrapper for {{tl|Dictionary/ | + | This particular template is a wrapper for {{tl|Dictionary/quad}}, the '''Database'''. |
Entries in this dictionary call {{tl|QuAD/list}} to order the '''Availability''' in a fixed order, and passes them as sequentially numbered parameters to {{tl|QuAD/list/core}}. QuAD/list/core adds punctuation (commas and ampersands) and the result is a nicely readable string. This also makes use of {{tl|QuAD/comma}} and {{tl|QuAD/ampersand}}. | Entries in this dictionary call {{tl|QuAD/list}} to order the '''Availability''' in a fixed order, and passes them as sequentially numbered parameters to {{tl|QuAD/list/core}}. QuAD/list/core adds punctuation (commas and ampersands) and the result is a nicely readable string. This also makes use of {{tl|QuAD/comma}} and {{tl|QuAD/ampersand}}. | ||
| − | {{tl|Qualitycheck}} is called with a '''Quality''', and it will format the availability list for the relevant template (such as {{tl|Wqc}} | + | {{tl|Qualitycheck}} is called with a '''Quality''', and it will format the availability list for the relevant template (such as {{tl|Wqc}} or the qualities section in {{tl|Item infobox}}). |
| + | |||
{{tl|Wqc/table/core}}, {{tl|Cqc/table/core}}, or {{tl|Quality list}} call Qualitycheck (or do the formatting themselves) for all the available qualities. | {{tl|Wqc/table/core}}, {{tl|Cqc/table/core}}, or {{tl|Quality list}} call Qualitycheck (or do the formatting themselves) for all the available qualities. | ||
| + | |||
| + | Other templates: {{tl|QuAD/p}} and {{tl|QuAD/series}}. | ||
== Usage == | == Usage == | ||
| − | When new items are added that need qualities, edit the '''Database''', {{tl|Dictionary/ | + | When new items are added that need qualities, edit the '''Database''', {{tl|Dictionary/quad}}. |
| + | |||
| + | When new availability types are added/needed, edit the '''Availability''', {{tl|QuAD/list}}. | ||
| − | + | If there is an item with more than 20 availabilities, update {{tl|QuAD/list/core}}. | |
| − | If there | ||
If there are new qualities, edit the '''Quality''' lists, {{tl|Wqc/table/core}}, {{tl|Cqc/table/core}}, or {{tl|Quality list}}. | If there are new qualities, edit the '''Quality''' lists, {{tl|Wqc/table/core}}, {{tl|Cqc/table/core}}, or {{tl|Quality list}}. | ||
Latest revision as of 18:00, 22 November 2023
 | This template is very complex. If you have questions about this template, feel free to ask on the IRC. Darkid has offered to maintain this template, you may contact them if you need further assistance. |
Summary
{{QuAD}} is used to display the Quality Availability Database. In other words, it will list the ways to get an item in a given quality.
This particular template is a wrapper for {{Dictionary/quad}}, the Database.
Entries in this dictionary call {{QuAD/list}} to order the Availability in a fixed order, and passes them as sequentially numbered parameters to {{QuAD/list/core}}. QuAD/list/core adds punctuation (commas and ampersands) and the result is a nicely readable string. This also makes use of {{QuAD/comma}} and {{QuAD/ampersand}}.
{{Qualitycheck}} is called with a Quality, and it will format the availability list for the relevant template (such as {{Wqc}} or the qualities section in {{Item infobox}}).
{{Wqc/table/core}}, {{Cqc/table/core}}, or {{Quality list}} call Qualitycheck (or do the formatting themselves) for all the available qualities.
Other templates: {{QuAD/p}} and {{QuAD/series}}.
Usage
When new items are added that need qualities, edit the Database, {{Dictionary/quad}}.
When new availability types are added/needed, edit the Availability, {{QuAD/list}}.
If there is an item with more than 20 availabilities, update {{QuAD/list/core}}.
If there are new qualities, edit the Quality lists, {{Wqc/table/core}}, {{Cqc/table/core}}, or {{Quality list}}.
