Template:GT/doc

From Wiki
Jump to: navigation, search


Purpose

To show gross tonnage in a consistent manner that is compliant with WP:MOSNUM. In particular it:

  • capitalization and spelling are standardized (i.e. GT, Gt, gt, G.T., g.t. and so forth),
  • the link to the definition is standardized,
  • links to gross tonnage on the first use in an article,
  • uses the abbreviation GT, i.e. "XXX GT" on subsequent uses in the article,
  • inserts  s where needed, and
  • spells out "gross tonnage (GT) of XXX", introducing the abbreviation GT on the first use in an article.

Note! Gross tonnage is a dimensionless index calculated with a mathematical formula. While this template allows, for the sake of backwards compatibility, the use of "tons" as the unit for gross tonnage, this is not correct and should not be used in future articles.

Usage

{{GT|number|disp=|link=}}
Parameters
number: numerical value of the gross tonnage;
disp: controls how the template will render in the page:
|disp= when empty or omitted, displays the abbreviated form:
{{GT|36,000|disp=}} → 36,000 GT
|disp=long creates a verbose description suitable for the first occurrence on a page. Equivalent to the deprecated |first=yes;
{{GT|36,000|disp=long}} → 36,000 gross tonnage (GT)
|disp=adj creates the adjectival form:
{{GT|36,000|disp=adj}} → 36,000-gross tonnage (GT)
link: controls when the template output is linked to the gross tonnage article
|link= when empty or omitted, links to the gross tonnage article; this is the default;
{{GT|36,000|disp=long|link=}} → 36,000 gross tonnage (GT)
|link=off instances of the rendered template are not linked to the gross tonnage article:
{{GT|36,000|disp=long|link=off}} → 36,000 gross tonnage (GT)
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:
{{GT|36,000|first=}} → 36,000 GT
|first=yes (deprecated) creates a verbose description suitable for the first occurrence on a page. Improper usage.[Note] Use |disp=long;
{{GT|36,000|first=yes}}gross tonnage (GT) of 36,000
|first=caps (deprecated) creates a verbose description that begins with a capital letter. Improper usage.[Note]
{{GT|36,000|first=caps}}Gross tonnage (GT) of 36,000

Examples

Input Displays as
{{GT|36000|disp=long}} 36,000 gross tonnage (GT)
{{GT|36000|disp=long|link=off}} 36,000 gross tonnage (GT)
{{GT|36000|disp=adj}} 36,000-gross tonnage (GT)
{{GT|36000|disp=adj|link=off}} 36,000-gross tonnage (GT)
{{GT|36000|disp=}} 36,000 GT
{{GT|36000}} 36,000 GT
{{GT|36000|link=off}} 36,000 GT

Related templates