Template:Pound sterling/doc

Relevant discussion at

→ Template talk:Currency#Suggestions for a standard set of options for each template

This is a multifunction template. At its simplest, it adds the currency mark "£", as recommended by MOS:CURRENCY for many situations. The template can also link to the Pound sterling article and can even calculate inflation. See warnings below.

Usage

{{GBP|value}}

Example:

• {{GBP}} → £
• {{GBP|123.45}} → £123.45

Link

The parameter |link=yes may be used to link to the article Pound sterling. This is turned off by default, but may be appropriate for the first occurrence of the term in an article.

Example:

• {{GBP|123.45|link=yes}} → £123.45

Inflation calculation

The template supports inflation calculation, by way of {{Inflation}}. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, if 1209 ≤ year < 2023), the equivalent value represented in 2023 pound will be calculated in parentheses. However, this function should only be used in appropriate situations.

• {{GBP|value|year}}
• {{GBP|value|year|round=round|about=yes}}

Examples:

• {{GBP|100|1208}} → £100
• {{GBP|100|1209}} → £100 (equivalent to £177,967 in 2023)
• {{GBP|100|1966}} → £100 (equivalent to £2,353 in 2023)
• {{GBP|100|1966|link=yes}} → £100 (equivalent to £2,353 in 2023)
• {{GBP|100|2022}} → £100 (equivalent to £106.41 in 2023)
• {{GBP|100|2023}} → £100
• {{GBP|100|2024}} → £100
• {{GBP|100|2025}} → £100

Additional parameter |about=yes will cause the template to calculate to the nearest pound (instead of the nearest penny), and prefix the calculated value with "about". The rounding can be fine-tuned further by using |round=integer. These parameters may be combined.

Examples:

• {{GBP|10|1990}} → £10 (equivalent to £28.71 in 2023)
• {{GBP|10|1990|round=0}} → £10 (equivalent to £29 in 2023)
• {{GBP|10|1990|about=yes}} → £10 (equivalent to about £29 in 2023)
• {{GBP|1000|1990|round=2}} → £1,000 (equivalent to £2,870.84 in 2023)
• {{GBP|1000|1990|round=-2}} → £1,000 (equivalent to £2,900 in 2023)
• {{GBP|1000|1990|round=-2|about=yes}} → £1,000 (equivalent to about £2,900 in 2023)

Redirects here

• Template:GB£
• Template:£
• Template:STG
• Template:£ stg
• Template:Sterling

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Pound sterling in articles based on its TemplateData.

TemplateData for Pound sterling

This template renders the standard British Pound sterling currency abbreviation (£) and an optional value. The abbreviation provides an informative link to the currency article and can even calculate inflation.

Template parameters

Parameter		Description	Type	Status
Amount	1	The monetary value. Preferably in numeric value. Example 10000.00	Number	optional
Year	2 year	The year which the monetary value was recorded Example 2010	Number	optional
Display currency article	link	To display ''Pound sterling'' article. 'on' will display the link. Example on	String	optional
Display "GB" before the "£" sign?	long	no description Suggested values yes no Example no	String	optional
Calculate to nearest pound	about	Calculate to nearest pound Example yes	String	optional
Rounding	round	Number of integers to round the value to. Example 2	Number	optional

See also

• Wikipedia:Manual of Style (dates and numbers)#Currencies
• Template:Currency
• Wikipedia:Wikiproject United Kingdom
• Template:Pounds, shillings, and pence
• Template:AUD
• Template:BDT
• Template:CAD
• Template:CNY
• Template:INR
• Template:JPY
• Template:Philippine peso
• Template:PKR
• Template:US$