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

From RimWorld Wiki
Jump to navigation Jump to search
(Testing documentation)
 
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Example documentation<br/><br/>
 
Example documentation<br/><br/>
 +
 +
==Parameters==
 +
 +
{|
 +
! Parameter !! Explanation
 +
|-
 +
| showExamples || ''(optional):'' If it exists, shows an Examples column.
 +
|-
 +
| hideParents || ''(optional):'' If it exists, hides the "Parents:" section.
 +
|-
 +
| hideNotes || ''(optional):'' If it exists, hides the Notes column.
 +
|-
 +
| parents || ''(required):'' A list of [[User:Alistaire/Template:DefsStdFormatter]] -type links to this tag's parents.
 +
|-
 +
| tag || ''(optional, default: PAGENAME):'' What tag to display on the first row.
 +
|-
 +
| link || ''(optional):'' What the tag links to, if that is different from the name itself.
 +
|-
 +
|
 +
|}<br/><br/>
  
 
==Examples==
 
==Examples==
  
 
{|
 
{|
−
| {{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef}}
+
! Input !! Output
 +
|-
 +
|<pre>{{User:Alistaire/Template:DefsStdTemplateHeader}}
 +
|-
 +
|}</pre>
 +
| .<nowiki>{{User:Alistaire/Template:DefsStdTemplateHeader}}
 +
|-
 +
|}</nowiki>
 +
|-
 +
|<pre>{{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|Defs}}|showExamples=1}}
 +
|-
 +
|}</pre>
 +
|{{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|thingDef}}|showExamples=1}}
 
|-
 
|-
−
|
 
 
|}
 
|}
 +
|-
 +
|<pre>{{User:Alistaire/Template:DefsStdTemplateHeader|tag=biomeDef|hideParents=1}}
 +
|-
 +
|}</pre>
 +
|{{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|hideParents=1}}
 +
|-
 +
|}
 +
|-
 +
|}<br/><br/>
 +
 +
==See also==
 +
 +
*[[User:Alistaire/Template:DefsStdTemplate]]

Latest revision as of 23:48, 4 April 2023

Example documentation

Parameters[edit]

Parameter Explanation
showExamples (optional): If it exists, shows an Examples column.
hideParents (optional): If it exists, hides the "Parents:" section.
hideNotes (optional): If it exists, hides the Notes column.
parents (required): A list of User:Alistaire/Template:DefsStdFormatter -type links to this tag's parents.
tag (optional, default: PAGENAME): What tag to display on the first row.
link (optional): What the tag links to, if that is different from the name itself.



Examples[edit]

Input Output 
{{User:Alistaire/Template:DefsStdTemplateHeader}}
|-
|}
 .{{User:Alistaire/Template:DefsStdTemplateHeader}} |- |} 
{{User:Alistaire/Template:DefsStdTemplateHeader|tag=thingDef|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|Defs}}|showExamples=1}}
|-
|}
 Parents: <>ThingDefs
<>thingDef
Element Contents Notes Examples 
{{User:Alistaire/Template:DefsStdTemplateHeader|tag=biomeDef|hideParents=1}}
|-
|}
<>thingDef
Element Contents Notes



See also[edit]

Retrieved from "https://rimworldwiki.com/index.php?title=User:Alistaire/Template:DefsStdTemplateHeader/doc&oldid=132895"