Difference between revisions of "Template:DWT/doc"

From blackwiki
Jump to navigation Jump to search
imported>Trappist the monk
m (keep sandbox out of cats;)
imported>Trappist the monk
m (copyedit;)
Line 6: Line 6:
  
 
==Usage==
 
==Usage==
  <code><nowiki>{{</nowiki>DWT|''number''|''unit''|disp=|link=}}</code>
+
  <code><nowiki>{{</nowiki>DWT|{{var|number}}|{{var|unit}}|disp=|link=}}</code>
  
 
;Parameters
 
;Parameters
:'''number''': numerical value of the deadweight tonnage;  
+
:'''{{var|number}}''': numerical value of the deadweight tonnage;  
:'''unit''': specifies the units in which the dead weight tonnage is measured; use '''<code>long</code>''' or '''<code>metric</code>''';
+
:'''{{var|unit}}''': specifies the units in which the dead weight tonnage is measured; use '''<code>long</code>''' or '''<code>metric</code>''';
 
:'''disp''': controls how the template will render in the page:
 
:'''disp''': controls how the template will render in the page:
 
::{{para|disp}} when empty or omitted, displays the abbreviated form:
 
::{{para|disp}} when empty or omitted, displays the abbreviated form:
 
:::<code><nowiki>{{DWT|36,000|metric|disp=}}</nowiki></code> → {{DWT|36,000|metric|disp=}}
 
:::<code><nowiki>{{DWT|36,000|metric|disp=}}</nowiki></code> → {{DWT|36,000|metric|disp=}}
::{{para|disp|long}} creates a verbose description suitable for the first occurrence on a page. Equivalent to the deprecated {{para|first|yes}};
+
::{{para|disp|long}} creates a verbose description suitable for the first occurrence on a page
 
:::<code><nowiki>{{DWT|36,000|metric|disp=long}}</nowiki></code> → {{DWT|36,000|metric|disp=long}}
 
:::<code><nowiki>{{DWT|36,000|metric|disp=long}}</nowiki></code> → {{DWT|36,000|metric|disp=long}}
 
::{{para|disp|adj}} creates the adjectival form:
 
::{{para|disp|adj}} creates the adjectival form:
Line 23: Line 23:
 
::{{para|link|off}} instances of the rendered template are not linked to the deadweight tonnage article:
 
::{{para|link|off}} instances of the rendered template are not linked to the deadweight tonnage article:
 
:::<code><nowiki>{{DWT|36,000|metric|disp=long|link=off}}</nowiki></code> → {{DWT|36,000|metric|disp=long|link=off}}
 
:::<code><nowiki>{{DWT|36,000|metric|disp=long|link=off}}</nowiki></code> → {{DWT|36,000|metric|disp=long|link=off}}
:{{xtd|'''first'''}}: (deprecated) controls how the template will render in the page:
 
::{{xtd|{{para|first}}}} (deprecated) when empty or omitted, displays the abbreviated form:
 
:::<code><nowiki>{{DWT|36,000|metric|first=}}</nowiki></code> → {{DWT|36,000|metric|first=}}
 
::{{xtd|{{para|first|yes}}}} (deprecated) creates a verbose description suitable for the first occurrence on a page. Equivalent to {{para|disp|long}};
 
:::<code><nowiki>{{DWT|36,000|metric|first=yes}}</nowiki></code> → {{DWT|36,000|metric|first=yes}}
 
  
 
==Examples==
 
==Examples==

Revision as of 11:55, 11 July 2017

Purpose

To show deadweight tonnage, whether expressed in metric or long tons, in a consistent manner. Also to introduce the units used and the intended meaning of the abbreviation DWT the first time it is used in an article.

Usage

{{DWT|number|unit|disp=|link=}}
Parameters
number: numerical value of the deadweight tonnage;
unit: specifies the units in which the dead weight tonnage is measured; use long or metric;
disp: controls how the template will render in the page:
|disp= when empty or omitted, displays the abbreviated form:
{{DWT|36,000|metric|disp=}} → 36,000 t DWT
|disp=long creates a verbose description suitable for the first occurrence on a page
{{DWT|36,000|metric|disp=long}} → 36,000 tonnes deadweight (DWT)
|disp=adj creates the adjectival form:
{{DWT|36,000|metric|disp=adj}} → 36,000-tonne deadweight (DWT)
link: controls when the template output is linked to the deadweight tonnage article
|link= when empty or omitted, links to the deadweight tonnage article; this is the default;
{{DWT|36,000|metric|disp=long|link=}} → 36,000 tonnes deadweight (DWT)
|link=off instances of the rendered template are not linked to the deadweight tonnage article:
{{DWT|36,000|metric|disp=long|link=off}} → 36,000 tonnes deadweight (DWT)

Examples

Input Displays as
{{DWT|36,000|metric|disp=long}} 36,000 tonnes deadweight (DWT)
{{DWT|36,000|long|disp=long}} 36,000 long tons deadweight (DWT)
{{DWT|36,000|metric}} 36,000 t DWT
{{DWT|36,000|long}} 36,000 LT DWT
{{DWT|36,000}} 36,000 DWT
  1. REDIRECT Template:WPSHIPS: Measurement templates


  • 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.