Document mtiLib library

This commit is contained in:
Simon Cozens 2020-07-22 14:31:17 +01:00
parent b7c2e3d174
commit f72983b09d
2 changed files with 34 additions and 7 deletions

View File

@ -1,8 +1,14 @@
###### ###########################################
mtiLib mtiLib: Read Monotype FontDame source files
###### ###########################################
FontTools provides support for reading the OpenType layout tables produced by
Monotype's FontDame and Font Chef font editors. These tables are written in a
simple textual format. The ``mtiLib`` library parses these text files and creates
table objects representing their contents.
Additionally, ``fonttools mtiLib`` will convert a text file to TTX XML.
.. automodule:: fontTools.mtiLib .. automodule:: fontTools.mtiLib
:inherited-members: :members: build, main
:members:
:undoc-members:

View File

@ -1146,12 +1146,33 @@ class Tokenizer(object):
return line return line
def build(f, font, tableTag=None): def build(f, font, tableTag=None):
"""Parse a Monotype font layout file.
A font object must be passed, but this may be a "dummy" font; it is only
used for sorting glyph sets when making coverage tables.
Args:
f: A file object.
font (TTFont): A font object.
tableTag (string): If provided, asserts that the file contains data for the
given OpenType table.
Returns:
An object representing the table. (e.g. ``table_G_S_U_B_``)
"""
lines = Tokenizer(f) lines = Tokenizer(f)
return parseTable(lines, font, tableTag=tableTag) return parseTable(lines, font, tableTag=tableTag)
def main(args=None, font=None): def main(args=None, font=None):
"""Convert a FontDame OTL file to TTX XML""" """Convert a FontDame OTL file to TTX XML.
Writes XML output to stdout.
Args:
args: Command line arguments (``--font``, ``--table``, input files).
font (TTFont): If passed, used for sorting glyph sets.
"""
import sys import sys
from fontTools import configLogger from fontTools import configLogger
from fontTools.misc.testTools import MockFont from fontTools.misc.testTools import MockFont