Template:Map/Note

This template generates a map note as a map marker. This template is intended for use in the 'note' parameter of the Map template, though may be used separately in any block type container. See Template:.


 * Usage
 * 1 or x - the relative horizontal marker position
 * 2 or y - the relative vertical marker position
 * 3 or marker - marker type name. Default is 'Blip'
 * 4 or title - the short display name for the note
 * 5 or desc - legend markup for the note. Used by the large map legend
 * icon - if 1, then return only a simple icon wiki image. Optional


 * Notes on 'x' and 'y': These are the map coordinates of the map note marker, noting a position of a marker on the map. Any number of decimal places for the coordinate number can be used, like 52, 52.3, 52.2995843, etc. See additional Note docs


 * Notes on 'marker': Several different marker type names may refer to the same marker type or icon. For a wiki specific list of note marker types and icons. See additional Note docs.


 * Notes on 'desc' legend markup: the note description can optionally a more complex format, like 'Location##Elite mob;;Location::Hogger'. These formats add additional categories and elements to the map legend. See


 * Examples

Basic rules and features:
 * Legend markup
 * Markup for a basic legend entry looks like ' ' or ' '
 * Each basic entry has a category name on the left, and a marker specific name on the right.
 * Basic entries can use ' ' for generic entries or ' ' for specific named entries.
 * Multiple basic entries can be combined for a single marker using ' ' as a delimiter, like: ' '
 * Multiple basic entries allow a single marker to be represented more than once in the legend.

Notes and hints: 

 Location Elite mob 1 				 2 				 Hogger 1 				 2 			 Raid meets here Point of Interest Graveyard
 * Only map notes with a legend parameter are featured in the legend. The rest are omitted.
 * There are no predefined categories or entry types. They simply spring to life when you use them.

An illustrated legend markup guide:
 * A legend entry consists of two parts:
 * The category of the legend entry and
 * the actual name of the entry


 * The two parts are separated by ' ' or ' '


 * There are two kinds of legend entries:
 * 1. Indexed entries. Useful when the note stands for something generic.
 * Indexed entries are separated by  and are rendered like this:
 * Indexed entries are separated by  and are rendered like this:



 Location Elite mob 1 2
 * Indexed entries are always presented as numbers, even if there are no duplicates in the legend.
 * 2. Named entries. Useful when the note stands for a unique place or thing, or any proper name.
 * Named entries are separated by  and are rendered like this:
 * Named entries are separated by  and are rendered like this:
 * Named entries are separated by  and are rendered like this:



 Location Raid meets here Point of Interest Graveyard
 * Named entries will be treated like indexed entries, if there are exact duplicates in the legend.



 Location Hogger 1 2


 * A legend category may have both indexed and named entries.
 * Indexed entries are listed first.
 * Both groups are sorted alphabetically.


 * Any map note may have more than one entry in the legend. Make use of this feature liberally.
 * Multiple entries are separated by  and are rendered like these:
 * Multiple entries are separated by  and are rendered like these:

 Location::Raid meets here;;Location##Elite;;Location::Hogger  Location Elite mob 1 			 Hogger Raid meets here
 * Alternate example showing multiple roles for a character.

 Trainer::Jalane;;Trainer##Skinning;;Trainer##Leatherworking  Trainer Leatherworking 1 			  Skinning 1 			 Jalane
 * The order of multiple entries in a single note does not matter.
 * The entries do not need to be in the same category.


 * Advanced Usage
 * Position notes - The position coordinates are based on the defined extents of the map or block. By default they are linear 'percents' % with extents defined as an origin of 0,0 at the upper left corner, and 100,100 at the bottom right corner. See Template:/Extents about using other systems and extents.


 * Calling Map/Note outside Map - When using Map/Note outside of the Map template, Extents need to be defined first using the Map/Extents command, and then cleared when done. Normally Map would supply the default extents and clear them automatically. See the example above.

This template generates a Map "note" as an icon and tooltip on a map, using the user specified marker type, and allows the user to define the hover text and large map light-box legend notes.
 * For Admins and Maintainers

The marker type name passed to Note is filtered or translated here in the wiki code, into the final icon wiki file name used to display the icon. Wiki maintainers can add or change this templates code to add or change acceptable marker type names. This template allows all of the markers for the wiki over time to be managed in one common place.

For rendering a /Note outside of the Map and it's 'note' parameter, see advanced section above and see the example code in this template. For rendering just a simple image for regular wiki text/code using marker type names use the 'icon=1' option, or use the simplified convenience template Template:/Icon.

See Template:/Note/doc for any additional wiki specific information.