Template:Service awards/doc

Usage

Basic usage

This template allows users to show service awards. To display it, place {{service awards|year=year|month=month|day=day|edits=edits}} on the relevant page where the item in italics is replaced by the relevant value. These parameters are required, and should not be omitted.

The template takes four required parameters:

• |year= – Starting year
• |month= – Starting month
• |day= – Starting day of month
• |edits= – Number of user edits

{{service awards|year=1995|month=1|day=15|edits=2000000}}

This editor is a Sagacious Editor and is entitled to display this Carbonadium Editor Star with the Strangelet Superstar.

Summary of all options

All parameters

Parameter	Definition	Default value
align	Alignment of image	left
caption1	Message shown	This editor is
caption2	Message shown	and is entitled to display this (for most awards – default differs on higher awards)
caption3	Message shown	(blank)
day	Starting day of month	(required - no default)
edits	Number of user edits	(required - no default)
format	Type of template desired	medal
month	Starting month	(required - no default)
punctuation	Message shown	(full stop)
size	Size of image	Images: frame (varies for some awards where frame gives too large an award) Small ribbons: 72px Ribbon option #2: 120px Userboxes: 45px Topicon: 48px
year	Starting year	(required - no default)
noinc	If the incremental awards are not displayed	no

Display format

The |format= parameter is used to specify the type of template displayed. Most users will want to use one of the standard format values. There are also some special formats that allow you to put together your own custom format.

Standard formats

Standard format values

Parameter value	Format
medal	Medal image (the default)
ubxmedal	Medal userbox
book	Book image
ubxbook	Book userbox
ribbon	Standard ribbon image
ribbon2	Alternative ribbon image (doesn't support Registered Editor / Signator, nor any awards above Senior Editor II / Most Pluperfect Labutnum)
smlribbon	Small ribbon image
topicon	Top icon (page status indicator)

Examples of standard formats

This editor is a Sagacious Editor and is entitled to display this Carbonadium Editor Star with the Strangelet Superstar. {{service awards | year=1995 | month=1 | day=15 | edits=2000000 | format=medal}}

This editor is an Ephoros of the Encyclopedia and is entitled to display this floor plan of the The Great Library of Alecyclopedias, signed by Jimbo with a silver marker, and including its cardboard carrying tube and magnifying glass. {{service awards | year=1995 | month=1 | day=15 | edits=2000000 | format=book | size=upright}}

This editor is a Sagacious Editor and is entitled to display this Carbonadium Editor Star with the Strangelet Superstar. {{service awards|year=1995|month=1|day=15|edits=2000000|format=ubxmedal}}

This editor is an Ephoros of the Encyclopedia and is entitled to display this floor plan of the The Great Library of Alecyclopedias, signed by Jimbo with a silver marker, and including its cardboard carrying tube and magnifying glass. {{service awards|year=1995|month=1|day=15|edits=2000000|format=ubxbook}}

Sagacious Editor {{service awards | year=1995 | month=1 | day=15 | edits=2000000 | format=ribbon}}

Ephoros of the Encyclopedia {{service awards | year=1995 | month=1 | day=15 | edits=2000000 | format=ribbon2}}

Sagacious Editor {{service awards|year=1995|month=1|day=15|edits=2000000|format=smlribbon}}

(displayed in upper right of page) {{service awards|year=1995|month=1|day=15|edits=2000000|format=topicon}}

Custom formats

You can create your own format by combining the name, description and image of an award in any way you like. The |format= parameter values shown below allow you to fetch these parts of an award on their own. Transclude the {{service awards}} template multiple times to fetch multiple elements, arranged how you like.

Custom format values

Parameter value	Format	Example
namebook	Award name, using the book naming scheme	an Ephoros of the EncyclopediaEphoros
namemedal	Award name, using the medal naming scheme	a Sagacious Editor
awardbook	Description of the book awardees are entitled to display	floor plan of the The Great Library of Alecyclopedias, signed by Jimbo with a silver marker, and including its cardboard carrying tube and magnifying glass
awardmedal	Description of the medal awardees are entitled to display	Carbonadium Editor Star with the Strangelet Superstar
imgbook	Image filename of the book awardees are entitled to display	Ephoros.jpg
imgmedal	Image filename of the medal awardees are entitled to display	Sagacious star.png
imgsmlrib	Image filename of small ribbon awardees are entitled to display	Editorrib23.svg

For example:

{| style="border: 2px solid black; width: 300px"
|-
| [[File:{{service awards|year=1995|month=1|day=15|edits=2000000|format=imgmedal}}<!--
--> | thumbnail | 110px <!--
--> | {{service awards|year=1995|month=1|day=15|edits=2000000|format=awardmedal}}]]
|
So what's that medal for? That's my service award&#160;– I'm
{{service awards|year=1995|month=1|day=15|edits=2000000|format=namemedal}}!
|}

Carbonadium Editor Star with the Strangelet Superstar

So what's that medal for? That's my service award – I'm a Sagacious Editor!

Image alignment

Use the align parameter to specify the location of the template. It can only be used with the medal, book, ribbon, ribbon2 and smlribbon formats.

|align= values

Parameter value	Alignment
left	Left, with text wrapping around the right side
center	Centered
right	Right, with text wrapping around the left side

{{service awards|year=1995|month=1|day=15|edits=2000000|align=left}}

This editor is a Sagacious Editor and is entitled to display this Carbonadium Editor Star with the Strangelet Superstar.

{{service awards|year=1995|month=1|day=15|edits=2000000|align=center}}

This editor is a Sagacious Editor and is entitled to display this Carbonadium Editor Star with the Strangelet Superstar.

{{service awards|year=1995|month=1|day=15|edits=2000000|align=right}}

This editor is a Sagacious Editor and is entitled to display this Carbonadium Editor Star with the Strangelet Superstar.

Image size

For the image-with-caption award formats, the size parameter specifies whether to include the frame and caption, and/or change the image size. The frame and caption are shown by default for the image awards, but are omitted for ribbons. Userboxes have a separate frame and caption that the size parameter does not control. The size parameter is ignored for the ribbon format, though it works for the ribbon2 and smlribbon formats.

Small ribbons default to 72 pixels wide; other ribbons default to 120 pixels wide. The image on userboxes defaults to 45 pixels wide. The default width for the image formats depends upon the award.

Some example uses of size=:

size=NNpx

Display the image at the specified width, selecting the best height to maintain the image proportions.

size=xNNpx

Display the image at the specified height, selecting the best width to maintain the image proportions.

For the topicon format, the size parameter specifies the width of the top icon. Any non-numeric characters are ignored. The height is capped to 20 pixels by the top icon template. The default of 48px results in an image that is 48 pixels wide by 20 pixels tall. Set this to 20px to keep the top icon the same width as a standard 20px×20px top icon.

Caption customisation

The caption on the template can be customised using these parameters. The caption has two auto updating sections: one for the editor's title and one for the editor's award. The three caption parameters specify the text either side of these auto updating sections and the punctuation parameter specifies what punctuation character to use at the end of the caption.

Caption customisation parameters

Parameter	Definition	Default value
caption1	Message on template	This editor is
caption2	Message on template	and is entitled to display this
caption3	Message on template	(blank)
punctuation	Message on template	(full stop)

Example:

{{service awards
 | year=1995
 | month=1
 | day=15
 | edits=2000000
 | caption1=Hello everyone, I'm
 | caption2=and I'm now going to show off my
 | caption3=to the whole world
 | punctuation=!!!}}

Gives:

Hello everyone, I'm a Sagacious Editor and I'm now going to show off my Carbonadium Editor Star with the Strangelet Superstar to the whole world!!!

Note: the caption and punctuation parameters will have no effect on the ribbon formats and therefore these parameters should be left out (not blank) if one of these formats is selected.

Technical details

Internally, this template uses the following sub-templates:

• /compose: Displays an award as described by various parameters.
• /core: Displays the award for the specified level (0-22) by calling /compose with the appropriate parameters. Edit this template to change the template names or text displayed for each award.
• /select: Determines which level of award to display, based on the length of service and number of edits. Edit this template to change the award requirements.

Template Data

Display a Service Award automatically based on editor's starting date and number of edits.

Template parameters

Parameter		Description	Type	Status
Year	year	Starting year Example 1995	Number	required
Month	month	Starting month Example 1	Number	required
Day	day	Starting day of the month Example 15	Number	required
Edits	edits	Number of user edits Example 2000000	Number	required
Format	format	Type of template desired Suggested values medal ubxmedal book ubxbook ribbon ribbon2 smlribbon topicon namebook namemedal awardbook awardmedal imgbook imgmedal imgsmlrib Default medal	String	suggested
Align	align	Alignment of image (left, center, or right) Suggested values left center right Default left	String	optional
Caption 1	caption1	First part of message shown Default This editor is	String	optional
Caption 2	caption2	Second part of message shown. The default is for most awards – it differs on higher awards Default and is entitled to display this	String	optional
Caption 3	caption3	Third part of message shown Default	String	optional
Punctuation	punctuation	Punctuation at end of message Default .	String	optional
Size	size	Size of image (##px, x##px). Default is for Small ribbons. Ribbon option default to 120px, Userboxes to 45px, and Topicons to 48px Default 72px	String	optional
No Incremental Awards	noinc	Incremental awards are not shown where they are available ''(Topicons)'' Default no	Boolean	optional
No Categories	nocat	no description	Boolean	optional
sortkey	sortkey	no description	String	optional

See also

• {{Service award progress}}
• {{SA user topicon}}
• Lists of Wikipedians by number of edits