Difference between revisions of "User:Alistaire/Template:DefsStdTemplate/doc"
(Updated parameters) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
|- | |- | ||
| attribute || ''(required<sup>1</sup>):'' The attribute, e.g <parent attribute=""/>, you are describing in this row. | | attribute || ''(required<sup>1</sup>):'' The attribute, e.g <parent attribute=""/>, you are describing in this row. | ||
| + | |- | ||
| + | | collapseContents || ''(optional):'' Whether the contents should collapse. Starts collapsed. | ||
| + | |- | ||
| + | | contents || ''(optional<sup>2</sup>):'' An unformatted {{{type}}}, used for special contents cases e.g child tags. | ||
|- | |- | ||
| examples || ''(optional):'' Adds an example column in <pre/>, e.g <pre>{{{examples}}}</pre>. | | examples || ''(optional):'' Adds an example column in <pre/>, e.g <pre>{{{examples}}}</pre>. | ||
| Line 24: | Line 28: | ||
|}<br/> | |}<br/> | ||
| − | # Only one of attribute and tag is shown.<br/><br/> | + | # Only one of attribute and tag is shown. |
| + | # Only shown when there's no type parameter.<br/><br/> | ||
==Examples== | ==Examples== | ||
| − | + | <nowiki> | |
{| | {| | ||
! Input !! Output | ! Input !! Output | ||
|- | |- | ||
| − | | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader|examplesEnabled=1}} | + | | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader|notesDisabled=1|examplesEnabled=1}} |
{{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} | {{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} | ||
|}</pre> | |}</pre> | ||
| − | | {{User:Alistaire/Template:DefsStdTemplateHeader|examplesEnabled=1}} | + | | {{User:Alistaire/Template:DefsStdTemplateHeader|notesDisabled=1|examplesEnabled=1}} |
{{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} | {{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} | ||
|} | |} | ||
| Line 50: | Line 55: | ||
|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} | |notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} | ||
|}</pre> | |}</pre> | ||
| − | | {{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter| | + | | {{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDef|ThingDef}}}} |
{{User:Alistaire/Template:DefsStdTemplate|tag=defName|type=string|notes=The in-script defName of this thing, referenced by recipes for example.}} | {{User:Alistaire/Template:DefsStdTemplate|tag=defName|type=string|notes=The in-script defName of this thing, referenced by recipes for example.}} | ||
{{User:Alistaire/Template:DefsStdTemplate|attribute=Name|type=bool|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} | {{User:Alistaire/Template:DefsStdTemplate|attribute=Name|type=bool|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} | ||
| Line 56: | Line 61: | ||
|- | |- | ||
|}<br/><br/> | |}<br/><br/> | ||
| − | + | </nowiki> | |
==See also== | ==See also== | ||
*[[User:Alistaire/Template:DefsStdTemplateHeader]] | *[[User:Alistaire/Template:DefsStdTemplateHeader]] | ||
Latest revision as of 23:50, 4 April 2023
Example documentation
Parameters[edit]
| Parameter | Explanation |
|---|---|
| attribute | (required1): The attribute, e.g <parent attribute=""/>, you are describing in this row. |
| collapseContents | (optional): Whether the contents should collapse. Starts collapsed. |
| contents | (optional2): An unformatted {{{type}}}, used for special contents cases e.g child tags. |
| examples | (optional): Adds an example column in <pre/>, e.g <pre>{{{examples}}}</pre>. |
| link | (optional): Overwrites what attribute/tag links to. |
| notes | (required): An explanation on the tag/attribute described in this row. |
| tag | (required1): The tag, e.g <parent><tag/></parent>, you are describing in this row. |
| type | (required): A User:Alistaire/Template:DefsStdContentSwitch -style content name. Accepted values are shown on the template page. |
| typeDefault | (optional): A User:Alistaire/Template:DefsStdContentSwitch -style default value. Shows up as (default: {{{typeDefault}}}), before typeInfo. |
| typeInfo | (optional): A User:Alistaire/Template:DefsStdContentSwitch -style extra info. Shows up as ({{{typeInfo}}}), behind typeDefault. |
- Only one of attribute and tag is shown.
- Only shown when there's no type parameter.
Examples[edit]
{| ! Input !! Output |- | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader|notesDisabled=1|examplesEnabled=1}} {{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} |}</pre> | {{User:Alistaire/Template:DefsStdTemplateHeader|notesDisabled=1|examplesEnabled=1}} {{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} |} |- | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader |tag=thingDef |parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|Defs}}}} {{User:Alistaire/Template:DefsStdTemplate |tag=defName |type=string |notes=The in-script defName of this thing, referenced by recipes for example.}} {{User:Alistaire/Template:DefsStdTemplate |attribute=Name |type=bool |notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} |}</pre> | {{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDef|ThingDef}}}} {{User:Alistaire/Template:DefsStdTemplate|tag=defName|type=string|notes=The in-script defName of this thing, referenced by recipes for example.}} {{User:Alistaire/Template:DefsStdTemplate|attribute=Name|type=bool|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} |} |- |}<br/><br/>