summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/UniversalLanguageSelector/data/fontrepo/fonts/README
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/UniversalLanguageSelector/data/fontrepo/fonts/README')
-rw-r--r--www/wiki/extensions/UniversalLanguageSelector/data/fontrepo/fonts/README51
1 files changed, 51 insertions, 0 deletions
diff --git a/www/wiki/extensions/UniversalLanguageSelector/data/fontrepo/fonts/README b/www/wiki/extensions/UniversalLanguageSelector/data/fontrepo/fonts/README
new file mode 100644
index 00000000..8fdbee59
--- /dev/null
+++ b/www/wiki/extensions/UniversalLanguageSelector/data/fontrepo/fonts/README
@@ -0,0 +1,51 @@
+This is font repository for Universal Language Selector. These fonts are used
+by jquery.webfonts to deliver on demand or based on users preferences. There is
+a script named "compile-font-repo.php" to generate the font repository in
+JavaScript syntax. It reads this font.ini files.
+
+Each folder contains a font.ini file, which is the description about the font.
+The fields in the font.ini is described below. Use ';' to add any comments.
+
+languages
+---------
+list of language(s) to use for font. * in language code suggests it is default
+font for language.
+
+version
+-------
+Font version.
+
+license
+-------
+License in SPDX format. see licenses/README file for format and details.
+
+licensefile
+-----------
+Name of license file from licenses folder.
+
+request-url
+-----------
+URL of bug or request where font addition request was made. For more than 2
+languages, use URLs separated by comma in,
+
+request-url=url1, url2
+
+url
+---
+Upstream location of font to download.
+
+formats
+-------
+If there are style variants, font.ini should contain file names for each
+variants(bold, italic etc). Otherwise, based on the extension of files, the
+font compilation script can pick it up.
+
+Preparing font formats
+-----------------------
+
+1. From the upstream releases, take the TTF versions.
+2. To generate woff format, get: https://github.com/rillig/sfntly
+3. Use https://github.com/google/woff2 to generate woff2 from ttf. This will
+ produce a compressed woff2 file. Modern browsers support this format.
+4. The eot file format is used only by older IE, but it can be generated using
+ sfntly. Make sure to use -mtx flag to get enhanced compression.