recipe-brainstorming-archive

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

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.

related pages

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