Template:Administrative service award doc/doc

This is a documentation subpage for Template:Administrative service award doc.
It may contain usage information, categories and other content that is not part of the original template page.

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

{{Administrative service award doc
 | AWARD NAME
 | type=TYPE
 | root=ROOT TEMPLATE
}}

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: image, ribbon, topicon, or userbox. 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 Ribbon, Topicon, or Userbox suffix. This is used to add links to related templates (e.g. from an image template to the corresponding ribbon, topicon, and userbox templates). For example, if the template being documented is Template:New Administrator Ribbon, specify root=New Administrator. If unspecified, the name of the template being documented is used.