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

[designspaceLib/docs] varLib spelling

Browse Source
This commit is contained in:
Behdad Esfahbod 2023-05-30 22:33:38 -06:00
parent 2740f98c9e
commit a8f9fa98ec
4 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/source/designspaceLib/index.rst
View File

@ -127,20 +127,20 @@ Implementation and differences
The designspace format has gone through considerable development. The designspace format has gone through considerable development.
- the format was originally written for MutatorMath. - the format was originally written for MutatorMath.
- the format is now also used in fontTools.varlib. - the format is now also used in fontTools.varLib.
- not all values are be required by all implementations. - not all values are be required by all implementations.
Varlib vs. MutatorMath varLib vs. MutatorMath
---------------------- ----------------------
There are some differences between the way MutatorMath and fontTools.varlib handle designspaces. There are some differences between the way MutatorMath and fontTools.varLib handle designspaces.
- Varlib does not support anisotropic interpolations. - varLib does not support anisotropic interpolations.
- MutatorMath will extrapolate over the boundaries of - MutatorMath will extrapolate over the boundaries of
the axes. Varlib can not (at the moment). the axes. varLib can not (at the moment).
- Varlib requires much less data to define an instance than - varLib requires much less data to define an instance than
MutatorMath. MutatorMath.
- The goals of Varlib and MutatorMath are different, so not all - The goals of varLib and MutatorMath are different, so not all
attributes are always needed. attributes are always needed.

2
Doc/source/designspaceLib/scripting.rst
View File

@ -234,7 +234,7 @@ You can generate the UFOs with MutatorMath:
- Assuming the outline data in the masters is compatible. - Assuming the outline data in the masters is compatible.
Or you can use the file in making a **variable font** with varlib. Or you can use the file in making a **variable font** with varLib.
.. _working_with_v5: .. _working_with_v5:

4
Doc/source/designspaceLib/xml.rst
View File

@ -867,7 +867,7 @@ The ``<instances>`` element contains one or more ``<instance>`` elements.
- Defines a single font that can be calculated with the designspace. - Defines a single font that can be calculated with the designspace.
- Child element of ``<instances>`` - Child element of ``<instances>``
- For use in Varlib the instance element really only needs the names - For use in varLib the instance element really only needs the names
and the location. The ``<glyphs>`` element is not required. and the location. The ``<glyphs>`` element is not required.
- MutatorMath uses the ``<glyphs>`` element to describe how certain - MutatorMath uses the ``<glyphs>`` element to describe how certain
glyphs need different masters, mainly to describe the effects of glyphs need different masters, mainly to describe the effects of
@ -942,7 +942,7 @@ with an ``xml:lang`` attribute:
<stylemapfamilyname xml:lang="ja">モンセラート SemiBold</stylemapfamilyname> <stylemapfamilyname xml:lang="ja">モンセラート SemiBold</stylemapfamilyname>
Example for varlib Example for varLib
------------------ ------------------
.. code:: xml .. code:: xml

40
Lib/fontTools/designspaceLib/__init__.py
View File

@ -206,7 +206,7 @@ class SourceDescriptor(SimpleDescriptor):
self.name = name self.name = name
"""string. Optional. Unique identifier name for this source. """string. Optional. Unique identifier name for this source.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.designLocation = ( self.designLocation = (
@ -214,7 +214,7 @@ class SourceDescriptor(SimpleDescriptor):
) )
"""dict. Axis values for this source, in design space coordinates. """dict. Axis values for this source, in design space coordinates.
MutatorMath + Varlib. MutatorMath + varLib.
This may be only part of the full design location. This may be only part of the full design location.
See :meth:`getFullDesignLocation()` See :meth:`getFullDesignLocation()`
@ -231,14 +231,14 @@ class SourceDescriptor(SimpleDescriptor):
can be extracted from the font, it can be efficient to have it right can be extracted from the font, it can be efficient to have it right
here. here.
Varlib. varLib.
""" """
self.styleName = styleName self.styleName = styleName
"""string. Style name of this source. Though this data """string. Style name of this source. Though this data
can be extracted from the font, it can be efficient to have it right can be extracted from the font, it can be efficient to have it right
here. here.
Varlib. varLib.
""" """
self.localisedFamilyName = localisedFamilyName or {} self.localisedFamilyName = localisedFamilyName or {}
"""dict. A dictionary of localised family name strings, keyed by """dict. A dictionary of localised family name strings, keyed by
@ -304,7 +304,7 @@ class SourceDescriptor(SimpleDescriptor):
def location(self): def location(self):
"""dict. Axis values for this source, in design space coordinates. """dict. Axis values for this source, in design space coordinates.
MutatorMath + Varlib. MutatorMath + varLib.
.. deprecated:: 5.0 .. deprecated:: 5.0
Use the more explicit alias for this property :attr:`designLocation`. Use the more explicit alias for this property :attr:`designLocation`.
@ -482,14 +482,14 @@ class AxisMappingDescriptor(SimpleDescriptor):
self.inputLocation: SimpleLocationDict = inputLocation or {} self.inputLocation: SimpleLocationDict = inputLocation or {}
"""dict. Axis values for the input of the mapping, in design space coordinates. """dict. Axis values for the input of the mapping, in design space coordinates.
Varlib. varLib.
.. versionadded:: 5.1 .. versionadded:: 5.1
""" """
self.outputLocation: SimpleLocationDict = outputLocation or {} self.outputLocation: SimpleLocationDict = outputLocation or {}
"""dict. Axis values for the output of the mapping, in design space coordinates. """dict. Axis values for the output of the mapping, in design space coordinates.
Varlib. varLib.
.. versionadded:: 5.1 .. versionadded:: 5.1
""" """
@ -606,7 +606,7 @@ class InstanceDescriptor(SimpleDescriptor):
) )
"""dict. Axis values for this instance, in design space coordinates. """dict. Axis values for this instance, in design space coordinates.
MutatorMath + Varlib. MutatorMath + varLib.
.. seealso:: This may be only part of the full location. See: .. seealso:: This may be only part of the full location. See:
:meth:`getFullDesignLocation` :meth:`getFullDesignLocation`
@ -617,7 +617,7 @@ class InstanceDescriptor(SimpleDescriptor):
self.userLocation: SimpleLocationDict = userLocation or {} self.userLocation: SimpleLocationDict = userLocation or {}
"""dict. Axis values for this instance, in user space coordinates. """dict. Axis values for this instance, in user space coordinates.
MutatorMath + Varlib. MutatorMath + varLib.
.. seealso:: This may be only part of the full location. See: .. seealso:: This may be only part of the full location. See:
:meth:`getFullDesignLocation` :meth:`getFullDesignLocation`
@ -628,27 +628,27 @@ class InstanceDescriptor(SimpleDescriptor):
self.familyName = familyName self.familyName = familyName
"""string. Family name of this instance. """string. Family name of this instance.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.styleName = styleName self.styleName = styleName
"""string. Style name of this instance. """string. Style name of this instance.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.postScriptFontName = postScriptFontName self.postScriptFontName = postScriptFontName
"""string. Postscript fontname for this instance. """string. Postscript fontname for this instance.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.styleMapFamilyName = styleMapFamilyName self.styleMapFamilyName = styleMapFamilyName
"""string. StyleMap familyname for this instance. """string. StyleMap familyname for this instance.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.styleMapStyleName = styleMapStyleName self.styleMapStyleName = styleMapStyleName
"""string. StyleMap stylename for this instance. """string. StyleMap stylename for this instance.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.localisedFamilyName = localisedFamilyName or {} self.localisedFamilyName = localisedFamilyName or {}
"""dict. A dictionary of localised family name """dict. A dictionary of localised family name
@ -698,7 +698,7 @@ class InstanceDescriptor(SimpleDescriptor):
def location(self): def location(self):
"""dict. Axis values for this instance. """dict. Axis values for this instance.
MutatorMath + Varlib. MutatorMath + varLib.
.. deprecated:: 5.0 .. deprecated:: 5.0
Use the more explicit alias for this property :attr:`designLocation`. Use the more explicit alias for this property :attr:`designLocation`.
@ -883,7 +883,7 @@ class AbstractAxisDescriptor(SimpleDescriptor):
self.name = name self.name = name
"""string. Name of the axis as it is used in the location dicts. """string. Name of the axis as it is used in the location dicts.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
# names for UI purposes, if this is not a standard axis, # names for UI purposes, if this is not a standard axis,
self.labelNames = labelNames or {} self.labelNames = labelNames or {}
@ -901,7 +901,7 @@ class AbstractAxisDescriptor(SimpleDescriptor):
user space is the same as design space, as in [(minimum, minimum), user space is the same as design space, as in [(minimum, minimum),
(maximum, maximum)]. (maximum, maximum)].
Varlib. varLib.
""" """
self.axisOrdering = axisOrdering self.axisOrdering = axisOrdering
"""STAT table field ``axisOrdering``. """STAT table field ``axisOrdering``.
@ -979,18 +979,18 @@ class AxisDescriptor(AbstractAxisDescriptor):
self.minimum = minimum self.minimum = minimum
"""number. The minimum value for this axis in user space. """number. The minimum value for this axis in user space.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.maximum = maximum self.maximum = maximum
"""number. The maximum value for this axis in user space. """number. The maximum value for this axis in user space.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
self.default = default self.default = default
"""number. The default value for this axis, i.e. when a new location is """number. The default value for this axis, i.e. when a new location is
created, this is the value this axis will get in user space. created, this is the value this axis will get in user space.
MutatorMath + Varlib. MutatorMath + varLib.
""" """
def serialize(self): def serialize(self):