ThomasLoertsch: added format-in-progess-#2

2009-07-09T12:50:04Z

added format-in-progess-#2

ThomasLoertsch: removed title tag

2008-12-02T15:41:43Z

removed title tag

← Older revision		Revision as of 15:41, 2 December 2008
Line 1:		Line 1:
	~~<h1>Recipe Brainstorming Archive</h1>~~

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

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

ThomasLoertsch: new archive page for formats-in-progress from brainstorming

2008-11-11T13:10:10Z

new archive page for formats-in-progress from brainstorming

New page

<h1>Recipe Brainstorming Archive</h1>

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

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

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

recipe-brainstorming-archive - Revision history

ThomasLoertsch: added format-in-progess-#2

ThomasLoertsch: removed title tag

ThomasLoertsch: new archive page for formats-in-progress from brainstorming