recipe-brainstorming-archive

(Difference between revisions)

Jump to: navigation, search
m (removed title tag)
Current revision (12:50, 9 July 2009) (view source)
(added format-in-progess-#2)
 
Line 98: Line 98:
* The element is identified by the class name <code>yield</code>.
* The element is identified by the class name <code>yield</code>.
* A Recipe {{may}} include a <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">
 +
<p class="recipe-title">Pommes Frites</p>
 +
<p class="recipe-summary">
 +
Pommes frites originate in outer space. They are served hot.<br />
 +
This recipe is only an example. Don't try this at home!
 +
</p>
 +
<p class="vcard fn">Thomas Loertsch</p>
 +
<p>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></p>
 +
<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>
 +
<p class="ingredient hmeasure">
 +
<span class="num">500</span>
 +
<span class="unit">gramme</span>
 +
<span class="item">potatoes</span>,
 +
<span class="note">hard cooking</span>.
 +
</p>
 +
<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>
 +
<p>Enough for <span class="yield">12</span> children.</p>
 +
<p class="preparation-time hmeasure">Preparation time is approximately
 +
<span class="num">90</span>
 +
<abbr class="unit" title="minutes">min</abbr>.
 +
</p>
 +
<p class="preparation-time hmeasure">Add
 +
<span class="num">5</span>
 +
<abbr class="unit" title="minutes" >min</abbr>
 +
for <span class="note">preparing the Ketchup</span>.
 +
</p>
 +
<p>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>.</p>
 +
<p class="nutrition hmeasure">
 +
Pommes Frites have more than
 +
<span class="num">1000</span>
 +
<span class="unit">Joule</span>
 +
                <span class="type">Energy</span>.
 +
</p>
 +
</div>
 +
</nowiki></pre>
 +
 +
 +
 +
 +

Current revision

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.

Field Details

Title: The title of the recipe.

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

Author: Author the person who authored the recipe.

Date published: The date the recipe was published.

Photo: Accompanying image.

Ingredient: Describes an ingredient used in the recipe.

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

Item: Specifies the name of the ingredient.

Note: A note concerning one of the ingredients.

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

Method: The method of the recipe.

Yield: Specifies the quantity produced by the recipe.



format-in-progress - #2 - october 2008

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.

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

Root Class Name

To be decided. Likely ‘hRecipe’.

Property List

Class names author, photo and note are taken from hCard, published used from hAtom and item from measure.

Field Details

Title: The title of the recipe.

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

Author: Author the person who authored the recipe.

Date published: The date the recipe was published.

Photo: Accompanying image.

Ingredients: Describes the ingredients used in the recipe.

Ingredient: Describes one ingredient used in the recipe.

Note: A note concerning an Ingredient or a Preparation Time element (for element Preparation Time see below).

Method: The method of the recipe.

Yield: Specifies the quantity produced by the recipe.

Preparation Time: The time it takes to prepare the meal described by the recipe.

Nutrition:


Example

<div class="hrecipe">
	<p class="recipe-title">Pommes Frites</p>
	<p class="recipe-summary">
		Pommes frites originate in outer space. They are served hot.<br />
		This recipe is only an example. Don't try this at home!
	</p>
	<p class="vcard fn">Thomas Loertsch</p>
	<p>Published <abbr class="published" title="2008-10-14T10:05:37-01:00">14. Oct 2008</abbr></p>
	<img src="/img/pommes.png" class="photo" width="100" height="100" alt="Pommes Frites"/>
	<p class="ingredient hmeasure">
		<span class="num">500</span> 
		<span class="unit">gramme</span>
		<span class="item">potatoes</span>,
		<span class="note">hard cooking</span>.
	</p>
	<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>
	<p>Enough for <span class="yield">12</span> children.</p>
	<p class="preparation-time hmeasure">Preparation time is approximately 
		<span class="num">90</span> 
		<abbr class="unit" title="minutes">min</abbr>.
	</p>
	<p class="preparation-time hmeasure">Add 
		<span class="num">5</span> 
		<abbr class="unit" title="minutes" >min</abbr> 
		for <span class="note">preparing the Ketchup</span>.
	</p>
	<p>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>.</p>
	<p class="nutrition hmeasure">
		Pommes Frites have more than 
		<span class="num">1000</span> 
		<span class="unit">Joule</span>
                <span class="type">Energy</span>.
	</p>
</div>




related pages

recipe-brainstorming-archive was last modified: Thursday, July 9th, 2009

Views