Jump to content

Template:Admin service awards/doc

From Wikipedia, the free encyclopedia

Basic usage

[edit]

To display the template, just place {{Admin service awards|year=year|month=month|day=day|actions=actions}} 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
  • |actions= – Number of administrative actions

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

"Vanguard Administrator, awarded for being an administrator for at least 16 years and performing at least 62,000 administrative actions"

This editor is a
Vanguard Administrator
and is entitled to display this
Gold Service Badge
and carry the
Gold Keys to the Encyclopedia.

Summary of all options

[edit]
All parameters
Parameter Definition Default value
actions Number of administrative actions performed (required - no default)
align Alignment of image left
day Starting day of month (required - no default)
format Type of template desired medal
month Starting month (required - no default)
nocat Whether user category should be suppressed true
size Size of image

Images: 130px
Ribbons: 120px
Topicons: 48px
Small ribbons: 72px (fixed width)
Userboxes: 45px (fixed width)

sortkey Setting topicon sort order (no default)
year Starting year (required - no default)

Display format

[edit]

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

[edit]
Standard format values
Parameter value Format
medal Medal image (the default)
mop Mop image
ubxmedal Medal userbox
ubxmop Mop userbox
ribbon Standard ribbon image
smlribbon Small ribbon image
topicon Top icon (page status indicator)
Examples of standard formats
"Vanguard Administrator, awarded for being an administrator for at least 16 years and performing at least 62,000 administrative actions"

This editor is a
Vanguard Administrator
and is entitled to display this
Gold Service Badge
and carry the
Gold Keys to the Encyclopedia.
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=medal}}
Error: Template:Quantum Custodian does not exist!
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=mop}}
This editor is a
Vanguard Administrator
and is entitled to display this
Gold Service Badge
and carry the
Gold Keys to the Encyclopedia.
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ubxmedal}}
Error: Template:Quantum Custodian Userbox does not exist!
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ubxmop}}
Vanguard Administrator
Vanguard Administrator
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ribbon}}
Vanguard Administrator
Vanguard Administrator
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=smlribbon}}
This editor is a Vanguard Editor. (displayed in upper right of page)
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=topicon}}

Custom formats

[edit]

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 {{Admin service awards}} template multiple times to fetch multiple elements, arranged how you like.

Custom format values
Parameter value Format Example
namemop Award name, using the mop naming scheme a Quantum Custodian
namemedal Award name, using the medal naming scheme a Vanguard Administrator
awardmop Description of the mop awardees are entitled to display Quantum Mop and Water Bucket, now with 42% Dark Matter
awardmedal Description of the medal awardees are entitled to display Gold Service Badge and Gold Keys to the Encyclopedia
imgmop Image filename of the mop awardees are entitled to display
imgmedal Image filename of the medal awardees are entitled to display Vanguard Admin Medal.svg
imgsmlrib Image filename of small ribbon awardees are entitled to display Adminrib20.svg

For example:

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

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

Image alignment

[edit]

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

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

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

"Vanguard Administrator, awarded for being an administrator for at least 16 years and performing at least 62,000 administrative actions"

This editor is a
Vanguard Administrator
and is entitled to display this
Gold Service Badge
and carry the
Gold Keys to the Encyclopedia.

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

"Vanguard Administrator, awarded for being an administrator for at least 16 years and performing at least 62,000 administrative actions"

This editor is a
Vanguard Administrator
and is entitled to display this
Gold Service Badge
and carry the
Gold Keys to the Encyclopedia.

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

"Vanguard Administrator, awarded for being an administrator for at least 16 years and performing at least 62,000 administrative actions"

This editor is a
Vanguard Administrator
and is entitled to display this
Gold Service Badge
and carry the
Gold Keys to the Encyclopedia.

Image size

[edit]

For the most award formats, the |size= parameter specifies whether to change the image size. The ubxmedal, ubxmop, and smlribbon images have fixed widths (45 pixels for the userbox awards and 72 pixels for the small ribbons). The default image width for the medal and mop formats is 130 pixels, and the default for the ribbon format is 120 pixels wide.

Examples:

size=##px
Display the image at the specified width, selecting the best height to maintain the image proportions (e.g. |size=140px displays the image 140 pixels wide).
size=x##px
Display the image at the specified height, selecting the best width to maintain the image proportions (e.g. |size=x160px displays the image 160 pixels tall).
size=upright=#.##
Display the image as a percentage of your user preference (defaults to 220 pixels wide) while maintaining image proportions (e.g. |size=upright=0.50 displays the image at 50% of the user's preferred thumbnail width).

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.

Technical details

[edit]

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-20) 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

[edit]

Display an Administrative Service Award automatically based on administrator's starting date and number of administrative actions.

Template parameters

ParameterDescriptionTypeStatus
Yearyear

Starting year

Example
1995
Numberrequired
Monthmonth

Starting month

Example
1
Numberrequired
Dayday

Starting day of the month

Example
15
Numberrequired
Actionsactions

Number of administrative actions

Example
2000000
Numberrequired
Formatformat

Type of template desired (medal, ubxmedal, book, ubxbook, ribbon, smlribbon, topicon)

Example
medal
Stringsuggested
Alignalign

Alignment of image (left, center, or right)

Suggested values
left center right
Example
left
Stringoptional
Sizesize

Size of image (##px, x##px, upright=#.##)

Example
72px
Stringoptional
Sortkeysortkey

Indicate sort order of topicons

Example
42
Stringsuggested
Nocatnocat

Indicate whether to add the user to associated categories

Example
true
Booleanoptional

See also

[edit]