Template:FloorNumber/doc

The FloorNumber template outputs a textual floor reference using the British style; it takes an input in American style numbering. An optional tooltip is also provided to explain the floor reference to the reader.

The reason for this adjustment is that British floor numbering counts the ground floor as zero, followed by 1, 2, etc. In the American (U.S.) system, the ground floor and first floor are synonymous. The adjustment of -1 (ie. UK = US - 1) ensures they start at the same place. The appropriate ordinal suffix (st nd rd th) is then applied.

Note: This template does not yet support basements, i.e. US floors B (or B1) and below.

This template is used in conjunction with Floor which is used at the top or near the very top of the article.

Parameters

 * # - Required. The floor number using the American numbering style: 1, 2, 3, etc. No 0.
 * In a building whose door is level with the ground, this is the floor that a person would be on immediately after enter that building.
 * American second floor, as well as any other numbers above 1, are output as the British floor  (or with other appropriate ordinal suffix). For example:
 * the second floor (US), would become the 1st floor in the (UK).
 * the fourth floor (US), would become the 3rd floor (UK);
 * caps - Optional. If this parameter is added (written as is), the output will be: Ground floor, First floor, etc.
 * nohelp - Optional. If this parameter is added (written as is), the help tooltip will not display. Applying this parameter won't affect of the article's Table of Contents appears if the template is used in a section heading.