编辑“Template:Terrain requirement/doc”

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
    <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
This template can be used for displaying terrain requirements for buildings. Use this template for consistent, easier to update styling between different buildings.
<div class="toclimit-3">__TOC__</div>
== Parameters ==
{| class="wikitable"
! Parameter
! Optional?
! Description
|-
! any
| Optional (default: no)
| When set to "yes", will force the template to display a sentence stating that the building may be built in any terrain.
|-
! mode
| Optional (default: table)
| Sets the formatting of the terrain requirements. Currently supports two modes: "table", with the terrain requirements shown in a yes/no table for each terrain type; and "sentence", with the terrain requirements shown in sentence form. As a guideline, use "sentence" instead of "table" if it would ease readability, such as when the building may only be built in one or two terrain types. If "any" is set to yes, or if all terrain parameters are equal to "yes", the mode does not change the formatting of the template output.
|-
! <terrain>
| Optional (default: no for each terrain)
| There is a parameter for each terrain type. [[#Accepted terrain parameters|See below]] for accepted terrain types. If set to "yes", the building may be built in the corresponding terrain. If all available terrain types are set to "yes", the result is identical to having the "any" parameter set to "yes".
|}

=== Accepted terrain parameters ===
The following parameters may be used to define terrain requirements for the building:
{| class="wikitable"
! Parameter
! Terrain type
|-
| desert
| {{iconify|Desert}}
|-
| desert mountains
| {{iconify|Desert Mountains}}
|-
| drylands
| {{iconify|Drylands}}
|-
| farmlands
| {{iconify|Farmlands}}
|-
| floodplains
| {{iconify|Floodplains}}
|-
| forest
| {{iconify|Forest}}
|-
| hills
| {{iconify|Hills}}
|-
| jungle
| {{iconify|Jungle}}
|-
| mountains
| {{iconify|Mountains}}
|-
| oasis
| {{iconify|Oasis}}
|-
| plains
| {{iconify|Plains}}
|-
| steppe
| {{iconify|Steppe}}
|-
| taiga
| {{iconify|Taiga}}
|-
| wetlands
| {{iconify|Wetlands}}
|}

== Usage ==
; Syntax
: <code><nowiki>{{terrain requirement|any=yes/no|mode=table/sentence|<terrain>=yes/no...}}</nowiki></code>

=== Examples ===
==== Tables (default) ====
{| class="wikitable"
!
! One terrain type
! Two terrain types
! Three terrain types
|-
! Syntax
| <code><nowiki>{{terrain requirement|desert=yes}}</nowiki></code>
| <code><nowiki>{{terrain requirement|desert=yes|mountains=yes}}</nowiki></code>
| <code><nowiki>{{terrain requirement|desert=yes|mountains=yes|steppe=yes}}</nowiki></code>
|-
! Example
| {{Terrain requirement|desert=yes}}
| {{Terrain requirement|desert=yes|mountains=yes}}
| {{Terrain requirement|desert=yes|mountains=yes|steppe=yes}}
|}
==== Sentences ====
{| class="wikitable"
!
! One terrain type
! Two terrain types
! Three terrain types
|-
! Syntax
| <code><nowiki>{{terrain requirement|mode=sentence|desert=yes}}</nowiki></code>
| <code><nowiki>{{terrain requirement|mode=sentence|desert=yes|mountains=yes}}</nowiki></code>
| <code><nowiki>{{terrain requirement|mode=sentence|desert=yes|mountains=yes|steppe=yes}}</nowiki></code>
|-
! Example
| {{Terrain requirement|mode=sentence|desert=yes}}
| {{Terrain requirement|mode=sentence|desert=yes|mountains=yes}}
| {{Terrain requirement|mode=sentence|desert=yes|mountains=yes|steppe=yes}}
|}
==== All terrain ====
; Syntax
: <code><nowiki>{{terrain requirement|any=yes}}</nowiki></code>
: ''or''
: <code><nowiki>{{terrain requirement|desert=yes|...|wetlands=yes}}</nowiki></code>
; Result
: {{Terrain requirement|any=yes}}

== Subtemplates ==
* [[Template:Terrain requirement/Table|Table]]
* [[Template:Terrain requirement/Row|Row]]
* [[Template:Terrain requirement/Any terrain|Any terrain]]

== See also ==
* [[Template:Sentence list]]