Template:Layer/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search

This template collects notes of a tile layer and slippy map together. The informations are displayed as an infobox. Data from this template are also extracted by:

To describe a more complex software you can use Template:Software.

Usage

Common template

{{Layer
|name               = <!-- Sample Layer -->
|author             = <!-- Author1;[[User:Author2|Author2]] -->
|screenshot         = <!-- NameToFile.ext -->
|screenshot_caption = <!-- City, Country -->
|slippy_web         = <!-- {{URL|https://example.com/linkToSlippyMap}} -->
}}

Slippy map only template

{{Layer
|name               = <!-- Sample Layer -->
|author             = <!-- Author1;[[User:Author2|Author2]] -->
|screenshot         = <!-- NameToFile.ext -->
|screenshot_caption = <!-- City, Country -->
|slippy_web         = <!-- {{URL|https://example.com/linkToSlippyMap}} -->
|notlayer           = yes
}}

Complete template

{{Layer
|lang                =
|name                =
|alt_name            =
|logo                =
|discontinued        =
|author              =
|screenshot          =
|screenshot_caption  =
|based_on            =
|slippy_web          =
|usage_policy        =
|tiles_languages     =
|tiles_languagesurl  =
|tiles_license       =
|style_web           =
|style_license       =
|version             =
|date                =
|description         =
|repo                =
|bugtracker_web      =
|taginfo_projectname =
|notlayer            =
}}

Parameters

No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Template languagelang

no description

Example
en
Stringoptional
Namename

Official name of the layer, otherwise most common one

Stringrequired
Alternative namesalt_name

Other names under which this layer is known. Multiple values shall be seperated by semicolons (;)

Example
Name 1;Name 2;Name 3
Stringoptional
Logologo

no description

Unknownoptional
Layer discontinued?discontinued

no description

Suggested values
yes no
Stringoptional
Authorauthor

Name of the author or a link to their OSM-wiki user page

Stringsuggested
Screenshotscreenshot

no description

Filesuggested
Screenshot captionscreenshot_caption

Text displayed below the screenshot. Normally location of screenshot

Example
Paris, France
Stringsuggested
Based onbased_on

Template on which this layer is based on. Multiple values shall be seperated by semicolons (;)

Example
[[Layer 1]];[[Layer 2]];Layer 3
Stringoptional
slippy_webslippy_web

no description

Stringoptional
Usage policyusage_policy

Usage policy of slippy map, tile or style

Example
[https://operations.osmfoundation.org/policies/tiles/ operations.osmfoundation.org/policies/tiles/]
Stringoptional
tiles_languagestiles_languages

no description

Stringoptional
tiles_languagesurltiles_languagesurl

no description

Stringoptional
tiles_licensetiles_license

no description

Stringoptional
style_webstyle_web

no description

Stringoptional
style_licensestyle_license

no description

Stringoptional
Versionversion

no description

Stringoptional
Datedate

no description

Dateoptional
Source coderepo

Link to source code of the layer. If applicable style_web shall be preferred

Stringoptional
Descriptiondescription

Description of the layer. For example purpose or highlighted elements

Stringsuggested
URL of bug trackerbugtracker_web

no description

URLoptional
Associated project name on TagInfotaginfo_projectname

no description

Stringoptional
Not layer?notlayer

If the article doesn't describe a layer and shouldn't be tagged as such.

Suggested values
yes no
Stringoptional

Categories

Category:Discontinued slippy map
Added, if slippy_web and discontinued are set. Can be disabled by setting notlayer = yes
Category:Discontinued tiles layer
Added, if discontinued is set. Can be disabled by setting notlayer = yes
Category:Project on TagInfo
Added, if taginfo_projectname is set
Category:Slippy map
Added, if slippy_web is set
Category:Tiles layer
Added to every article which includes this template. Can be disabled by setting notlayer = yes