10,082
edits
Changes
Module:US elections imagemap/doc (view source)
Revision as of 07:44, 16 July 2021
, 07:44, 16 July 2021Pywikibot 6.4.0
{{lua sidebar}}
{{Module rating |beta}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
'''For general usage, use the wrapped template at {{t|US elections imagemap}}. This page is mainly documentation for Module maintainers.'''
== Functions ==
=== <code>makeMap</code> ===
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.
{| class="wikitable"
|+ Parameters
|-
! Parameter !! Usage !! Example
|-
| '''link_template''' || Template for links || 2018 STATE gubernatorial election
|-
| '''cycle''' || Election cycle || Gov2{{efn|name=datapage|For valid values of {{para|cycle}} and {{para|extra_states}}, see [[Module:US elections imagemap/data]].}}
|-
| extra_states || Extra states to include{{efn|name=semicolon|(<code>;</code> delimited)}} || OR;WV{{efn|name=datapage}}
|-
| extra_lines || Extra raw lines to include{{efn|name=semicolon}} || <code><nowiki>rect 702 391 725 423 [[2020–21 United States Senate special election in Georgia]]</nowiki></code>
|-
| 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}}
== Submodules ==
* [[Module:US elections imagemap/utils]] — string utilities
* [[Module:US elections imagemap/data]] — shapes and cycle data
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>
{{Module rating |beta}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
'''For general usage, use the wrapped template at {{t|US elections imagemap}}. This page is mainly documentation for Module maintainers.'''
== Functions ==
=== <code>makeMap</code> ===
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.
{| class="wikitable"
|+ Parameters
|-
! Parameter !! Usage !! Example
|-
| '''link_template''' || Template for links || 2018 STATE gubernatorial election
|-
| '''cycle''' || Election cycle || Gov2{{efn|name=datapage|For valid values of {{para|cycle}} and {{para|extra_states}}, see [[Module:US elections imagemap/data]].}}
|-
| extra_states || Extra states to include{{efn|name=semicolon|(<code>;</code> delimited)}} || OR;WV{{efn|name=datapage}}
|-
| extra_lines || Extra raw lines to include{{efn|name=semicolon}} || <code><nowiki>rect 702 391 725 423 [[2020–21 United States Senate special election in Georgia]]</nowiki></code>
|-
| 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}}
== Submodules ==
* [[Module:US elections imagemap/utils]] — string utilities
* [[Module:US elections imagemap/data]] — shapes and cycle data
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>