Module:US elections imagemap/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 19:23, 19 January 2021

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

^ ^a ^b For valid values of |cycle= and |extra_states=, see Module:US elections imagemap/data.
^ ^a ^b ^c ^d (; delimited)

Subpages

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

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

[semicolon-2] (; delimited)

[a]

[b]

@@ Line 22: / Line 22: @@
 |-
 | state_overrides || Set a custom link for the state, instead of following the template{{efn|name=semicolon}} || AZ=2020 United States Senate special election in Arizona
+|-
+| excluded_states || States to exclude. Overridden by <code>extra_states</code>{{efn|name=semicolon}} || AK;HI
 |}
 {{notelist}}