Microformats Wiki - User contributions [en]

hrecipe

2010-04-08T02:56:30Z

DaveCorboy: /* Examples in the wild */

<entry-title>hRecipe 0.22</entry-title>
{{Template:DraftSpecification}}
{{TOC-right}}
http://www.livingathome.de/test/recipe/hRecipe.png

[[recipe|hRecipe]] is a simple, open, distributed format, suitable for embedding information about recipes for cooking in (X)HTML, Atom, RSS, and arbitrary XML. hRecipe is one of several [[microformats]] open standards. This page and Microformat is in the public domain.

== hRecipe Microformat Draft Specification ==

=== Editor ===
* [[User:ThomasLoertsch | Thomas Loertsch]] ([http://www.essen-und-trinken.de Gruner+Jahr])
=== Authors ===
* [[User:Phae|Frances Berriman]] (BBC)
* [[User:BenWard|Ben Ward]]
* [[User:TobyInk|Toby Inkster]]

=== Contributors===
[[User:AndyMabbett|Andy Mabbett]], [[User:Phae|Frances Berriman]], [[User:IamCam|Cameron Perry]], [[User:JohnLeMasney|John LeMasney]], [[User:Tantek|Tantek Çelik]], [[User:SudarshanP|SudarshanP]], [[User:CiaranMc|Ciaran McNulty]], [[User:LeeJordan|Lee Jordan]], [[User:RobertBachmann|Robert Bachmann]], [[User:JeffMcNeill|jeffmcneill]], [[User:ManuSporny|Manu Sporny]], [[User:RyanKing|Ryan King]], HollyMarieKoltz, Straup, [[User:ChristopheDucamp|Christophe Ducamp]], Mercman, [[User:Yde|Yde]], [[User:AmeerDawood|Ameer Dawood]], Scottk, [[User:Lee_Jordan|Lee Jordan]], MonroAlmon, EstevaoSamuel, [[User:Brian|Brian Suda]], SteveL, JohnLeMasney,

Microformats [[#Copyright]] and [[#Patents]] statements apply.

== Introduction ==

The hRecipe microformat is designed for the mark-up of instructions for creating meals, drinks or food-based items.

It is difficult for a browser to extract semantic information about a recipe described on a web page. Metadata such as author and name and details such as ingredients, method, preparation time etc provide relevant information about the recipe.

Having such information marked up can provide a number of benefits to the viewer. If a web browser understands that a particular web page contains a recipe with specific characteristics, it can produce richer interactions. For example, specific searches may be performed for ingredients or authors via general search services such as Google and Wikipedia. Additionally, classification by crawlers can become more accurate. If there are 20 recipes found on a page, and they all contain a certain ingredient, it can be assumed that the page is not only about cooking, but also about that particular ingredient.

In order to enable and encourage the sharing, distribution, syndication, and aggregation of recipes, the authors propose the hRecipe microformat, an open standard for distributed recipe metadata. The authors have researched both numerous [[recipe-examples]] in the wild and earlier attempts at [[recipe-formats]], and have designed hRecipe around a simple minimal schema for recipe content. Feedback is encouraged on the [[recipe-feedback|hRecipe feedback]] page.

=== Inspiration and Acknowledgments ===

Many thanks to the various individuals that did research and proposed ideas and discussion related to the hRecipe-format and recipes in general.

=== Scope ===

hRecipe is a format to annotate descriptions and lists of ingredients for the preparation of food and meals. Recipes consistently share several common properties. hRecipe has been based on this minimal common subset.

=== Out of scope ===

Recipes that are not for stuff that's meant to be eaten by humans are out of scope.

== Format ==

{{rfc-2119-intro}}

=== In General ===
The hRecipe format is based on a set of properties common to numerous recipe sites and formats in use today on the web. Where possible property names have been chosen based on those defined by related microformat standards. 
Some properties are marked ''experimental'' since they exceed the minimum set of properties needed to describe a recipe but still are very commonly used on the web. It's not sure if they are relevant enough for inclusion in the format. Implementation and general uptake of these properties will be observed and inform further decisions. So their use is not at all discouraged - but use them with care and be prepared for their eventual removal from the final spec.

=== Schema ===
The hRecipe schema consists of the following properties:

* '''hrecipe'''
** '''fn'''. required. text. the name of the recipe.
** '''ingredient'''. required. 1 or more. text with optional valid (x)HTML markup.
*** '''''value''''' and '''''type'''''. optional. [experimental]
** '''''yield'''''. optional. text.
** '''''instructions'''''. optional. text with optional valid (x)HTML markup.
** '''''duration'''''. optional. 1 or more. text.
** ''photo''. optional. 1 or more. using any element containing a URL, such as IMG. [experimental]
** ''summary''. optional. text. [experimental]
** ''author''. optional. 1 or more. [experimental]
** ''published''. optional. [experimental]
** ''nutrition''. optional. 1 or more. [experimental]
*** ''value'' and ''type''. optional. [experimental]
** ''tag''. optional. 1 or more. [experimental]

=== Property details ===

Property names <code>fn</code>, <code>photo</code>, <code>author</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Property name <code>duration</code> is reused from [[hAudio]]. Property name <code>summary</code> is reused from [[hCalendar]]. Property name <code>published</code> is reused from [[hAtom]]. Property name <code>tag</code> is reused from [[rel-tag]].

The fields of the hRecipe schema represent the following:

==== hRecipe ====

A hRecipe is used to identify and describe values and metadata typically associated with a recipe.

* A hRecipe property is identified by the name <code>hrecipe</code>

==== fn ====

The title of a single recipe. A short textual description used to identify the work among interested parties. This can be the name of a meal or a short description regarding it's ingredients.

* The property is identified by the name <code>fn</code>.
* A Recipe {{must}} include a <code>fn</code>.
* The property {{must}} follow the conventions outlined in [[hCard]] e.g. by using only plain text.

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The property is identified by the name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The property {{may}} include valid HTML markup (e.g. a list of ingredients).
* The property {{may}} include the properties <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]], e.g. <source lang=html4strict>125ml milk</source>In this case each ingredient should be marked up with it's own <code>ingredient</code> property. These subproperties are considered ''experimental'' and may be removed from the final specification or replaced by 'num' and 'unit' from [[measure]].

==== yield ====

Specifies the quantity produced by the recipe, like how many persons it satisfyies or how many pieces can be made of it.

* The property is identified by the name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The property is identified by the name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> property.
* The property {{may}} include valid HTML markup e.g. paragraphs or a list of steps.

==== duration ====

The time it takes to prepare the meal described by the recipe. Multiple duration properties can be used to denote e.g. time for preparing a dough, time needed for the dough to raise, time to bake the dough, time for decorating the cake etc.

* The property is identified by the name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code> properties.
* The property {{may}} encode the timespan as outlined in the [[value-class-pattern|value-class-pattern]]. A duration of 1 hour 30 minutes would translate to "PT1H30M" in ISO 8601 format and can be encoded as follows:<source lang=html4strict> 90 min</source>

==== photo ====

Accompanying image.

* The property is identified by the name <code>photo</code>.
* A Recipe {{may}} include one or more <code>photo</code> properties.
* The property {{should}} use an <img> element. It {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended. See [[hRecipe#Semantic_XHTML_Design_Principles | notes]] below.
* The property is considered ''experimental'' and may be removed from the final specification.

==== summary ====

The summary provides a short introduction to or an accompanying statement about the recipe.

* The property is identified by the name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The property {{must}} follow the conventions outlined in [[hCalendar]]. Plain text fulfills these requirements.
* The property is considered ''experimental'' and may be removed from the final specification.

==== author ====

An author is the person who wrote the recipe.

* The property is identified by the name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> properties.
* The contents of the element {{may}} be a plain text string in which case it defaults to a "vcard fn". Anything more elaborate {{must}} follow the conventions outlined in [[hCard]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The property is identified by the name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The property {{may}} be encoded using the [[value-class-pattern|value-class-pattern]], e.g.:<source lang=html4strict>Published 14. Oct 2008</source>
* The property is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The property is identified by name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> properties.
* The property {{may}} include the properties <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each nutritional information item should be marked up with it's own <code>nutrition</code> property. These subelement are considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The property <code>nutrition</code> itself is also considered ''experimental'' and may be removed from the final specification.

==== tag ====

A keyword indicating a subject or an important aspect of the recipe like it's main ingredient, type of meal etc.

* The property is identified by the name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code>'s.
* The property {{must}} follow the conventions outlined in [[rel-tag]].
* The property is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* Version 0.22 changed the proposed formatting of time and date from the [[datetime-design-pattern|datetime-design-pattern]], which has [[datetime-design-pattern#Accessibility_issues|accessibility issues]], to the [[value-class-pattern|value-class-pattern]]. Also corrected some errors in the example especially with regard to the correct handling of vcard properties.
* Version 0.21 changed the status of ingredient/value and ingredient/type to ''experimental'', mentioning that there still is discussion if they should be replaced by 'num' and 'unit' from [[measure]] (which is still in brainstorming).
* Version 0.2: From [http://microformats.org/wiki/index.php?title=hrecipe&oldid=37357 Version 0.1] some elements have been renamed to strenghten re-use of established elements: '''fn''' for '''hRecipe-title''', '''summary''' for '''hRecipe-summary''', '''duration''' for '''preparation-time''', '''value''' and '''type''' for '''num''' and '''unit'''. Also some elements have been marked '''experimental''' because of concerns of element bloat. See the [[hrecipe-issues]] page for a more thorough discussion. Draft 0.1 was already a result of long lasting efforts. Nonetheless after publishing of it there has been a lively debate about some properties. Since they mostly could be resolved version 0.2 is considered fairly stable now, although of course you never know ;-)

=== Parser Processing Notes ===

* If the "author" property contains only a plain text string it should be regarded as of type "vcard fn".

=== Semantic XHTML Design Principles ===

{{semantic-xhtml-design-principles}}

==== More Semantic Equivalents ====

For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:

* For "photo", use <code><img class="photo" src="..." alt="" /></code>

==== Language ====

* To explicitly convey the natural language that an recipe is written in, use the standard (X)HTML 'lang' or 'xml:lang' attribute on the element with class="hrecipe"
**e.g. <code><nowiki>I like Kartoffelknödel best.</nowiki></code>
*If portions of an hRecipe (e.g. an ingredient name) are in a different language to the rest of the hRecipe, use the 'lang' or 'xml:lang' attribute on those portions.
* hRecipe parsers which need to handle the native language of hRecipe {{must}} process the standard (X)HTML 'lang' or 'xml:lang' attribute as specified.
* hRecipe parsers which need to handle native language {{may}} traverse up the DOM to discover the native language of the page and apply that to the hRecipe if no other language is specified on the hRecipe.

==== Human vs. Machine Readable ====

If an <code><abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value.

If an <code><a></code> element is used for one or more properties, it {{must}} be treated as follows:
# For the 'photo' property and any other property that takes a URL as its value, the <code>href="..."</code> attribute provides the property value.
# For other properties, the element's content is the value of the property.

If an <code><img></code> element is used for the 'photo' property, it {{must}} use the property value provided by the <code>src="..."</code> attribute as property value.

If an <code><object></code> element is used for the 'photo' property, it {{must}} use the property value provided by the <code>data="..."</code> attribute as property value.

=== Notes ===

This section is informative.

*Non so far.

== XMDP Profile ==

<source lang=html4strict>
<dl class="profile">
<dt>class</dt>
<dd>
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
HTML4 definition of the 'class' attribute.</a>
This meta data profile defines some 'class' attribute values (class names)
and their meanings as suggested by a
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
draft of "Hypertext Links in HTML"</a>.
<dl>
<dt>hrecipe</dt>
<dd>
Used to identify and describe metadata associated with instructions for creating meals, drinks or food-based items.
</dd>
<dt>fn</dt>
<dd>
The title of the recipe.
</dd>
<dt>ingredient</dt>
<dd>
Describes the ingredient(s) used in the recipe.
</dd>
<dt>yield</dt>
<dd>
Specifies the quantity produced by the recipe.
</dd>
<dt>instructions</dt>
<dd>
The method of the recipe.
</dd>
<dt>duration</dt>
<dd>
The time it takes to prepare the meal described by the recipe.
</dd>
<dt>photo</dt>
<dd>
Accompanying image.
</dd>
<dt>summary</dt>
<dd>
The summary provides a short introduction or an accompanying statement about the recipe.
</dd>
<dt>author</dt>
<dd>
The person who authored the recipe..
</dd>
<dt>published</dt>
<dd>
The date that the recipe was made available to the public.
</dd>
<dt>nutrition</dt>
<dd>
Nutritional information like calories, fat, dietary fiber etc.
</dd>
<dt>tag</dt>
<dd>
Keyword(s) describing the recipe.
</dd>
</dl>
</dd>
</dl>
</source>

== Examples ==

This section is informative.

Here '''will be''' a few examples of recipes, from real web sites, showing how they could be easily enhanced to use hRecipe. In the meantime the following contrieved example will have to do.

<source lang=html4strict><div class="hrecipe">
<h1 class="fn">Pommes Frites</h1>

Pommes frites originate in outer space. They are served hot. 
This recipe is only an example. Don't try this at home!


Contributed by CJ Tom and the
<a class="url fn" href="http://example.com">Cooky Gang</a>.

Published 14. Oct 2008
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>
<h2>Ingredients</h2>
<ul>
<li class="ingredient">
500
gramme potatoes, hard cooking.
</li>
<li class="ingredient">
1 spoonful of salt
</li>
<li>
You may want to provide some
Ketchup and Mayonnaise
as well.
</li>
</ul>
<h2>Instructions</h2>
<ul class="instructions">
<li>First wash the potatoes.</li>
<li>Then slice and dice them and put them in boiling fat.</li>
<li>After a few minutes take them out again.</li>
</ul>
<h2>Further details</h2>
Enough for 12 children.
Preparation time is approximately
 90 min

Add half an hour to prepare your homemade Ketchup.
This recipe is <a href="http://www.example.com/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.example.com/tags/tastyness/delicious" rel="tag">delicious</a>.


Pommes Frites have more than
1000
Joule
Energy,
while Ketchup and Mayonnaise have
0 vitamins.

</div>
</source>


== Examples in the wild ==

This section is '''informative'''.

Sites and pages that publish hRecipes. When it gets too big we can move it to a separate page like [[hrecipe-examples-in-wild]].

* [http://www.epicurious.com/ Epicurious.com]'s [http://www.epicurious.com/recipesmenus/ recipes] have been marked up with hRecipe as of April 2010. (E.g., [http://www.epicurious.com/recipes/food/views/Chocolate-Almond-and-Banana-Parfaits-357369 Chocolate, Almond, and Banana Parfaits])
* [http://www.williams-sonoma.com/ Williams-Sonoma]'s [http://www.williams-sonoma.com/recipe/ recipes section], e.g. [http://www.williams-sonoma.com/recipe/cherry-almond-bundt-cake.html Cherry Almond Bundt Cake]
* http://foodnetwork.com/ has marked up all their recipes with hRecipe as of 2009-10, e.g. [http://www.foodnetwork.com/recipes/ina-garten/deep-dish-apple-pie-recipe2/index.html Deep-Dish Apple Pie recipe]
* essen & trinken. As of spring 2009 [http://www.essen-und-trinken.de essen & trinken] publishes all recipes with hRecipe-conformant metadata encoded in RDF. See [[hrecipe-rdf]] for technical details.
* It's Ripe! As of January 2009, [http://itsripe.com/recipes/ http://itsripe.com] supports hRecipe for recipe pages and will soon add support in lists.
*'''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.

== Implementations ==
This section is '''informative'''.

Tools for generating and consuming hRecipes. When it gets too big we can move it to a separate page like [[hrecipe-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.
* WordPress Plugin. There's a [http://wordpress.org/ WordPress ] [http://wordpress.org/extend/plugins/hrecipe/ hRecipe Plugin] available which makes adding hRecipe metadata to recipes very easy, practically effortless. Very nice!

== References ==

=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://gmpg.org/xmdp/ XMDP]
* [[hcard|hCard]]
* [[abbr-design-pattern]]
* [[datetime-design-pattern]]

=== Informative References ===
* [http://www.w3.org/TR/REC-CSS1 CSS1]
* ISO.8601.1988
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]
* Other recipe metadata efforts. See [[recipe-formats]].
* [[grouping-examples]]
* [[grouping-brainstorming]]
* [[xoxo|XOXO]]

=== Copyright ===

Per [[Microformats_Wiki:Copyrights]], hRecipe was placed into the public domain on 2008-11-14 by the authors. There are no usage, distribution, re-printing, or any other restrictions of any kind with regards to the text or content of this specification.

=== Patents ===

{{MicroFormatPatentStatement}}

=== Public Domain Release ===

The authors and editors of this page due hereby relinquish their copyright on the document and release the text of this page into the public domain.

* [[User:Phae|Frances Berriman]] (BBC)
* [[User:BenWard|Ben Ward]]
* [[User:TobyInk|Toby Inkster]]
* [[User:ThomasLoertsch | Thomas Loertsch]] ([http://www.essen-und-trinken.de Gruner+Jahr])

== Work in progress ==
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.

== derivative works ==
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe

Per the microformats [[process]], the [[recipe]] effort developed
* [[recipe-examples]]
* [[recipe-formats]]
* [[recipe-brainstorming]] (see also [[recipe-brainstorming-archive]])
* [[recipe-issues]]
towards the development of this draft.

[[Category:Draft Specifications]]

recipe-brainstorming

2010-04-04T04:57:13Z

DaveCorboy: /* Promoting hRecipe for use in Recipe Search Indexing */

Towards a [[recipe|Recipe]] microformat. Please read the [[process]] before editing this page.

<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:
*Recipe_Title
*Summary Description (one liner)
*Measurement System (U.S., Imperial etc)
*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)
*** 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|α]]
**Units need separate microformat: see [[measure]]
**Ingredient Preparation: such as diced, chopped, sliced, grated, minced, etc. [[User:SteveL|Steve Lewis]] 18:55, 11 Feb 2007 (PST)
*Preparation Time (overall time)
*Yield Quantity and Unit (4 pancakes or 5 servings)
**Calories per serving [[User:JohnLeMasney| John LeMasney]]
**Calories per ounce [[User:JohnLeMasney| John LeMasney]]
*Background Information - Optional section to encapsulate information that is useful but not necessarily required for a successful recipe. [[User:AlexanderShusta|α]]
**Author (Person) ([[hcard]]?)
**Submitter (Person) ([[hcard]]?)
**Source (Book Title etc)
*** could use the proposed [[citation]] microformat. [[User:AndyMabbett|Andy Mabbett]] 06:43, 16 Nov 2006 (PST)
**Date (Of Creation or Publication)
**Rights (Copyright or other)
**Meal Category (Starter, entree, dessert )
**Cuisine Category (Italian etc)
*Instructions (text, but can contain:)
**Steps (optional)
***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|α]]
***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]]
**Could be one per dish, or one for each (or for some of the) step(s). [[User:AndyMabbett|Andy Mabbett]]

===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]]
** -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)
*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 Rum</li>
</ul>
</li>
<li>Mixer
<li>1 part Cola</li>
<li>1 part Lime juice</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>
Take a handful
of spinach and fry it</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)

*Method > Steps - or Method-Step[] as a child of Method. Imply ordered steps from an HTML list or explicitly mark-up ordered steps respectively.
** -1. Outside 80/20. POSH is good enough for this purpose. --[[User:ThomasLoertsch|ThomasLoertsch]] 15:04, 01 Oct 2008 (CET)
* 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)
* Suitable for occasions - what occasions are the dish suitable for? [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
* Category - many sites categorize their recipes. [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
** Tags could be used for both suitability and category.

*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 cheese 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 cheese 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>salt</nowiki></pre>
is a shorthand for:
<pre><nowiki>salt</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>3 eggs</li>
<li>6 oz self-raising flour</li>
<li>6 oz caster sugar</li>
<li>6 oz butter</li>
<li>1 tsp vanilla essence</li>
</ul></nowiki></pre>

is a shorthand for:

<pre><nowiki><ul class="ingredients">
<li class="ingredient">3 eggs</li>
<li class="ingredient">6 oz self-raising flour</li>
<li class="ingredient">6 oz caster sugar</li>
<li class="ingredient">6 oz butter</li>
<li class="ingredient">1 tsp vanilla essence</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

(Though I usually prefer pecans in most recipes, I like walnuts best in this.)

</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">
So before we get to the recipe, let me tell you a story about cranberries...

Now, let's get to cooking! First, you will need to coarsely grind the cranberries. Fill your blender 2/3 full...
After you have done this, you will need to pour the blender contents into your strainer and let the liquid...


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 peel and dice the apples and add them to the drained cranberries.

</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: 5 minutes</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: 25 minutes</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>
Salad
Fruit
</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>
Side dish
</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>
Easy
</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>
<img src="/images/4-out-of-5-stars.jpg" />
</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-formats]]
* [[recipe-brainstorming]] (see also [[recipe-brainstorming-archive]])
* [[recipe-issues]]

See now:
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]]

User:DaveCorboy

2010-03-22T03:47:27Z

DaveCorboy: New page: My name is Dave Corboy. I lead development for a company that offers a free shopping list web-app with a significant recipe search component. You can reach me at dave.corboy@ziplist.com.

My name is Dave Corboy. I lead development for a company that offers a free shopping list web-app with a significant recipe search component. You can reach me at dave.corboy@ziplist.com.

recipe-brainstorming

2010-03-22T03:43:39Z

DaveCorboy: promoting some extensions to hRecipe for use in recipe search indexing

Towards a [[recipe|Recipe]] microformat. Please read the [[process]] before editing this page.

<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:
*Recipe_Title
*Summary Description (one liner)
*Measurement System (U.S., Imperial etc)
*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)
*** 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|α]]
**Units need separate microformat: see [[measure]]
**Ingredient Preparation: such as diced, chopped, sliced, grated, minced, etc. [[User:SteveL|Steve Lewis]] 18:55, 11 Feb 2007 (PST)
*Preparation Time (overall time)
*Yield Quantity and Unit (4 pancakes or 5 servings)
**Calories per serving [[User:JohnLeMasney| John LeMasney]]
**Calories per ounce [[User:JohnLeMasney| John LeMasney]]
*Background Information - Optional section to encapsulate information that is useful but not necessarily required for a successful recipe. [[User:AlexanderShusta|α]]
**Author (Person) ([[hcard]]?)
**Submitter (Person) ([[hcard]]?)
**Source (Book Title etc)
*** could use the proposed [[citation]] microformat. [[User:AndyMabbett|Andy Mabbett]] 06:43, 16 Nov 2006 (PST)
**Date (Of Creation or Publication)
**Rights (Copyright or other)
**Meal Category (Starter, entree, dessert )
**Cuisine Category (Italian etc)
*Instructions (text, but can contain:)
**Steps (optional)
***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|α]]
***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]]
**Could be one per dish, or one for each (or for some of the) step(s). [[User:AndyMabbett|Andy Mabbett]]

===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]]
** -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)
*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 Rum</li>
</ul>
</li>
<li>Mixer
<li>1 part Cola</li>
<li>1 part Lime juice</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>
Take a handful
of spinach and fry it</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)

*Method > Steps - or Method-Step[] as a child of Method. Imply ordered steps from an HTML list or explicitly mark-up ordered steps respectively.
** -1. Outside 80/20. POSH is good enough for this purpose. --[[User:ThomasLoertsch|ThomasLoertsch]] 15:04, 01 Oct 2008 (CET)
* 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)
* Suitable for occasions - what occasions are the dish suitable for? [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
* Category - many sites categorize their recipes. [[User:WilleRaab|WilleRaab]] 16:57, 20 Jul 2007 (PDT)
** Tags could be used for both suitability and category.

*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 cheese 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 cheese 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>salt</nowiki></pre>
is a shorthand for:
<pre><nowiki>salt</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>3 eggs</li>
<li>6 oz self-raising flour</li>
<li>6 oz caster sugar</li>
<li>6 oz butter</li>
<li>1 tsp vanilla essence</li>
</ul></nowiki></pre>

is a shorthand for:

<pre><nowiki><ul class="ingredients">
<li class="ingredient">3 eggs</li>
<li class="ingredient">6 oz self-raising flour</li>
<li class="ingredient">6 oz caster sugar</li>
<li class="ingredient">6 oz butter</li>
<li class="ingredient">1 tsp vanilla essence</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)

==== 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

(Though I usually prefer pecans in most recipes, I like walnuts best in this.)

</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">
So before we get to the recipe, let me tell you a story about cranberries...

Now, let's get to cooking! First, you will need to coarsely grind the cranberries. Fill your blender 2/3 full...
After you have done this, you will need to pour the blender contents into your strainer and let the liquid...


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 peel and dice the apples and add them to the drained cranberries.

</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: 5 minutes</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: 25 minutes</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>
Salad
Fruit
</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>
Side dish
</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>
Easy
</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>
<img src="/images/4-out-of-5-stars.jpg" />
</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-formats]]
* [[recipe-brainstorming]] (see also [[recipe-brainstorming-archive]])
* [[recipe-issues]]

See now:
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]]