Template:Infobox cocktail/doc
File:Edit-copy green.svg | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
File:Lua-Logo.svg | This template uses Lua: |
{{Wikipedia:WikiProject Food and drink/Beverages Task Force/navigation}}
{{Infobox cocktail}} displays a highly configurable, user-friendly table of information concerning mixed drinks, cocktails, garnishes, and drinkware in the upper right of each related article. It should be present on articles concerning notable alcoholic and non-alcoholic mixed drinks, including cocktails, as well as cocktail garnishes and drinkware. By providing readers a consistent table of similar information within all the page concerning these topics, they will be able to locate the pertinent information quickly and easily, without having to read through the entire article. {{Infobox cocktail}} is extremely complex and very powerful. When used correctly (and it's much easier to use than the previous sentence made it sound), the infobox does much more than provide snippets of information. It also:
- Clearly identifies IBA official cocktails.
- Reduces clutter and disorganization within the articles by moving information that is generally poorly formatted into a logical infobox template.
- Reduces nearly all contentious "recipe" information (which is generally considered not acceptable within Wikipedia) to a small list of key ingredients (which essentially defines the drink much like the chemical formula does a molecule), and very brief preparation steps. All of this is moved outside the article and into the infobox, keeping the article clearly more encyclopedic in tone.
- Advanced scripting within the infobox properly links to pertinent articles, displays appropriate images, and handles other tasks based on a simple "attribute" and "attribute value" system (in other words, you copy and paste the template into the page, fill in a few key words, and the template does all the Wiki-magic to display lots of cool information).
Usage
To get started with a mixed drink article, copy the Basic template below and paste it into the article. If you are editing a type of drinkware or a cocktail garnish, use the other appropriate template instead. The template with all the options is primarily for reference. At a minimum, you will need to replace the NAME in the template with the actual name of the article's subject, and also the ALCOHOLTYPE with a valid type of alcohol (like gin or vodka). Preview the page, and you should see something similar to the examples below.
Do not subst: this template, or the page will become filled with information that will make it very hard for anyone to edit the article.
Place the following text near the top of the page, usually right after the first paragraph and before the first heading is a good choice.
Basic template options | All template options | ||||||||
---|---|---|---|---|---|---|---|---|---|
Use the following template options replacing ALCOHOLTYPE with one of the primary alcohol options.
<syntaxhighlight lang="wikitext">
|
<syntaxhighlight lang="wikitext">
| ||||||||
Drinkware/garnish options | |||||||||
Drinkware and cocktail garnishes use only the following options. <syntaxhighlight lang="wikitext">
|
Attributes
- Only the name of the topic is required.
- Except for the primary alcohol types, all the basic template options or drinkware/garnish template options should be included in the article. Doing so makes it easy for other editors to fill-in missing information. Blank attribute are not displayed.
- Standard attribute names ("iba", "name", "image", etc.) and values ("yes", "whiskey", "rocks2", etc.) are CaSe-SeNsItIvE, so be sure to enter them exactly as indicated. If something unexpected is displayed, this is one of the first things to check.
- Line breaks are permitted in most free-form values
iba
- This attribute applies only to certain cocktails.
Several cocktails are specially designated by the International Bartender Association (IBA) and are used in the annual World Cocktail Competition (WCC). These mixed drinks are some of the most well-known and popular drinks throughout the world. Such a drink is referred to as an IBA Official Cocktail.
Always identify any IBA Official Cocktails: <syntaxhighlight lang="wikitext"> | iba = yes</syntaxhighlight>
Source
- This attribute applies only to mixed drinks.
Mixed drinks vary quite a bit in how they are prepared. This can result in quite a bit of disagreement between editors as to the "correct" ingredients and their proportions.
Whenever possible one of the following sources should be used for creating the ingredient list (see below).
IBA Official Cocktails should always use the IBA standard recipes. This option is redundant if iba=yes
is set above: <syntaxhighlight lang="wikitext"> | source = iba</syntaxhighlight>
If using DrinkBoy: <syntaxhighlight lang="wikitext"> | source = drinkboy</syntaxhighlight>
If using a different site: <syntaxhighlight lang="wikitext"> | source = url</syntaxhighlight>
If using an unknown source (not a good idea), leave it blank: <syntaxhighlight lang="wikitext"> | source = </syntaxhighlight>
sourcelink
- This attribute applies only to mixed drinks with a valid source attribute (see above).
If you entered a source above, you should also enter the link
For IBA Official Cocktails, see the instructions for {{IBA recipe}} to obtain the link name: <syntaxhighlight lang="wikitext"> | sourcelink = DRINKNAME</syntaxhighlight>
For Drinkboy, see the instructions for {{Drinkboy recipe}} to obtain the link name: <syntaxhighlight lang="wikitext"> | sourcelink = ###</syntaxhighlight>
If using a different site, enter the full URL: <syntaxhighlight lang="wikitext"> | sourcelink = http://www.example.net</syntaxhighlight>
If using an unknown source (not a good idea), leave it blank: <syntaxhighlight lang="wikitext"> | sourcelink = </syntaxhighlight>
name
- Applies to all types.
This is the name of the mixed drink, cocktail garnish, or drinkware to which you are adding the infobox.
- If you are tagging an IBA Official Cocktail, you should always name the infobox with the exact IBA Official Cocktail name.
- Except for disambiguation information following the drink name, the name of the article should also match the IBA Official Cocktail name. If it does not, please discuss this on the article's talk page. If you feel very comfortable moving articles to new names and fixing all double redirect links and updating what links here pages, feel free to do so. Otherwise, please add it to the To-Do List for the Mixed Drinks Task Force; we will be happy to help move the article and fix anything that needs fixing.
Always provide the name of the subject (enter on a single line without links): <syntaxhighlight lang="wikitext"> | name = NAME</syntaxhighlight>
image
- Applies to all types.
If there is a decent photo available, please include its name here. You should not include the word "file:" or the size of the image. If you have a choice of photos, please try to pick the one that is most representative of the subject. For drinks, that would be a photo showing the drink properly prepared, with the standard garnishes, in the standard drinkware for the type of beverage. For drinkware, it should be a fairly plain and standard version of the vessel, without much decoration or ornamentation, and preferably no brand names or logos visible. For garnishes, pictures that show how the item is used as a mixed drink are best, but a good close-up is also perfectly acceptable.
If there is a good image available, please include its filename: <syntaxhighlight lang="wikitext"> | image = example.jpg</syntaxhighlight>
- Applies to all types.
Captions only appear if an image is specified. The caption should ideally point out some of the reasons why the image is truly representative of the subject. If there is something non-standard about the photo (like a drink served in the wrong type of glass), it may be good to point that out, too.
If displaying a picture, provide a detailed description (may be multiple lines): <syntaxhighlight lang="wikitext"> | caption = Green Fizz cocktails are easily identified by their fluorescent green tint.</syntaxhighlight>
type
- Applies to all types.
Certain drinks, like eggnog, which are commonly served both with and without alcohol, and do not fit nicely in more specific categories should be identified as mixed, but they are the exceptions.
If the primary alcohol is a type of beer that is mixed with lesser amounts of other alcohols or mixers:
(see Category:Cocktails with beer)
<syntaxhighlight lang="wikitext"> | type = beer</syntaxhighlight>
If the primary alcohol is a type of distilled spirit (gin, rum, tequila, vodka, whiskey, etc.) that is mixed with lesser amounts of other alcohols or mixers:
(see Category:Cocktails)
<syntaxhighlight lang="wikitext"> | type = cocktail</syntaxhighlight>
If the primary alcohol is a type of distilled spirit (gin, rum, tequila, vodka, whiskey, etc.) that is mixed with a larger amount of non-alcoholic mixer: <syntaxhighlight lang="wikitext"> | type = highball</syntaxhighlight>
If the cocktail is primarily served as a shooter (in other words, it would be very odd to see it served in anything other than a shot glass):
(see Category:Shooters (drinks))
<syntaxhighlight lang="wikitext"> | type = shooter</syntaxhighlight>
If the cocktail is a layered shooter (a shooter in which the various alcohols are layered one on top of the other): <syntaxhighlight lang="wikitext"> | type = layered</syntaxhighlight>
If the primary alcohol is a type of wine (including Champagne and fortified wines) that is mixed with lesser amounts of other alcohols or mixers:
(see Category:Cocktails with wine)
<syntaxhighlight lang="wikitext"> | type = wine</syntaxhighlight>
Mixed drinks that normally do not contain any alcohol:
(see Category:Non-alcoholic mixed drinks)
<syntaxhighlight lang="wikitext"> | type = nonalc</syntaxhighlight>
or, if you prefer:
<syntaxhighlight lang="wikitext"> | type = non-alcoholic</syntaxhighlight>
Any other type of mixed drink that does not fit into one of the preceding types, should be labeled:
(see Category:Mixed drinks)
<syntaxhighlight lang="wikitext"> | type = mixed</syntaxhighlight>
Drinkware, such as drinking glasses, stemware, steins, drinking horns, etc., should be identified:
(see Category:Drinkware)
<syntaxhighlight lang="wikitext"> | type = drinkware</syntaxhighlight>
Finally, cocktail garnishes (usually the non-food types) should be identified:
(see Category:Cocktail garnishes)
<syntaxhighlight lang="wikitext"> | type = garnish</syntaxhighlight>
flaming
- This attribute applies only to mixed drinks.
Some mixed drinks are made with high-proof alcohol that is ignited prior to serving. These "flaming beverages" are generally a type of cocktail or shooter. If the article discusses serving the drink on fire, either normally or as a variation, note this by setting this attribute.
Served on fire regularly or as a variation: <syntaxhighlight lang="wikitext"> | flaming = yes</syntaxhighlight>
ALCOHOLTYPE
- This attribute applies only to mixed drinks.
While you may include the list of all possible alcohol type attributes, it is usually best to remove the attributes that do not apply to save storage space and improve processing speed.
- Identify the primary alcohol by volume used in the drink. If two or more types of alcohol are primary and in equal volumes, you should list each of the primary alcohols by including each alcohol's ALCOHOLTYPE on separate lines.
- Generally do not include the primary alcohols used in variations listed within the article (for example, only list "gin" for a martini, even though vodka martinis are a very common variation that is mentioned in the same article).
Substitute the word ALCOHOLTYPE in this example: <syntaxhighlight lang="wikitext"> | ALCOHOLTYPE = yes</syntaxhighlight> with one of the following types of alcohol:
Grain-based Spirits and Fermented Beverages | ||
---|---|---|
Beers | ||
ALCOHOLTYPE | Links to the following article | Notes |
Use beer unless the specific type is important. | ||
beer | Beer | Preferred generic term |
ale | Ale | |
fruitbeer | Fruit Beer | |
lager | Lager | |
pilsner | Pilsner | |
porter | Porter | |
stout | Stout | |
wheatbeer | Wheat beer | |
Gins | ||
ALCOHOLTYPE | Links to the following article | Notes |
gin | Gin | Preferred generic term |
Neutral Grain Spirits | ||
ALCOHOLTYPE | Links to the following article | Notes |
everclear | Everclear | |
moonshine | Moonshine | |
Rice-based | ||
ALCOHOLTYPE | Links to the following article | Notes |
sake | Sake | |
Whiskies | ||
Use whiskey unless the specific type is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
whiskey | Whiskey | Preferred generic term |
bourbon | Bourbon whiskey | |
canadian | Canadian whisky | |
irishw | Irish whiskey | |
rye | Rye whiskey | |
scotch | Scotch whisky | |
tennessee | Tennessee whiskey | |
whisky | Whisky | |
Fruit-based Spirits and Fermented Beverages | ||
Brandies | ||
Use brandy or cognac unless the specific type is important. | ||
brandy | Brandy | Preferred generic term |
cognac | Cognac | Preferred generic term |
gmarnier | Grand Marnier | Also an orange liqueur |
hpnotiq | Hpnotiq | Also a fruit liqueur |
pisco | Pisco | |
Wines | ||
Use wine or sparkling unless the specific type is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
wine | Wine | Preferred generic term |
sparkling | Sparkling wine | Preferred generic term |
champagne | Champagne | |
fortified | Fortified wine | |
port | Port | |
prosecco | Prosecco | |
vermouth | Vermouth | |
Other Fruits | ||
ALCOHOLTYPE | Links to the following article | Notes |
cider | Cider | |
Other Spirits and Fermented Beverages | ||
Agave-based | ||
Use mezteq unless the specific type is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
mezteq | Mezcal/Tequila | Preferred generic term |
mezcal | Mezcal | |
tequila | Tequila | |
Potato-based | ||
ALCOHOLTYPE | Links to the following article | Notes |
vodka | Vodka | Preferred generic term |
Sugar Cane or Molassas-based | ||
Use rum unless the specific type is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
rum | Rum | Preferred generic term |
151 | Bacardi 151 | |
cachaça | Cachaça | |
Miscellaneous | ||
ALCOHOLTYPE | Links to the following article | Notes |
schnapps | Schnapps | |
highproof | High-proof alcohol | |
Liqueurs | ||
Anise | ||
Use anise unless the specific type is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
anise | Anise-flavored liqueur | Preferred generic term |
absinthe | Absinthe | |
ouzo | Ouzo | |
pastis | Pastis | |
sambuca | Sambuca | |
Chocolate | ||
Use chocolate unless the specific type is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
chocolate | Chocolate liqueur | |
cacao | Crème de Cacao | Also a crème liqueur |
Coffee | ||
ALCOHOLTYPE | Links to the following article | Notes |
coffee | Coffee liqueur | Kahlúa, Tia Maria, etc. |
Cream | ||
ALCOHOLTYPE | Links to the following article | Notes |
cream | Cream liqueur | Generic term |
irishc | Irish Cream | Baileys, etc. |
Crème | ||
ALCOHOLTYPE | Links to the following article | Notes |
crème | Crème liqueur | Generic term |
cacao | Crème de Cacao | Also a chocolate liqueur |
menthe | Crème de menthe | |
Fruit or Berry | ||
Use one of the generic terms unless the specific brand is important. | ||
ALCOHOLTYPE | Links to the following article | Notes |
berry | Berry liqueur | Generic term |
curaçao | Curaçao | |
fruit | Fruit liqueur | Generic term |
gmarnier | Grand Marnier | Also an brandy |
hpnotiq | Hpnotiq | Also a cognac |
midori | Midori | |
orange | Orange-flavored liqueur | Generic term |
pucker | Pucker | |
Herbal | ||
See also Anise above. | ||
ALCOHOLTYPE | Links to the following article | Notes |
campari | Campari | |
herbal | Herbal liqueur | Generic term |
jäger | Jägermeister | |
Nuts | ||
ALCOHOLTYPE | Links to the following article | Notes |
amaretto | Amaretto |
You may also specify any other type of alcohol ("build your own"): <syntaxhighlight lang="wikitext"> | other = Amaro</syntaxhighlight>
You may refer to the article itself (or any other text): <syntaxhighlight lang="wikitext"> | other = See the article for details</syntaxhighlight>
served
- This attribute applies only to mixed drinks.
This attribute explains how the drink is typically served. If the drink is served in a variety of ways, you may leave this attribute blank or write your own brief description.
Blended with ice ("frozen" style): <syntaxhighlight lang="wikitext"> | served = blended</syntaxhighlight>
"On the rocks"; poured over ice: <syntaxhighlight lang="wikitext"> | served = rocks</syntaxhighlight>
"Straight up"; without ice: <syntaxhighlight lang="wikitext"> | served = straight</syntaxhighlight>
"Neat"; undiluted and without ice:
<syntaxhighlight lang="wikitext"> | served = neat</syntaxhighlight>
Write your own description (may be multiple lines): <syntaxhighlight lang="wikitext"> | served = Commonly served two ways:
- "On the rocks"; poured over ice
- Blended with ice ("frozen" style)
</syntaxhighlight>
garnish
- This attribute applies only to mixed drinks.
Cocktail garnishes are considered optional by some, and some bartenders and patrons have unconventional ways of garnishing their drinks. However, if there is a standard way of garnishing the drink (as is the case with IBA Official Cocktails), then briefly list standard garnishes, linking where it makes sense.
Write your own description (may be multiple lines): <syntaxhighlight lang="wikitext">| garnish = 1⁄2 orange slice and maraschino cherry</syntaxhighlight>
drinkware
- This attribute applies only to mixed drinks.
As with garnishes, the standard type of drinkware (drinking glass, beer stein, etc.) varies from place to place, but there is usually one type of glass that is standard for any particular drink.
This section may be updated in the near future for increased flexibility, such as the possibility of adding multiple types of drinkware (for example, margaritas are commonly served in tumblers, welled margarita glasses, and margarita saucers). Other plans include providing standard measurements for the drinkware. So, for now, please pick only one type of drinkware from the list below, whichever seems most common or proper for the drink.
Substitute the word TYPE in this example: <syntaxhighlight lang="wikitext"> | drinkware = TYPE</syntaxhighlight> with one of the following types of drinkware:
-
absinthe
Absinthe glass -
beermug
Beer mug -
beerstein
Beer stein -
beverage
Beverage glass (Tumbler) -
cocktail
Cocktail glass -
coffee
Irish coffee mug -
cooler
Cooler glass -
cosmo
Cosmopolitan or cocktail glass -
collins
Collins glass -
cordial
Cordial glass -
coupe
Champagne coupe -
cup
Coffee cup -
flute
Champagne flute -
goblet
Goblet -
highball
Highball glass -
hurricane
Hurricane glass -
icedtea
Iced tea glass -
margarita
Margarita glass -
margaritas
Margarita glass -
mug
Mug -
pilsner
Pilsner glass -
pint
Pint glass -
pub
Pub glass -
rocks
Rocks glass -
rocks2
Rocks glass (double) -
schooner
Schooner -
sherry
Sherry glass -
shooter
Shooters glass -
shooter2
Shooters glass (double) -
shot
Shot glass -
shot2
Shot glass (double) -
snifter
Snifter -
wheat
Wheat beer glass -
wineg
Wine glass (grande) -
winer
Wine glass (red) -
winew
Wine glass (white)
- Special cases
Beer cocktails often call for both a pint (or pub) glass and a shot glass: <syntaxhighlight lang="wikitext"> | drinkware = pintshot</syntaxhighlight> <syntaxhighlight lang="wikitext"> | drinkware = pubshot</syntaxhighlight>
You could also write your own description, but due to planned changes in how this attribute works, it is not recommended: <syntaxhighlight lang="wikitext"> | drinkware = See the article for details</syntaxhighlight>
ingredients
- This attribute applies only to mixed drinks.
- Using
{{Plainlist}}
or{{Unbulleted list}}
(same output, different input format) will produce something that looks most like a typical ingredients list, does not waste horizontal space in the infobox, and will be consistent from article to article. - If the drink is an IBA Official Cocktail, only the official ingredients should be listed.
- If using a different source, be sure to include the
|source=
and (if applicable)|sourcelink=
parameters for proper attribution). - Link to each ingredient's Wikipedia article wherever it makes sense to do so. Do not worry about duplicating links elsewhere in the body of the article. Such duplicate links should generally be avoided because they can cause confusion, but in this case links inside the infobox are helpful rather than confusing.
- Do not list variations in this section. If there is a very common variation (like vodka in martinis), it is acceptable to mention that in
|footnotes=
(or less desirably in|notes=
if|footnotes=
are used for something else); however, no more than one or two such variations should be mentioned there. Use the main article to list less common variations.
Write your own description (unbulleted lists are preferred; see templates mentioned above for this): <syntaxhighlight lang="wikitext"> | ingredients = Please keep instructions very brief. Use IBA official ingredients if available.</syntaxhighlight>
prep
- This attribute generally applies to mixed drinks and possibly garnishes.
- If the drink is an IBA Official Cocktail, only the official instructions should be given. Minor edits are acceptable (sometimes even desirable), but only if they do not alter or confuse any of the process of making the drink the IBA way.
- In all other cases, avoid multiple complete sentences, using very brief action phrases (e.g., "Pour whiskey then juice over ice; drizzle grenadine until streaks appear; garnish and serve.")
- Avoid linking within the preparation method, unless the term is not linked elsewhere in the infobox and would likely be helpful to the reader (tools and methods of preparation may need linking).
Write your own description (may be multiple lines): <syntaxhighlight lang="wikitext"> | prep = Please keep instructions very brief. Use IBA official instructions if available.</syntaxhighlight>
timing
- This attribute applies only to mixed drinks.
Indicate the conventional time at which the drink is generally consumed. Typical values are Before dinner, After dinner, and All day <syntaxhighlight lang="wikitext"> |timing = Convention dictates the time at which certain drinks should be consumed.</syntaxhighlight>
notes
- This attribute is primarily for drinkware and garnishes.
Drinks should rarely, if ever use this attribute (just put the notes directly in the article).
Since most of the rest of the infobox is concerned with drinks, this attribute is a free-form place to note anything important concerning drinkware or garnishes.
Write your own description (may be multiple lines): <syntaxhighlight lang="wikitext"> | notes = Notes are primarily for drinkware and garnishes</syntaxhighlight>
footnotes
- Applies to all types.
Footnotes are printed in very small text, and are most useful for minor notes or clarifications of other information mentioned in the infobox.
Write your own description (may be multiple lines): <syntaxhighlight lang="wikitext"> | footnotes = Footnotes should generally be avoided</syntaxhighlight>
Examples
This text | Produces this result | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
No attributes specified | |||||||||||||||||||||||||||||||||||||||||||||
<syntaxhighlight lang="wikitext">
|
| ||||||||||||||||||||||||||||||||||||||||||||
Unconfigured basic template | |||||||||||||||||||||||||||||||||||||||||||||
<syntaxhighlight lang="wikitext">
|
| ||||||||||||||||||||||||||||||||||||||||||||
Whiskey sour, an IBA Official Cocktail | |||||||||||||||||||||||||||||||||||||||||||||
<syntaxhighlight lang="wikitext">
|
| ||||||||||||||||||||||||||||||||||||||||||||
Snakebite, a beer cocktail | |||||||||||||||||||||||||||||||||||||||||||||
<syntaxhighlight lang="wikitext">
|
| ||||||||||||||||||||||||||||||||||||||||||||
Jellybean, a cocktail | |||||||||||||||||||||||||||||||||||||||||||||
<syntaxhighlight lang="wikitext">
|
|
Microformats
The HTML mark-up produced by this template includes an hRecipe microformat that makes food recipes and information about individual foods readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.
- Classes used
The HTML classes of this microformat include:
- author
- duration
- fn
- ingredient
- instructions
- nutrition
- published
- tag
- type
- yield