Difference between revisions of "User:Alistaire/Template:DefsStdTemplate/doc"
Jump to navigation
Jump to search
(Created) |
(Added better examples) |
||
| Line 18: | Line 18: | ||
| tagLink || ''(optional<sup>1</sup>):'' If the tag name isn't the same as the page you want to link to, use this parameter to choose the right link. | | tagLink || ''(optional<sup>1</sup>):'' If the tag name isn't the same as the page you want to link to, use this parameter to choose the right link. | ||
|- | |- | ||
| − | |} | + | |}</br> |
| − | # One of attribute/attributeLink and tag/tagLink is shown. | + | # One of attribute/attributeLink and tag/tagLink is shown.<br/></br> |
==Examples== | ==Examples== | ||
| Line 32: | Line 32: | ||
| {{User:Alistaire/Template:DefsStdTemplateHeader}} | | {{User:Alistaire/Template:DefsStdTemplateHeader}} | ||
{{User:Alistaire/Template:DefsStdTemplate}} | {{User:Alistaire/Template:DefsStdTemplate}} | ||
| + | |} | ||
| + | |- | ||
| + | | <pre>{{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|Defs}}}} | ||
| + | {{User:Alistaire/Template:DefsStdTemplate|tag=defName|contents=string|notes=The in-script defName of this thing, referenced by recipes for example.}} | ||
| + | {{User:Alistaire/Template:DefsStdTemplate|attribute=Name|contents=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|contents=string|notes=The in-script defName of this thing, referenced by recipes for example.}} | ||
| + | {{User:Alistaire/Template:DefsStdTemplate|attribute=Name|contents=bool|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}} | ||
|} | |} | ||
|- | |- | ||
|} | |} | ||
Revision as of 13:34, 12 April 2015
Example documentation
Parameters
| Parameter | Explanation |
|---|---|
| attribute | (required1): The attribute, e.g <parent attribute=""/>, you are describing in this row. |
| attributeLink | (optional1): If the attribute name isn't the same as the page you want to link to, use this parameter to choose the right link. |
| contents | (required): A User:Alistaire/Template:DefsStdContentSwitch -style content name. Accepted values are shown on the template page. |
| 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. |
| tagLink | (optional1): If the tag name isn't the same as the page you want to link to, use this parameter to choose the right link. |
- One of attribute/attributeLink and tag/tagLink 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|contents=string|notes=The in-script defName of this thing, referenced by recipes for example.}}
{{User:Alistaire/Template:DefsStdTemplate|attribute=Name|contents=bool|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}}
|}
|
Parents: <>ThingDefs
| ||||||||||||