View source for Template:Service awards/compose/doc

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

This is the {{tl|Service awards/compose}} sub-template.

This template is called by {{tl|Service awards/core}}. Do not use this template directly; use {{tl|Service awards}} instead.

===Purpose===
This template is used by {{tlf|Service awards/core}} to display a service award based on parameters that describe the award.

This code is separate from the main {{tlf|Service awards}} template to make the template easier to understand and less work for MediaWiki to parse.

===Parameters===
{| class="wikitable"
|-
! Parameter     !! Definition
|-
| format        || The display format to use (passed from {{tlf|Service awards}}).
|-
| size          || Image size (passed from {{tlf|Service awards}}).
|-
| align         || Image alignment (passed from {{tlf|Service awards}}).
|-
| medal         || The name of the template for the medal award. 'Userbox' and 'Ribbon' variants of this template should also exist.
|-
| medalarticle  || Word to use before the name of the medal award: ''a'' or ''an''. Default is ''a''. Can also be blank for no word.
|-
| medaltext     || Displayed name of the medal award if different from the medal parameter.
|-
| medalaward    || Description of the medal associated with this award.
|-
| medalimg      || Filename of the medal image for this award (without the ''File:'' prefix).
|-
| book          || The name of the template for the book award. A 'Userbox' variant of this template should also exist.
|-
| bookarticle   || Word to use before the name of the book award: ''a'' or ''an''. Default is ''a''. Can also be blank for no word.
|-
| booktext      || Displayed name of the book award if different from the book parameter.
|-
| bookaward     || Description of the book associated with this award.
|-
| bookimg       || Filename of the book image for this award (without the ''File:'' prefix).
|-
| minirib       || Filename of the small ribbon image for this award (without the ''File:'' prefix).
|-
| ribbon2       || Filename of the ribbon option #2 image for this award (without the ''File:'' prefix).
|-
| caption1      || Caption customisation (passed from {{tlf|Service awards}}).
|-
| caption2      || Caption customisation (passed from {{tlf|Service awards}}).
|-
| caption2book  || If specified, this is used instead of caption2 if format is set to 'book' or 'ubxbook'.
|-
| caption3      || Caption customisation (passed from {{tlf|Service awards}}).
|-
| punctuation   || Caption customisation (passed from {{tlf|Service awards}}).
|}

===See also===
* [[Template:Service awards]]
* [[Template:Service awards/select]]

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

</includeonly>