Difference between revisions of "Template:GRT/doc"
Jump to navigation
Jump to search
imported>Trappist the monk (Upgrade: replace first=yes with disp=long, disp=adj, add link=off;) |
|||
| Line 13: | Line 13: | ||
==Usage== | ==Usage== | ||
| − | < | + | <code><nowiki>{{</nowiki>GRT|''number''|disp=|link=}}</code> |
| − | + | ;Parameters | |
| − | + | :'''number''': numerical value of the gross register tonnage; | |
| − | + | :'''disp''': controls how the template will render in the page: | |
| + | ::{{para|disp}} when empty or omitted, displays the abbreviated form: | ||
| + | :::<code><nowiki>{{GRT|36,000|disp=}}</nowiki></code> → {{GRT|36,000|disp=}} | ||
| + | ::{{para|disp|long}} creates a verbose description suitable for the first occurrence on a page. Equivalent to the deprecated {{para|first|yes}}; | ||
| + | :::<code><nowiki>{{GRT|36,000|disp=long}}</nowiki></code> → {{GRT|36,000|disp=long}} | ||
| + | ::{{para|disp|adj}} creates the adjectival form: | ||
| + | :::<code><nowiki>{{GRT|36,000|disp=adj}}</nowiki></code> → {{GRT|36,000|disp=adj}} | ||
| + | :'''link''': controls when the template output is linked to the [[gross register tonnage]] article | ||
| + | ::{{para|link}} when empty or omitted, links to the gross register tonnage article; this is the default; | ||
| + | :::<code><nowiki>{{GRT|36,000|disp=long|link=}}</nowiki></code> → {{GRT|36,000|disp=long|link=}} | ||
| + | ::{{para|link|off}} instances of the rendered template are not linked to the gross register tonnage article: | ||
| + | :::<code><nowiki>{{GRT|36,000|disp=long|link=off}}</nowiki></code> → {{GRT|36,000|disp=long|link=off}} | ||
| + | :'''first''': (deprecated) controls how the template will render in the page: | ||
| + | ::{{para|first}} (deprecated) when empty or omitted, displays the abbreviated form: | ||
| + | :::<code><nowiki>{{GRT|36,000|first=}}</nowiki></code> → {{GRT|36,000|first=}} | ||
| + | ::{{para|first|yes}} (deprecated) creates a verbose description suitable for the first occurrence on a page. Equivalent to {{para|disp|long}}; | ||
| + | :::<code><nowiki>{{GRT|36,000|first=yes}}</nowiki></code> → {{GRT|36,000|first=yes}} | ||
==Examples== | ==Examples== | ||
| Line 23: | Line 39: | ||
|'''Input'''||'''Displays as''' | |'''Input'''||'''Displays as''' | ||
|- | |- | ||
| − | |<nowiki> {{GRT| | + | |<nowiki> {{GRT|36000|disp=long}} </nowiki> ||{{GRT|36000|disp=long}} |
| + | |- | ||
| + | |<nowiki> {{GRT|36000|disp=long|link=off}} </nowiki> ||{{GRT|36000|disp=long|link=off}} | ||
| + | |- | ||
| + | |<nowiki> {{GRT|36000|disp=adj}} </nowiki> ||{{GRT|36000|disp=adj}} | ||
| + | |- | ||
| + | |<nowiki> {{GRT|36000|disp=adj|link=off}} </nowiki> ||{{GRT|36000|disp=adj|link=off}} | ||
| + | |- | ||
| + | |<nowiki> {{GRT|36000|disp=}} </nowiki> ||{{GRT|36000|disp=}} | ||
|- | |- | ||
| − | |<nowiki> {{GRT| | + | |<nowiki> {{GRT|36000}} </nowiki> ||{{GRT|36000}} |
|- | |- | ||
| − | |<nowiki> {{GRT| | + | |<nowiki> {{GRT|36000|link=off}} </nowiki> ||{{GRT|36000|link=off}} |
|} | |} | ||
Revision as of 13:31, 2 October 2013
| 40px | 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:
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.