From b784e5b11a596a456eb8879d394fde64bc63aaef Mon Sep 17 00:00:00 2001
From: toasted-nutbread <toasted-nutbread@users.noreply.github.com>
Date: Mon, 27 Sep 2021 18:19:53 -0400
Subject: Katakana to hiragana conversion options (#1965)

* Refactor convertKatakanaToHiragana

* Add keepProlongedSoundMarks option

* Test keepProlongedSoundMarks option

* Refactor

* Add keepProlongedSoundMarks option to hiragana handlebars helper

* Update documentation
---
 docs/templates.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/templates.md b/docs/templates.md
index 638c79a6..778b8e2d 100644
--- a/docs/templates.md
+++ b/docs/templates.md
@@ -786,11 +786,14 @@ Converts katakana text to hiragana.
 <details>
   <summary>Syntax:</summary>
 
-  <code>{{#hiragana <i>value</i>}}{{/hiragana}}</code><br>
-  <code>{{#hiragana}}<i>value</i>{{/hiragana}}</code><br>
+  <code>{{#hiragana <i>value</i> <i>[keepProlongedSoundMarks=true|false]</i>}}{{/hiragana}}</code><br>
+  <code>{{#hiragana <i>[keepProlongedSoundMarks=true|false]</i>}}<i>value</i>{{/hiragana}}</code><br>
 
   * _`value`_ <br>
     The text to convert.
+  * _`keepProlongedSoundMarks`_ _(optional)_ <br>
+    Whether or not the `ー` character should be kept or converted to a vowel character.
+    Defaults to `false` if not specified.
 </details>
 <details>
   <summary>Example:</summary>
@@ -798,12 +801,16 @@ Converts katakana text to hiragana.
   ```handlebars
   {{#hiragana "よみちゃん ヨミちゃん ヨミチャン"}}{{/hiragana}}
   {{#hiragana}}よみちゃん ヨミちゃん ヨミチャン{{/hiragana}}
+  {{#hiragana}}ローマ字{{/hiragana}}
+  {{#hiragana keepProlongedSoundMarks=true}}ローマ字{{/hiragana}}
   ```
 
   Output:
   ```html
   よみちゃん よみちゃん よみちゃん
   よみちゃん よみちゃん よみちゃん
+  ろうま字
+  ろーま字
   ```
 </details>
 
-- 
cgit v1.2.3