Skip to content

Commit

Permalink
Update docs and fontdocs/makedocs system; ignore diffinator2 artifacts
Browse files Browse the repository at this point in the history
  • Loading branch information
jvgaultney committed Jul 13, 2023
1 parent 77f2b57 commit c3a356a
Show file tree
Hide file tree
Showing 40 changed files with 220 additions and 103 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,5 @@ __pycache__/
# temporary doc files
documentation/source/pdftemp/
documentation/source/productsite/
.ninja_log
build.ninja
9 changes: 4 additions & 5 deletions documentation/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,17 @@
<h1 class="title">Kay Pho Du - About</h1>
</header>
<h2 id="about-this-project">About this project</h2>
<p>Kay Pho Du is a font for the Kayah Li script, based initially on the design of <a href="https://github.com/silnrsi/font-karenni">Karenni</a>, although the glyphs have been redrawn and a new Latin set has been added. It supports the full Kayah Li range of Unicode characters (U+A900..U+A92F).</p>
<p>Kay Pho Du is a font for the Kayah Li script, based initially on the design of <a href="https://github.com/silnrsi/font-karenni">Karenni</a>, although the glyphs have been redrawn and a new Latin set has been added. There are four weights: Regular, Medium, SemiBold, and Bold. It supports the full Kayah Li range of Unicode characters (U+A900..U+A92F).</p>
<h2 id="future-plans">Future plans</h2>
<p>These fonts are actively maintained and improved. In the near future we plan to add new Bold and other weights. If you are considering making a derivative of this package you may wish to wait until that broader set of fonts are released.</p>
<p>Please send us your requests using the <a href="https://software.sil.org/kayphodu/">form on the project website</a>. If you are interested in helping us make the fonts better see the <a href="developer.html">Developer</a> page.</p>
<p>These fonts are actively maintained and improved. Please send us your requests using the <a href="https://software.sil.org/kayphodu/">form on the project website</a>. If you are interested in helping us make the fonts better see the <a href="developer.html">Developer</a> page.</p>
<h2 id="announcement-list">Announcement list</h2>
<p>If you wish to receive announcements about updates to any of our SIL fonts, please subscribe to our <a href="https://groups.google.com/a/groups.sil.org/forum/#!forum/sil-font-news">SIL Font News Announcement List</a>. This is an announcement-only list with messages approximately once a month. It does not allow any discussion.</p>
<p>You can subscribe using either of the two following options.</p>
<ul>
<li><p>If you use a Google profile and join the group, you will be able to access the group and control your subscription and notification options with a web browser. Make sure you are logged in to your Google profile and go to the <a href="https://groups.google.com/a/groups.sil.org/forum/#!forum/sil-font-news">SIL Font News Google Group</a>. Click on <strong>Join group</strong>.</p></li>
<li><p>If you would rather not use a Google profile, you can subscribe any email address by sending a message to <a href="mailto:[email protected]">[email protected]</a> and following the instructions you get in the confirmation message.</p></li>
</ul>
<p>Our font announcements are also available through Twitter <span class="citation" data-cites="silfonts">[@silfonts]</span>(http://twitter.com/silfonts).</p>
<p>Our font announcements are also available through Twitter <a href="http://twitter.com/silfonts">@silfonts</a>.</p>
<h2 id="supporting-the-project">Supporting the project</h2>
<p>These fonts are provided at no cost, however they are expensive to produce and maintain. Please consider donating to SIL’s font development efforts to support future development. Go to <a href="https://donate.givedirect.org/?cid=13536&amp;n=206909">SIL’s Give Direct page</a> and designate your gift for <em>Scripts &amp; Fonts</em>. <strong>Thank you!</strong></p>
<h2 id="about-sil-international">About SIL International</h2>
Expand All @@ -36,7 +35,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/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
15 changes: 15 additions & 0 deletions documentation/assets/css/webfonts.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@ released under the MIT license (http://opensource.org/licenses/MIT).
font-family: KayPhoDu-R;
src: url("../../../web/KayPhoDu-Regular.woff2") format("woff2");
}
@font-face {
font-family: KayPhoDu-M;
src: url("../../../web/KayPhoDu-Medium.woff2") format("woff2");
}
@font-face {
font-family: KayPhoDu-SB;
src: url("../../../web/KayPhoDu-SemiBold.woff2") format("woff2");
}
@font-face {
font-family: KayPhoDu-B;
src: url("../../../web/KayPhoDu-Bold.woff2") format("woff2");
}

.kayphodu-R { font-family: KayPhoDu-R; }
.kayphodu-M { font-family: KayPhoDu-M; }
.kayphodu-SB { font-family: KayPhoDu-SB; }
.kayphodu-B { font-family: KayPhoDu-B; }

16 changes: 16 additions & 0 deletions documentation/assets/css/webfontsttf.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,21 @@ released under the MIT license (http://opensource.org/licenses/MIT).
font-family: KayPhoDu-R;
src: url("../../../results/KayPhoDu-Regular.ttf") format("truetype");
}
@font-face {
font-family: KayPhoDu-M;
src: url("../../../results/KayPhoDu-Medium.ttf") format("truetype");
}
@font-face {
font-family: KayPhoDu-SB;
src: url("../../../results/KayPhoDu-SemiBold.ttf") format("truetype");
}
@font-face {
font-family: KayPhoDu-B;
src: url("../../../results/KayPhoDu-Bold.ttf") format("truetype");
}

.kayphodu-R { font-family: KayPhoDu-R; }
.kayphodu-M { font-family: KayPhoDu-M; }
.kayphodu-SB { font-family: KayPhoDu-SB; }
.kayphodu-B { font-family: KayPhoDu-B; }

2 changes: 1 addition & 1 deletion documentation/charset.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h2 id="supported-characters">Supported characters</h2>
</tbody>
</table>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions documentation/developer.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ <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>The full source code for the fonts is available on <a href="https://github.com/silnrsi/font-kayphodu">Github</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>.</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="contributing-to-the-project">Contributing to the project</h2>
<p>We warmly welcome contributions to the fonts. 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>Because we want to be able to guarantee a high level of quality for our fonts, we will review submissions carefully. Contributions will need to cover all the weights and styles of the family. Please don’t be discouraged if we do not include a submission due to quality or incompleteness, or if we ask you to make specific revisions.</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/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
7 changes: 6 additions & 1 deletion documentation/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,13 @@ <h4 id="how-is-the-font-different-from-karenni"><em>How is the font different fr
<p>Kay Pho Du is a freshly-drawn, new design based on the overall design of Karenni. Although the design is meant to be very similar to Karenni it is not identical and does not include any of the original outlines. Because of that, many of the glyphs are slightly different and the metrics are not the same. Many glyphs have also been added.</p>
<h4 id="what-is-the-source-of-the-latin-glyphs"><em>What is the source of the Latin glyphs?</em></h4>
<p>The Latin glyphs in Kay Pho Du are a new design specifically designed to work as a secondary script alongside the Kayah Li glyphs. They are not available as a standalone Latin design.</p>
<h3 id="problems-with-bold-weights">Problems with Bold weights</h3>
<h4 id="why-does-my-application-not-show-the-bold-weight-in-font-menus-and-dialogs"><em>Why does my application not show the Bold weight in font menus and dialogs?</em></h4>
<p>Some applications will list all the weights but leave out Bold. To access the Bold you need to choose Regular and turn on Bold using the application's UI controls such as a "B" button. See our <a href="https://software.sil.org/fonts/axis-based-fonts/">Font Help Guide on Axis-Based Font Families</a> for more information.</p>
<h4 id="why-do-i-sometimes-get-a-fake-bold"><em>Why do I sometimes get a fake Bold?</em></h4>
<p>If you choose a weight other than Regular (such as Medium), and then use application controls to turn on Bold, some applications will make a "fake" Bold rather than use one of the real ones in the font (SemiBold, Bold). This is because only Regular has an associated Bold counterpart. This is a technical limitation with some apps and OSes. If you are using a weight other than Regular for text and want to make a word or phrase stand out, you will need to select the text and apply one of the heavier weights manually. See our <a href="https://software.sil.org/fonts/axis-based-fonts/">Font Help Guide on Axis-Based Font Families</a> for more information.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
18 changes: 10 additions & 8 deletions documentation/history.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@
<header>
<h1 class="title">Kay Pho Du - Version History</h1>
</header>
<h2 id="announcement-list">Announcement list</h2>
<p>If you would like stay informed of updates to Kay Pho Du and other SIL fonts, please subscribe to the <a href="https://groups.google.com/a/groups.sil.org/forum/#!forum/sil-font-news">SIL Font News Announcement List</a>. For more information see <a href="about.html">About</a>.</p>
<p>Our font announcements are also available through Twitter <span class="citation" data-cites="silfonts">[@silfonts]</span>(http://twitter.com/silfonts).</p>
<h2 id="current-versions">Current versions</h2>
<p>The latest version of the fonts is always available from the <a href="https://software.sil.org/kayphodu/">Kay Pho Du site</a> as a .zip archive for all major platforms.</p>
<h2 id="change-history">Change history</h2>
<h3 id="july-2023-sil-wstech-team-kay-pho-du-v3.000">13 July 2023 (SIL WSTech Team) Kay Pho Du v3.000</h3>
<ul>
<li>New Bold, SemiBold, and Medium weights</li>
<li>Increased space around U+A92F KAYAH LI SIGN SHYA and after exclamation point</li>
<li>Other minor improvements</li>
</ul>
<h3 id="april-2022-sil-wstech-team-kay-pho-du-v2.000">21 April 2022 (SIL WSTech Team) Kay Pho Du v2.000</h3>
<p>Initial release of regular weight only</p>
<ul>
<li>Initial release of regular weight only</li>
</ul>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions documentation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<header>
<h1 class="title">Kay Pho Du - Documentation</h1>
</header>
<p><span class="kayphodu-R normal">ꤒꤢ꤬ꤖꤟꤌꤣ ꤔꤛꤣ꤬ ꤘꤤ꤬ꤗꤟꤌꤣꤘꤢꤨ꤬ ꤊꤟꤛꤢ꤬꤭ꤊꤢꤨ꤬꤭</span></p>
<p><span class="kayphodu-R normal">ꤒꤢ꤬ꤖꤟꤌꤣ ꤔꤛꤣ꤬ ꤘꤤ꤬ꤗꤟꤌꤣꤘꤢꤨ꤬ ꤊꤟꤛꤢ꤬꤭ꤊꤢꤨ꤬꤭</span>   Regular<br> <span class="kayphodu-M normal">ꤒꤢ꤬ꤖꤟꤌꤣ ꤔꤛꤣ꤬ ꤘꤤ꤬ꤗꤟꤌꤣꤘꤢꤨ꤬ ꤊꤟꤛꤢ꤬꤭ꤊꤢꤨ꤬꤭</span>   Medium<br> <span class="kayphodu-SB normal">ꤒꤢ꤬ꤖꤟꤌꤣ ꤔꤛꤣ꤬ ꤘꤤ꤬ꤗꤟꤌꤣꤘꤢꤨ꤬ ꤊꤟꤛꤢ꤬꤭ꤊꤢꤨ꤬꤭</span>   SemiBold<br> <span class="kayphodu-B normal">ꤒꤢ꤬ꤖꤟꤌꤣ ꤔꤛꤣ꤬ ꤘꤤ꤬ꤗꤟꤌꤣꤘꤢꤨ꤬ ꤊꤟꤛꤢ꤬꤭ꤊꤢꤨ꤬꤭</span>   Bold<br></p>
<p>Thank you for your interest in the Kay Pho Du fonts. This font family supports the Kayah Li script.</p>
<p>This documentation is a set of HTML pages that can be viewed in any modern web browser. PDF versions of these pages are also provided. This content, plus download links and a contact form, are available from the <a href="https://software.sil.org/kayphodu/">Kay Pho Du site</a>.</p>
<ul>
Expand All @@ -24,11 +24,12 @@ <h1 class="title">Kay Pho Du - Documentation</h1>
<li><a href="charset.html">Character set support</a> — Details of Unicode characters that are supported</li>
<li><a href="support.html">Support</a> — How to get additional support</li>
<li><a href="developer.html">Developer information</a> — How to modify and build the fonts</li>
<li><a href="versions.html">Versions</a> - Sources for alternate versions</li>
<li><a href="history.html">Version history</a> - Complete version history</li>
</ul>
<p>Additional information is also provided in other project files: <a href="../README.txt">README.txt</a>, <a href="../OFL.txt">OFL.txt</a>, <a href="../OFL-FAQ.txt">OFL-FAQ.txt</a>, and <a href="../FONTLOG.txt">FONTLOG.txt</a>.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
Binary file modified documentation/pdf/about.pdf
Binary file not shown.
Binary file modified documentation/pdf/charset.pdf
Binary file not shown.
Binary file modified documentation/pdf/developer.pdf
Binary file not shown.
Binary file modified documentation/pdf/faq.pdf
Binary file not shown.
Binary file modified documentation/pdf/history.pdf
Binary file not shown.
Binary file modified documentation/pdf/index.pdf
Binary file not shown.
Binary file modified documentation/pdf/resources.pdf
Binary file not shown.
Binary file modified documentation/pdf/support.pdf
Binary file not shown.
Binary file added documentation/pdf/versions.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion documentation/resources.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h2 id="web-fonts">Web fonts</h2>
<h2 id="text-conversion">Text conversion</h2>
<p>These fonts are encoded according to <a href="http://unicode.org">The Unicode Standard</a>. If you have text that uses a legacy, non-Unicode encoding there are tools that can help you convert that text for use with Unicode fonts. See <a href="https://scriptsource.org/entry/xlzd6n5aqt">Introduction to Text Conversion and Transliteration</a>.</p>
<footer class="footer">
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 2.000 and is copyright © 2019-2023 SIL International.</p>
<p>This guide is from the <a href="https://software.sil.org/kayphodu/" title="" class="active">Kay Pho Du project</a> version 3.000 and is copyright © 2019-2023 SIL International.</p>
</footer>
</article>
</div>
Expand Down
10 changes: 4 additions & 6 deletions documentation/source/about.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
title: Kay Pho Du - About
fontversion: 2.000
fontversion: 3.000
---

## About this project

Kay Pho Du is a font for the Kayah Li script, based initially on the design of [Karenni](https://github.com/silnrsi/font-karenni), although the glyphs have been redrawn and a new Latin set has been added. It supports the full Kayah Li range of Unicode characters (U+A900..U+A92F).
Kay Pho Du is a font for the Kayah Li script, based initially on the design of [Karenni](https://github.com/silnrsi/font-karenni), although the glyphs have been redrawn and a new Latin set has been added. There are four weights: Regular, Medium, SemiBold, and Bold. It supports the full Kayah Li range of Unicode characters (U+A900..U+A92F).

## Future plans

These fonts are actively maintained and improved. In the near future we plan to add new Bold and other weights. If you are considering making a derivative of this package you may wish to wait until that broader set of fonts are released.

Please send us your requests using the [form on the project website](https://software.sil.org/kayphodu/). If you are interested in helping us make the fonts better see the [Developer](developer.md) page.
These fonts are actively maintained and improved. Please send us your requests using the [form on the project website](https://software.sil.org/kayphodu/). If you are interested in helping us make the fonts better see the [Developer](developer.md) page.

## Announcement list

Expand All @@ -23,7 +21,7 @@ You can subscribe using either of the two following options.

- If you would rather not use a Google profile, you can subscribe any email address by sending a message to [[email protected]](mailto:[email protected]) and following the instructions you get in the confirmation message.

Our font announcements are also available through Twitter [@silfonts](http://twitter.com/silfonts).
Our font announcements are also available through Twitter [\@silfonts](http://twitter.com/silfonts).

## Supporting the project

Expand Down
2 changes: 1 addition & 1 deletion documentation/source/charset.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Kay Pho Du - Character Set Support
fontversion: 2.000
fontversion: 3.000
---

This font supports the Kayah Li script plus a range of useful Latin characters.
Expand Down
Loading

0 comments on commit c3a356a

Please sign in to comment.