Difference between revisions of "User:Alistaire/Template:DefsStdTemplate/doc"
Jump to navigation
Jump to search
(Updated parameters) |
(contents -> type in examples) |
||
| Line 37: | Line 37: | ||
{{User:Alistaire/Template:DefsStdTemplate | {{User:Alistaire/Template:DefsStdTemplate | ||
|tag=defName | |tag=defName | ||
| − | | | + | |type=string |
|notes=The in-script defName of this thing, referenced by recipes for example.}} | |notes=The in-script defName of this thing, referenced by recipes for example.}} | ||
{{User:Alistaire/Template:DefsStdTemplate | {{User:Alistaire/Template:DefsStdTemplate | ||
|attribute=Name | |attribute=Name | ||
| − | | | + | |type=bool |
|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|ThingDefs|Defs}}}} | | {{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|Defs}}}} | ||
| − | {{User:Alistaire/Template:DefsStdTemplate|tag=defName| | + | {{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| | + | {{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.}} |
|} | |} | ||
|- | |- | ||
|} | |} | ||
Revision as of 14:14, 12 April 2015
Example documentation
Parameters
| Parameter | Explanation |
|---|---|
| attribute | (required1): The attribute, e.g <parent attribute=""/>, you are describing in this row. |
| 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. |
- Only one of attribute and tag is shown.
Examples
| Input | Output | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{User:Alistaire/Template:DefsStdTemplateHeader}}
{{User:Alistaire/Template:DefsStdTemplate}}
|}
|
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
| ||||||||||||