View source for Template:Golf18/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

= Usage =
The '''{{tl|Golf18}}''' template creates a table header for an 18-hole [[golf course]] scorecard. Additional rows are added to the table to show par for each hole, to show the hole [[Stroke Index]] and to show the yardages for each [[teeing ground|tee]]. The set of templates used to create a golf scorecard are:

{| border="1" cellpadding="5"
!width="100"|Template!! Default appearance !! What it does
|-
| {{tl|Golf18}}
|style="background:darkkhaki; color:black;"|'''[[Teeing ground|Tee]]'''
| Creates the table header and hole list.
|-
| {{tl|Par18}}
|style="background:khaki; color:black;"|'''Par'''
| Lists par for each hole, for each side of 9 holes and the total for 18 holes.
|-
| {{tl|Handicap18}}
|style="background:khaki; color:black;"|'''[[Stroke Index|SI]]'''
| Lists the Stroke Index for each hole.
|-
| {{tl|Tee18}}
|style="background:white; color:black;"|'''''Name'''''
| Generic template for a set of tees. It lists the [[Golf handicap#Course rating|rating/slope]] for the tee and the yardage for each hole, for each side of 9 holes and the total for 18 holes. Typically, however, one of the templates based on tee color listed below are used instead of the generic template.
|-
| {{tl|Black18}}
|style="background:black;       color:white"| '''Black'''
|rowspan=8| Colored templates for each of the common colors for tee markers.
|-
| {{tl|Blue18}}
|style="background:blue;        color:white"| '''Blue'''
|-
| {{tl|White18}}
|style="background:white;       color:black"| '''White'''
|-
| {{tl|Yellow18}}
|style="background:yellow;      color:black"| '''Yellow'''
|-
| {{tl|Red18}}
|style="background:red;         color:white"| '''Red'''
|-
| {{tl|Green18}}
|style="background:forestgreen; color:white"| '''Green'''
|-
| {{tl|Gold18}}
|style="background:gold;        color:black"| '''Gold'''
|-
| {{tl|Silver18}}
|style="background:silver;      color:black"| '''Silver'''
|-
| {{tl|End18}}
|
| Ends the table
|}

== Example ==

The following templates are an illustration of usage:

<syntaxhighlight lang="wikitext">
{{Golf18|center=true|title=South Course}}
{{par18                 | 4 | 4 | 3 | 4 | 4 | 5 | 4 | 3 | 5 | 36 | 4 | 3 | 4 | 5 | 4 | 4 | 3 | 4 | 5 | 36 | 72 }}
{{handicap18|name=Men's  | 5 | 15| 13| 3 | 11| 9 | 1 | 17| 7 |      16| 14| 2 | 6 | 8 | 12| 18| 4 | 10          }}
{{blue18   |78.1 / 143 |452|387|198|483|453|560|462|176|613|3784|405|221|504|541|435|477|227|442|571|3823|7607}}
{{tee18|Brown|bcolor=brown|tcolor=white|76.1 / 139 |444|362|160|471|404|530|442|164|590|3567|376|203|477|539|417|462|206|429|551|3660|7227}}
{{white18   |74.3 / 136 |432|347|149|460|393|518|434|154|535|3422|362|193|456|521|404|392|192|419|524|3463|6885}}
{{green18   |rssize=8pt |M:72.5/133 W:79.2/138
|                        417|332|134|445|378|503|419|139|520|3287|347|178|441|506|389|377|177|404|509|3327|6615}}
{{par18                 | 4 | 4 | 3 | 4 | 4 | 5 | 4 | 3 | 5 | 36 | 4 | 3 | 5 | 5 | 4 | 4 | 3 | 4 | 5 | 37 | 73 }}
{{handicap18|name=Women's| 7 | 13| 15| 9 | 11| 1 | 5 | 17| 3 |      10| 18| 2 | 6 | 14| 16| 12| 8 | 4           }}
{{red18     |73.5 / 128 |368|281|113|388|324|452|381| 96|432|2835|299|105|394|408|276|286|176|347|416|2707|5542}}
{{end18}}
</syntaxhighlight>

The {{tl|Golf18}} template creates the table header. Each line in the table is created by one of the other templates. The end of the scorecard is marked by a line that starts with <code>|}</code> to finish the table. Together these templates create:

{{Golf18|center=true|title=South Course}}
{{par18                 | 4 | 4 | 3 | 4 | 4 | 5 | 4 | 3 | 5 | 36 | 4 | 3 | 4 | 5 | 4 | 4 | 3 | 4 | 5 | 36 | 72 }}
{{handicap18|name=Men's  | 5 | 15| 13| 3 | 11| 9 | 1 | 17| 7 |      16| 14| 2 | 6 | 8 | 12| 18| 4 | 10          }}
{{black18   |78.1 / 143 |452|387|198|483|453|560|462|176|613|3784|405|221|504|541|435|477|227|442|571|3823|7607}}
{{tee18|Brown|bcolor=brown|tcolor=white|76.1 / 139 |444|362|160|471|404|530|442|164|590|3567|376|203|477|539|417|462|206|429|551|3660|7227}}
{{white18   |74.3 / 136 |432|347|149|460|393|518|434|154|535|3422|362|193|456|521|404|392|192|419|524|3463|6885}}
{{green18   |rssize=8pt |M:72.5/133 W:79.2/138
|                        417|332|134|445|378|503|419|139|520|3287|347|178|441|506|389|377|177|404|509|3327|6615}}
{{par18                 | 4 | 4 | 3 | 4 | 4 | 5 | 4 | 3 | 5 | 36 | 4 | 3 | 5 | 5 | 4 | 4 | 3 | 4 | 5 | 37 | 73 }}
{{handicap18|name=Women's| 7 | 13| 15| 9 | 11| 1 | 5 | 17| 3 |      10| 18| 2 | 6 | 14| 16| 12| 8 | 4           }}
{{red18     |73.5 / 128 |368|281|113|388|324|452|381| 96|432|2835|299|105|394|408|276|286|176|347|416|2707|5542}}
{{end18}}

== Parameters ==

=== Required parameters ===

All required parameters are determined by position only&mdash;there is no name (e.g. no <code>name=value</code> form) associated with a required parameter.

;{{tl|Golf18}}
:No required parameters.

;{{tl|Par18}}
:The par for holes 1&ndash;9, followed by the par for the front 9, followed by the par for holes 10&ndash;18, followed by the par for the back 9, followed by the par for all 18 holes.  (21 parameters)

;{{tl|Handicap18}}
:The Stroke Indexes for holes 1&ndash;18. (18 parameters)

;{{tl|Tee18}}
:The name of the tee (e.g. '''Regular''' or '''Blue'''), followed by the slope/rating, followed by the yardages for holes 1&ndash;9, followed by the yardage for the front 9, followed by the yardages for holes 10&ndash;18, followed by the yardage for the back 9, followed by the yardage for all 18 holes.

;{{tl|Black18}} {{tl|Blue18}} {{tl|White18}} {{tl|Yellow18}} {{tl|Red18}} {{tl|Green18}} {{tl|Gold18}} {{tl|Silver18}}
:The slope/rating, followed by the yardages for holes 1&ndash;9, followed by the yardage for the front 9, followed by the yardages for holes 10&ndash;18, followed by the yardage for the back 9, followed by the yardage for all 18 holes.

=== Optional parameters ===

All of the optional parameters are named&mdash;they use the form <code>name=value</code>. The templates support the following optional parameters:

;bcolor  (all templates)
:Overrides the default background color. Example: <code>bcolor=red</code>

;tcolor  (all templates)
:Overrides the default text color. Note that when used with {{tl|Golf18}}, this also sets the default text color for any {{tl|Par18}} and {{tl|Handicap18}} templates in the scorecard. Example: <code>tcolor=white</code>

;rssize  (all templates)
:Overrides the size of the font used to display the rating/slope. When used with {{tl|Golf18}}, this overrides the size of the font in the rating/slope column heading. Note that for {{tl|Par18}} and {{tl|Handicap18}}, there is no rating/slope text unless the optional '''name''' parameter is also provided. Examples: <code>rssize=8pt</code> or <code>rssize=smallest</code>

;name  ({{tl|Black18}}, {{tl|Blue18}}, {{tl|White18}}, {{tl|Yellow18}}, {{tl|Red18}}, {{tl|Green18}}, {{tl|Gold18}},  {{tl|Silver18}}, {{tl|Bronze18}}, and {{tl|Brown18}})
:Overrides the default name of the tee.  (The default name is the name of the tee color.)  Example: <code>name=Championship</code>

;name  ({{tl|Par18}} and {{tl|Handicap18}})
:Provides a name in the rating/slope column to identify either the tee or whether the par/handicap is for men or women. Example: <code>name=Womens</code>

;title  ({{tl|Golf18}})
:The table caption displayed centered over the top of the scorecard. If not specified then no title is displayed. Example: <code>title=South Course</code>

;center  ({{tl|Golf18}})
:A boolean parameter&mdash;if set to a non-empty value, then the table is centered horizontally on the page. Example: <code>center=true</code>

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Golf scorecard templates]]
}}</includeonly>