Module:US elections imagemap/doc

This is a documentation subpage for Module:US elections imagemap.
It may contain usage information, categories and other content that is not part of the original module page.

Usage

For general usage, use the wrapped template at {{US elections imagemap}}. This page is mainly documentation for Module maintainers.

Functions

`makeMap`

Generates the inner part of an imagemap. Needs to be wrapped with imagemap tags to work, this only generates state shapes and links. This is due to a limitation in Lua modules.

Parameters
Parameter	Usage	Example
link_template	Template for links	2018 STATE gubernatorial election
cycle	Election cycle	Gov2^[a]
extra_states	Extra states to include^[b]	OR;WV^[a]
extra_lines	Extra raw lines to include^[b]	`rect 702 391 725 423 [[2020–21 United States Senate special election in Georgia]]`
state_overrides	Set a custom link for the state, instead of following the template^[b]	AZ=2020 United States Senate special election in Arizona
excluded_states	States to exclude. Overridden by `extra_states`^[b]	AK;HI

^ ^1.0 ^1.1 For valid values of |cycle= and |extra_states=, see Module:US elections imagemap/data.
^ ^2.0 ^2.1 ^2.2 ^2.3 (; delimited)

Submodules

Module:US elections imagemap/utils — string utilities
Module:US elections imagemap/data — shapes and cycle data

[datapage-1] 1.0 ^1.1 For valid values of |cycle= and |extra_states=, see Module:US elections imagemap/data.

[semicolon-2] 2.0 ^2.1 ^2.2 ^2.3 (; delimited)

[a]

[b]