Difference between revisions of "Template:Variable table documentation"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(creating a set of templates to format variable tables in a uniform manner)
 
(update documentation)
 
Line 11: Line 11:
 
<pre>
 
<pre>
 
{{Variable table start}}
 
{{Variable table start}}
−
{{Variable table row| AREA_WORLD_MAP_ENABLED | int | | If this is set to 1, the party can switch to travel on the world map at any point within the area. | }}
+
{{Variable table row| AREA_WORLD_MAP_ENABLED | int | | If this is set to 1, the party can switch to travel on the world map at any point within the area. }}
−
{{Variable table row| ENTERED_FOR_THE_FIRST_TIME | int | | Defaults to false. If false, set true when an area is first entered and exploration XP is awarded.}}
+
{{Variable table row| ENTERED_FOR_THE_FIRST_TIME | int | FALSE | If false, set true when an area is first entered and exploration XP is awarded.}}
 
{{Variable table end}}
 
{{Variable table end}}
 
</pre>
 
</pre>
Line 19: Line 19:
  
 
{{Variable table start}}
 
{{Variable table start}}
−
{{Variable table row| AREA_WORLD_MAP_ENABLED | int | | If this is set to 1, the party can switch to travel on the world map at any point within the area. | }}
+
{{Variable table row| AREA_WORLD_MAP_ENABLED | int | | If this is set to 1, the party can switch to travel on the world map at any point within the area. }}
 
{{Variable table row| ENTERED_FOR_THE_FIRST_TIME | int | FALSE | If false, set true when an area is first entered and exploration XP is awarded.}}
 
{{Variable table row| ENTERED_FOR_THE_FIRST_TIME | int | FALSE | If false, set true when an area is first entered and exploration XP is awarded.}}
 
{{Variable table end}}
 
{{Variable table end}}
 +
 +
Alternately, you could use named parameters like so:
 +
 +
<pre>
 +
{{Variable table start}}
 +
{{Variable table row
 +
|name= AREA_WORLD_MAP_ENABLED
 +
|type= int
 +
|default=
 +
|description= If this is set to 1, the party can switch to travel on the world map at any point within the area.
 +
}}
 +
{{Variable table row
 +
|name= ENTERED_FOR_THE_FIRST_TIME
 +
|type= int
 +
|default= FALSE
 +
|description= If false, set true when an area is first entered and exploration XP is awarded.
 +
}}
 +
{{Variable table end}}
 +
</pre>
 +
 +
Produces:
 +
 +
{{Variable table start}}
 +
{{Variable table row
 +
|name= AREA_WORLD_MAP_ENABLED
 +
|type= int
 +
|default=
 +
|description= If this is set to 1, the party can switch to travel on the world map at any point within the area.
 +
}}
 +
{{Variable table row
 +
|name= ENTERED_FOR_THE_FIRST_TIME
 +
|type= int
 +
|default= FALSE
 +
|description= If false, set true when an area is first entered and exploration XP is awarded.
 +
}}
 +
{{Variable table end}}
 +
 +
Here's a blank set of templates to copy and paste:
 +
 +
<pre>
 +
{{Variable table start}}
 +
{{Variable table row
 +
|name=
 +
|type=
 +
|default=
 +
|description=
 +
}}
 +
{{Variable table end}}
 +
</pre>
  
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Formatting templates]]</includeonly>
 
<includeonly>[[Category:Formatting templates]]</includeonly>

Latest revision as of 23:12, 17 July 2009

This template set includes the following templates:

It's intended to allow uniform formatting of variable tables for documentation purposes.

For exmample, the following set of templates: 

{{Variable table start}}
{{Variable table row| AREA_WORLD_MAP_ENABLED | int | | If this is set to 1, the party can switch to travel on the world map at any point within the area. }}
{{Variable table row| ENTERED_FOR_THE_FIRST_TIME | int | FALSE | If false, set true when an area is first entered and exploration XP is awarded.}}
{{Variable table end}}

Produces:

Variable name Type Default Description
AREA_WORLD_MAP_ENABLED int If this is set to 1, the party can switch to travel on the world map at any point within the area.
ENTERED_FOR_THE_FIRST_TIME int FALSE If false, set true when an area is first entered and exploration XP is awarded.

Alternately, you could use named parameters like so: 

{{Variable table start}}
{{Variable table row
|name= AREA_WORLD_MAP_ENABLED
|type= int
|default=
|description= If this is set to 1, the party can switch to travel on the world map at any point within the area.
}}
{{Variable table row
|name= ENTERED_FOR_THE_FIRST_TIME
|type= int
|default= FALSE
|description= If false, set true when an area is first entered and exploration XP is awarded.
}}
{{Variable table end}}

Produces:

Variable name Type Default Description
AREA_WORLD_MAP_ENABLED int If this is set to 1, the party can switch to travel on the world map at any point within the area.
ENTERED_FOR_THE_FIRST_TIME int FALSE If false, set true when an area is first entered and exploration XP is awarded.

Here's a blank set of templates to copy and paste: 

{{Variable table start}}
{{Variable table row
|name= 
|type= 
|default=
|description= 
}}
{{Variable table end}}
Retrieved from "http://datoolset.net/mw/index.php?title=Template:Variable_table_documentation&oldid=1269"