View source for Template:Bbl to t/doc

{{Documentation subpage}}

==Usage==
:{{tlx|bbl to t| 1 | 2 | 3 | 4 {{para|API||plain=y}}{{para|abbr||plain=y}}{{para|lk||plain=y}}{{para|adj||plain=y}}{{para|per||plain=y}}{{para|t_per||plain=y}}{{para|mlt||plain=y}}}}

===Examples===
:{|
|-
|
|{{tlx|bbl to t|100}}||gives||{{bbl to t|100}}
|-
|''round to three significant figures'':
|{{tlx|bbl to t|100|3}}||gives||{{bbl to t|100|3}}
|-
|''define density'':
|{{tlx|bbl to t|100{{para|API|22|plain=y}}}}||gives||{{bbl to t|100|API=22}}
|-
|''abbreviate'':
|{{tlx|bbl to t|100{{para|abbr|on|plain=y}}}}||gives||{{bbl to t|100|abbr=on}}
|-
|''link'':
|{{tlx|bbl to t|100{{para|lk|on|plain=y}}}}||gives||{{bbl to t|100|lk=on}}
|-
|''adjectives''
|{{tlx|bbl to t|100{{para|adj|on|plain=y}}}}||gives||{{bbl to t|100|adj=on}}
|-
|''rates'':
|{{tlx|bbl to t|100{{para|per|d|plain=y}}}}||gives||{{bbl to t|100|per=d}}
|-
|''rates with different time units'':
|{{tlx|bbl to t|100{{para|per|d|plain=y}}{{para|t_per|a|plain=y}}}}||gives||{{bbl to t|100|per=d|t_per=a}}
|-
|''ranges'':
|{{tlx|bbl to t|100|to|200}}||gives||{{bbl to t|100|to|200}}
|-
|''large numbers of barrels'':
|{{tlx|bbl to t|100{{para|mlt|M|plain=y}}}}||gives||{{bbl to t|100|mlt=M}}
|}

See [[Template talk:Bbl to t#More examples|talk]] for more examples.

===Parameters===
''Italicized'' parameters are optional:
*'''1''' is a required parameter, which specifies the number of oil barrels to be converted to tonnes (metric tons).  Please do not format this parameter; i.e., use 1234 instead of 1,234.
*'''''API''''' is the [[API gravity]] factor.  The default value is&nbsp;33.4, corresponding to a density of 858.1&nbsp;kg/m³ or 7.330 bbl/t at 60&nbsp;°F.
*'''''2''''' can either be a word or a number dependant on "[[#Modes|mode]]".
*'''''3''''' is used only in range mode.
*'''''4''''' is used only in range mode.
*'''''abbr''''' can take values of either ''on'' or ''off''.  The default value is ''off'', which will show the names of the units as specified in the [[WP:MOSNUM#Units of measurement|Manual of Style for dates and numbers]] (barrels, t); ''on'' will show the abbreviated names of the units (bbl, t).
*'''''lk''''' specifies whether the names of the units should be linked and can take values of either ''on'' or ''off''. The default value is ''off''.
*'''''adj''''' is used for adjectives and can take values of either ''on'' or ''off''.  The default value is ''off''.  Setting this parameter to ''on'' will put hyphens in and make ''barrel'' singular.
*'''''per''''' is used for rates. Use <code>h</code> for "per hour", <code>d</code> for "per day" and <code>a</code> for "per [[annum]]".
*'''''t_per''''' is used for tonne rates if a different time unit than that used for barrels is desired.
*'''''mlt''''' specifies whether to convert barrels, thousands of barrels, millions of barrels, billions of barrels or trillions of barrels.  Set this parameter to the appropriate [[SI prefix]].  Note the billion and trillion used here are the "[[long and short scales|short scale]]" ones (10<sup>9</sup> and 10<sup>12</sup> respectively).

===Modes===
;Single-conversion mode
In single-conversion mode template converts a single value.  In standard mode '''''2''''' determines the number of significant figures in the output.

;Dual-conversion mode
Setting '''''2''''' to a word puts the template into dual-conversion mode.  In this mode the template converts two values conjoined with the given word.  The first value is determined by '''1''' and the second value is determined by '''3'''.  In dual conversion mode the number of significant figures in the output can be given by '''''4'''''.

===Rounding===
;Rounding to a given number of significant figures
The template rounds conversions to the number of significant figures given by either '''''2''''' or '''''4''''' (dependant on mode as noted above).

;Default rounding
Where no number of significant figures is specified the default is to round according to the number of significant figures in the input. See [[Template talk:Bbl to t#New features|talk]] for details.

==Template Data==
{{Template data header}}
<templatedata>
{
	"params": {
		"1": {},
		"2": {},
		"3": {},
		"4": {},
		"lk": {},
		"abbr": {},
		"adj": {},
		"per": {},
		"mlt": {},
		"API": {},
		"t_per": {}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"lk",
		"abbr",
		"adj",
		"per",
		"mlt",
		"API",
		"t_per"
	]
}
</templatedata>

==See also==
{{Math templates|conversion}}

<includeonly>{{Sandbox other||
[[Category:Conversion templates|Bbl To T]]
[[Category:Convert-like templates|{{SUBPAGENAME}}]]
}}</includeonly>