మూస:Service awards/doc
 | This template uses Lua: |
 | This is a documentation subpage for మూస:Service awards. It may contain usage information, categories and other content that is not part of the original మూస page. |
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}}
Summary of all options
[మార్చు]| 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) |
| 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
[మార్చు]| 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) |
{{service awards
| year=1995 | month=1 | day=15
| edits=2000000 | format=medal}}
| ||
 {{service awards
| year=1995 | month=1 | day=15
| edits=2000000 | format=book | size=thumbnail{{!}}upright}}
| ||
| ||
| ||
 {{service awards
| year=1995 | month=1 | day=15
| edits=2000000 | format=ribbon}}
| ||
 {{service awards
| year=1995 | month=1 | day=15
| edits=2000000 | format=ribbon2}}
| ||
| ||
|
|
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.
| Parameter value | Format | Example |
|---|---|---|
| namebook | Award name, using the book naming scheme | a Cardinal Gom, the August Togneme of the EncyclopediaCardinal Gom |
| namemedal | Award name, using the medal naming scheme | an Ultimate Vanguard 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 |
| awardmedal | Description of the medal awardees are entitled to display | Meitnerium Editor Star with the Neutronium Superstar hologram |
| imgbook | Image filename of the book awardees are entitled to display | Gom iii.jpg |
| imgmedal | Image filename of the medal awardees are entitled to display | Editor - lapis matter v.jpg |
| imgsmlrib | Image filename of small ribbon awardees are entitled to display | Editorrib22.svg |
For example:
{| style="border: 2px solid black; width: 300px"
|-
| [[File:{{service awards|year=1995|month=1|day=15|edits=200000|format=imgmedal}}<!--
--> | thumbnail | 110px <!--
--> | {{service awards|year=1995|month=1|day=15|edits=200000|format=awardmedal}}]]
|
So what's that medal for? That's my service award – I'm
{{service awards|year=1995|month=1|day=15|edits=200000|format=namemedal}}!
|}
|
So what's that medal for? That's my service award – I'm an Ultimate Vanguard 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.
| 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}}
{{service awards|year=1995|month=1|day=15|edits=2000000|align=center}}
{{service awards|year=1995|month=1|day=15|edits=2000000|align=right}}
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. (Also omits the frame and caption for image-with-caption formats.)
- size=xNNpx
- Display the image at the specified height, selecting the best width to maintain the image proportions. (Also omits the frame and caption for image-with-caption formats.)
- size=frameless
- Omit the frame and caption and use the default image width.
- size=frame
- Force the frame and caption to show.
- size=thumbnail{{!}}NNpx
- Show a frame and caption and set the image 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.
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.
| 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:
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.
| పరామితి | వివరణ | రకం | స్థితి | |
|---|---|---|---|---|
| Year | year | Starting year
| సంఖ్య | తప్పనిసరి |
| Month | month | Starting month
| సంఖ్య | తప్పనిసరి |
| Day | day | Starting day of the month
| సంఖ్య | తప్పనిసరి |
| Edits | edits | Number of user edits
| సంఖ్య | తప్పనిసరి |
| Format | format | Type of template desired (medal, ubxmedal, book, ubxbook, ribbon, ribbon2, smlribbon, topicon)
| స్ట్రింగు | సూచించినవి |
| Align | align | Alignment of image (left, center, or right)
| స్ట్రింగు | ఐచ్చికం |
| Caption 1 | caption1 | First part of message shown
| స్ట్రింగు | ఐచ్చికం |
| Caption 2 | caption2 | Second part of message shown
| స్ట్రింగు | ఐచ్చికం |
| Caption 3 | caption3 | Third part of message shown | స్ట్రింగు | ఐచ్చికం |
| Punctuation | punctuation | Punctuation at end of message
| స్ట్రింగు | ఐచ్చికం |
| Size | size | Size of image (##px, x##px, frameless, frame, thumbnail{{!}}##px)
| స్ట్రింగు | ఐచ్చికం |
| No Incremental Awards | noinc | Incremental awards are not shown where they are available ''(Topicons)'' | బూలియన్ | ఐచ్చికం |
| No Categories | nocat | వివరణ లేదు | బూలియన్ | ఐచ్చికం |
See also
[మార్చు]