మూస:Admin service awards/doc పేజీ సోర్సు చూడండి

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
=== Basic usage ===

To display the template, just place {{tlc|Admin service awards|2=year=''year''|3=month=''month''|4=day=''day''|5=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:

* {{Para|year}} &ndash; Starting year
* {{Para|month}} &ndash; Starting month
* {{Para|day}} &ndash; Starting day of month
* {{Para|actions}} &ndash; Number of administrative actions

{{tlc|Admin service awards|2=year=1995|3=month=1|4=day=15|5=actions=2000000}}
{{Admin service awards|year=1995|month=1|day=15|actions=2000000|nocat=true}}
{{-}}

=== Summary of all options ===

{| class="wikitable"
|+ All parameters
|-
! Parameter !! Definition !! Default value
|-
| <kbd>[[#Basic usage|actions]]</kbd> || Number of administrative actions performed || (required - no default)
|-
| <kbd>[[#Image alignment|align]]</kbd> || Alignment of image || left
|-
| <kbd>[[#Basic usage|day]]</kbd> || Starting day of month || (required - no default)
|-
| <kbd>[[#Display format|format]]</kbd> || Type of template desired || medal
|-
| <kbd>[[#Basic usage|month]]</kbd> || Starting month || (required - no default)
|-
| <kbd>nocat</kbd> || Whether user category should be suppressed || true
|-
| <kbd>[[#Image size|size]]</kbd> || Size of image
|
''Images:'' 130px<br />
''Ribbons:'' 120px<br />
''Topicons:'' 48px<br />
''Small ribbons:'' 72px ''(fixed width)''<br />
''Userboxes:'' 45px ''(fixed width)''
|-
| <kbd>sortkey</kbd> || Setting topicon sort order || (no default)
|-
| <kbd>[[#Basic usage|year]]</kbd> || Starting year || (required - no default)
|}

=== Display format ===

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

==== Standard formats ====
{| class="wikitable"
|+ Standard format values
|-
! Parameter value !! Format
|-
| <kbd>medal</kbd>     || Medal image (the default)
|-
| <kbd>mop</kbd>       || Mop image
|-
| <kbd>ubxmedal</kbd>  || Medal userbox
|-
| <kbd>ubxmop</kbd>    || Mop userbox
|-
| <kbd>ribbon</kbd>    || Standard ribbon image
|-
| <kbd>smlribbon</kbd> || Small ribbon image
|-
| <kbd>topicon</kbd>   || Top icon ([[mw:Help:Page status indicators|page status indicator]])
|}

{| class="wikitable"
|+ Examples of standard formats
|-
|
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=medal | nocat=true}}
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=medal}}
</pre>
{{-}}
|-
| {{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=mop | nocat=true}}
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=mop}}
</pre>
{{-}}
|-
| {{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ubxmedal | nocat=true}}
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ubxmedal}}
</pre>
{{-}}
|-
| {{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ubxmop | nocat=true}}
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ubxmop}}
</pre>
{{-}}
|-
| {{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ribbon | nocat=true}}
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=ribbon}}
</pre>
{{-}}
|-
| {{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=smlribbon | nocat=true}}
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=smlribbon}}
</pre>
{{-}}
|-
| [[File:{{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=imgsmlrib|nocat=true}}|48px|This editor is a Vanguard Editor.]] (displayed in upper right of page)
{{-}}
<pre style="overflow: auto">
{{Admin service awards | year=1995 | month=1 | day=15 | actions=2000000 | format=topicon}}
</pre>
{{-}}
|}

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

{| class="wikitable"
|+ Custom format values
|-
! Parameter value !! Format !! Example
|-
| <kbd>namemop</kbd>    || Award name, using the mop naming scheme || {{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=namemop|nocat=true}}
|-
| <kbd>namemedal</kbd>  || Award name, using the medal naming scheme || {{admin service awards|year=1995|month=1|day=15|actions=2000000|format=namemedal|nocat=true}}
|-
| <kbd>awardmop</kbd>   || Description of the mop awardees are entitled to display || {{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=awardmop|nocat=true}}
|-
| <kbd>awardmedal</kbd> || Description of the medal awardees are entitled to display || {{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=awardmedal|nocat=true}}
|-
| <kbd>imgmop</kbd>     || Image filename of the mop awardees are entitled to display || {{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=imgmop|nocat=true}}
|-
| <kbd>imgmedal</kbd>   || Image filename of the medal awardees are entitled to display || {{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=imgmedal|nocat=true}}
|-
| <kbd>imgsmlrib</kbd>  || Image filename of small ribbon awardees are entitled to display || {{Admin service awards|year=1995|month=1|day=15|actions=2000000|format=imgsmlrib|nocat=true}}
|}

For example:
<pre style="overflow: auto">
{| 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}}!
|}
</pre>

{| style="border: 2px solid black; width: 300px"
|-
| [[File:{{Admin service awards|year=1995|month=1|day=15|actions=200000|format=imgmedal|nocat=true}}<!--
--> | thumbnail | 110px <!--
--> | {{Admin service awards|year=1995|month=1|day=15|actions=200000|format=awardmedal|nocat=true}}]]
|
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|nocat=true}}!
|}

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

{| class="wikitable"
|+ Alignment values
|-
! Parameter value !! Alignment
|-
| <kbd>left</kbd> || Left, with text wrapping around the right side
|-
| <kbd>center</kbd> || Centered
|-
| <kbd>right</kbd> || Right, with text wrapping around the left side
|}

{{tlc|Admin service awards|2=year=1995|3=month=1|4=day=15|5=actions=2000000|6=align=left}}
{{Admin service awards|year=1995|month=1|day=15|actions=2000000|align=left|nocat=true}}
{{-}}

{{tlc|Admin service awards|2=year=1995|3=month=1|4=day=15|5=actions=2000000|6=align=center}}
{{Admin service awards|year=1995|month=1|day=15|actions=2000000|align=center|nocat=true}}
{{-}}

{{tlc|Admin service awards|2=year=1995|3=month=1|4=day=15|5=actions=2000000|6=align=right}}
{{Admin service awards|year=1995|month=1|day=15|actions=2000000|align=right|nocat=true}}
{{-}}

=== Image size ===
For the most award formats, the {{para|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. {{para|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. {{para|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. {{para|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 [[:Template:Top icon|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 ===

Internally, this template uses the following sub-templates:
* [[Template:Admin service awards/compose|/compose]]: Displays an award as described by various parameters.
* [[Template:Admin service awards/core|/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.''
* [[Template:Admin service awards/select|/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 ===

<templatedata>
{
	"params": {
		"actions": {
			"label": "Actions",
			"description": "Number of administrative actions",
			"example": "2000000",
			"type": "number",
			"required": true
		},
		"day": {
			"label": "Day",
			"description": "Starting day of the month",
			"example": "15",
			"type": "number",
			"required": true
		},
		"month": {
			"label": "Month",
			"description": "Starting month",
			"example": "1",
			"type": "number",
			"required": true
		},
		"year": {
			"label": "Year",
			"description": "Starting year",
			"example": "1995",
			"type": "number",
			"required": true
		},
		"size": {
			"label": "Size",
			"description": " Size of image (##px, x##px, upright=#.##)",
			"example": "72px",
			"type": "string"
		},
		"align": {
			"label": "Align",
			"description": "Alignment of image (left, center, or right)",
			"example": "left",
			"type": "string",
		    "suggestedvalues": [
		        "left",
		        "center",
        		"right"
		    ]
		},
		"format": {
			"label": "Format",
			"description": "Type of template desired (medal, ubxmedal, book, ubxbook, ribbon, smlribbon, topicon)",
			"example": "medal",
			"type": "string",
			"suggested": true
		},
		"nocat": {
			"label": "Nocat",
                        "description": "Indicate whether to add the user to associated categories",
                        "example": "true",
			"type": "boolean"
		},
                "sortkey": {
                        "label": "Sortkey",
                        "description": "Indicate sort order of topicons",
                        "example": "42",
                        "type": "string",
                        "suggested": true
                }
	},
	"paramOrder": [
		"year",
		"month",
		"day",
		"actions",
		"format",
		"align",
		"size",
                "sortkey",
		"nocat"
	],
	"description": "Display an Administrative Service Award automatically based on administrator's starting date and number of administrative actions."
}
</templatedata>

=== See also ===

*[[WP:SVC/A|Administrative service awards]]
*[[Wikipedia:Service awards|Service awards]]
*[[Template:Service awards]] – The template and associated subtemplates on which this template and associated subtemplates are based. Please see that template's history for attribution.
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Administrative service award templates|!]]
}}</includeonly>