Template:ShipCost

Template documentation[view] [edit] [history] [purge]

Purpose

The purpose of this template is to abstract and format ship costs.

Currently configured so no adjustments or conversions are applied.

Usage

{{ShipCost|country|value|currency_units|year=|origin=|r=|force=|lk=|exact=|qty=|tot=|suffix=|est=|ref=|mode=}}

Parameters

A description of the template's parameters are listed below.

Field name	Usage	Example	Description
country_code	mandatory	GBR	The country code of the currency, see the examples to find out what is currently supported. EUR for Euro (inflation adjustment would require using a country-specific code).
value	mandatory	10000.01	The value, in the country_code currency, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234).
currency_units	optional	m	Used to represent smaller or larger numbers. Available options are as follows. ct – to represent cent(s) p – to represent penny (pence) pa – to represent paisa (paise) (generalized to mean cents) po – to represent poysha (generalized to mean cents) ba – to represent baisa(s) (generalized to mean 1/1000) k – to represent thousand(s) m – to represent million(s) b – to represent short scale billion(s) t – to represent short scale trillion(s) l – to represent lakh(s) c – to represent crore(s) lc – to represent lakh crore(s) Brackets in the sense may be singular (or) plural. The Indian units can be applied to any currency.
lk	optional	lk=on	This parameter gives you the option of internally linking currency names (paise, which is generalized here to mean cents in the source currency) and/or number names (billion, trillion, lakh, crore). By default, the parameter is set to "off" (i.e. it is set not to link). Available options are as follows. on – to link all units source – to link the source value original – to link the values in the original currency inflated – to link the inflated value in the original currency result – to link the inflated and converted vales converted – to link the converted value source-converted – to link the source and converted values
year	optional	year=2002	This parameter allows entering values from previous years. The year will be displayed and historic values will be inflated to the latest year available in {{Inflation}} if index is also provided then converted by {{ToUSD}}. If no index name is present, the conversion will be attempted for the year indicated (but see force). If year is not provided, just a conversion will be performed at the most current rate available.
origin	optional	origin=ESP	The country code of the shipyard's location, by default that corresponding to the currency is assumed (no country assumed for Euro).
r	optional	r=3	Sets the digits to which the results must be rounded. A negative value indicates rounding to an upper significant digit, and a positive value indicates a fractional digit including trailing zeros. Defaults to 2.
force	optional	force=yes	This parameter allows to force a conversion at the most current rate available when data is lacking for the provided year when its value is yes.
exact	optional	exact=source	This provides some control over formatting. source requests to display the input value normally (in American fashion) after applying the units. on does this for both the input and result values. Otherwise all values will be displayed as per {{Format price}}.
qty	optional	qty=first	This allows adding a phrase that indicates to how many or which units the cost applies to.
tot	optional	tot=yes	yes indicates that the cost includes technology transfer.
suffix	optional	suffix=and training facilities	This allows appending an arbitrary wikitext to the output.
est	optional	est=yes	yes indicates that the cost is estimated.
ref	optional	ref=<ref>some wikitext ref</ref>	This allows displaying one or more references. Each one must consist of a ref wikitext element. The placement of the references is normalized (currently after the year, but this might be changed in the future).
mode	optional	mode=historical	This parameter allows to disable adjustment even if the template is configured to enable it.

Examples

ShipCost syntax	Results
{{ShipCost|ARG|3600000}}	ARS
{{ShipCost|ARG|3600000|year=1992}}	ARS  (1992)
{{ShipCost|ARG|3600000|year=1991}}	Year not supported
{{ShipCost|AUS|3.6|m}}	A$
{{ShipCost|AUS|3600000}}	A$
{{ShipCost|AUS|3654000|year=1962}}	A$ (1962)
{{ShipCost|AUS|3654000|year=1962|origin=AUS}}	A$ (1962)
{{ShipCost|AUS|3654000|year=1962|origin=ESP}}	A$ (1962)
{{ShipCost|AUS|3654000|year=1962|r=3|ref=<ref name="qv">something1</ref>}}	A$ (1962)
{{ShipCost|AUS|3.6|m|qty=}}	A$
{{ShipCost|AUS|3.6|m|qty=first}}	A$ for the first unit
{{ShipCost|AUS|3.6|m|qty=1}}	A$ per unit
{{ShipCost|AUS|3.6|m|qty=8}}	A$ for 8 units
{{ShipCost|AUS|3650000|year=1962|exact=on|ref=<ref name="qv">something1</ref><ref name="s">something2</ref>}}	A$Template:FXConvert/Formatnum (1962)
{{ShipCost|AUS|3650000|year=1962|exact=on|qty=8|suffix= + [[Technology transfer|ToT]]|ref=<ref name="qv">something1</ref><ref name="s">something2</ref>}}	A$Template:FXConvert/Formatnum (1962) for 8 units + ToT
{{ShipCost|AUS|3650000|year=1962|exact=on|qty=8|tot=yes|ref=<ref name="qv">something1</ref><ref name="s">something2</ref>}}	A$Template:FXConvert/Formatnum (1962) for 8 units + ToT
{{ShipCost|AUS|3650000|year=1962|exact=on|qty=8|tot=yes|suffix=and training facilities|ref=<ref name="qv">something1</ref><ref name="s">something2</ref>}}	A$Template:FXConvert/Formatnum (1962) for 8 units + ToT and training facilities
{{ShipCost|AUS|3650000|year=1962|exact=on|qty=8|tot=yes|est=yes|suffix=and training facilities|ref=<ref name="qv">something1</ref><ref name="s">something2</ref>}}	A$Template:FXConvert/Formatnum (1962) for 8 units + ToT and training facilities (est.)
{{ShipCost|AUS|3650000|year=1962|exact=on|mode=historical|qty=8|tot=yes|est=yes|suffix=and training facilities|ref=<ref name="qv">something1</ref><ref name="s">something2</ref>}}	A$Template:FXConvert/Formatnum (1962) for 8 units + ToT and training facilities (est.)
{{ShipCost|BEL|3600000}}	€
{{ShipCost|BEL|3600000|year=1999}}	€ (1999)
{{ShipCost|BEL|3600000|year=1998}}	BEF  (1998)
{{ShipCost|BEL|3600000|year=1947}}	BEF  (1947)
{{ShipCost|BEL|3600000|year=1946}}	Year not supported
{{ShipCost|BRA|3600000}}	R$
{{ShipCost|BRA|3600000|year=1995}}	R$ (1995)
{{ShipCost|BRA|3600000|year=1994}}	Year not supported
{{ShipCost|CAN|3600000}}	CA$
{{ShipCost|CAN|3600000|year=1962}}	CA$ (1962)
{{ShipCost|CHN|3600000}}	CN¥
{{ShipCost|CHN|3600000|year=1949}}	CN¥ (1949)
{{ShipCost|CHN|3600000|year=1948}}	Year not supported
{{ShipCost|GER|3600000}}	Use DEU
{{ShipCost|GER|3600000|year=1999}}	Use DEU
{{ShipCost|GER|3600000|year=1998}}	Use DEU
{{ShipCost|GER|3600000|year=1949}}	Use DEU
{{ShipCost|GER|3600000|year=1948}}	Use DEU
{{ShipCost|DEU|3600000}}	€
{{ShipCost|DEU|3600000|year=1999}}	€ (1999)
{{ShipCost|DEU|3600000|year=1998}}	DM  (1998)
{{ShipCost|DEU|3600000|year=1949}}	DM  (1949)
{{ShipCost|DEU|3600000|year=1948}}	Year not supported
{{ShipCost|DNK|3600000}}	DKK
{{ShipCost|DNK|3600000|year=1874}}	DKK  (1874)
{{ShipCost|DNK|3600000|year=1873}}	Year not supported
{{ShipCost|ESP|3600000}}	€
{{ShipCost|ESP|3600000|year=1999}}	€ (1999)
{{ShipCost|ESP|3600000|year=1998}}	₧  (1998)
{{ShipCost|ESP|3600000|year=1869}}	₧  (1869)
{{ShipCost|ESP|3600000|year=1868}}	Year not supported
{{ShipCost|EUR|3600000}}	€
{{ShipCost|EUR|3600000|year=1999}}	€ (1999)
{{ShipCost|FIN|3600000}}	€
{{ShipCost|FIN|3600000|year=1999}}	€ (1999)
{{ShipCost|FIN|3600000|year=1998}}	FIM  (1998)
{{ShipCost|FIN|3600000|year=1861}}	FIM  (1861)
{{ShipCost|FIN|3600000|year=1860}}	Year not supported
{{ShipCost|FRA|3600000}}	€
{{ShipCost|FRA|3600000|year=1999}}	€ (1999)
{{ShipCost|FRA|3600000|year=1998}}	FRF  (1998)
{{ShipCost|FRA|3600000|year=1960}}	FRF  (1960)
{{ShipCost|FRA|3600000|year=1959}}	FF  (1959)
{{ShipCost|FRA|3600000|year=1796}}	FF  (1796)
{{ShipCost|FRA|3600000|year=1795}}	Year not supported
{{ShipCost|GBR|3600000}}	yes|yes|GB|}}£
{{ShipCost|GBR|3600000|year=1962}}	yes|yes|GB|}}£ (1962)
{{ShipCost|GRC|3600000}}	€
{{ShipCost|GRC|3600000|year=2001}}	€ (2001)
{{ShipCost|GRC|3600000|year=2000}}	₯ (2000)
{{ShipCost|GRC|3600000|year=1955}}	₯ (1955)
{{ShipCost|GRC|3600000|year=1954}}	Year not supported
{{ShipCost|HRV|3600000}}	HRK
{{ShipCost|HRV|3600000|year=1995}}	HRK  (1995)
{{ShipCost|HRV|3600000|year=1994}}	Year not supported
{{ShipCost|IRL|3600000}}	€
{{ShipCost|IRL|3600000|year=1999}}	€ (1999)
{{ShipCost|IRL|3600000|year=1998}}	IR£ (1998)
{{ShipCost|IRL|3600000|year=1939}}	IR£ (1939)
{{ShipCost|IRL|3600000|year=1038}}	Year not supported
{{ShipCost|ITA|3600000}}	€
{{ShipCost|ITA|3600000|year=1999}}	€ (1999)
{{ShipCost|ITA|3600000|year=1998}}	Lit.  (1998)
{{ShipCost|ITA|3600000|year=1863}}	Lit.  (1863)
{{ShipCost|ITA|3600000|year=1862}}	Year not supported
{{ShipCost|JPN|3600000}}	¥
{{ShipCost|JPN|3600000|year=1962}}	¥ (1962)
{{ShipCost|KOR|3600000}}	₩
{{ShipCost|KOR|3600000|year=1962}}	₩ (1962)
{{ShipCost|LUX|3600000}}	€
{{ShipCost|LUX|3600000|year=1999}}	€ (1999)
{{ShipCost|LUX|3600000|year=1998}}	LUF  (1998)
{{ShipCost|LUX|3600000|year=1945}}	LUF  (1945)
{{ShipCost|LUX|3600000|year=1944}}	Year not supported
{{ShipCost|MLT|3600000}}	€
{{ShipCost|MLT|3600000|year=2008}}	€ (2008)
{{ShipCost|MLT|3600000|year=2007}}	Lm  (2007)
{{ShipCost|MLT|3600000|year=1973}}	Lm  (1973)
{{ShipCost|MLT|3600000|year=1972}}	Year not supported
{{ShipCost|MYS|3600000}}	RM
{{ShipCost|MYS|3600000|year=1976}}	RM  (1976)
{{ShipCost|MYS|3600000|year=1975}}	Year not supported
{{ShipCost|NLD|3600000}}	€
{{ShipCost|NLD|3600000|year=1999}}	€ (1999)
{{ShipCost|NLD|3600000|year=1998}}	ƒ (1998)
{{ShipCost|NLD|3600000|year=1815}}	ƒ (1815)
{{ShipCost|NLD|3600000|year=1814}}	Year not supported
{{ShipCost|NOR|3600000}}	NOK
{{ShipCost|NOR|3600000|year=1876}}	NOK  (1876)
{{ShipCost|NOR|3600000|year=1875}}	Year not supported
{{ShipCost|NZL|3600000}}	NZ$
{{ShipCost|NZL|3600000|year=1968}}	NZ$ (1968)
{{ShipCost|NZL|3600000|year=1967}}	Year not supported
{{ShipCost|PHL|3600000}}	₱
{{ShipCost|PHL|3600000|year=1946}}	₱ (1946)
{{ShipCost|PHL|3600000|year=1945}}	Year not supported
{{ShipCost|POL|3600000}}	PLN
{{ShipCost|POL|3600000|year=1995}}	PLN  (1995)
{{ShipCost|POL|3600000|year=1994}}	PLZ  (1994)
{{ShipCost|POL|3600000|year=1951}}	PLZ  (1951)
{{ShipCost|POL|3600000|year=1950}}	Year not supported
{{ShipCost|PRT|3600000}}	€
{{ShipCost|PRT|3600000|year=1999}}	€ (1999)
{{ShipCost|PRT|3600000|year=1998}}	PTE  (1998)
{{ShipCost|PRT|3600000|year=1912}}	PTE  (1912)
{{ShipCost|PRT|3600000|year=1911}}	Year not supported
{{ShipCost|ROU|3600000}}	RON
{{ShipCost|ROU|3600000|year=2006}}	RON  (2006)
{{ShipCost|ROU|3600000|year=2005}}	Year not supported
{{ShipCost|ROU|3600000|year=2004}}	ROL  (2004)
{{ShipCost|ROU|3600000|year=1953}}	ROL  (1953)
{{ShipCost|ROU|3600000|year=1952}}	Year not supported
{{ShipCost|ROU|3600000|year=1951}}	Year not supported
{{ShipCost|SWE|3600000}}	SEK
{{ShipCost|SWE|3600000|year=1874}}	SEK  (1874)
{{ShipCost|SWE|3600000|year=1873}}	Year not supported
{{ShipCost|USA|3600}}	US$
{{ShipCost|USA|3600|year=1790}}	US$ (1790)
{{ShipCost|ZAF|3600000}}	Template:ZAR
{{ShipCost|ZAF|3600000|year=1962}}	Template:ZAR (1962)

See also

• {{FXConvert}}: Inflates and converts a given currency to US dollars. It is used by {{ShipCost}}.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for ShipCost

Template presents the cost of a ship.

Template parameters

Parameter		Description	Type	Status
Currency country code	1	ISO 3166-1 alpha-3 country code of the currency, see the examples to find out what is currently supported. EUR for Euro (inflation adjustment would require using a country-specific code). Example GBR	Line	required
Value	2	The value, in the source, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234). Example 500000000	Number	required
Currency units	3	Use this to represent larger numbers such as crores, billions et al. Example c, lc, b, m, k, cr, p, pa, po, ba	Line	suggested
Linking	lk	Gives option to whether link currency names (paise, etc.) or number names (crores, lakhs, billions, trillions) Example on, off, source, original, inflated, result, converted, source-converted	Line	suggested
Year	year	This parameter allows for inflation. Historic values will be inflated to the most current values available then converted. Example 2015	Number	suggested
Origin	origin	ISO 3166-1 alpha-3 country code of the shipyard's location, by default that corresponding to the currency is assumed (no country assumed for Euro). Example ESP	Line	optional
Rounding digits	r	Used to round significant digits. A value of "0" will drop paise or cent values from the converted number. By default the conversion will be rounded to two significant figures. Example 0	Number	optional
Force	force	This parameter allows to force a conversion at the most current rate available when data is lacking for the provided year when its value is "yes". Example yes	Line	optional
Exact	exact	This provides some control over formatting. "source" requests to display the input value normally (in American fashion) after applying the units. "on" does this for both the input and result values. Otherwise all values will be displayed as per Format price. Example source, on	Line	optional
Quantity	qty	This allows adding a phrase that indicates to how many or which units the cost applies to. Example first, 1, 4	Line	optional
Technology transfer	tot	yes indicates that the cost includes technology transfer Example yes	Line	optional
Suffix	suffix	This allows appending an arbitrary wikitext to the output. Example and training facilities	Line	optional
Estimated	est	yes indicates that the cost is estimated Example yes	Line	optional
References	ref	This allows displaying one or more references. Each one must consist of a ref wikitext element. The placement of the references is normalized (currently after the year, but this might be changed in the future). Example <ref>some wikitext ref</ref>	Content	suggested
Mode	mode	This parameter allows to disable the adjustment even if the template is enabling it. Default (blank) Example historical	Line	optional

The above documentation is transcluded from Template:ShipCost/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.