Module:Roman/doc

Notes

This module contains functions for working with Roman numerals. Currently used by:

• {{Roman}}
• {{Roman year}}

Using this module from templates

Year

This function returns a year formatted as a Roman numeral. It works for years between 1 and 4999999. The output string may contain HTML tags. If the input does not look like it contains a year or the year is outside of the supported range an error message is returned. If an error message is returned, the error message will contain code to categorize pages into Category:Errors reported by Module Roman.

Usage:

{{#invoke:Roman|Year|year}}

Numeral

This function converts an Arabic numeral into a Roman numeral. It works for values between 0 and 4999999. The output string may contain HTML tags. Arabic numeral zero is output as an empty string. If the input does not look like it contains a number or the number is outside of the supported range an error message is returned. If an error message is returned, the error message will contain code to categorize pages into Category:Errors reported by Module Roman.

Usage:

{{#invoke:Roman|Numeral|value}}

Using this module from Lua code

In order to use the functions in this module from another Lua module you first have to import this module.

Example:

local roman = require('Module:Roman')

_Year

This function returns a year formatted as a Roman numeral. It works for years between 1 and 4999999. The output string may contain HTML tags. If the input does not look like it contains a year or the year is outside of the supported range an error message is returned. If an error message is returned, the error message will contain code to categorize pages into Category:Errors reported by Module Roman.

Usage:

roman_year = roman._Year(year)

_Numeral

This function converts an Arabic numeral into a Roman numeral. It works for values between 0 and 4999999. The output string may contain HTML tags. Arabic numeral zero is output as an empty string. If the input does not look like it contains a number or the number is outside of the supported range an error message is returned. If an error message is returned, the error message will contain code to categorize pages into Category:Errors reported by Module Roman.

Usage:

roman_year = roman._Numeral(value)