Skip to content

Commit 634d1d1

Browse files
committed
docs: Improve plural example
1 parent f2adcb6 commit 634d1d1

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

dist/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,6 @@
181181
}
182182
</style></head><body><h1>TIK Cheatsheet</h1>This cheatsheet will help you write <a target="_blank" href=" https://github.com/romshark/tik">textual internationalization keys (TIKs)</a> in the default setting for locale <code>en</code>. <section aria-labelledby="string"><div class="section-header"><h2 id="string"><code>{"..."}</code> String</h2><p>Replaces <code>...</code> with an arbitrary string value.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>Avoid comparing {&#34;apples&#34;} to {&#34;oranges&#34;}.</code></td></tr><tr><td>ICU</td><td><code>Avoid comparing {var0} to {var1}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;cats 🐈&#34;, &#34;var1&#34;: &#34;dogs 🐕&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Avoid comparing cats 🐈 to dogs 🐕</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;bananas&#34;, &#34;var1&#34;: &#34;anything really&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Avoid comparing bananas to anything really</span></div></div></li></ul></div></section><section aria-labelledby="integer"><div class="section-header"><h2 id="integer"><code>{7}</code> Integer</h2><p>Represents an integer number value.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>Your number is {3}</code></td></tr><tr><td>ICU</td><td><code>Your number is {var0, number, integer}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 42}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Your number is 42</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 0}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Your number is 0</span></div></div></li></ul></div></section><section aria-labelledby="number"><div class="section-header"><h2 id="number"><code>{3.14}</code> Number</h2><p>Represents a decimal number value.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>It&#39;s off by {3.14} degrees.</code></td></tr><tr><td>ICU</td><td><code>It&#39;s {var0, number} degrees.</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 42}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s off by 42 degrees.</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 0.628}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s off by 0.628 degrees.</span></div></div></li></ul></div></section><section aria-labelledby="cardinal-pluralization"><div class="section-header"><h2 id="cardinal-pluralization"><code>{"2 ..."}</code> Cardinal Pluralization</h2><p>Pluralizes <code>...</code> to the correct <a
183183
href="https://www.unicode.org/cldr/charts/47/supplemental/language_plural_rules.html">CLDR
184-
plural form</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>You have {2 unread messages} in {2 groups}.</code></td></tr><tr><td>ICU</td><td><code>You have {var0, plural, one{# unread message} other{# unread messages}} in {var1, plural, one{# group} other{# groups}}}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 4, &#34;var1&#34;: 1}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>You have 4 unread messages in 1 group</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 1, &#34;var1&#34;: 1}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>You have 1 unread message in 1 group</span></div></div></li></ul></div></section><section aria-labelledby="ordinal-pluralization"><div class="section-header"><h2 id="ordinal-pluralization"><code>{4th}</code> Ordinal Pluralization</h2><p>Represents a <a
184+
plural form</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>You have {2 unread messages} in {2 groups}.</code></td></tr><tr><td>ICU</td><td><code>You have {var0, plural, one{# unread message} other{# unread messages}} in {var1, plural, one{# group} other{# groups}}}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 4, &#34;var1&#34;: 3}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>You have 4 unread messages in 3 groups</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 1, &#34;var1&#34;: 1}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>You have 1 unread message in 1 group</span></div></div></li></ul></div></section><section aria-labelledby="ordinal-pluralization"><div class="section-header"><h2 id="ordinal-pluralization"><code>{4th}</code> Ordinal Pluralization</h2><p>Represents a <a
185185
href="https://www.unicode.org/cldr/charts/47/supplemental/language_plural_rules.html">CLDR
186186
ordinal plural</a> value.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>You are {4th} in the queue.</code></td></tr><tr><td>ICU</td><td><code>You are {var0, selectordinal, one{#st} two{#nd} few{#rd} other{#th}} in the queue.</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 1}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>You are 1st in the queue.</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: 9}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>You are 9th in the queue.</span></div></div></li></ul></div></section><section aria-labelledby="gender"><div class="section-header"><h2 id="gender"><code>{They}</code> Gender</h2><p>Represents a gender subject.</p></div><div class="section-body"><div class="aliases"><div class="labeled alias"><label>alias</label> <span>them</span></div><div class="labeled alias"><label>alias</label> <span>their</span></div><div class="labeled alias"><label>alias</label> <span>theirs</span></div><div class="labeled alias"><label>alias</label> <span>themself</span></div></div><table><tr><td>Example</td><td><code>{They} received the message!</code></td></tr><tr><td>ICU</td><td><code>{var0, select, male{He} female{She} other{They}} received the message!</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;male&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>He received the message</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;female&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>She received the message</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;neutral&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>They received the message</span></div></div></li></ul></div></section><section aria-labelledby="date-short"><div class="section-header"><h2 id="date-short"><code>{7/16/99}</code> Date Short</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-date-formats">CLDR short date</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>Today is {7/16/99}</code></td></tr><tr><td>ICU</td><td><code>Today is {var0, date, short}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is 1/26/25</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is 9/2/98</span></div></div></li></ul></div></section><section aria-labelledby="date-medium"><div class="section-header"><h2 id="date-medium"><code>{Jul 16, 1999}</code> Date Medium</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-date-formats">CLDR medium date</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>Today is {Jul 16, 1999}</code></td></tr><tr><td>ICU</td><td><code>Today is {var0, date, medium}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is Jan 26, 2025</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is Sep 2, 1998</span></div></div></li></ul></div></section><section aria-labelledby="date-long"><div class="section-header"><h2 id="date-long"><code>{July 16, 1999}</code> Date Long</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-date-formats">CLDR long date</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>Today is {July 16, 1999}</code></td></tr><tr><td>ICU</td><td><code>Today is {var0, date, long}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is January 26, 2025</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is September 2, 1998</span></div></div></li></ul></div></section><section aria-labelledby="date-full"><div class="section-header"><h2 id="date-full"><code>{Friday, July 16, 1999}</code> Date Full</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-date-formats">CLDR full date</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>Today is {Friday, July 16, 1999}</code></td></tr><tr><td>ICU</td><td><code>Today is {var0, date, full}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is Sunday, January 26, 2025</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>Today is Wednesday, September 2, 1998</span></div></div></li></ul></div></section><section aria-labelledby="time-short"><div class="section-header"><h2 id="time-short"><code>{10:30 pm}</code> Time Short</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-time-formats">CLDR short time</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>It&#39;s {10:30 pm}</code></td></tr><tr><td>ICU</td><td><code>It&#39;s {var0, time, short}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 4:20 pm</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50-07:00&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 8:20 pm</span></div></div></li></ul></div></section><section aria-labelledby="time-medium"><div class="section-header"><h2 id="time-medium"><code>{10:30:45 pm}</code> Time Medium</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-time-formats">CLDR medium time</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>It&#39;s {10:30:45 pm}</code></td></tr><tr><td>ICU</td><td><code>It&#39;s {var0, time, medium}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 4:20:50 pm</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50-07:00&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 8:20:50 pm</span></div></div></li></ul></div></section><section aria-labelledby="time-long"><div class="section-header"><h2 id="time-long"><code>{10:30:45 pm PDT}</code> Time Long</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-time-formats">CLDR long time</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>It&#39;s {10:30:45 pm PDT}</code></td></tr><tr><td>ICU</td><td><code>It&#39;s {var0, time, long}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 4:20:50 pm UTC</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50-07:00&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 8:20:50 pm PDT</span></div></div></li></ul></div></section><section aria-labelledby="time-full"><div class="section-header"><h2 id="time-full"><code>{10:30:45 pm Pacific Daylight Time}</code> Time Full</h2><p>Represents a <a href="https://cldr.unicode.org/translation/date-time/date-time-patterns#basic-time-formats">CLDR full time</a>.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>It&#39;s {10:30:45 pm Pacific Daylight Time}</code></td></tr><tr><td>ICU</td><td><code>It&#39;s {var0, time, full}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;2025-01-26T16:20:50Z&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 4:20:50 pm UTC</span></div></div></li><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: &#34;1998-09-02T20:20:50-07:00&#34;}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>It&#39;s 8:20:50 pm Pacific Daylight Time</span></div></div></li></ul></div></section><section aria-labelledby="currency"><div class="section-header"><h2 id="currency"><code>{$1}</code> Currency</h2><p>Represents an amount of money.</p></div><div class="section-body"><div class="aliases"></div><table><tr><td>Example</td><td><code>The price is {$1}</code></td></tr><tr><td>ICU</td><td><code>The price is {var0, number, ::currency/auto}</code></td></tr></table><ul class="examples"><li><div class="example"><div class="labeled data"><label>data</label> <span>{&#34;var0&#34;: {&#34;currency&#34;: &#34;USD&#34;, &#34;amount&#34;: 12.99}}</span></div><div class="arrow"></div><div class="labeled text"><label>text</label> <span>The price is $12.99</span></div></div></li></ul></div></section><ul><li>TIK's <a target="_blank" href="https://github.com/romshark/tik?tab=readme-ov-file#magic-constants">magic constants</a> (and any of their variants) are case insensitive.</li><li><a target="_blank" href="https://unicode-org.github.io/icu/userguide/format_parse/messages/">ICU Message Format</a></li></ul></body></html>

main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ func main() {
8585
ICU: `You have {var0, plural, one{# unread message} other{# unread messages}} in {var1, plural, one{# group} other{# groups}}}`,
8686
Examples: []Example{
8787
{
88-
Data: `{"var0": 4, "var1": 1}`,
89-
Text: `You have 4 unread messages in 1 group`,
88+
Data: `{"var0": 4, "var1": 3}`,
89+
Text: `You have 4 unread messages in 3 groups`,
9090
},
9191
{
9292
Data: `{"var0": 1, "var1": 1}`,

0 commit comments

Comments
 (0)