Update documentation for a release

silnrsi · Aug 23, 2022 · dcf3e10 · dcf3e10
1 parent 9465ff4
commit dcf3e10
Showing 28 changed files with 28 additions and 27 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -43,6 +43,7 @@
 
 # Declare text files that will stay in LF (i.e. not expected to be used on Windows)
 makedocs text eol=lf
+makeftml text eol=lf
 preflight text eol=lf
 preflightg text eol=lf
 preflightff text eol=lf

diff --git a/FONTLOG.txt b/FONTLOG.txt
@@ -7,7 +7,7 @@ This information should be distributed along with the Dai Banna SIL fonts and an
 
 ## About this project
 
-This project is intended to provide a free and open font family for all current languages and writing systems that use the New Tai Lue (Xishuangbanna Dai) script.
+This project provides a free and open font family for the New Tai Lue (Xishuangbanna Dai) script.
 The New Tai Lue script is used by approximately 300,000 people who speak the Xishuangbanna Dai language in Yunnan, China. It is a simplification of the Tai Tham (Old Tai Lue) script as used for this language for hundreds of years.
 
 It uses Graphite technology to support complex script behaviours like intersyllabic line breaking in spaceless text. (NB: Only basic break opportunities are accounted for in the current release. Breaking behaviours for numbers and special CCV structures have yet to be added.)
@@ -18,7 +18,7 @@ The previous weights in two families (Dai Banna SIL Light and Dai Banna SIL Book
 
 (This should list both major and minor changes, most recent first.)
 
-### unreleased (SIL WSTech team) Dai Banna SIL version 4.000
+### 23 Aug 2022 (SIL WSTech team) Dai Banna SIL version 4.000
 - Switched to a single family with a wider range of weights.
 - Replaced many Latin glyphs with Gentium Plus at 92%
   The Latin glyphs that were kept were designed especially
@@ -73,7 +73,9 @@ submit the required form, please visit the CLA information page
 
 ## Acknowledgements
 
-(Here is where contributors can be acknowledged. If you make modifications be sure to add your name (N), email (E), web-address (W) and description (D). This list is sorted by last name in alphabetical order.)
+(Here is where contributors can be acknowledged.
+If you make modifications be sure to add your name (N), email (E), web-address (W) and description (D).
+This list is sorted by last name in alphabetical order.)
 
 N: Adrian Cheuk, Victor Gaultney, Martin Hosken, Julie Remington, Bobby de Vos
 E: https://software.sil.org/daibanna/#contact

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## Dai Banna SIL [![Build Status](http://build.palaso.org/app/rest/builds/buildType:Fonts_DaiBanna/statusIcon)](http://build.palaso.org/viewType.html?buildTypeId=Fonts_DaiBanna&guest=1)
 
-This project is intended to provide a free and open font family for all current languages and writing systems that use the New Tai Lue (Xishuangbanna Dai) script.
+This project provides a free and open font family for the New Tai Lue (Xishuangbanna Dai) script.
 This project uses a UFO-based design and production workflow, with all sources in open formats and a completely open-source build toolkit.
 
 To download the fonts visit the [Dai Banna SIL downloads page](https://software.sil.org/daibanna/#downloads) or the [Github releases page](https://github.com/silnrsi/font-daibannasil/releases).

diff --git a/README.txt b/README.txt
@@ -2,7 +2,7 @@ README
 Dai Banna SIL
 =============
 
-This project is intended to provide a free and open font family for all current languages and writing systems that use the New Tai Lue (Xishuangbanna Dai) script.
+This project provides a free and open font family for the New Tai Lue (Xishuangbanna Dai) script.
 This project uses a UFO-based design and production workflow, with all sources in open formats and a completely open-source build toolkit.
 
 To download the fonts visit the [Dai Banna SIL downloads page](https://software.sil.org/daibanna/#downloads) or the [Github releases page](https://github.com/silnrsi/font-daibannasil/releases).

diff --git a/documentation/about.html b/documentation/about.html
@@ -15,7 +15,7 @@
         <h1 class="title">Dai Banna SIL - About</h1>
     </header>
     <h2 id="about-this-project">About this project</h2>
-    <p>This project is intended to provide a free and open font family for all current languages and writing systems that use the New Tai Lue (Xishuangbanna Dai) script. The New Tai Lue script is used by approximately 300,000 people who speak the Xishuangbanna Dai language in Yunnan, China. It is a simplification of the Tai Tham (Old Tai Lue) script as used for this language for hundreds of years.</p>
+    <p>This project provides a free and open font family for the New Tai Lue (Xishuangbanna Dai) script. The New Tai Lue script is used by approximately 300,000 people who speak the Xishuangbanna Dai language in Yunnan, China. It is a simplification of the Tai Tham (Old Tai Lue) script as used for this language for hundreds of years.</p>
     <p>For more information on the visual characteristics of the font family see <a href="design.html">Design</a>.</p>
     <h2 id="future-plans">Future plans</h2>
     <p>Please send us your requests using the <a href="https://software.sil.org/daibanna/#contact">form on the font website</a>. If you are interested in helping us make the fonts better see the <a href="developer.html">Developer</a> page.</p>

diff --git a/documentation/charset.html b/documentation/charset.html
@@ -14,7 +14,7 @@
     <header>
         <h1 class="title">Dai Banna SIL - Character Set Support</h1>
     </header>
-    <p>Dai Banna SIL includes a complete set of New Tai Lue consonants, vowels, tones and digits, along with punctuation and other useful symbols. A basic set of Latin glyphs, including Arabic numerals, is also provided. Chinese punctuation used in New Tai Lue texts are included as well.</p>
+    <p>Dai Banna SIL includes a complete set of New Tai Lue consonants, vowels, tones and digits, along with punctuation and other useful symbols. Chinese punctuation used in New Tai Lue texts, and a basic set of Latin characters, are included as well. Inclusion of a 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>
     <h2 id="supported-characters">Supported characters</h2>
     <p>The following character ranges are supported by this font:</p>
     <table>

diff --git a/documentation/developer.html b/documentation/developer.html
@@ -2,7 +2,7 @@
 <html lang="en-us">
 <head>
     <meta charset="utf-8">
-    <title>Dai Banna SIL - Developer information</title>
+    <title>Dai Banna SIL - Developer Information</title>
     <meta name="author" content="SIL Writing Systems Technology">
     <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
     <link rel="stylesheet" href="./assets/css/theme.css">
@@ -12,7 +12,7 @@
 <div class="container">
 <article class="article">
     <header>
-        <h1 class="title">Dai Banna SIL - Developer information</h1>
+        <h1 class="title">Dai Banna SIL - Developer Information</h1>
     </header>
     <h2 id="welcome-font-developers">Welcome font developers!</h2>
     <p>We welcome other developers who wish to get involved in supporting and enhancing these fonts or who want to modify them.</p>

diff --git a/documentation/history.html b/documentation/history.html
@@ -14,7 +14,7 @@
     <header>
         <h1 class="title">Dai Banna SIL - Version History</h1>
     </header>
-    <h3 id="unreleased-sil-wstech-team-dai-banna-sil-version-4.000">unreleased (SIL WSTech team) Dai Banna SIL version 4.000</h3>
+    <h3 id="aug-2022-sil-wstech-team-dai-banna-sil-version-4.000">23 Aug 2022 (SIL WSTech team) Dai Banna SIL version 4.000</h3>
     <ul>
     <li>Switched to a single family with a wider range of weights.</li>
     <li>Replaced many Latin glyphs with Gentium Plus at 92% The Latin glyphs that were kept were designed especially for the Dai Banna characters.</li>

diff --git a/documentation/pdf/about.pdf b/documentation/pdf/about.pdf
diff --git a/documentation/pdf/charset.pdf b/documentation/pdf/charset.pdf
diff --git a/documentation/pdf/design.pdf b/documentation/pdf/design.pdf
diff --git a/documentation/pdf/developer.pdf b/documentation/pdf/developer.pdf
diff --git a/documentation/pdf/faq.pdf b/documentation/pdf/faq.pdf
diff --git a/documentation/pdf/history.pdf b/documentation/pdf/history.pdf
diff --git a/documentation/pdf/index.pdf b/documentation/pdf/index.pdf
diff --git a/documentation/pdf/resources.pdf b/documentation/pdf/resources.pdf
diff --git a/documentation/pdf/support.pdf b/documentation/pdf/support.pdf
diff --git a/documentation/pdf/versions.pdf b/documentation/pdf/versions.pdf
diff --git a/documentation/source/about.md b/documentation/source/about.md
@@ -5,7 +5,8 @@ fontversion: 4.000
 
 ## About this project
 
-This project is intended to provide a free and open font family for all current languages and writing systems that use the New Tai Lue (Xishuangbanna Dai) script. The New Tai Lue script is used by approximately 300,000 people who speak the Xishuangbanna Dai language in Yunnan, China. It is a simplification of the Tai Tham (Old Tai Lue) script as used for this language for hundreds of years.
+This project provides a free and open font family for the New Tai Lue (Xishuangbanna Dai) script.
+The New Tai Lue script is used by approximately 300,000 people who speak the Xishuangbanna Dai language in Yunnan, China. It is a simplification of the Tai Tham (Old Tai Lue) script as used for this language for hundreds of years.
 
 For more information on the visual characteristics of the font family see [Design](design.md).
 

diff --git a/documentation/source/charset.md b/documentation/source/charset.md
@@ -3,7 +3,10 @@ title: Dai Banna SIL - Character Set Support
 fontversion: 4.000
 ---
 
-Dai Banna SIL includes a complete set of New Tai Lue consonants, vowels, tones and digits, along with punctuation and other useful symbols. A basic set of Latin glyphs, including Arabic numerals, is also provided. Chinese punctuation used in New Tai Lue texts are included as well.
+Dai Banna SIL includes a complete set of New Tai Lue consonants, vowels, tones and digits, along with punctuation and other useful symbols.
+Chinese punctuation used in New Tai Lue texts, and a basic set of Latin characters, are included as well.
+Inclusion of a 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.
 
 ## Supported characters
 

diff --git a/documentation/source/developer.md b/documentation/source/developer.md
@@ -1,5 +1,5 @@
 ---
-title: Dai Banna SIL - Developer information
+title: Dai Banna SIL - Developer Information
 fontversion: 4.000
 ---
 

diff --git a/documentation/source/history.md b/documentation/source/history.md
@@ -3,7 +3,7 @@ title: Dai Banna SIL - Version History
 fontversion: 4.000
 ---
 
-### unreleased (SIL WSTech team) Dai Banna SIL version 4.000
+### 23 Aug 2022 (SIL WSTech team) Dai Banna SIL version 4.000
 - Switched to a single family with a wider range of weights.
 - Replaced many Latin glyphs with Gentium Plus at 92%
   The Latin glyphs that were kept were designed especially

diff --git a/documentation/source/productsite.md b/documentation/source/productsite.md
@@ -11,7 +11,7 @@ fontversion: 4.000
 
 <h2 id="about">About</h2>
 
-Dai Banna SIL is a Unicode font package for rendering New Tai Lue (Xishuangbanna Dai) characters. It includes a complete set of New Tai Lue consonants, vowels, tones, and digits, along with punctuation and other useful symbols. A basic set of Latin glyphs, including Arabic numerals, is also provided. Apart from a few New Tai Lue characters and Chinese punctuation marks, the design is the same as its predecessor, SIL Dai Banna (obsolete).
+Dai Banna SIL is a Unicode font package for rendering New Tai Lue (Xishuangbanna Dai) characters. It includes a complete set of New Tai Lue consonants, vowels, tones, and digits, along with punctuation and other useful symbols. Apart from a few New Tai Lue characters and Chinese punctuation marks, the design is the same as its predecessor, SIL Dai Banna (obsolete).
 
 For a different style of New Tai Lue script, see SIL’s [Nokyung](https://software.sil.org/nokyung) fonts.
 

diff --git a/documentation/source/productsite/singlepage.md b/documentation/source/productsite/singlepage.md
@@ -6,7 +6,7 @@
 
 <h2 id="about">About</h2>
 
-Dai Banna SIL is a Unicode font package for rendering New Tai Lue (Xishuangbanna Dai) characters. It includes a complete set of New Tai Lue consonants, vowels, tones, and digits, along with punctuation and other useful symbols. A basic set of Latin glyphs, including Arabic numerals, is also provided. Apart from a few New Tai Lue characters and Chinese punctuation marks, the design is the same as its predecessor, SIL Dai Banna (obsolete).
+Dai Banna SIL is a Unicode font package for rendering New Tai Lue (Xishuangbanna Dai) characters. It includes a complete set of New Tai Lue consonants, vowels, tones, and digits, along with punctuation and other useful symbols. Apart from a few New Tai Lue characters and Chinese punctuation marks, the design is the same as its predecessor, SIL Dai Banna (obsolete).
 
 For a different style of New Tai Lue script, see SIL’s [Nokyung](https://software.sil.org/nokyung) fonts.
 

diff --git a/documentation/source/versions.md b/documentation/source/versions.md
@@ -9,15 +9,15 @@ If you would like stay informed of updates to Dai Banna SIL and other SIL fonts,
 
 Our font announcements are also available through Twitter [@silfonts](http://twitter.com/silfonts).
 
-## Current versions
+## Current version
 
 The latest version of the fonts is always available from the [Dai Banna SIL download page](https://software.sil.org/daibanna/#downloads) as a .zip archive for all major platforms.
 
 This font package is also available in the [SIL software repository for Ubuntu](https://packages.sil.org/). Users can subscribe to this software repository and get current versions and updates automatically.
 
 ## Previous versions
 
-Previous versions remain available from our [Previous Versions archive](https://software.sil.org/daibanna/#downloads).
+Previous versions remain available from the [Dai Banna SIL download page](https://software.sil.org/daibanna/#downloads).
 
 ## Change history
 

diff --git a/documentation/versions.html b/documentation/versions.html
@@ -17,11 +17,11 @@ <h1 class="title">Dai Banna SIL - Versions and Changes</h1>
     <h2 id="announcement-list">Announcement list</h2>
     <p>If you would like stay informed of updates to Dai Banna SIL 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>
+    <h2 id="current-version">Current version</h2>
     <p>The latest version of the fonts is always available from the <a href="https://software.sil.org/daibanna/#downloads">Dai Banna SIL download page</a> as a .zip archive for all major platforms.</p>
     <p>This font package is also available in the <a href="https://packages.sil.org/">SIL software repository for Ubuntu</a>. Users can subscribe to this software repository and get current versions and updates automatically.</p>
     <h2 id="previous-versions">Previous versions</h2>
-    <p>Previous versions remain available from our <a href="https://software.sil.org/daibanna/#downloads">Previous Versions archive</a>.</p>
+    <p>Previous versions remain available from the <a href="https://software.sil.org/daibanna/#downloads">Dai Banna SIL download page</a>.</p>
     <h2 id="change-history">Change history</h2>
     <p>A detailed list of changes for each version of the fonts is on the <a href="history.html">Version history page</a>.</p>
     <footer class="footer">

diff --git a/tools/psfgenftml.py b/tools/psfgenftml.py
@@ -131,7 +131,6 @@ def setBackgroundColor(uids):
             ftml.closeTest()
 
     if test.lower().startswith("matras"):
-        # Combinations with matras:
         ftml.startTestGroup('Consonants with matras')
         for c in consonants:
             for m in matras:

diff --git a/wscript b/wscript
@@ -2,17 +2,12 @@
 # this is a smith configuration file
 
 # set the default output folders
-DOCDIR="doc"
+DOCDIR = ['documentation', 'web']
 
 # set the font name, version, licensing and description
 APPNAME="DaiBannaSIL"
 getufoinfo('source/masters/' + APPNAME + '-Light' + '.ufo')
 
-DESC_LONG = """
-Dai Banna SIL is a Unicode font package for the New Tai Lue script used by the Xishuangbanna Dai people.  It includes two font families which differ only in weight.  It has complete coverage of the Unicode 8.0 New Tai Lue block and smart code in Graphite.
-"""
-DESC_NAME = "DaiBannaSIL"
-
 # Set up the FTML tests
 ftmlTest('tools/ftml-smith.xsl')