=== Sankhyaank ===
Contributors: rahultank
Tags: number format, lakh, crore, rupee, shortcode
Requires at least: 6.0
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Show numbers the Indian way: 12,34,567, 12.35 lakh or 2 crore, with the rupee sign and Gujarati or Devanagari digits.

== Description ==

WordPress groups digits in threes (1,234,567). In India the same number is written 12,34,567, and large amounts are usually read in lakh and crore.

Sankhyaank ("sankhyaank" means numeral in Hindi and Gujarati) adds a shortcode that writes a number in the Indian numbering system:

* `[sankhyaank value="1234567"]` → 12,34,567
* `[sankhyaank value="1234567" style="words"]` → 12.35 lakh
* `[sankhyaank value="20000000" style="words"]` → 2 crore
* `[sankhyaank value="250000" currency="inr"]` → ₹2,50,000
* `[sankhyaank value="1234567" digits="gujarati"]` → ૧૨,૩૪,૫૬૭
* `[sankhyaank value="1234567" digits="devanagari"]` → १२,३४,५६७

= Shortcode options =

* `value` – the number. Commas and spaces in it are ignored.
* `style` – `digits` (default) for 12,34,567, or `words` for thousand, lakh and crore.
* `decimals` – how many decimal places to show. By default the number keeps its own decimals, and `words` uses up to 2.
* `digits` – `latin` (default), `gujarati`, `devanagari`, or `auto` to use Gujarati digits on a Gujarati site and Devanagari digits on a Hindi or Marathi site.
* `currency` – `inr` to add the rupee sign.

Large numbers stay exact, because the formatting works on the digits as text instead of converting them to a floating point number.

The words thousand, lakh and crore can be translated, so a site in Gujarati or Hindi can show them in its own language once translations are available.

= For developers =

Use the same formatting in a theme or plugin:

`echo esc_html( Sankhyaank::format( 1234567, array( 'style' => 'words' ) ) );`

The plugin has no settings, stores nothing in the database and does not contact any external service.

== Installation ==

1. Upload the `sankhyaank` folder to `/wp-content/plugins/`, or install it from the Plugins screen.
2. Activate the plugin.
3. Add the shortcode to a post, a page or a Shortcode block.

== Frequently Asked Questions ==

= What happens if the value is not a number? =

The value is shown as it was given, without formatting.

= Does it change the numbers WordPress shows elsewhere? =

No. Only numbers inside the shortcode, or passed to `Sankhyaank::format()`, are formatted.

= Can it show amounts in words, such as "twelve lakh"? =

Not in this version. The `words` style writes the number in digits followed by the unit, such as 12 lakh.

== Changelog ==

= 1.0.0 =
* First release.
