forked from fontman/fontmanpkg-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfontpackage.toml
113 lines (96 loc) · 4.17 KB
/
fontpackage.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
[fontpackage]
########################################################################
# PACKAGE METADATA #####################################################
########################################################################
name = "My Font Family" #REQUIERD: Package name (same as the postscript family name)
type = "family" #REQUIERD: Package type [family, collection]
version = "" #REQUIERD: SemVer
status = "" #REQUIERD: [BETA, ALPHA, STABLE]
authors = ["", ""] #REQUIERD: Authors of the package
license = "" #REQUIERD: https://spdx.org/licenses/
copyright = "" #REQUIERD
category = "" #REQUIERD: #serif, sans, display, monospace, script, dingbat
license-file = "" #OPTIONAL: URL to licence file or EULA
description = "" #OPTIONAL
repository = { url = "", type = "git"} #REQUIERD
homepage_url = "" #OPTIONAL
issues_url = "" #OPTIONAL
funding_url = "" #OPTIONAL
date_published = "" #OPTIONAL: Date first published
fontlog = "" #OPTIONAL: Defults to ROOT (./FONTLOG.md ./FONTLOG.txt ./CHANGELOG.txt) Defult format Markdown .md
foundry = { name = "", email = "", url = "", vendor_id = "" } #OPTIONAL:
designers = [ #OPTIONAL: Desiners from the nameID
{ name = "", email = "", url = "" },
{ name = "", email = "", url = "" },
{ name = "", email = "", url = "" } ]
private = "" #REQUIERD: Boolean, When set to true, conforming
maintenance = { status = "", comment = "" } #OPTIONAL: # `actively-developed`, `passively-maintained`, `as-is`, `experimental`, `looking-for-maintainer`, `deprecated`, and the default `none`,}
versions_provider = "" #REQUIERD: How is the font versions provided. When set to 'tags' the versions will be fetched from the git tags.
tools = "" #OPTIONAL: Details realted to font development and build. Similar to tools key in UFR METADATA.yml
progress = [ #OPTIONAL: Progress and of the project out of 100 percentage.
{ design = "" },
{ family_styles = "" },
{ character_set = "" },
{ drawing_quality = "" },
{ spacing = ""},
{ kerning = ""},
{ hinting = "" },
{ opentype_features = "" }, ]
########################################################################
# DISPLAY AND CLASSIFCATION DATA #######################################
########################################################################
tags = [ #OPTIONAL: Pakage specific display strings for display and testing purposes
{ style = "" }, # Blackletter, Calligraphic, Condensed, Decorative, Display, Handdrawn, Monospaced, Rounded, Sans-serif, Script, Serif, Slab, Stencil, Symbols"
{ contrast = "" },
{ width = "" },
{ body_height = "" },
{ intended_useage = ""}, # large, medium, text, body, branding
{ figures = ""},
{ languages = "" },
{ related_fonts = "" }, ]
display_texts = [ #OPTIONAL: Pakage specific display strings for display and testing purposes
{ en_US = ""},
{ si_LK= ""},
{ dv_IN= ""}]
# Display images and promotional banners
display_images = [ #OPTIONAL Display images and promotional banners
{ banner = ""},
{ small= ""},
{ thumbnail= ""},
{ medium = ""},
{ small= ""},
{ large = ""} ]
links = [ #OPTIONAL: External links and release channels
{ font_in_use = "" },
{ googlefonts = "" },
{ fontlibrary_org = "" },
{ typekit = "" } ]
########################################################################
# FONT BINARIES AND METADATA ###########################################
########################################################################
[[fonts]]
name = "" #REQUIERD
path = "" #OPTIONAL DEFUALTS to ./fonts/otf .fonts
style = "" #REQUIERD
weight = "" #REQUIERD
full_name = "" #OPTIONAL
preview_image = "" #OPTIONAL
protected = "" #OPTIONAL
purpose = "" #OPTIONAL
variable_font = "" #OPTIONAL
format = "" #REQUIERD
free = "" #REQUIERD
[[fonts]]
# ...
########################################################################
# APP OR PLATFOROM SPECIFIC CONFIGS AND DATA ###########################
########################################################################
# Additional metadata
[fontpackage.extras]
# …
# Additional metadata to generate NPM packages
[fontpackage.npm]
# …
# Additional metadata to generate Appstram metadata files
[fontpackage.appstream]
# …