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
Ambiguous description of 'ingredients', 'recipeInstructions' in Recipe#165
Comments
Good point, thanks. There was an initial bad idea to use a plural 's' on property names whenever a property was repeatable. We cleaned most of those a while back - http://www.w3.org/wiki/WebSchemas/Singularity - but this looks to have slipped through, perhaps due to mass nouns values like 'butter', 'sugar' making it not so obviously wrong as using 'actors' to refer to a single person. Perhaps "An ingredient used in the recipe." should become "An ingredient used in the recipe e.g. "sugar", "egg"? Then "Use repeated properties for each ingredient." |
This change was requested more than 2 years ago at http://www.w3.org/wiki/WebSchemas/Singularity#Follow_up_.28June_29th.2C_2012.29 as follow up but it was just never made. So yes, we're good to make that change here. |
It's maybe important also in definition to state that this is different from 'activeIngredient' used for drugs. Just to disambiguate. |
A slightly shorter version might be: “A single ingredient used in the recipe, for example sugar, flour or garlic.” At the risk of cluttering up the wrong bug, the same problem exists with recipeInstructions, the definition for which is currently “The steps to make the dish.” On the assumption that the property should be applied to a single instruction, suggest: “A step or instruction involved in making the recipe.” |
This is not fixed. I think we should rename the 'ingredients' property to be singluar according to my comment from http://www.w3.org/wiki/WebSchemas/Singularity#Follow_up_.28June_29th.2C_2012.29:
|
OK, re-opening. |
questions -
|
yes IMO
I think this one is fine. According to the examples of https://developers.google.com/structured-data/rich-snippets/recipes and http://schema.org/Recipe, the instructions are not meant to be a list of single instructions, but rather a single text value (with maybe an HTML list).
just fix the basics here. |
Ah, so you prefer the current "The steps to make the dish." for recipeInstructions, rather than proposed "A step or instruction involved in making the recipe."... |
It would be nice if recipeInstructions took an ItemList so one could mark up instructions separately and specify their order. |
Yes. It is also what Google and schema.org currently recommends and show in their examples. |
Dan, if you're referring to adding a Product or Thing type for the ingredients property, I like that idea. It would provide more structure to the recipe markup and disambiguate things a little more, in my opinion. |
Rather than just rename it to ingredient, can we make it 'recipeIngredient' so that it is less ambiguous? |
@rvguha partially less ambiguous... I have a recipe for natural dog food and another recipe for Playdoh...so perhaps instead humanFoodRecipeIngredient ;) |
So, can we all live with:
(with appropriate supersededBy assertions for the earlier (quite widely used) spellings.) |
+1 Can live with recipeIngredient and recipeInstructions |
@danbri |
Sigh. I can live with recipeingredient. But "ingredients" in english are almost always things that are in food - apart from recipes the term is used for the same thing in food labelling, and that is pretty much it. So we weren't IMHO saving ourselves from a real ambiguity, for once. It seems to me that recipe would be appropriate for playdough, dog food, perfume and soap. Would using it in those ways cause problems? |
@chaals note that @twamarc pointed out above the common other use of ingredients - for medicines and drugs. http://schema.org/Recipe has always been pretty oriented towards food recipes, even if the description is ... curt. The more extended use of Recipe you outline slides quickly into metaphor. At Google we have noticed that publishers do try to stretch Recipe to cover all kinds of other situations, hence https://developers.google.com/structured-data/rich-snippets/recipes "Recipe markup should be used for content about preparing a particular dish. For example, "facial scrub" or "party ideas" are not valid names for a dish", i.e. "Recipe for success!", howtos etc are out of scope. @LJWatson - yes I think that fits the newly updated distinction between recipeIngredient (which would be repeated for each single ingredient) vs recipeInstructions (which is all the instructions in a blob of text, or in a list that would be the single value of one recipeInstructions property). |
I dislike recipeInstruction and recipeIngredient. They both seem unwieldy, and I’m not sure how either will stop people trying to use Recipe for unintended purposes? |
@LJWatson it has already been "recipeInstructions" for several years. For the other property, @scor asked that "ingredients" become "ingredient" for the good reason you've also given re singular (essentially this job was overlooked a few years ago when we de-pluralized many other properties that ended in a final 's'). The change from "ingredient" to "recipeIngredient" comes as both @twamarc and @rvguha noted that this is one of several cases where a very general word is used to mean something very specific. Changing it won't stop people's behavior, but it is an alternative to @chaals suggestion that the scope of the recipe terms could be broadened (e.g. from food to include e.g. soap making) i.e. bringing it closer to its dictionary reading. It may not be the most elegant package but i think it is reasonable. We already do have recipeCategory, recipeYield, recipeCuisine, recipeInstructions. We will never achieve 100% internal stylistic consistency but I still think this change will be progress. |
Questions:
For example, I may be interested in capturing information about natural food items (e.g. an apple) and prepared food items (e.g. Ben & Jerry chocolate ice cream), independently of the recipes they may be involved in, if any. Specifically, an apple can exist without being part of a recipe, and I may want to describe its country of origin, scientific name, and nutrition facts. |
A distinction should be made between food items and ingredients. Ingredients can be captured for both a recipe and an item. It could be beneficial though to be able to link a recipe to a specific item in addition to ingredients for example "tabasco-original-red-sauce". This would support the use case of a recipe promoting a specific food item instead of hot sauce in general. |
Drugs are close enough to food items that I think trying to preserve the distinction is interesting to ontologists, but less so in the "real world", where people do want recipes for play-dough and soap - and most of those people also have recipes for bread and a medicinal herbal tea mix. |
@nicolastorzec @ekgs1 @danbri @chaals I opened a new issue https://github.com/schemaorg/schemaorg/issues/458 that addresses the need for a new Food type. |
Food/nutrition 'labels' are quite interesting and important. It would be guha On Tue, Apr 28, 2015 at 5:55 PM, Thad Guidry notifications@github.com
|
re Food/nutrition, GS1's external extension covered this in epic detail - http://blog.schema.org/2016/02/gs1-milestone-first-schemaorg-external.html (cheeseFirmness etc :) |
http://schema.org/ingredients
http://schema.org/recipeInstructions
The description of the "ingredients" property in the Recipe schema is "An ingredient used in the recipe".
The property name is plural and the description singular, which makes its scope ambiguous. Should the property be applied to a collection of ingredients, or to an individual ingredient, or doesn't it matter?
Suggest changing the description to provide greater clarity.
The text was updated successfully, but these errors were encountered: