Skip to content

Commit

Permalink
Update documentation using new font.
Browse files Browse the repository at this point in the history
  • Loading branch information
@LornaSIL
LornaSIL committed Aug 10, 2023
1 parent 0426322 commit d05174f
Show file tree
Hide file tree
Showing 32 changed files with 63 additions and 204 deletions.
2 changes: 1 addition & 1 deletion documentation/about.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h2 id="about-sil-international">About SIL International</h2>
<p>Our Mission: Inspired by God’s love, we advocate, build capacity, and work with local communities to apply language expertise that advances meaningful development, education, and engagement with Scripture.</p>
<p><a href="https://software.sil.org/">SIL Language Technology</a> supports these activities by developing <a href="https://software.sil.org/products/">software</a>, <a href="https://software.sil.org/fonts/">fonts</a>, and <a href="https://keyman.com/">keyboard technologies</a>.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
2 changes: 1 addition & 1 deletion documentation/allah.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h1 class="title">Lateef - Rendering the Allah ligature</h1>
[font id='lateefL' face='Lateef-Regular' size='150%' ltr=1]
-->
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
96 changes: 5 additions & 91 deletions documentation/announcement.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,99 +17,13 @@ <h1 class="title">Lateef - Announcement</h1>
<h2 id="changes">Changes</h2>
<h4 id="new">New</h4>
<ul>
<li>Added Wolof language support</li>
<li>New features:
<ul>
<li>cv49 - Heh Doachashmee</li>
<li>cv74 - Inverted Damma</li>
</ul></li>
<li>Added:
<ul>
<li>U+061D ARABIC END OF TEXT MARK</li>
<li>Due to the rarity of these characters, lam-alef ligatures have not been implemented with these new characters:
<ul>
<li>U+0870 ARABIC LETTER ALEF WITH ATTACHED FATHA</li>
<li>U+0871 ARABIC LETTER ALEF WITH ATTACHED TOP RIGHT FATHA</li>
<li>U+0872 ARABIC LETTER ALEF WITH RIGHT MIDDLE STROKE</li>
<li>U+0873 ARABIC LETTER ALEF WITH LEFT MIDDLE STROKE</li>
<li>U+0874 ARABIC LETTER ALEF WITH ATTACHED KASRA</li>
<li>U+0875 ARABIC LETTER ALEF WITH ATTACHED BOTTOM RIGHT KASRA</li>
<li>U+0876 ARABIC LETTER ALEF WITH ATTACHED ROUND DOT ABOVE</li>
<li>U+0877 ARABIC LETTER ALEF WITH ATTACHED RIGHT ROUND DOT</li>
<li>U+0878 ARABIC LETTER ALEF WITH ATTACHED LEFT ROUND DOT</li>
<li>U+0879 ARABIC LETTER ALEF WITH ATTACHED ROUND DOT BELOW</li>
<li>U+087A ARABIC LETTER ALEF WITH DOT ABOVE</li>
<li>U+087B ARABIC LETTER ALEF WITH ATTACHED TOP RIGHT FATHA AND DOT ABOVE</li>
<li>U+087C ARABIC LETTER ALEF WITH RIGHT MIDDLE STROKE AND DOT ABOVE</li>
<li>U+087D ARABIC LETTER ALEF WITH ATTACHED BOTTOM RIGHT KASRA AND DOT ABOVE</li>
<li>U+087E ARABIC LETTER ALEF WITH ATTACHED TOP RIGHT FATHA AND LEFT RING</li>
<li>U+087F ARABIC LETTER ALEF WITH RIGHT MIDDLE STROKE AND LEFT RING</li>
<li>U+0880 ARABIC LETTER ALEF WITH ATTACHED BOTTOM RIGHT KASRA AND LEFT RING</li>
<li>U+0881 ARABIC LETTER ALEF WITH ATTACHED RIGHT HAMZA</li>
<li>U+0882 ARABIC LETTER ALEF WITH ATTACHED LEFT HAMZA</li>
<li>FD42 ARABIC LIGATURE RADI ALLAAHU ANHAA</li>
<li>FD47 ARABIC LIGATURE ALAYHI AS-SALAAM</li>
<li>FDCF ARABIC LIGATURE SALAAMUHU ALAYNAA</li>
<li>FDFD ARABIC LIGATURE BISMILLAH AR-RAHMAN AR-RAHEEM</li>
</ul></li>
<li>U+0883 ARABIC TATWEEL WITH OVERSTRUCK HAMZA</li>
<li>U+0884 ARABIC TATWEEL WITH OVERSTRUCK WAW</li>
<li>U+0885 ARABIC TATWEEL WITH TWO DOTS BELOW</li>
<li>U+0886 ARABIC LETTER THIN YEH</li>
<li>U+0887 ARABIC BASELINE ROUND DOT</li>
<li>U+0888 ARABIC RAISED ROUND DOT</li>
<li>U+0889 ARABIC LETTER NOON WITH INVERTED SMALL V</li>
<li>U+088A ARABIC LETTER HAH WITH INVERTED SMALL V BELOW</li>
<li>U+088B ARABIC LETTER TAH WITH DOT BELOW</li>
<li>U+088C ARABIC LETTER TAH WITH THREE DOTS BELOW</li>
<li>U+088D ARABIC LETTER KEHEH WITH TWO DOTS VERTICALLY BELOW</li>
<li>U+088E ARABIC VERTICAL TAIL</li>
<li>U+0890 ARABIC POUND MARK ABOVE</li>
<li>U+0891 ARABIC PIASTRE MARK ABOVE</li>
<li>U+0898 ARABIC SMALL HIGH WORD AL-JUZ</li>
<li>U+0899 ARABIC SMALL LOW WORD ISHMAAM</li>
<li>U+089A ARABIC SMALL LOW WORD IMAALA</li>
<li>U+089B ARABIC SMALL LOW WORD TASHEEL</li>
<li>U+089C ARABIC MADDA WAAJIB</li>
<li>U+089D ARABIC SUPERSCRIPT ALEF MOKHASSAS</li>
<li>U+089E ARABIC DOUBLED MADDA</li>
<li>U+089F ARABIC HALF MADDA OVER MADDA</li>
<li>U+08B5 ARABIC LETTER QAF WITH DOT BELOW AND NO DOTS ABOVE</li>
<li>U+08C8 ARABIC LETTER GRAF</li>
<li>U+08C9 ARABIC SMALL FARSI YEH</li>
<li>U+08CA ARABIC SMALL HIGH FARSI YEH</li>
<li>U+08CB ARABIC SMALL HIGH YEH BARREE WITH TWO DOTS BELOW</li>
<li>U+08CC ARABIC SMALL HIGH WORD SAH</li>
<li>U+08CD ARABIC SMALL HIGH ZAH</li>
<li>U+08CE ARABIC LARGE ROUND DOT ABOVE</li>
<li>U+08CF ARABIC LARGE ROUND DOT BELOW</li>
<li>U+08D0 ARABIC SUKUN BELOW</li>
<li>U+08D1 ARABIC LARGE CIRCLE BELOW</li>
<li>U+08D2 ARABIC LARGE ROUND DOT INSIDE CIRCLE BELOW</li>
<li>U+08D3 ARABIC SMALL LOW WAW</li>
<li>U+08D4 ARABIC SMALL HIGH WORD AR-RUB</li>
<li>U+08D5 ARABIC SMALL HIGH SAD</li>
<li>U+08D6 ARABIC SMALL HIGH AIN</li>
<li>U+08D7 ARABIC SMALL HIGH QAF</li>
<li>U+08D8 ARABIC SMALL HIGH NOON WITH KASRA</li>
<li>U+08D9 ARABIC SMALL LOW NOON WITH KASRA</li>
<li>U+08DA ARABIC SMALL HIGH WORD ATH-THALATHA</li>
<li>U+08DB ARABIC SMALL HIGH WORD AS-SAJDA</li>
<li>U+08DC ARABIC SMALL HIGH WORD AN-NISF</li>
<li>U+08DD ARABIC SMALL HIGH WORD SAKTA</li>
<li>U+08DE ARABIC SMALL HIGH WORD QIF</li>
<li>U+08DF ARABIC SMALL HIGH WORD WAQFA</li>
<li>U+08E0 ARABIC SMALL HIGH FOOTNOTE MARKER</li>
<li>U+08E1 ARABIC SMALL HIGH SIGN SAFHA</li>
<li>U+08E2 ARABIC DISPUTED END OF AYAH<br />
</li>
<li>U+10EFD ARABIC SMALL LOW WORD SAKTA</li>
<li>U+10EFE ARABIC SMALL LOW WORD QASR</li>
<li>U+10EFF ARABIC SMALL LOW WORD MADDA</li>
</ul></li>
</ul>
<h4 id="improved">Improved</h4>
<ul>
<li>Adjusted height of kashida</li>
<li>Enhanced kerning to support support new characters</li>
<li>Changed Kurdish language to support a U+06BE Heh Doachashmee alternate rather than U+0647 Heh alternate</li>
<li>Fixed rendering bug related to a vowel mark plus a hamza with an intervening combining grapheme joiner</li>
</ul>
<h4 id="known-issues">Known issues</h4>
<ul>
Expand All @@ -120,7 +34,7 @@ <h4 id="known-issues">Known issues</h4>
<li>In InDesign: some behaviors, such as the <em>lam-alef</em> ligature, raised <em>kasra</em> with <em>shadda</em>, and subtending marks, will not function correctly unless <strong>Ligatures</strong> is turned on in the <strong>Characters</strong> panel.</li>
</ul>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
8 changes: 6 additions & 2 deletions documentation/charset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ <h1 class="title">Lateef - Character Set Support</h1>
<h2 id="supported-characters">Supported characters</h2>
<p>The following character ranges are supported by this font:</p>
<table>
<colgroup>
<col style="width: 46%" />
<col style="width: 53%" />
</colgroup>
<thead>
<tr class="header">
<th>Unicode block</th>
Expand Down Expand Up @@ -48,7 +52,7 @@ <h2 id="supported-characters">Supported characters</h2>
</tr>
<tr class="even">
<td>Arabic Presentation Forms-A</td>
<td>only includes FD3E..FD3F, FDF2, FDFC</td>
<td>only includes FD3E..FD3F, FD42, FD47, FDCF, FDF2, FDFC, FDFD</td>
</tr>
<tr class="odd">
<td>Arabic Presentation Forms-B</td>
Expand All @@ -67,7 +71,7 @@ <h2 id="supported-characters">Supported characters</h2>
<p>A selection of characters from the General Punctuation block, such as various-sized spaces, are also supported; a utility such as <a href="https://scripts.sil.org/ViewGlyph_home">SIL ViewGlyph</a> can be used to examine the exact repertoire of this font. U+204F REVERSED SEMICOLON and U+2E41 REVERSED COMMA have been added to support Sindhi punctuation.</p>
<p>¹Inclusion of basic Latin repertoire is provided as a convenience, e.g., for use in menus or for displaying markup in text files; these fonts are not intended for extensive Latin script use.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions documentation/design.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ <h1 class="title">Lateef - Design</h1>
<h2 id="type-samples">Type Samples</h2>
<p>Type samples showing some of the inventory of glyphs can be found here: <a href="sample.html">Lateef Type Sample</a>.</p>
<p>Examples of some text is shown below.</p>
<img src="assets/images/weights.png" alt="Lateef Sample - Seven weights" class="fullsize" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2022/06/weights.png -->
<img src="assets/images/weights.png" class="fullsize" alt="Lateef Sample - Seven weights" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2022/06/weights.png -->
<figcaption>
Lateef Sample - Seven weights
</figcaption>
<img src="assets/images/LateefArabicGen11_LO.png" alt="Lateef Sample - Genesis 11" class="fullsize" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2022/06/LateefArabicGen11_LO.png -->
<img src="assets/images/LateefArabicGen11_LO.png" class="fullsize" alt="Lateef Sample - Genesis 11" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2022/06/LateefArabicGen11_LO.png -->
<figcaption>
Lateef Sample - Genesis 11
</figcaption>
Expand All @@ -43,7 +43,7 @@ <h2 id="rendering-the-allah-ligature">Rendering the Allah ligature</h2>
<h2 id="font-features">Font Features</h2>
<p>Alternate glyphs that are available through features are demonstrated in the <a href="features.html">Features</a> document.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions documentation/developer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h2 id="permissions-granted-by-the-ofl">Permissions granted by the OFL</h2>
<h2 id="building-the-fonts-from-source-code">Building the fonts from source code</h2>
<p>Font sources are published in a <a href="https://github.com/silnrsi/font-lateef">Github project</a>. The build process requires <a href="https://github.com/silnrsi/smith">smith</a> and project build parameters are set in the <a href="https://github.com/silnrsi/smith/blob/master/wscript">wscript</a>.</p>
<p>Font sources are in the <a href="http://unifiedfontobject.org/versions/ufo3/">UFO3</a> format with font family structures defined using <a href="https://github.com/fonttools/fonttools/tree/master/Doc/source/designspaceLib">designspace</a>. OpenType source code is stored in the <a href="https://adobe-type-tools.github.io/afdko/OpenTypeFeatureFileSpecification.html">.fea</a> format in the UFO (features.fea) but is maintained in a separate file using the more efficient and powerful <a href="https://github.com/silnrsi/pysilfont/blob/master/docs/feaextensions.md">.feax</a> format.</p>
<p>The fonts are built using a completely free and open source workflow using industry-standard tools (<a href="https://github.com/fonttools/fonttools">fonttools</a>), a package of custom python scripts (<a href="https://github.com/silnrsi/pysilfont">pysilfont</a>), and a build and packaging system (<a href="https://github.com/silnrsi/smith">Smith</a>). The whole system is available in a preconfigured virtual machine using VirtualBox and Vagrant.</p>
<p>The fonts are built using a completely free and open source workflow using industry-standard tools (<a href="https://github.com/fonttools/fonttools">fonttools</a>), a package of custom python scripts (<a href="https://github.com/silnrsi/pysilfont">pysilfont</a>), and a build and packaging system (<a href="https://github.com/silnrsi/smith">Smith</a>). The whole toolchain is available as a Docker container.</p>
<p>Full instructions for setting up the tools and building SIL fonts are available on a dedicated web site: <a href="https://silnrsi.github.io/silfontdev/">SIL Font Development Notes</a>.</p>
<h2 id="building">Building</h2>
<p>The Lateef project can be built from source using <a href="https://github.com/silnrsi/smith">smith</a>. This is done via the sequence:</p>
Expand All @@ -48,7 +48,7 @@ <h2 id="contributing-to-the-project">Contributing to the project</h2>
<p>We warmly welcome contributions to the fonts, such as new glyphs, enhanced smart font code, or bug fixes. The <a href="https://silnrsi.github.io/silfontdev/en-US/Contributing_Changes.html">brief overview of contributing changes</a> is a good place to begin. The next step is to contact us by responding to an existing issue or creating an issue in the Github repository and expressing your interest. We can then work together to plan and integrate your contributions.</p>
<p>To enable us to accept contributions in a way that honors your contribution and respects your copyright while preserving long-term flexibility for open source licensing, you would also need to agree to the <strong>SIL International Contributor License Agreement for Font Software (v1.0)</strong> prior to sending us your contribution. To read more about this requirement and find out how to submit the required form, please visit the <a href="https://software.sil.org/fontcla">CLA information page</a>.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions documentation/faq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ <h3 id="what-is-so-special-about-lateef"><em>What is so special about Lateef?</e
<p>Lateef is designed in an appropriate style often used for Sindhi and other languages of southern Asia. This font is designed to work with the OpenType font technology. To take advantage of the advanced typographic capabilities of this font, you must be using applications that provide an adequate level of support for OpenType. These advanced capabilities provide access to the variant character forms used in some languages. See <a href="features.html">Smart Font Features</a>.</p>
<h3 id="what-makes-lateef-specifically-sindhi-style"><em>What makes Lateef specifically "Sindhi-style"?</em></h3>
<ul>
<li>The lam-alef ligature is designed in a Sindhi-style: <img src="assets/images/LateefLamAlef.jpg" alt="Lateef lam-alef ligature" class="fullsize" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2018/10/LateefLamAlef.jpg -->
<li>The lam-alef ligature is designed in a Sindhi-style: <img src="assets/images/LateefLamAlef.jpg" class="fullsize" alt="Lateef lam-alef ligature" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2018/10/LateefLamAlef.jpg -->
<figcaption>
</figcaption></li>
<li>Diacritics on isolate and final forms of characters are left offset to the nukat: <img src="assets/images/LateefDiacritics.jpg" alt="Lateef Diacritics" class="fullsize" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2018/10/LateefDiacritics.jpg -->
<li>Diacritics on isolate and final forms of characters are left offset to the nukat: <img src="assets/images/LateefDiacritics.jpg" class="fullsize" alt="Lateef Diacritics" /> <!-- PRODUCT SITE IMAGE SRC https://software.sil.org/lateef/wp-content/uploads/sites/30/2018/10/LateefDiacritics.jpg -->
<figcaption>
</figcaption></li>
</ul>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions documentation/features.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -615,10 +615,10 @@ <h4 id="disable-digit-kerning-see-faq-typetuner-only">Disable digit kerning (see
<!-- PRODUCT SITE ONLY
[font id='lateef' face='Lateef-Regular' bold='Lateef-Bold' size='160%' rtl=1]
[font id='lateefL' face='Lateef-Regular' bold='Lateef-Bold' size='160%' ltr=1]
-->
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.000 and is copyright © 1994-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/lateef/" title="" class="active">Lateef project</a> version 4.100 and is copyright © 1994-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
Loading

0 comments on commit d05174f

Please sign in to comment.