recipe-brainstorming

Recipe Brainstorming

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

format-in-progress

This format-in-progress follows the restarting of Recipe development by 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 Ben Ward and Frances Berriman.

Editor

Frances Berriman (BBC)

Introduction

Recipe is based on examples and fields in 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 author and published are taken from hAtom, photo used from hCard and item from measure.

• Title. recipe-title. required. text.
• Summary. recipe-summary. optional. text.
• Author. author. optional. hcard.
• Date published. published. optional. datetime-design-pattern.
• Photo(s). photo. optional. img or url.
• Ingredient(s). ingredient. 1 or more required.
  • Quantity. quantity. optional. text, optionally measure.
  • Item. item. required. text.
  • Note. note. optional. text.
  • Optionality. optional. optional. text. Its absence should imply that the ingredient is required.
• Method. method. required. text with optional valid HTML markup.
• Yield. yield. optional. text.
• Preparation time. preparation-time. 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 recipe-title.
• A Recipe MUST have a recipe-title

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

• The element is identified by class name recipe-summary.
• A Recipe MAY have a recipe-summary.

Author: Author the person who authored the recipe.

• The element is identified by class name author.
• A Recipe MAY include an author.
• 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 published.
• A Recipe MAY include a published date.
• SHOULD (?) use the datetime-design-pattern to encode the published datetime.

Photo: Accompanying image.

• The element is identified by the class name photo.
• 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.

Ingredient: Describes an ingredient used in the recipe.

• The element is identified by the class name ingredient.
• A Recipe MUST have one or more ingredients.
• The element MUST include the field item.
• The element MAY include quantity, note and/or optionality.

Quantity: The quantity of an ingredient needed for the recipe.

• The element is identified by the class name quantity.
• An ingredient MAY specify the quantity.

Item: Specifies the name of the ingredient.

• The element is identified by the class name item.
• An ingredient MUST specify the item.

Note: A note concerning one of the ingredients.

• The element is identified by the class name note.
• An ingredient MAY include a note.

Optionality: States that an ingredient is optional to the recipe.

• The element is identified by the class name optionality.
• The optionality of an ingredient 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 method.
• A Recipe MUST include a method.
• 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 yield.
• A Recipe MAY include a yield.

brainstorming

RecipeML-based Brainstorm

Excerpted from 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. Andy Mabbett 06:41, 16 Nov 2006 (PST)
  • Ingredient importance (e.g. Main, Required, Optional) should be listed as an attribute of each entry. α
  • Units need separate microformat: see measure
  • Ingredient Preparation: such as diced, chopped, sliced, grated, minced, etc. Steve Lewis 18:55, 11 Feb 2007 (PST)
• Preparation Time (overall time)
• Yield Quantity and Unit (4 pancakes or 5 servings)
  • Calories per serving John LeMasney
  • Calories per ounce John LeMasney
• Background Information - Optional section to encapsulate information that is useful but not necessarily required for a successful recipe. α
  • Author (Person) (hcard?)
  • Submitter (Person) (hcard?)
  • Source (Book Title etc)
    • could use the proposed citation microformat. 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 Andy Mabbett 14:46, 16 Nov 2006 (PST)
    • Another vote for an ordered list, perhaps in the XOXO format. α
    • 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. Ben Curtis
• Photo (optional) Cameron Perry
  • Could be one per dish, or one for each (or for some of the) step(s). Andy Mabbett

Cookcamp brainstorming

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

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? --Yde 08:41, 30 May 2008 (PDT)
• Difficulty/Notes - Perhaps incorporation of hReview to describe difficulty (using rating) and general comments (review), as an optional field. 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. Andy Mabbett 14:57, 16 Nov 2006 (PST)
• Ingredient Grouping - In baking you need to differentiate wet from dry ingredients. See also an example recipe from extratasty.com for useful grouping in cocktail mixing. Steve Lewis 19:10, 11 Feb 2007
  • Maybe this ingredient grouping can be used to express some alternative ingredients, like "mayonnaise or cream cheese". 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:

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

• • 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:

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

of spinach</span> and fry it</p> --BenWard 13:20, 18 Apr 2008 (PDT)

• • You're right. I think grouping would introduce too many new elements (class="group", class="group-title") considering how relatively uncommon this is. --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. --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. WilleRaab 16:57, 20 Jul 2007 (PDT)
• Suitable for occasions - what occasions are the dish suitable for? WilleRaab 16:57, 20 Jul 2007 (PDT)
• Category - many sites categorize their recipes. 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? 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:

I like to eat <span class="hRecipe"><span class="ingredient">cheese</span></span> for supper.

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

I like to eat <span class="hRecipe-ingredient">cheese</span> for supper.

Andy Mabbett 08:16, 5 Jan 2008 (PST)

• • But that's not really a recipe, is it? And what would the purpose of knowing that cheese is an ingredient be? --Yde 12:46, 18 Apr 2008 (PDT)
  • -1. Makes no sense to me either --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 menu examples. 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" - introduction) --Yde 13:39, 23 Apr 2008 (PDT)

Calories

per serving. May be part of the measure microformat in future.

• +1. Nutritional information is quite important for a lot of people and is inside the 80/20. It should be included as an optional element. The problems are: which nutritional information exactly? A common denominator is calories, proteins, carbohydrates and fat. That's also what european law demands as information on packaged food. Most sites that I visited only list calories as nutritional information (if any). Since Calories are a somehow superordinate concept for proteins, carbohydrates and fat that's fine. Allrecipes.com is quite extreme with a huge list of nutritional information - clearly outside 80/20 IMHO. Another problem: although Calories are the most popular term, the measure is deprecated in favor of Joule. Also hMeasure uses Joule. I'd therefor propose to add the optional element nutrition and subelements calories("mandatory") in Joule,fat("optional"), protein("optional") and carbohydrates("optional"), those all in grams. --ThomasLoertsch 15:16, 01 Oct 2008 (CET), modified 09.Oct 2008

Note

The 'note' property is only useful in some rare cases and might not fit the 80-20 rule.

• We might want to start as simple as possible and leave this out for a future revision.
• People often put some of the very basic preparation steps into the ingredients list. For example, ingredients lists sometimes read like "one onion, finely chopped".
• +1. note should stay as an optional value. There are so many ways to define ingredients that it seems useful enough to fit into the 80/20. --ThomasLoertsch 15:26, 01 Oct 2008 (CET)

Method

For informally or concisely written recipes, the method is often left out. Could we either make this optional, or have an optimisation such that if the method is absent, the entire text of the recipe is taken to be the method. TobyInk 02:53, 15 Jul 2008 (PDT)

• e.g. salad, sandwich and smoothie recipes don't often require a method to be useful.
• +1 for making it optional. Although most recipes rely heavily on a method there are indeed those where it isn't necessary. If 80/20 does mean that easy or simple usecases should be facilitated it would be in line with the principal to make the method optional. And it wouldn't hurt anybody either. --ThomasLoertsch 15:04, 01 Oct 2008 (CET)

Preparation Time

Make preparation-time plural and add an optional preparation-time-note element inline to preparation time

• preparation-time (optional, plural)
  • preparation-time-note (optional, singular)

There are often times additional to the main preparation time i.e. the time the dough needs to rise. When scanning a recipe for practicality - i.e. your guest are coming in 4 hours - this is a very important information. Allowing preparation-time to be used more than once per recipe and adding an optional note element would allow great flexibility in stating such details while staying simple. It could also be used to give times for different parts of a recipe like cake and topping or to differentiate times for preparation, waiting and cooking. --ThomasLoertsch 15:05, 01 Oct 2008 (CET)

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: - glass - leave - pinch - tablespoonful - teaspoonful - lacing - tie (??? my english is really leaving me here, hope you get the idea) note can be used to indicate more subtle differentiation (like a "big spoonful", "some leaves" etc). I think this list is both usefully short and complete. The following measures: - 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. --ThomasLoertsch 15:45, 01 Oct 2008 (CET)

Proposed Optimisations

Item

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

• +1. That and the Proposed Ingredient List Optimisation seem to be very pragmatic proposals. --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? --ThomasLoertsch 15:07, 01 Oct 2008 (CET)

Proposed Ingredient List Optimisation

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

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

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

is a shorthand for:

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

• I agree. This would save a lot of space, especially combined with the proposed hmeasure minimisation technique. --Yde 12:57, 18 Apr 2008 (PDT)
• Do we have ingredients (plural) as an element? Doesn't that open a whole can of list-issues? --ThomasLoertsch 15:37, 01 Oct 2008 (CET)

Proposed Ingredient Name/Quantity Optimisation

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

This idea's a bit more "out there" and probably needs a bit more work.

<li class="ingredient">3  eggs</li>

(note the double-space between '3' and 'eggs') is treated as a shorthand for:

<li class="ingredient"><span class="quantity">3</span> <span class="name">eggs</span></li>

This is similar to N-optimisation in hCard, but uses a double space instead of a single space because the components (quantity, name) may themselves each contain spaces. With both of these optimisations in place, the sponge cake ingredient list can be written as concisely as:

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

Which (apart from the double spaces) is pretty close to how many people publish ingredients lists already. (Certainly close to how I do!)

Alternative Proposed Ingredient Name/Quantity Optimisation

TobyInk 02:02, 24 Mar 2008 (PDT): Perhaps a better solution than the double spacing...

As above, but:

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

Or is this stretching the meaning of <var> too much?

Proposed Ingredient Name Optimisation

--Yde 02:12, 23 Apr 2008 (PDT): If no class="quantity" or class="name" is found, the content of the ingredient element is treated as the name of the ingredient.

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

is a shorthand for:

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

Maybe we should even allow markup like

<li class="ingredient"><span class="quantity">1 tbsp</span>salt</li>

which would be parsed as

• ingredient
  • quantity: 1 tbsp
  • name: salt

NOTE: To avoid confusion, I used the class name "name" although I think it should be changed to "item".

issues

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

implementations

Cognition

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

related pages

• recipe
• recipe-examples
• recipe-formats
• recipe-issues