View source for Template:Volume/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This template calculates the volume of a three-dimensional space.  This is for cubic feet, cubic centimeters, etc., not for converting linear measures to things like gallons.

It only accepts numeric input, not units, and does not perform conversions.

By default, it simply outputs the calculated volume, rounded to two decimal places (if rounding can be applied). Rounding value can be changed.

It can also be told to output table cells showing all three of the dimensional measures followed by the volume.

==Usage==

{{tlx|{{BASEPAGENAME}}|1|2|3}} produces: {{ {{BASEPAGENAME}}|1|2|3}}

{{tlx|{{BASEPAGENAME}}|1.1|22.22|333.333}} produces: {{ {{BASEPAGENAME}}|1.1|22.22|333.333}}

{{tlx|{{BASEPAGENAME}}|1|2|3|cells=yes}} produces:<br /><code>{{ {{BASEPAGENAME}}|1|2|3|cells=yes}}</code>

{{tlx|{{BASEPAGENAME}}|1.1|22.22|333.333|cells=yes}} produces:<br /><code>{{ {{BASEPAGENAME}}|1.1|22.22|333.333|cells=yes}}</code>

===Parameters===

*{{para|1|{{var|x}}}} or first unnamed parameter – First measure (e.g. length). Must be numerals (e.g. 12) or a number in decimal format (e.g. 47.93). {{em|Do not include a unit}} or any other data.
*{{para|2|{{var|y}}}} or second unnamed parameter – Second measure (e.g. width). Same format as above.
*{{para|3|{{var|z}}}} or third unnamed parameter – Third measure (e.g. height/depth). Same format as above.
*{{para|round|{{var|n}}}} – Specify a different rounding from the default, which is <code>2</code> (rounded to two decimal places, if rounding applies). Must be a numeral.
*{{para|cells|{{kbd|yes}}}} (or any other value such as {{kbd|y}} or {{kbd|true}} – Cause the template to output an inline row of table cells in the format:<br /><code><nowiki>| </nowiki>{{var|x}}<nowiki> || </nowiki>{{var|y}}<nowiki> || </nowiki>{{var|z}}<nowiki> || </nowiki>{{var|volume}}</code><br />(this does not include a <code><nowiki>|-</nowiki></code> line to create the table row, only the line of cells).

This template does not currently support any units or conversion.  This could be changed.

=== Use cases ===
* Inline: "<code>The tank has a capacity of {{tl|{{BASEPAGENAME}}|12|7.5|6}} cubic feet ({{tl|{{BASEPAGENAME}}|3.66|2.29|1.83}} m<nowiki><sup>3</sup></nowiki>)</code>"
** Another option (so you needn't do any manual conversion) is to add the first part (the feet measure in the example), do a page preview and note what the calculation is ({{ {{BASEPAGENAME}}|12|7.5|6}} in this case), then feed that to {{tlx|convert}}: "... <code>({{tlf|convert|540|cuft|m3|2|disp{{=}}out}})</code>"
** The two methods above can produce mismatched approximations. The first applied your own two-decimal rounding to each ft to m conversion, then multiplied these together, producing a result of 15.34. The latter method took unrounded values that were calculated from feet to meters, multiplied them, then rounded the result, producing output of <samp>15.29</samp>.  The latter method is more accurate when starting with only one set of sourced measurements. The former method may be preferable when the source provides both sets of dimensional measures, since the editor cannot be certain in which unit the measure was more accurately performed (i.e., which was converted and approximated from which), unless the source explicitly specifies this.
* Table: Create a table the headers of which specify what the units are, then a table row, then this template, with {{para|cells|y}}, as the content of the table row (the template creates cells, it doesn't go in one).  If a conversion is required, it could be provided in an additional cell, in a column for that unit, e.g. with:<br /><code>{{tl|{{BASEPAGENAME}}|3.66|2.29|1.83|cells{{=}}y}} {{!}}{{!}} {{tlp|convert|540|cuft|m3|2|disp{{=}}number}}</code>

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Mathematical function templates]]

}}</includeonly>