[docs] Make front page user-facing, separate developer info
This commit is contained in:
Simon Cozens
parent
7b894956d5
commit
9691acb15d
115
Doc/source/developer.rst
Normal file
115
Doc/source/developer.rst
Normal file
@ -0,0 +1,115 @@
|
|||||||
|
.. _developerinfo:
|
||||||
|
.. image:: ../../Icons/FontToolsIconGreenCircle.png
|
||||||
|
:width: 200px
|
||||||
|
:height: 200px
|
||||||
|
:alt: Font Tools
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
|
||||||
|
fontTools Developer Information
|
||||||
|
===============================
|
||||||
|
|
||||||
|
If you would like to contribute to the development of fontTools, you can clone the repository from GitHub, install the package in 'editable' mode and modify the source code in place. We recommend creating a virtual environment, using the Python 3 `venv <https://docs.python.org/3/library/venv.html>`_ module::
|
||||||
|
|
||||||
|
# download the source code to 'fonttools' folder
|
||||||
|
git clone https://github.com/fonttools/fonttools.git
|
||||||
|
cd fonttools
|
||||||
|
|
||||||
|
# create new virtual environment called e.g. 'fonttools-venv', or anything you like
|
||||||
|
python -m venv fonttools-venv
|
||||||
|
|
||||||
|
# source the `activate` shell script to enter the environment (Un*x)
|
||||||
|
. fonttools-venv/bin/activate
|
||||||
|
|
||||||
|
# to activate the virtual environment in Windows `cmd.exe`, do
|
||||||
|
fonttools-venv\Scripts\activate.bat
|
||||||
|
|
||||||
|
# install in 'editable' mode
|
||||||
|
pip install -e .
|
||||||
|
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
To exit a Python virtual environment, enter the command ``deactivate``.
|
||||||
|
|
||||||
|
Testing
|
||||||
|
-------
|
||||||
|
|
||||||
|
To run the test suite, you need to install `pytest <http://docs.pytest.org/en/latest/>`__.
|
||||||
|
When you run the ``pytest`` command, the tests will run against the
|
||||||
|
installed fontTools package, or the first one found in the
|
||||||
|
``PYTHONPATH``.
|
||||||
|
|
||||||
|
You can also use `tox <https://tox.readthedocs.io/en/latest/>`__ to
|
||||||
|
automatically run tests on different Python versions in isolated virtual
|
||||||
|
environments::
|
||||||
|
|
||||||
|
pip install tox
|
||||||
|
tox
|
||||||
|
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
When you run ``tox`` without arguments, the tests are executed for all the environments listed in the ``tox.ini`` ``envlist``. The current Python interpreters defined for tox testing must be available on your system ``PATH``.
|
||||||
|
|
||||||
|
You can specify a different testing environment list via the ``-e`` option, or the ``TOXENV`` environment variable::
|
||||||
|
|
||||||
|
tox -e py36
|
||||||
|
TOXENV="py36-cov,htmlcov" tox
|
||||||
|
|
||||||
|
|
||||||
|
Development Community
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
fontTools development is ongoing in an active community of developers that includes professional developers employed at major software corporations and type foundries as well as hobbyists.
|
||||||
|
|
||||||
|
Feature requests and bug reports are always welcome at https://github.com/fonttools/fonttools/issues/
|
||||||
|
|
||||||
|
The best place for end-user and developer discussion about the fontTools project is the `fontTools gitter channel <https://gitter.im/fonttools-dev/Lobby>`_. There is also a development https://groups.google.com/d/forum/fonttools-dev mailing list for continuous integration notifications.
|
||||||
|
|
||||||
|
|
||||||
|
History
|
||||||
|
-------
|
||||||
|
|
||||||
|
The fontTools project was started by Just van Rossum in 1999, and was
|
||||||
|
maintained as an open source project at
|
||||||
|
http://sourceforge.net/projects/fonttools/. In 2008, Paul Wise (pabs3)
|
||||||
|
began helping Just with stability maintenance. In 2013 Behdad Esfahbod
|
||||||
|
began a friendly fork, thoroughly reviewing the codebase and making
|
||||||
|
changes at https://github.com/behdad/fonttools to add new features and
|
||||||
|
support for new font formats.
|
||||||
|
|
||||||
|
|
||||||
|
Acknowledgments
|
||||||
|
---------------
|
||||||
|
|
||||||
|
In alphabetical order:
|
||||||
|
|
||||||
|
Olivier Berten, Samyak Bhuta, Erik van Blokland, Petr van Blokland,
|
||||||
|
Jelle Bosma, Sascha Brawer, Tom Byrer, Frédéric Coiffier, Vincent
|
||||||
|
Connare, Dave Crossland, Simon Daniels, Peter Dekkers, Behdad Esfahbod,
|
||||||
|
Behnam Esfahbod, Hannes Famira, Sam Fishman, Matt Fontaine, Yannis
|
||||||
|
Haralambous, Greg Hitchcock, Jeremie Hornus, Khaled Hosny, John Hudson,
|
||||||
|
Denis Moyogo Jacquerye, Jack Jansen, Tom Kacvinsky, Jens Kutilek,
|
||||||
|
Antoine Leca, Werner Lemberg, Tal Leming, Peter Lofting, Cosimo Lupo,
|
||||||
|
Masaya Nakamura, Dave Opstad, Laurence Penney, Roozbeh Pournader, Garret
|
||||||
|
Rieger, Read Roberts, Guido van Rossum, Just van Rossum, Andreas Seidel,
|
||||||
|
Georg Seifert, Chris Simpkins, Miguel Sousa, Adam Twardoch, Adrien Tétar, Vitaly Volkov,
|
||||||
|
Paul Wise.
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
|
|
||||||
|
`MIT license <https://github.com/fonttools/fonttools/blob/master/LICENSE>`_. See the full text of the license for details.
|
||||||
|
|
||||||
|
.. |Travis Build Status| image:: https://travis-ci.org/fonttools/fonttools.svg
|
||||||
|
:target: https://travis-ci.org/fonttools/fonttools
|
||||||
|
.. |Appveyor Build status| image:: https://ci.appveyor.com/api/projects/status/0f7fmee9as744sl7/branch/master?svg=true
|
||||||
|
:target: https://ci.appveyor.com/project/fonttools/fonttools/branch/master
|
||||||
|
.. |Coverage Status| image:: https://codecov.io/gh/fonttools/fonttools/branch/master/graph/badge.svg
|
||||||
|
:target: https://codecov.io/gh/fonttools/fonttools
|
||||||
|
.. |PyPI| image:: https://img.shields.io/pypi/v/fonttools.svg
|
||||||
|
:target: https://pypi.org/project/FontTools
|
||||||
|
.. |Gitter Chat| image:: https://badges.gitter.im/fonttools-dev/Lobby.svg
|
||||||
|
:alt: Join the chat at https://gitter.im/fonttools-dev/Lobby
|
||||||
|
:target: https://gitter.im/fonttools-dev/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
||||||
@ -8,13 +8,12 @@
|
|||||||
fontTools Docs
|
fontTools Docs
|
||||||
==============
|
==============
|
||||||
|
|
||||||
|Travis Build Status| |Appveyor Build status| |Coverage Status| |PyPI| |Gitter Chat|
|
|
||||||
|
|
||||||
About
|
About
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
fontTools is a family of libraries and utilities for manipulating fonts in Python.
|
||||||
|
|
||||||
fontTools is a library for manipulating fonts, written in Python. The project includes the TTX tool, that can convert TrueType and OpenType fonts to and from an XML text format, which is also called TTX. It supports TrueType, OpenType, AFM and to an extent Type 1 and some Mac-specific formats. The project has an `MIT open-source license <https://github.com/fonttools/fonttools/blob/master/LICENSE>`_. Among other things this means you can use it free of charge.
|
The project has an `MIT open-source license <https://github.com/fonttools/fonttools/blob/master/LICENSE>`_. Among other things this means you can use it free of charge.
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
@ -27,86 +26,10 @@ The package is listed in the Python Package Index (PyPI), so you can install it
|
|||||||
|
|
||||||
pip install fonttools
|
pip install fonttools
|
||||||
|
|
||||||
If you would like to contribute to its development, you can clone the repository from GitHub, install the package in 'editable' mode and modify the source code in place. We recommend creating a virtual environment, using the Python 3 `venv <https://docs.python.org/3/library/venv.html>`_ module::
|
|
||||||
|
|
||||||
# download the source code to 'fonttools' folder
|
|
||||||
git clone https://github.com/fonttools/fonttools.git
|
|
||||||
cd fonttools
|
|
||||||
|
|
||||||
# create new virtual environment called e.g. 'fonttools-venv', or anything you like
|
|
||||||
python -m venv fonttools-venv
|
|
||||||
|
|
||||||
# source the `activate` shell script to enter the environment (Un*x)
|
|
||||||
. fonttools-venv/bin/activate
|
|
||||||
|
|
||||||
# to activate the virtual environment in Windows `cmd.exe`, do
|
|
||||||
fonttools-venv\Scripts\activate.bat
|
|
||||||
|
|
||||||
# install in 'editable' mode
|
|
||||||
pip install -e .
|
|
||||||
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
To exit a Python virtual environment, enter the command ``deactivate``.
|
|
||||||
|
|
||||||
See the Optional Requirements section below for details about module-specific dependencies that must be installed in select cases.
|
See the Optional Requirements section below for details about module-specific dependencies that must be installed in select cases.
|
||||||
|
|
||||||
|
Utilities
|
||||||
TTX – From OpenType and TrueType to XML and Back
|
---------
|
||||||
------------------------------------------------
|
|
||||||
|
|
||||||
Once installed you can use the ttx command to convert binary font files (.otf, .ttf, etc) to the TTX XML format, edit them, and convert them back to binary format. TTX files have a .ttx file extension::
|
|
||||||
|
|
||||||
ttx /path/to/font.otf
|
|
||||||
ttx /path/to/font.ttx
|
|
||||||
|
|
||||||
The TTX application can be used in two ways, depending on what platform you run it on:
|
|
||||||
|
|
||||||
* As a command line tool (Windows/DOS, Unix, macOS)
|
|
||||||
* By dropping files onto the application (Windows, macOS)
|
|
||||||
|
|
||||||
TTX detects what kind of files it is fed: it will output a ``.ttx`` file when it sees a ``.ttf`` or ``.otf``, and it will compile a ``.ttf`` or ``.otf`` when the input file is a ``.ttx`` file. By default, the output file is created in the same folder as the input file, and will have the same name as the input file but with a different extension. TTX will never overwrite existing files, but if necessary will append a unique number to the output filename (before the extension) such as ``Arial#1.ttf``.
|
|
||||||
|
|
||||||
When using TTX from the command line there are a bunch of extra options. These are explained in the help text, as displayed when typing ``ttx -h`` at the command prompt. These additional options include:
|
|
||||||
|
|
||||||
|
|
||||||
* specifying the folder where the output files are created
|
|
||||||
* specifying which tables to dump or which tables to exclude
|
|
||||||
* merging partial .ttx files with existing .ttf or .otf files
|
|
||||||
* listing brief table info instead of dumping to .ttx
|
|
||||||
* splitting tables to separate .ttx files
|
|
||||||
* disabling TrueType instruction disassembly
|
|
||||||
|
|
||||||
The TTX file format
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
The following tables are currently supported::
|
|
||||||
|
|
||||||
BASE, CBDT, CBLC, CFF, CFF2, COLR, CPAL, DSIG, EBDT, EBLC, FFTM,
|
|
||||||
Feat, GDEF, GMAP, GPKG, GPOS, GSUB, Glat, Gloc, HVAR, JSTF, LTSH,
|
|
||||||
MATH, META, MVAR, OS/2, SING, STAT, SVG, Silf, Sill, TSI0, TSI1,
|
|
||||||
TSI2, TSI3, TSI5, TSIB, TSID, TSIJ, TSIP, TSIS, TSIV, TTFA, VDMX,
|
|
||||||
VORG, VVAR, ankr, avar, bsln, cidg, cmap, cvar, cvt, feat, fpgm,
|
|
||||||
fvar, gasp, gcid, glyf, gvar, hdmx, head, hhea, hmtx, kern, lcar,
|
|
||||||
loca, ltag, maxp, meta, mort, morx, name, opbd, post, prep, prop,
|
|
||||||
sbix, trak, vhea and vmtx
|
|
||||||
|
|
||||||
Other tables are dumped as hexadecimal data.
|
|
||||||
|
|
||||||
TrueType fonts use glyph indices (GlyphIDs) to refer to glyphs in most places. While this is fine in binary form, it is really hard to work with for humans. Therefore we use names instead.
|
|
||||||
|
|
||||||
The glyph names are either extracted from the ``CFF`` table or the ``post`` table, or are derived from a Unicode ``cmap`` table. In the latter case the Adobe Glyph List is used to calculate names based on Unicode values. If all of these methods fail, names are invented based on GlyphID (eg ``glyph00142``)
|
|
||||||
|
|
||||||
It is possible that different glyphs use the same name. If this happens, we force the names to be unique by appending #n to the name (n being an integer number.) The original names are being kept, so this has no influence on a "round tripped" font.
|
|
||||||
|
|
||||||
Because the order in which glyphs are stored inside the binary font is important, we maintain an ordered list of glyph names in the font.
|
|
||||||
|
|
||||||
Please see the :py:mod:`fontTools.ttx` documentation for additional details.
|
|
||||||
|
|
||||||
|
|
||||||
Other Tools
|
|
||||||
-----------
|
|
||||||
|
|
||||||
Commands for merging and subsetting fonts are also available::
|
Commands for merging and subsetting fonts are also available::
|
||||||
|
|
||||||
@ -115,22 +38,12 @@ Commands for merging and subsetting fonts are also available::
|
|||||||
|
|
||||||
Please see the :py:mod:`fontTools.merge` and :py:mod:`fontTools.subset` documentation for additional information about these tools.
|
Please see the :py:mod:`fontTools.merge` and :py:mod:`fontTools.subset` documentation for additional information about these tools.
|
||||||
|
|
||||||
|
Libraries
|
||||||
|
---------
|
||||||
|
|
||||||
fontTools Python Library
|
XXX
|
||||||
------------------------
|
|
||||||
|
|
||||||
The fontTools Python library provides a convenient way to programmatically edit font files::
|
|
||||||
|
|
||||||
>>> from fontTools.ttLib import TTFont
|
|
||||||
>>> font = TTFont('/path/to/font.ttf')
|
|
||||||
>>> font
|
|
||||||
<fontTools.ttLib.TTFont object at 0x10c34ed50>
|
|
||||||
>>>
|
|
||||||
|
|
||||||
A selection of sample Python programs is in the `Snippets directory <https://github.com/fonttools/fonttools/blob/master/Snippets/>`_ of the fontTools repository.
|
|
||||||
|
|
||||||
Please navigate to the respective area of the documentation to learn more about the available modules in the fontTools library.
|
|
||||||
|
|
||||||
|
A selection of sample Python programs using these libaries can be found in the `Snippets directory <https://github.com/fonttools/fonttools/blob/master/Snippets/>`_ of the fontTools repository.
|
||||||
|
|
||||||
Optional Requirements
|
Optional Requirements
|
||||||
---------------------
|
---------------------
|
||||||
@ -278,71 +191,10 @@ Pen to drawing glyphs as PNG images, requires:
|
|||||||
* `reportlab <https://pypi.python.org/pypi/reportlab>`__: Python toolkit for generating PDFs and
|
* `reportlab <https://pypi.python.org/pypi/reportlab>`__: Python toolkit for generating PDFs and
|
||||||
graphics.
|
graphics.
|
||||||
|
|
||||||
|
Developer information
|
||||||
Testing
|
|
||||||
-------
|
|
||||||
|
|
||||||
To run the test suite, you need to install `pytest <http://docs.pytest.org/en/latest/>`__.
|
|
||||||
When you run the ``pytest`` command, the tests will run against the
|
|
||||||
installed fontTools package, or the first one found in the
|
|
||||||
``PYTHONPATH``.
|
|
||||||
|
|
||||||
You can also use `tox <https://tox.readthedocs.io/en/latest/>`__ to
|
|
||||||
automatically run tests on different Python versions in isolated virtual
|
|
||||||
environments::
|
|
||||||
|
|
||||||
pip install tox
|
|
||||||
tox
|
|
||||||
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
When you run ``tox`` without arguments, the tests are executed for all the environments listed in the ``tox.ini`` ``envlist``. The current Python interpreters defined for tox testing must be available on your system ``PATH``.
|
|
||||||
|
|
||||||
You can specify a different testing environment list via the ``-e`` option, or the ``TOXENV`` environment variable::
|
|
||||||
|
|
||||||
tox -e py36
|
|
||||||
TOXENV="py36-cov,htmlcov" tox
|
|
||||||
|
|
||||||
|
|
||||||
Development Community
|
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
fontTools development is ongoing in an active community of developers that includes professional developers employed at major software corporations and type foundries as well as hobbyists.
|
Information for developers can be found :doc:`here <./developer>`.
|
||||||
|
|
||||||
Feature requests and bug reports are always welcome at https://github.com/fonttools/fonttools/issues/
|
|
||||||
|
|
||||||
The best place for end-user and developer discussion about the fontTools project is the `fontTools gitter channel <https://gitter.im/fonttools-dev/Lobby>`_. There is also a development https://groups.google.com/d/forum/fonttools-dev mailing list for continuous integration notifications.
|
|
||||||
|
|
||||||
|
|
||||||
History
|
|
||||||
-------
|
|
||||||
|
|
||||||
The fontTools project was started by Just van Rossum in 1999, and was
|
|
||||||
maintained as an open source project at
|
|
||||||
http://sourceforge.net/projects/fonttools/. In 2008, Paul Wise (pabs3)
|
|
||||||
began helping Just with stability maintenance. In 2013 Behdad Esfahbod
|
|
||||||
began a friendly fork, thoroughly reviewing the codebase and making
|
|
||||||
changes at https://github.com/behdad/fonttools to add new features and
|
|
||||||
support for new font formats.
|
|
||||||
|
|
||||||
|
|
||||||
Acknowledgments
|
|
||||||
---------------
|
|
||||||
|
|
||||||
In alphabetical order:
|
|
||||||
|
|
||||||
Olivier Berten, Samyak Bhuta, Erik van Blokland, Petr van Blokland,
|
|
||||||
Jelle Bosma, Sascha Brawer, Tom Byrer, Frédéric Coiffier, Vincent
|
|
||||||
Connare, Dave Crossland, Simon Daniels, Peter Dekkers, Behdad Esfahbod,
|
|
||||||
Behnam Esfahbod, Hannes Famira, Sam Fishman, Matt Fontaine, Yannis
|
|
||||||
Haralambous, Greg Hitchcock, Jeremie Hornus, Khaled Hosny, John Hudson,
|
|
||||||
Denis Moyogo Jacquerye, Jack Jansen, Tom Kacvinsky, Jens Kutilek,
|
|
||||||
Antoine Leca, Werner Lemberg, Tal Leming, Peter Lofting, Cosimo Lupo,
|
|
||||||
Masaya Nakamura, Dave Opstad, Laurence Penney, Roozbeh Pournader, Garret
|
|
||||||
Rieger, Read Roberts, Guido van Rossum, Just van Rossum, Andreas Seidel,
|
|
||||||
Georg Seifert, Chris Simpkins, Miguel Sousa, Adam Twardoch, Adrien Tétar, Vitaly Volkov,
|
|
||||||
Paul Wise.
|
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|||||||
@ -2,6 +2,56 @@
|
|||||||
ttx
|
ttx
|
||||||
###
|
###
|
||||||
|
|
||||||
|
|
||||||
|
TTX – From OpenType and TrueType to XML and Back
|
||||||
|
------------------------------------------------
|
||||||
|
|
||||||
|
Once installed you can use the ttx command to convert binary font files (.otf, .ttf, etc) to the TTX XML format, edit them, and convert them back to binary format. TTX files have a .ttx file extension::
|
||||||
|
|
||||||
|
ttx /path/to/font.otf
|
||||||
|
ttx /path/to/font.ttx
|
||||||
|
|
||||||
|
The TTX application can be used in two ways, depending on what platform you run it on:
|
||||||
|
|
||||||
|
* As a command line tool (Windows/DOS, Unix, macOS)
|
||||||
|
* By dropping files onto the application (Windows, macOS)
|
||||||
|
|
||||||
|
TTX detects what kind of files it is fed: it will output a ``.ttx`` file when it sees a ``.ttf`` or ``.otf``, and it will compile a ``.ttf`` or ``.otf`` when the input file is a ``.ttx`` file. By default, the output file is created in the same folder as the input file, and will have the same name as the input file but with a different extension. TTX will never overwrite existing files, but if necessary will append a unique number to the output filename (before the extension) such as ``Arial#1.ttf``.
|
||||||
|
|
||||||
|
When using TTX from the command line there are a bunch of extra options. These are explained in the help text, as displayed when typing ``ttx -h`` at the command prompt. These additional options include:
|
||||||
|
|
||||||
|
|
||||||
|
* specifying the folder where the output files are created
|
||||||
|
* specifying which tables to dump or which tables to exclude
|
||||||
|
* merging partial .ttx files with existing .ttf or .otf files
|
||||||
|
* listing brief table info instead of dumping to .ttx
|
||||||
|
* splitting tables to separate .ttx files
|
||||||
|
* disabling TrueType instruction disassembly
|
||||||
|
|
||||||
|
The TTX file format
|
||||||
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
The following tables are currently supported::
|
||||||
|
|
||||||
|
BASE, CBDT, CBLC, CFF, CFF2, COLR, CPAL, DSIG, EBDT, EBLC, FFTM,
|
||||||
|
Feat, GDEF, GMAP, GPKG, GPOS, GSUB, Glat, Gloc, HVAR, JSTF, LTSH,
|
||||||
|
MATH, META, MVAR, OS/2, SING, STAT, SVG, Silf, Sill, TSI0, TSI1,
|
||||||
|
TSI2, TSI3, TSI5, TSIB, TSID, TSIJ, TSIP, TSIS, TSIV, TTFA, VDMX,
|
||||||
|
VORG, VVAR, ankr, avar, bsln, cidg, cmap, cvar, cvt, feat, fpgm,
|
||||||
|
fvar, gasp, gcid, glyf, gvar, hdmx, head, hhea, hmtx, kern, lcar,
|
||||||
|
loca, ltag, maxp, meta, mort, morx, name, opbd, post, prep, prop,
|
||||||
|
sbix, trak, vhea and vmtx
|
||||||
|
|
||||||
|
Other tables are dumped as hexadecimal data.
|
||||||
|
|
||||||
|
TrueType fonts use glyph indices (GlyphIDs) to refer to glyphs in most places. While this is fine in binary form, it is really hard to work with for humans. Therefore we use names instead.
|
||||||
|
|
||||||
|
The glyph names are either extracted from the ``CFF`` table or the ``post`` table, or are derived from a Unicode ``cmap`` table. In the latter case the Adobe Glyph List is used to calculate names based on Unicode values. If all of these methods fail, names are invented based on GlyphID (eg ``glyph00142``)
|
||||||
|
|
||||||
|
It is possible that different glyphs use the same name. If this happens, we force the names to be unique by appending #n to the name (n being an integer number.) The original names are being kept, so this has no influence on a "round tripped" font.
|
||||||
|
|
||||||
|
Because the order in which glyphs are stored inside the binary font is important, we maintain an ordered list of glyph names in the font.
|
||||||
|
|
||||||
.. automodule:: fontTools.ttx
|
.. automodule:: fontTools.ttx
|
||||||
:inherited-members:
|
:inherited-members:
|
||||||
:members:
|
:members:
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user