Difference between revisions of "User:Alistaire/Template:DefsStdTemplate/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(Changed examples, added newlines to fix how much the <pre> takes in of the page)
(Updated parameters)
Line 8: Line 8:
 
| 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.
 
|-
 
|-
−
| attributeLink || ''(optional<sup>1</sup>):'' 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.
 
|-
 
|-
−
| contents || ''(required):'' A [[User:Alistaire/Template:DefsStdContentSwitch]] -style content name. Accepted values are shown on the template page.
+
| link || ''(optional):'' Overwrites what attribute/tag links to.
 
|-
 
|-
 
| notes || ''(required):'' An explanation on the tag/attribute described in this row.
 
| 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.
 
| tag || ''(required<sup>1</sup>):'' The tag, e.g <parent><tag/></parent>, you are describing in this row.
−
|-
 
−
| 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>
 
|}</br>
  
−
# One of attribute/attributeLink and tag/tagLink is shown.<br/><br/>
+
# Only one of attribute and tag is shown.<br/><br/>
  
 
==Examples==
 
==Examples==

Revision as of 14:00, 12 April 2015

Example documentation

Parameters

Parameter Explanation
attribute (required1): The attribute, e.g <parent attribute=""/>, you are describing in this row.
contents (required): A User:Alistaire/Template:DefsStdContentSwitch -style content name. Accepted values are shown on the template page.
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.


  1. Only one of attribute and tag is shown.

Examples

Input Output 
{{User:Alistaire/Template:DefsStdTemplateHeader}}
{{User:Alistaire/Template:DefsStdTemplate}}
|}
 Parents: none specified
<>Alistaire/Template:DefsStdTemplate/doc
Element Contents Notes
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
<>thingDef
Element Contents Notes
<>defName string The in-script defName of this thing, referenced by recipes for example.
@Name bool The tag's Name that other tags have to reference to with ParentName to get the same contents.
Retrieved from "https://rimworldwiki.com/index.php?title=User:Alistaire/Template:DefsStdTemplate/doc&oldid=34902"