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