Template:WPMIXInfobox/doc

WPMIXInfobox displays a highly configurable, user-friendly table of information concerning mixed drinks, cocktails, garnishes, and drinkware in the upper right of each related article.

Purpose
This infobox is a consistently-formatted table that 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.

undefined 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:
 * Properly categorizes articles by the type of drink (beer mix, cocktail, shooter, etc.) and primary alcohol used (for cocktails).
 * 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).

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.

Usage
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.

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.
 * Bullets ("*") at the start of free-form values generally display as asterisks instead of bullets.
 * Line breaks are permitted in most free-form values, and bullets generally work after the first line break.

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: | iba        = yes

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  is set above:'' | source     = iba

If using CocktailDB: | source     = cocktaildb

If using DrinkBoy: | source     = drinkboy

If using a different site: | source     = url

If using an unknown source (not a good idea), leave it blank: | source     =

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: | sourcelink = DRINKNAME

For CocktailDB, see the instructions for Cocktaildb recipe to obtain the link name: | sourcelink = ####

For Drinkboy, see the instructions for Drinkboy recipe to obtain the link name: | sourcelink = DRINKNAME

If using a different site, enter the full URL: | sourcelink = http://www.example.net

If using an unknown source (not a good idea), leave it blank: | sourcelink =

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 and related Drinkware WikiProject; 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): | name       = NAME

image

 * Applies to all types.

If there is a decent photo available, please include its name here. You should not include the word "Image:" 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: | image      = example.jpg

caption

 * 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, but bullets do not work on the first line): | caption    = ''Green Fizz cocktails are easily identified by their fluorescent green tint.

type

 * Applies to all types.

This is one of the most important attributes to include, because it also automatically categorizes the article properly. If you leave this attribute blank, omit it entirely, or enter a value that is not recognized, the article will be classified under, which is generally not the best place to place these articles, because it is the most generic category. 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 ) '' | type       = beer

''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 ) '' | type       = cocktail

''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 ) '' | type       = shooter

If the cocktail is a layered shooter (a shooter in which the various alcohols are layered one on top of the other): | type       = layered

''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 ) '' | type       = wine

''Mixed drinks that normally do not contain any alcohol:

(see ) '' | type       = nonalc or, if you prefer: | type       = non-alcoholic

''Any other type of mixed drink that does not fit into one of the preceding types, should be labeled:

(see ) '' | type       = mixed

''Drinkware, such as drinking glasses, stemware, steins, drinking horns, etc., should be identified:

(see ) '' | type       = drinkware

''Finally, cocktail garnishes (usually the non-food types) should be identified:

(see ) '' | type       = garnish

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: | flaming    = yes

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: | ALCOHOLTYPE = yes with the one of the following types of alcohol:

You may also specify any other type of alcohol ("build your own"); however the article may not be properly categorized (also add the generic if one is available): | other      = [[Amaro]]

You may refer to the article itself (or any other text): | other      = See the article for details

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): | served     = blended

"On the rocks"; poured over ice: | served     = rocks

"Straight up"; without ice: | served     = straight

"Neat"; undiluted and without ice: Note: "Neat" is generally not proper for mixed drinks, because it essentially means that the alcohol is served without mixing it with anything else (the opposite of a mixed drink), and is included only for the sake of completeness. | served     = neat

Write your own description (may be multiple lines, but bullets do not work on the first line): | served     = Commonly served two ways: * "On the rocks"; poured over ice * Blended with ice ("frozen" style)

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, but bullets do not work on the first line): | garnish    =  ½ orange slice and maraschino cherry 

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: | drinkware  = TYPE with the one of the following types of drinkware:

Beer cocktails often call for both a pint (or pub) glass and a shot glass: | drinkware  = pintshot | drinkware  = pubshot
 * Special cases:

You could also write your own description, but due to planned changes in how this attribute works, itt is not recommended: | drinkware  = See the article for details

ingredients

 * This attribute applies only to mixed drinks.


 * If the drink is an IBA Official Cocktail, only the official ingredients should be listed.
 * The IBA generally uses centilitres for measurements; leave them in cl's, but also include the relative "parts" in parentheses following the centilitre measurement and before the ingredient name.
 * If using CocktailDB or DrinkBoy, use their standard recipe (be sure to include the source and sourcelink for proper attribution) and include the relative "parts" in parentheses.
 * If using a different source, please use your best judgment in how to format the recipe (be sure to include the source and sourcelink 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 the footnotes (or less desirably in the notes if the 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 (bulleted lists are preferred; bullets do work on the first line): | ingredients = ''Please keep instructions very brief. Use IBA official ingredients if available.

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; bullets do work on the first line): | prep       = ''Please keep instructions very brief. Use IBA official instructions if available.

categories

 * Applies to all types.

This is a somewhat "hidden" feature that allows demonstrating these infoboxes in places where it is not desirable to have the articles auto-magically tagged with mixed drink categories. Any value other than no is ignored and the categories will be generated. If set to no the infobox will display as normal, but the categories will be suppressed.

| categories = no

Template

 * The generic template is displayed to the right.