The FloorNumber template outputs a textual floor reference, using the recommended British style; it takes an input in American style numbering. A note is also provided to explain the floor reference to the reader.
The first parameter for this template is the floor number, using the American style:
- The American first floor (input as the number
1) will output as the British
- 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
(number - 1)th floor(or with other appropriate ordinal suffix). For example:
- the second floor (US), would become the 1st floor in the (UK).
- the seventh floor (US), would become the 6th floor (UK);
- Note: the emphasis in the explanation above is added, and is not reproduced in the text after this template is transcluded, as below.
There are other parameters which will alter the display of the text:
- If nohelp is added, the tooltip help will not display.
- If caps is added, with the first floor (US), the output will be Ground floor.
Examples in context, as template inputs and outputs, are below:
| ||groundUK] floor[|
| ||1stUK] floor[|
| ||2ndUK] floor[|
| ||Ground floor|
| ||21st floor|
This template does not yet support basements, i.e. US floors 0 and below, nor successive basements below those.
The reason for this adjustment is that British floor numbering counts from zero on the ground floor. The American (US) system starts from one. The adjustment of -1 (ie, US n + -1 = UK n) ensures they start at the same place.For clarity in this documentation, American numbers are written out as full words, and British numbers are written as "number ordinal". However, in general usage writing them out as words (first, second) is also used.