Extension:ImageMap

ImageMap is an extension which allows clickable image maps. An image map is a list of coordinates in a specific image, which hyperlinks areas of the image to multiple destinations (in contrast to a normal image link, in which the entire area of the image links to a single destination). For example, a map of the world may have each country hyperlinked to further information about that country. The intention of an image map is to provide an easy way of linking various parts of an image without dividing the image into separate image files.

Syntax example

<imagemap>
Image:JoshuaReynoldsParty.jpg|center|Image map example. Clicking on a person in the picture causes the browser to load the appropriate article.|350px|thumb
poly 133 343 124 287 159 224 189 228 195 291 222 311 209 343 209 354 243 362 292 466 250 463 [[w:Samuel Johnson|Dr Johnson - Dictionary writer]]
poly 76 224 84 255 43 302 62 400 123 423 121 361 137 344 122 290 111 234 96 225 [[w:James Boswell|Boswell - Biographer]]
poly 190 276 208 240 229 228 247 238 250 258 286 319 282 323 223 323 220 301 200 295 [[w:Joshua Reynolds|Sir Joshua Reynolds - Host]]
poly 308 317 311 270 328 261 316 246 320 228 343 227 357 240 377 274 366 284 352 311 319 324 [[w:David Garrick|David Garrick - actor]]
poly 252 406 313 343 341 343 366 280 383 273 372 251 378 222 409 228 414 280 420 292 390 300 374 360 359 437 306 418 313 391 272 415 [[w:Edmund Burke|Edmund Burke - statesman]]
rect 418 220 452 287 [[w:Pasquale Paoli|Pasqual Paoli - Corsican patriot]]
poly 455 238 484 253 505 303 495 363 501 377 491 443 429 439 423 375 466 352 [[w:Charles Burney|Charles Burney - music historian]]
poly 501 279 546 237 567 239 572 308 560 326 537 316 530 300 502 289 [[w:Thomas Warton|Thomas Warton - poet laureate]]
poly 572 453 591 446 572 373 603 351 562 325 592 288 573 260 573 248 591 243 615 254 637 280 655 334 705 396 656 419 625 382 609 391 613 453 [[w:Oliver Goldsmith|Oliver Goldsmith - writer]]
rect 450 86 584 188 [[w:Joshua Reynolds|prob.The Infant Academy 1782]]
rect 286 87 376 191 [[w:Joshua Reynolds|unknown painting]]
circle 100 141 20 [[w:Joshua Reynolds|An unknown portrait]]
poly 503 192 511 176 532 176 534 200 553 219 554 234 541 236 525 261 506 261 511 220 515 215 [[w:Francis Barber|servant - poss. Francis Barber]]
rect 12 10 702 500 [[w:The Club (Literary Club)|Use button to enlarge or use hyperlinks]]
desc bottom-left
</imagemap>

Outputs this:

Syntax description

The contents of an <imagemap> tag consists of blank lines, comments (starting with #) and logical lines. The first logical line specifies the image to be displayed. This must be in the same format as an ordinary MediaWiki image link, except without the enclosing [[ and ]].

Further lines are split into tokens, separated by whitespace. The function of each line is determined by the first token in the line. All coordinates are according to the full-size image, not the visible image. They should be specified as (distance from left edge, distance from top).

desc

Specifies the location of the image description link. May be either top-right, bottom-right, bottom-left, top-left or none. This puts a blue "i" icon in the specified corner, linking to the image description page. The default is bottom-right. To hide the description link, set it to none. Possible values: top-right, bottom-right, bottom-left, top-left, none

poly

A polygon. The coordinates of the vertices are given, followed by a link in square brackets.
Polygons must be defined before any other form!

rect

A rectangle. The parameters are the coordinates of the top-left and bottom-right corners, followed by a title to link to in square brackets.

circle

A circle. The first two parameters are the coordinates of the center, the third is the radius. The coordinates are followed by a link in square brackets.

default

This gives the default link, where no other regions are specified.

All coordinates are specified relative to the source image. The image can be scaled using thumbnail syntax, in which case the image map coordinates will be automatically scaled as well.

All links are given in either the form [[Page title]] or [[Page title|description]]. In the latter case, the part after the pipe "|" becomes the title attribute of the link -- in most browsers, it will pop up as a tooltip when the user hovers over it. If no explicit link description is given, the page title will be used.

Areas which overlap give precedence to the first link listed.

Installation Guide

1. Make a directory in extensions: ImageMap
2. Download the files to ImageMap
3. Register the extension in LocalSettings.php by adding the following line:

require_once("$IP/extensions/ImageMap/ImageMap.php");

Test installation:

1. Download Image:Foo.jpg and upload it to your wiki.
2. Make a new Article ImageMap and copy & paste the text of this article (at least section "syntax example") to your article

Troubleshooting:

1. Check to see if your php DOM is turned on. You may need to install it if it is not.
2. Check whether ImageMagick is installed, since this extension relies on /usr/bin/convert for the resizing. If it is not present, you could get a page with only XML errors (tip: use the back-button in the browser, because you can still edit the page).

Parameters

NOTE: This parameter has been removed in the latest version (Revision 23292). It now always permits external links. For older releases:

Note: Extension parameters must be below the extension's require_once()

• $wgImageMapAllowExternalLinks = false

  Set this to true to enable external links (http://www.example.com) as link destination

Known Bugs

Search Imagemap bugs: open / all

• Bugzilla:8600 Transclusion of variables like Extension:ImageMap fails in imagemap, dup of Bugzilla:2257 --D0li0 21:53, 15 May 2007 (UTC)
• Bugzilla:8640 ImageMap extension icon assumes a standard location make a symbol link to the directory. --Raymond 08:16, 10 May 2007 (UTC)
• Bugzilla:8718 Information icon on imagemap is wrong placed when image is centered. rev:41725
• Bugzilla:8788 ImageMap makes accompanying links unclickable rev:41720/rev:41725
• Bugzilla:8835 ImageMap does not accept links in the image caption (neither does it accept parameters when embedded within a Template) rev:40684/rev:40685
• Bugzilla:9126 Image maps fail to scroll in IE7 rev:41720
• Bugzilla:9295 ImageMap extension produces PHP fatal error when given invalid link title Fixed with rev:21993. --Raymond 08:16, 10 May 2007 (UTC)
• Bugzilla:11504 External links containing '&' are not linked properly. resolved?

Known feature requests

• Bugzilla:8657 Superimpose another image as click destination

Usage with templates

If you want this extension (as with most tag extensions) to parse template parameters, magic words, or parser functions, you will need to use #tag syntax, such as w:Template:Click did.

Image map editor

• A graphical tool to determine the coordinates. Author: meta:User:Dapete
• A simple guide on how to use the Image Map editor with the ImageMap extension can be found on wikiHow.
• Online image map editor, supports all shapes, Extension:ImageMap compatible: [1].
• Basic on-line image mapper. Author: meta:User:mgwalk

In addition, the Image Map Conversion special page can be used to convert HTML format image map information into the format for this extension. It can be used to convert the output from the utilities for file-based image maps as listed at Extension:ImageMap (Alternate)#Utilities and links.

See also

• McNaught imagemap extension. Consider choosing an ImageMap extension before deciding on which ImageMap extension to use.