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

From Sudo Room
Jump to navigation Jump to search
(creates template doc)
 
(changes name to 'Infobox recipe', removes docs on deprecated wikibooks/commons links, adds Date docs, adds instructions field)
Line 2: Line 2:
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
==Usage==
==Usage==
{{Infobox prepared food
{{Infobox recipe
| name            = {{{name}}}
| name            = {{{name}}}
| image            = {{{image}}}
| image            = {{{image}}}
| caption          = {{{caption}}}
| caption          = {{{caption}}}
| alternate_name  = {{{alternate_name}}}
| alternate_name  = {{{alternate_name}}}
| country          = {{{country}}}
| location        = {{{location}}}
| region          = {{{region}}}
| national_cuisine = {{{national_cuisine}}}
| creator          = {{{creator}}}
| creator          = {{{creator}}}
| year             = {{{year}}}
| date             = {{{date}}}
| time1            = {{{time1}}}
| time1            = {{{time1}}}
| time2            = {{{time2}}}
| time2            = {{{time2}}}
Line 19: Line 17:
| main_ingredient  = {{{main_ingredient}}}
| main_ingredient  = {{{main_ingredient}}}
| minor_ingredient = {{{minor_ingredient}}}
| minor_ingredient = {{{minor_ingredient}}}
| instructions    = {{{instructions}}}
| variations      = {{{variations}}}
| variations      = {{{variations}}}
| serving_size    = 100 g
| serving_size    = 100 g
Line 31: Line 30:
}}
}}
<pre style="overflow:auto">
<pre style="overflow:auto">
{{Infobox prepared food
{{Infobox recipe
| name            =  
| name            =  
| image            =  
| image            =  
| caption          =  
| caption          =  
| alternate_name  =  
| alternate_name  =  
| country          =
| location        =  
| region          =
| national_cuisine =  
| creator          =  
| creator          =  
| year             =  
| date             =  
| time1            =  
| time1            =  
| time2            =  
| time2            =  
Line 48: Line 45:
| main_ingredient  =  
| main_ingredient  =  
| minor_ingredient =  
| minor_ingredient =  
| instructions    =
| variations      =  
| variations      =  
| serving_size    = 100 g
| serving_size    = 100 g
Line 81: Line 79:
* '''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}}.
* '''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}}.
* '''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).
Line 92: Line 91:
* '''other'''&nbsp;– Other information.
* '''other'''&nbsp;– Other information.
* '''complexity'''&nbsp;– The complexity of cooking. Should if provided contain a number between 1 and 5.
* '''complexity'''&nbsp;– The complexity of cooking. Should if provided contain a number between 1 and 5.
* '''no_recipes'''&nbsp;– set to 'true' to suppress the recipe search links
* '''no_commons'''&nbsp;– set to 'true' to suppress the commons search links


==Microformats==
==Microformats==
===Adr===
{{UF-adr}}
===Recipe===
===Recipe===
{{UF-hrecipe}}
{{UF-hrecipe}}
<includeonly>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
==See also==
* [[Template:Nutritional value]]
* [[Template:Infobox brand]]
<includeonly>
[[Category:Food infobox templates|prepared food]]
</includeonly>
</includeonly>

Revision as of 14:38, 19 May 2014

File:OOjs UI icon book-ltr.svg This is a documentation subpage for Template:Infobox recipe.
It contains usage information, categories and other content that is not part of the original template page.

Usage

{{{name}}}
Lua error: Cannot create process: proc_open(/dev/null): failed to open stream: Operation not permitted
{{{caption}}}
Alternative names
 {{{alternate_name}}}
Type {{{course}}}
Location of creation
 {{{location}}}
Creators {{{creator}}}
Total time
Serving temperature
 {{{served}}}
Main ingredients
 {{{main_ingredient}}}
Ingredients generally used
 {{{minor_ingredient}}}
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   = 
| location         = 
| creator          = 
| date             = 
| time1            = 
| time2            = 
| course           = 
| type             = 
| served           = 
| main_ingredient  = 
| minor_ingredient = 
| 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.
  • country â€“ Country of origin of the dish.
  • region â€“ Region or state the dish was developed.
  • national_cuisine â€“ Cuisine by nationality.
  • creator â€“ Creator(s) of the dish.
  • year â€“ Year of invention 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}}.
  • minor_ingredient â€“ Minor ingredient(s) for the dish.
  • instructions&nbspo;– 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.

Retrieved from "https://sudoroom.org/mediawiki/index.php?title=Template:Infobox_recipe/doc&oldid=8110"