Debian Codegraph @

documentation/developer/dev03_interfaces.md

raw
1 ---
2 title: Awami Nastaliq Developer Documentation
3 fontversion: 3.200
4 ---
5
6 # Glyph Interfaces and Suffixes
7
8 The calligraphic nature of the Nastaliq style means that a distinctive visual connection is needed between any two characters. For instance, the connection between seen and sad is different from the connection between the seen and jeem or the seen and lam, so there needs to be separate forms of the seen to connect to each following character.
9
10 ![Seen forms with various connections](images/SeenForms_red.png)
11
12 _Seen forms with various connections_
13
14 As a rule, the shape of the connection is determined by the second character of the pair, although there are exceptions. In some cases (especially for beh-like forms), there exist sequences of three characters, where the third character affects the shape of the first.
15
16 We define a set of “interfaces” which indicate the shape of the connection. The interface specifies the exit of the first glyph, the entrance to the second glyph, and the way they connect. Any two glyphs that are designed to support the interface should connect nicely.
17
18 For most characters, all of their medial/final forms will use the same interface for the entrance (ie, the shape of the right-hand side). For instance, the entrance of all the medial/final sads are identical, so any “sad”-type exit (left side) will attach to any medial or final sad entrance. The preceding glyphs have the .sd suffix indicating that they are designed with a “sad” exit to support the “sad” interface, so they can connect to a sad.
19
20 In the examples below, notice how any of the glyphs with sad exits (right-hand column) will connect with any of the sads (left-hand column):
21
22 ![Sad interface entrances and exits](images/SadInterface.png)
23
24 _Sad interface entrances and exits_
25
26 Similarly, any of the glyphs on the right with meem-style exits will connect with any meem on the left.
27
28 ![Corresponding meem interface entrances and exits](images/MeemInterface.png)
29
30 _Corresponding meem interface entrances and exits_
31
32 Of course there are exceptions and complications. The beh requires quite a few interfaces due to signficant variation in the beh forms. There is an alternate meem form that needs a different interface, as well as the “kashida”-style or toothless seen (which occurs before another seen). The heh-goal requires one interface for the medial and another for the final.
33
34 In addition, there are three suffixes that are each used for two distinct interfaces. The final chotiyeh, final qaf/waw, and reh have two final forms that are chosen based on the preceding glyph. (The final qaf and waw forms both use the .qf interfaces. There are two distinct connections, but it turns out that the forms of the qaf and waw do not need to be significantly different, so perhaps the interfaces could be merged.)
35
36 ## Suffixes for Principal Interfaces
37
38 Here is a list of the interfaces identified by suffix and the glyphs they connect to:
39
40 - default (no suffix) - alef, lam, kaf, dal
41 - .ai - ain
42 - .be - beh (default)
43 - .beM1 - high-tooth beh
44 - .beM2 - low-tooth beh (including an alternate final beh)
45 - .benn - beh that occurs before a final noon
46 - .behg - beh that occurs before a final heh-goal
47 - .bere - beh that occurs before a final reh
48 - .beF - final beh (standard; there is an alternate final beh that uses .beM2)
49 - .by - bariyeh (final)
50 - .ch - final chotiyeh (two interfaces)
51 - .fe - feh (and medial qaf)
52 - .hd - heh-doachaschmee
53 - .hgM - medial heh-goal
54 - .hgF - final heh-goal
55 - .jm - jeem
56 - .mm - meem (standard)
57 - .mmX - alternate medial meem (round form)
58 - .nn - final noon
59 - .qf - final qaf and waw (two interfaces)
60 - .re - reh (final) (two interfaces)
61 - .sd - sad, also the rounded form of kaf that occurs before a lam or an alef
62 - .sn - seen (standard)
63 - .snsn - flat “kashida”- style seen that occurs before another seen
64 - .ta - tah
65 - [.tmF - final teh marbuta - not currently used; instead we use the default forms here]
66
67 These exist for virtually all dual-connecting characters, in both initial and medial forms. (Note that 25 interfaces * 2 contexts = 50 forms for each character class.)
68
69 Here we show [images of all the interfaces listed above](dev03a_interfaceimages.md).
70
71 ## Other Suffixes
72
73 In addition to the suffixes corresponding to the principle interfaces, there are other suffixes that are used. An underscore in the suffix indicates the preceding character(s):
74
75 - nn_hgbm - form of medial beh that occurs heh-goal, meem, etc. and final noon (see class `c_preBehNn_hgbm`)
76 - sn_sn - flat toothless seen that occurs between two other seens
77 - \_stfh - form of final qaf and waw that follows initial seen, tah, etc. (see class `cPreQw_stfh`)
78 - \_bfkl - final forms of beh and chotiyeh that occur before beh, feh, kaf, etc. (see classes `c_preBe_bfkl` and `c_preChF_bfkl`)
79 - \_hgM - form of final reh that follows medial heh goal (see `c_preReF_hgM`)
80 - \_jkl - form of final reh that follow jeem, kaf, lam, and initial beh (see `c_preReF_jkl`)
81
82 Obsolete interfaces:
83
84 - \_sshg - form of final reh that follows seen, sad, or heh-goal (see `c_preReF_sshg` - currently not used)
85 - XX_ss - beh forms following sad or seen - OBSOLETE
86 - hgF_be - OBSOLETE
87
88 Suffixes are used to indicate some special-purpose contextual forms as well:
89
90 - .al - used for lams that are followed by alef
91 - .kf - short or wide forms that occur before a kaf/gaf, to avoid collisions
92 - .bekl - wide form of jeem occurring before teh/theh + kaf/gaf/lam/alef, to avoid collisions
93 - .bekf - short form of tah occurring before beh + kaf/gaf, to avoid collisions
94 - .kf_lm - special form of gaf between a lam and kaf, to avoid collisions
95
96 Other suffixes include:
97
98 - R - wider form to allow room for a ring
99 - short
100 - tall
101 - flat
102 - lowentry - tall kaf/gaf forms with adjusted AP to make it taller, used to avoid collisions
103 - squiggle - kaf form with squiggle
104
105 --------
106
107 << Previous: [The Glyph Set](dev02_glyphset.md) | [Introduction and Index](dev01_intro.md) | Next: [Alternating Beh Teeth](dev04_behteeth.md) >>
108
109
110 <!-- PRODUCT SITE ONLY
111 [font id='awami' face='AwamiNastaliq-Regular' size='150%' rtl=1]
112 [font id='awamiL' face='AwamiNastaliq-Regular' size='150%' ltr=1]
113 -->