Jump to content

Template:Recipe summary/doc

From Wikibooks, open books for an open world
{{recipe summary
| category    = 
| servings    = 
| time        = 
| difficulty  = <!-- Should if provided contain a number between 1 and 5 -->
| image       = 
| energy      = <!-- Should if provided contain the number of calories and cal (can include kJ)-->
| note        = 
}}

Examples

[edit source]

Named parameters, All values

[edit source]
{{recipe summary
| category    = Dessert recipes
| servings    = 1-2
| time        = 30 minutes
| difficulty  = 3
| image       = [[File:Hamburger_sandwich.jpg|300px]]
| energy      = 100 Cal (400 kJ)
| note        = Requires specific tools
}}
Recipe summary/doc
CategoryDessert recipes
Servings1-2
Energy100 Cal (400 kJ)
Time30 minutes
Difficulty
NoteRequires specific tools


Positional parameters, All values

[edit source]

{{recipe summary|Dessert recipes|1-2|40 minutes|3|[[File:Hamburger_sandwich.jpg|300px]]|100 Cal (400 kJ)|Requires specific tools}}

Note that some parameters should not have any newlines or spaces around them when using positional parameters as it will break the template.

Recipe summary/doc
CategoryDessert recipes
Servings1-2
Energy100 Cal (400 kJ)
Time40 minutes
Difficulty
Note100 Cal (400 kJ)


Named parameters, Partial values

[edit source]
{{recipe summary
| category    = Dessert recipes
| servings    = 1-2
| time        = 30 minutes
| image       = [[File:Hamburger_sandwich.jpg|300px]]
}}
Recipe summary/doc
CategoryDessert recipes
Servings1-2
Time30 minutes


Positional parameters, Partial values, Subsequent positional parameters

[edit source]
{{recipe summary|Dessert recipes|1-2|30 minutes||[[File:Hamburger_sandwich.jpg|300px]]||}}</nowiki>
Recipe summary/doc
CategoryDessert recipes
Servings1-2
Time30 minutes


Positional parameters, Partial values, No subsequent parameters

[edit source]

If you do not need later positional parameters, you can omit the "|"s.

{{recipe summary|Dessert recipes|1-2|30 minutes}}
Recipe summary/doc
CategoryDessert recipes
Servings1-2
Time30 minutes


Positional parameters, Partial values, Named subsequent parameters

[edit source]

As above, if you do not need later positional parameters, you can omit the "|"s. You may wish to include these via named parameters for clarity or brevity:

{{recipe summary|Dessert recipes|1-2|30 minutes|image=[[File:Hamburger_sandwich.jpg|300px]]}}
Recipe summary/doc
CategoryDessert recipes
Servings1-2
Time30 minutes

TemplateData

[edit source]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Recipe summary

Infobox for recipes in the cookbook

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
NameName name

The name of the recipe. Defaults to PAGENAME if not set.

Auto value
{{subst:PAGENAME}}
Stringoptional
CategoryCategory category 1

Category of the recipe.

Example
Dessert recipes
Unknownsuggested
YieldYield yield 8

How much the recipe makes.

Example
24 cookies, 2 cups, 500 g, etc.
Unknownsuggested
ServingsServings servings 2

The number(s) of servings the recipe would make.

Example
1~2
Unknownsuggested
TimeTime 3

Time needed to complete the recipe.

Example
30 minutes
Unknownsuggested
DifficultyDifficulty difficulty 4

The difficulty of finishing the recipe on a scale of 1~5.

Suggested values
1 2 3 4 5
Numbersuggested
ImageImage image 5

An image of the product of the recipe

Example
[[File:Hamburger_sandwich.jpg|300px]]
Unbalanced wikitextsuggested
EnergyEnergy energy 6

Energy intake of the product of the recipe.

Example
100 Cal (400 kJ)
Stringsuggested
NoteNote note 7

Any notes on the recipe.

Stringoptional
NoincludecatNoincludecat

When this parameter is set to anything, don't put the page in the category specified in the "category" parameter.

Booleanoptional
Ratingrating

no description

Numberdeprecated

See also

[edit source]