Mr. Johnson (talk | contribs) (→Usage) |
Mr. Johnson (talk | contribs) m (Text replacement - "{{Description}}" to "{{Description Tab}}") |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><!--Template Subcategories--></includeonly> | <includeonly><!--Template Subcategories--></includeonly>__NOTOC__ | ||
{{Template|Description | {{Template|Description}} is used in {{Category|Item}} articles to create standardized text for properties appearing on an Item's Description Tab. | ||
==Usage== | ==Usage== | ||
It accepts nine {{Parameter|optional|string}}s: {{Code|rating}}, {{Code|qty}}, {{Code|conceal}}, {{Code|cost}}, {{Code|avail}}, {{Code|condition}}, {{Code|equipped}}, {{Code|wireless}}, and {{Code|pan}}. | It accepts nine {{Parameter|optional|string}}s: {{Code|rating}}, {{Code|qty}}, {{Code|conceal}}, {{Code|cost}}, {{Code|avail}}, {{Code|condition}}, {{Code|equipped}}, {{Code|wireless}}, and {{Code|pan}}. | ||
| Line 6: | Line 6: | ||
* If set to {{Code|false}}, it hides the entire line. | * If set to {{Code|false}}, it hides the entire line. | ||
* If set to any other value, the text is appended to the base text. The sentence normally ends with a period, but if this option is used, you must include any trailing punctuation. This allows for choices. | * If set to any other value, the text is appended to the base text. The sentence normally ends with a period, but if this option is used, you must include any trailing punctuation. This allows for choices. | ||
It accepts one additional {{Parameter|optional|string}}, {{code|before}}, which can be used to manually add list items between the leading text and the first standard item. | |||
It should only be included on pages which also | It should only be included on pages which also transclude [[Stub:Description Tab]]. | ||
==Returns== | ==Returns== | ||
{{Code|<nowiki>{{Description Tab}}</nowiki>}} returns: {{Return|{{Description Tab}}}} | {{Code|<nowiki>{{Description Tab}}</nowiki>}} returns: {{Return|{{Description Tab}}}} | ||
{{Code|<nowiki>{{Description Tab|avail=false}}</nowiki>}} returns: {{Return|{{Description Tab|avail=false}}}} | {{Code|<nowiki>{{Description Tab|avail=false}}</nowiki>}} returns: {{Return|{{Description Tab|avail=false}}}} | ||
{{Code|<nowiki>{{Description Tab|qty=. Multiple pieces factor into the Actor's total Essence cost.}}</nowiki>}} returns: {{Return|{{Description Tab|qty=. Multiple pieces factor into the Actor's total Essence cost.}}}} | {{Code|<nowiki>{{Description Tab|qty=. Multiple pieces factor into the Actor's total Essence cost.}}</nowiki>}} returns: {{Return|{{Description Tab|qty=. Multiple pieces factor into the Actor's total Essence cost.}}}} | ||
{{Code|<nowiki>{{Description Tab|before=* {{Anchor|Alpha}} is the beginning.}}</nowiki>}} returns: {{Return|{{Description Tab|before=* {{Anchor|Alpha}} is the beginning.}}}} | |||
<div style="display: none;">{{References}}</div> | |||
Latest revision as of 21:27, 14 December 2023
Template:Description is used in Item articles to create standardized text for properties appearing on an Item's Description Tab.
Usage
It accepts nine optional string parameters: rating, qty, conceal, cost, avail, condition, equipped, wireless, and pan.
- If unset, it displays precanned text appropriate to the value.
- If set to
false, it hides the entire line. - If set to any other value, the text is appended to the base text. The sentence normally ends with a period, but if this option is used, you must include any trailing punctuation. This allows for choices.
It accepts one additional optional string parameter, before, which can be used to manually add list items between the leading text and the first standard item.
It should only be included on pages which also transclude Stub:Description Tab.
Returns
{{Description Tab}} returns:
The Description Tab/Documentation sheet includes fields to record additional information:
- Rating is used to calculate the Item's Condition Monitor.[sr 1]
- Qty tracks the number of this Item the character has.
- Conceal stores the Concealability Modifier[sr 2] for the item.
- Cost is the Item's value in nuyen.
- Avail is the Item's Availability code.
- Con. Mon is calculated from the Item's Rating.
- Equipped items is linked to the Actor's Gear Tab.
- Wireless determines wether or not the Item is wirelessly active.
- PAN shows which Device this item is connected to.
{{Description Tab|avail=false}} returns:
The Description Tab/Documentation sheet includes fields to record additional information:
{{Description Tab|qty=. Multiple pieces factor into the Actor's total Essence cost.}} returns:
The Description Tab/Documentation sheet includes fields to record additional information:
- Rating is used to calculate the Item's Condition Monitor.[sr 1]
- Qty tracks the number of this Item the character has. Multiple pieces factor into the Actor's total Essence cost.
- Conceal stores the Concealability Modifier[sr 2] for the item.
- Cost is the Item's value in nuyen.
- Avail is the Item's Availability code.
- Con. Mon is calculated from the Item's Rating.
- Equipped items is linked to the Actor's Gear Tab.
- Wireless determines wether or not the Item is wirelessly active.
- PAN shows which Device this item is connected to.
{{Description Tab|before=* {{Anchor|Alpha}} is the beginning.}} returns:
The Description Tab/Documentation sheet includes fields to record additional information:
- Alpha is the beginning.
- Rating is used to calculate the Item's Condition Monitor.[sr 1]
- Qty tracks the number of this Item the character has.
- Conceal stores the Concealability Modifier[sr 2] for the item.
- Cost is the Item's value in nuyen.
- Avail is the Item's Availability code.
- Con. Mon is calculated from the Item's Rating.
- Equipped items is linked to the Actor's Gear Tab.
- Wireless determines wether or not the Item is wirelessly active.
- PAN shows which Device this item is connected to.