Template:IBA-cocktail/doc

From Wikibooks, open books for an open world
Jump to: navigation, search

This template is part of the IBA template family. It is used in the Bartending Guide Cocktails Glossary, but it is generic enough that it should be usable in other situations.

IBA templates[edit]

Parameters[edit]

  1. The type of cocktail: One of three recognized values (although unrecognized or empty values will default to the value of "official")
    • "official" - For cocktails designated by the IBA as "Official Cocktails" of the IBA
    • "win" or "winning" - For cocktails selected as "Winning Cocktails" at an IBA competition
  2. Link ID or URL: This is an optional parameter. The IBA Website's URL have a unique parameter named "id". Entering the number here taken from the URL following "id=" will automatically generate a link to that page on the IBA Website. If the ID cannot be determined, you can copy the entire URL here; however, that might make it more difficult to update links later if the IBA changes things on their Website.
  3. Link text: This is an optional parameter. The template displays "Official Website" as the default text for any generated link. You may specify any text here to override the default. This either has to be the third parameter or the named parameter text=.

Examples[edit]

IBA-cocktail with no parameters
{{IBA-cocktail}}

Produces the following output:

 IBA 


IBA-cocktail with "official" as the first parameter
{{IBA-cocktail|official}}

Produces the following output:

 IBA 


Which is the same as was produced with the default values.


IBA-cocktail with "winning" as the first parameter
{{IBA-cocktail|winning}}

Produces the nearly the same output:

 IBA 


However, the color of the badge is different, and the text is wikilinked to a different part of the article.
Note that you could substitute the shorter "win" for "winning", and the result would be identical.


IBA-cocktail with "official" as the first parameter and an ID for the second parameter

The complete URL for an Alexander (obtained by right-clicking on the IBA's link and opening the link in a new tab or window) is:

http://www.iba-world.com/index.php?option=com_content&id=89&tmpl=component&task=preview&Itemid=532

Note the bolded portion: "&id=89" The number 89 is the ID number that we need to use. Please do not confuse it with the "&Itemid=532" at the end of the URL; that is a completely different (and useless for us) part of the URL.

{{IBA-cocktail|official|89}}

Produces the following output:

 IBA 
An IBA Official Cocktail: Official Website


Following the "Official Website" link above should take you directly to a slightly different page than you were on, but it should display the same drink along with additional information.


If you really like to be precise, you always can specify an ID value with the parameter name:

{{IBA-cocktail|official|id=89}}
 IBA 
An IBA Official Cocktail: Official Website


IBA-cocktail with "winning" as the first parameter and an ID for the second parameter

Winning Cocktails do not have individual pages, but are found on pages organized in multi-year collections. The URL for the IBA Winning Cocktails (2010-2019) collection is:

http://www.iba-world.com/index.php?option=com_content&view=article&id=159&Itemid=530

Again, note the bolded portion: "&id=159" The number 159 is the ID number that we need to use to access that page. Please do not confuse it with the "&Itemid=530" at the end of the URL.

{{IBA-cocktail|winning|159}}

Produces the following output:

 IBA 
An IBA Winning Cocktail: Official Website


Following the "Official Website" link above should take you back to the original page than you were on.


Using full URLs for links

If you are unable to determine the correct ID number, you can try entering the full URL of the page. It is not the preferred way to do it, but it is better than not including any link. The parameter name "link=" is required for this to work.

{{IBA-cocktail|official|link=http://www.iba-world.com/index.php?option=com_content&id=89&tmpl=component&task=preview&Itemid=532}}
 IBA 
An IBA Official Cocktail: Official Website
{{IBA-cocktail|winning|link=http://www.iba-world.com/index.php?option=com_content&view=article&id=164&Itemid=559}}
 IBA 
An IBA Winning Cocktail: Official Website


Replacing the link text with default links

If you want to change the link text from "Official Website" to something else, like "Alexander: After Dinner Cocktail" or "IBA Winning Cocktails (2010 - 2019)", that is easy to do. Using the parameter name "text=" is strongly recommended, and it is required if the text contains certain special characters (the equals sign being the most notorious troublemaker).

{{IBA-cocktail|official|89|text=Alexander: After Dinner Cocktail}}
 IBA 
An IBA Official Cocktail: Alexander: After Dinner Cocktail
{{IBA-cocktail|winning|164|text=IBA Winning Cocktails (2010 - 2019)}}
 IBA 
An IBA Winning Cocktail: IBA Winning Cocktails (1960 - 1969)