View source for Template:Roman/doc

{{Documentation subpage}}
<!-- Please, add categories and interwikis at the bottom of this page. -->
{{High-use}}
{{Lua|Module:Roman}}
{{Lua sidebar}}

This template converts [[Arabic numeral]]s (that is, 1, 2, 3, etc.) into [[Roman numeral]]s (I, II, III etc.).  It currently works for any whole number between 1 and 4999999.

== Usage ==
<syntaxhighlight lang="wikitext">{{Roman|number|message}}</syntaxhighlight>

Replace <code>''number''</code> with the number you would like to be converted to Roman numerals. For numbers higher than 4999999 the template outputs "N/A". This can be changed by replacing <code>''message''</code> with your preferred text.

An overline, representing multiplication by 1000, is used to extend the upper range of the function.

See [[Roman numerals]] for further information.

=== Fraction support ===
The template can accept parsing decimals, fractions, and arithmetic expressions. This is not enabled by default. To enable this, supply {{Para|fraction|yes}}, i.e. <code><nowiki>{{Roman|105.5|fraction=yes}}</nowiki></code> or <code><nowiki>{{Roman|105.5|too big|fraction=yes}}</nowiki></code>.

Roman numeral output for fractional values uses these symbols:
*S = {{1/2}}
*''':''' = {{Frac|1|6}}
*• = {{Frac|1|12}}
*Є = {{Frac|1|24}}
*ƧƧ = {{Frac|1|36}}
*Ɔ = {{Frac|1|48}}
*Ƨ = {{Frac|1|72}}
*<s>Ƨ</s> = {{Frac|1|144}}
*℈ = {{Frac|1|288}}
*» = {{Frac|1|1728}}
*N = 0

== Examples ==
{|class="wikitable" style="text-align:right"
! Arabic numerals !! Template call !! Roman numerals
|-
|0 || {{Tlx|Roman|0}} || {{Roman|0}}
|-
|1 || {{Tlx|Roman|1}} || {{Roman|1}}
|-
|2 || {{Tlx|Roman|2}} || {{Roman|2}}
|-
|49 || {{Tlx|Roman|49}} || {{Roman|49}}
|-
|50 || {{Tlx|Roman|50}} || {{Roman|50}}
|-
|51 || {{Tlx|Roman|51}} || {{Roman|51}}
|-
|1024 || {{Tlx|Roman|1024}} || {{Roman|1024}}
|-
|4999 || {{Tlx|Roman|4999}} || {{Roman|4999}}
|-
|5000 || {{Tlx|Roman|5000}} || {{Roman|5000}}
|-
|5001 || {{Tlx|Roman|5001}} || {{Roman|5001}}
|-
|69105 || {{Tlx|Roman|69105}} || {{Roman|69105}}
|-
|1048576 || {{Tlx|Roman|1048576}} || {{Roman|1048576}}
|-
|4999999 || {{Tlx|Roman|4999999}} || {{Roman|4999999}}
|-
|7654321 || {{Tlx|Roman|7654321}} || {{Roman|7654321}}
|-
|7654321 || {{Tlx|Roman|7654321|too high}} || {{Roman|7654321|too high}}
|}

If the number provided is negative, the template will output an error message. If the first parameter provided cannot be interpreted as a number, the template will also output an error message. If no arguments are given, the template produces no output.

=== Decimal, fractional, and arithmetic examples ===
{|class="wikitable" style="text-align:right"
! Value !! Template Call !! Roman Numerals
|-
|0.0005 || {{Tlx|Roman|0.0005|fraction=yes}} || {{Roman|0.0005|fraction=yes}}
|-
|20.002 || {{Tlx|Roman|20.002|fraction=yes}} || {{Roman|20.002|fraction=yes}}
|-
|110.003472 || {{Tlx|Roman|110.003472|fraction=yes}} || {{Roman|110.003472|fraction=yes}}
|-
|3+4.007 || {{Tlx|Roman|3+4.007|fraction=yes}} || {{Roman|3+4.007|fraction=yes}}
|-
|1-0.9861 || {{Tlx|Roman|1-0.9861|fraction=yes}} || {{Roman|1-0.9861|fraction=yes}}
|-
|4.6*2.5 || {{Tlx|Roman|4.6*2.5|fraction=yes}} || {{Roman|4.6*2.5|fraction=yes}}
|-
|1/3 || {{Tlx|Roman|1/3|fraction=yes}} || {{Roman|1/3|fraction=yes}}
|-
|9999/10000 || {{Tlx|Roman|9999/10000|fraction=yes}} || {{Roman|9999/10000|fraction=yes}}
|-
|100+5.5 || {{Tlx|Roman|100+5.5|fraction=yes}} || {{Roman|100+5.5|fraction=yes}}
|}

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"type": "number",
			"label": "Number",
			"example": "69105",
			"description": "The number to be converted to Roman numerals. If the parameter passed cannot be interpreted as a numerical value, no output is generated."
		},
		"2": {
			"default": "N/A",
			"label": "Message",
			"example": "Too big",
			"description": "Message to display for numbers that are too big to be displayed in Roman numerals. (The largest number supported is 4999999.)",
			"type": "string"
		}
	},
	"description": "Convert numbers to Roman numerals."
}
</templatedata>

==See also==
*{{Tl|Rn}}
*{{Tl|Serif}}
{{Math templates|numeral systems}}

<includeonly>{{Sandbox other||{{#ifeq:{{PAGENAME}}|{{BASEPAGENAME}}|
<!-- Categories and interwikis here, thanks. -->
[[Category:Numerical conversion templates]]
}}}}</includeonly>
<noinclude>
[[pt:Predefinição:Roman/doc]]
</noinclyde>