Difference between revisions of "User:Alistaire/Template:DefsStdTemplate/doc"
Jump to navigation
Jump to search
(Added see also) |
(Updated parameters) |
||
| Line 6: | Line 6: | ||
! Parameter !! Explanation | ! Parameter !! Explanation | ||
|- | |- | ||
| − | | attribute || ''(required<sup>1</sup>):'' The attribute, e.g | + | | attribute || ''(required<sup>1</sup>):'' The attribute, e.g <parent attribute=""/>, you are describing in this row. |
| + | |- | ||
| + | | examples || ''(optional):'' Adds an example column in <pre/>, e.g <pre>{{{examples}}}</pre>. | ||
|- | |- | ||
| link || ''(optional):'' Overwrites what attribute/tag links to. | | link || ''(optional):'' Overwrites what attribute/tag links to. | ||
| Line 29: | Line 31: | ||
! Input !! Output | ! Input !! Output | ||
|- | |- | ||
| − | | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader}} | + | | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader|examplesEnabled=1}} |
| − | {{User:Alistaire/Template:DefsStdTemplate}} | + | {{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} |
|}</pre> | |}</pre> | ||
| − | | {{User:Alistaire/Template:DefsStdTemplateHeader}} | + | | {{User:Alistaire/Template:DefsStdTemplateHeader|examplesEnabled=1}} |
| − | {{User:Alistaire/Template:DefsStdTemplate}} | + | {{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}} |
|} | |} | ||
|- | |- | ||
Revision as of 15:40, 12 April 2015
Example documentation
Parameters
| Parameter | Explanation |
|---|---|
| attribute | (required1): The attribute, e.g <parent attribute=""/>, you are describing in this row. |
| 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.
Examples
| Input | Output | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{User:Alistaire/Template:DefsStdTemplateHeader|examplesEnabled=1}}
{{User:Alistaire/Template:DefsStdTemplate|examplesEnabled=1}}
|}
|
Parents: none specified
| ||||||||||||
{{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.}}
|}
|
Parents: <>ThingDefs
| ||||||||||||