Drducker: Documentation for a trial of a cleaned-up height template

2008-06-24T11:03:10Z

Documentation for a trial of a cleaned-up height template

New page

{{documentation subpage}}

=== DO NOT USE ===
This template is still in progress, please don't expect it to be useful yet.

=== Normalized Parameter Names for height template ===
This is for use as a normalized form of the height styling template, thus allowing some of the fragility of the older height template to be separated out.

=== Parameters ===
* m: height in meters (metric)
* f: feet portion of height (imperial)
* i: inch portion of height (imperial)
* abbr: '''yes''' | no | mos ; mos stands for "Manual Of Style"
* spel: '''American''' | Comonwealth ; displays "meters" or "metres" respectively
* frac: ''numeric'' ; fractional measurements; 10 yields inches as decimals, others act as denominators; ignored in imperial to metric conversions.
* prec: ''numeric'' ; decimal precision
* wiki: yes | '''no'''

==Instructions==
*The template is intended for conversion of heights specified in either meters, or in feet and inches. Meters are converted to feet and inches, and feet and inches are converted to meters.
*As this template is intended for use in infoboxes, the units on both sides of the conversion are abbreviated by default. When using this template outside of infoboxes, use the ''abbr'' parameter, which can take values of ''yes'' (default; both sides of the conversion are abbreviated), ''no'' (both sides of the conversion are spelled out), or ''mos'' (MOSNUM-compliant format, where the units being converted are spelled out and the units of the converted values are abbreviated).
*For conversion of meters to feet/inches, the ''frac'' parameter can be specified to either show the output inches as decimals (''frac''=10) or as a vulgar fraction (''frac''=desired denominator; the default is 2 for halves). The ''frac'' parameter is ignored for conversion of feet/inches to meters.
*When decimal output is used, the default precision is 1 for meters-to-feet/inches conversion and 2 for feet/inches-to-meters conversion, but it can be overridden by specifying a different figure using the ''precision'' parameter (see example below). The ''precision'' parameter is ignored when ''frac'' is set to anything but 10.
*''wiki'' parameter specifies whether the names of the units should be wikified or not and can take values of either ''yes'' or ''no''. The default value is ''no''.

==Code==
{| class="wikitable"
|-
! Code
! Result
|-
| <nowiki>{{height_npn|m=1.72}}</nowiki>
| {{height_npn|m=1.72}}
|-
| <nowiki>{{height_npn|m=1.72|prec=0}}</nowiki>
| {{height_npn|m=1.72|precision=0}}
|-
| <nowiki>{{height_npn|m=1.72|frac=16}}</nowiki>
| {{height_npn|m=1.72|frac=16}}
|-
| <nowiki>{{height_npn|f=6}}</nowiki>
| {{height_npn|f=6}}
|-
| <nowiki>{{height_npn|f=6|i=1}}</nowiki>
| {{height_npn|f=6|i=1}}
|-
| <nowiki>{{height_npn|f=6|i=1|prec=1}}</nowiki>
| {{height_npn|f=6|i=1|prec=1}}
|-
| <nowiki>{{height_npn|i=10}}</nowiki>
| {{height_npn|i=10}}
|-
| <nowiki>{{height_npn|m=1.72|abbr=no}}</nowiki>
| {{height_npn|m=1.72|abbr=no}}
|-
| <nowiki>{{height_npn|f=6|i=2|abbr=mos}}</nowiki>
| {{height_npn|f=6|i=2|abbr=mos}}
|-
| <nowiki>{{height_npn|f=6|i=2|wiki=yes}}</nowiki>
| {{height_npn|f=6|i=2|wiki=yes}}
|-
| <nowiki>{{height_npn|m=6|f=2}}</nowiki>
| {{height_npn|m=6|f=2}}
|}

<includeonly>

[[Category:Conversion templates|{{PAGENAME}}]]

</includeonly>

Template:Height npn/doc - Revision history

Drducker: Documentation for a trial of a cleaned-up height template