Template:Tag: Difference between revisions
From Spring
Jump to navigationJump to search
m removed visibility of special variable. |
updated examples. cleaned up default values. |
||
| Line 1: | Line 1: | ||
<includeonly> | <includeonly> | ||
; <span style="color:#cccccc;text-shadow: #111 2px 2px 2px;">{{{name| | ; <span style="color:#cccccc;text-shadow: #111 2px 2px 2px;">{{{name|name}}}</span> <span style="color:#00ff88">{{{type|type}}}</span> {{{range|}}} <span style="color:#ffff88"><b>{{{special|}}}</b></span> : <span style="color:#999999;">Default: {{{default|?}}}</span>, {{{description|description}}}</includeonly><noinclude>A template for documenting various tags used in the engine (gamedata files, defs etc) | ||
'''Usage:''' | |||
<pre>{{tag}}</pre> | |||
result: | |||
{{tag}} | |||
'''Usage:''' | |||
<pre>{{tag|name=foo|type=int|range=[0-100]|special=Required|default=10|description=Then type your description}}</pre> | |||
Result: | |||
{{tag|name=foo|type=int|range=[0-100]|special=Required|default=10|description=Then type your description}} | |||
'''Usage:''' | |||
<pre>{{tag|name=foo|type=int|default=10|description=Then type your description}}</pre> | <pre>{{tag|name=foo|type=int|default=10|description=Then type your description}}</pre> | ||
Result: | |||
{{tag|name=foo|type=int|default=10|description=Then type your description}} | |||
'''Usage:''' | |||
<pre>{{tag | <pre>{{tag | ||
|name = bar | |name = bar | ||
| Line 15: | Line 23: | ||
|default = 3.14 | |default = 3.14 | ||
|description = Then your description}}</pre> | |description = Then your description}}</pre> | ||
Result: | Result: | ||
{{tag | {{tag | ||
|name = bar | |name = bar | ||
|type = float | |type = float | ||
|range = [0-100] | |||
|special = Required | |||
|default = 3.14 | |default = 3.14 | ||
|description = Then your description}} | |description = Then your description}} | ||
</noinclude> | </noinclude> | ||
Revision as of 13:20, 3 June 2012
A template for documenting various tags used in the engine (gamedata files, defs etc)
Usage:
{{tag}}
result:
- name type
- Default: ?, description
Usage:
{{tag|name=foo|type=int|range=[0-100]|special=Required|default=10|description=Then type your description}}
Result:
- foo int [0-100] Required
- Default: 10, Then type your description
Usage:
{{tag|name=foo|type=int|default=10|description=Then type your description}}
Result:
- foo int
- Default: 10, Then type your description
Usage:
{{tag
|name = bar
|type = float
|range = [0-100]
|special = Required
|default = 3.14
|description = Then your description}}
Result:
- bar float [0-100] Required
- Default: 3.14, Then your description
