Template:Service award doc/doc

Usage

This documentation template is used to document various templates in Category:Service award templates.

{{Service award doc|AWARD NAME|type=TYPE
 | root=ROOT TEMPLATE
 | incremental=YESNO
 | defaultsize=SIZE
}}

The one unnamed parameter is required. This gives the name of the award displayed by the template being documented.

There are also a number of optional named parameters:

• type: The format of the award: userbox, ribbon or image. This affects which parameters are shown in the documentation. The default is image.
• root: The base name for the template being documented, without the Template: prefix or any Userbox or Ribbon suffix. This is used to add links to related templates (e.g. from an image template to the corresponding userbox and ribbon templates). For example, if the template being documented is Template:Apprentice Editor Userbox, specify root=Apprentice Editor. If unspecified, the name of the template being documented is used. This parameter is not used if incremental= is set to yes.
• incremental: If set to yes, the wording of the documentation is modified to be suitable for an incremental service award.
• defaultsize: The default value for the template's size= parameter. If not specified, the generated documentation will say the default is frame if the type is image, or 45px if the type is userbox. This parameter is presently ignored for ribbons.

See also

• Category:Service award templates