openfv

打开字体版本规范

版本0.3.0

状态：实验，不稳定的草稿

目录

• 介绍和理由
• 定义
• OpenFV规范
  • 名称表ID 5记录规范
  • 头桌fontrevision记录规范
  • 版本编号语义
• 例子
  • 名称表ID 5记录示例
  • 头桌fontrevision记录示例
• 执照

介绍和理由

软件版本字符串通常包括以下语义：

• 源代码相对于最后版本的大小和向后兼容性变化
• 源代码的生产级别发布的准备就绪到最终用户
• 构建时间的源代码状态

在软件开发过程中，建立且广泛使用的SEMVER方法用于语义软件版本使用使用版本编号MAJOR.MINOR.PATCH 。随着工作的发展，通常将其他元数据附加到该SEMVER语法上，以指示最终用户一般使用软件的准备就绪（例如v1.2.0-alpha ， v1.2.0-beta ， v1.2.0-rc.1 ， v1.2.0-rc.2 ， v1.2.0 ）。从源代码中创建编译的二进制文物的项目经常将标签与构建工件相关联，以在构建时间建立源代码状态的记录（例如，git commit sha1 hash字符串）。

这些版本控制概念适用于字体软件的开发，并且在开发过程中是可取的。但是，在Opentype字体版本规范中，它们并非全部定义。字体软件版本字符串被编译到Opentype名称表的NameID 5记录中，以及Opentype Head表的Fontrevision记录。这些记录以下面的方式定义在Opentype格式规范中，并在SIL FONT开发最佳实践文档（源）中进行了解释。

Opentype名称表ID 5记录定义

版本字符串。应该从语法的“版本”开始。 （上情况，下情况或混合，在“版本”和数字之间具有空间）。

该字符串必须包含以下形式的版本编号：一个或多个值的数字（0-9）小于65,535，其次是一个期间，然后是一个或多个值的数字小于65,535。除了数字以外的任何字符都将终止次要数字。诸如“;”之类的角色有助于分开不同的版本信息。

字符串中的第一个匹配可以通过安装软件使用来比较字体版本。请注意，某些安装程序可能要求字符串以“版本”开头，然后是上述版本号。

（来源）

Opentype Head Table Fontrevision记录定义

由字体制造商设置

（来源）

Opentype规范将版本编号定义为MAJOR.MINOR 。没有针对PATCH / BUILD版本编号或版本号元数据字符串的规范。由于字体编译器约定，字体版本控制与SEMVER版本编号格式更加偏离，其中包括MINOR编号中的零填充。虽然在nameID 5记录中并不总是如此，但这是head.fontrevision记录中使用的一致格式。使用这种方法对版本编号的解释不是直观的。版本编号字符串Version 1.1 ， Version 1.01和Version 1.001都定义为“不同”，尽管这些数字都可能代表相同的开发阶段（即，超出了第一个主要版本的一个迭代）。由于项目作者建立的约定以及用来从源代码编译字体的工具，因此在版本号上出现了这些差异。 Opentype定义没有指定格式来指示类型项目相对于其版本里程碑的开发状态，也没有定义一种方法来维护字体构建构建伪像的构建时间的信息。缺乏解决上述问题的正式标准为该规范提供了动力。

开放字体版本（OpenFV）规范代表Opentype名称表名称5记录和Opentype Head.Fontrevision记录规格的符合符合的扩展名。 OpenFV旨在用作字体源代码的开发，测试，发布和使用的字体软件版本管理标准，以及源自源的构建工件（FONTS）。该规范定义了具有语义基础的版本编号字符串语法，该语义基础为开发人员和用户提供了信息性数据。

定义

• 构建- 任何字体构建伪影类型的编译文件，该文件是由构建时间源代码状态定义的（即字体二进制文件）定义的
• 开发- 源代码和编译的构建工件状态，包括不完整的工作以实现释放里程碑
• 元数据- 落在版本号字符串的OpenFV定义之外的数据
• 位置一个- 版本字符串的第一个子字母位置
• 位置两个- 版本字符串的第二个子字母位置
• 发布- 源代码和编译的构建人工制品的里程碑，用于最终用户的生产水平使用
• 状态- 源代码开发/发布状态的二进制指标
• 状态- 构建时间源代码状态的指标

关键词“必须”，“必须”，“必需”，“应”，“不得”，“应该”，“不应该”，“不建议”，“推荐”，“可能”，“可能”和“可选”，如RFC 2119中所述，应解释。

OpenFV规范

1。名称表ID 5记录版本字符串

一个。版本字符串语法

Opentype名称表ID 5记录中的版本字符串必须定义为强制性和可选数据元素的半符号划界子字符串。

完整版字符串的子字符串元素的OpenFV规范语法是：

 [Font Version Number]; [Status/State Metadata]; [Other Metadata]

字体版本字符串必须包括：

• 字体版本号substring

字体版本字符串可能包括：

• 状态/状态元数据基因
• 其他元数据基因

b。字体版本号substring

字体版本号substring：

• 必须位于子字母位置。
• 必须定义为大写的单词“版本”，一个太空字形（U+0020）， MAJOR版本号码，一个周期（u+002E）， MINOR版本编号数字。
• 不得包括元数据。
• 如果元数据遵循二线位置的字体版本编号子字节串联，则可以在其最终角色位置中包含一个半角色位置。空格字符不应在MINOR版本编号和半隆之间包含。
• 如果在版本号substring之后没有元数据，则不得包括半隆。

MAJOR版本编号：

• 必须具有最低值为0的一至三位数，最大值为999。

MINOR版本号：

• 必须恰好有三位数。对于小于100的数字，必须在MINOR版本编号中使用零填充物。 MINOR版本号必须的最小值为000，最大值为999。

c。状态元数据基因

州元数据基因：

• 应在字体构建时间定义源代码状态。
• 是可选的。
• 必须位于字体版本字符串的两个子字符串位置。
• 不得包含集合之外的字符： a-zA-Z0-9._-
• 必须将定界符[作为初始字符和定界符]作为基因的最终字符。这些定系数中的字符串内容应定义为“状态标签”。状态标签应为50个字符或更少。
• 可能包括状态基因（见下文）。

d。状态元数据基因

状态元数据基因：

• 应定义源代码和字体构建的二进制开发/发布状态，如定义部分所定义。
• 是可选的。
• 必须位于二弦位置二。
• 必须使用以下情况敏感格式之一，其版本字符串中的版本字符串或一个前面的空间字符，该格式不包含状态基因字符串：
  • DEV
  • RELEASE
• 必须使用以下案例敏感格式之一，而不用先前的空格字符来进行版本字符串，其中包含状态子字符串：
  • -dev
  • -release

e。其他元数据基因

其他元数据基因：

• 是可选的。
• 可以在字体版本字符串中包含一次或多次
• 必须遵循所有版本编号substring和状态/状态基弦数据，具有半元素定界符，然后是零或一个空间字符，互相元数据基因。
• 应限制为50个字符或更少。

2。头表fontrevision记录版本字符串

Opentype头表的Fontrevision记录中的字体版本号：

• 必须定义为MAJOR版本编号数字，一个时期， MINOR版本编号数字
• 必须具有一个主要版本编号，最小值为0，最大值为999。
• 必须有一个MINOR版本编号，其长度恰好是三位数。对于小于100的MINOR版本编号，必须使用零填充。 MINOR版本号必须的最小值为000，最大值为999。
• 不得在MAJOR版本编号之前或MINOR版本编号之前包含任何字符

3。版本编号语义

• MAJOR.MINOR版本编号应旨在代表一个释放里程碑，该里程碑可能在用MAJOR.MINOR版本编号定义的来源中无法完全实现。 MAJOR.MINOR版本编号不应在构建工件中的构建时间表示源代码状态，并且在构建工件中可能并不是唯一的，因为进行了工作以实现MAJOR.MINOR版本。
• 开发源状态应通过使用该规范中定义的状态元数据基因来区分发行源状态。
• 在初始版本之前的开发前阶段，应将MAJOR版本编号设置为0。 MAJOR版本编号0应指示此预生产阶段的开发阶段。
• 最初版本时，必须将MAJOR版本编号设置为1。从MAJOR版本0到MAJOR版本1的转换应表明作者的确认，即源代码和构建工件符合OpenFV版本的定义。
• 完成源代码更改以实现释放里程碑后，应立即执行版本编号增量，然后再对源代码进行更改，该源代码旨在为将来的版本里程碑进行更改。

更改版本编号的语义应包括以下1个值的增量：

• 完成特定项目的主要里程碑以及对字体软件进行的所有向后不兼容的更改（例如，消除对整个Unicode代码范围的支持）的MAJOR版本编号。
• MINOR版本编号，用于功能，hotfix和依赖关系更改。示例包括：
  • 字形设计改变
  • 提示/指令集的加法/消除/修改
  • 添加/去除字形
  • 设计缺陷修复
  • 更改以构建流程
  • 更新的构建依赖项

当MAJOR版本编号增加时， MINOR版本编号应更改为000的值。

例子

名称表ID 5记录

符合OpenFV规范的名称表ID 5记录版本的示例包括：

仅版本号

 Version 1.001

版本编号和开发状态标签

 Version 1.001; DEV
Version 1.001; RELEASE

版本编号和源代码状态标签

 Version 1.001; [abcd123]

版本号，源代码状态标签和开发状态标签

 Version 1.001; [abcd123]-dev
Version 1.001; [abcd123]-release

版本号，源代码状态标签，开发状态标签和其他元数据

 Version 1.001; [abcd123]-dev; here are metadata
Version 1.001; [abcd123]-release; here are metadata

版本编号和其他元数据

 Version 1.001; here are metadata
Version 1.001; here are metadata; here are more metadata

头桌fontrevision记录

符合OpenFV规范的Head Table Fontrevision记录版本的示例包括：

 1.001

 10.010

 100.100

执照

CC由4.0