Difference between revisions of "Template:Australia locator map/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
(add cat)
imported>Plastikspork
(→‎Parameter list: BaseballIcon being deleted)
Line 15: Line 15:
 
:* Only the filename (with extension) should be used.
 
:* Only the filename (with extension) should be used.
 
:* For best results, the file should be in a 3:2 width:height format. Variations on this will likely make the icon appear either too north (eg 2:1) or too far west (eg 1:1).
 
:* For best results, the file should be in a 3:2 width:height format. Variations on this will likely make the icon appear either too north (eg 2:1) or too far west (eg 1:1).
*  <code>'''adelaide-bb-icon'''</code> - the parameter from {{tl|baseballIcon}} to use for the location
+
*  <code>'''adelaide-bb-icon'''</code> - to use a standard red pin.
 
:* Only the icon parameter is required. Size and alignment are preset.
 
:* Only the icon parameter is required. Size and alignment are preset.
 
:* For a list of available options, see {{<nowiki>baseballIcon</nowiki>}}.
 
:* For a list of available options, see {{<nowiki>baseballIcon</nowiki>}}.

Revision as of 22:58, 8 April 2012

This template is intended as a locator map for Australia. It is preset with 15 locations, with customizable labels and icons for those locations. The icon parameters have been setup to work with the {{baseballIcon}} template, but any images can be used.

Usage

Parameter list

  • size - the width of the template in pixels
  • Defaults to 450.
  • Don't use "px" at the end of the number, it's already coded for.
  • adelaide-label - the label for the location
  • adelaide-color - the color of the label's text
  • Defaults to black (#000000).
  • Can either be in RGB format ("#xxyyzz" where xx is the hexadecimal value for red, yy is green, and zz is blue) or a web color name.
  • adelaide-icon - the name of the image for the location
  • Only the filename (with extension) should be used.
  • For best results, the file should be in a 3:2 width:height format. Variations on this will likely make the icon appear either too north (eg 2:1) or too far west (eg 1:1).
  • adelaide-bb-icon - to use a standard red pin.
  • Only the icon parameter is required. Size and alignment are preset.
  • For a list of available options, see {{baseballIcon}}.

For the parameters above, "adelaide" can be substituted for any of the other locations, following the same format. The full list of locations in the format accepted by the template is:

See also