Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify file name of metadata file #273

Open
jeanas opened this issue Apr 21, 2023 · 3 comments
Open

Clarify file name of metadata file #273

jeanas opened this issue Apr 21, 2023 · 3 comments
Assignees
Milestone

Comments

@jeanas
Copy link

jeanas commented Apr 21, 2023

https://w3c.github.io/smufl/latest/specification/font-specific-metadata.html doesn’t say how it should be called. Is this arbitrary? Is there a recommendation?

@dspreadbury dspreadbury self-assigned this Apr 21, 2023
@dspreadbury dspreadbury added this to the SMuFL 1.5 milestone Apr 21, 2023
@dspreadbury
Copy link
Contributor

We should certainly clarify this. I think the convention that has come about is using the name of the font, e.g. "Bravura.json" or "Golden Age.json".

@jeanas
Copy link
Author

jeanas commented Apr 21, 2023

Hm, actually https://w3c.github.io/smufl/latest/specification/font-metadata-locations.html gives this recommendation (unless I'm misunderstanding it?), but it's only explicit for metadata installed on the system.

@mnquintana
Copy link

FWIW I think it'd be worth standardizing a name and relative location (ie. at the root of the repo / download artifact) for the metadata file instead of letting each font pick their own, mostly because having a consistent convention would make it much more feasible to build tooling around Smufl without too much ceremony (sort of analogous to package.json in JavaScript land). As of now, without a consistent file name as a convention, tooling would either have to guess (e.g. just pick the first JSON file at the root of the repo and hope for the best), or force users to specify their font's metadata file via a CLI arg or some other config.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants