Difference between revisions of "Template:Infobox recipe/doc"

From Sudo Room
Jump to navigation Jump to search
(changes name to 'Infobox recipe', removes docs on deprecated wikibooks/commons links, adds Date docs, adds instructions field)
m (fixes typo)
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
| caption          = {{{caption}}}
| caption          = {{{caption}}}
| alternate_name  = {{{alternate_name}}}
| alternate_name  = {{{alternate_name}}}
| summary          = {{{summary}}}
| location        = {{{location}}}
| location        = {{{location}}}
| creator          = {{{creator}}}
| creator          = {{{creator}}}
Line 17: Line 18:
| main_ingredient  = {{{main_ingredient}}}
| main_ingredient  = {{{main_ingredient}}}
| minor_ingredient = {{{minor_ingredient}}}
| minor_ingredient = {{{minor_ingredient}}}
| yield            = {{{yield}}}
| instructions    = {{{instructions}}}
| instructions    = {{{instructions}}}
| variations      = {{{variations}}}
| variations      = {{{variations}}}
Line 35: Line 37:
| caption          =  
| caption          =  
| alternate_name  =  
| alternate_name  =  
| summary          =
| location        =  
| location        =  
| creator          =  
| creator          =  
Line 43: Line 46:
| type            =  
| type            =  
| served          =  
| served          =  
| main_ingredient  =  
| main_ingredient  = <!-- List amounts in parentheses: <nowiki>{{Plainlist|Banana (1)|Yogurt (1 cup)}}</nowiki> -->
| minor_ingredient =  
| minor_ingredient = <!-- List amounts in parentheses: <nowiki>{{Plainlist|Vanilla extract (1 tsp)|Cinammon (0.5 tsp)}}</nowiki> -->
| yield            =
| instructions    =  
| instructions    =  
| variations      =  
| variations      =  
Line 67: Line 71:
* '''caption'''&nbsp;– Leave empty for no image caption.
* '''caption'''&nbsp;– Leave empty for no image caption.
* '''alternate name'''&nbsp;– Alternate name for the dish.
* '''alternate name'''&nbsp;– Alternate name for the dish.
* '''country'''&nbsp;– Country of origin of the dish.
* '''summary'''&nbsp;– Summary description of the dish.
* '''region'''&nbsp;– Region or state the dish was developed.
* '''location'''&nbsp;– Location of creation of the dish.
* '''national_cuisine'''&nbsp;– Cuisine by nationality.
* '''creator'''&nbsp;– Creator(s) of the dish.
* '''creator'''&nbsp;– Creator(s) of the dish.
* '''year'''&nbsp;– Year of invention of the dish.
* '''year'''&nbsp;– Year of creation of the dish.
* '''time1'''&nbsp;– Min time for cooking the dish.
* '''time1'''&nbsp;– Min time for cooking the dish.
* '''time2'''&nbsp;– Max time for cooking the dish.
* '''time2'''&nbsp;– Max time for cooking the dish.
Line 78: Line 81:
* '''served'''&nbsp;– Serving temperature for the dish.
* '''served'''&nbsp;– Serving temperature for the dish.
* '''main_ingredient'''&nbsp;– Main ingredient(s) for the dish. Separate multiple values by using {{tl|Plainlist}}.
* '''main_ingredient'''&nbsp;– Main ingredient(s) for the dish. Separate multiple values by using {{tl|Plainlist}}.
** List amounts in parentheses, such as: <nowiki>{{Plainlist|Banana (1)|Yogurt (1 cup)}}</nowiki>
* '''minor_ingredient'''&nbsp;– Minor ingredient(s) for the dish.
* '''minor_ingredient'''&nbsp;– Minor ingredient(s) for the dish.
* '''instructions'''&nbspo;– Instructions for preparing the dish. Separate multiple values by using {{tl|Plainlist}}.
** List amounts in parentheses, such as: <nowiki>{{Plainlist|Vanilla extract (1 tsp)|Cinammon (0.5 tsp)}}</nowiki>
* '''yield'''&nbsp;– Yield of recipe in serving sizes, based on ingredients and instructions.
* '''instructions'''&nbsp;– Instructions for preparing the dish. Separate multiple values by using {{tl|Plainlist}}.
* '''variations'''&nbsp;– Variations for making the dish.
* '''variations'''&nbsp;– Variations for making the dish.
* '''serving_size'''&nbsp;– Size of the default serving, (use 100 g for the standard 100 [[gram|g]] serving size).
* '''serving_size'''&nbsp;– Size of the default serving, (use 100 g for the standard 100 [[gram|g]] serving size).

Latest revision as of 15:20, 19 May 2014

Usage

{{{name}}}
Lua error: Cannot create process: proc_open(/dev/null): failed to open stream: Operation not permitted
{{{caption}}}
Alternative names
{{{alternate_name}}}
Summary {{{summary}}}
Type {{{course}}}
Location of creation
{{{location}}}
Creators {{{creator}}}
Total time
Serving temperature
{{{served}}}
Main ingredients
{{{main_ingredient}}}
Ingredients generally used
{{{minor_ingredient}}}
Yield {{{yield}}}
Instructions {{{instructions}}}
Variations {{{variations}}}
Food energy
(per 100 g serving)
{{{calories}}} kcal
Nutritional value
(per 100 g serving)
Protein {{{protein}}} g
Fat {{{fat}}} g
Carbohydrate {{{carbohydrate}}} g
Similar dishes
{{{similar_dish}}}
Other information
{{{other}}}
{{Infobox recipe
| name             = 
| image            = 
| caption          = 
| alternate_name   = 
| summary          =
| location         = 
| creator          = 
| date             = 
| time1            = 
| time2            = 
| course           = 
| type             = 
| served           = 
| main_ingredient  = <!-- List amounts in parentheses: {{Plainlist|Banana (1)|Yogurt (1 cup)}} -->
| minor_ingredient = <!-- List amounts in parentheses: {{Plainlist|Vanilla extract (1 tsp)|Cinammon (0.5 tsp)}} -->
| yield            =
| instructions     = 
| variations       = 
| serving_size     = 100 g
| calories         = 
| protein          = 
| fat              = 
| carbohydrate     = 
| glycemic_index   = 
| similar_dish     = 
| other            = 
| complexity       = 3 <!-- Should if provided contain a number between 1 and 5 -->
}}

Parameters

Copy and paste the infobox above into the desired article and fill in the values after the equals (=) sign. All of the fields are optional. For questions or examples please see the discussion page.

  • name â€“ This comes to the top of the box. If omitted, will be inferred from the page title.
  • image â€“ If there's not an image available, leave the field empty.
  • caption â€“ Leave empty for no image caption.
  • alternate name â€“ Alternate name for the dish.
  • summary â€“ Summary description of the dish.
  • location â€“ Location of creation of the dish.
  • creator â€“ Creator(s) of the dish.
  • year â€“ Year of creation of the dish.
  • time1 â€“ Min time for cooking the dish.
  • time2 â€“ Max time for cooking the dish.
  • course â€“ Appetizer, Dessert, Drink, Main course, Salad, or Side dish.
  • type â€“ e.g. "pie", "biscuit", etc. Do not use if redundant to |course=
  • served â€“ Serving temperature for the dish.
  • main_ingredient â€“ Main ingredient(s) for the dish. Separate multiple values by using {{Plainlist}}.
    • List amounts in parentheses, such as: {{Plainlist|Banana (1)|Yogurt (1 cup)}}
  • minor_ingredient â€“ Minor ingredient(s) for the dish.
    • List amounts in parentheses, such as: {{Plainlist|Vanilla extract (1 tsp)|Cinammon (0.5 tsp)}}
  • yield â€“ Yield of recipe in serving sizes, based on ingredients and instructions.
  • instructions â€“ Instructions for preparing the dish. Separate multiple values by using {{Plainlist}}.
  • variations â€“ Variations for making the dish.
  • serving_size â€“ Size of the default serving, (use 100 g for the standard 100 g serving size).
  • calories â€“ Calories per serving, use a raw number for automatic conversion to kJ.
  • calories_ref â€“ Citation for the calories per serving.
  • protein â€“ The amount of protein in the dish per serving.
  • fat â€“ The amount of fat in the dish per serving.
  • carbohydrate â€“ The amount of carbohydrate in the dish per serving.
  • glycemic_index â€“ Glycemic index (GI).
  • similar_dish â€“ Similar dish.
  • other â€“ Other information.
  • complexity â€“ The complexity of cooking. Should if provided contain a number between 1 and 5.

Microformats

Recipe

The HTML mark up produced by this template includes an hRecipe microformat, which makes food recipes and individual foods parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person. For more information about the use of microformats on Wikipedia, please see the microformat project.

hRecipe uses HTML classes including:

  • author
  • duration
  • fn
  • ingredient
  • instructions
  • nutrition
  • published
  • tag
  • type
  • yield

Please do not rename or remove these classes.