Template:Worldmap poe1/doc

This template is a fancy themed frame, intended to hold either a world map or area map.

Still very much a work in progress. The CSS used to style this frame is in MediaWiki:Hydradark.css, while the JavaScript is in MediaWiki:WorldmapPoe1.js.

Todo:
 * Enable/disable sidebar depending on size of content.
 * Implement different modes (responsive and panzoom).
 * Convert background-images to CSS sprite atlases to reduce HTTP requests.

Example
See Pillars of Eternity world map/dynamic

Parameters

 * content (required)
 * The contents of the frame.


 * title
 * The title shown in the name bar. Can be linked with square brackets if required.


 * sidebar
 * The visibility state of the sidebar. Values are show, hide or auto (default). If auto, the sidebar is shown or hidden depending on the size of the contents and the area available.


 * namebar
 * The visibility state of the namebar. Values are show (default) or hide.


 * framemode
 * Three different "frame" modes are provided and can be changed with the "X" button in the top right
 * full - The full decorative frame. Namebar, sidebar, frame, and background are shown.
 * partial - Partial decorative frame. Namebar and sidebar is hidden.
 * minimal - Minimal decorative frame. Namebar, sidebar, frame, and background are all hidden.
 * auto - (Default) Defaults to LocalStorage setting, which may cause flicker as it's loaded in after the map is fully loaded, or "full" if no setting is set.


 * scalingmode
 * How the frame scales. Values are fixed and dynamic (default).
 * fixed - Keeps the container at a fixed height. The container width will be fit into the full width of the page, and the content will be enveloped to fit inside it. In this mode, the container size will almost always be at a different aspect ratio to the content.
 * dynamic - Keep the frame at a height that matches the aspect ratio of the content within the container. In this mode, the container size will always match the aspect ratio of the content, and the sidebar will be smartly shown and hidden to maximise use of the space. This may not work for all types of content.


 * sidebaricon
 * Which icon to show in the sidebar. Valid values are worldmap and areamap (default).


 * sidebarbutton
 * Page to go to when the sidebar button is clicked


 * closebutton
 * Page to go to when the close button is clicked