Editing User:Alistaire/Template:DefsStdTemplate/doc

Example documentation<br/><br/>

==Parameters==

{|
! Parameter !! Explanation
|-
| attribute || ''(required<sup>1</sup>):'' The attribute, e.g &lt;parent attribute=""/&gt;, 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 &lt;pre/&gt;, e.g &lt;pre&gt;{{{examples}}}&lt;/pre&gt;.
|-
| link || ''(optional):'' Overwrites what attribute/tag links to.
|-
| notes || ''(required):'' An explanation on the tag/attribute described in this row.
|-
| tag || ''(required<sup>1</sup>):'' 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.
|-
|}<br/>

# Only one of attribute and tag is shown.
# Only shown when there's no type parameter.<br/><br/>

==Examples==

{|
! 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|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.}}
|}
|-
|}<br/><br/>

==See also==

*[[User:Alistaire/Template:DefsStdTemplateHeader]]