Skip to content

Commit cd81bbb

Browse files
keyman-serverkeyman-server
committed
auto: Keyboard help deployment
1 parent bdeff8a commit cd81bbb

2 files changed

Lines changed: 172 additions & 0 deletions

File tree

‎keyboard/hindi_flick/1.1/hindi_flick.php‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<?php
2+
$pagename = 'Hindi Flick Keyboard Help';
3+
$pagetitle = $pagename;
4+
require_once('header.php');
5+
?>
6+
7+
8+
<p>Hindi Flick is a mobile keyboard layout based upon the Devanagari varnamala's (alphabet) clustering of syllables. It is intended to be usable by anyone who knows the varnamala. It is inspired by the flick-based layouts popular in Japan and (to a lesser extent) Korea, as well as Vietnamese TELEX with regards to diacritic rules and magic.</p>
9+
<p>हिंदी फ्लिक एक देवनागरी वर्णमाला के अक्षरों के वर्गीकरण पर आधारित मोबाइल कुंजीपटल लेआउट है। इसका उद्देश्य है कि यह किसी भी वर्णमाला के जानकार के द्वारा उपयोगनीय हो। यह जापान और (कुछ कम स्तर तक) कोरिया में प्रसिद्ध "फ्लिक"-आधारित कुंजीपटल, तथा वियतनामी टेलेक्स में पाय जाने वाले मात्राओं को लेकर नियम से प्रेरणा लेता है।</p>
10+
11+
<p>Hindi Flick is based on the clustering of syllables according to the area of the mouth used that is inherent to
12+
Devanagari and many other Indian scripts. There are 7 such clusters in total (8 if you count the conjuncts क्ष, त्र,
13+
ज्ञ as a separate cluster), with 5 having five consonants each, and 2 having four each. Thus, we get a character set
14+
of 33 consonants. In addition, there are 12 vowels, out of which 10 are actually part of a pair of short and long
15+
vowels.</p>
16+
<p>We utilise these two facts - that there are upto 5 related consonants per consonant cluster, as well as that there
17+
are 10 pairs of short and long vowels, to be able to create a keyboard that encompasses nearly 50 characters (along
18+
with punctuation etc.) into only 12 keys. In addition, by adding numerous rules to the parser, we are able to
19+
correctly preserve the phonetic order of the characters and diacritics, something especially important for syllabic
20+
scripts (also known as <em>abugidas</em>) like Devanagari.</p>
21+
22+
<h2>Functionality and Usage</h2>
23+
24+
<div id='osk-phone' data-states='default abc_noshift shift numeric'>
25+
</div>
26+
27+
<p>Each <em>akshara</em> (syllable) key is equipped with the ability to produce not only the character on the key, but
28+
3-8 other related characters from its cluster (i.e. <em>varga</em>). This is done by flicking the key in the
29+
direction of the desired character. For example, flicking the क key to the right will produce ख, flicking it up will
30+
produce ग, and so on. The characters available on flicking are displayed on the key itself. They are ordered in
31+
clockwise order <strong>starting from the left</strong>. For keys with more than 4 options, the order continues
32+
<strong>from the top left corner of the key</strong>.</p>
33+
<p>Each of these options can also be accessed by holding the key for at least a second, which brings up a list of the
34+
available characters to choose from.</p>
35+
<p>Finally, you can also cycle through the characters available by tapping on the key multiple times.</p>
36+
37+
<h3>Vowels (<em>Svara</em>)</h3>
38+
<p>Vowels and their diacritics play a central role in designating sounds to consonants in most Indian scripts.
39+
<p>If you notice, the only vowels available on the key are the short vowels अ, इ, उ, ए, ओ (with additional, less used
40+
ones like ऋ and ऑ on the corners). This is to utilise the fact that each of these vowels has a corresponding long
41+
vowel, and thus there is no need to clutter the key with these. Instead, we provide the key <strong>अ↔आ</strong>
42+
which converts short vowels to long vowels and vice versa. This also works on their matras (diacritics).</p>
43+
<p>For example, क + इ = कि, and pressing <strong>अ↔आ</strong> makes it की.</p>
44+
<p>Speaking of diacritics, all the vowels have the corresponding diacritics as their output when a consonant is found
45+
as the previous character (except अ, which outputs the ा diacritic, as each consonant has the अ sound by default and
46+
ा is probably one of the most frequently used matras). The keyboard has rules in place to dictate what should happen
47+
in different scenarios. A few of these include:</p>
48+
49+
<ul>
50+
<li>If a <em>consonant</em> is found before adding a vowel, the vowel's diacritic is added. For example, क + इ = कि.
51+
</li>
52+
<li>If a <em>vowel</em> is found before adding a vowel, the whole vowel is placed, no diacritic (as it is
53+
nonsensical to do so). For example, इ + उ = इउ, not इु.</li>
54+
<li>If a <em>vowel diacritic</em> is found before adding a vowel, the whole new vowel is placed. For example, कि + उ
55+
= किउ.</li>
56+
<li>If an <em>anusvara</em> (ं), <em>chandrabindu</em> (ँ) or <em>visarga</em> (ः) is found before adding a vowel,
57+
the whole new vowel is placed. For example, कं + उ = कंउ.</li>
58+
</ul>
59+
60+
<h3>Matra to Svara Key (े↔ए)</h3>
61+
<p>Sometimes, it is not desired to put a matra right after a consonant, but rather a full vowel. This is where the
62+
<strong>े↔ए</strong> key comes in. It converts the matra to a full vowel and vice versa. For example, क + े = के,
63+
and pressing <strong>े↔ए</strong> makes it कए.</p>
64+
<p>An example of a word I can imagine this would be real helpful for is कई (many), where the ई is a full vowel and not
65+
a matra.</p>
66+
<h3>Halant (्)</h3>
67+
<p>The halant is a special character in Devanagari that is used to remove the inherent vowel sound from a consonant.
68+
It is used to create conjuncts, and is also used in many other scenarios. The halant key is placed at the bottom of
69+
the keyboard. Similar to the 12-kana keyboard, it also contains the flick-keys for parentheses, the Devanagari
70+
abbreviation sign (॰), and a dash.</p>
71+
<h3>Bindus and nuqtas</h3>
72+
<p>The tenth key in the keyboard contains the bindu (ँ), chandrabindu (ं), visarga (ः), chandra (ॅ) and nuqta (़)
73+
characters. The keyboard automatically handles the placement of these characters when a vowel is added after them.
74+
</p>
75+
<p>A particular note for nuqtas, the order utilised (as with other parts of the keyboard) is consonant + nuqta +
76+
matra. Even if you add a matra first, the nuqta will be placed after the consonant. This is to ensure that the nuqta
77+
is always placed after the consonant, as is the norm in Devanagari.</p>

‎keyboard/mara/1.0.6/mara.php‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<?php
2+
$pagename = 'Mara Keyboard Help';
3+
$pagetitle = 'Mara Keyboard Help';
4+
require_once('header.php');
5+
?>
6+
7+
<div class="container">
8+
<p style="text-align:center;">This keyboard is for the Mara language.</p>
9+
10+
<hr>
11+
12+
<h2>Description</h2>
13+
<p>The Mara Keyboard is designed for the Mara people to type easily in their language.</p>
14+
<p>The Mara Keyboard is based on the standard English (QWERTY) layout, but includes special characters for the Mara language.</p>
15+
<ul>
16+
<li>The <strong>Q</strong> key has been replaced with <strong>Â</strong> (unshifted <strong>â</strong>).</li>
17+
<li>The <strong>X</strong> key has been replaced with <strong>Ô</strong> (unshifted <strong>ô</strong>).</li>
18+
<li>The <strong>J</strong> key produces the digraph <strong>Ch</strong>.
19+
<ul>
20+
<li>Press <strong>j</strong> for <strong>ch</strong></li>
21+
<li>Press <strong>Shift</strong> + <strong>j</strong> for <strong>Ch</strong></li>
22+
<li>Turn on <strong>Caps Lock</strong> and press <strong>j</strong> for <strong>CH</strong></li>
23+
</ul>
24+
</li>
25+
</ul>
26+
27+
<h3>Typing Original English Letters</h3>
28+
<p>If you need to type the original English <strong>q</strong>, <strong>x</strong>, or <strong>j</strong>, you can use the <strong>Right Alt (AltGr)</strong> key:</p>
29+
<ul>
30+
<li><strong>Right Alt</strong> + <strong>q</strong> = <strong>q</strong> (Hold Shift for <strong>Q</strong>)</li>
31+
<li><strong>Right Alt</strong> + <strong>x</strong> = <strong>x</strong> (Hold Shift for <strong>X</strong>)</li>
32+
<li><strong>Right Alt</strong> + <strong>j</strong> = <strong>j</strong> (Hold Shift for <strong>J</strong>)</li>
33+
</ul>
34+
35+
<h3>Smart Backspace (Step-Wise Backspacing)</h3>
36+
<p>The keyboard features smart, step-wise backspacing for circumflex characters. Pressing <strong>Backspace</strong> immediately after typing <strong>â</strong>, <strong>Â</strong>, <strong>ô</strong>, or <strong>Ô</strong> will only delete the circumflex (<strong>^</strong>) and leave the base letter intact. Pressing it a second time will delete the base letter.</p>
37+
38+
<p>This allows for easy typing of the Mara alphabet while retaining access to standard English letters. The rest of the keys follow the standard QWERTY layout.</p>
39+
<p>The touch layout for phones follows a similar pattern, with the special characters readily available on the main keyboard layer.</p>
40+
41+
<h2>Palâsana</h2>
42+
<p>Mara Keyboard he Marasawzy ta âmo reih hmâpa ta chhuh awpa ta pachhuahpa a châ.</p>
43+
<p>Mara Keyboard he English (QWERTY) layout hmâpa ta pachhuahpa châ ta, Mara reihchâ liata hawhrawh eihpa ta <code>â</code>, <code>ô</code>, <code>ch</code> zy pahlaopa a châ.</p>
44+
<ul>
45+
<li><strong>Q</strong> key he <strong>Â</strong> (unshifted <strong>â</strong>) ta thla pa a châ.</li>
46+
<li><strong>X</strong> key he <strong>Ô</strong> (unshifted <strong>ô</strong>) ta thla pa a châ.</li>
47+
<li><strong>J</strong> key châta <strong>Ch</strong> he thlapa a châ.
48+
<ul>
49+
<li><strong>j</strong> key hmiepa a châ khiah, <strong>ch</strong></li>
50+
<li><strong>Shift</strong> + <strong>j</strong> key hmiepa a châ khiah, <strong>Ch</strong></li>
51+
<li><strong>Caps Lock</strong> ON nota <strong>j</strong> key hmiepa a châ khiah, <strong>CH</strong> a châ.</li>
52+
</ul>
53+
</li>
54+
</ul>
55+
56+
<h3>English Hawrawh Chhuhna</h3>
57+
<p>English hawrawh <strong>q</strong>, <strong>x</strong>, nata <strong>j</strong> zy chhuh awpa ta, <strong>Right Alt (AltGr)</strong> key hmâ theipa a châ:</p>
58+
<ul>
59+
<li><strong>Right Alt</strong> + <strong>q</strong> = <strong>q</strong> (<strong>Q</strong> châta Shift)</li>
60+
<li><strong>Right Alt</strong> + <strong>x</strong> = <strong>x</strong> (<strong>X</strong> châta Shift)</li>
61+
<li><strong>Right Alt</strong> + <strong>j</strong> = <strong>j</strong> (<strong>J</strong> châta Shift)</li>
62+
</ul>
63+
64+
<h3>Smart Backspace (Step-Wise Backspacing)</h3>
65+
<p>He keyboard liata smart backspace khôpa a châ. <strong>â</strong>, <strong>Â</strong>, <strong>ô</strong>, nata <strong>Ô</strong> na chhuh tawhta <strong>Backspace</strong> na hmie khiahta, luhkhu (<strong>^</strong>) he lei tua aw ta, hawhrawh pizy a y chy aw. Backspace na hmie heih khiahta hawhrawh pizy a lei aw.</p>
66+
67+
<p>He he Mara châhnawh chhuhna a pahlâ nawpa châta ta pachhuahpa a châ. Key hropazy cha QWERTY layout a ypa hawhta a y.</p>
68+
<p>Phone châta touch layout chhao he hawhna heta pachhuahpa châ ta, Mara reihchâ hnawh eih viapazy chhao main keyboard liana he hmâ theipa a châ haw bâ!</p>
69+
70+
<h2>Links</h2>
71+
<ul>
72+
<li>Keyboard Homepage: <a href="https://keyman.com/keyboards/mara" target="_blank" rel="noopener noreferrer">https://keyman.com/keyboards/mara</a></li>
73+
</ul>
74+
75+
<h2>Author & Copyright</h2>
76+
<p>This keyboard was created by <a href="https://laitei.dev" target="_blank" rel="noopener noreferrer">Laitei</a>.</p>
77+
<p>Copyright © Laitei</p>
78+
79+
<h2>Supported Platforms</h2>
80+
<ul>
81+
<li>Windows</li>
82+
<li>macOS</li>
83+
<li>Linux</li>
84+
<li>Web</li>
85+
<li>iPhone & iPad</li>
86+
<li>Android phone & tablet</li>
87+
</ul>
88+
89+
<h2>Keyboard Layouts</h2>
90+
<h3>Desktop Layout</h3>
91+
<div id='osk' data-states='default shift'></div>
92+
93+
<h3>Phone Layout</h3>
94+
<div id='osk-phone' data-states='default shift numeric'></div>
95+
</div>

0 commit comments

Comments
 (0)