aboutsummaryrefslogtreecommitdiff
path: root/docs/templates.md
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2021-09-27 18:19:53 -0400
committerGitHub <noreply@github.com>2021-09-27 18:19:53 -0400
commitb784e5b11a596a456eb8879d394fde64bc63aaef (patch)
tree411419b07d224ca1bd11d79cc302a1055a012dd1 /docs/templates.md
parent729abbf5616f93a641bb6b68593e524b352b2a19 (diff)
Katakana to hiragana conversion options (#1965)
* Refactor convertKatakanaToHiragana * Add keepProlongedSoundMarks option * Test keepProlongedSoundMarks option * Refactor * Add keepProlongedSoundMarks option to hiragana handlebars helper * Update documentation
Diffstat (limited to 'docs/templates.md')
-rw-r--r--docs/templates.md11
1 files changed, 9 insertions, 2 deletions
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>