Template:Service award doc/doc
 | This is a documentation subpage for Template:Service award doc. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This documentation template is used to document various templates in Category:Service award templates.
<syntaxhighlight lang="wikitext"> Place this template on your user page to indicate that you have awarded yourself the AWARD NAME service award. Service awards are awards that you give to yourself for length of service and number of edits on Wikipedia.
Basic usage
To simply show this award on your user page, just place the template's name between double braces:
{{Service award doc}}
Parameters
The award's appearance can be customized using parameters:
{{Service award doc
|align=|caption=
}}
- align: Set where to display the award on the page. This can be left or right to float the image to the appropriate side of the screen, with text wrapping around it. Use center to center the image, with space on either side of it. The default is left.
- caption: Use the specified caption for the award. A default caption is used if this is omitted.
See also
</syntaxhighlight>
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 ifincremental=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