Add known/standard metadata keys to documentation #101
Closed
jphastings
started this conversation in
General
Replies: 3 comments
-
I hadn't spotted that this has been partially done with the cooklang rs extensions — it'd be great if this was referenced too! |
Beta Was this translation helpful? Give feedback.
0 replies
-
Relevant proposal for spec change #105. |
Beta Was this translation helpful? Give feedback.
0 replies
-
This is now part of the main specification, closing the discussion. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
It'd be great if the metadata section of the docs was expanded to list all the known/standard keys and their intended purpose & format.
Right now it's not clear if we should make our own if they're unlisted (eg.
servings
isn't mentioned there, but it appears to be considered standard from other pages in the docs).What I'm assuming the list would be so far:
source
https://example.org/recipe
,The Palomar Cookbook <urn:isbn:9781784720995>
time required
HhMm
format to avoid plurals and locales.45 minutes
,1 hour 30 minutes
,1h30m
servings
2
,15 cups worth
course
dinner
locale
es_VE
,en_GB
,fr
I'd love to have clarity on these as I'd like to know where I can put information in software I'm writing such that other cooklang tools can interpret it correctly.
For example, if I'm turning a recipe from a physical book into a cooklang recipe I'd like to be able to store the ISBN and the page number(s). I'd be tempted to put that like this, but I'd want to know that (a) the name of the source would be used and (b) the URN would be hidden (possibly linked to for clients that support ISBN URNs) (edit: it looks like this is assumed by the cooklang extensions, can I consider them standard?)
I'd like to propose the following keys too:
cook time
time required
field4 hours
,4h
prep time
time required
field15 minutes
,1h30m
I'm new here, but I'll be happy to make a PR if this makes sense.
Beta Was this translation helpful? Give feedback.
All reactions