openfv

Buka Spesifikasi Versi Font

Versi 0.3.0

Status: draft eksperimental dan tidak stabil

Daftar isi

• Pendahuluan dan Dasar Pemikiran
• Definisi
• Spesifikasi OpenFV
  • Name Table ID 5 Spesifikasi Catatan
  • Spesifikasi Catatan Head Table Fontrevision
  • Versi Nomor Semantik
• Contoh
  • Name Table ID 5 Contoh Rekam
  • Contoh Catatan Fontrevision Kepala
• Lisensi

Pendahuluan dan Dasar Pemikiran

String versi perangkat lunak biasanya mencakup semantik berikut:

• Kompatibilitas besar dan mundur dari kode sumber berubah relatif terhadap versi terakhir
• kesiapan kode sumber untuk rilis tingkat produksi untuk pengguna akhir
• status kode sumber saat membangun waktu

Pendekatan SEMVER yang mapan dan banyak digunakan untuk versi perangkat lunak semantik menggunakan format nomor versi MAJOR.MINOR.PATCH dengan standar berbasis API perangkat lunak untuk nilai bertambah selama proses pengembangan perangkat lunak. Metadata tambahan biasanya ditambahkan ke sintaks SEMVER ini untuk menunjukkan kesiapan perangkat lunak untuk penggunaan umum oleh pengguna akhir ketika pekerjaan berkembang menuju tonggak rilis (misalnya v1.2.0-alpha , v1.2.0-beta , v1.2.0-rc.1 , v1.2.0-rc.2 , v1.2.0 ). Proyek -proyek yang membuat artefak biner yang dikompilasi dari kode sumber sering mengaitkan label dengan artefak build untuk membuat catatan status kode sumber pada waktu pembuatan (misalnya, string hash git komit sha1).

Konsep -konsep versi ini berlaku untuk pengembangan perangkat lunak jenis huruf dan diinginkan selama proses pengembangan; Namun, mereka tidak semuanya didefinisikan di bawah spesifikasi versi font openType. String versi perangkat lunak jenis huruf dikompilasi ke dalam catatan 5Id 5 dari tabel nama OpenType dan catatan fontrevision dari tabel head OpenType. Catatan -catatan ini didefinisikan dalam spesifikasi format OpenType seperti di bawah ini, dan dijelaskan dalam Dokumentasi Praktik Terbaik Pengembangan Font SIL (Sumber).

OpenType Name Table ID 5 Definisi Catatan

String Versi. Harus mulai dengan 'versi' sintaks. (Kasus atas, huruf kecil, atau dicampur, dengan ruang antara "versi" dan angka).

String harus berisi nomor versi dari formulir berikut: satu atau lebih digit (0-9) nilai kurang dari 65.535, diikuti oleh suatu periode, diikuti oleh satu atau lebih angka nilai kurang dari 65.535. Karakter apa pun selain digit akan mengakhiri bilangan kecil. Karakter seperti ";" bermanfaat untuk memisahkan berbagai informasi versi.

Kecocokan pertama dalam string dapat digunakan oleh perangkat lunak instalasi untuk membandingkan versi font. Perhatikan bahwa beberapa penginstal mungkin memerlukan string untuk memulai dengan "Versi", diikuti dengan nomor versi seperti di atas.

(Sumber)

OpenType Head Table Fontrevision Record Definisi

Diatur oleh produsen font

(Sumber)

Spesifikasi OpenType mendefinisikan nomor versi sebagai MAJOR.MINOR . Tidak ada spesifikasi untuk nomor versi PATCH / BUILD atau nomor versi metadata string. Versi font menyimpang lebih lanjut dari format nomor versi semver sebagai hasil dari konvensi kompiler font untuk memasukkan nol padding dalam nomor versi MINOR . Meskipun ini tidak selalu terjadi dalam catatan 5Id 5, ini adalah format yang konsisten yang digunakan dalam catatan head.fontrevision. Interpretasi nomor versi dengan pendekatan ini tidak intuitif. Versi nomor string Version 1.1 , Version 1.01 , dan Version 1.001 semuanya didefinisikan sebagai "berbeda" meskipun angka -angka ini semuanya dapat mewakili tahap pengembangan yang sama (yaitu, satu iterasi di luar rilis besar pertama). Perbedaan -perbedaan dalam nomor versi ini muncul karena konvensi yang ditetapkan oleh penulis proyek dan oleh alat yang mereka gunakan untuk menyusun font dari kode sumbernya. Definisi OpenType tidak menentukan format untuk menunjukkan status pengembangan proyek jenis huruf relatif terhadap tonggak versinya, mereka juga tidak mendefinisikan pendekatan untuk mempertahankan informasi tentang status kode sumber pada waktu pembangunan dalam artefak build font. Kurangnya standar formal untuk mengatasi masalah di atas asalkan dorongan untuk spesifikasi ini.

Spesifikasi Open Font Version (OpenFV) mewakili ekstensi yang sesuai dari Tabel Nama OpenType NameID 5 Record dan OpenType head.fontrevision Record Spesifikasi. OpenFV dimaksudkan untuk berfungsi sebagai standar versi perangkat lunak typeface untuk pengembangan, pengujian, rilis, dan penggunaan kode sumber jenis huruf dan artefak build (font) yang berasal dari sumber. Spesifikasi ini mendefinisikan sintaks string nomor versi dengan dasar semantik yang memelihara data informatif untuk pengembang dan pengguna.

Definisi

• Build - File yang dikompilasi dari tipe jenis jenis huruf jenis artefak yang ditentukan oleh keadaan kode sumber pada waktu pembuatan (yaitu, file biner font)
• Pengembangan - Kode Sumber dan Kompilasi Status Artefak Build yang mencakup implementasi pekerjaan yang tidak lengkap untuk mencapai tonggak rilis
• Metadata - Data yang berada di luar definisi OpenFV dari string nomor versi
• Posisi Satu - Posisi Substring Pertama dari String Versi
• Posisi Dua - Posisi Substring Kedua dari String Versi
• Rilis - Kode Sumber dan Kompilasi Build Artefact State Tonggak yang dimaksudkan untuk penggunaan tingkat produksi oleh pengguna akhir
• Status - Indikator biner dari status pengembangan/rilis kode sumber
• Status - Indikator status kode sumber pada waktu pembangunan

Kata -kata kunci "harus", "tidak boleh", "diperlukan", "akan", "tidak boleh", "harus", "tidak boleh", "direkomendasikan", "mungkin", dan "opsional" dalam dokumen ini harus ditafsirkan seperti yang dijelaskan dalam RFC 2119.

Spesifikasi OpenFV

1. Nama Tabel ID 5 Rekam Versi String

A. Sintaks String Versi

Versi string dalam catatan nama OpenType ID 5 harus didefinisikan sebagai substring yang dibatasi titik koma dari elemen data wajib dan opsional.

Sintaks spesifikasi OpenFV untuk elemen substring dari string versi lengkap adalah:

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

String versi font harus termasuk:

• Substring Nomor Versi Font

String versi font mungkin termasuk:

• Status/State Metadata Substring
• Substring metadata lainnya

B. Substring Nomor Versi Font

Substring nomor versi font:

• Harus ditempatkan pada posisi substring satu.
• Harus didefinisikan sebagai kata "versi" yang dikapitalisasi, space glyph (U+0020), angka nomor MAJOR digit, periode (U+002E), digit nomor versi MINOR .
• Tidak boleh menyertakan metadata.
• Dapat menyertakan titik koma pada posisi karakter terakhirnya jika metadata mengikuti substring nomor versi font pada posisi substring dua. Karakter whitespace tidak boleh dimasukkan antara nomor versi MINOR dan titik koma.
• Tidak boleh termasuk titik koma jika tidak ada metadata mengikuti substring nomor versi.

Nomor versi MAJOR :

• Harus memiliki antara satu dan tiga digit dengan nilai minimum 0 dan nilai maksimum 999.

Nomor versi MINOR :

• Harus memiliki persis tiga digit. Untuk angka kurang dari 100, nol padding harus digunakan dalam nomor versi MINOR . Nomor versi MINOR harus memiliki nilai minimum 000 dan nilai maksimum 999.

C. Substring metadata negara

Substring metadata negara:

• Harus mendefinisikan status kode sumber pada waktu pembangunan font.
• adalah opsional.
• Harus ditempatkan pada posisi substring dua dari string versi font.
• Tidak boleh memasukkan karakter di luar set: a-zA-Z0-9._-
• Harus memasukkan pembatas [ sebagai karakter awal dan pembatas ] sebagai karakter akhir dari substring. Isi string di dalam pembatas ini harus didefinisikan sebagai "label negara". Label negara harus 50 karakter atau kurang.
• Dapat menyertakan substring status (lihat di bawah).

D. Status Metadata Substring

Status metadata substring:

• Harus menentukan status pengembangan/rilis kode sumber dan font yang dibangun sebagaimana didefinisikan dalam bagian definisi.
• adalah opsional.
• Harus ditempatkan pada posisi substring dua.
• Harus menggunakan salah satu dari format peka case-case berikut dengan nol atau satu karakter spasi sebelumnya untuk string versi yang tidak termasuk substring status:
  • DEV
  • RELEASE
• Harus menggunakan salah satu dari format peka case-case berikut tanpa karakter spasi sebelumnya untuk string versi yang mencakup substring status:
  • -dev
  • -release

e. Substring metadata lainnya

Substring metadata lainnya:

• adalah opsional.
• Dapat dimasukkan satu atau lebih kali dalam string versi font
• Harus mengikuti semua data nomor versi substring dan status substring status dengan pembatas titik koma diikuti oleh nol atau satu karakter ruang yang lebih dari satu sama lain metadata substring.
• Harus dibatasi hingga 50 karakter atau kurang.

2. HEAD TA bagian Tabel Fontrevision Record Version String

Nomor versi font dalam catatan fontrevision dari tabel kepala openType:

• Harus didefinisikan sebagai digit nomor versi MAJOR , periode, angka nomor versi MINOR
• Harus memiliki nomor versi utama yang panjangnya antara satu dan tiga digit dengan nilai minimum 0 dan nilai maksimum 999.
• Harus memiliki nomor versi MINOR yang panjangnya tiga digit. Untuk nomor versi MINOR kurang dari 100, nol padding harus digunakan. Nomor versi MINOR harus memiliki nilai minimum 000 dan nilai maksimum 999.
• Tidak boleh menyertakan karakter apa pun sebelum nomor versi MAJOR atau setelah nomor versi MINOR

3. Versi Nomor Semantik

• Nomor MAJOR.MINOR MAJOR.MINOR . MAJOR.MINOR Versi MAJOR.MINOR .
• Status sumber pengembangan harus dibedakan dari status sumber pelepasan melalui penggunaan substring metadata status sebagaimana didefinisikan dalam spesifikasi ini.
• Nomor versi MAJOR harus diatur ke 0 selama fase pengembangan pra-produksi sebelum rilis awal. Nomor versi MAJOR 0 harus menunjukkan fase perkembangan pra-produksi ini.
• Nomor versi MAJOR harus ditetapkan ke 1 pada saat rilis awal untuk pengguna akhir. Konversi dari nomor versi MAJOR 0 ke versi MAJOR nomor 1 harus menunjukkan pengakuan penulis bahwa kode sumber dan membangun artefak memenuhi definisi rilis OpenFV.
• Setelah menyelesaikan perubahan kode sumber untuk mencapai tonggak rilis, peningkatan nomor versi harus dilakukan segera sebelum membuat perubahan pada kode sumber yang dimaksudkan untuk tonggak rilis di masa depan.

Semantik untuk perubahan nomor versi harus mencakup kenaikan berdasarkan nilai 1 dari:

• Nomor Versi MAJOR untuk menyelesaikan tonggak utama proyek utama dan semua perubahan yang tidak kompatibel ke dalam perangkat lunak jenis huruf (misalnya, penghapusan dukungan untuk seluruh rentang kode unicode).
• Nomor Versi MINOR untuk Fungsionalitas, Persimpangan Hot, dan Perubahan Ketergantungan. Contohnya termasuk:
  • Perubahan Desain Glyph
  • Penambahan/Eliminasi/Modifikasi Set Petunjuk/Instruksi
  • Penambahan/Penghapusan Glyphs
  • Perbaikan cacat desain
  • Perubahan pada proses pembangunan
  • Dependensi Bangun yang Diperbarui

Ketika nomor versi MAJOR bertambah, nomor versi MINOR harus diubah menjadi nilai 000.

Contoh

Nama Tabel ID 5 Rekam

Contoh Name Table ID 5 String Versi Rekam Yang Memenuhi Spesifikasi OpenFV Termasuk:

Nomor versi saja

 Version 1.001

Nomor versi dan label status pengembangan

 Version 1.001; DEV
Version 1.001; RELEASE

Nomor versi dan label status kode sumber

 Version 1.001; [abcd123]

Nomor versi, label status kode sumber, dan label status pengembangan

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

Nomor versi, label status kode sumber, label status pengembangan, dan metadata lainnya

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

Nomor versi dan metadata lainnya

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

Catatan Fontrevision Meja Kepala

Contoh string versi rekaman fontrevision tabel head yang memenuhi spesifikasi OpenFV meliputi:

 1.001

 10.010

 100.100

Lisensi

CC oleh 4.0