recipe-brainstorming

(Difference between revisions)

Jump to: navigation, search
(Additional Suggestions)
Current revision (04:57, 4 April 2010) (view source)
(Promoting hRecipe for use in Recipe Search Indexing)
 
(178 intermediate revisions not shown.)
Line 1: Line 1:
-
= recipe brainstorming =
+
Towards a [[recipe|Recipe]] microformat.  Please read the [[process]] before editing this page.
-
This page is currently a rough draft formed after surveying the [[recipe-examples]] and other related formats such as RecipeML and existing microformats.
 
-
'''This page is currently premature, as there first needs to be a [[recipe-formats]] page where pre-existing recipe formats are documented (e.g. RecipeML).'''
 
-
*Not according to "[[process|the process]]". [[User:AndyMabbett|Andy Mabbett]] 07:11, 17 Nov 2006 (PST)
 
-
==Suggested fields for inclusion==
+
<div id="Format-In-Progress">
 +
==format-in-progress - #1 - september 2007==
 +
</div>
 +
 
 +
For the sake of clarity the format-in-progress from september 2007 was moved to  [[recipe-brainstorming-archive]]. [[User:ThomasLoertsch|ThomasLoertsch]] 14:12, 11. Nov 2008 (CET)
 +
 
 +
<div id="Format-In-Progress-10-2008">
 +
==format-in-progress - #2 - october 2008==
 +
</div>
 +
 
 +
Also the format-in-progress from october  2008 has been moved to  [[recipe-brainstorming-archive]]. --[[User:ThomasLoertsch|ThomasLoertsch]] 12:49, 9 July 2009 (UTC)
 +
 
 +
==brainstorming==
 +
===RecipeML-based Brainstorm===
 +
'''NOTE: Brainstorms should be based on implied schema of examples, not on explicit schema of other formats.  The only exceptions where this appears to have been ok (perhaps I got lucky) was with hCard (based on vCard) and hCalendar (based on iCalendar), but even in those cases, experience has shown that there are several properties in each that in practice have not shown much if any use, therefore indicating that the microformats were/are bigger than they need(ed) to be.''' [[User:Tantek|Tantek]] 23:19, 27 December 2008 (UTC)
 +
 
Excerpted from [http://conoroneill.com/2006/03/21/what-if-i-suggest-a-structured-recipe-format-and-you-critique-it/ Conor Bandon's Blog entry] and derived from The RecipeML Spec:
Excerpted from [http://conoroneill.com/2006/03/21/what-if-i-suggest-a-structured-recipe-format-and-you-critique-it/ Conor Bandon's Blog entry] and derived from The RecipeML Spec:
*Recipe_Title
*Recipe_Title
Line 13: Line 25:
*Ingredients (each one a separate "item" rather than block text with count/amount/range/unit broken out too)
*Ingredients (each one a separate "item" rather than block text with count/amount/range/unit broken out too)
**Some (e.g. meats, vegetables) could optionally be marked up with (elements of) the proposed [[species]] microformat. [[User:AndyMabbett|Andy Mabbett]] 06:41, 16 Nov 2006 (PST)
**Some (e.g. meats, vegetables) could optionally be marked up with (elements of) the proposed [[species]] microformat. [[User:AndyMabbett|Andy Mabbett]] 06:41, 16 Nov 2006 (PST)
 +
*** None of the [[recipe-examples]] show references to species names, therefore there is no empirical justification for inclusion of such detail in the microformat. [[User:Tantek|Tantek]] 23:19, 27 December 2008 (UTC)
 +
**** The vast majority of recipes reference a species of plant or animal (e.g. "chicken", "carrot"). Binomial/trinomial names are pretty much never seen of course, but the current species proposal allows for vernacular (common) names to be marked up, so it is not an especially odd suggestion to define a pattern for marking up species within ingredients. [[User:TobyInk|TobyInk]] 20:11, 29 December 2008 (UTC)
** Ingredient importance (e.g. Main, Required, Optional) should be listed as an attribute of each entry. [[User:AlexanderShusta|α]]
** Ingredient importance (e.g. Main, Required, Optional) should be listed as an attribute of each entry. [[User:AlexanderShusta|α]]
**Units need separate microformat: see [[measure]]  
**Units need separate microformat: see [[measure]]  
Line 33: Line 47:
***Should be an ordered list [[User:AndyMabbett|Andy Mabbett]] 14:46, 16 Nov 2006 (PST)
***Should be an ordered list [[User:AndyMabbett|Andy Mabbett]] 14:46, 16 Nov 2006 (PST)
***Another vote for an ordered list, perhaps in the [[XOXO]] format. [[User:AlexanderShusta|α]]
***Another vote for an ordered list, perhaps in the [[XOXO]] format. [[User:AlexanderShusta|α]]
 +
***Many recipes associate ingredients with specific steps of a multi-step method; if methods are broken out into steps, then the format should support this association whether the complete ingredient list is up front or the ingredient list is itself broken out per step. [[User:Quixote|Ben Curtis]]
*Photo (optional) [[User:IamCam|Cameron Perry]]
*Photo (optional) [[User:IamCam|Cameron Perry]]
**Could be one per dish, or one for each (or for some of the) step(s). [[User:AndyMabbett|Andy Mabbett]]
**Could be one per dish, or one for each (or for some of the) step(s). [[User:AndyMabbett|Andy Mabbett]]
-
== Additional Suggestions ==
+
===Cookcamp brainstorming===
 +
At [http://barcamp.org/CookCamp CookCamp] in February 2007, Tantek moderated a fairly free form discussion of how to publish/share recipes.  Here is a [http://flickr.com/photos/tantek/422072573/ photo of the whiteboard]:
 +
[http://flickr.com/photos/tantek/422072573/ http://farm1.static.flickr.com/162/422072573_9956d93f61.jpg]
 +
'''To Do''': OCR this and enter rough notes here...
 +
 +
===Additional Suggestions===
 +
*Steps - As cited above but to include estimated time per step.  Include the type of step (prep, preheat, cook, bake, mix, saute, etc) as well as the ingredients involved.  This would be very useful when trying to time a meal so all the food appears together.
 +
**I think this is being to specific. Are there any real world examples where this would be useful? --[[User:Yde|Yde]] 08:41, 30 May 2008 (PDT)
*Difficulty/Notes - Perhaps incorporation of [[hreview|hReview]] to describe difficulty (using rating) and general comments (review), as an optional field. [[User:Phae|Frances Berriman]]
*Difficulty/Notes - Perhaps incorporation of [[hreview|hReview]] to describe difficulty (using rating) and general comments (review), as an optional field. [[User:Phae|Frances Berriman]]
 +
** -1.  Too diverse in the wild, better handled bytags (at least in the first version). same for suitablility.
*Suitability (e.g. vegetarian, vegan, wheat-free, etc.). Possibly [[rel-tag]]. [[User:AndyMabbett|Andy Mabbett]] 14:57, 16 Nov 2006 (PST)
*Suitability (e.g. vegetarian, vegan, wheat-free, etc.). Possibly [[rel-tag]]. [[User:AndyMabbett|Andy Mabbett]] 14:57, 16 Nov 2006 (PST)
*Ingredient Grouping - In baking you need to differentiate wet from dry ingredients.  See also an [[recipe-examples|example recipe]] from [http://www.extratasty.com/recipe/46/cuba_libre extratasty.com] for useful grouping in cocktail mixing. [[SteveL|Steve Lewis]] 19:10, 11 Feb 2007
*Ingredient Grouping - In baking you need to differentiate wet from dry ingredients.  See also an [[recipe-examples|example recipe]] from [http://www.extratasty.com/recipe/46/cuba_libre extratasty.com] for useful grouping in cocktail mixing. [[SteveL|Steve Lewis]] 19:10, 11 Feb 2007
 +
** Maybe this ingredient grouping can be used to express some alternative ingredients, like "mayonnaise or cream cheese". [[EstevaoSamuel|Estêvão Samuel Procópio]] 15:33, 16 Dez 2007 (PDT)
 +
** This could be solved by using a xoxo list and ignoring list items that don't include a class="name". Example:<pre><nowiki>
 +
<ul class="ingredients">
 +
  <li>Booze
 +
    <ul>
 +
      <li>1 part <span class="name">Rum</span></li>
 +
    </ul>
 +
  </li>
 +
  <li>Mixer
 +
    <li>1 part <span class="name">Cola</span></li>
 +
    <li>1 part <span class="name">Lime juice</span></li>
 +
  </li>
 +
</ul></nowiki></pre> --[[User:Yde|Yde]] 13:09, 18 Apr 2008 (PDT)
 +
**We can't have a dependency on XOXO or any list mark-up for ingredients. That's too restrictive on publishing patterns, preventing patterns like: <pre><nowiki>
 +
<p class="method">Take <span class="ingredient"><span class="quantity">a handful</span>
 +
of  spinach</span> and fry it</p></nowiki></pre> --[[User:BenWard|BenWard]] 13:20, 18 Apr 2008 (PDT)
 +
**You're right. I think grouping would introduce too many new elements (class="group", class="group-title") considering how relatively uncommon this is. --[[User:Yde|Yde]] 13:51, 23 Apr 2008 (PDT)
-
==Issues==
+
*Method > Steps - or Method-Step[] as a child of Method. Imply ordered steps from an HTML list or explicitly mark-up ordered steps respectively.
-
===Scope===
+
** -1. Outside 80/20. POSH is good enough for this purpose. --[[User:ThomasLoertsch|ThomasLoertsch]] 15:04, 01 Oct 2008 (CET)
-
*Is this intended for only food recipes, or also recipes for, say, glue, paint, dyes and other chemicals? [[User:AndyMabbett|Andy Mabbett]] 14:53, 16 Nov 2006 (PST)
+
* Number of dishes or similar - often it's mentioned how many dishes (or breads in baking, etc) the ingredients are for. [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
-
** +1 Wondered the same. I'd like to see this extended as a general recipe for anything that can be created in a defined way/order, rather than just edible food.[[User:Phae|Frances Berriman]]
+
* Suitable for occasions - what occasions are the dish suitable for? [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
-
** Agreed. This format could apply to a set of methods and materials, including cooking, science experiments, craft making, building, etc. - essentially any how-to or tutorial. [[User:IamCam|Cameron Perry]]
+
* Category - many sites categorize their recipes. [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
-
** However, now I view my addition of 'calories per serving' as suspect, ;) though I guess it could still apply, since it's just a unit of energy. [[User:JohnLeMasney|John LeMasney]]
+
** Tags could be used for both suitability and category.
-
***Recipe for Nitroglycerine (not recommended by Weight Watchers) ? [[User:AndyMabbett|Andy Mabbett]] 10:43, 1 Feb 2007 (PST)
+
-
== See Also ==
+
*Under what terms is the recipe licensed? Microformat: rel="license". Often a page is in the creative commons but the page author has taken some text from a copyrighted page and in theory re-published the work in violation to the terms of use, adding a rel="license" to each recipe on the page? [[User:Lee Jordan|Lee Jordan]] 20:55, 04 Feb 2008 (GMT)
 +
*Single foodstuffs - If "method" is made optional, this could be used for marking up individual foodstuffs in prose. for example, "I like to eat cheese for supper." would become:
 +
<pre><nowiki>
 +
I like to eat <span class="hRecipe"><span class="ingredient">cheese</span></span> for supper.
 +
</nowiki></pre>
 +
or simply (if the proposed "[http://microformats.org/discuss/mail/microformats-discuss/2008-January/011199.html sub-microformat-pattern]" is adopted):
 +
<pre><nowiki>
 +
I like to eat <span class="hRecipe-ingredient">cheese</span> for supper.
 +
</nowiki></pre>
 +
: [[User:AndyMabbett|Andy Mabbett]] 08:16, 5 Jan 2008 (PST)
 +
**But that's not really a recipe, is it? And what would the purpose of knowing that cheese is an ingredient be? --[[User:Yde|Yde]] 12:46, 18 Apr 2008 (PDT)
 +
** -1. Makes no sense to me either --[[User:ThomasLoertsch|ThomasLoertsch]] 15:29, 01 Oct 2008 (CET)
 +
 +
*Menus - With the addition of a "price" field, and perhaps one or two others, and again making "method" optional, this microformat can also be used for menus. See [[recipe-examples#Menus|menu examples]]. [[User:AndyMabbett|Andy Mabbett]] 02:39, 19 Feb 2008 (PST)
 +
**I would consider this out of scope (which is to produce an as-simple-as-possible microformat "for the mark-up of instructions for creating meals, drinks or food-based items" - [[recipe-brainstorming#Introduction | introduction]]) --[[User:Yde|Yde]] 13:39, 23 Apr 2008 (PDT)
 +
 +
===Quantity===
 +
There are a lot of units typically used in recipes that do not make much sense in most other cases and therefor most likely will never make it into a 80/20-aware measure-microformat. This is a deliberatly short list:
 +
* cup
 +
* leave
 +
* pinch
 +
* tablespoonful
 +
* teaspoonful
 +
* lacing
 +
* tie (??? my english is really leaving me here, hope you get the idea)
 +
<code>note</code> can be used to indicate more subtle differentiation (like a "big spoonful", "some leaves" etc). I think this list is both usefully short and complete. The following measures:
 +
* weight (gram)
 +
* volume (litre)
 +
* length (metre)
 +
can be taken from the measure microformat. I guess measure is already stable enough that it's save to use these terms "experimentally". The measure-element should be optional. That way nobody is forced to select a value from it - it's just a help to facilitate interoperability. --[[User:ThomasLoertsch|ThomasLoertsch]] 15:45, 01 Oct 2008 (CET)
 +
 +
=== Proposed Optimisations ===
 +
 +
====Item====
 +
Can we have this optimisation?... if no "item" is found, the entire ingredient is taken to be the item. [[User:TobyInk|TobyInk]]
 +
 +
Example:
 +
<pre><nowiki><span class="ingredient">salt</span></nowiki></pre>
 +
is a shorthand for:
 +
<pre><nowiki><span class="ingredient"><span class="item">salt</span></span></nowiki></pre>
 +
* +1. That and the Proposed Ingredient List Optimisation seem to be very pragmatic proposals. --[[User:Yde|Yde]] 14:40, 14 Jul 2008 (PDT)
 +
* -1. I'm not convinced that it's wise to introduce variations in the syntax for the singlemost important element (beside the title). Also the case seems very rare to me. Can you give some examples? --[[User:ThomasLoertsch|ThomasLoertsch]] 15:07, 01 Oct 2008 (CET)
 +
 +
====Ingredient List====
 +
 +
[[User:TobyInk|TobyInk]] 03:42, 23 Mar 2008 (PDT):
 +
 +
If class="ingredients" (note: plural) is found on an element, class="ingredient" (note: singular) is automatically implied on all its children.
 +
 +
<pre><nowiki><ul class="ingredients">
 +
<li><span class="quantity">3</span> <span class="item">eggs</span></li>
 +
<li><span class="quantity">6 oz</span> <span class="item">self-raising flour</span></li>
 +
<li><span class="quantity">6 oz</span> <span class="item">caster sugar</span></li>
 +
<li><span class="quantity">6 oz</span> <span class="item">butter</span></li>
 +
<li><span class="quantity">1 tsp</span> <span class="item">vanilla essence</span></li>
 +
</ul></nowiki></pre>
 +
 +
is a shorthand for:
 +
 +
<pre><nowiki><ul class="ingredients">
 +
<li class="ingredient"><span class="quantity">3</span> <span class="item">eggs</span></li>
 +
<li class="ingredient"><span class="quantity">6 oz</span> <span class="item">self-raising flour</span></li>
 +
<li class="ingredient"><span class="quantity">6 oz</span> <span class="item">caster sugar</span></li>
 +
<li class="ingredient"><span class="quantity">6 oz</span> <span class="item">butter</span></li>
 +
<li class="ingredient"><span class="quantity">1 tsp</span> <span class="item">vanilla essence</span></li>
 +
</ul></nowiki></pre>
 +
 +
* I agree. This would save a lot of space, especially combined with the proposed hmeasure [http://microformats.org/wiki/measure#hmeasure minimisation technique]. --[[User:Yde|Yde]] 12:57, 18 Apr 2008 (PDT)
 +
* Do we have <code>ingredients</code> (plural) as an element? Doesn't that open a whole can of list-issues? --[[User:ThomasLoertsch|ThomasLoertsch]] 15:37, 01 Oct 2008 (CET)
 +
 +
=== Promoting hRecipe for use in Recipe Search Indexing ===
 +
My company has an interest in the establishment and adoption of a recipe-based microformat in support of our goal to index recipe content for search.
 +
 +
We would like to promote a few [http://microformats.org/wiki/posh POSH] extensions to hRecipe that we think will be useful to the recipe-publishing community in support of our shared intention to promote hRecipe's adoption as a standard.
 +
 +
I have outlined these extensions (and our rationale) below and would like to ask the community for comment in advance of any publication. After comment, we will host a public page outlining the extensions which will refer to microformats.org as the authoritative source for hRecipe.
 +
 +
(My intent is also to share whatever data we collect on the adoption of hRecipe in the sites we index, which will include smaller blogger sites where we expect hRecipe will initially be most prevalent.)
 +
 +
--[[User:DaveCorboy|DaveCorboy]] 03:43, 22 March 2010 (UTC)
 +
 +
* We have now published the page I reference above [http://www.ziplist.com/recipe_microformat here]. --[[User:DaveCorboy|DaveCorboy]] 04:57, 4 April 2010 (UTC)
 +
 +
==== Proposed Extensions ====
 +
===== comment =====
 +
* An inline comment for an ingredient within the recipe.
 +
* Optional. Text. Limited to one '''comment''' per ingredient.
 +
* ''Rationale: We have seen a number of examples in the wild of comments mixed in with ingredients. '''comment''' allows the expression of a standard ingredient list while also allowing for prose-style lists and additional commentary (e.g., substitutions) related to specific ingredients.''
 +
Example
 +
<pre><nowiki>
 +
<ul>
 +
  <li class="ingredient">1 cup of walnuts or pecans
 +
    <span class="comment">
 +
      (Though I usually prefer pecans in most recipes, I like walnuts best in this.)
 +
    </span>
 +
  </li>
 +
</ul>
 +
</nowiki></pre>
 +
 +
===== step =====
 +
* The steps necessary to prepare the recipe.
 +
* Optional. Text. No limit to the total number of '''step'''s per recipe. Use of step properties within an instructions block are optional, but recommended.
 +
* ''Rationale: The [http://www.cookingforengineers.com/recipe/33/Lemon-Bars Cooking for Engineers] website is an excellent real-world example of the many alternative recipe writing styles described in [http://www.anthus.com/Recipes/CompCook.html this paper]. hRecipe has reasonably [http://microformats.org/wiki/recipe-issues#closed_issues closed this as an immediate need], however we wish to try to accommodate this sort of prose-style recipes that do not have an explicit collection of steps.''
 +
Example
 +
<pre><nowiki>
 +
<div class="instructions">
 +
  <p>So before we get to the recipe, let me tell you a story about cranberries...</p>
 +
  <p>
 +
    Now, let's get to cooking! First, you will need to <span class="step">coarsely grind the cranberries. Fill your blender 2/3 full...</span>
 +
    After you have done this, you will need to <span class="step">pour the blender contents into your strainer and let the liquid...</span>
 +
  </p>
 +
  <p>
 +
    All this cooking reminds me of the apple farm where I grew up...
 +
    Now that you know where apples come from, you will need to <span class="step">peel and dice the apples and add them to the drained cranberries.</span>
 +
  </p>
 +
</div>
 +
</nowiki></pre>
 +
 +
===== preptime =====
 +
* Time it takes for the preparation step of the recipe.
 +
* Optional. Text or the property may be encoded using the [http://microformats.org/wiki/value-class-pattern value-class-pattern]. Limited to one '''preptime''' per recipe.
 +
* ''Rationale: We add '''preptime''' and '''cooktime''' to help publishers express these values explicitly and request only one '''duration''' property to express total time for the recipe.''
 +
Example
 +
<pre><nowiki>
 +
<h6>Preparation time: <span class="preptime">5 minutes</span></h6>
 +
</nowiki></pre>
 +
 +
===== cooktime =====
 +
* Time it takes for the cooking step of the recipe.
 +
* Optional. Text or the property may be encoded using the [http://microformats.org/wiki/value-class-pattern value-class-pattern]. Limited to one '''cooktime''' per recipe.
 +
* ''Rationale: We add '''preptime''' and '''cooktime''' to help publishers express these values explicitly and request only one '''duration''' property to express total time for the recipe.''
 +
Example
 +
<pre><nowiki>
 +
<h6>Cooking time: <span class="cooktime">25 minutes</span></h6>
 +
</nowiki></pre>
 +
 +
===== tag =====
 +
* One or more tags (cuisine, keyword, etc.) for the recipe.
 +
* Optional. No limit to number of '''tag'''  properties per recipe.
 +
* ''Rationale: Our use of tagging is very different from the use-case of [http://microformats.org/wiki/rel-tag rel-tag] which requires a tagspace. In our use case, we need to allow users of the microformat the ability to associate descriptive words to a recipe, but cannot require they also construct a web infrastructure. This view is correctly rejected by the rel-tag issues reviewers citing large-scale sites such as Flickr and del.icio.us. Perhaps "tags" is simply the wrong term for us?''
 +
Example
 +
<pre><nowiki>
 +
<span class="tag">Salad</span>
 +
<span class="tag">Fruit</span>
 +
</nowiki></pre>
 +
 +
===== category =====
 +
* Category of the recipe.
 +
* Optional. Limited to one '''category''' per recipe.
 +
* ''Rationale: While hRecipe recommends tags for this, we find that the category of the recipe is often treated differently in published recipes and we'd like to try to promote it out of the tags.''
 +
Example
 +
<pre><nowiki>
 +
<span class="category">Side dish</span>
 +
</nowiki></pre>
 +
 +
===== difficulty =====
 +
* Difficulty level of preparing the recipe.
 +
* Optional. The value should be encoded as a fraction using the '''value-title''' class defined in the [http://microformats.org/wiki/value-class-pattern value-class-pattern]. Limited to one '''difficulty''' per recipe.
 +
* ''Rationale: While hRecipe recommends tags for this, we find that the difficulty of the recipe is often expressed in published recipes as a specific ratio.''
 +
Example
 +
<pre><nowiki>
 +
<span class="difficulty"><span class="value-title" title="1/3" />Easy</span>
 +
</nowiki></pre>
 +
 +
===== rating =====
 +
* Rating of the recipe.
 +
* Optional. The value should be encoded as a fraction using the '''value-title''' class defined in the [http://microformats.org/wiki/value-class-pattern value-class-pattern]. Limited to one '''rating''' per recipe.
 +
* ''While hRecipe recommends tags for this, we find that the rating of the recipe is often expressed in published recipes as a specific ratio.''
 +
Example
 +
<pre><nowiki>
 +
<span class="rating"><span class="value-title" title="4/5" /><img src="/images/4-out-of-5-stars.jpg" /></span>
 +
</nowiki></pre>
 +
 +
==issues==
 +
Issues have been moved to a seperate [[recipe-issues|recipe-issues ]] page.
 +
 +
==implementations==
 +
===Cognition===
 +
As of September 2008, [http://buzzword.org.uk/cognition/ Cognition] has experimental support for this format. ([http://buzzword.org.uk/cognition/uf-plus.html#hrecipe Details of support].) Recipes may be exported in [[recipe-formats#RecipeBook_XML|RecipeBook XML]] format or RDF.
 +
 +
==examples in the wild==
 +
 +
'''Wild Mushroom, Pancetta & Truffle Risotto''' by Toby Inkster
 +
* [http://tobyinkster.co.uk/blog/2008/10/23/mushroom-risotto/ Marked up as hRecipe] using the September 2007 draft format
 +
* [http://srv.buzzword.org.uk/recipebook/tobyinkster.co.uk/blog/2008/10/23/mushroom-risotto/ RecipeBook XML] output from Cognition.
 +
* [http://srv.buzzword.org.uk/rdf-xml/tobyinkster.co.uk/blog/2008/10/23/mushroom-risotto/ RDF/XML] and [http://srv.buzzword.org.uk/turtle/tobyinkster.co.uk/blog/2008/10/23/mushroom-risotto/ Turtle] output from Cognition.
 +
 +
== related pages ==
 +
[[recipe]] effort per the process:
* [[recipe-examples]]
* [[recipe-examples]]
* [[recipe-formats]]
* [[recipe-formats]]
 +
* [[recipe-brainstorming]] (see also [[recipe-brainstorming-archive]])
 +
* [[recipe-issues]]
 +
 +
See now:
 +
* [[hRecipe]]
 +
* [[hrecipe-issues|hRecipe issues]]

Current revision

Towards a Recipe microformat. Please read the process before editing this page.


For the sake of clarity the format-in-progress from september 2007 was moved to recipe-brainstorming-archive. ThomasLoertsch 14:12, 11. Nov 2008 (CET)

format-in-progress - #2 - october 2008

Also the format-in-progress from october 2008 has been moved to recipe-brainstorming-archive. --ThomasLoertsch 12:49, 9 July 2009 (UTC)

brainstorming

RecipeML-based Brainstorm

NOTE: Brainstorms should be based on implied schema of examples, not on explicit schema of other formats. The only exceptions where this appears to have been ok (perhaps I got lucky) was with hCard (based on vCard) and hCalendar (based on iCalendar), but even in those cases, experience has shown that there are several properties in each that in practice have not shown much if any use, therefore indicating that the microformats were/are bigger than they need(ed) to be. Tantek 23:19, 27 December 2008 (UTC)

Excerpted from Conor Bandon's Blog entry and derived from The RecipeML Spec:

Cookcamp brainstorming

At CookCamp in February 2007, Tantek moderated a fairly free form discussion of how to publish/share recipes. Here is a photo of the whiteboard: 422072573_9956d93f61.jpg

To Do: OCR this and enter rough notes here...

Additional Suggestions

<ul class="ingredients"> <li>Booze <ul> <li>1 part <span class="name">Rum</span></li> </ul> </li> <li>Mixer <li>1 part <span class="name">Cola</span></li> <li>1 part <span class="name">Lime juice</span></li> </li> </ul> --Yde 13:09, 18 Apr 2008 (PDT)

<p class="method">Take <span class="ingredient"><span class="quantity">a handful</span>

of spinach</span> and fry it</p> --BenWard 13:20, 18 Apr 2008 (PDT)
I like to eat <span class="hRecipe"><span class="ingredient">cheese</span></span> for supper.

or simply (if the proposed "sub-microformat-pattern" is adopted):

I like to eat <span class="hRecipe-ingredient">cheese</span> for supper.
Andy Mabbett 08:16, 5 Jan 2008 (PST)

Quantity

There are a lot of units typically used in recipes that do not make much sense in most other cases and therefor most likely will never make it into a 80/20-aware measure-microformat. This is a deliberatly short list:

note can be used to indicate more subtle differentiation (like a "big spoonful", "some leaves" etc). I think this list is both usefully short and complete. The following measures:

can be taken from the measure microformat. I guess measure is already stable enough that it's save to use these terms "experimentally". The measure-element should be optional. That way nobody is forced to select a value from it - it's just a help to facilitate interoperability. --ThomasLoertsch 15:45, 01 Oct 2008 (CET)

Proposed Optimisations

Item

Can we have this optimisation?... if no "item" is found, the entire ingredient is taken to be the item. TobyInk

Example:

<span class="ingredient">salt</span>

is a shorthand for:

<span class="ingredient"><span class="item">salt</span></span>

Ingredient List

TobyInk 03:42, 23 Mar 2008 (PDT):

If class="ingredients" (note: plural) is found on an element, class="ingredient" (note: singular) is automatically implied on all its children.

<ul class="ingredients">
<li><span class="quantity">3</span> <span class="item">eggs</span></li>
<li><span class="quantity">6 oz</span> <span class="item">self-raising flour</span></li>
<li><span class="quantity">6 oz</span> <span class="item">caster sugar</span></li>
<li><span class="quantity">6 oz</span> <span class="item">butter</span></li>
<li><span class="quantity">1 tsp</span> <span class="item">vanilla essence</span></li>
</ul>

is a shorthand for:

<ul class="ingredients">
<li class="ingredient"><span class="quantity">3</span> <span class="item">eggs</span></li>
<li class="ingredient"><span class="quantity">6 oz</span> <span class="item">self-raising flour</span></li>
<li class="ingredient"><span class="quantity">6 oz</span> <span class="item">caster sugar</span></li>
<li class="ingredient"><span class="quantity">6 oz</span> <span class="item">butter</span></li>
<li class="ingredient"><span class="quantity">1 tsp</span> <span class="item">vanilla essence</span></li>
</ul>

Promoting hRecipe for use in Recipe Search Indexing

My company has an interest in the establishment and adoption of a recipe-based microformat in support of our goal to index recipe content for search.

We would like to promote a few POSH extensions to hRecipe that we think will be useful to the recipe-publishing community in support of our shared intention to promote hRecipe's adoption as a standard.

I have outlined these extensions (and our rationale) below and would like to ask the community for comment in advance of any publication. After comment, we will host a public page outlining the extensions which will refer to microformats.org as the authoritative source for hRecipe.

(My intent is also to share whatever data we collect on the adoption of hRecipe in the sites we index, which will include smaller blogger sites where we expect hRecipe will initially be most prevalent.)

--DaveCorboy 03:43, 22 March 2010 (UTC)

Proposed Extensions

comment

Example

<ul>
  <li class="ingredient">1 cup of walnuts or pecans
    <span class="comment">
      (Though I usually prefer pecans in most recipes, I like walnuts best in this.)
    </span>
  </li>
</ul>
step

Example

<div class="instructions">
  <p>So before we get to the recipe, let me tell you a story about cranberries...</p>
  <p>
    Now, let's get to cooking! First, you will need to <span class="step">coarsely grind the cranberries. Fill your blender 2/3 full...</span>
    After you have done this, you will need to <span class="step">pour the blender contents into your strainer and let the liquid...</span>
  </p>
  <p>
    All this cooking reminds me of the apple farm where I grew up...
    Now that you know where apples come from, you will need to <span class="step">peel and dice the apples and add them to the drained cranberries.</span>
  </p>
</div>
preptime

Example

<h6>Preparation time: <span class="preptime">5 minutes</span></h6>
cooktime

Example

<h6>Cooking time: <span class="cooktime">25 minutes</span></h6>
tag

Example

<span class="tag">Salad</span>
<span class="tag">Fruit</span>
category

Example

<span class="category">Side dish</span>
difficulty

Example

<span class="difficulty"><span class="value-title" title="1/3" />Easy</span>
rating

Example

<span class="rating"><span class="value-title" title="4/5" /><img src="/images/4-out-of-5-stars.jpg" /></span>

issues

Issues have been moved to a seperate recipe-issues page.

implementations

Cognition

As of September 2008, Cognition has experimental support for this format. (Details of support.) Recipes may be exported in RecipeBook XML format or RDF.

examples in the wild

Wild Mushroom, Pancetta & Truffle Risotto by Toby Inkster

related pages

recipe effort per the process:

See now:

recipe-brainstorming was last modified: Sunday, April 4th, 2010

Views