shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document the required setup method call order

Browse Source
This commit is contained in:
justvanrossum 2018-11-01 12:37:37 +01:00
parent 723afd626d
commit 8d2615e9c8
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Lib/fontTools/fontBuilder.py
View File

@ -6,12 +6,23 @@ __all__ = ["FontBuilder"]
"""
This module is *experimental*, meaning it still may evolve and change.
The `FontBuilder` class is a convenient helper to construct working TTF or OTF
fonts from scratch.
The `FontBuilder` class is a convenient helper to construct working TTF or
OTF fonts from scratch.
Note that the various setup method calls cannot be done in arbitrary order,
due to various interdependencies between OpenType tables. See the examples
below for an order that works.
Note that the various setup methods cannot be called in arbitrary order,
due to various interdependencies between OpenType tables. Here is an order
that works:
fb = FontBuilder(...)
fb.setupGlyphOrder(...)
fb.setupCharacterMap(...)
fb.setupGlyf(...) --or-- fb.setupCFF(...)
fb.setupMetrics("hmtx", ...)
fb.setupHorizontalHeader()
fb.setupNameTable(...)
fb.setupOS2()
fb.setupPost()
fb.save(...)
Here is how to build a minimal TTF: