Template:GRT/doc
< Template:GRT
Jump to navigation
Jump to search
Revision as of 10:22, 24 June 2017 by imported>Trappist the monk (keep sandbox out of cats;)
| This is a documentation subpage for Template:GRT. It contains usage information, categories and other content that is not part of the original template page. |
Purpose
To show gross register tonnage in a consistent manner that is compliant with WP:MOSNUM. In particular it:
- capitalization and spelling are standardized (i.e. GRT, Grt, grt, G.R.T., g.r.t. and so forth),
- the link to the definition is standardized,
- spells out "XXX gross register tons" and introduces the abbreviation GRT on the first use in an article,
- links to gross register tonnage on the first use in an article,
- uses the abbreviation GRT on subsequent uses in the article, and
- inserts a between the number and the unit.
Note! For ships built on or after 18 July 1982, use {{GT}}.
Usage
{{GRT|number|disp=|link=}}
- Parameters
- number: numerical value of the gross register tonnage;
- disp: controls how the template will render in the page:
|disp=when empty or omitted, displays the abbreviated form:{{GRT|36,000|disp=}}→ 36,000 GRT
|disp=longcreates a verbose description suitable for the first occurrence on a page. Equivalent to the deprecated|first=yes;{{GRT|36,000|disp=long}}→ 36,000 gross register tons (GRT)
|disp=adjcreates the adjectival form:{{GRT|36,000|disp=adj}}→ 36,000-gross register ton (GRT)
- link: controls when the template output is linked to the gross register tonnage article
|link=when empty or omitted, links to the gross register tonnage article; this is the default;{{GRT|36,000|disp=long|link=}}→ 36,000 gross register tons (GRT)
|link=offinstances of the rendered template are not linked to the gross register tonnage article:{{GRT|36,000|disp=long|link=off}}→ 36,000 gross register tons (GRT)
- first: (deprecated) controls how the template will render in the page:
|first=(deprecated) when empty or omitted or|first=short(deprecated) displays the abbreviated form:{{GRT|36,000|first=}}→ 36,000 GRT
|first=yes(deprecated) creates a verbose description suitable for the first occurrence on a page. Equivalent to|disp=long;{{GRT|36,000|first=yes}}→ 36,000 GRT
|first=off(deprecated) creates an unlinked verbose description. Equivalent to|disp=long|link=off;{{GRT|36,000|first=off}}→ 36,000 GRT
Examples
| Input | Displays as |
| {{GRT|36000|disp=long}} | 36,000 gross register tons (GRT) |
| {{GRT|36000|disp=long|link=off}} | 36,000 gross register tons (GRT) |
| {{GRT|36000|disp=adj}} | 36,000-gross register ton (GRT) |
| {{GRT|36000|disp=adj|link=off}} | 36,000-gross register ton (GRT) |
| {{GRT|36000|disp=}} | 36,000 GRT |
| {{GRT|36000}} | 36,000 GRT |
| {{GRT|36000|link=off}} | 36,000 GRT |
- From a page move: This is a redirect from a page that has been moved (renamed). This page was kept as a redirect to avoid breaking links, both internal and external, that may have been made to the old page name.