Microformats Wiki - User contributions [en]

hrecipe

2010-06-25T16:36:53Z

ThomasLoertsch: /* Editor */ not employed by Gruner+Jahr anymore

<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 Lörtsch]]

=== 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]
* [http://www.plantoeat.com/ Plan to Eat]'s [http://www.plantoeat.com/recipe_book recipe planner] is now in hRecipe format as of April 2010. (E.g., [http://www.plantoeat.com/recipes/4583/1fv1A5vFhjm Pasta With Smashed Peas])
* 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]]

User:ThomasLoertsch

2009-07-22T21:46:31Z

ThomasLoertsch:

My name is Thomas Lörtsch. You can reach me as thomas@stray.net and, very irregularily, as "tl" or "tomlurge" in the #microformats chat.

I did work at "essen & trinken" (rough translation: "eating & drinking"), a fairly popular website [1] about cooking in german. One of the main features of the site is a collection of about 10.000 recipes, all actually tried, categorized, etc. While searching for a standard ontology we came across the hRecipe proposal, which by and large fitted well with what we had already. I helped moving it forward to the current Draft status and implemented it on essen & trinken with RDFa.

Please note that my former mail adress at guj.de does not work anymore.

[1] http://www.essen-und-trinken.de/

WYSIWYG-plugins

2009-07-14T08:57:27Z

ThomasLoertsch: added WYMeditor

This is a list of WYSIWYG editors and the plugins to be developed and translated so that it is easy to add microformats into [[CMS]] systems.

==TinyMCE==
See existing write-up at [[wordpress-plugins#TinyMCE_plugins]].
* Homepage link
* Developer notes
* Plugins to Create
** rel-license
** rel-tag
** (more)

==FCKEditor==
* [http://www.fckeditor.net/ Homepage]
* [http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide Developer notes]
* Notes: has a 3.x version under development.

==WYMeditor==
* [http://www.wymeditor.org/ Homepage]
* [http://forum.wymeditor.org/forum/viewtopic.php?f=3&p=2030 WYMeditor for RDFa], [http://files.wymeditor.org/wymeditor/trunk/src/test/rdfa.html RDFa editor implementation test page]
* very nice and clean approach to a structure oriented editor

==(more???)==
* Homepage link
* Developer notes

== icons==
We will need some standardized icon styles for these buttons. Recommendations? Styles?

== see also ==
* [[cms]]
* [[drupal]]
* [[movable-type]]
* [[wordpress]]
* [[wordpress-plugins]]

recipe-brainstorming-archive

2009-07-09T12:50:04Z

ThomasLoertsch: added format-in-progess-#2

This page contains former formats-in-progress from the [[recipe-brainstorming]] page.

<div id="Format-In-Progress">
==format-in-progress - september 2007==
</div>
This format-in-progress follows the restarting of Recipe development by [[User:Phae|Frances Berriman]] on 25th September 2007. Note that this Format-In-Progress section is intended to be edited to reflect the discussion that occurs on the microformats-new list, rather than being a free-form playground for schema. This documentation was produced by [[User:BenWard|Ben Ward]] and [[User:Phae|Frances Berriman]].

; Editor
: [[User:Phae|Frances Berriman]] (BBC)

===Introduction===

Recipe is based on [[recipe-examples|examples]] and fields in [[recipe-formats|existing formats]].

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

===Root Class Name===

To be decided. Likely ‘hrecipe’.

===Property List===

Class names <code>author</code> and <code>published</code> are taken from [[hAtom]], <code>photo</code> used from [[hCard]] and <code>item</code> from [[measure]].

* Title. <code>recipe-title</code>. required. text.
* Summary. <code>recipe-summary</code>. optional. text.
* Author. <code>author</code>. optional. [[hcard]].
* Date published. <code>published</code>. optional. [[datetime-design-pattern]].
* Photo(s). <code>photo</code>. optional. img or url.
* Ingredient(s). <code>ingredient</code>. 1 or more required.
** Quantity. <code>quantity</code>. optional. text, optionally [[measure]].
** Item. <code>item</code>. required. text.
** Note. <code>note</code>. optional. text.
** Optionality. <code>optional</code>. optional. text. Its absence should imply that the ingredient is required.
* Method. <code>method</code>. required. text with optional valid HTML markup.
* Yield. <code>yield</code>. optional. text.
* Preparation time. <code>preparation-time</code>. optional. (see [[ISO-31-1]] duration brainstorming)
* Tags. optional. [[rel-tag]].
* License. optional. [[rel-license]].

===Field Details===

'''Title''': The title of the recipe.
* The element is identified by class name <code>recipe-title</code>.
* A Recipe {{must}} have a <code>recipe-title</code>

'''Summary''': The summary provides a short introduction or an accompanying statement about the recipe.
* The element is identified by class name <code>recipe-summary</code>.
* A Recipe {{may}} have a <code>recipe-summary</code>.

'''Author''': Author the person who authored the recipe.
* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include an <code>author</code>.
* The contents of the element {{must}} include a valid [[hCard]].

'''Date published''': The date the recipe was published.
* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* {{should}} (?) use the [[datetime-design-pattern]] to encode the published datetime.

'''Photo''': Accompanying image.
* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <code><img></code> element.
* The element {{may}} use any other element that contains a URL, such as <code><a></code> or <code><object></code>, but it is not recommended.

'''Ingredient''': Describes an ingredient used in the recipe.
* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} have one or more <code>ingredient</code>s.
* The element {{must}} include the field item.
* The element {{may}} include <code>quantity</code>, <code>note</code> and/or <code>optionality</code>.

'''Quantity''': The quantity of an ingredient needed for the recipe.
* The element is identified by the class name <code>quantity</code>.
* An ingredient {{may}} specify the <code>quantity</code>.

'''Item''': Specifies the name of the ingredient.
* The element is identified by the class name <code>item</code>.
* An ingredient {{must}} specify the <code>item</code>.

'''Note''': A note concerning one of the ingredients.
* The element is identified by the class name <code>note</code>.
* An ingredient {{may}} include a <code>note</code>.

'''Optionality''': States that an ingredient is optional to the recipe.
* The element is identified by the class name <code>optionality</code>.
* The <code>optionality</code> of an <code>ingredient</code> {{may}} be specified.
* The absence of the element implies that the ingredient is required.

'''Method''': The method of the recipe.
* The element is identified by the class name <code>method</code>.
* A Recipe {{must}} include a <code>method</code>.
* The field {{may}} include valid HTML markup (e.g. paragraphs).

'''Yield''': Specifies the quantity produced by the recipe.
* The element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

<div id="Format-In-Progress-10-2008">
==format-in-progress - #2 - october 2008==
</div>

===Introduction===

Recipe is based on [[recipe-examples|examples]] and fields in [[recipe-formats|existing formats]].
The recipe microformat is designed for the mark-up of instructions for creating meals, drinks or food-based items.

Please note that Format-In-Progress sections are intended to be edited to reflect the discussion that occurs on the microformats-new list, rather than being a free-form playground for schema. This Format-In-Progress was produced by [[User:ThomasLoertsch|ThomasLoertsch]] 15:29, 15. Oct 2008 (CET)

===Changelog===

This second Format-In-Progress reflects the discussions following the first one from september 2007 (see [[recipe-brainstorming-archive]]). It is not an entirely new format-in-progress proposal but rather an evolution from the september07-version and about 90% the same. A short overview of changes:
* made <code>author</code> and <code>published</code> plural
* added <code>ingredients</code> element
* made <code>ingredient</code> an optional subelement of <code>ingredients</code>
* modified quantity (and removed the element <code>quantity</code>) to improve compatability with [[measure]]
* deleted ingredient-<code>optionality</code>
* <code>method</code> changed to optional
* <code>preparation-time</code> changed to optionally multiple instances
* added <code>note</code> to <code>preparation-time</code> and made both <code>note</code>s hCard elements
* <code>preparation-time</code>
* added <code>nutrition</code>
* removed<code>rel-license</code> element, because it can't be scoped to one of several receipes on one page (see [[recipe-issues]])

===Root Class Name===

To be decided. Likely ‘hRecipe’.

===Property List===

Class names <code>author</code>, <code>photo</code> and <code>note</code> are taken from [[hCard]], <code>published</code> used from [[hAtom]] and <code>item</code> from [[measure]].

* Title. <code>recipe-title</code>. required. text.
* Summary. <code>recipe-summary</code>. optional. text.
* Author. <code>author</code>. optional. 1 or more. [[hcard]].
* Date published. <code>published</code>. optional. 1 or more. [[datetime-design-pattern]].
* Photo(s). <code>photo</code>. optional. 1 or more. img or url. [[hcard].
* Ingredients. <code>ingredients</code>. required. text with optional valid HTML markup or 1 or more <code>ingredient</code> elements.
** Ingredient. <code>ingredient</code>. optional. 1 or more.
*** Quantity. <code>num</code>, <code>unit</code> and <code>item</code>. optional. [[measure]].
*** Note. <code>note</code>. optional. text. [[hcard].
* Method. <code>method</code>. optional. text with optional valid HTML markup.
* Yield. <code>yield</code>. optional. text.
* Preparation time. <code>preparation-time</code>. 1 or more, optional. (see [[ISO-31-1]] duration brainstorming)
** Note. <code>note</code>. optional. text. [[hcard].
* Tags. <code>tag</code>. optional. 1 or more. [[rel-tag]].
* Nutrition. <code>nutrition</code>. optional. 1 or more.
** Quantity. <code>num</code>, <code>unit</code> and <code>item</code>. optional. [[measure]].

===Field Details===

'''Title''': The title of the recipe.
* The element is identified by class name <code>recipe-title</code>.
* A Recipe {{must}} have a <code>recipe-title</code>

'''Summary''': The summary provides a short introduction or an accompanying statement about the recipe.
* The element is identified by class name <code>recipe-summary</code>.
* A Recipe {{may}} have a <code>recipe-summary</code>.

'''Author''': Author the person who authored the recipe.
* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include an <code>author</code>.
* The contents of the element {{must}} include a valid [[hCard]].

'''Date published''': The date the recipe was published.
* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* {{should}} (?) use the [[datetime-design-pattern]] to encode the published datetime.

'''Photo''': Accompanying image.
* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <code><img></code> element.
* The element {{may}} use any other element that contains a URL, such as <code><a></code> or <code><object></code>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].

'''Ingredients''': Describes the ingredients used in the recipe.
* The element is identified by the class name <code>ingredients</code>.
* A Recipe {{must}} include one <code>ingredients</code> element.
* The field {{may}} include valid HTML markup (e.g. paragraphs).
* The element {{may}} include 1 or more <code>ingredient</code> elements.

'''Ingredient''': Describes one ingredient used in the recipe.
* The element is identified by the class name <code>ingredient</code>.
* It {{must}} only occur within an <code>ingredients</code> element.
* A Recipe {{may}} have one or more <code>ingredient</code>s.
* The element {{may}} include the fields <code>num</code>, <code>unit</code> and <code>item</code> following [[measure]].
* The element {{may}} include a <code>note</code>.

'''Note''': A note concerning an Ingredient or a Preparation Time element (for element Preparation Time see below).
* The element is identified by the class name <code>note</code>.
* Ingredients and Preparation Time elements {{may}} include a <code>note</code>.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].

'''Method''': The method of the recipe.
* The element is identified by the class name <code>method</code>.
* A Recipe {{may}} include a <code>method</code>.
* The field {{may}} include valid HTML markup (e.g. paragraphs).

'''Yield''': Specifies the quantity produced by the recipe.
* The element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

'''Preparation Time''': The time it takes to prepare the meal described by the recipe.
* The element is identified by the class name <code>preparation-time</code>.
* A Recipe {{may}} include one or more <code>preparation-time</code>s.
* Each Preparation Time element {{may}} include a <code>note</code>, to specify their respective purpose.

'''Nutrition''':
* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <code>num</code>, <code>unit</code> and <code>item</code> following [[measure]].

===Example===

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes,
hard cooking.

<ul class="method">
<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>
Enough for 12 children.
Preparation time is approximately
90
<abbr class="unit" title="minutes">min</abbr>.

Add
5
<abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>

== related pages ==
* [[recipe]]
* [[recipe-examples]]
* [[recipe-brainstorming]]
* [[recipe-formats]]
* [[recipe-issues]]

recipe-brainstorming

2009-07-09T12:49:23Z

ThomasLoertsch: moved format-in-progress-#2 to the brainstorming-archive

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)

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

hrecipe

2009-07-08T12:03:15Z

ThomasLoertsch: changed version to 0.22 because of modifications to the proposed design pattern for datetime formatting

<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'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-08T11:48:40Z

ThomasLoertsch: /* Examples */ changed published and duration to value-class-pattern

<entry-title>hRecipe 0.21</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.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 ;-)
* 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) .

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

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-08T10:17:17Z

ThomasLoertsch: /* duration */ rewording

<entry-title>hRecipe 0.21</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.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 ;-)
* 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) .

=== 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 <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-08T10:16:02Z

ThomasLoertsch: /* published */ changed encoding of published date to value-class-pattern

<entry-title>hRecipe 0.21</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 be "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.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 ;-)
* 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) .

=== 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 <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-08T10:03:16Z

ThomasLoertsch: /* fn */ some rewording for easier reading

<entry-title>hRecipe 0.21</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 be "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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<source lang=html4strict>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></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.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 ;-)
* 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) .

=== 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 <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-08T10:00:04Z

ThomasLoertsch: /* duration */ referring to the value-class-pattern now (instead of hAtom/ABBR)

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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 be "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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<source lang=html4strict>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></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.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 ;-)
* 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) .

=== 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 <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-issues

2009-07-02T15:13:08Z

ThomasLoertsch: /* issues */ corrected typo

== issues ==
Please add new issues to the '''bottom''' of this section by copy and pasting the [[hrecipe-issues#template|Template]]. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

<div class="vevent">
* {{OpenIssue}} 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* '''"num" and "unit"'''. I only recently discovered the properties "type" and "value" from 'hCard'. I'll replace "num" and "unit" from the unfinished 'measure' with them.
** The decision to replace "num", "unit", and "item" with "type" and "value" needs further explanation. Was it due to the fact that measure is unfinished? If so I think leaving "ingredient" and "nutrition" as text strings until measure is finished would be a better idea. The transition from "type"/"value" to measure will be difficult at a later point and I believe measure is more appropriate than re-using hCard. [[User:Yde|Yde]] 11:46, 23 January 2009 (UTC)
*** The proposal to replace "num", "unit", and "item" with "type" and "value" has several reasons: first, i only recently thoroughly and systematically investgated other formats and that's when i found "type" and "value". They have a semantic advantage in that they may be more suitable for cases like value:"2"/type:"eggs" or value:"1/2"/type:"spoonfull" which are rather informal ways of putting measures, at least do not lend themselves easily to formal specification. Another reason is that these terms come from a comparably very stable vocabulary, while measure has not even draft status. It would be perfectly okay for measure to change attribute names, semantics or even the whole structure of the vocabulary. Although it doesn't look like that measure will (have to) do that I'd prefer to stay on the safe side, especially since we might even gain semantic advantage. [[User:ThomasLoertsch|ThomasLoertsch]] 19:43, 23 January 2009 (UTC)
**** I'm still not sure this is the right decision. 1) I don't think the semantic meaning of hCard's "type"/"value" is exactly equivalent to measure's "num"/"unit"/"item". From the [[hcard-profile]]: "Value: This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property." So what is the actual value of an ingredient? Is it the name of the ingredient or is the quantity? 2) This is ''exactly'' what [[measure]] is for. The advantage of being able to convert measures would IMO be one of the gratest advantages of hRecipe. I don't see why value:"2"/type:"eggs" is better than num:"2"/item:"eggs"? I agree that cases like value:"1/2"/type:"spoonfull" is problematic, but that's a [[measure]] issue. 3) Many [[recipe-formats]] use quantity/unit/item.
***** Measurements are rather informal in recipes and therefor the type/value pair seems quite appropriate to me. Automatic translation is out of scope. Anyway for a good enough machine translation of a recipe the markup of the ingredients won't be the main hurdle. Standardizing the informal quantities would be a requirement for such an effort. I made some suggestions for a vocabulary of most used "units" like cups, teespoonfulls etc a few months ago but no one reacted. So I dropped it.
***** But we're moving in circles. You are making valid points too. One reason I decided this way is that it's more inline with other decisions like reusing "fn". Since not all the shortcomings of microformats can be solved within hRecipe and since there has been no interest in discussing them here I decided to go the way of least resistance and stick with the customs of compactness, reuse and rather lax interpretation of semantic constraints. IMO hRecipe is now consistent with the genereal microformats approach and neither necessitates nor hinders a general redesign of microformats (which I think would be a good thing). --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
**** Proposed resolution: keep "ingredient" as a text string like "yield" - which would also benefit from a measure format - until such a format is ready. [[User:Yde|Yde]] 10:23, 15 February 2009 (UTC)
***** I opened this issue again and marked the subproperty 'value' and 'type' of ingredient as ''experimental''. This should leave enough room to discuss this issue further. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Too many properties.''' From reviewing the [[recipe-examples]], it does not appear that the schema implied by the examples justify the number of properties in hRecipe, especially for a first draft. microformats should start as small as possible (even smaller), and in this regard I believe several improvements could be made. There is one obvious example of recipe-title vs recipe-summary, but it looks like there may be more. Would appreciate feedback from folks who add hRecipe to the recipes on the web regarding which properties they ended up not using.
#* It is not necessarily helpful to constrain a vocabulary by all means. hCard and hCalender are examples for too large vocabularies (which mostly stems from the approach taken of converting an existing vocab 1:1) which are not as easily usable as one would wish. But to be useful a vocabluary should encompass 80:20 of the usecases, otherwise it may well not be worth the burden of implementation. We better try to hit that sweet spot right from the start - since otherwise, how should hRecipe get traction in the wild. All of the proposed properties are used on big recipe sites (many 'user generated content' sites among them) on the web. Please provide more arguments which properties you specifically think are superfluous. The only concrete example you give is to replace title by summary (which I think is a bad idea). [[User:ThomasLoertsch|ThomasLoertsch]]
#* Version 0.2 (and a little more so 0.21) has marked all but the most essential properties as ''experimental''. There use is not at all discouraged but implementors are warned that these properties may be removed from later version if they aren't used in real world applications. This uptake by implementors should be observed and studied before a final descision is made. A proposed timeframe would be at least a few months, maybe even a year or two, depending on how many implemetations surface in the meantime. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
#* I checked the usage of the hRecipe format today and was delighted to see that Yahoo! searchmonkey lists 56.000 of them (search Yahoo for "searchmonkey:com.yahoo.page.uf.recipe"). The site I work for is responsible for about 12.000 of them but when i checked the first 70 results none of them was from our site :-) In fact they almost all came from personal sites, blogs and the like and this is really great! It was also very interesting to see that a lot of them came from WordPress Blogs which shows that the WordPress Plugin for hRecipe is very useful. But back to the issue: I checked the first 60 or so results and about 2/3 of them where really using hRecipe. 17 of them were from different sites(*) (**).

It's never bad to gather some empirical data to make an informed decision, so I took the burden to count element use. Actually this didn't take much more then an hour, so if somebody wants to check the results from 61 to ... feel free! Well, now, without futher ado, the results:
<pre>
16 fn
17 ingredient (3 value, 3 type)
3 yield
15 instructions
3 duration
4 photo
9 summary
4 author
3 published
1 nutrition (0 value, 0 type)
2 tag
</pre>
Of course this is not representative, but it gives a fairly good impression. If you add our site (or 20% of all published hRecipes ;) you can add +1 to all elements since we use everything...

Evaluation:

"fn", "ingredient" and "instructions" are no-brainers. Also "summary" is surprisingly strong and the intuition, that it's a strong part of how people communicate on recipes, seems to be right.

"author" and "published" probably didn't get so much used because on a blog they are provided anyway and most of the sites investigated were blogs. OTOH they aren't important for the functionality of a recipe and can be added by other means. So maybe they should be removed for the sake of terseness.

"photo" was definitely less used than there were photos added to recipes. And I know a lot of people who, when showed 2 recipes, one with and one without photo, almost certainly choose the one with photo. So IMHO it should stay.

"yield" was used surprisingly seldomly. Isn't it an essential addition to the ingredients list? Maybe the yield is often self-explanatory, maybe this reflects the fact, that also the value and type of ingredients wasn't marked up most of the time. 'Smallishness' would certainly suggest to omit all the three: "value", "type" and yield". People seem to feel that the "ingredient" field naturally holds information not only about the name of the ingredient but about type and value too and don't bother to mark these up explicitely. Again for big sites which generate their content from databases the cost-benefit ratio is totally different...

"duration" would be a candidate for removal as well. But still, remeber that this list only reflects usage of the elements. An information of duration was part of the recipe more often than it was marked up as such.

"tag" obviously didn't get used much and is maybe strong enough on it's own. People add tags no matter if they are part of a vocabulary, and the rel-tag pattern is certainly easy enough to grasp and straightforward to implement.
But the WordPress plugin added a tagging vocabulary on it's own (how dare they... ;-) which did get used most of the time. So tagging principally is strong. Well, I still don't have a clue on this one.

"nutrition" is definitely a candidate for removal, maybe into it's own vocabulary. OTOH, big commercially backed sites very often provide nutritional information and when provided it is a much more integral part of the information context than say the author. So maybe it should stay?
The full result-set, including URLs:
<pre>
fn ingredient v t yield instructions duration photo summary author published nutrition v t tag
http://nissasham.blog.com/
x x x x x x
http://reciperiot.blog.com/
x x x
http://www.greenworld365.com/twice-baked-buttermilk-potatoes/
x x
http://peachquilting.com/2009/04/beef-with-garlic-potatoes/ (wordpress plugin)
x x x x
http://fivepennynicole.com/blog/2008/10/29/world-series-caramel-corn/ (wordpress plugin)
x x x x x x x
http://www.theslowcook.com/2009/04/23/shrimp-stir-fry/ (wordpress plugin)
x x x
http://bitten.blogs.nytimes.com/2009/01/29/addictive-mac-and-cheese/ well ... very freestyle
x x x x
http://au.food.yahoo.com/recipes/recipe/-/5346170/baked-chicken-ravioli/
x x x x
http://humblegourmand.com/recipes/grovestand-lemon-cupcakes/
x x x x x x x
http://www.f00die.com/
x x x x
http://www.thebarkersworld.com/ (wordpress plugin)
x x x x
http://www.murraywilliams.com/cooking/souffle.html
x x x x
http://cookingwithbooze.org/beer/beer-brats/
x x x x
http://itsripe.com/recipes/11-kale-smoothie
x x x x x x x x x x
http://xavierroy.com/blog/chicken-legs-in-lemon-basil-mustard-sauce
x x x x x x x x x
http://www.f00die.com/2008/06/17/hobo-potatoes-w-arugula/
x x x x x
http://www.todayonpei.com/?p=5420
x x x
</pre>

(*) well, more of them, I skipped some WordPress Blogs since they all came from the same Plugin. But as the feature set of the Plugin continues to grow it doesn't make much sense to investigate them too thoroughly now unless you want to take into account which version of the plugin was used exactly etc etc - an undertaking I'm not really up to ;-)

(**) I felt quite bad when I saw that a lot of them used the pre-0.2 version with "title", "method" etc but I really don't know what I could do about it now (or then, too). I guess these decisions are made and the pain will diminish over time (cough).
--[[User:ThomasLoertsch|ThomasLoertsch]] 17:36, 17 June 2009 (UTC)
</div>
</div>

<div class="hentry">
{{OpenIssue}} 2009-07-01 raised by [[User:BenWard|BenWard]]
<div class="entry-content discussion issues">
* Reconsidering semantic of <code>published</code> over ‘<code>created</code>’. I think the reuse of <code>published</code> from [[hAtom]] may be incorrect. Given its use in hAtom, <code>published</code> represents the date and time that the content was originally published to the page. In the case of a recipe, it seems that you would instead want to represent the date that the recipe was authored/created, which is subtly different. The publication of a recipe on a web page is something that should be done with hAtom itself (publishing an <code>hEntry</code> that contains the recipe), but the recipe itself would contain the date that ''the recipe itself'' was created. e.g. <samp>I came up with this recipe for mashed potato in last summer</samp>. I'm totally open to ideas about this, but my feeling is that it's unnecessary to represent the publication date since that should be represented by a complete hAtom entry. Do we think that <code>created</code> as described here falls inside the 80:20?
** I agree with your interpretation of "published" versus "created". "published" is not used very often on it's own (see above) and I'm sure "created" would be used much less so - because it often is very difficult to determine when a recipe was created, when it was modified enough to count as newly created, from where (and when) it originated etc. IMO "published" MAY be out of the 80:20, but "created" certainly IS. You raise a point though that I'm thinking heavily about right now. I'm pondering if it would be wise to move most of the properties that are currently marked as "experimental" out of the draft and refer to them only (but explicitly) as possibly useful additions to a hRecipe. I would then add hReview as well and, from the 'experimental' properties, only leave "Nutrition" within the property set of hRecipe. But I need to think about that a little more. Anyway: I think your point is valid but should be part of a broader approach. --[[User:ThomasLoertsch|ThomasLoertsch]] 15:09, 2 July 2009 (UTC)
</div>
</div>

== resolved issues ==
<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description">
*# '''author is re-used from hAtom not hCard'''. minor issue. the "author" property is actually re-used from [[hAtom]] rather than hCard - hCard has no such property.
*#* Yikes! Corrected... [[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}}2008-01-17 raised by [[User:Yde|Yde]]
<div class="description">
* '''method'''. Would it make sense to [[reuse]] [[hreview|hReview's]] "description" instead of hRecipe's "method" or is this stretching the semantics too far?
** I just discovered that hCalender uses "method", and with totally different semantics. So I guess we MUST change it. I'm not very happy with "description" though - that's a very unspecific term. Maybe "instructions", or "steps", or "preparation" , or "procedure"? They are all 'available'. I like "instructions" most, but since I'm not a native speaker I'm hesitant. Maybe the semantics are too different? Maybe "preparation" is better since we already almost have it (or had it - see the discussion about "preparation-time" -> "duration" above)? [[User:ThomasLoertsch|ThomasLoertsch]] 12:24, 21 January 2009 (UTC)
** Since no further comments surfaced I'll change the property name to "instructions". I think it's a fairly unambiguous name which also can easily be reused in other formats. [[User:ThomasLoertsch|ThomasLoertsch]] 14:30, 2 Febuary 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Unnecessary recipe prefixing of summary property.''' Note: this is a re-opening of an issue from [[recipe-issues]]. The usage of summary in recipes appears to be very similar to that used for events. Rephrased, insufficient (if any?) evidence has been provided that summary means anything "special" enough (distinguishing it from the generic term "summary" as used in microformats) in the context of recipes to merit prefixing and thus a new property.
#* proposed resolution: Re-use generic "summary" property rather than introducing a recipe microformat scoped "recipe-summary" property.
#* I agree principally but there are different "summary"s around: The [[hReview]]-Draft specifies a summary as "This optional field serves as a title for the review itself" while the [[hCalendar]] Draft refers to RFC 2445 which defines summary as "This property defines a short summary or subject for the calendar component". I certainly agree more with the semantics from RFC 2445 but referring to either of the two doesn't make much sense right now. Since you are editor of both hReview and hCalendar maybe you can clarify the subject? If hReview would be aligned with RFC 2445 then I would promote dropping the prefix.[[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
#** Agreed, the definitions of "summary" across hCalendar and hReview could be better converged. Please add this as an issue to both [[hcalendar-issues]] and [[hreview-issues]] and I'll follow-up there accordingly. Given that is the path forward, let's fix this immediately in hRecipe now that the issue (and resolution) has been captured. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Will change "recipe-summary" to "summary" as defined in hCalender/RFC2445. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''preparation-time could re-use duration instead''' - it appears that the "preparation-time" semantic basically means the "duration" of the recipe, and thus could re-use that property from [[hCalendar]] rather than introducing a new property name.
#* proposed resolution: change "preparation-time" to "duration" and note re-use from [[hCalendar]] - or at least document how preparation-time is a different enough semantic from "duration" to justify the introduction of a new term.
#* One difference is that hCalendar ''duration'' is a singular property whereas hRecipe's ''preparation-time'' is plural. Also, ''preparation-time'' will often (typically) use value+note subproperties, while ''duration'' will usually be an ISO 8601 duration. [[User:TobyInk|TobyInk]] 20:32, 29 December 2008 (UTC)
#** Plurality is a contextual aspect and does not alter the semantic of the underlying property, thus is insufficient justification for introducing a new term. We do not duplicates of each property in a singular and plural form. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Syntax differences (value+note vs ISO 8601) are also insufficient to justify the introduction of a new property for the same semantic. Rather, it is better to expand the syntax of the existing property, e.g. perhaps using the [[value-excerption-pattern]] and to note that explicitly. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Semantically the reuse of "duration" is okay. RFC 2445 permits multiple duration values "if the property permits" so that should be fine too. If the syntactic differences can be worked out the way Tantek suggests above than it's okay with me to re-use "duration". I'm just not sure if it helps usability to overload properties in such a way but that ay be another discussion on it's own. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** The observation that preparation-time uses a nested "note" subproperty may actually reveal a problem with that approach itself, that is, perhaps instead of "preparation-time" with "value" and "note" subproperties, it may be better to refactor it as a "preparation" (an act thereof) with "duration" and "note" subproperties. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Removed the sub-property "note" from the v_0.2 draft format since I now agree that it looks a little overengineered. [[User:ThomasLoertsch|ThomasLoertsch]] 12:47, 22 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''issues too long''' 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
As threatened 2 weeks ago I heavily re-edited this page because discussions had become a little frayed (and heated at soem points). Have a look at the [http://microformats.org/wiki/index.php?title=hrecipe-issues&oldid=37788 previous version] for the full debate and feel free to re-edit this page if you find that I axed it too much. [[User:ThomasLoertsch|ThomasLoertsch]] 14:47, 2 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''new draft'''2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* The following is a proposal for draft 0.2, reflecting the issues discussed so far. "recipe-title" is replaced with "fn" from hCard (although I'm not convinced that this is a good idea), "recipe-summary" with "summary", "num" and "unit" from the unfinished 'measure' with "type" and "value" from 'hCard' (i only recently discovered them...), "method" (wihch is already used by [[hCalendar]] with "instructions", "preparation-time" with "duration". Two "note"s are deleted for brevity. "summary", "nutrition", "author", "published" and "photo" are marked as 'experimental', meaning that they may be removed from future drafts or the final specification, depending on experience and feedback from implementations :
</div>

=== '''hrecipe'''. Proposal for Draft 0.2 ===

* '''fn'''. the name of the recipe. required. text. re-used from [[hCard]]
* '''ingredient''' required. 1 or more. text with optional valid (x)HTML markup.
** '''value''' and '''type'''. optional. re-used from [[hCard]].
* '''yield'''. optional. text.
* '''instructions'''. optional. text with optional valid (x)HTML markup.
* '''duration'''. optional. 1 or more. text (see [[ISO-31-1]] duration brainstorming). re-used from [[hCalendar]].
* '''''summary'''''. optional. text. re-used from [[hCalendar]]. [ ''experimental'' ]
* '''''nutrition'''''. optional. 1 or more. [ ''experimental'' ].
** '''''value''''' and '''''type'''''. optional. re-used from [[hCard]]. [ ''experimental'' ].
* '''''author'''''. optional. 1 or more. re-used from [[hAtom]] using [[hCard]]. [ ''experimental'' ].
* '''''published'''''. optional. re-used from [[hAtom]]. [ ''experimental'' ].
* '''''photo'''''. optional. 1 or more. using any element containing a URL, such as IMG. re-used from [[hCard]]. [ ''experimental'' ].
* '''''tag'''''. optional. 1 or more. [ ''experimental'' ].
--[[User:ThomasLoertsch|ThomasLoertsch]] 11:01, 10 February 2009 (UTC)
</div>

== closed issues ==

<div class="vevent">
* {{ClosedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]] in the context of issue '''Too many properties'''
<div class="description discussion issues">
# '''Drop "recipe-title".''' In reviewing the examples, few (if any?) include *both* a title and a summary, and in practice the semantics of usage in the context of recipes appears to be virtually indistinguishable. Therefore we don't need both, and following in the pattern provided by [[hCalendar]] (which got it from [[RFC2445]]), we should keep the more generic concept of a "summary" and drop the concept of "title" from hRecipe.
#* I tend to agree. There are definitely use cases for both "recipe-title/title/fn" and "recipe-summary/summary" - e.g. "[http://www.simonwheatley.co.uk/2006/03/26/a-moroccan-ish-casserole/ A Moroccan-ish Casserole]" sounds more like a summary while "[http://blog.bumblepuppy.org.uk/2006/10/05/spaghetti-primavera/ Spaghetti primavera]" is the full name or the title of the recipe. But the problem is, they would serve the same purpose. [[User:Yde|Yde]] 10:07, 17 January 2009 (UTC)
#** Title and summary are different things and they are used differently in the real world. The examples you give are both names/titles/labels/headings, although more or less descriptive. They are short, memorable and make the thing adressable by humans. A summary can be (and mostly is) much longer and serves a different purpose: it describes essential properties of the object at hand, eg: "this is easy and fast to prepare, but still looks impressive", "easy, tasty, fast, vegan, good on cold days" or "the kids loved this last summer, but the ingredients can be hard to get" or "whenever i cook this i start to dream of ..." [[User:ThomasLoertsch|ThomasLoertsch]] 14:25, 20 January 2009 (UTC)
#*** Right, on second thought, I believe "title/name" and "summary" are different things. [[User:Yde|Yde]] 11:22, 23 January 2009 (UTC)
#* The term "title" has been so horribly overloaded across formats, vocabularies that it is nearly meaningless and for that reason should be avoided in any/all format efforts, preferring instead something more semantically specific such as "fn" (meaning full/formatted name of an item) or "summary" (when items are labeled more often with a short description/explanation rather than a name). [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Synonyms and homonyms are part of the real world - we have to cope with them. Also the word "title" is not horribly overloaded, you're exaggerating here. It just happened that hCard were the first to use it, and in a way that's empirically much less important then the use of "title" as the heading of a resource. Still the real problem is that Microformats have only one namespace and no resolution mechanism for conflicts like this, beside "first come first served". [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** Maybe it would be better to make a clear cut with some of the sins of the past and deprecate some terms in hCard / hCalendar[[User:ThomasLoertsch|ThomasLoertsch]] 15:30, 3 February 2009 (UTC)
#* "fn" is [[existing-classes|defined]] as "the name of the object" which is pretty much what "recipe-title" means right now. So, whether we chose to keep this property, summary, or both, renaming "recipe-title" to "fn" would make sense. [[User:Yde|Yde]] 23:03, 16 January 2009 (UTC)
#** the definition of "fn" in [[existing-classes|existing classes]] is maybe a little too short. "fn" is defined in hCard which is a reformulation of RFC 2462, which says: "Type name:FN - Type purpose: To specify the formatted text corresponding to the name of the object the vCard represents. -Type special notes: This type is based on the semantics of the X.520 Common Name attribute. The property MUST be present in the vCard object. - Type example: 'FN:Mr. John Q. Public\, Esq.'" (http://www.ietf.org/rfc/rfc2426.txt, on page 8). That clearly means a name of a person or an institution. Institution equals a juristical person, so "fn" semantically boils down to 'name of a person'. I wouldn't use that for every object. [[User:ThomasLoertsch|ThomasLoertsch]] 14:03, 20 January 2009 (UTC)
#*** Thanks for the clarification. "fn" is definitely not a good idea. [[User:Yde|Yde]] 10:00, 23 January 2009 (UTC)
#*** <code>fn</code> is already reused more generically in hAudio, hReview and hListing (for items). The definition of use within microformats has already been adapted from the strict vcard interpretation in prior work. --[[User:BenWard|BenWard]] 23:04, 27 January 2009 (UTC)
#**** I see. I can't help but thinking: what a mess... What's the family name of a recipe, audio-recording or list-entry? What's the point of re-using a semantically totally void two-letter-acronym, when it doesn't even fit very well? What's the point of reusing an element when I have to lookup the meaning of it every time anyway? [[User:ThomasLoertsch|ThomasLoertsch]] 00:48, 28 January 2009 (UTC)
#***** <code>fn</code> is ''formatted''-name, not ‘family’. ‘Name as presented’, ‘display name’. I agree that <code>fn</code> takes a double glance when you're learning, but it's there and the reuse in other specs is consistent; there's a much stronger author benefit in building on common equivalent-semantic vocabulary than introducing synonyms, which I think will cause more confusion. Better to have a strong spec with common vocabulary than introduce duplication. I'll keep in mind that we should better emphasise the expansion of <code>fn</code> in all specs for benefit of new authors. I can see how ‘family name’ is a muddle too easily made in hCard. --[[User:BenWard|BenWard]] 07:01, 28 January 2009 (UTC)
#****** I was referring to the fact that a name of a natural or juridical person is semantically quite different to the name of an object. Other things like the opacity of the two-letter-code "fn" are indeed problematic too but not my main issue here. That vCard-legacy seems to be lurking around every corner. Why not make a clear cut and deprecate the problematic parts like "title" and "fn"? The approach to rather overload the semantics (and the property-constraints) just to keep element-count low only takes that far. In the end it hinders usability instead of improving it. I think [[reuse]] and [[naming-principles]] don't strike the right balance in that respect. [[User:ThomasLoertsch|ThomasLoertsch]] 11:45, 28 January 2009 (UTC)
#* why not define a property "name"?! From my understanding of the english language (I'm not a native speaker) "name" is semantically generic enough to serve as a substitute for "title". Defining it rather broadly as "designation or title or denominator or heading of an item" would make it easily reusable. Plus we would have to explicitely discourage it's use for naming real or juristical persons and point to "fn" instead. [[User:ThomasLoertsch|ThomasLoertsch]] 12:21, 21 January 2009 (UTC)
#** Hmmm. I would really like to get feedback on this... Again my argumentation:
#*** <code>title</code> would be the best solution but is already "taken". Depercating some of hCalenders sins would be the best solution but seems out of reach so far.
#*** <code>heading</code> would be a possible solution either but seems more suited for prose
#*** <code>name</code> gets the semantics quite well, especially in the case of recipes which are more a "thing" or abstract conceptualization than a work of literature/science/prose
#*** <code>fn</code> with it's subproperties is geared towards natural and juristical persons, which are quite different from things and concepts. Also semantics of the term "fn" are rather opaque, even misleading, which hinder it's usability.
#** Therefor I'd love "title", could live very well with "name", could live still well with "heading" and would sleep bad (but sleep) with "fn". [[User:ThomasLoertsch|ThomasLoertsch]] 16:30, 2 Febuary 2009 (UTC)
#** Okay, since there's no response I bow my head to "fn". But it speaks for itself that it's the only tag that has to be explained in the schema. [[User:ThomasLoertsch|ThomasLoertsch]] 11:15, 10 February 2009 (UTC)
</div>
</div>

===template===
{{issues-format}}

==related pages==
* [[hRecipe]]
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-issues

2009-07-02T15:09:27Z

ThomasLoertsch: /* issues */ re: published

== issues ==
Please add new issues to the '''bottom''' of this section by copy and pasting the [[hrecipe-issues#template|Template]]. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

<div class="vevent">
* {{OpenIssue}} 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* '''"num" and "unit"'''. I only recently discovered the properties "type" and "value" from 'hCard'. I'll replace "num" and "unit" from the unfinished 'measure' with them.
** The decision to replace "num", "unit", and "item" with "type" and "value" needs further explanation. Was it due to the fact that measure is unfinished? If so I think leaving "ingredient" and "nutrition" as text strings until measure is finished would be a better idea. The transition from "type"/"value" to measure will be difficult at a later point and I believe measure is more appropriate than re-using hCard. [[User:Yde|Yde]] 11:46, 23 January 2009 (UTC)
*** The proposal to replace "num", "unit", and "item" with "type" and "value" has several reasons: first, i only recently thoroughly and systematically investgated other formats and that's when i found "type" and "value". They have a semantic advantage in that they may be more suitable for cases like value:"2"/type:"eggs" or value:"1/2"/type:"spoonfull" which are rather informal ways of putting measures, at least do not lend themselves easily to formal specification. Another reason is that these terms come from a comparably very stable vocabulary, while measure has not even draft status. It would be perfectly okay for measure to change attribute names, semantics or even the whole structure of the vocabulary. Although it doesn't look like that measure will (have to) do that I'd prefer to stay on the safe side, especially since we might even gain semantic advantage. [[User:ThomasLoertsch|ThomasLoertsch]] 19:43, 23 January 2009 (UTC)
**** I'm still not sure this is the right decision. 1) I don't think the semantic meaning of hCard's "type"/"value" is exactly equivalent to measure's "num"/"unit"/"item". From the [[hcard-profile]]: "Value: This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property." So what is the actual value of an ingredient? Is it the name of the ingredient or is the quantity? 2) This is ''exactly'' what [[measure]] is for. The advantage of being able to convert measures would IMO be one of the gratest advantages of hRecipe. I don't see why value:"2"/type:"eggs" is better than num:"2"/item:"eggs"? I agree that cases like value:"1/2"/type:"spoonfull" is problematic, but that's a [[measure]] issue. 3) Many [[recipe-formats]] use quantity/unit/item.
***** Measurements are rather informal in recipes and therefor the type/value pair seems quite appropriate to me. Automatic translation is out of scope. Anyway for a good enough machine translation of a recipe the markup of the ingredients won't be the main hurdle. Standardizing the informal quantities would be a requirement for such an effort. I made some suggestions for a vocabulary of most used "units" like cups, teespoonfulls etc a few months ago but no one reacted. So I dropped it.
***** But we're moving in circles. You are making valid points too. One reason I decided this way is that it's more inline with other decisions like reusing "fn". Since not all the shortcomings of microformats can be solved within hRecipe and since there has been no interest in discussing them here I decided to go the way of least resistance and stick with the customs of compactness, reuse and rather lax interpretation of semantic constraints. IMO hRecipe is now consistent with the genereal microformats approach and neither necessitates nor hinders a general redesign of microformats (which I think would be a good thing). --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
**** Proposed resolution: keep "ingredient" as a text string like "yield" - which would also benefit from a measure format - until such a format is ready. [[User:Yde|Yde]] 10:23, 15 February 2009 (UTC)
***** I opened this issue again and marked the subproperty 'value' and 'type' of ingredient as ''experimental''. This should leave enough room to discuss this issue further. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Too many properties.''' From reviewing the [[recipe-examples]], it does not appear that the schema implied by the examples justify the number of properties in hRecipe, especially for a first draft. microformats should start as small as possible (even smaller), and in this regard I believe several improvements could be made. There is one obvious example of recipe-title vs recipe-summary, but it looks like there may be more. Would appreciate feedback from folks who add hRecipe to the recipes on the web regarding which properties they ended up not using.
#* It is not necessarily helpful to constrain a vocabulary by all means. hCard and hCalender are examples for too large vocabularies (which mostly stems from the approach taken of converting an existing vocab 1:1) which are not as easily usable as one would wish. But to be useful a vocabluary should encompass 80:20 of the usecases, otherwise it may well not be worth the burden of implementation. We better try to hit that sweet spot right from the start - since otherwise, how should hRecipe get traction in the wild. All of the proposed properties are used on big recipe sites (many 'user generated content' sites among them) on the web. Please provide more arguments which properties you specifically think are superfluous. The only concrete example you give is to replace title by summary (which I think is a bad idea). [[User:ThomasLoertsch|ThomasLoertsch]]
#* Version 0.2 (and a little more so 0.21) has marked all but the most essential properties as ''experimental''. There use is not at all discouraged but implementors are warned that these properties may be removed from later version if they aren't used in real world applications. This uptake by implementors should be observed and studied before a final descision is made. A proposed timeframe would be at least a few months, maybe even a year or two, depending on how many implemetations surface in the meantime. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
#* I checked the usage of the hRecipe format today and was delighted to see that Yahoo! searchmonkey lists 56.000 of them (search Yahoo for "searchmonkey:com.yahoo.page.uf.recipe"). The site I work for is responsible for about 12.000 of them but when i checked the first 70 results none of them was from our site :-) In fact they almost all came from personal sites, blogs and the like and this is really great! It was also very interesting to see that a lot of them came from WordPress Blogs which shows that the WordPress Plugin for hRecipe is very useful. But back to the issue: I checked the first 60 or so results and about 2/3 of them where really using hRecipe. 17 of them were from different sites(*) (**).

It's never bad to gather some empirical data to make an informed decision, so I took the burden to count element use. Actually this didn't take much more then an hour, so if somebody wants to check the results from 61 to ... feel free! Well, now, without futher ado, the results:
<pre>
16 fn
17 ingredient (3 value, 3 type)
3 yield
15 instructions
3 duration
4 photo
9 summary
4 author
3 published
1 nutrition (0 value, 0 type)
2 tag
</pre>
Of course this is not representative, but it gives a fairly good impression. If you add our site (or 20% of all published hRecipes ;) you can add +1 to all elements since we use everything...

Evaluation:

"fn", "ingredient" and "instructions" are no-brainers. Also "summary" is surprisingly strong and the intuition, that it's a strong part of how people communicate on recipes, seems to be right.

"author" and "published" probably didn't get so much used because on a blog they are provided anyway and most of the sites investigated were blogs. OTOH they aren't important for the functionality of a recipe and can be added by other means. So maybe they should be removed for the sake of terseness.

"photo" was definitely less used than there were photos added to recipes. And I know a lot of people who, when showed 2 recipes, one with and one without photo, almost certainly choose the one with photo. So IMHO it should stay.

"yield" was used surprisingly seldomly. Isn't it an essential addition to the ingredients list? Maybe the yield is often self-explanatory, maybe this reflects the fact, that also the value and type of ingredients wasn't marked up most of the time. 'Smallishness' would certainly suggest to omit all the three: "value", "type" and yield". People seem to feel that the "ingredient" field naturally holds information not only about the name of the ingredient but about type and value too and don't bother to mark these up explicitely. Again for big sites which generate their content from databases the cost-usage relation is totally different...

"duration" would be a candidate for removal as well. But still, remeber that this list only reflects usage of the elements. An information of duration was part of the recipe more often than it was marked up as such.

"tag" obviously didn't get used much and is maybe strong enough on it's own. People add tags no matter if they are part of a vocabulary, and the rel-tag pattern is certainly easy enough to grasp and straightforward to implement.
But the WordPress plugin added a tagging vocabulary on it's own (how dare they... ;-) which did get used most of the time. So tagging principally is strong. Well, I still don't have a clue on this one.

"nutrition" is definitely a candidate for removal, maybe into it's own vocabulary. OTOH, big commercially backed sites very often provide nutritional information and when provided it is a much more integral part of the information context than say the author. So maybe it should stay?
The full result-set, including URLs:
<pre>
fn ingredient v t yield instructions duration photo summary author published nutrition v t tag
http://nissasham.blog.com/
x x x x x x
http://reciperiot.blog.com/
x x x
http://www.greenworld365.com/twice-baked-buttermilk-potatoes/
x x
http://peachquilting.com/2009/04/beef-with-garlic-potatoes/ (wordpress plugin)
x x x x
http://fivepennynicole.com/blog/2008/10/29/world-series-caramel-corn/ (wordpress plugin)
x x x x x x x
http://www.theslowcook.com/2009/04/23/shrimp-stir-fry/ (wordpress plugin)
x x x
http://bitten.blogs.nytimes.com/2009/01/29/addictive-mac-and-cheese/ well ... very freestyle
x x x x
http://au.food.yahoo.com/recipes/recipe/-/5346170/baked-chicken-ravioli/
x x x x
http://humblegourmand.com/recipes/grovestand-lemon-cupcakes/
x x x x x x x
http://www.f00die.com/
x x x x
http://www.thebarkersworld.com/ (wordpress plugin)
x x x x
http://www.murraywilliams.com/cooking/souffle.html
x x x x
http://cookingwithbooze.org/beer/beer-brats/
x x x x
http://itsripe.com/recipes/11-kale-smoothie
x x x x x x x x x x
http://xavierroy.com/blog/chicken-legs-in-lemon-basil-mustard-sauce
x x x x x x x x x
http://www.f00die.com/2008/06/17/hobo-potatoes-w-arugula/
x x x x x
http://www.todayonpei.com/?p=5420
x x x
</pre>

(*) well, more of them, I skipped some WordPress Blogs since they all came from the same Plugin. But as the feature set of the Plugin continues to grow it doesn't make much sense to investigate them too thoroughly now unless you want to take into account which version of the plugin was used exactly etc etc - an undertaking I'm not really up to ;-)

(**) I felt quite bad when I saw that a lot of them used the pre-0.2 version with "title", "method" etc but I really don't know what I could do about it now (or then, too). I guess these decisions are made and the pain will diminish over time (cough).
--[[User:ThomasLoertsch|ThomasLoertsch]] 17:36, 17 June 2009 (UTC)
</div>
</div>

<div class="hentry">
{{OpenIssue}} 2009-07-01 raised by [[User:BenWard|BenWard]]
<div class="entry-content discussion issues">
* Reconsidering semantic of <code>published</code> over ‘<code>created</code>’. I think the reuse of <code>published</code> from [[hAtom]] may be incorrect. Given its use in hAtom, <code>published</code> represents the date and time that the content was originally published to the page. In the case of a recipe, it seems that you would instead want to represent the date that the recipe was authored/created, which is subtly different. The publication of a recipe on a web page is something that should be done with hAtom itself (publishing an <code>hEntry</code> that contains the recipe), but the recipe itself would contain the date that ''the recipe itself'' was created. e.g. <samp>I came up with this recipe for mashed potato in last summer</samp>. I'm totally open to ideas about this, but my feeling is that it's unnecessary to represent the publication date since that should be represented by a complete hAtom entry. Do we think that <code>created</code> as described here falls inside the 80:20?
** I agree with your interpretation of "published" versus "created". "published" is not used very often on it's own (see above) and I'm sure "created" would be used much less so - because it often is very difficult to determine when a recipe was created, when it was modified enough to count as newly created, from where (and when) it originated etc. IMO "published" MAY be out of the 80:20, but "created" certainly IS. You raise a point though that I'm thinking heavily about right now. I'm pondering if it would be wise to move most of the properties that are currently marked as "experimental" out of the draft and refer to them only (but explicitly) as possibly useful additions to a hRecipe. I would then add hReview as well and, from the 'experimental' properties, only leave "Nutrition" within the property set of hRecipe. But I need to think about that a little more. Anyway: I think your point is valid but should be part of a broader approach. --[[User:ThomasLoertsch|ThomasLoertsch]] 15:09, 2 July 2009 (UTC)
</div>
</div>

== resolved issues ==
<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description">
*# '''author is re-used from hAtom not hCard'''. minor issue. the "author" property is actually re-used from [[hAtom]] rather than hCard - hCard has no such property.
*#* Yikes! Corrected... [[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}}2008-01-17 raised by [[User:Yde|Yde]]
<div class="description">
* '''method'''. Would it make sense to [[reuse]] [[hreview|hReview's]] "description" instead of hRecipe's "method" or is this stretching the semantics too far?
** I just discovered that hCalender uses "method", and with totally different semantics. So I guess we MUST change it. I'm not very happy with "description" though - that's a very unspecific term. Maybe "instructions", or "steps", or "preparation" , or "procedure"? They are all 'available'. I like "instructions" most, but since I'm not a native speaker I'm hesitant. Maybe the semantics are too different? Maybe "preparation" is better since we already almost have it (or had it - see the discussion about "preparation-time" -> "duration" above)? [[User:ThomasLoertsch|ThomasLoertsch]] 12:24, 21 January 2009 (UTC)
** Since no further comments surfaced I'll change the property name to "instructions". I think it's a fairly unambiguous name which also can easily be reused in other formats. [[User:ThomasLoertsch|ThomasLoertsch]] 14:30, 2 Febuary 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Unnecessary recipe prefixing of summary property.''' Note: this is a re-opening of an issue from [[recipe-issues]]. The usage of summary in recipes appears to be very similar to that used for events. Rephrased, insufficient (if any?) evidence has been provided that summary means anything "special" enough (distinguishing it from the generic term "summary" as used in microformats) in the context of recipes to merit prefixing and thus a new property.
#* proposed resolution: Re-use generic "summary" property rather than introducing a recipe microformat scoped "recipe-summary" property.
#* I agree principally but there are different "summary"s around: The [[hReview]]-Draft specifies a summary as "This optional field serves as a title for the review itself" while the [[hCalendar]] Draft refers to RFC 2445 which defines summary as "This property defines a short summary or subject for the calendar component". I certainly agree more with the semantics from RFC 2445 but referring to either of the two doesn't make much sense right now. Since you are editor of both hReview and hCalendar maybe you can clarify the subject? If hReview would be aligned with RFC 2445 then I would promote dropping the prefix.[[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
#** Agreed, the definitions of "summary" across hCalendar and hReview could be better converged. Please add this as an issue to both [[hcalendar-issues]] and [[hreview-issues]] and I'll follow-up there accordingly. Given that is the path forward, let's fix this immediately in hRecipe now that the issue (and resolution) has been captured. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Will change "recipe-summary" to "summary" as defined in hCalender/RFC2445. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''preparation-time could re-use duration instead''' - it appears that the "preparation-time" semantic basically means the "duration" of the recipe, and thus could re-use that property from [[hCalendar]] rather than introducing a new property name.
#* proposed resolution: change "preparation-time" to "duration" and note re-use from [[hCalendar]] - or at least document how preparation-time is a different enough semantic from "duration" to justify the introduction of a new term.
#* One difference is that hCalendar ''duration'' is a singular property whereas hRecipe's ''preparation-time'' is plural. Also, ''preparation-time'' will often (typically) use value+note subproperties, while ''duration'' will usually be an ISO 8601 duration. [[User:TobyInk|TobyInk]] 20:32, 29 December 2008 (UTC)
#** Plurality is a contextual aspect and does not alter the semantic of the underlying property, thus is insufficient justification for introducing a new term. We do not duplicates of each property in a singular and plural form. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Syntax differences (value+note vs ISO 8601) are also insufficient to justify the introduction of a new property for the same semantic. Rather, it is better to expand the syntax of the existing property, e.g. perhaps using the [[value-excerption-pattern]] and to note that explicitly. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Semantically the reuse of "duration" is okay. RFC 2445 permits multiple duration values "if the property permits" so that should be fine too. If the syntactic differences can be worked out the way Tantek suggests above than it's okay with me to re-use "duration". I'm just not sure if it helps usability to overload properties in such a way but that ay be another discussion on it's own. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** The observation that preparation-time uses a nested "note" subproperty may actually reveal a problem with that approach itself, that is, perhaps instead of "preparation-time" with "value" and "note" subproperties, it may be better to refactor it as a "preparation" (an act thereof) with "duration" and "note" subproperties. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Removed the sub-property "note" from the v_0.2 draft format since I now agree that it looks a little overengineered. [[User:ThomasLoertsch|ThomasLoertsch]] 12:47, 22 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''issues too long''' 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
As threatened 2 weeks ago I heavily re-edited this page because discussions had become a little frayed (and heated at soem points). Have a look at the [http://microformats.org/wiki/index.php?title=hrecipe-issues&oldid=37788 previous version] for the full debate and feel free to re-edit this page if you find that I axed it too much. [[User:ThomasLoertsch|ThomasLoertsch]] 14:47, 2 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''new draft'''2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* The following is a proposal for draft 0.2, reflecting the issues discussed so far. "recipe-title" is replaced with "fn" from hCard (although I'm not convinced that this is a good idea), "recipe-summary" with "summary", "num" and "unit" from the unfinished 'measure' with "type" and "value" from 'hCard' (i only recently discovered them...), "method" (wihch is already used by [[hCalendar]] with "instructions", "preparation-time" with "duration". Two "note"s are deleted for brevity. "summary", "nutrition", "author", "published" and "photo" are marked as 'experimental', meaning that they may be removed from future drafts or the final specification, depending on experience and feedback from implementations :
</div>

=== '''hrecipe'''. Proposal for Draft 0.2 ===

* '''fn'''. the name of the recipe. required. text. re-used from [[hCard]]
* '''ingredient''' required. 1 or more. text with optional valid (x)HTML markup.
** '''value''' and '''type'''. optional. re-used from [[hCard]].
* '''yield'''. optional. text.
* '''instructions'''. optional. text with optional valid (x)HTML markup.
* '''duration'''. optional. 1 or more. text (see [[ISO-31-1]] duration brainstorming). re-used from [[hCalendar]].
* '''''summary'''''. optional. text. re-used from [[hCalendar]]. [ ''experimental'' ]
* '''''nutrition'''''. optional. 1 or more. [ ''experimental'' ].
** '''''value''''' and '''''type'''''. optional. re-used from [[hCard]]. [ ''experimental'' ].
* '''''author'''''. optional. 1 or more. re-used from [[hAtom]] using [[hCard]]. [ ''experimental'' ].
* '''''published'''''. optional. re-used from [[hAtom]]. [ ''experimental'' ].
* '''''photo'''''. optional. 1 or more. using any element containing a URL, such as IMG. re-used from [[hCard]]. [ ''experimental'' ].
* '''''tag'''''. optional. 1 or more. [ ''experimental'' ].
--[[User:ThomasLoertsch|ThomasLoertsch]] 11:01, 10 February 2009 (UTC)
</div>

== closed issues ==

<div class="vevent">
* {{ClosedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]] in the context of issue '''Too many properties'''
<div class="description discussion issues">
# '''Drop "recipe-title".''' In reviewing the examples, few (if any?) include *both* a title and a summary, and in practice the semantics of usage in the context of recipes appears to be virtually indistinguishable. Therefore we don't need both, and following in the pattern provided by [[hCalendar]] (which got it from [[RFC2445]]), we should keep the more generic concept of a "summary" and drop the concept of "title" from hRecipe.
#* I tend to agree. There are definitely use cases for both "recipe-title/title/fn" and "recipe-summary/summary" - e.g. "[http://www.simonwheatley.co.uk/2006/03/26/a-moroccan-ish-casserole/ A Moroccan-ish Casserole]" sounds more like a summary while "[http://blog.bumblepuppy.org.uk/2006/10/05/spaghetti-primavera/ Spaghetti primavera]" is the full name or the title of the recipe. But the problem is, they would serve the same purpose. [[User:Yde|Yde]] 10:07, 17 January 2009 (UTC)
#** Title and summary are different things and they are used differently in the real world. The examples you give are both names/titles/labels/headings, although more or less descriptive. They are short, memorable and make the thing adressable by humans. A summary can be (and mostly is) much longer and serves a different purpose: it describes essential properties of the object at hand, eg: "this is easy and fast to prepare, but still looks impressive", "easy, tasty, fast, vegan, good on cold days" or "the kids loved this last summer, but the ingredients can be hard to get" or "whenever i cook this i start to dream of ..." [[User:ThomasLoertsch|ThomasLoertsch]] 14:25, 20 January 2009 (UTC)
#*** Right, on second thought, I believe "title/name" and "summary" are different things. [[User:Yde|Yde]] 11:22, 23 January 2009 (UTC)
#* The term "title" has been so horribly overloaded across formats, vocabularies that it is nearly meaningless and for that reason should be avoided in any/all format efforts, preferring instead something more semantically specific such as "fn" (meaning full/formatted name of an item) or "summary" (when items are labeled more often with a short description/explanation rather than a name). [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Synonyms and homonyms are part of the real world - we have to cope with them. Also the word "title" is not horribly overloaded, you're exaggerating here. It just happened that hCard were the first to use it, and in a way that's empirically much less important then the use of "title" as the heading of a resource. Still the real problem is that Microformats have only one namespace and no resolution mechanism for conflicts like this, beside "first come first served". [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** Maybe it would be better to make a clear cut with some of the sins of the past and deprecate some terms in hCard / hCalendar[[User:ThomasLoertsch|ThomasLoertsch]] 15:30, 3 February 2009 (UTC)
#* "fn" is [[existing-classes|defined]] as "the name of the object" which is pretty much what "recipe-title" means right now. So, whether we chose to keep this property, summary, or both, renaming "recipe-title" to "fn" would make sense. [[User:Yde|Yde]] 23:03, 16 January 2009 (UTC)
#** the definition of "fn" in [[existing-classes|existing classes]] is maybe a little too short. "fn" is defined in hCard which is a reformulation of RFC 2462, which says: "Type name:FN - Type purpose: To specify the formatted text corresponding to the name of the object the vCard represents. -Type special notes: This type is based on the semantics of the X.520 Common Name attribute. The property MUST be present in the vCard object. - Type example: 'FN:Mr. John Q. Public\, Esq.'" (http://www.ietf.org/rfc/rfc2426.txt, on page 8). That clearly means a name of a person or an institution. Institution equals a juristical person, so "fn" semantically boils down to 'name of a person'. I wouldn't use that for every object. [[User:ThomasLoertsch|ThomasLoertsch]] 14:03, 20 January 2009 (UTC)
#*** Thanks for the clarification. "fn" is definitely not a good idea. [[User:Yde|Yde]] 10:00, 23 January 2009 (UTC)
#*** <code>fn</code> is already reused more generically in hAudio, hReview and hListing (for items). The definition of use within microformats has already been adapted from the strict vcard interpretation in prior work. --[[User:BenWard|BenWard]] 23:04, 27 January 2009 (UTC)
#**** I see. I can't help but thinking: what a mess... What's the family name of a recipe, audio-recording or list-entry? What's the point of re-using a semantically totally void two-letter-acronym, when it doesn't even fit very well? What's the point of reusing an element when I have to lookup the meaning of it every time anyway? [[User:ThomasLoertsch|ThomasLoertsch]] 00:48, 28 January 2009 (UTC)
#***** <code>fn</code> is ''formatted''-name, not ‘family’. ‘Name as presented’, ‘display name’. I agree that <code>fn</code> takes a double glance when you're learning, but it's there and the reuse in other specs is consistent; there's a much stronger author benefit in building on common equivalent-semantic vocabulary than introducing synonyms, which I think will cause more confusion. Better to have a strong spec with common vocabulary than introduce duplication. I'll keep in mind that we should better emphasise the expansion of <code>fn</code> in all specs for benefit of new authors. I can see how ‘family name’ is a muddle too easily made in hCard. --[[User:BenWard|BenWard]] 07:01, 28 January 2009 (UTC)
#****** I was referring to the fact that a name of a natural or juridical person is semantically quite different to the name of an object. Other things like the opacity of the two-letter-code "fn" are indeed problematic too but not my main issue here. That vCard-legacy seems to be lurking around every corner. Why not make a clear cut and deprecate the problematic parts like "title" and "fn"? The approach to rather overload the semantics (and the property-constraints) just to keep element-count low only takes that far. In the end it hinders usability instead of improving it. I think [[reuse]] and [[naming-principles]] don't strike the right balance in that respect. [[User:ThomasLoertsch|ThomasLoertsch]] 11:45, 28 January 2009 (UTC)
#* why not define a property "name"?! From my understanding of the english language (I'm not a native speaker) "name" is semantically generic enough to serve as a substitute for "title". Defining it rather broadly as "designation or title or denominator or heading of an item" would make it easily reusable. Plus we would have to explicitely discourage it's use for naming real or juristical persons and point to "fn" instead. [[User:ThomasLoertsch|ThomasLoertsch]] 12:21, 21 January 2009 (UTC)
#** Hmmm. I would really like to get feedback on this... Again my argumentation:
#*** <code>title</code> would be the best solution but is already "taken". Depercating some of hCalenders sins would be the best solution but seems out of reach so far.
#*** <code>heading</code> would be a possible solution either but seems more suited for prose
#*** <code>name</code> gets the semantics quite well, especially in the case of recipes which are more a "thing" or abstract conceptualization than a work of literature/science/prose
#*** <code>fn</code> with it's subproperties is geared towards natural and juristical persons, which are quite different from things and concepts. Also semantics of the term "fn" are rather opaque, even misleading, which hinder it's usability.
#** Therefor I'd love "title", could live very well with "name", could live still well with "heading" and would sleep bad (but sleep) with "fn". [[User:ThomasLoertsch|ThomasLoertsch]] 16:30, 2 Febuary 2009 (UTC)
#** Okay, since there's no response I bow my head to "fn". But it speaks for itself that it's the only tag that has to be explained in the schema. [[User:ThomasLoertsch|ThomasLoertsch]] 11:15, 10 February 2009 (UTC)
</div>
</div>

===template===
{{issues-format}}

==related pages==
* [[hRecipe]]
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-02T14:16:00Z

ThomasLoertsch: beautyfied source code formatting

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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 [[haudio#Duration|hAudio]] . An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<source lang=html4strict>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></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.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 ;-)
* 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) .

=== 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 <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-07-01T16:05:34Z

ThomasLoertsch: /* Examples */ changed 'author' part

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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. <pre>125ml milk</pre>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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

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

<pre>
<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>
</pre>

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

<pre><nowiki><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="author vcard url fn" href="http://example.com">Cooky Gang</a>.

Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

* 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T17:18:28Z

ThomasLoertsch: added some spacing between chapters

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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. <pre>125ml milk</pre>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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T17:13:51Z

ThomasLoertsch: /* ingredient */ added example for type and value

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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. <pre>125ml milk</pre>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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T17:06:32Z

ThomasLoertsch: /* Parser Processing Notes */ author defaults to "vcard fn"

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T17:03:37Z

ThomasLoertsch: /* Property details */

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T17:02:36Z

ThomasLoertsch: /* Property details */ "author" is now inherited from vCard

<entry-title>hRecipe 0.21</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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:59:53Z

ThomasLoertsch: /* author */ switched from hAtom to hCard, removed parsing note

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:55:23Z

ThomasLoertsch: /* published */ deleted reference to hAtom. refering to datetime-design-pattern is good enough and easier to comprehend

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 which any conforming parser should interpret as "vcard fn". Anything more elaborate {{must}} follow the conventions outlined in [[hAtom]].
* 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 [[datetime-design-pattern]] {{should}} be used to encode the published datetime, e.g.<pre>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></pre>
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:35:11Z

ThomasLoertsch: /* author */ added default type "vcard fn"

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 which any conforming parser should interpret as "vcard fn". Anything more elaborate {{must}} follow the conventions outlined in [[hAtom]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:24:24Z

ThomasLoertsch: /* summary */ added: Plain text fulfills these requirements.

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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 {{must}} follow the conventions outlined in [[hAtom]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:20:48Z

ThomasLoertsch: /* photo */ removed superfluous link to hCard

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:12:30Z

ThomasLoertsch: /* ingredient */ arg

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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.
* The property {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the property {{must}} follow the conventions outlined in [[hCard]].
* 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]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T16:10:56Z

ThomasLoertsch: changed "element" and "field" to "property" (where appropriate)

<entry-title>hRecipe 0.21</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>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 names <code>author</code> and <code>published</code> are 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]]. Plain text fulfills these requirements.

==== 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]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> property. These subelements 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 [[haudio#Duration|hAudio]] . In particular the contents of the property {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== 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.
* The property {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the property {{must}} follow the conventions outlined in [[hCard]].
* 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]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* 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 {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* 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.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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hreview

2009-06-30T16:05:04Z

ThomasLoertsch: /* property details */ typo

<entry-title>hReview 0.3</entry-title>
{{DraftSpecification}}

[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in HTML, XHTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.

Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.

== Microformats Draft Specification 2006-02-22 ==
; Editor: [http://tantek.com/ Tantek Çelik] ([http://technorati.com Technorati, Inc.])
; Authors: [http://tantek.com/ Tantek Çelik] ([http://technorati.com Technorati, Inc.])
: [http://360.yahoo.com/alidiabali Ali Diab] ([http://yahoo.com Yahoo! Inc.])
: [http://ianmcall.blogspot.com/ Ian McAllister] ([http://amazon.com/ Amazon.com])
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer] ([http://www.aol.com America Online, Inc.])
: [http://ifindkarma.com/blog Adam Rifkin] ([http://labs.commerce.net/ CommerceNet Labs])
: [http://sippey.typepad.com/ Michael Sippey] ([http://sixapart.com Six Apart, Ltd])

Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.

__TOC__

== Introduction ==
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.

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

{{rfc-2119-intro}}

=== Inspiration and Acknowledgments ===
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [[User:Richardault|Richard Ault]], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].

=== Scope ===
Reviews consistently share several common aspects. Where possible hReview has been based on this minimal common subset.

==== Out of scope ====
Portions of reviews that are specific to particular kinds of items have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.

The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
=== In General ===
The hReview format is based on a set of properties common to numerous review sites and formats in use today on the web. Where possible property names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.

=== Schema ===
The hReview schema consists of the following:

* hReview ('''<code>hreview</code>''')
** '''<code>version</code>'''. optional. text.
** '''<code>summary</code>'''. optional. text.
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.
** '''<code>description</code>'''. optional. text with optional valid HTML markup.
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.
** license. optional, using '''[[rel-license]]'''.

=== Property details ===
Details of the hReview properties:

'''version''':: This optional property permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this property, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This property is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this property for this specification is "0.3".

'''summary''':: This optional property serves as a title for the review itself.

'''type''':: The optional property "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".

'''item''':: This required property {{must}} have at a minimum the name (using the subproperty "fn" - the formatted text corresponding to the name, except for an event item which {{must}} have the "summary" subproperty inside the respective hCalendar "vevent") of ''the'' item (an hReview describes only one item), {{should}} provide at least one URI ("url") for the item, and {{may}} provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) {{must}} be encapsulated in an [[hcard|hCard]]. For items of type event, the item info {{should}} be encapsulated in an [[hcalendar|hCalendar]] "vevent". Non-URL unique item IDs (e.g. ISBNs, UPCs) {{may}} be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they {{must}} be nested inside the item element.

'''reviewer''':: The optional property specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer {{must}} be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers {{should}} look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers {{should}} use the author defined by the containing document language, e.g. for HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.

'''dtreviewed''':: This optional property when present {{must}} provide an [[ISO-8601|ISO8601]] absolute date time of when the review was written or otherwise authored. This property {{should}} use UTC, but {{may}} use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.

'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value {{may}} be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.

'''description''':: This optional property contains the full text representing the written opinion of the reviewer. The property {{may}} include valid HTML markup (e.g. paragraphs). User agents {{should}} preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) {{should}} be included in the description property.

'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer {{may}} optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and {{may}} also have a custom worst...best range specified. Authors {{may}} also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags {{should}} ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 {{should}} link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.

'''permalink''':: This optional property is a URL for the hReview. In addition to using the <code><a href></code> tag for this property, the attribute <code>rel="self bookmark"</code> {{must}} be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> {{must}} be included among the space-separated set of values in the attribute. Indexers {{may}} treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink {{may}} also be used to indicate or imply the origin of the review. Authors {{may}} use the classname of "permalink" on the element representing the permalink.

'''license''':: an hReview indicates the license for its contents using the '''[[rel-license]]''' microformat.

The following property names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards {{may}} contain any hCard property. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].

=== More Semantic Equivalents ===

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

* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code>

* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code><abbr></code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code><abbr class="rating" title="3.0">***</abbr></code>. This is further explored in the next section.

==== Language ====
* To explicitly convey the natural language that an hReview is written in, use the standard HTML 'lang' attribute on the element with class="hreview", e.g. <code><div class="hreview" lang="en"> ... </div></code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.
* hReview processors which need to handle the language of reviews MUST process the standard HTML 'lang' attribute as specified.

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

Similarly, if an <code><img /></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>src="..."</code> attribute provides the property value.
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.

=== Object Includes ===

hReview 0.3 includes support for the object [[include-pattern]].

Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.

=== Notes ===
This section is informative.

* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.
* The enumerated list of item types is under development and may be extended.
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.

== Examples ==
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat.

Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.

=== Restaurant reviews ===

Here is an example of a simple online restaurant review:

<pre><nowiki>
<div>
5 stars out of 5 stars
<h4>Crepes on Cole is awesome</h4>
Reviewer: Tantek - April 18, 2005
<blockquote>
Crepes on Cole is one of the best little creperies in San Francisco.
Excellent food and service. Plenty of tables in a variety of sizes
for parties large and small. Window seating makes for excellent
people watching to/from the N-Judah which stops right outside.
I've had many fun social gatherings here, as well as gotten
plenty of work done thanks to neighborhood WiFi.
</blockquote>
Visit date: April 2005
Food eaten: Florentine crepe
</div>
</nowiki></pre>

Adding hReview to this review is quite simple:

<pre><nowiki>
<div class="hreview">
5 out of 5 stars
<h4 class="summary">Crepes on Cole is awesome</h4>
Reviewer: Tantek -
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr>
<div class="description item vcard">
Crepes on Cole is one of the best little
creperies in San Francisco.
Excellent food and service. Plenty of tables in a variety of sizes
for parties large and small. Window seating makes for excellent
people watching to/from the N-Judah which stops right outside.
I've had many fun social gatherings here, as well as gotten
plenty of work done thanks to neighborhood WiFi.
</div>
Visit date: April 2005
Food eaten: Florentine crepe
</div>
</nowiki></pre>

Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.

This sample hReview could be rendered like this:

5 stars out of 5 stars 
'''Crepes on Cole is awesome''' 
Reviewer: Tantek - April 18, 2005 

Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.

Visit date: April 2005 
Food eaten: Florentine crepe 

==== Multidimensional Restaurant Review ====
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.

Here is one such review in text format:

Cafe Borrone

1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;
cafeborrone.com

Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...

This cafe is a welcoming oasis on the Peninsula. It even has a fountain
outside which cloaks the nearby sounds of El Camino traffic. Next door to a
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a
snack to accompany a newly purchased book or imported periodical. Soups and
sandwich specials rotate daily. The corn chowder with croutons and big
chunks of cheese goes especially well with a freshly toasted mini-baguette.
Evenings are often crowded and may require sharing a table with a perfect
stranger. Espresso afficionados will appreciate the Illy coffee. Noise
levels can vary from peaceful in the late mornings to nearly overwhelming on
jazz band nights.

As an hReview:

<pre><nowiki>
<div class="hreview">
<div class="item vcard">
<div class="fn org summary">Cafe Borrone</div>

1010 El Camino Real,
Menlo Park,
CA
94025,

+1-650-327-0830;
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a>
</div>
<ul>
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag">
Food: 18/30</a>;</li>
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag">
Ambience: 19/30</a>;</li>
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag">
Service: 15/30</a>;</li>
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag">
Price: <abbr class="value" title="2">$$</abbr>...</a></li>
</ul>
<div class="description">
This <abbr class="type" title="business">
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr>
is a welcoming oasis on the Peninsula.
It even has a fountain outside which nearly eliminates
the sounds of El Camino traffic. Next door to a superb indy bookstore,
Cafe Borrone is an ideal spot to grab a
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a>
or a meal to accompany a newly purchased book or imported periodical.
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a>
specials rotate daily. The corn chowder with croutons and big chunks of cheese
goes especially well with a freshly toasted mini-baguette. Evenings are
often crowded and may require sharing a table with a perfect stranger.
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a>
afficionados will appreciate the
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee.
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.
</div>
Review (<a href="http://microformats.org/wiki/hreview">
hReview v0.3</a>)
by anonymous,
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.
</div>
</nowiki></pre>

With an accompanying CSS style sheet like:

<pre><nowiki>
a.url { display:block }
ul { margin:1em 0; padding:0 }
ul li { display:inline }
</nowiki></pre>

This hReview could be presented similar to the original text:

Cafe Borrone 
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830; 
[http://cafeborrone.com/ cafeborrone.com] 
 
[http://en.wikipedia.org/wiki/Food Food: 18/30];
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];
[http://en.wikipedia.org/wiki/Service Service: 15/30];
[http://en.wikipedia.org/wiki/Price Price: $$...] 

This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.

Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.

=== Product review ===
Here is an example of a product review:

<pre><nowiki>
<div>
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/">
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg"
alt="Album cover photo: The Postal Service: Give Up." />
The Postal Service: Give Up</a>
<blockquote>
"The people thought they were just being rewarded for treating others
as they like to be treated, for obeying stop signs and curing diseases,
for mailing letters with the address of the sender... Don't wake me,
I plan on sleeping in..."

"Nothing Better" is a great track on this album, too...
</blockquote>
(*****)
</div>
</nowiki></pre>

Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:

<pre><nowiki>
<div class="hreview">
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/">
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg"
alt="Album cover photo: The Postal Service: Give Up. "
class="photo" />
The Postal Service: Give Up</a>
<div class="description">
"The people thought they were just being rewarded for treating others
as they like to be treated, for obeying stop signs and curing diseases,
for mailing letters with the address of the sender... Don't wake me,
I plan on sleeping in..."

"Nothing Better" is a great track on this album, too...
</div>
(<abbr class="rating" title="5">*****</abbr>)
Review by
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>,
<abbr class="dtreviewed" title="200502">February 2005</abbr>

</div>
</nowiki></pre>

And this hReview might be presented like this:

[Album cover photo: ]
[The Postal Service:]
[ Give Up ]

The Postal Service: Give Up

"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."

"Nothing Better" is a great track on this album, too...

(*****)

Review by Adam Rifkin, February 2005.

=== Movie Review ===
Finally, here is an example of a movie review.

<pre><nowiki>
<div>
anonymous, April 18th, 2005
<div>
<a lang="zh" href="http://www.imdb.com/title/tt0299977/">
Ying Xiong (HERO)
</a>
</div>
<div>Rating: 4 out of 5</div>
<blockquote>
This movie has great visuals and music.
</blockquote>
</div>
</nowiki></pre>

With hReview:

<pre><nowiki>
<div class="hreview">

anonymous,
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr>

<div class="item">
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/">
Ying Xiong (HERO)
</a>
</div>
<div>Rating: 4 out of 5</div>
<div class="description">
This movie has great music and visuals.
</div>
</div>
</nowiki></pre>

Which could be presented like this:

anonymous, April 18th, 2005 
Ying Xiong (HERO) 
Rating: 4 out of 5 

This movie has great music and visuals.

== Examples in the wild ==
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].

See [[hreview-examples-in-wild|hReview Examples in the wild]].

== Implementations ==
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].

See [[hreview-implementations|hReview Implementations]].

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://gmpg.org/xmdp/ XMDP]
* [[hcard|hCard]]
* [[hcalendar|hCalendar]]
* [[rel-tag]]
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)

=== 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.ietf.org/rfc/rfc3667.txt RFC3667]
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]
* Other reviews efforts. See [[reviews-formats]].
* Contributed from http://developers.technorati.com/wiki/hReview.

==== Similar Work ====
* [[hlisting-proposal|hListing]]
* [[xoxo|XOXO]]

=== Copyright ===
{{MicroformatCopyrightStatement2005}}
* [[User:Tantek|Tantek]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
** When all authors/editors have done so, we can remove the MicroFormatCopyrightStatement template reference and replace it with the MicroFormatPublicDomainContributionStatement.

=== Patents ===
{{MicroFormatPatentStatement}}

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

=== Changes from v0.2 ===
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:

Normative changes:
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person
# "reviewer" changes
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for HTML pages) as the reviewer.
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information
# "dtreviewed" changes
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.
# Added [[rel-license]] to indicate the license of the hReview as a whole.
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.

Informative changes (several, but in particular):
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.
# Updated examples accordingly.

== Further Reading ==
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].

== Related Pages ==
{{hreview-related-pages}}

[[Category:Draft Specifications]]
[[Category:hReview]]

hrecipe

2009-06-30T15:49:19Z

ThomasLoertsch: /* fn */ modified reference to hCard

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 class name <code>fn</code>.
* A Recipe {{must}} include a <code>fn</code>.
* The property {{must}} follow the conventions outlined in [[hCard]]. Plain text fulfills these requirements.

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code> elements.
* The element {{may}} encode the timespan as outlined in [[haudio#Duration|hAudio]] . In particular the contents of the element {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hAtom]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement are considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T15:13:23Z

ThomasLoertsch: /* duration */

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code> elements.
* The element {{may}} encode the timespan as outlined in [[haudio#Duration|hAudio]] . In particular the contents of the element {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hAtom]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement are considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T15:08:02Z

ThomasLoertsch: /* duration */ changed the reference from hCalender to hAudio

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code> elements.
* The element {{may}} encode the timespan as outlined in [[haudio#Duration|hAudio]] . In particular the contents of the element {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 1:30 (i.e 1 hour 30 minutes) would be "PT1H30M" in ISO 8601 format.
<pre><abbr class="duration" title="PT1H30M">90 min</abbr></pre>

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hAtom]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement are considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T14:32:23Z

ThomasLoertsch: /* nutrition */ typo

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]] (see [[ISO-31-1]] duration brainstorming).

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hAtom]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement are considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T14:29:43Z

ThomasLoertsch: /* Examples */ a lot of details changed and updated

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]] (see [[ISO-31-1]] duration brainstorming).

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hAtom]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><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!

Tom Lurge
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<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 <abbr title="minutes">min</abbr>.

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>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T10:20:30Z

ThomasLoertsch: /* author */

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]] (see [[ISO-31-1]] duration brainstorming).

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{must}} follow the conventions outlined in [[hAtom]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== published ====

The date the recipe was published.

* The element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T09:26:43Z

ThomasLoertsch: /* duration */

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]] (see [[ISO-31-1]] duration brainstorming).

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{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 element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T09:25:54Z

ThomasLoertsch: /* Schema */ removed references to reused microformats

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

* '''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]

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]].

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{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 element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-30T09:21:01Z

ThomasLoertsch: /* Field details */ typos...

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

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

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]]. Class names <code>duration</code> and <code>summary</code> are reused from [[hCalendar]]. Class names <code>author</code> and <code>published</code> are reused from [[hAtom]]. Class 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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]].

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{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 element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-rdf

2009-06-18T12:50:32Z

ThomasLoertsch: /* General Questions */ "no", and: "to the list, please".

= aRecipe - a mapping of the hRecipe microformat to RDF =

== Purpose ==
In some cases people want or need to use an RDF-based solution to add metadata to web pages. [http://www.w3.org/TR/xhtml-rdfa-primer/ RDFa] is a standardized way to do so. While it's not as easy to use as microformats it serves certain use cases that microformats can not handle like e.g. when you want to add metadata to certain parts of a page and other metadata to the page as a whole. RDFa is also a straight forward solution for domains which are not covered by a microformat but where a well established RDF vocabulary already exists.

== Documentation ==
[http://purl.org/arecipe/ aRecipe] is a mapping from hRecipe to RDF as thorough and 1:1 as possible. It is part of a bigger effort to map all microformats into one RDF vocabulary, called [http://purl.org/amicroformat/ aMicroformat]. But since that is a lot of work and will take some more time the aRecipe part of aMicroformat is a first shot.

The official location of the voacbulary is at [http://purl.org/arecipe/ http://purl.org/arecipe/]. There you'll always find the latest version, currently in two encodings: [http://rat.io/nal/amicroformat/arecipe/arecipe.n3 n3] and [http://rat.io/nal/amicroformat/arecipe/arecipe.rdf RDF/XML]. Hopefully soon some documentation will be added as well.

== Implementation ==
aRecipe has been implemented on http://www.essen-und-trinken.de, e.g. here: [http://www.essen-und-trinken.de/rezept/144350/apfelkuchen-vom-blech.html apple pie] (in german, sorry ;-). A convenient way to look at the RDFa is the [http://www.w3.org/2007/08/pyRdfa/ RDFa Distiller]. See below an excerpt of the RDF generated from the apple pie recipe.

Enjoy and leave comments and feedback at the bottom of this page.

== The RDF mapping of hRecipe ==
The original mapping at http://purl.org/arecipe/ additionally contains some more constructs to model the constraints on each element. These constructs are rather involved because the constraints are rather complex and OWL isn't particularily suited to model constraints. Because of that it's not sure if they will be part of the final version.

<pre>
<rdf:RDF xmlns="http://www.w3.org/2000/01/rdf-schema#"
xmlns:owl="http://www.w3.org/2002/07/owl#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">

<owl:Ontology rdf:about="http://purl.org/amicroformat/arecipe/">
<comment>The hRecipe microformat is designed for the mark-up of instructions for creating meals, drinks or food-based items. <http://microformats.org/wiki/recipe#Introduction></comment>
<comment>This ontology is only informative. The normative version is always that on the site <http://microformats.org>.</comment>
<comment>microformats are a way to encode semantic information into (x)html. they define formats that share one common namespace. this piece of work defines a mapping from the hRecipe microformat into RDF by mirroring the elements of that microformat as straight as possible into an RDF vocabulary.</comment>
<label>aRecipe</label>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe"/>
<owl:versionInfo>28042009</owl:versionInfo>
<owl:versionInfo>Draft 0.21</owl:versionInfo>
</owl:Ontology>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/Recipe">
<comment>A Recipe is used to identify and describe values and metadata typically associated with a recipe.</comment>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#hRecipe"/>
<label>recipe</label>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:cardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:cardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/fn"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/ingredient"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:maxCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:maxCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">0</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
</subclassOf>
</owl:Class>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/author">
<comment>An Author is the person who authored the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Author"/>
<label>author</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#author"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/duration">
<comment>The time it takes to prepare the meal described by the recipe. Multiple duration fields 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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#duration"/>
<label>duration</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/fn">
<comment>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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCard"/>
<label>title</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#fn"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/ingredient">
<comment>Describes one or more ingredients used in the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#ingredient"/>
<label>ingredient</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/instructions">
<comment>The method of the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#instructions"/>
<label>instructions</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/nutrition">
<comment>Nutritional information like calories, fat, dietary fiber etc. </comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#nutrition"/>
<label>nutrition</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/photo">
<comment>Accompanying image. </comment>
<comment>See section 3.1.4 of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>photo</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#photo"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/published">
<comment>The date the recipe was published.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Published"/>
<label>published</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#published"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/summary">
<comment>The summary provides a short introduction or an accompanying statement about the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCalendar"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#summary"/>
<label>summary</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/tag">
<comment>Indicates that the referred resource serves as a 'tag', or keyword/subject, for the referring page.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/rel-tag#XMDP_profile"/>
<label>rel-tag</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#tag"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/type">
<comment>Defines a type of the parent element. For instance a type of telephone number such as home or work. Used in conjunction with 'value'. <http://microformats.org/wiki/existing-classes></comment>
<comment>See 'type' in the various sections of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>type</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/value">
<comment>This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<comment>Used in conjunction with 'type'. The actual value of a particular type. For instance a telephone number of type work such as +1.415.555.1212. <http://microformats.org/wiki/existing-classes></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>value</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/yield">
<comment>Specifies the quantity produced by the recipe, like how many persons it satisfyies or how many pieces can be made of it.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#yield"/>
<label>yield</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/IngredientClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/NutritionClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</rdf:Description>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
</rdf:Description>
</rdf:RDF>
</pre>

== Generated RDFa ==

<pre>
<?xml version="1.0" encoding="utf-8"?>
<rdf:RDF
xmlns:amf="http://purl.org/amicroformat/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:xhv="http://www.w3.org/1999/xhtml/vocab#"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
>
<amf:Recipe rdf:about="http://www.essen-und-trinken.de/rezept/144350">
<amf:duration xml:lang="de">1 h </amf:duration>
<amf:yield xml:lang="de">Für 24 Stücke</amf:yield>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/schnellundeinfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/party"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/kuchentorte"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfelkuchen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/backen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/gutvorzubereiten"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/einfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfel"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/nuesse"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/obst"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/blechkuchen"/>
<amf:ingredient rdf:parseType="Literal">6 El Zitronensaft</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">200 g Zucker</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g Schmand</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">500 g Mehl</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">1,2 kg Äpfel </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">1 Pk. Backpulver</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g gehackte Mandeln</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">300 g Butter</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">3 El Calvados</amf:ingredient>
<amf:ingredient xml:lang="de"> Salz</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">6 Eier </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">125 g Puderzucker</amf:ingredient>
<amf:fn xml:lang="de">Apfelkuchen vom Blech</amf:fn>
<amf:instructions rdf:parseType="Literal">
1. Mandeln in einer Pfann ohne Fett anrösten. Herausnehmen und abkühlen lassen. Die Äpfel schälen, vierteln und entkernen. In Würfel schneiden und mit Zitronensaft beträufeln.2. Butter, Zucker und 1 Prise Salz cremig rühren. Eier nacheinander unterrühren. Mehl, Backpulver und Mandeln mischen und abwechselnd mit dem Schmand unter die Ei-Zucker-Masse rühren. Auf ein mit Backpapier belegtes Blech streichen. Apfelwürfel darüber streuen. Im vorgeheizten Ofen bei 175 ° backen ca. 40 Min. backen. 3. Puderzucker und Calvados glatt rühren und über den heißen Kuchen träufeln.</amf:instructions>
<amf:author rdf:parseType="Literal"> Von <a href="/user/melaFTL" rel="nofollow" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml">melaFTL</a><a href="#" id="addFavoriteCookLinkActive" onclick="return false;; return false;" style="display:none" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml"><img alt="Icon_user_rot" id="addFavoriteCookLinkAktiveImg" src="/img/icon_user_rot.gif"/></a> </amf:author>
<amf:note rdf:parseType="Literal">Der Kuchen wird weihnachtlich, wenn man in den Teig noch etwas Lebkuchengewürz gibt, etwa 1 1/2 Tl. </amf:note>
</amf:Recipe>
</rdf:RDF>
</pre>

== Feedback ==
Please add questions and comments in the following sections.
=== Template ===
{{issues-format}}

=== General Questions ===

<div class="hentry">
{{OpenIssue}} 2009-06-17 raised by [[User:BenWard|BenWard]]
<div class="entry-content discussion issues">
* Non-microformat content on µf wiki. I appreciate that the µf wiki is not exclusively used to document microformats (c.f. [[POSH]], [[social-network-anti-patterns]]), but it seems to be a new stretch to document RDFa here, especially when RDFa somewhat conflicts with some microformats design principals.
*## i think you should elaborate on this point. i'm not sure what you are referring at. and please stay as close to aRecipe (the actual point of discussion here) as possible.
Keeping the documentation here seems problematic as:
*# This is not a community based around RDFa expertise, as such it seems unlikely that you will get thorough feedback
*## There are people in this community with very good RDFa skills and expertise (much better than mine for sure), well known and respected in both communities, RDF and microformats. yes, it's possible to like and use both.
*# It dilutes and confuses the normative [[hRecipe]] documentation, which is itself unfinished.
*## no, it thoroughly follows the hrecipe Draft and it explicitly states that it itself is not normative but hRecipe is
*# The somewhat odd, unverified problem statement (“In some cases people want or need to use an RDF-based solution to add metadata to web pages”
*## what's odd and unverified here? RDF and RDFa are used in a lot of places and for good reasons. there's nothing special about recipes that makes them useful as microformats (or RDFa) only.
— who has ever asked to publish hRecipe in RDF?
*## me, for example. do i have to ask first?
Especially given that it's an unstable draft. I don't think there's a strong use case for this that justifies confusing the real spec.
*## your reference to the "unstability" of the draft seems contrived. it is quite stable, it's used a lot, there are only very few open issues. and it wouldn't matter if it wasn't since aRecipe is also an exercise on how to map microformats to RDFa and the hRecipe draft can only profit from lessons learned here.

side note: i do find it strange and unlucky that a reply to my post on the mailinglist is posted in the wiki without even notifying the list, especially when it goes as far as suggesting to remove this page. since there is not email notification for changes on wiki pages everyone should try to make it as easy as possible to follow discussions.
since your criticism is rather profound i think you should post it on the list as a reply to my mail which i precisely posted to the list because i expected some debate. this very page was sitting here for weeks without getting any comment whatsoever but minutes after i pushed it to the list you ask for it's removal. i think that speaks for itself. --[[User:ThomasLoertsch|ThomasLoertsch]] 12:50, 18 June 2009 (UTC)
</div>
</div>

<div class="hentry">
{{OpenIssue}} 2009-06-17 raised by [[User:BenWard|BenWard]]
<div class="entry-content discussion issues">
* hRecipe is a draft and making normative references to it is confusing. It seems unwise to be pursuing an effort to port hRecipe to a different language before the hRecipe vocabulary itself is stable.
*## you made that point above already. see my reply there--[[User:ThomasLoertsch|ThomasLoertsch]] 12:50, 18 June 2009 (UTC)
</div>
</div>

=== General Comments ===

==related pages==
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]]
* [[hrecipe-feedback|hRecipe feedback]]

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.

hrecipe-issues

2009-06-17T17:36:15Z

ThomasLoertsch: /* issues */

== issues ==
Please add new issues to the '''bottom''' of this section by copy and pasting the [[hrecipe-issues#template|Template]]. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

<div class="vevent">
* {{OpenIssue}} 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* '''"num" and "unit"'''. I only recently discovered the properties "type" and "value" from 'hCard'. I'll replace "num" and "unit" from the unfinished 'measure' with them.
** The decision to replace "num", "unit", and "item" with "type" and "value" needs further explanation. Was it due to the fact that measure is unfinished? If so I think leaving "ingredient" and "nutrition" as text strings until measure is finished would be a better idea. The transition from "type"/"value" to measure will be difficult at a later point and I believe measure is more appropriate than re-using hCard. [[User:Yde|Yde]] 11:46, 23 January 2009 (UTC)
*** The proposal to replace "num", "unit", and "item" with "type" and "value" has several reasons: first, i only recently thoroughly and systematically investgated other formats and that's when i found "type" and "value". They have a semantic advantage in that they may be more suitable for cases like value:"2"/type:"eggs" or value:"1/2"/type:"spoonfull" which are rather informal ways of putting measures, at least do not lend themselves easily to formal specification. Another reason is that these terms come from a comparably very stable vocabulary, while measure has not even draft status. It would be perfectly okay for measure to change attribute names, semantics or even the whole structure of the vocabulary. Although it doesn't look like that measure will (have to) do that I'd prefer to stay on the safe side, especially since we might even gain semantic advantage. [[User:ThomasLoertsch|ThomasLoertsch]] 19:43, 23 January 2009 (UTC)
**** I'm still not sure this is the right decision. 1) I don't think the semantic meaning of hCard's "type"/"value" is exactly equivalent to measure's "num"/"unit"/"item". From the [[hcard-profile]]: "Value: This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property." So what is the actual value of an ingredient? Is it the name of the ingredient or is the quantity? 2) This is ''exactly'' what [[measure]] is for. The advantage of being able to convert measures would IMO be one of the gratest advantages of hRecipe. I don't see why value:"2"/type:"eggs" is better than num:"2"/item:"eggs"? I agree that cases like value:"1/2"/type:"spoonfull" is problematic, but that's a [[measure]] issue. 3) Many [[recipe-formats]] use quantity/unit/item.
***** Measurements are rather informal in recipes and therefor the type/value pair seems quite appropriate to me. Automatic translation is out of scope. Anyway for a good enough machine translation of a recipe the markup of the ingredients won't be the main hurdle. Standardizing the informal quantities would be a requirement for such an effort. I made some suggestions for a vocabulary of most used "units" like cups, teespoonfulls etc a few months ago but no one reacted. So I dropped it.
***** But we're moving in circles. You are making valid points too. One reason I decided this way is that it's more inline with other decisions like reusing "fn". Since not all the shortcomings of microformats can be solved within hRecipe and since there has been no interest in discussing them here I decided to go the way of least resistance and stick with the customs of compactness, reuse and rather lax interpretation of semantic constraints. IMO hRecipe is now consistent with the genereal microformats approach and neither necessitates nor hinders a general redesign of microformats (which I think would be a good thing). --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
**** Proposed resolution: keep "ingredient" as a text string like "yield" - which would also benefit from a measure format - until such a format is ready. [[User:Yde|Yde]] 10:23, 15 February 2009 (UTC)
***** I opened this issue again and marked the subproperty 'value' and 'type' of ingredient as ''experimental''. This should leave enough room to discuss this issue further. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Too many properties.''' From reviewing the [[recipe-examples]], it does not appear that the schema implied by the examples justify the number of properties in hRecipe, especially for a first draft. microformats should start as small as possible (even smaller), and in this regard I believe several improvements could be made. There is one obvious example of recipe-title vs recipe-summary, but it looks like there may be more. Would appreciate feedback from folks who add hRecipe to the recipes on the web regarding which properties they ended up not using.
#* It is not necessarily helpful to constrain a vocabulary by all means. hCard and hCalender are examples for too large vocabularies (which mostly stems from the approach taken of converting an existing vocab 1:1) which are not as easily usable as one would wish. But to be useful a vocabluary should encompass 80:20 of the usecases, otherwise it may well not be worth the burden of implementation. We better try to hit that sweet spot right from the start - since otherwise, how should hRecipe get traction in the wild. All of the proposed properties are used on big recipe sites (many 'user generated content' sites among them) on the web. Please provide more arguments which properties you specifically think are superfluous. The only concrete example you give is to replace title by summary (which I think is a bad idea). [[User:ThomasLoertsch|ThomasLoertsch]]
#* Version 0.2 (and a little more so 0.21) has marked all but the most essential properties as ''experimental''. There use is not at all discouraged but implementors are warned that these properties may be removed from later version if they aren't used in real world applications. This uptake by implementors should be observed and studied before a final descision is made. A proposed timeframe would be at least a few months, maybe even a year or two, depending on how many implemetations surface in the meantime. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
#* I checked the usage of the hRecipe format today and was delighted to see that Yahoo! searchmonkey lists 56.000 of them (search Yahoo for "searchmonkey:com.yahoo.page.uf.recipe"). The site I work for is responsible for about 12.000 of them but when i checked the first 70 results none of them was from our site :-) In fact they almost all came from personal sites, blogs and the like and this is really great! It was also very interesting to see that a lot of them came from WordPress Blogs which shows that the WordPress Plugin for hRecipe is very useful. But back to the issue: I checked the first 60 or so results and about 2/3 of them where really using hRecipe. 17 of them were from different sites(*) (**).

It's never bad to gather some empirical data to make an informed decision, so I took the burden to count element use. Actually this didn't take much more then an hour, so if somebody wants to check the results from 61 to ... feel free! Well, now, without futher ado, the results:
<pre>
16 fn
17 ingredient (3 value, 3 type)
3 yield
15 instructions
3 duration
4 photo
9 summary
4 author
3 published
1 nutrition (0 value, 0 type)
2 tag
</pre>
Of course this is not representative, but it gives a fairly good impression. If you add our site (or 20% of all published hRecipes ;) you can add +1 to all elements since we use everything...

Evaluation:

"fn", "ingredient" and "instructions" are no-brainers. Also "summary" is surprisingly strong and the intuition, that it's a strong part of how people communicate on recipes, seems to be right.

"author" and "published" probably didn't get so much used because on a blog they are provided anyway and most of the sites investigated were blogs. OTOH they aren't important for the functionality of a recipe and can be added by other means. So maybe they should be removed for the sake of terseness.

"photo" was definitely less used than there were photos added to recipes. And I know a lot of people who, when showed 2 recipes, one with and one without photo, almost certainly choose the one with photo. So IMHO it should stay.

"yield" was used surprisingly seldomly. Isn't it an essential addition to the ingredients list? Maybe the yield is often self-explanatory, maybe this reflects the fact, that also the value and type of ingredients wasn't marked up most of the time. 'Smallishness' would certainly suggest to omit all the three: "value", "type" and yield". People seem to feel that the "ingredient" field naturally holds information not only about the name of the ingredient but about type and value too and don't bother to mark these up explicitely. Again for big sites which generate their content from databases the cost-usage relation is totally different...

"duration" would be a candidate for removal as well. But still, remeber that this list only reflects usage of the elements. An information of duration was part of the recipe more often than it was marked up as such.

"tag" obviously didn't get used much and is maybe strong enough on it's own. People add tags no matter if they are part of a vocabulary, and the rel-tag pattern is certainly easy enough to grasp and straightforward to implement.
But the WordPress plugin added a tagging vocabulary on it's own (how dare they... ;-) which did get used most of the time. So tagging principally is strong. Well, I still don't have a clue on this one.

"nutrition" is definitely a candidate for removal, maybe into it's own vocabulary. OTOH, big commercially backed sites very often provide nutritional information and when provided it is a much more integral part of the information context than say the author. So maybe it should stay?
The full result-set, including URLs:
<pre>
fn ingredient v t yield instructions duration photo summary author published nutrition v t tag
http://nissasham.blog.com/
x x x x x x
http://reciperiot.blog.com/
x x x
http://www.greenworld365.com/twice-baked-buttermilk-potatoes/
x x
http://peachquilting.com/2009/04/beef-with-garlic-potatoes/ (wordpress plugin)
x x x x
http://fivepennynicole.com/blog/2008/10/29/world-series-caramel-corn/ (wordpress plugin)
x x x x x x x
http://www.theslowcook.com/2009/04/23/shrimp-stir-fry/ (wordpress plugin)
x x x
http://bitten.blogs.nytimes.com/2009/01/29/addictive-mac-and-cheese/ well ... very freestyle
x x x x
http://au.food.yahoo.com/recipes/recipe/-/5346170/baked-chicken-ravioli/
x x x x
http://humblegourmand.com/recipes/grovestand-lemon-cupcakes/
x x x x x x x
http://www.f00die.com/
x x x x
http://www.thebarkersworld.com/ (wordpress plugin)
x x x x
http://www.murraywilliams.com/cooking/souffle.html
x x x x
http://cookingwithbooze.org/beer/beer-brats/
x x x x
http://itsripe.com/recipes/11-kale-smoothie
x x x x x x x x x x
http://xavierroy.com/blog/chicken-legs-in-lemon-basil-mustard-sauce
x x x x x x x x x
http://www.f00die.com/2008/06/17/hobo-potatoes-w-arugula/
x x x x x
http://www.todayonpei.com/?p=5420
x x x
</pre>

(*) well, more of them, I skipped some WordPress Blogs since they all came from the same Plugin. But as the feature set of the Plugin continues to grow it doesn't make much sense to investigate them too thoroughly now unless you want to take into account which version of the plugin was used exactly etc etc - an undertaking I'm not really up to ;-)

(**) I felt quite bad when I saw that a lot of them used the pre-0.2 version with "title", "method" etc but I really don't know what I could do about it now (or then, too). I guess these decisions are made and the pain will diminish over time (cough).
--[[User:ThomasLoertsch|ThomasLoertsch]] 17:36, 17 June 2009 (UTC)
</div>
</div>

== resolved issues ==
<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description">
*# '''author is re-used from hAtom not hCard'''. minor issue. the "author" property is actually re-used from [[hAtom]] rather than hCard - hCard has no such property.
*#* Yikes! Corrected... [[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}}2008-01-17 raised by [[User:Yde|Yde]]
<div class="description">
* '''method'''. Would it make sense to [[reuse]] [[hreview|hReview's]] "description" instead of hRecipe's "method" or is this stretching the semantics too far?
** I just discovered that hCalender uses "method", and with totally different semantics. So I guess we MUST change it. I'm not very happy with "description" though - that's a very unspecific term. Maybe "instructions", or "steps", or "preparation" , or "procedure"? They are all 'available'. I like "instructions" most, but since I'm not a native speaker I'm hesitant. Maybe the semantics are too different? Maybe "preparation" is better since we already almost have it (or had it - see the discussion about "preparation-time" -> "duration" above)? [[User:ThomasLoertsch|ThomasLoertsch]] 12:24, 21 January 2009 (UTC)
** Since no further comments surfaced I'll change the property name to "instructions". I think it's a fairly unambiguous name which also can easily be reused in other formats. [[User:ThomasLoertsch|ThomasLoertsch]] 14:30, 2 Febuary 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Unnecessary recipe prefixing of summary property.''' Note: this is a re-opening of an issue from [[recipe-issues]]. The usage of summary in recipes appears to be very similar to that used for events. Rephrased, insufficient (if any?) evidence has been provided that summary means anything "special" enough (distinguishing it from the generic term "summary" as used in microformats) in the context of recipes to merit prefixing and thus a new property.
#* proposed resolution: Re-use generic "summary" property rather than introducing a recipe microformat scoped "recipe-summary" property.
#* I agree principally but there are different "summary"s around: The [[hReview]]-Draft specifies a summary as "This optional field serves as a title for the review itself" while the [[hCalendar]] Draft refers to RFC 2445 which defines summary as "This property defines a short summary or subject for the calendar component". I certainly agree more with the semantics from RFC 2445 but referring to either of the two doesn't make much sense right now. Since you are editor of both hReview and hCalendar maybe you can clarify the subject? If hReview would be aligned with RFC 2445 then I would promote dropping the prefix.[[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
#** Agreed, the definitions of "summary" across hCalendar and hReview could be better converged. Please add this as an issue to both [[hcalendar-issues]] and [[hreview-issues]] and I'll follow-up there accordingly. Given that is the path forward, let's fix this immediately in hRecipe now that the issue (and resolution) has been captured. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Will change "recipe-summary" to "summary" as defined in hCalender/RFC2445. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''preparation-time could re-use duration instead''' - it appears that the "preparation-time" semantic basically means the "duration" of the recipe, and thus could re-use that property from [[hCalendar]] rather than introducing a new property name.
#* proposed resolution: change "preparation-time" to "duration" and note re-use from [[hCalendar]] - or at least document how preparation-time is a different enough semantic from "duration" to justify the introduction of a new term.
#* One difference is that hCalendar ''duration'' is a singular property whereas hRecipe's ''preparation-time'' is plural. Also, ''preparation-time'' will often (typically) use value+note subproperties, while ''duration'' will usually be an ISO 8601 duration. [[User:TobyInk|TobyInk]] 20:32, 29 December 2008 (UTC)
#** Plurality is a contextual aspect and does not alter the semantic of the underlying property, thus is insufficient justification for introducing a new term. We do not duplicates of each property in a singular and plural form. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Syntax differences (value+note vs ISO 8601) are also insufficient to justify the introduction of a new property for the same semantic. Rather, it is better to expand the syntax of the existing property, e.g. perhaps using the [[value-excerption-pattern]] and to note that explicitly. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Semantically the reuse of "duration" is okay. RFC 2445 permits multiple duration values "if the property permits" so that should be fine too. If the syntactic differences can be worked out the way Tantek suggests above than it's okay with me to re-use "duration". I'm just not sure if it helps usability to overload properties in such a way but that ay be another discussion on it's own. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** The observation that preparation-time uses a nested "note" subproperty may actually reveal a problem with that approach itself, that is, perhaps instead of "preparation-time" with "value" and "note" subproperties, it may be better to refactor it as a "preparation" (an act thereof) with "duration" and "note" subproperties. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Removed the sub-property "note" from the v_0.2 draft format since I now agree that it looks a little overengineered. [[User:ThomasLoertsch|ThomasLoertsch]] 12:47, 22 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''issues too long''' 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
As threatened 2 weeks ago I heavily re-edited this page because discussions had become a little frayed (and heated at soem points). Have a look at the [http://microformats.org/wiki/index.php?title=hrecipe-issues&oldid=37788 previous version] for the full debate and feel free to re-edit this page if you find that I axed it too much. [[User:ThomasLoertsch|ThomasLoertsch]] 14:47, 2 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''new draft'''2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* The following is a proposal for draft 0.2, reflecting the issues discussed so far. "recipe-title" is replaced with "fn" from hCard (although I'm not convinced that this is a good idea), "recipe-summary" with "summary", "num" and "unit" from the unfinished 'measure' with "type" and "value" from 'hCard' (i only recently discovered them...), "method" (wihch is already used by [[hCalendar]] with "instructions", "preparation-time" with "duration". Two "note"s are deleted for brevity. "summary", "nutrition", "author", "published" and "photo" are marked as 'experimental', meaning that they may be removed from future drafts or the final specification, depending on experience and feedback from implementations :
</div>

=== '''hrecipe'''. Proposal for Draft 0.2 ===

* '''fn'''. the name of the recipe. required. text. re-used from [[hCard]]
* '''ingredient''' required. 1 or more. text with optional valid (x)HTML markup.
** '''value''' and '''type'''. optional. re-used from [[hCard]].
* '''yield'''. optional. text.
* '''instructions'''. optional. text with optional valid (x)HTML markup.
* '''duration'''. optional. 1 or more. text (see [[ISO-31-1]] duration brainstorming). re-used from [[hCalendar]].
* '''''summary'''''. optional. text. re-used from [[hCalendar]]. [ ''experimental'' ]
* '''''nutrition'''''. optional. 1 or more. [ ''experimental'' ].
** '''''value''''' and '''''type'''''. optional. re-used from [[hCard]]. [ ''experimental'' ].
* '''''author'''''. optional. 1 or more. re-used from [[hAtom]] using [[hCard]]. [ ''experimental'' ].
* '''''published'''''. optional. re-used from [[hAtom]]. [ ''experimental'' ].
* '''''photo'''''. optional. 1 or more. using any element containing a URL, such as IMG. re-used from [[hCard]]. [ ''experimental'' ].
* '''''tag'''''. optional. 1 or more. [ ''experimental'' ].
--[[User:ThomasLoertsch|ThomasLoertsch]] 11:01, 10 February 2009 (UTC)
</div>

== closed issues ==

<div class="vevent">
* {{ClosedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]] in the context of issue '''Too many properties'''
<div class="description discussion issues">
# '''Drop "recipe-title".''' In reviewing the examples, few (if any?) include *both* a title and a summary, and in practice the semantics of usage in the context of recipes appears to be virtually indistinguishable. Therefore we don't need both, and following in the pattern provided by [[hCalendar]] (which got it from [[RFC2445]]), we should keep the more generic concept of a "summary" and drop the concept of "title" from hRecipe.
#* I tend to agree. There are definitely use cases for both "recipe-title/title/fn" and "recipe-summary/summary" - e.g. "[http://www.simonwheatley.co.uk/2006/03/26/a-moroccan-ish-casserole/ A Moroccan-ish Casserole]" sounds more like a summary while "[http://blog.bumblepuppy.org.uk/2006/10/05/spaghetti-primavera/ Spaghetti primavera]" is the full name or the title of the recipe. But the problem is, they would serve the same purpose. [[User:Yde|Yde]] 10:07, 17 January 2009 (UTC)
#** Title and summary are different things and they are used differently in the real world. The examples you give are both names/titles/labels/headings, although more or less descriptive. They are short, memorable and make the thing adressable by humans. A summary can be (and mostly is) much longer and serves a different purpose: it describes essential properties of the object at hand, eg: "this is easy and fast to prepare, but still looks impressive", "easy, tasty, fast, vegan, good on cold days" or "the kids loved this last summer, but the ingredients can be hard to get" or "whenever i cook this i start to dream of ..." [[User:ThomasLoertsch|ThomasLoertsch]] 14:25, 20 January 2009 (UTC)
#*** Right, on second thought, I believe "title/name" and "summary" are different things. [[User:Yde|Yde]] 11:22, 23 January 2009 (UTC)
#* The term "title" has been so horribly overloaded across formats, vocabularies that it is nearly meaningless and for that reason should be avoided in any/all format efforts, preferring instead something more semantically specific such as "fn" (meaning full/formatted name of an item) or "summary" (when items are labeled more often with a short description/explanation rather than a name). [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Synonyms and homonyms are part of the real world - we have to cope with them. Also the word "title" is not horribly overloaded, you're exaggerating here. It just happened that hCard were the first to use it, and in a way that's empirically much less important then the use of "title" as the heading of a resource. Still the real problem is that Microformats have only one namespace and no resolution mechanism for conflicts like this, beside "first come first served". [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** Maybe it would be better to make a clear cut with some of the sins of the past and deprecate some terms in hCard / hCalendar[[User:ThomasLoertsch|ThomasLoertsch]] 15:30, 3 February 2009 (UTC)
#* "fn" is [[existing-classes|defined]] as "the name of the object" which is pretty much what "recipe-title" means right now. So, whether we chose to keep this property, summary, or both, renaming "recipe-title" to "fn" would make sense. [[User:Yde|Yde]] 23:03, 16 January 2009 (UTC)
#** the definition of "fn" in [[existing-classes|existing classes]] is maybe a little too short. "fn" is defined in hCard which is a reformulation of RFC 2462, which says: "Type name:FN - Type purpose: To specify the formatted text corresponding to the name of the object the vCard represents. -Type special notes: This type is based on the semantics of the X.520 Common Name attribute. The property MUST be present in the vCard object. - Type example: 'FN:Mr. John Q. Public\, Esq.'" (http://www.ietf.org/rfc/rfc2426.txt, on page 8). That clearly means a name of a person or an institution. Institution equals a juristical person, so "fn" semantically boils down to 'name of a person'. I wouldn't use that for every object. [[User:ThomasLoertsch|ThomasLoertsch]] 14:03, 20 January 2009 (UTC)
#*** Thanks for the clarification. "fn" is definitely not a good idea. [[User:Yde|Yde]] 10:00, 23 January 2009 (UTC)
#*** <code>fn</code> is already reused more generically in hAudio, hReview and hListing (for items). The definition of use within microformats has already been adapted from the strict vcard interpretation in prior work. --[[User:BenWard|BenWard]] 23:04, 27 January 2009 (UTC)
#**** I see. I can't help but thinking: what a mess... What's the family name of a recipe, audio-recording or list-entry? What's the point of re-using a semantically totally void two-letter-acronym, when it doesn't even fit very well? What's the point of reusing an element when I have to lookup the meaning of it every time anyway? [[User:ThomasLoertsch|ThomasLoertsch]] 00:48, 28 January 2009 (UTC)
#***** <code>fn</code> is ''formatted''-name, not ‘family’. ‘Name as presented’, ‘display name’. I agree that <code>fn</code> takes a double glance when you're learning, but it's there and the reuse in other specs is consistent; there's a much stronger author benefit in building on common equivalent-semantic vocabulary than introducing synonyms, which I think will cause more confusion. Better to have a strong spec with common vocabulary than introduce duplication. I'll keep in mind that we should better emphasise the expansion of <code>fn</code> in all specs for benefit of new authors. I can see how ‘family name’ is a muddle too easily made in hCard. --[[User:BenWard|BenWard]] 07:01, 28 January 2009 (UTC)
#****** I was referring to the fact that a name of a natural or juridical person is semantically quite different to the name of an object. Other things like the opacity of the two-letter-code "fn" are indeed problematic too but not my main issue here. That vCard-legacy seems to be lurking around every corner. Why not make a clear cut and deprecate the problematic parts like "title" and "fn"? The approach to rather overload the semantics (and the property-constraints) just to keep element-count low only takes that far. In the end it hinders usability instead of improving it. I think [[reuse]] and [[naming-principles]] don't strike the right balance in that respect. [[User:ThomasLoertsch|ThomasLoertsch]] 11:45, 28 January 2009 (UTC)
#* why not define a property "name"?! From my understanding of the english language (I'm not a native speaker) "name" is semantically generic enough to serve as a substitute for "title". Defining it rather broadly as "designation or title or denominator or heading of an item" would make it easily reusable. Plus we would have to explicitely discourage it's use for naming real or juristical persons and point to "fn" instead. [[User:ThomasLoertsch|ThomasLoertsch]] 12:21, 21 January 2009 (UTC)
#** Hmmm. I would really like to get feedback on this... Again my argumentation:
#*** <code>title</code> would be the best solution but is already "taken". Depercating some of hCalenders sins would be the best solution but seems out of reach so far.
#*** <code>heading</code> would be a possible solution either but seems more suited for prose
#*** <code>name</code> gets the semantics quite well, especially in the case of recipes which are more a "thing" or abstract conceptualization than a work of literature/science/prose
#*** <code>fn</code> with it's subproperties is geared towards natural and juristical persons, which are quite different from things and concepts. Also semantics of the term "fn" are rather opaque, even misleading, which hinder it's usability.
#** Therefor I'd love "title", could live very well with "name", could live still well with "heading" and would sleep bad (but sleep) with "fn". [[User:ThomasLoertsch|ThomasLoertsch]] 16:30, 2 Febuary 2009 (UTC)
#** Okay, since there's no response I bow my head to "fn". But it speaks for itself that it's the only tag that has to be explained in the schema. [[User:ThomasLoertsch|ThomasLoertsch]] 11:15, 10 February 2009 (UTC)
</div>
</div>

===template===
{{issues-format}}

==related pages==
* [[hRecipe]]
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe

2009-06-17T09:32:40Z

ThomasLoertsch: /* Implementations */ WordPress Plugin

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

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

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]] <code>duration</code> and<code>summary</code> are reused from [[hCalendar]], <code>author</code> and <code>published</code> are reused from [[hAtom]], <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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]].

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{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 element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

Main Page

2009-05-20T09:50:34Z

ThomasLoertsch: /* Drafts */ inking hRecipe to hrecipe (instead of recipe)

<entry-title>Welcome to the microformats wiki!</entry-title>
__TOC__
Please start with the [[introduction]] page and read [[how-to-play]] before making any edits.

==Introduction==

This wiki is the central resource of the microformats community. You'll find current versions of published microformat specifications, specification drafts and publishing patterns. The wiki also hosts development resources, such as brainstorming pages for new formats and issue tracking pages for all current and in-development microformats.

To get started with microformats:

* First, be familiar writing your pages and applications with semantically rich, descriptive, ‘[http://microformats.org/wiki/posh <abbr title="Plain Old Semantic HTML">POSH</abbr>]’ <abbr title="HyperText Mark-up Language">HTML</abbr>.
* Learn about microformats from the [http://microformats.org/about/ about page], [http://microformats.org/ blog], [[press]], [[presentations]], [[books]], [[podcasts]], & [[screencasts]] pages.
* Take a look at established specifications such as [[hcard|hCard]] and [[hcalendar|hCalendar]], and follow the [[hcard-examples|examples]] to start publishing microformats.
* Have questions? Read the [[faq|frequently asked questions]] and see the [[glossary]] for terms and definitions. You can also post to the {{MicroformatsMailingList}}.
* Want to learn more in person? Check out microformats [[events]].

Also, this wiki has a number of neat enhancements to assist development and contributions to microformats. Before you start editing, see the [[wiki-2|wiki introduction page]] for instructions.

==Definition==
Microformats are small patterns of HTML to represent commonly published things like [[hcard|people]], [[hcalendar|events]], [[hatom|blog posts]], [[hreview|reviews]] and [[rel-tag|tags]] in web pages.

Microformats enable the publishing of higher fidelity information on the Web; the fastest and simplest way to provide feeds and APIs for the information in your website.

* Read more explanations of [[what-are-microformats|what microformats are]], and [[what-can-you-do-with-microformats|what you can do with them]].

== How to contribute ==
Do you want to help take microformats to the next level? You can:

* [[get-started|Get started]] by adding microformats to your website, services, and products.
* [[advocacy|Advocate]] the use of microformats on other web sites, especially those you use.
* Write a [[testimonial]].
* Do something on the [[to-do|to do list]].
* Join the [[irc|IRC Channel]] and [[mail|mailing lists]] to learn and help answer questions (read the [[mailing-lists#General_guidelines|general guidelines]] before posting).
* [[Main_Page#microformats_wiki_translations|Translate this microformats wiki into other languages]] to make microformats more accessible to readers of languages around the world.
* Before proposing any new microformats, make sure your website is [[POSH]], [[get-started|uses existing microformats]], and then read the [[process]].

== Specifications ==
The list of current, stable [[microformats|Microformats]] open standard specifications.

* [[hcalendar|hCalendar]] - [http://microformats.org/code/hcalendar/creator hCalendar creator]
* [[hcard|hCard]] - [http://microformats.org/code/hcard/creator hCard creator]
* [[rel-license]]
* [[rel-nofollow]]
* [[rel-tag]]
* [[vote-links|VoteLinks]]
* [[XFN]] - [http://gmpg.org/xfn/creator XFN creator]
* [[XMDP]]
* [[xoxo|XOXO]]

''If you're tempted to try your hand at writing a microformat please read '''[[process|the process]]''' page first!''

== Drafts ==
Drafts are newer microformats, for which the specifications haven't been completed yet. Drafts are somewhat mature in the development [[process]] (see [[exploratory-discussions]] for additional efforts that are not as far along in the process). The stability of these documents cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Please watch the wiki pages for updates.

* [[adr|adr]] - for marking up address information
* [[geo|geo]] - for marking up [http://en.wikipedia.org/wiki/WGS84 WGS84] geographic coordinates (latitude; longitude)
* [[hatom|hAtom]] - syndicating episodic content (e.g. weblog postings)
* [[haudio|hAudio]]
* [[hmedia|hMedia]] - A single media publishing format that relates to Images, Video and Audio.
* [[hproduct|hProduct]]
* [[hrecipe|hRecipe]] - for cooking+baking recipes
* [[hresume|hResume]] - for publishing resumes and CVs
* [[hreview|hReview]] - [http://microformats.org/code/hreview/creator hReview creator]
* [[rel-directory]] - to indicate that the destination of a hyperlink is a directory listing containing an entry for the current page
* [[rel-enclosure]] - for indicating attachments (e.g. files) to download and cache
* [[rel-home]] - indicate a hyperlink to the homepage of the site
* [[rel-payment]] - indicate a payment mechanism
* [[robots-exclusion|robots exclusion]]
* [[xfolk|xFolk]]

== Design Patterns ==
{{design_patterns}} 
* [[elemental-microformat|elemental microformats]]
* [[compound-microformat|compound microformats]]

== Exploratory Discussions ==
See: [[exploratory-discussions]] for details of research and analysis of real-world [[examples]], existing formats, and brainstorming of possible new microformats, per the microformats [[process]].

== Examples ==
* [[examples-in-the-wild]]
* [[implementations]]
* [[zen-garden]]

== Resources ==
See [[resources]].

== User centric development ==
*[[user-interface]]
*[[data-portability]]
*[[social-network-portability]]

== Shared work areas ==
* [[to-do]]
* [[templates]]
* [http://microformats.org/wiki/delete pages for deletion] 
* [[Special:Specialpages|"Special" wiki pages]]
* [[year-in-review]]

== Tools, test cases, additional research ==
The first place to look for examples, code, and test cases is in the pages for each individual microformat. There are only a few cross-cutting [[tools|tools and services]] that need to process more than one microformat. That section is intended for editors, [[parsers]], [[validators]], test cases, and other information relevant across multiple microformats.

== Microformats wiki translations ==
You may read and edit microformats articles in many other languages:

* languages with over 100 articles
** [[Main_Page-fr|Français (French)]] {{UpdateMarker-fr}}
* languages with over 10 articles
** [[Main_Page-pt-br|Português (Brazilian Portuguese)]]
** [[Main_Page-ja|日本語 (Japanese)]]
** [[Main_Page-ru|Русский (Russian)]]
* languages with over 2 articles
** [[Main_Page-cs|Česky (Czech)]] {{NewMarker}}
** [[Main_Page-de|Deutsch (German)]]
** [[Main_Page-es|Español (Spanish)]]
** [[Main_Page-gl|Galego (Galician)]] {{NewMarker}}
** [[Main_Page-pl|Polski (Polish)]]
** [[Main_Page-ro|Română (Romanian)]] {{NewMarker}}
** [[Main_Page-zh|汉语 (Chinese)]]
* languages just started
** [[Main_Page-ar|العربية (Arabic)]]
** [[Main_Page-th|ภาษาไทย (Thai)]]
** [[Main_Page-it|Italiano (Italian)]] {{NewMarker}}
** [[Main_Page-ko|한국어 (Korean)]] {{NewMarker}}
* elsewhere
**[http://en.wikipedia.org/wiki/Microformat Wikipedia's article on microformats] has been translated into a number of languages.

See also [[other-languages]], and [[how-to-start-new-translation|how-to-start-a-new-translation]].

rel-tag

2009-05-20T09:29:52Z

ThomasLoertsch: /* Scope */ added hRecipe

<entry-title>rel="tag"</entry-title>
__TOC__
== Draft Specification 2005-01-10 ==
; Editors/Authors
:[http://tantek.com/ Tantek Çelik]
:[http://epeus.blogspot.com/ Kevin Marks]

;Concept
:[http://powazek.com/ Derek Powazek]

=== Copyright ===
{{MicroFormatCopyrightStatement2004}}
* [[User:Tantek|Tantek]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
* [[User:Kevin Marks|Kevin Marks]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
** When all authors/editors have done so, we can remove the MicroFormatCopyrightStatement template reference and replace it with the MicroFormatPublicDomainContributionStatement.

=== Patents ===
{{MicroFormatPatentStatement}}

== Abstract ==
[[Rel-Tag]] is one of several [[MicroFormats]]. By adding <code>rel="tag"</code> to a hyperlink, a page indicates that the destination of that hyperlink is an author-designated "tag" (or keyword/subject) for the current page. Note that a tag may just refer to a major portion of the current page (i.e. a blog post). e.g. by placing this link on a page,

<pre><nowiki><a href="http://technorati.com/tag/tech" rel="tag">tech</a></nowiki></pre>

the author indicates that the page (or some portion of the page) has the tag "tech".

The linked page SHOULD exist, and it is the linked page, rather than the link text, that defines the tag. The last path component of the URL
is the text of the tag, so

<pre><nowiki><a href="http://technorati.com/tag/tech" rel="tag">fish</a></nowiki></pre>

would indicate the tag "tech" rather than "fish".

== Scope ==
rel="tag" is specifically designed for "tagging" content, typically web pages (or portions thereof, like blog posts).

rel="tag" is NOT designed for "tagging" arbitrary URLs or external content. There is demand for a general decentralized syntax for tagging URLs external to the current page, but this is not meant for that. See [[xfolk|xFolk]] and [[hreview|hReview]] for ways to tag arbitrary URLs.

If you need to define tags as part of a more specialized format, rel="tag" is the recommended way to do so, and [[xfolk|xFolk]], [[hreview|hReview]], [[hcard |hCard]], [[hcalendar|hCalendar]] and [[hrecipe|hRecipe]] all do this.

== XMDP profile ==
http://microformats.org/wiki/rel-tag-profile

== Tag Spaces ==

Tags are embedded in HTTP URIs in a well-defined manner so that the tag embedded in an HTTP URI can be mechanically extracted from that URI. Specifically, the last segment of the path portion of the URI (after the final "/" character) contains the tag value. For example, the URI <pre><nowiki>http://www.example.com/tags/foo</nowiki></pre> contains the tag "foo".

Thus, for the purposes of comparing two HTTP URIs as tags, the last segment of the path portion should be extracted and only that value (that value of the tag) should be compared.

''Need more formal language about comparison and extraction process.''

The destination of a rel="tag" hyperlink is required to be a tag space (a place that collates or defines tags), where the last segment of the path of the URL is the tag, e.g.

<pre><nowiki>http://technorati.com/tag/tech </nowiki></pre>

is a URL for the tag "tech".

Tags may only be placed in the URL path, and only in the last segment of the path. Tags may not be placed in query parameters or fragment identifiers. e.g.

<pre><nowiki>http://technorati.com/tag/tech?tag=fish#emu </nowiki></pre>

is still a URL for the tag "tech", not "fish" or "emu".

Since the only part of a tag space URL of which any structure is required is the last path segment, a tag space URL can be hosted at any domain. Authors may choose to link to a tag at a particular tag space in order to provide a specific meaning. E.g. a tag for technology could link to:

<pre><nowiki> http://en.wikipedia.org/wiki/Technology </nowiki></pre>

Trailing slashes in tag URLs are ignored, that is:

<pre><nowiki> http://technorati.com/tag/Technology/ </nowiki></pre>
as a rel-tag URL is treated as:
<pre><nowiki> http://technorati.com/tag/Technology </nowiki></pre>

== Encoding issues ==
Spaces can be encoded either as <code>+</code> or <code>%20</code>. Unicode characters are encoded as specified in [http://www.ietf.org/rfc/rfc3986.txt <nowiki>RFC 3986</nowiki>]. For example:

<pre><nowiki><a href="http://technorati.com/tag/Sant%C3%A9+et+bien-%C3%AAtre" rel="tag">Santé et bien-être</a> </nowiki></pre>

Note that if using Wikipedia as a tagspace, as discussed above, you should use <code>%20</code> as they remap '+' to <code>%2B</code>, causing a page with a plus sign in the title (which usually does not exist) to appear.

== Tags Are Visible Metadata ==
<code>rel="tag"</code> hyperlinks are intended to be visible links on pages and posts. This is in stark contrast to meta keywords (which were invisible and typically never revealed to readers), and thus is at least somewhat more resilient to the problems which plagued meta keywords.

Making tag hyperlinks visible has the additional benefit of making it more obvious to readers if a page is abusing tag links, and thus providing more peer pressure for better behavior. It also makes it more obvious to authors, who may not always be aware what invisible metadata is being generated on their behalf.

As a result the invisible tag link syntax variant: <code><link rel="tag" href="..." /></code> SHOULD NOT be supported by implementations.

==Examples in the Wild==
This section is '''informative'''.

The following sites have implemented rel-tag, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If your site marked up with rel-tag, feel free to add it to the '''top''' of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://huffduffer.com/ Huffduffer] uses rel-tag on every page, pointing to its own tag space e.g. http://huffduffer.com/tags/microformats
* [http://www.pantrymothtrap.com/ Pantry Moth Traps] implements the rel-tag in articles where an authoritative source is known. (for example in the article [http://www.pantrymothtrap.com/MothTrapsPick.html Moth Trap Picks] the tag [http://www.cleanertoday.com/tag/moth%20trap Moth Trap])
* [http://www.hightechcville.com/ HighTechCville] uses rel-tag on all the pages listing tagged content for [http://www.hightechcville.com/people people], [http://www.hightechcville.com/organizations organizations] and [http://www.hightechcville.com/events events] related to high tech in Charlottesville, VA.
* [http://skateboardspot.info skateboardspot.info] uses rel-tag in spotguide entries which are added to the site and categorized by the users (for example: [http://skateboardspot.info/cat/spotguide/action/view/id/1 “El Toro High School” spotguide entry]).
* [http://www.idoneos.com Idoneos.com] uses rel-tag for conceptual links to its own tag space, a collection of 'concepts' (mostly spanish).
* [http://www.professionalontheweb.com Professional On The Web] uses rel-tag for user entered tags which categorize web professionals and freelancers.
* [https://www.coderesort.com/p/epicode/wiki/CloudCuckoo CloudCuckoo] (secure site but open to all) an [http://www.episerver.com EPiServer] module distributed free by [http://www.interakting.co.uk Interakting], generates tag clouds with rel-tag links.
* [http://www.lifetime.com Lifetime.com] uses rel- and rev-tags in all content pages.
* [http://www.my-warehouse.de the my-Warehouse shopsystem] implements rel-tags in box headings and categories links.
* Joseph Bergantine uses tags to categorize [http://bergantinedesign.us/wallpaper/ wallpapers] and [http://bergantinedesign.us/blog/my-name-is-rachel-corrie blog posts]
* [http://www.codesignville.com Codesignville] uses rel-tag to indicate content categories.
* [http://www.bossalive.com BossaLive] uses rel-tag for tagging music. Publishes rel-tags for album, artist and genre.
** Also uses [[hcard|hCard]] on user profile pages.
* [http://www.qmpeople.com/ qmpeople] Uses rel-tag for translated tags into english, french and italian to meet new friends in different countries.
* [http://www.keevu.com Keevu.com] uses rel-tag to indicate content categories on most pages, like [http://www.keevu.com/venues venues]
* [http://www.amazingincredible.com Amazing Incredible] uses rel-tag on content pages
* [http://www.auctionlink.com.au AuctionLink] uses rel-tag on [http://www.auctionlink.com.au/TagList/Auctioneers/ Auction Sales Listings] tags.
** Could also use [[hcard|hCard]], e.g. on [http://www.auctionlink.com.au/Auctioneers/Auctioneer/Bonhams_Goodman_1/] [[User:AndyMabbett|Andy Mabbett]]
* Christian Hess uses rel-tag on his [http://www.hess-cr.com homepage blog] and several other pages of his site.
* [http://spacedust.atspace.com/ Spacedust] uses rel-tag to mark up gallery pages.
* [http://my.opera.com/dstorey/blog/ My Opera] uses rel-tag for tags on all user's blog entries.
* [http://dev.opera.com/articles/view/making-wii-friendly-pages/ Dev Opera] uses rel-tag on all article tags.
* [http://www.international.unt.edu UNT International] uses rel-tag to indicate content categories on most pages
* [http://yedda.com Yedda] - Yedda publishes rel-tags for all of the tags the people entered on themselves as well as on all tags entered on questions asked on Yedda.
* [http://www.lingr.com Lingr] publishes rel-tags for all user entered tags.
* [http://odeo.com ODEO] [http://odeo.com/blog/2005/07/adding-microformats-to-odeo.html publishes] rel-tags for user entered tags.
* [http://eventful.com Eventful] publishes rel-tags for user entered tags.
* [http://spinn3r.com Spinn3r] implements rel-tag as well as RSS and Atom subject and categories.
* [http://www.weboffate.com Web of Fate] publishes rel-tags for future predictions.

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

The following implementations have been developed which either generate or parse rel-tag links. If you have a rel-tag implementation, feel free to add it to the '''top''' of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://www.textcube.org Textcube.org] makes a blogging tool, Textcube which generates rel-tag for tags on blog posts.
* [http://hashtags.org/ HashTags] tags Twitter posts, converting "#example" into a tag of "example"
* [http://ikiwiki.info ikiwiki] generates rel-tag for all tagged pages (as of version 2.6)
* [http://www.hubtag.com HubTag] helps users find a unique tag across the web for their event - eg. JohnAndBettysWeddingWimbledonMarch07
* [http://www.necctar.com Necctar] is a search engine exclusively based on tag microformat parsing and processing. Necctar uses tags entered by bloggers to index the world wide web
* Nutch has a [[rel-tag]] parser [http://www.mail-archive.com/nutch-commits@lucene.apache.org/msg01014.html committed to their svn repository].
* [http://www.webstandards.org/action/dwtf/microformats/ Dreamweaver Extension suite] from the [http://webstandards.org/ Web Standards Project] enables rel-tagging from within Dreamweaver 8.
* [http://scooch.gr0w.com/ Scooch] slide show creator allows authors to generate rel-tags and group slide shows by rel-tag via a list or cloud with tag usage count.
* The Freetag plugin for the [http://www.s9y.org Serendipity] blog software supports rel-tags on a per-entry basis, as well as inside of its tag clouds. (The Freetag plugin is available inside of SPARTACUS)
* [http://placenamehere.com/TXP/pnh_mf/ pnh_mf] is a plugin for [http://textpattern.com/ Textpattern] that supports embedding rel-tags and other microformats in templates and blog posts. Written by [http://placenamehere.com/ Chris Casciano].
* [http://www.truist.com/blog/493/trutags-a-tagging-plugin-for-textpattern tru_tags] is a plugin for [http://textpattern.com/ Textpattern] that supports rel-tagging blog posts via the Keywords field.
* [http://news.livejournal.com/86492.html?thread=24881884 LiveJournal] - see also [http://www.livejournal.com/support/faq.bml?cat=tags their FAQ regarding their tags support]
* [http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/TagsLinks TagsLinks] Turn each tag into links that let you find related content on tagging services.
* [http://dev.wp-plugins.org/wiki/BunnysTechnoratiTags Tag plugin for WordPress]
** Note that some sites using WordPress (http://microformatique.com/ for instance) are getting incorrect tags. The tag is ?cat=12 instead of the actual tag value.
* [http://noone.org/blog/tags/Tagging Tag plugin for Blosxom]
* Technorati first implemented rel-tag in its [http://technorati.com/tag/ Technorati Tags] service. Technorati indexes rel-tag tags.
* [http://consumingexperience.blogspot.com/2005/12/updated-multiple-word-technorati-tag.html Greasemonkey script for Firefox that generates tags for Blogger]
* [http://tools.microformatic.com/help/xhtml/rel-lint/ rel-lint] is a validation tool by [[User:DrewMcLellan|Drew McLellan]] that will validate existence of rel-tag attributes.

== References ==
=== Normative References ===
* [http://www.w3.org/TR/REC-html40/ HTML 4]
* [http://www.w3.org/TR/xhtml1/ XHTML 1]
* [http://gmpg.org/xmdp/ XMDP]
* RFC 3986 specifies URL syntax. Section 3.3 specifies URL paths and path segments.

=== Informative References ===
* [[hreview|hReview]] uses rel-tag for tags and scalar tags
* [[xfolk|xFolk]] uses rel-tag to build a distributed remote resource tagging construct
* [http://developers.technorati.com/wiki/attentionxml Attention.XML] uses rel-tag for reader tagging of pages, posts, feeds
* [[hcard|hCard]] can use rel-tag for categories
* [[hcalendar|hCalendar]] can use rel-tag for categories
* [http://technorati.com/help/tags.html Using Technorati Tags]
* Contributed from http://developers.technorati.com/wiki/RelTag
* [http://microformatique.com/?p=61 Know your rel-tag] at microformatique.com

== Discussions ==
* Feedback is encouraged on the [[rel-tag-feedback]] page.
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
* History: [http://www.powazek.com/2005/07/000532.html How Tags Happened at Technorati] by [http://www.powazek.com/ Derek Powazek]

=== Q&A ===
* If you have any questions about rel-tag, check the [[rel-faq|rel FAQ]] first for general rel attribute questions, then check the [[rel-tag-faq|rel-tag FAQ]], and then if you don't find answers, ask your question on the [http://microformats.org/discuss microformats-discuss] mailing list.

==Related pages==
{{rel-tag-related-pages}}

[[Category:Specifications]]
[[Category:rel-tag]]

hrecipe

2009-05-19T11:04:43Z

ThomasLoertsch: /* Implementations */ added essen&trinken

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

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

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]] <code>duration</code> and<code>summary</code> are reused from [[hCalendar]], <code>author</code> and <code>published</code> are reused from [[hAtom]], <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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]].

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{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 element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-rdf

2009-05-19T10:58:47Z

ThomasLoertsch: /* related pages */

= aRecipe - a mapping of the hRecipe microformat to RDF =

== Purpose ==
In some cases people want or need to use an RDF-based solution to add metadata to web pages. [http://www.w3.org/TR/xhtml-rdfa-primer/ RDFa] is a standardized way to do so. While it's not as easy to use as microformats it serves certain use cases that microformats can not handle like e.g. when you want to add metadata to certain parts of a page and other metadata to the page as a whole. RDFa is also a straight forward solution for domains which are not covered by a microformat but where a well established RDF vocabulary already exists.

== Documentation ==
[http://purl.org/arecipe/ aRecipe] is a mapping from hRecipe to RDF as thorough and 1:1 as possible. It is part of a bigger effort to map all microformats into one RDF vocabulary, called [http://purl.org/amicroformat/ aMicroformat]. But since that is a lot of work and will take some more time the aRecipe part of aMicroformat is a first shot.

The official location of the voacbulary is at [http://purl.org/arecipe/ http://purl.org/arecipe/]. There you'll always find the latest version, currently in two encodings: [http://rat.io/nal/amicroformat/arecipe/arecipe.n3 n3] and [http://rat.io/nal/amicroformat/arecipe/arecipe.rdf RDF/XML]. Hopefully soon some documentation will be added as well.

== Implementation ==
aRecipe has been implemented on http://www.essen-und-trinken.de, e.g. here: [http://www.essen-und-trinken.de/rezept/144350/apfelkuchen-vom-blech.html apple pie] (in german, sorry ;-). A convenient way to look at the RDFa is the [http://www.w3.org/2007/08/pyRdfa/ RDFa Distiller]. See below an excerpt of the RDF generated from the apple pie recipe.

Enjoy and leave comments and feedback at the bottom of this page.

== The RDF mapping of hRecipe ==
The original mapping at http://purl.org/arecipe/ additionally contains some more constructs to model the constraints on each element. These constructs are rather involved because the constraints are rather complex and OWL isn't particularily suited to model constraints. Because of that it's not sure if they will be part of the final version.

<pre>
<rdf:RDF xmlns="http://www.w3.org/2000/01/rdf-schema#"
xmlns:owl="http://www.w3.org/2002/07/owl#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">

<owl:Ontology rdf:about="http://purl.org/amicroformat/arecipe/">
<comment>The hRecipe microformat is designed for the mark-up of instructions for creating meals, drinks or food-based items. <http://microformats.org/wiki/recipe#Introduction></comment>
<comment>This ontology is only informative. The normative version is always that on the site <http://microformats.org>.</comment>
<comment>microformats are a way to encode semantic information into (x)html. they define formats that share one common namespace. this piece of work defines a mapping from the hRecipe microformat into RDF by mirroring the elements of that microformat as straight as possible into an RDF vocabulary.</comment>
<label>aRecipe</label>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe"/>
<owl:versionInfo>28042009</owl:versionInfo>
<owl:versionInfo>Draft 0.21</owl:versionInfo>
</owl:Ontology>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/Recipe">
<comment>A Recipe is used to identify and describe values and metadata typically associated with a recipe.</comment>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#hRecipe"/>
<label>recipe</label>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:cardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:cardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/fn"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/ingredient"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:maxCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:maxCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">0</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
</subclassOf>
</owl:Class>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/author">
<comment>An Author is the person who authored the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Author"/>
<label>author</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#author"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/duration">
<comment>The time it takes to prepare the meal described by the recipe. Multiple duration fields 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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#duration"/>
<label>duration</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/fn">
<comment>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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCard"/>
<label>title</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#fn"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/ingredient">
<comment>Describes one or more ingredients used in the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#ingredient"/>
<label>ingredient</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/instructions">
<comment>The method of the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#instructions"/>
<label>instructions</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/nutrition">
<comment>Nutritional information like calories, fat, dietary fiber etc. </comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#nutrition"/>
<label>nutrition</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/photo">
<comment>Accompanying image. </comment>
<comment>See section 3.1.4 of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>photo</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#photo"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/published">
<comment>The date the recipe was published.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Published"/>
<label>published</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#published"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/summary">
<comment>The summary provides a short introduction or an accompanying statement about the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCalendar"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#summary"/>
<label>summary</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/tag">
<comment>Indicates that the referred resource serves as a 'tag', or keyword/subject, for the referring page.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/rel-tag#XMDP_profile"/>
<label>rel-tag</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#tag"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/type">
<comment>Defines a type of the parent element. For instance a type of telephone number such as home or work. Used in conjunction with 'value'. <http://microformats.org/wiki/existing-classes></comment>
<comment>See 'type' in the various sections of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>type</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/value">
<comment>This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<comment>Used in conjunction with 'type'. The actual value of a particular type. For instance a telephone number of type work such as +1.415.555.1212. <http://microformats.org/wiki/existing-classes></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>value</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/yield">
<comment>Specifies the quantity produced by the recipe, like how many persons it satisfyies or how many pieces can be made of it.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#yield"/>
<label>yield</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/IngredientClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/NutritionClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</rdf:Description>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
</rdf:Description>
</rdf:RDF>
</pre>

== Generated RDFa ==

<pre>
<?xml version="1.0" encoding="utf-8"?>
<rdf:RDF
xmlns:amf="http://purl.org/amicroformat/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:xhv="http://www.w3.org/1999/xhtml/vocab#"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
>
<amf:Recipe rdf:about="http://www.essen-und-trinken.de/rezept/144350">
<amf:duration xml:lang="de">1 h </amf:duration>
<amf:yield xml:lang="de">Für 24 Stücke</amf:yield>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/schnellundeinfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/party"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/kuchentorte"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfelkuchen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/backen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/gutvorzubereiten"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/einfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfel"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/nuesse"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/obst"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/blechkuchen"/>
<amf:ingredient rdf:parseType="Literal">6 El Zitronensaft</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">200 g Zucker</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g Schmand</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">500 g Mehl</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">1,2 kg Äpfel </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">1 Pk. Backpulver</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g gehackte Mandeln</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">300 g Butter</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">3 El Calvados</amf:ingredient>
<amf:ingredient xml:lang="de"> Salz</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">6 Eier </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">125 g Puderzucker</amf:ingredient>
<amf:fn xml:lang="de">Apfelkuchen vom Blech</amf:fn>
<amf:instructions rdf:parseType="Literal">
1. Mandeln in einer Pfann ohne Fett anrösten. Herausnehmen und abkühlen lassen. Die Äpfel schälen, vierteln und entkernen. In Würfel schneiden und mit Zitronensaft beträufeln.2. Butter, Zucker und 1 Prise Salz cremig rühren. Eier nacheinander unterrühren. Mehl, Backpulver und Mandeln mischen und abwechselnd mit dem Schmand unter die Ei-Zucker-Masse rühren. Auf ein mit Backpapier belegtes Blech streichen. Apfelwürfel darüber streuen. Im vorgeheizten Ofen bei 175 ° backen ca. 40 Min. backen. 3. Puderzucker und Calvados glatt rühren und über den heißen Kuchen träufeln.</amf:instructions>
<amf:author rdf:parseType="Literal"> Von <a href="/user/melaFTL" rel="nofollow" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml">melaFTL</a><a href="#" id="addFavoriteCookLinkActive" onclick="return false;; return false;" style="display:none" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml"><img alt="Icon_user_rot" id="addFavoriteCookLinkAktiveImg" src="/img/icon_user_rot.gif"/></a> </amf:author>
<amf:note rdf:parseType="Literal">Der Kuchen wird weihnachtlich, wenn man in den Teig noch etwas Lebkuchengewürz gibt, etwa 1 1/2 Tl. </amf:note>
</amf:Recipe>
</rdf:RDF>
</pre>

== Feedback ==
Please add questions and comments in the following sections.
=== Template ===
{{issues-format}}

=== General Questions ===

=== General Comments ===

==related pages==
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]]
* [[hrecipe-feedback|hRecipe feedback]]

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

hrecipe-rdf

2009-05-19T10:55:08Z

ThomasLoertsch: /* Documentation */corrected broken links

= aRecipe - a mapping of the hRecipe microformat to RDF =

== Purpose ==
In some cases people want or need to use an RDF-based solution to add metadata to web pages. [http://www.w3.org/TR/xhtml-rdfa-primer/ RDFa] is a standardized way to do so. While it's not as easy to use as microformats it serves certain use cases that microformats can not handle like e.g. when you want to add metadata to certain parts of a page and other metadata to the page as a whole. RDFa is also a straight forward solution for domains which are not covered by a microformat but where a well established RDF vocabulary already exists.

== Documentation ==
[http://purl.org/arecipe/ aRecipe] is a mapping from hRecipe to RDF as thorough and 1:1 as possible. It is part of a bigger effort to map all microformats into one RDF vocabulary, called [http://purl.org/amicroformat/ aMicroformat]. But since that is a lot of work and will take some more time the aRecipe part of aMicroformat is a first shot.

The official location of the voacbulary is at [http://purl.org/arecipe/ http://purl.org/arecipe/]. There you'll always find the latest version, currently in two encodings: [http://rat.io/nal/amicroformat/arecipe/arecipe.n3 n3] and [http://rat.io/nal/amicroformat/arecipe/arecipe.rdf RDF/XML]. Hopefully soon some documentation will be added as well.

== Implementation ==
aRecipe has been implemented on http://www.essen-und-trinken.de, e.g. here: [http://www.essen-und-trinken.de/rezept/144350/apfelkuchen-vom-blech.html apple pie] (in german, sorry ;-). A convenient way to look at the RDFa is the [http://www.w3.org/2007/08/pyRdfa/ RDFa Distiller]. See below an excerpt of the RDF generated from the apple pie recipe.

Enjoy and leave comments and feedback at the bottom of this page.

== The RDF mapping of hRecipe ==
The original mapping at http://purl.org/arecipe/ additionally contains some more constructs to model the constraints on each element. These constructs are rather involved because the constraints are rather complex and OWL isn't particularily suited to model constraints. Because of that it's not sure if they will be part of the final version.

<pre>
<rdf:RDF xmlns="http://www.w3.org/2000/01/rdf-schema#"
xmlns:owl="http://www.w3.org/2002/07/owl#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">

<owl:Ontology rdf:about="http://purl.org/amicroformat/arecipe/">
<comment>The hRecipe microformat is designed for the mark-up of instructions for creating meals, drinks or food-based items. <http://microformats.org/wiki/recipe#Introduction></comment>
<comment>This ontology is only informative. The normative version is always that on the site <http://microformats.org>.</comment>
<comment>microformats are a way to encode semantic information into (x)html. they define formats that share one common namespace. this piece of work defines a mapping from the hRecipe microformat into RDF by mirroring the elements of that microformat as straight as possible into an RDF vocabulary.</comment>
<label>aRecipe</label>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe"/>
<owl:versionInfo>28042009</owl:versionInfo>
<owl:versionInfo>Draft 0.21</owl:versionInfo>
</owl:Ontology>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/Recipe">
<comment>A Recipe is used to identify and describe values and metadata typically associated with a recipe.</comment>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#hRecipe"/>
<label>recipe</label>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:cardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:cardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/fn"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/ingredient"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:maxCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:maxCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">0</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
</subclassOf>
</owl:Class>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/author">
<comment>An Author is the person who authored the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Author"/>
<label>author</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#author"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/duration">
<comment>The time it takes to prepare the meal described by the recipe. Multiple duration fields 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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#duration"/>
<label>duration</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/fn">
<comment>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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCard"/>
<label>title</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#fn"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/ingredient">
<comment>Describes one or more ingredients used in the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#ingredient"/>
<label>ingredient</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/instructions">
<comment>The method of the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#instructions"/>
<label>instructions</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/nutrition">
<comment>Nutritional information like calories, fat, dietary fiber etc. </comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#nutrition"/>
<label>nutrition</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/photo">
<comment>Accompanying image. </comment>
<comment>See section 3.1.4 of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>photo</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#photo"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/published">
<comment>The date the recipe was published.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Published"/>
<label>published</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#published"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/summary">
<comment>The summary provides a short introduction or an accompanying statement about the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCalendar"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#summary"/>
<label>summary</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/tag">
<comment>Indicates that the referred resource serves as a 'tag', or keyword/subject, for the referring page.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/rel-tag#XMDP_profile"/>
<label>rel-tag</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#tag"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/type">
<comment>Defines a type of the parent element. For instance a type of telephone number such as home or work. Used in conjunction with 'value'. <http://microformats.org/wiki/existing-classes></comment>
<comment>See 'type' in the various sections of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>type</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/value">
<comment>This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<comment>Used in conjunction with 'type'. The actual value of a particular type. For instance a telephone number of type work such as +1.415.555.1212. <http://microformats.org/wiki/existing-classes></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>value</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/yield">
<comment>Specifies the quantity produced by the recipe, like how many persons it satisfyies or how many pieces can be made of it.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#yield"/>
<label>yield</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/IngredientClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/NutritionClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</rdf:Description>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
</rdf:Description>
</rdf:RDF>
</pre>

== Generated RDFa ==

<pre>
<?xml version="1.0" encoding="utf-8"?>
<rdf:RDF
xmlns:amf="http://purl.org/amicroformat/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:xhv="http://www.w3.org/1999/xhtml/vocab#"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
>
<amf:Recipe rdf:about="http://www.essen-und-trinken.de/rezept/144350">
<amf:duration xml:lang="de">1 h </amf:duration>
<amf:yield xml:lang="de">Für 24 Stücke</amf:yield>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/schnellundeinfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/party"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/kuchentorte"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfelkuchen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/backen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/gutvorzubereiten"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/einfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfel"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/nuesse"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/obst"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/blechkuchen"/>
<amf:ingredient rdf:parseType="Literal">6 El Zitronensaft</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">200 g Zucker</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g Schmand</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">500 g Mehl</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">1,2 kg Äpfel </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">1 Pk. Backpulver</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g gehackte Mandeln</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">300 g Butter</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">3 El Calvados</amf:ingredient>
<amf:ingredient xml:lang="de"> Salz</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">6 Eier </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">125 g Puderzucker</amf:ingredient>
<amf:fn xml:lang="de">Apfelkuchen vom Blech</amf:fn>
<amf:instructions rdf:parseType="Literal">
1. Mandeln in einer Pfann ohne Fett anrösten. Herausnehmen und abkühlen lassen. Die Äpfel schälen, vierteln und entkernen. In Würfel schneiden und mit Zitronensaft beträufeln.2. Butter, Zucker und 1 Prise Salz cremig rühren. Eier nacheinander unterrühren. Mehl, Backpulver und Mandeln mischen und abwechselnd mit dem Schmand unter die Ei-Zucker-Masse rühren. Auf ein mit Backpapier belegtes Blech streichen. Apfelwürfel darüber streuen. Im vorgeheizten Ofen bei 175 ° backen ca. 40 Min. backen. 3. Puderzucker und Calvados glatt rühren und über den heißen Kuchen träufeln.</amf:instructions>
<amf:author rdf:parseType="Literal"> Von <a href="/user/melaFTL" rel="nofollow" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml">melaFTL</a><a href="#" id="addFavoriteCookLinkActive" onclick="return false;; return false;" style="display:none" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml"><img alt="Icon_user_rot" id="addFavoriteCookLinkAktiveImg" src="/img/icon_user_rot.gif"/></a> </amf:author>
<amf:note rdf:parseType="Literal">Der Kuchen wird weihnachtlich, wenn man in den Teig noch etwas Lebkuchengewürz gibt, etwa 1 1/2 Tl. </amf:note>
</amf:Recipe>
</rdf:RDF>
</pre>

== Feedback ==
Please add questions and comments in the following sections.
=== Template ===
{{issues-format}}

=== General Questions ===

=== General Comments ===

==related pages==
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-rdf

2009-05-19T10:50:13Z

ThomasLoertsch: a first shot

= aRecipe - a mapping of the hRecipe microformat to RDF =

== Purpose ==
In some cases people want or need to use an RDF-based solution to add metadata to web pages. [http://www.w3.org/TR/xhtml-rdfa-primer/ RDFa] is a standardized way to do so. While it's not as easy to use as microformats it serves certain use cases that microformats can not handle like e.g. when you want to add metadata to certain parts of a page and other metadata to the page as a whole. RDFa is also a straight forward solution for domains which are not covered by a microformat but where a well established RDF vocabulary already exists.

== Documentation ==
[http://purl.org/arecipe/ aRecipe] is a mapping from hRecipe to RDF as thorough and 1:1 as possible. It is part of a bigger effort to map all microformats into one RDF vocabulary, called [http://purl.org/amicroformat/ aMicroformat]. But since that is a lot of work and will take some more time the aRecipe part of aMicroformat is a first shot.

The official location of the voacbulary is at [http://purl.org/arecipe/ http://purl.org/arecipe/]. There you'll always find the latest version, currently in two encodings: [http://purl.org/arecipe/arecipe.n3 n3] and [http://purl.org/arecipe/arecipe.rdf RDF/XML]. Hopefully soon some documentation will be added as well.

== Implementation ==
aRecipe has been implemented on http://www.essen-und-trinken.de, e.g. here: [http://www.essen-und-trinken.de/rezept/144350/apfelkuchen-vom-blech.html apple pie] (in german, sorry ;-). A convenient way to look at the RDFa is the [http://www.w3.org/2007/08/pyRdfa/ RDFa Distiller]. See below an excerpt of the RDF generated from the apple pie recipe.

Enjoy and leave comments and feedback at the bottom of this page.

== The RDF mapping of hRecipe ==
The original mapping at http://purl.org/arecipe/ additionally contains some more constructs to model the constraints on each element. These constructs are rather involved because the constraints are rather complex and OWL isn't particularily suited to model constraints. Because of that it's not sure if they will be part of the final version.

<pre>
<rdf:RDF xmlns="http://www.w3.org/2000/01/rdf-schema#"
xmlns:owl="http://www.w3.org/2002/07/owl#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">

<owl:Ontology rdf:about="http://purl.org/amicroformat/arecipe/">
<comment>The hRecipe microformat is designed for the mark-up of instructions for creating meals, drinks or food-based items. <http://microformats.org/wiki/recipe#Introduction></comment>
<comment>This ontology is only informative. The normative version is always that on the site <http://microformats.org>.</comment>
<comment>microformats are a way to encode semantic information into (x)html. they define formats that share one common namespace. this piece of work defines a mapping from the hRecipe microformat into RDF by mirroring the elements of that microformat as straight as possible into an RDF vocabulary.</comment>
<label>aRecipe</label>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe"/>
<owl:versionInfo>28042009</owl:versionInfo>
<owl:versionInfo>Draft 0.21</owl:versionInfo>
</owl:Ontology>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/Recipe">
<comment>A Recipe is used to identify and describe values and metadata typically associated with a recipe.</comment>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#hRecipe"/>
<label>recipe</label>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:cardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:cardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/fn"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/ingredient"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:maxCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">1</owl:maxCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</subclassOf>
<subclassOf rdf:parseType="Resource">
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Restriction"/>
<owl:minCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int">0</owl:minCardinality>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:onProperty rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
</subclassOf>
</owl:Class>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/author">
<comment>An Author is the person who authored the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Author"/>
<label>author</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#author"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/duration">
<comment>The time it takes to prepare the meal described by the recipe. Multiple duration fields 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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#duration"/>
<label>duration</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/fn">
<comment>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.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCard"/>
<label>title</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#fn"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/ingredient">
<comment>Describes one or more ingredients used in the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#ingredient"/>
<label>ingredient</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/instructions">
<comment>The method of the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#instructions"/>
<label>instructions</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/nutrition">
<comment>Nutritional information like calories, fat, dietary fiber etc. </comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#nutrition"/>
<label>nutrition</label>
<range rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/photo">
<comment>Accompanying image. </comment>
<comment>See section 3.1.4 of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>photo</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#photo"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/published">
<comment>The date the recipe was published.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hAtom#Entry_Published"/>
<label>published</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#published"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/summary">
<comment>The summary provides a short introduction or an accompanying statement about the recipe.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hCalendar"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#summary"/>
<label>summary</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/tag">
<comment>Indicates that the referred resource serves as a 'tag', or keyword/subject, for the referring page.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/rel-tag#XMDP_profile"/>
<label>rel-tag</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<seeAlso rdf:resource="http://microformats.org/wiki/hrecipe#tag"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/type">
<comment>Defines a type of the parent element. For instance a type of telephone number such as home or work. Used in conjunction with 'value'. <http://microformats.org/wiki/existing-classes></comment>
<comment>See 'type' in the various sections of RFC 2426. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>type</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/value">
<comment>This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property. <http://www.ietf.org/rfc/rfc2426.txt></comment>
<comment>Used in conjunction with 'type'. The actual value of a particular type. For instance a telephone number of type work such as +1.415.555.1212. <http://microformats.org/wiki/existing-classes></comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hcard"/>
<label>value</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:DatatypeProperty rdf:about="http://purl.org/amicroformat/arecipe/yield">
<comment>Specifies the quantity produced by the recipe, like how many persons it satisfyies or how many pieces can be made of it.</comment>
<domain rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<isDefinedBy rdf:resource="http://microformats.org/wiki/hrecipe#yield"/>
<label>yield</label>
<range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
</owl:DatatypeProperty>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/IngredientClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<owl:Class rdf:about="http://purl.org/amicroformat/arecipe/NutritionClass">
<comment>A helper class for constructing the RDF-graph</comment>
</owl:Class>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/Recipe"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/author"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/duration"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/instructions"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/nutrition"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/photo"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/published"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/summary"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/tag"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/yield"/>
</rdf:Description>

<rdf:Description>
<rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Axiom"/>
<comment>Some fields are marked experimental since they exceed the minimum set of elements 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 elements 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.</comment>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/IngredientClass"/>
<owl:object rdf:resource="http://purl.org/amicroformat/arecipe/NutritionClass"/>
<owl:predicate rdf:resource="http://www.w3.org/2000/01/rdf-schema#domain"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/type"/>
<owl:subject rdf:resource="http://purl.org/amicroformat/arecipe/value"/>
</rdf:Description>
</rdf:RDF>
</pre>

== Generated RDFa ==

<pre>
<?xml version="1.0" encoding="utf-8"?>
<rdf:RDF
xmlns:amf="http://purl.org/amicroformat/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:xhv="http://www.w3.org/1999/xhtml/vocab#"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
>
<amf:Recipe rdf:about="http://www.essen-und-trinken.de/rezept/144350">
<amf:duration xml:lang="de">1 h </amf:duration>
<amf:yield xml:lang="de">Für 24 Stücke</amf:yield>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/schnellundeinfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/party"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/kuchentorte"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfelkuchen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/backen"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/gutvorzubereiten"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/einfach"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/apfel"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/nuesse"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/kategorie/obst"/>
<amf:tag rdf:resource="http://www.essen-und-trinken.de/rezepte/tag/blechkuchen"/>
<amf:ingredient rdf:parseType="Literal">6 El Zitronensaft</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">200 g Zucker</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g Schmand</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">500 g Mehl</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">1,2 kg Äpfel </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">1 Pk. Backpulver</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">100 g gehackte Mandeln</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">300 g Butter</amf:ingredient>
<amf:ingredient rdf:parseType="Literal">3 El Calvados</amf:ingredient>
<amf:ingredient xml:lang="de"> Salz</amf:ingredient>

<amf:ingredient rdf:parseType="Literal">6 Eier </amf:ingredient>
<amf:ingredient rdf:parseType="Literal">125 g Puderzucker</amf:ingredient>
<amf:fn xml:lang="de">Apfelkuchen vom Blech</amf:fn>
<amf:instructions rdf:parseType="Literal">
1. Mandeln in einer Pfann ohne Fett anrösten. Herausnehmen und abkühlen lassen. Die Äpfel schälen, vierteln und entkernen. In Würfel schneiden und mit Zitronensaft beträufeln.2. Butter, Zucker und 1 Prise Salz cremig rühren. Eier nacheinander unterrühren. Mehl, Backpulver und Mandeln mischen und abwechselnd mit dem Schmand unter die Ei-Zucker-Masse rühren. Auf ein mit Backpapier belegtes Blech streichen. Apfelwürfel darüber streuen. Im vorgeheizten Ofen bei 175 ° backen ca. 40 Min. backen. 3. Puderzucker und Calvados glatt rühren und über den heißen Kuchen träufeln.</amf:instructions>
<amf:author rdf:parseType="Literal"> Von <a href="/user/melaFTL" rel="nofollow" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml">melaFTL</a><a href="#" id="addFavoriteCookLinkActive" onclick="return false;; return false;" style="display:none" xml:lang="de" xmlns="http://www.w3.org/1999/xhtml"><img alt="Icon_user_rot" id="addFavoriteCookLinkAktiveImg" src="/img/icon_user_rot.gif"/></a> </amf:author>
<amf:note rdf:parseType="Literal">Der Kuchen wird weihnachtlich, wenn man in den Teig noch etwas Lebkuchengewürz gibt, etwa 1 1/2 Tl. </amf:note>
</amf:Recipe>
</rdf:RDF>
</pre>

== Feedback ==
Please add questions and comments in the following sections.
=== Template ===
{{issues-format}}

=== General Questions ===

=== General Comments ===

==related pages==
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-feedback

2009-05-19T08:55:18Z

ThomasLoertsch: /* Related Pages */ added hrecipe-rdf

This document is for keeping track of feedback about [[recipe|hRecipe]], one of several MicroFormats.

== Template ==
{{issues-format}}

== Feedback ==
=== General Questions ===

=== General Comments ===

==related pages==
* [[hRecipe]]
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-issues

2009-05-19T08:52:59Z

ThomasLoertsch: /* related pages */

== issues ==
Please add new issues to the '''bottom''' of this section by copy and pasting the [[hrecipe-issues#template|Template]]. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

<div class="vevent">
* {{OpenIssue}} 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* '''"num" and "unit"'''. I only recently discovered the properties "type" and "value" from 'hCard'. I'll replace "num" and "unit" from the unfinished 'measure' with them.
** The decision to replace "num", "unit", and "item" with "type" and "value" needs further explanation. Was it due to the fact that measure is unfinished? If so I think leaving "ingredient" and "nutrition" as text strings until measure is finished would be a better idea. The transition from "type"/"value" to measure will be difficult at a later point and I believe measure is more appropriate than re-using hCard. [[User:Yde|Yde]] 11:46, 23 January 2009 (UTC)
*** The proposal to replace "num", "unit", and "item" with "type" and "value" has several reasons: first, i only recently thoroughly and systematically investgated other formats and that's when i found "type" and "value". They have a semantic advantage in that they may be more suitable for cases like value:"2"/type:"eggs" or value:"1/2"/type:"spoonfull" which are rather informal ways of putting measures, at least do not lend themselves easily to formal specification. Another reason is that these terms come from a comparably very stable vocabulary, while measure has not even draft status. It would be perfectly okay for measure to change attribute names, semantics or even the whole structure of the vocabulary. Although it doesn't look like that measure will (have to) do that I'd prefer to stay on the safe side, especially since we might even gain semantic advantage. [[User:ThomasLoertsch|ThomasLoertsch]] 19:43, 23 January 2009 (UTC)
**** I'm still not sure this is the right decision. 1) I don't think the semantic meaning of hCard's "type"/"value" is exactly equivalent to measure's "num"/"unit"/"item". From the [[hcard-profile]]: "Value: This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property." So what is the actual value of an ingredient? Is it the name of the ingredient or is the quantity? 2) This is ''exactly'' what [[measure]] is for. The advantage of being able to convert measures would IMO be one of the gratest advantages of hRecipe. I don't see why value:"2"/type:"eggs" is better than num:"2"/item:"eggs"? I agree that cases like value:"1/2"/type:"spoonfull" is problematic, but that's a [[measure]] issue. 3) Many [[recipe-formats]] use quantity/unit/item.
***** Measurements are rather informal in recipes and therefor the type/value pair seems quite appropriate to me. Automatic translation is out of scope. Anyway for a good enough machine translation of a recipe the markup of the ingredients won't be the main hurdle. Standardizing the informal quantities would be a requirement for such an effort. I made some suggestions for a vocabulary of most used "units" like cups, teespoonfulls etc a few months ago but no one reacted. So I dropped it.
***** But we're moving in circles. You are making valid points too. One reason I decided this way is that it's more inline with other decisions like reusing "fn". Since not all the shortcomings of microformats can be solved within hRecipe and since there has been no interest in discussing them here I decided to go the way of least resistance and stick with the customs of compactness, reuse and rather lax interpretation of semantic constraints. IMO hRecipe is now consistent with the genereal microformats approach and neither necessitates nor hinders a general redesign of microformats (which I think would be a good thing). --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
**** Proposed resolution: keep "ingredient" as a text string like "yield" - which would also benefit from a measure format - until such a format is ready. [[User:Yde|Yde]] 10:23, 15 February 2009 (UTC)
***** I opened this issue again and marked the subproperty 'value' and 'type' of ingredient as ''experimental''. This should leave enough room to discuss this issue further. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Too many properties.''' From reviewing the [[recipe-examples]], it does not appear that the schema implied by the examples justify the number of properties in hRecipe, especially for a first draft. microformats should start as small as possible (even smaller), and in this regard I believe several improvements could be made. There is one obvious example of recipe-title vs recipe-summary, but it looks like there may be more. Would appreciate feedback from folks who add hRecipe to the recipes on the web regarding which properties they ended up not using.
#* It is not necessarily helpful to constrain a vocabulary by all means. hCard and hCalender are examples for too large vocabularies (which mostly stems from the approach taken of converting an existing vocab 1:1) which are not as easily usable as one would wish. But to be useful a vocabluary should encompass 80:20 of the usecases, otherwise it may well not be worth the burden of implementation. We better try to hit that sweet spot right from the start - since otherwise, how should hRecipe get traction in the wild. All of the proposed properties are used on big recipe sites (many 'user generated content' sites among them) on the web. Please provide more arguments which properties you specifically think are superfluous. The only concrete example you give is to replace title by summary (which I think is a bad idea). [[User:ThomasLoertsch|ThomasLoertsch]]
#* Version 0.2 (and a little more so 0.21) has marked all but the most essential properties as ''experimental''. There use is not at all discouraged but implementors are warned that these properties may be removed from later version if they aren't used in real world applications. This uptake by implementors should be observed and studied before a final descision is made. A proposed timeframe would be at least a few months, maybe even a year or two, depending on how many implemetations surface in the meantime. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

== resolved issues ==
<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description">
*# '''author is re-used from hAtom not hCard'''. minor issue. the "author" property is actually re-used from [[hAtom]] rather than hCard - hCard has no such property.
*#* Yikes! Corrected... [[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}}2008-01-17 raised by [[User:Yde|Yde]]
<div class="description">
* '''method'''. Would it make sense to [[reuse]] [[hreview|hReview's]] "description" instead of hRecipe's "method" or is this stretching the semantics too far?
** I just discovered that hCalender uses "method", and with totally different semantics. So I guess we MUST change it. I'm not very happy with "description" though - that's a very unspecific term. Maybe "instructions", or "steps", or "preparation" , or "procedure"? They are all 'available'. I like "instructions" most, but since I'm not a native speaker I'm hesitant. Maybe the semantics are too different? Maybe "preparation" is better since we already almost have it (or had it - see the discussion about "preparation-time" -> "duration" above)? [[User:ThomasLoertsch|ThomasLoertsch]] 12:24, 21 January 2009 (UTC)
** Since no further comments surfaced I'll change the property name to "instructions". I think it's a fairly unambiguous name which also can easily be reused in other formats. [[User:ThomasLoertsch|ThomasLoertsch]] 14:30, 2 Febuary 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Unnecessary recipe prefixing of summary property.''' Note: this is a re-opening of an issue from [[recipe-issues]]. The usage of summary in recipes appears to be very similar to that used for events. Rephrased, insufficient (if any?) evidence has been provided that summary means anything "special" enough (distinguishing it from the generic term "summary" as used in microformats) in the context of recipes to merit prefixing and thus a new property.
#* proposed resolution: Re-use generic "summary" property rather than introducing a recipe microformat scoped "recipe-summary" property.
#* I agree principally but there are different "summary"s around: The [[hReview]]-Draft specifies a summary as "This optional field serves as a title for the review itself" while the [[hCalendar]] Draft refers to RFC 2445 which defines summary as "This property defines a short summary or subject for the calendar component". I certainly agree more with the semantics from RFC 2445 but referring to either of the two doesn't make much sense right now. Since you are editor of both hReview and hCalendar maybe you can clarify the subject? If hReview would be aligned with RFC 2445 then I would promote dropping the prefix.[[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
#** Agreed, the definitions of "summary" across hCalendar and hReview could be better converged. Please add this as an issue to both [[hcalendar-issues]] and [[hreview-issues]] and I'll follow-up there accordingly. Given that is the path forward, let's fix this immediately in hRecipe now that the issue (and resolution) has been captured. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Will change "recipe-summary" to "summary" as defined in hCalender/RFC2445. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''preparation-time could re-use duration instead''' - it appears that the "preparation-time" semantic basically means the "duration" of the recipe, and thus could re-use that property from [[hCalendar]] rather than introducing a new property name.
#* proposed resolution: change "preparation-time" to "duration" and note re-use from [[hCalendar]] - or at least document how preparation-time is a different enough semantic from "duration" to justify the introduction of a new term.
#* One difference is that hCalendar ''duration'' is a singular property whereas hRecipe's ''preparation-time'' is plural. Also, ''preparation-time'' will often (typically) use value+note subproperties, while ''duration'' will usually be an ISO 8601 duration. [[User:TobyInk|TobyInk]] 20:32, 29 December 2008 (UTC)
#** Plurality is a contextual aspect and does not alter the semantic of the underlying property, thus is insufficient justification for introducing a new term. We do not duplicates of each property in a singular and plural form. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Syntax differences (value+note vs ISO 8601) are also insufficient to justify the introduction of a new property for the same semantic. Rather, it is better to expand the syntax of the existing property, e.g. perhaps using the [[value-excerption-pattern]] and to note that explicitly. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Semantically the reuse of "duration" is okay. RFC 2445 permits multiple duration values "if the property permits" so that should be fine too. If the syntactic differences can be worked out the way Tantek suggests above than it's okay with me to re-use "duration". I'm just not sure if it helps usability to overload properties in such a way but that ay be another discussion on it's own. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** The observation that preparation-time uses a nested "note" subproperty may actually reveal a problem with that approach itself, that is, perhaps instead of "preparation-time" with "value" and "note" subproperties, it may be better to refactor it as a "preparation" (an act thereof) with "duration" and "note" subproperties. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Removed the sub-property "note" from the v_0.2 draft format since I now agree that it looks a little overengineered. [[User:ThomasLoertsch|ThomasLoertsch]] 12:47, 22 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''issues too long''' 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
As threatened 2 weeks ago I heavily re-edited this page because discussions had become a little frayed (and heated at soem points). Have a look at the [http://microformats.org/wiki/index.php?title=hrecipe-issues&oldid=37788 previous version] for the full debate and feel free to re-edit this page if you find that I axed it too much. [[User:ThomasLoertsch|ThomasLoertsch]] 14:47, 2 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''new draft'''2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* The following is a proposal for draft 0.2, reflecting the issues discussed so far. "recipe-title" is replaced with "fn" from hCard (although I'm not convinced that this is a good idea), "recipe-summary" with "summary", "num" and "unit" from the unfinished 'measure' with "type" and "value" from 'hCard' (i only recently discovered them...), "method" (wihch is already used by [[hCalendar]] with "instructions", "preparation-time" with "duration". Two "note"s are deleted for brevity. "summary", "nutrition", "author", "published" and "photo" are marked as 'experimental', meaning that they may be removed from future drafts or the final specification, depending on experience and feedback from implementations :
</div>

=== '''hrecipe'''. Proposal for Draft 0.2 ===

* '''fn'''. the name of the recipe. required. text. re-used from [[hCard]]
* '''ingredient''' required. 1 or more. text with optional valid (x)HTML markup.
** '''value''' and '''type'''. optional. re-used from [[hCard]].
* '''yield'''. optional. text.
* '''instructions'''. optional. text with optional valid (x)HTML markup.
* '''duration'''. optional. 1 or more. text (see [[ISO-31-1]] duration brainstorming). re-used from [[hCalendar]].
* '''''summary'''''. optional. text. re-used from [[hCalendar]]. [ ''experimental'' ]
* '''''nutrition'''''. optional. 1 or more. [ ''experimental'' ].
** '''''value''''' and '''''type'''''. optional. re-used from [[hCard]]. [ ''experimental'' ].
* '''''author'''''. optional. 1 or more. re-used from [[hAtom]] using [[hCard]]. [ ''experimental'' ].
* '''''published'''''. optional. re-used from [[hAtom]]. [ ''experimental'' ].
* '''''photo'''''. optional. 1 or more. using any element containing a URL, such as IMG. re-used from [[hCard]]. [ ''experimental'' ].
* '''''tag'''''. optional. 1 or more. [ ''experimental'' ].
--[[User:ThomasLoertsch|ThomasLoertsch]] 11:01, 10 February 2009 (UTC)
</div>

== closed issues ==

<div class="vevent">
* {{ClosedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]] in the context of issue '''Too many properties'''
<div class="description discussion issues">
# '''Drop "recipe-title".''' In reviewing the examples, few (if any?) include *both* a title and a summary, and in practice the semantics of usage in the context of recipes appears to be virtually indistinguishable. Therefore we don't need both, and following in the pattern provided by [[hCalendar]] (which got it from [[RFC2445]]), we should keep the more generic concept of a "summary" and drop the concept of "title" from hRecipe.
#* I tend to agree. There are definitely use cases for both "recipe-title/title/fn" and "recipe-summary/summary" - e.g. "[http://www.simonwheatley.co.uk/2006/03/26/a-moroccan-ish-casserole/ A Moroccan-ish Casserole]" sounds more like a summary while "[http://blog.bumblepuppy.org.uk/2006/10/05/spaghetti-primavera/ Spaghetti primavera]" is the full name or the title of the recipe. But the problem is, they would serve the same purpose. [[User:Yde|Yde]] 10:07, 17 January 2009 (UTC)
#** Title and summary are different things and they are used differently in the real world. The examples you give are both names/titles/labels/headings, although more or less descriptive. They are short, memorable and make the thing adressable by humans. A summary can be (and mostly is) much longer and serves a different purpose: it describes essential properties of the object at hand, eg: "this is easy and fast to prepare, but still looks impressive", "easy, tasty, fast, vegan, good on cold days" or "the kids loved this last summer, but the ingredients can be hard to get" or "whenever i cook this i start to dream of ..." [[User:ThomasLoertsch|ThomasLoertsch]] 14:25, 20 January 2009 (UTC)
#*** Right, on second thought, I believe "title/name" and "summary" are different things. [[User:Yde|Yde]] 11:22, 23 January 2009 (UTC)
#* The term "title" has been so horribly overloaded across formats, vocabularies that it is nearly meaningless and for that reason should be avoided in any/all format efforts, preferring instead something more semantically specific such as "fn" (meaning full/formatted name of an item) or "summary" (when items are labeled more often with a short description/explanation rather than a name). [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Synonyms and homonyms are part of the real world - we have to cope with them. Also the word "title" is not horribly overloaded, you're exaggerating here. It just happened that hCard were the first to use it, and in a way that's empirically much less important then the use of "title" as the heading of a resource. Still the real problem is that Microformats have only one namespace and no resolution mechanism for conflicts like this, beside "first come first served". [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** Maybe it would be better to make a clear cut with some of the sins of the past and deprecate some terms in hCard / hCalendar[[User:ThomasLoertsch|ThomasLoertsch]] 15:30, 3 February 2009 (UTC)
#* "fn" is [[existing-classes|defined]] as "the name of the object" which is pretty much what "recipe-title" means right now. So, whether we chose to keep this property, summary, or both, renaming "recipe-title" to "fn" would make sense. [[User:Yde|Yde]] 23:03, 16 January 2009 (UTC)
#** the definition of "fn" in [[existing-classes|existing classes]] is maybe a little too short. "fn" is defined in hCard which is a reformulation of RFC 2462, which says: "Type name:FN - Type purpose: To specify the formatted text corresponding to the name of the object the vCard represents. -Type special notes: This type is based on the semantics of the X.520 Common Name attribute. The property MUST be present in the vCard object. - Type example: 'FN:Mr. John Q. Public\, Esq.'" (http://www.ietf.org/rfc/rfc2426.txt, on page 8). That clearly means a name of a person or an institution. Institution equals a juristical person, so "fn" semantically boils down to 'name of a person'. I wouldn't use that for every object. [[User:ThomasLoertsch|ThomasLoertsch]] 14:03, 20 January 2009 (UTC)
#*** Thanks for the clarification. "fn" is definitely not a good idea. [[User:Yde|Yde]] 10:00, 23 January 2009 (UTC)
#*** <code>fn</code> is already reused more generically in hAudio, hReview and hListing (for items). The definition of use within microformats has already been adapted from the strict vcard interpretation in prior work. --[[User:BenWard|BenWard]] 23:04, 27 January 2009 (UTC)
#**** I see. I can't help but thinking: what a mess... What's the family name of a recipe, audio-recording or list-entry? What's the point of re-using a semantically totally void two-letter-acronym, when it doesn't even fit very well? What's the point of reusing an element when I have to lookup the meaning of it every time anyway? [[User:ThomasLoertsch|ThomasLoertsch]] 00:48, 28 January 2009 (UTC)
#***** <code>fn</code> is ''formatted''-name, not ‘family’. ‘Name as presented’, ‘display name’. I agree that <code>fn</code> takes a double glance when you're learning, but it's there and the reuse in other specs is consistent; there's a much stronger author benefit in building on common equivalent-semantic vocabulary than introducing synonyms, which I think will cause more confusion. Better to have a strong spec with common vocabulary than introduce duplication. I'll keep in mind that we should better emphasise the expansion of <code>fn</code> in all specs for benefit of new authors. I can see how ‘family name’ is a muddle too easily made in hCard. --[[User:BenWard|BenWard]] 07:01, 28 January 2009 (UTC)
#****** I was referring to the fact that a name of a natural or juridical person is semantically quite different to the name of an object. Other things like the opacity of the two-letter-code "fn" are indeed problematic too but not my main issue here. That vCard-legacy seems to be lurking around every corner. Why not make a clear cut and deprecate the problematic parts like "title" and "fn"? The approach to rather overload the semantics (and the property-constraints) just to keep element-count low only takes that far. In the end it hinders usability instead of improving it. I think [[reuse]] and [[naming-principles]] don't strike the right balance in that respect. [[User:ThomasLoertsch|ThomasLoertsch]] 11:45, 28 January 2009 (UTC)
#* why not define a property "name"?! From my understanding of the english language (I'm not a native speaker) "name" is semantically generic enough to serve as a substitute for "title". Defining it rather broadly as "designation or title or denominator or heading of an item" would make it easily reusable. Plus we would have to explicitely discourage it's use for naming real or juristical persons and point to "fn" instead. [[User:ThomasLoertsch|ThomasLoertsch]] 12:21, 21 January 2009 (UTC)
#** Hmmm. I would really like to get feedback on this... Again my argumentation:
#*** <code>title</code> would be the best solution but is already "taken". Depercating some of hCalenders sins would be the best solution but seems out of reach so far.
#*** <code>heading</code> would be a possible solution either but seems more suited for prose
#*** <code>name</code> gets the semantics quite well, especially in the case of recipes which are more a "thing" or abstract conceptualization than a work of literature/science/prose
#*** <code>fn</code> with it's subproperties is geared towards natural and juristical persons, which are quite different from things and concepts. Also semantics of the term "fn" are rather opaque, even misleading, which hinder it's usability.
#** Therefor I'd love "title", could live very well with "name", could live still well with "heading" and would sleep bad (but sleep) with "fn". [[User:ThomasLoertsch|ThomasLoertsch]] 16:30, 2 Febuary 2009 (UTC)
#** Okay, since there's no response I bow my head to "fn". But it speaks for itself that it's the only tag that has to be explained in the schema. [[User:ThomasLoertsch|ThomasLoertsch]] 11:15, 10 February 2009 (UTC)
</div>
</div>

===template===
{{issues-format}}

==related pages==
* [[hRecipe]]
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

hrecipe-issues

2009-05-19T08:52:07Z

ThomasLoertsch: /* related pages */

== issues ==
Please add new issues to the '''bottom''' of this section by copy and pasting the [[hrecipe-issues#template|Template]]. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

<div class="vevent">
* {{OpenIssue}} 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* '''"num" and "unit"'''. I only recently discovered the properties "type" and "value" from 'hCard'. I'll replace "num" and "unit" from the unfinished 'measure' with them.
** The decision to replace "num", "unit", and "item" with "type" and "value" needs further explanation. Was it due to the fact that measure is unfinished? If so I think leaving "ingredient" and "nutrition" as text strings until measure is finished would be a better idea. The transition from "type"/"value" to measure will be difficult at a later point and I believe measure is more appropriate than re-using hCard. [[User:Yde|Yde]] 11:46, 23 January 2009 (UTC)
*** The proposal to replace "num", "unit", and "item" with "type" and "value" has several reasons: first, i only recently thoroughly and systematically investgated other formats and that's when i found "type" and "value". They have a semantic advantage in that they may be more suitable for cases like value:"2"/type:"eggs" or value:"1/2"/type:"spoonfull" which are rather informal ways of putting measures, at least do not lend themselves easily to formal specification. Another reason is that these terms come from a comparably very stable vocabulary, while measure has not even draft status. It would be perfectly okay for measure to change attribute names, semantics or even the whole structure of the vocabulary. Although it doesn't look like that measure will (have to) do that I'd prefer to stay on the safe side, especially since we might even gain semantic advantage. [[User:ThomasLoertsch|ThomasLoertsch]] 19:43, 23 January 2009 (UTC)
**** I'm still not sure this is the right decision. 1) I don't think the semantic meaning of hCard's "type"/"value" is exactly equivalent to measure's "num"/"unit"/"item". From the [[hcard-profile]]: "Value: This class name is used to distinguish the actual *value* of a property from any other cruft that may be in the element representing the property." So what is the actual value of an ingredient? Is it the name of the ingredient or is the quantity? 2) This is ''exactly'' what [[measure]] is for. The advantage of being able to convert measures would IMO be one of the gratest advantages of hRecipe. I don't see why value:"2"/type:"eggs" is better than num:"2"/item:"eggs"? I agree that cases like value:"1/2"/type:"spoonfull" is problematic, but that's a [[measure]] issue. 3) Many [[recipe-formats]] use quantity/unit/item.
***** Measurements are rather informal in recipes and therefor the type/value pair seems quite appropriate to me. Automatic translation is out of scope. Anyway for a good enough machine translation of a recipe the markup of the ingredients won't be the main hurdle. Standardizing the informal quantities would be a requirement for such an effort. I made some suggestions for a vocabulary of most used "units" like cups, teespoonfulls etc a few months ago but no one reacted. So I dropped it.
***** But we're moving in circles. You are making valid points too. One reason I decided this way is that it's more inline with other decisions like reusing "fn". Since not all the shortcomings of microformats can be solved within hRecipe and since there has been no interest in discussing them here I decided to go the way of least resistance and stick with the customs of compactness, reuse and rather lax interpretation of semantic constraints. IMO hRecipe is now consistent with the genereal microformats approach and neither necessitates nor hinders a general redesign of microformats (which I think would be a good thing). --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
**** Proposed resolution: keep "ingredient" as a text string like "yield" - which would also benefit from a measure format - until such a format is ready. [[User:Yde|Yde]] 10:23, 15 February 2009 (UTC)
***** I opened this issue again and marked the subproperty 'value' and 'type' of ingredient as ''experimental''. This should leave enough room to discuss this issue further. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{OpenIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Too many properties.''' From reviewing the [[recipe-examples]], it does not appear that the schema implied by the examples justify the number of properties in hRecipe, especially for a first draft. microformats should start as small as possible (even smaller), and in this regard I believe several improvements could be made. There is one obvious example of recipe-title vs recipe-summary, but it looks like there may be more. Would appreciate feedback from folks who add hRecipe to the recipes on the web regarding which properties they ended up not using.
#* It is not necessarily helpful to constrain a vocabulary by all means. hCard and hCalender are examples for too large vocabularies (which mostly stems from the approach taken of converting an existing vocab 1:1) which are not as easily usable as one would wish. But to be useful a vocabluary should encompass 80:20 of the usecases, otherwise it may well not be worth the burden of implementation. We better try to hit that sweet spot right from the start - since otherwise, how should hRecipe get traction in the wild. All of the proposed properties are used on big recipe sites (many 'user generated content' sites among them) on the web. Please provide more arguments which properties you specifically think are superfluous. The only concrete example you give is to replace title by summary (which I think is a bad idea). [[User:ThomasLoertsch|ThomasLoertsch]]
#* Version 0.2 (and a little more so 0.21) has marked all but the most essential properties as ''experimental''. There use is not at all discouraged but implementors are warned that these properties may be removed from later version if they aren't used in real world applications. This uptake by implementors should be observed and studied before a final descision is made. A proposed timeframe would be at least a few months, maybe even a year or two, depending on how many implemetations surface in the meantime. --[[User:ThomasLoertsch|ThomasLoertsch]] 11:21, 18 February 2009 (UTC)
</div>
</div>

== resolved issues ==
<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description">
*# '''author is re-used from hAtom not hCard'''. minor issue. the "author" property is actually re-used from [[hAtom]] rather than hCard - hCard has no such property.
*#* Yikes! Corrected... [[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}}2008-01-17 raised by [[User:Yde|Yde]]
<div class="description">
* '''method'''. Would it make sense to [[reuse]] [[hreview|hReview's]] "description" instead of hRecipe's "method" or is this stretching the semantics too far?
** I just discovered that hCalender uses "method", and with totally different semantics. So I guess we MUST change it. I'm not very happy with "description" though - that's a very unspecific term. Maybe "instructions", or "steps", or "preparation" , or "procedure"? They are all 'available'. I like "instructions" most, but since I'm not a native speaker I'm hesitant. Maybe the semantics are too different? Maybe "preparation" is better since we already almost have it (or had it - see the discussion about "preparation-time" -> "duration" above)? [[User:ThomasLoertsch|ThomasLoertsch]] 12:24, 21 January 2009 (UTC)
** Since no further comments surfaced I'll change the property name to "instructions". I think it's a fairly unambiguous name which also can easily be reused in other formats. [[User:ThomasLoertsch|ThomasLoertsch]] 14:30, 2 Febuary 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''Unnecessary recipe prefixing of summary property.''' Note: this is a re-opening of an issue from [[recipe-issues]]. The usage of summary in recipes appears to be very similar to that used for events. Rephrased, insufficient (if any?) evidence has been provided that summary means anything "special" enough (distinguishing it from the generic term "summary" as used in microformats) in the context of recipes to merit prefixing and thus a new property.
#* proposed resolution: Re-use generic "summary" property rather than introducing a recipe microformat scoped "recipe-summary" property.
#* I agree principally but there are different "summary"s around: The [[hReview]]-Draft specifies a summary as "This optional field serves as a title for the review itself" while the [[hCalendar]] Draft refers to RFC 2445 which defines summary as "This property defines a short summary or subject for the calendar component". I certainly agree more with the semantics from RFC 2445 but referring to either of the two doesn't make much sense right now. Since you are editor of both hReview and hCalendar maybe you can clarify the subject? If hReview would be aligned with RFC 2445 then I would promote dropping the prefix.[[User:ThomasLoertsch|ThomasLoertsch]] 17:52, 6 January 2009 (UTC)
#** Agreed, the definitions of "summary" across hCalendar and hReview could be better converged. Please add this as an issue to both [[hcalendar-issues]] and [[hreview-issues]] and I'll follow-up there accordingly. Given that is the path forward, let's fix this immediately in hRecipe now that the issue (and resolution) has been captured. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Will change "recipe-summary" to "summary" as defined in hCalender/RFC2445. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]]
<div class="description discussion issues">
# '''preparation-time could re-use duration instead''' - it appears that the "preparation-time" semantic basically means the "duration" of the recipe, and thus could re-use that property from [[hCalendar]] rather than introducing a new property name.
#* proposed resolution: change "preparation-time" to "duration" and note re-use from [[hCalendar]] - or at least document how preparation-time is a different enough semantic from "duration" to justify the introduction of a new term.
#* One difference is that hCalendar ''duration'' is a singular property whereas hRecipe's ''preparation-time'' is plural. Also, ''preparation-time'' will often (typically) use value+note subproperties, while ''duration'' will usually be an ISO 8601 duration. [[User:TobyInk|TobyInk]] 20:32, 29 December 2008 (UTC)
#** Plurality is a contextual aspect and does not alter the semantic of the underlying property, thus is insufficient justification for introducing a new term. We do not duplicates of each property in a singular and plural form. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Syntax differences (value+note vs ISO 8601) are also insufficient to justify the introduction of a new property for the same semantic. Rather, it is better to expand the syntax of the existing property, e.g. perhaps using the [[value-excerption-pattern]] and to note that explicitly. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Semantically the reuse of "duration" is okay. RFC 2445 permits multiple duration values "if the property permits" so that should be fine too. If the syntactic differences can be worked out the way Tantek suggests above than it's okay with me to re-use "duration". I'm just not sure if it helps usability to overload properties in such a way but that ay be another discussion on it's own. [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** The observation that preparation-time uses a nested "note" subproperty may actually reveal a problem with that approach itself, that is, perhaps instead of "preparation-time" with "value" and "note" subproperties, it may be better to refactor it as a "preparation" (an act thereof) with "duration" and "note" subproperties. [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#*** Removed the sub-property "note" from the v_0.2 draft format since I now agree that it looks a little overengineered. [[User:ThomasLoertsch|ThomasLoertsch]] 12:47, 22 January 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''issues too long''' 2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
As threatened 2 weeks ago I heavily re-edited this page because discussions had become a little frayed (and heated at soem points). Have a look at the [http://microformats.org/wiki/index.php?title=hrecipe-issues&oldid=37788 previous version] for the full debate and feel free to re-edit this page if you find that I axed it too much. [[User:ThomasLoertsch|ThomasLoertsch]] 14:47, 2 February 2009 (UTC)
</div>
</div>

<div class="vevent">
* {{ResolvedIssue}} '''new draft'''2009-01-22 raised by [[User:ThomasLoertsch|ThomasLoertsch]]
<div class="description">
* The following is a proposal for draft 0.2, reflecting the issues discussed so far. "recipe-title" is replaced with "fn" from hCard (although I'm not convinced that this is a good idea), "recipe-summary" with "summary", "num" and "unit" from the unfinished 'measure' with "type" and "value" from 'hCard' (i only recently discovered them...), "method" (wihch is already used by [[hCalendar]] with "instructions", "preparation-time" with "duration". Two "note"s are deleted for brevity. "summary", "nutrition", "author", "published" and "photo" are marked as 'experimental', meaning that they may be removed from future drafts or the final specification, depending on experience and feedback from implementations :
</div>

=== '''hrecipe'''. Proposal for Draft 0.2 ===

* '''fn'''. the name of the recipe. required. text. re-used from [[hCard]]
* '''ingredient''' required. 1 or more. text with optional valid (x)HTML markup.
** '''value''' and '''type'''. optional. re-used from [[hCard]].
* '''yield'''. optional. text.
* '''instructions'''. optional. text with optional valid (x)HTML markup.
* '''duration'''. optional. 1 or more. text (see [[ISO-31-1]] duration brainstorming). re-used from [[hCalendar]].
* '''''summary'''''. optional. text. re-used from [[hCalendar]]. [ ''experimental'' ]
* '''''nutrition'''''. optional. 1 or more. [ ''experimental'' ].
** '''''value''''' and '''''type'''''. optional. re-used from [[hCard]]. [ ''experimental'' ].
* '''''author'''''. optional. 1 or more. re-used from [[hAtom]] using [[hCard]]. [ ''experimental'' ].
* '''''published'''''. optional. re-used from [[hAtom]]. [ ''experimental'' ].
* '''''photo'''''. optional. 1 or more. using any element containing a URL, such as IMG. re-used from [[hCard]]. [ ''experimental'' ].
* '''''tag'''''. optional. 1 or more. [ ''experimental'' ].
--[[User:ThomasLoertsch|ThomasLoertsch]] 11:01, 10 February 2009 (UTC)
</div>

== closed issues ==

<div class="vevent">
* {{ClosedIssue}} 2008-12-27 raised by [[User:Tantek|Tantek Çelik]] in the context of issue '''Too many properties'''
<div class="description discussion issues">
# '''Drop "recipe-title".''' In reviewing the examples, few (if any?) include *both* a title and a summary, and in practice the semantics of usage in the context of recipes appears to be virtually indistinguishable. Therefore we don't need both, and following in the pattern provided by [[hCalendar]] (which got it from [[RFC2445]]), we should keep the more generic concept of a "summary" and drop the concept of "title" from hRecipe.
#* I tend to agree. There are definitely use cases for both "recipe-title/title/fn" and "recipe-summary/summary" - e.g. "[http://www.simonwheatley.co.uk/2006/03/26/a-moroccan-ish-casserole/ A Moroccan-ish Casserole]" sounds more like a summary while "[http://blog.bumblepuppy.org.uk/2006/10/05/spaghetti-primavera/ Spaghetti primavera]" is the full name or the title of the recipe. But the problem is, they would serve the same purpose. [[User:Yde|Yde]] 10:07, 17 January 2009 (UTC)
#** Title and summary are different things and they are used differently in the real world. The examples you give are both names/titles/labels/headings, although more or less descriptive. They are short, memorable and make the thing adressable by humans. A summary can be (and mostly is) much longer and serves a different purpose: it describes essential properties of the object at hand, eg: "this is easy and fast to prepare, but still looks impressive", "easy, tasty, fast, vegan, good on cold days" or "the kids loved this last summer, but the ingredients can be hard to get" or "whenever i cook this i start to dream of ..." [[User:ThomasLoertsch|ThomasLoertsch]] 14:25, 20 January 2009 (UTC)
#*** Right, on second thought, I believe "title/name" and "summary" are different things. [[User:Yde|Yde]] 11:22, 23 January 2009 (UTC)
#* The term "title" has been so horribly overloaded across formats, vocabularies that it is nearly meaningless and for that reason should be avoided in any/all format efforts, preferring instead something more semantically specific such as "fn" (meaning full/formatted name of an item) or "summary" (when items are labeled more often with a short description/explanation rather than a name). [[User:Tantek|Tantek]] 20:54, 15 January 2009 (UTC)
#** Synonyms and homonyms are part of the real world - we have to cope with them. Also the word "title" is not horribly overloaded, you're exaggerating here. It just happened that hCard were the first to use it, and in a way that's empirically much less important then the use of "title" as the heading of a resource. Still the real problem is that Microformats have only one namespace and no resolution mechanism for conflicts like this, beside "first come first served". [[User:ThomasLoertsch|ThomasLoertsch]] 15:00, 16 January 2009 (UTC)
#** Maybe it would be better to make a clear cut with some of the sins of the past and deprecate some terms in hCard / hCalendar[[User:ThomasLoertsch|ThomasLoertsch]] 15:30, 3 February 2009 (UTC)
#* "fn" is [[existing-classes|defined]] as "the name of the object" which is pretty much what "recipe-title" means right now. So, whether we chose to keep this property, summary, or both, renaming "recipe-title" to "fn" would make sense. [[User:Yde|Yde]] 23:03, 16 January 2009 (UTC)
#** the definition of "fn" in [[existing-classes|existing classes]] is maybe a little too short. "fn" is defined in hCard which is a reformulation of RFC 2462, which says: "Type name:FN - Type purpose: To specify the formatted text corresponding to the name of the object the vCard represents. -Type special notes: This type is based on the semantics of the X.520 Common Name attribute. The property MUST be present in the vCard object. - Type example: 'FN:Mr. John Q. Public\, Esq.'" (http://www.ietf.org/rfc/rfc2426.txt, on page 8). That clearly means a name of a person or an institution. Institution equals a juristical person, so "fn" semantically boils down to 'name of a person'. I wouldn't use that for every object. [[User:ThomasLoertsch|ThomasLoertsch]] 14:03, 20 January 2009 (UTC)
#*** Thanks for the clarification. "fn" is definitely not a good idea. [[User:Yde|Yde]] 10:00, 23 January 2009 (UTC)
#*** <code>fn</code> is already reused more generically in hAudio, hReview and hListing (for items). The definition of use within microformats has already been adapted from the strict vcard interpretation in prior work. --[[User:BenWard|BenWard]] 23:04, 27 January 2009 (UTC)
#**** I see. I can't help but thinking: what a mess... What's the family name of a recipe, audio-recording or list-entry? What's the point of re-using a semantically totally void two-letter-acronym, when it doesn't even fit very well? What's the point of reusing an element when I have to lookup the meaning of it every time anyway? [[User:ThomasLoertsch|ThomasLoertsch]] 00:48, 28 January 2009 (UTC)
#***** <code>fn</code> is ''formatted''-name, not ‘family’. ‘Name as presented’, ‘display name’. I agree that <code>fn</code> takes a double glance when you're learning, but it's there and the reuse in other specs is consistent; there's a much stronger author benefit in building on common equivalent-semantic vocabulary than introducing synonyms, which I think will cause more confusion. Better to have a strong spec with common vocabulary than introduce duplication. I'll keep in mind that we should better emphasise the expansion of <code>fn</code> in all specs for benefit of new authors. I can see how ‘family name’ is a muddle too easily made in hCard. --[[User:BenWard|BenWard]] 07:01, 28 January 2009 (UTC)
#****** I was referring to the fact that a name of a natural or juridical person is semantically quite different to the name of an object. Other things like the opacity of the two-letter-code "fn" are indeed problematic too but not my main issue here. That vCard-legacy seems to be lurking around every corner. Why not make a clear cut and deprecate the problematic parts like "title" and "fn"? The approach to rather overload the semantics (and the property-constraints) just to keep element-count low only takes that far. In the end it hinders usability instead of improving it. I think [[reuse]] and [[naming-principles]] don't strike the right balance in that respect. [[User:ThomasLoertsch|ThomasLoertsch]] 11:45, 28 January 2009 (UTC)
#* why not define a property "name"?! From my understanding of the english language (I'm not a native speaker) "name" is semantically generic enough to serve as a substitute for "title". Defining it rather broadly as "designation or title or denominator or heading of an item" would make it easily reusable. Plus we would have to explicitely discourage it's use for naming real or juristical persons and point to "fn" instead. [[User:ThomasLoertsch|ThomasLoertsch]] 12:21, 21 January 2009 (UTC)
#** Hmmm. I would really like to get feedback on this... Again my argumentation:
#*** <code>title</code> would be the best solution but is already "taken". Depercating some of hCalenders sins would be the best solution but seems out of reach so far.
#*** <code>heading</code> would be a possible solution either but seems more suited for prose
#*** <code>name</code> gets the semantics quite well, especially in the case of recipes which are more a "thing" or abstract conceptualization than a work of literature/science/prose
#*** <code>fn</code> with it's subproperties is geared towards natural and juristical persons, which are quite different from things and concepts. Also semantics of the term "fn" are rather opaque, even misleading, which hinder it's usability.
#** Therefor I'd love "title", could live very well with "name", could live still well with "heading" and would sleep bad (but sleep) with "fn". [[User:ThomasLoertsch|ThomasLoertsch]] 16:30, 2 Febuary 2009 (UTC)
#** Okay, since there's no response I bow my head to "fn". But it speaks for itself that it's the only tag that has to be explained in the schema. [[User:ThomasLoertsch|ThomasLoertsch]] 11:15, 10 February 2009 (UTC)
</div>
</div>

===template===
{{issues-format}}

==related pages==
* [[hRecipe]]
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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

[[Category:Draft Specifications]]

hrecipe

2009-05-19T08:49:11Z

ThomasLoertsch: /* related pages */ added link to hrecipe-rdf (aRecipe)

<entry-title>hRecipe 0.21</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 elements and fields. 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 fields common to numerous recipe sites and formats in use today on the web. Where possible field names have been chosen based on those defined by related microformat standards. 
Some fields are marked ''experimental'' since they exceed the minimum set of elements 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 elements 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 elements:

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

=== Field details ===

Class names <code>fn</code>, <code>photo</code>, <code>value</code> and <code>type</code> are reused from [[hCard]] <code>duration</code> and<code>summary</code> are reused from [[hCalendar]], <code>author</code> and <code>published</code> are reused from [[hAtom]], <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 element is identified by class 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 element is identified by class name <code>fn</code>.
* A Recipe {{must}} include a <code> fn </code>.
* The element {{must}} follow the conventions outlined in [[hCard]].

==== ingredient ====

Describes one or more ingredients used in the recipe.

* The element is identified by the class name <code>ingredient</code>.
* A Recipe {{must}} include one or more <code>ingredient</code>s.
* The field {{may}} include valid HTML markup (e.g. a list of ingredients).
* The element {{may}} include the fields <code>value</code> and <code>type</code> following the conventions outlined in [[hCard]]. In this case each ingredient should be marked up with it's own <code>ingredient</code> element. These subelements 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 element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <code>yield</code>.

==== instructions ====

The method of the recipe.

* The element is identified by the class name <code>instructions</code>.
* A Recipe {{may}} include a <code>instructions</code> element.
* The field {{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 fields 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 element is identified by the class name <code>duration</code>.
* A Recipe {{may}} include one or more <code>duration</code>s.
* The element {{must}} follow the conventions outlined in [[hCalendar]].

==== photo ====

Accompanying image.

* The element is identified by the class name <code>photo</code>.
* A Recipe {{may}} include one or more photo elements.
* The element {{should}} use an <img> element.
* The element {{may}} use any other element that contains a URL, such as <a> or <object>, but it is not recommended.
* The contents of the element {{must}} follow the conventions outlined in [[hCard]].
* The element 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 element is identified by the class name <code>summary</code>.
* A Recipe {{may}} include a <code>summary</code>.
* The element {{must}} follow the conventions outlined in [[hCalendar]].
* The element is considered ''experimental'' and may be removed from the final specification.

==== author ====

An Author is the person who authored the recipe.

* The element is identified by class name <code>author</code>.
* A Recipe {{may}} include one or more <code>author</code> elements.
* The contents of the element {{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 element is identified by the class name <code>published</code>.
* A Recipe {{may}} include a <code>published</code> date.
* The element {{must}} follow the conventions outlined in [[hAtom]].
* The [[datetime-design-pattern]] {{should}} be used to encode the published datetime.
* The element is considered ''experimental'' and may be removed from the final specification.

==== nutrition ====

Nutritional information like calories, fat, dietary fiber etc.

* The element is identified by class name <code>nutrition</code>.
* A Recipe {{may}} include one or more <code>nutrition</code> elements.
* The element {{may}} include the fields <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> element. These subelement is considered ''experimental'' and may be replaced by 'num' and 'unit' from [[measure]].
* The element is 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 element is identified by class name <code>tag</code>.
* A Recipe {{may}} include one or more <code>tag</code> elements.
* The element {{must}} follow the conventions outlined in [[rel-tag]].
* The element is considered ''experimental'' and may be removed from the final specification.

=== Version history ===

* 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 ;-)
* 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) .

=== Parser Processing Notes ===

None so far.

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

<pre>
<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>
</pre>

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

<pre><nowiki><div class="hrecipe">
Pommes Frites

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

Thomas Loertsch
Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr>
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>

500
gramme
potatoes, hard cooking.

<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>
Enough for 12 children.
Preparation time is approximately
90 <abbr title="minutes">min</abbr>.

Add
5 <abbr class="unit" title="minutes" >min</abbr>
for preparing the Ketchup.

This recipe is <a href="http://www.eut.de/tags/difficulty/easy" rel="tag">easy</a> and <a href="http://www.eut.de/tags/tastyness/delicious" rel="tag">delicious</a>.

Pommes Frites have more than
1000
Joule
Energy.

</div>
</nowiki></pre>


== Examples in the wild ==

This section is '''informative'''.

'''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'''.

* 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.


* 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.

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

This document and hAudio specification 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.

==related pages==
* [[hrecipe-issues|hRecipe issues]] - issues regarding the hRecipe draft
* [[hrecipe-feedback|hRecipe feedback]] - general feedback regarding hRecipe
* [[hrecipe-rdf|hRecipe in RDF]] - mapping of hRecipe into a RDF vocabulary called "aRecipe"

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