plus/oppskrift
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Recipe spec almost done

Browse Source
This commit is contained in:
Djyp 2019-03-05 08:42:35 +01:00
parent 218459a41a
commit 90a438f760
1 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/Models.md
View File

@ -46,7 +46,7 @@ A single ingredient used in the recipe, e.g. sugar, flour or garlic.
### recipeInstructions ### recipeInstructions
`String[]` `String[]`
A step in making the recipe, in the form of a single item (document, video, etc.) or an ordered list with HowToStep and/or HowToSection items. A step in making the recipe, in the form of a single item (document, video, etc.) or an ordered list with HowToStep and/or HowToSection items.
The number of the step should never be the text. The number of the step should never be the text.
### recipeYield ### recipeYield
@ -55,7 +55,7 @@ The quantity produced by the recipe (for example, number of people served, numbe
### suitableForDiet ### suitableForDiet
`Array` of selected keywords (DiabeticDiet, GlutenFreeDiet, HalalDiet, HinduDiet, KosherDiet, LowCalorieDiet, LowFatDiet, LowLactoseDiet, LowSaltDiet, VeganDiet, VegetarianDiet) `Array` of selected keywords (DiabeticDiet, GlutenFreeDiet, HalalDiet, HinduDiet, KosherDiet, LowCalorieDiet, LowFatDiet, LowLactoseDiet, LowSaltDiet, VeganDiet, VegetarianDiet)
Indicates a dietary restriction or guideline for which this recipe or menu item is suitable, e.g. diabetic, halal etc. Indicates a dietary restriction or guideline for which this recipe or menu item is suitable, e.g. diabetic, halal etc.
TODO : Decide the best way to store the list... maybe in the model TODO : Decide the best way to store the list... maybe in the model
--- ---
@ -79,39 +79,48 @@ TODO : define a comment
A property to be shown in microdata/json-ld but in the model A property to be shown in microdata/json-ld but in the model
### contributor ### contributor
If anyone contribute to the recipe they should appear here as a list of users Maybe add this later. One of the future features is to let someone edit his own version of a recipe. The original author can know about it, accept the changes and add the contributor to the list. But maybe it's too much...
### dateModified ### dateModified-
`DateTime`
The most recent modification date The most recent modification date
### datePublished ### datePublished
`DateTime`
The date the first time the recipe appeared online The date the first time the recipe appeared online
### dicussionUrl ? ### dicussionUrl
PROBABLY NOT schema.org value for microdata & JSON-LD linking to the comments section of the recipe
### licence ### licence
`String`
URL of the licence used for the recipe or a string such as "Public domain"
### text ? ### thumbnailUrl
schema.org value for microdata & JSON-LD linking to the thumbnail image of the recipe
### thumbnailUrl ? ### version
Unless there is a versioning system for the recipe there's no point to this
### version ?
### description ### description
`Text`
### identifier ? The context of the recipe : history, source, ideas to serve it, personal notes, etc..
### image ### image
`String (255)`
URL of the image
### mainEntityOfPage ? ### mainEntityOfPage ?
### name ### name
`String (255)`
The name of the recipe The name of the recipe
### url ? ### url
schema.org value for microdata & JSON-LD linking to the url of the recipe, given by the framework's router
### likesCount ### likesCount
`Integer`
Calculated from the likes in the database Calculated from the likes in the database
### difficulty ### difficulty