Module:Football map

Module documentation[view] [edit] [history] [purge]

Overview

This module is used with the template {{football map}} to simplify creation of maps with the <mapframe> tag provided by the Kartographer extension.

The template takes the same parameters as <mapframe> and adds a number of markers using a series of |stadiumN parameters that are used to general the JSON data for the markers. The stadium data is either taken from an internal list or using Wikidata for the coordinates.

Examples:

• Template:Football map/demo — stadia of London football clubs (using data from module list)
• Template:Football map/demo2— stadia for the Russia World Cup in 2018 (using data supplied in template)
• Template:Football map/demo3 — a selection of English stadia (using a mixture of all three data sources)
• Template:Football map/demo4 — a map of the stadia in List of football stadiums in England (using Wikidata for data parameters)
• Template:Football map/demo5 — a list of clubs and their stadium for the 2018-19 Premier League season (using Wikidata for data parameters)
• User:Jts1882/maps/stadiums — a user test page with some mapframe related information and some more examples

Usage

{{#invoke:Football map|function_name}}

Template documentation

This template uses <mapframe>...</mapframe> to display interactive maps of football stadia, using data supplied from the template, from Wikidata, and/or from lists defined in module subpages. The markers for each stadium have a popup window with information on the stadium (e.g. image, description, capacity, etc.).

Usage

The simplest use of the template requires the basic mapframe parameters and a list of football stadiums or football clubs.

Parameters

Mapframe parameters

• |width= and |height= — set the dimensions of the map on the page
• |align= — sets the position on the page (left, right, center)
• |latitude= and |longitude= — the coordinates of the map centre
• |zoom= — a zoom factor with a value between 0 (whole world) to 19 (very local). See examples for typical values
• |text= — a description of the map displayed as a footer.
• |frameless= — to produce a frameless map (e.g. for an infobox).

For more further information see Kartographer extension.

Stadium and club lists

A Mapframes map can display markers for a number of geographical features, or a football stadia for this template. It takes the data in JSON format, but this template creates the JSON data from the parameters in the template. At its simplest, it needs a list of stadia or clubs set with the following parameters.

• |stadiumN= — a list of stadia with index N. The name must point to a valid Wikipedia page title.
• |clubN= — a list of football clubs with index N. Wikidata is used to get the name of the home stadium.

Stadia and clubs can be mixed, but each index can only be used once. The maximum index is currently 200.

See below for more on customising the markers.

Sources of data

Each marker needs the coordinates for its location. These can be provided in the template or got automatically from a list maintained in the module or from Wikidata. Parameters provided by the template have priority, followed those in the module lists and Wikidata.

• |wikidata= — makes Wikidata the first choice for data source. Values can be overridden by those set in the template parameters.
• |moduledata= — makes the lists of data in the module the first choice for data source. Values can be overridden by those set in the template parameters.
• |templatedata= — only uses data provided by the template.
• |latitudeN= and |longitudeN= — the coordinates of each stadium with the index specified
• |imageN= — an image to display in the popup, entered in the form File:The Hive Stadium 3.jpg
• |descriptionN= a description to display in the popup. This can contain any wiki markup, within reason.

Markers

The default markers:

• |size= — the size of the marker (small, medium, large )
• |color= — the color of the marker (red, green, #0050d0, etc.)
• |symbol= — the marker can take numbers, letters or custom symbols
  • use -number to number the markers (default)
  • use -letter to use a sequence of letters in the markers
  • use soccer, museum, etc. to use a custom symbol (see mw:Help:Extension:Kartographer/IconsList of icons for more)

The markers for any feature can be customised using a parameter with the index matching the feature name:

• |sizeN= — the size of the marker (small, medium, large). This is particularly useful for showing two stadia very close together (e.g. Goodison and Anfield), when making the one behind larger and/or on in front small makes them both easier to resolve. There is no control over the relative positions, which are set by <mapframe>...</mapframe> (more northerly ones first)
• |colorN= — the color of the marker (red, green, #0050d0, etc.)
• |symbolN= — the marker can take numbers, letters or custom symbols.

Examples

Using data from module list

Using data supplied in template

Using Wikidata for data parameters

Using Wikidata for data parameters

Using a mixture of all three data sources

Using Wikidata for data parameters

The above documentation is transcluded from Module:Football map/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

-- All Lua modules on Wikipedia must begin by defining a variable that will hold their
-- externally accessible functions. They can have any name and may also hold data.
p = {}

-- Add a function to the variable. These are callable in Wikipedia via the #invoke command.
-- "frame" will contain the data that Wikipedia sends this function when it is called. 
p.hello = function(frame) 

    -- Declare a local variable and assign data to it.
    local str = "Hello World!"  

    -- Quit this function and send the information in "str" back to Wikipedia.
    -- The "print" function is not allowed, so all output is accomplished via 
    -- returning strings in this fashion.
    return str    

-- End the function.
end

-- All modules end by returning the variable containing its functions to Wikipedia.
return p

-- We can now use this module by calling {{#invoke: HelloWorld | hello }}.
-- The #invoke command begins with the module's name, in this case "HelloWorld",
-- then takes the name of one of its functions as an argument, in this case "hello".