openfv

Especificação de versão de fonte aberta

Versão 0.3.0

Status: rascunho experimental e instável

Índice

• Introdução e justificativa
• Definições
• Especificação OpenFV
  • Nome tabela ID 5 Record Specification
  • especificação de registro da tabela de cabeça Fontrevisão
  • Número da versão Semântica
• Exemplos
  • Nome tabela ID 5 Exemplos de registro
  • Exemplos de registro da tabela de cabeças da cabeça
• Licença

Introdução e justificativa

Strings de versão de software geralmente incluem a seguinte semântica:

• A magnitude e a compatibilidade com versões anteriores das mudanças no código -fonte em relação à última versão
• A prontidão do código -fonte para liberação no nível de produção para os usuários finais
• o estado do código -fonte no tempo de construção

A abordagem semver estabelecida e amplamente usada para o versão semântica de software usa o número de versão do número de versão MAJOR.MINOR.PATCH com um padrão baseado em API de software para valores incrementados durante o processo de desenvolvimento de software. Metadados adicionais são comumente anexados a esta sintaxe de Semver para indicar a prontidão do software para uso geral pelo usuário final, à medida que o trabalho avança em direção a um marco de liberação (por exemplo, v1.2.0-alpha , v1.2.0-beta , v1.2.0-rc.1 , v1.2.0-rc.2 , v1.2.0 ). Projetos que criam artefatos binários compilados do código -fonte frequentemente associam uma gravadora ao artefato de compilação para estabelecer um registro do estado do código -fonte no horário de construção (por exemplo, uma string de hash sha1 commit git).

Esses conceitos de versão se aplicam ao desenvolvimento do software do tipo de letra e são desejáveis durante o processo de desenvolvimento; No entanto, eles não são todos definidos sob a especificação de versão do OpenType Fonte. As seqüências de versão do software do tipo de letra são compiladas no registro NameId 5 da tabela de nome do opentype e no registro do Fontrevisão da tabela de cabeças do OpenType. Esses registros são definidos na especificação do formato OpenType, como abaixo, e explicados na documentação das práticas recomendadas (fonte) do SIL Font Development Best Practices (fonte).

Opensype Nome Tabela ID 5 Definição de registro

String de versão. Deve começar com a sintaxe 'versão'. (Case superior, minúscula, ou misto, com um espaço entre "versão" e o número).

A string deve conter um número de versão do seguinte formulário: um ou mais dígitos (0-9) de valor menor que 65.535, seguidos por um período, seguidos por um ou mais dígitos de valor menor que 65.535. Qualquer caractere que não seja um dígito encerrará o número menor. Um personagem como ";" é útil para separar diferentes informações da versão.

A primeira correspondência desse tipo na string pode ser usada pelo software de instalação para comparar versões de fontes. Observe que alguns instaladores podem exigir que a string inicie com "versão", seguida por um número de versão como acima.

(Fonte)

Opensype Head Table Fontrevision Record Definição

Definido pelo fabricante de fontes

(Fonte)

A especificação OpenType define um número de versão como MAJOR.MINOR . Não há especificação para um número de versão do PATCH / BUILD nem strings de metadados do número de versão. A versão de fonte se desvia mais do formato do número da versão semver como resultado da convenção do compilador de fontes para incluir o preenchimento zero em números de versão MINOR . Embora esse nem sempre seja o caso nos registros NameID 5, este é um formato consistente usado no registro da cabeça. A interpretação dos números de versão com essa abordagem não é intuitiva. A versão do número da versão Version 1.1 , Version 1.01 e Version 1.001 são definidas como "diferentes", embora esses números possam representar o mesmo estágio de desenvolvimento (ou seja, uma iteração além da primeira grande versão). Essas diferenças nos números de versão emergem devido a convenções estabelecidas pelo (s) autor (s) do projeto e pelas ferramentas que eles usam para compilar fontes de seu código -fonte. As definições do OpenType não especificam um formato para indicar o status de desenvolvimento de um projeto de tipo de letra em relação ao seu marco de versão, nem definem uma abordagem para manter informações sobre o estado do código -fonte no horário de construção no artefato de construção da fonte. A falta de um padrão formal para abordar os problemas acima forneceu o ímpeto para esta especificação.

A especificação da versão aberta da fonte (OpenFV) representa uma extensão compatível da tabela de nome OpenType NameId 5 Register e OpenType Head.Fontrevision Registro Especificações. O OpenFV destina -se a servir como um padrão de versão do software de letra para o desenvolvimento, teste, liberação e uso do código -fonte do tipo de letra e os artefatos de construção (fontes) derivados da fonte. Esta especificação define uma sintaxe de string de número de versão com fundamentos semânticos que mantêm dados informativos para desenvolvedores e usuários.

Definições

• Build - Um arquivo compilado de qualquer tipo de artefato de compilação do tipo de letra que seja definido pelo estado do código -fonte no horário de construção (ou seja, um arquivo binário de fonte)
• Desenvolvimento - Código -fonte e Estado de artefato compilado que inclui implementação incompleta de trabalho para obter um marco de liberação
• Metadados - dados que ficam fora da definição do OpenFV da string de número de versão
• Posição um - a primeira posição de substring de uma string de versão
• Posição dois - a segunda posição de substring de uma string de versão
• Liberação - código -fonte e construção de arte de construção compilada Milestone destinado ao uso do nível de produção pelo usuário final
• Status - um indicador binário do status de desenvolvimento/liberação do código -fonte
• Estado - um indicador do estado do código -fonte no momento da construção

As palavras -chave "devem", "não devem", "necessárias", "devem", "não", "deve", "não deve", "recomendado", "pode" e "opcional" neste documento devem ser interpretadas conforme descrito na RFC 2119.

Especificação OpenFV

1. Nome tabela Id 5 Record versão string

um. Versão string sintaxe

As cadeias de versões no nome da tabela de nome do opentype 5 registram devem ser definidas como substâncias delimitadas de semicolon de elementos de dados obrigatórios e opcionais.

A sintaxe da especificação OpenFV para os elementos da substring da string de versão completa é:

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

A string da versão da fonte deve incluir:

• A substring número da versão da fonte

A string de versão da fonte pode incluir:

• Substring de status/metadados do estado
• Outras substringas de metadados

b. Substring de número da versão da fonte

A substring número da versão da fonte:

• Deve estar localizado na posição de substring um.
• Deve ser definido como a palavra capitalizada "versão", um glifo espacial (U+0020), dígitos do número MAJOR da versão, um período (U+002E), dígitos do número de versão MINOR .
• Não deve incluir metadados.
• Pode incluir um ponto de vírgula na posição final do caractere se os metadados seguirem a substring número da versão da fonte na posição de substring dois. Os caracteres de espaço em branco não devem ser incluídos entre o número da versão MINOR e o semicolon.
• Não deve incluir um semicolon se não houver metadados seguindo a substring número da versão.

O número da versão MAJOR :

• Deve ter entre um e três dígitos com um valor mínimo de 0 e um valor máximo de 999.

O número da versão MINOR :

• Deve ter exatamente três dígitos. Para números inferiores a 100, o preenchimento zero deve ser usado no número da versão MINOR . O número da versão MINOR deve ter um valor mínimo de 000 e um valor máximo de 999.

c. Substring de metadados do estado

A substring dos metadados do estado:

• Deve definir o estado do código -fonte no tempo de construção da fonte.
• é opcional.
• Deve estar localizado na posição da substring, dois da string da versão da fonte.
• Não deve incluir caracteres fora do conjunto: a-zA-Z0-9._-
• Deve incluir o delimitador [ como caractere inicial e o delimitador ] como o caractere final da substring. O conteúdo da string dentro desses delimitadores deve ser definido como o "rótulo do estado". O rótulo do estado deve ter 50 caracteres ou menos.
• Pode incluir uma substring de status (veja abaixo).

d. Substring de metadados de status

A substring dos metadados de status:

• Deve definir o status de desenvolvimento/liberação binário do código -fonte e da fonte construídos conforme definido na seção Definições.
• é opcional.
• Deve estar localizado na posição dois da substring.
• Deve usar um dos seguintes formatos sensíveis à caixa com zero ou um personagem de espaço anterior para seqüências de versões que não incluem uma substring de estado:
  • DEV
  • RELEASE
• Deve usar um dos seguintes formatos sensíveis ao caso sem caracteres espaciais precedentes para strings de versão que incluem uma substring estatal:
  • -dev
  • -release

e. Outras substringas de metadados

Outras substringas de metadados:

• são opcionais.
• Pode ser incluído uma ou mais vezes na string de versão da fonte
• Deve seguir todos os dados de substring do número de versão e substring de estado/status com um delimitador de vírgula seguido de zero ou um caractere de espaço que precedeu a substring de metadados.
• Deve ser limitado a 50 caracteres ou menos.

2. String de versão do registro da mesa de cabeça Fontrevisão

O número da versão da fonte no registro do Fontrevisão da tabela de cabeças do OpenType:

• Deve ser definido como dígitos do número MAJOR da versão, um período, um período MINOR de dígitos do número de versão
• Deve ter um número de versão principal entre um e três dígitos de comprimento com um valor mínimo de 0 e um valor máximo de 999.
• Deve ter um número de versão MINOR com exatamente três dígitos de comprimento. Para números de versão MINOR menor que 100, o preenchimento zero deve ser usado. O número da versão MINOR deve ter um valor mínimo de 000 e um valor máximo de 999.
• Não deve incluir caracteres antes do número da versão MAJOR nem após o número da versão MINOR

3. Semântica do número da versão

• O número MAJOR.MINOR versão MAJOR.MINOR . O número da versão MAJOR.MINOR não deve ser destinado a representar o estado de código -fonte no horário de construção nos artefatos de construção e pode não ser único nos artefatos de construção, pois o trabalho é realizado para alcançar uma das MAJOR.MINOR versões.
• O status da fonte de desenvolvimento deve ser distinguido do status da fonte de liberação através do uso de uma substring de metadados de status, conforme definido nesta especificação.
• O número da versão MAJOR deve ser definido como 0 durante a fase de desenvolvimento de pré-produção antes da liberação inicial. A versão MAJOR 0 deve indicar esta fase de desenvolvimento de pré-produção.
• O número da versão MAJOR deve ser definido como 1 no momento da versão inicial para os usuários finais. A conversão da versão MAJOR número 0 para a versão MAJOR número 1 deve indicar o reconhecimento dos autores de que o código -fonte e a criação de artefatos atendem à definição de liberação do OpenFV.
• Após a conclusão das alterações do código -fonte para obter um marco de liberação, um incremento de número de versão deve ser executado imediatamente antes de fazer alterações no código -fonte que se destinam a um marco futuro de liberação.

A semântica para alterações no número da versão deve incluir um incremento pelo valor de 1 do:

• Número MAJOR da versão para a conclusão dos principais marcos específicos do projeto e todas as alterações incompatíveis atrasadas feitas no software do tipo de letra (por exemplo, a eliminação do suporte para todo um intervalo de código Unicode).
• Número da versão MINOR para alterações de funcionalidade, hotfix e dependência. Exemplos incluem:
  • Alterações de design de glifos
  • adição/eliminação/modificação de conjuntos de sugestões/instruções
  • Adição/remoção de glifos
  • Correções de falhas de design
  • Alterações para construir processos
  • dependências de construção atualizadas

Quando o número MAJOR da versão for incrementado, o número da versão MINOR deve ser alterado para um valor de 000.

Exemplos

Nome tabela ID 5 Registro

Exemplos de nome ID da tabela 5 Strings de versão de gravação que atendem à especificação OpenFV incluem:

Apenas a versão número

 Version 1.001

Número da versão e rótulo de status de desenvolvimento

 Version 1.001; DEV
Version 1.001; RELEASE

Número da versão e etiqueta de estado do código -fonte

 Version 1.001; [abcd123]

Número da versão, rótulo do estado -fonte e rótulo de status de desenvolvimento

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

Número da versão, etiqueta do estado -fonte, rótulo de status de desenvolvimento e outros metadados

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

Número da versão e outros metadados

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

Mesa principal registro de Fontrevição

Exemplos de seqüências de versão do registro da tabela de cabeça Fontrevisão que atendem à especificação OpenFV incluem:

 1.001

 10.010

 100.100

Licença

CC por 4.0