Template:Service awards/doc
 | This is a documentation subpage for Template:Service awards. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
changeBasic Template Usage
changeTo display the template, just place {{service awards|year=[year]|month=[month]|day=[day]|edits=[edits]}} on the relevant page where the item in squared brackets is replaced by the relevant value.
| Parameter | Definition | Default Value |
|---|---|---|
| Year | Starting year | 2001 |
| Month | Starting month | 1 |
| Day | Starting date | 15 |
| Edits | Number of user edits | 9878562 |
{{service awards|year=1995|month=1|day=15|edits=2000000}}
Standard Options
changeThis template has various options in order to customise the template.
The location parameter is used to specify the location of the template.
| Format | Parameter Value |
|---|---|
| Left | left |
| Center | center |
| Right | right |
{{service awards|year=1995|month=1|day=15|edits=2000000|location=left}}
{{service awards|year=1995|month=1|day=15|edits=2000000|location=center}}
{{service awards|year=1995|month=1|day=15|edits=2000000|location=right}}
The format parameter is used to specify the type of template used.
| Format | Parameter Value |
|---|---|
| Medal | medal |
| Book | book |
| Medal Userbox | ubxmedal |
| Book Userbox | ubxbook |
| Ribbon | ribbon |
{{service awards|year=1995|month=1|day=15|edits=2000000|format=medal}}
{{service awards|year=1995|month=1|day=15|edits=2000000|format=book}}
{{service awards|year=1995|month=1|day=15|edits=2000000|format=ubxmedal}}
 | This editor is a Ultimate Editor and is entitled to display this Meitnerium Editor Star. |
{{service awards|year=1995|month=1|day=15|edits=2000000|format=ubxbook}}
 | This editor is an Ultimate Editor and is entitled to display this Complete Book of Knowledge with Secret Appendix and Free Errata Sheet. |
{{service awards|year=1995|month=1|day=15|edits=2000000|format=ribbon}}
The size parameter is used to specify whether to include the frame and caption. Add "size=frameless" to display just the picture on its own if this is desired; otherwise leave out the parameter so the frame and caption will be included.
| Parameter | Definition | Default Value |
|---|---|---|
| location | location of template | left |
| Format | Type of template desired | medal |
| Size | Size of template | frame |
Note: the location parameter is used only in the medal, book and ribbon formats and the size parameter is used only in the medal and book formats. They will have no effect on the other formats and therefore these parameters should be left out (not blank) if other formats are selected.
Caption Customisation
changeThe 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) |
{{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=!!!}}
Note: the caption and punctuation parameters will have no effect on the ribbon format and therefore these parameters should be left out (not blank) if this format is selected.
Related pages
change