Skip to content

Latest commit

 

History

History
72 lines (40 loc) · 2.46 KB

README.md

File metadata and controls

72 lines (40 loc) · 2.46 KB
Raw

iconRoman

Craft CMS 4.0.0+ Scrutinizer Code Quality

Convert an integer into roman numerals and vice versa.

Roman banner

— Based on the Craft 2 version of the Roman plugin by Bransin Anderson

Installation

Requirements

This plugin requires Craft CMS 4.0.0 or later.

Plugin Store

Log into your control panel and click on 'Plugin Store'. Search for 'Roman'.

Composer

  1. Open your terminal and go to your Craft project:
cd /path/to/project
  1. Then tell Composer to load the plugin:
composer require jalendport/craft-roman
  1. In the Control Panel, go to Settings → Plugins and click the “Install” button for Roman.

Using Roman

Roman provides several Twig methods for easy conversion between integers and roman numerals:

  • You can pass an integer (or a string) into the getRoman() method to get roman numerals:

    {{ craft.roman.getRoman(298) }}     // Output: CCXCVIII
{{ craft.roman.getRoman('539') }}   // Output: DXXXIX

  • You can pass a string (of roman numerals) into the getNumber() method to get an integer:

    {{ craft.roman.getNumber('ML') }}   // Output: 1050

  • Roman also includes a helper attribute to quickly get the current year in roman numeral form:

    {{ craft.roman.currentYear }}       // Output: MMXXIII

Found a Bug? Need Support?

Please open an issue describing what's going wrong.

Roadmap

Some things to do, and ideas for potential features:

  • Twig filter for converting all integers in a string of text to roman numerals.

If there's a feature you think should be added to Roman, please open an issue. PRs are also welcome!

Contributors