模块:Infobox mapframe/doc

这是Module:Infobox mapframe的文档页面

用法

该模块可自动生成适合信息框的mapframe,编者只需输入少量信息即可。

通用用法

只需使用模板{{Infobox mapframe}},按照其文档进行操作即可。该模块也可以导入到另一个Lua模块中。

信息框中的自动地图

示例编辑: Template:Infobox prisonTemplate:Infobox prison/doc

编辑信息框模板(或其沙盒)。

在信息框中添加类似以下示例的行。将数字(4,或9799)替换为适当的数字,具体数字取决于已有多少其他图像或data参数。

如果放在信息框顶部附近 如果放置在信息框底部或底部附近
| image4     = {{#invoke:Infobox mapframe|auto}}
| caption4   = {{#invoke:Infobox mapframe|autocaption}}
| header97   = {{#if:{{{mapframe|}}}|地图}}
| data98     = {{#invoke:Infobox mapframe|auto}}
| data99     = {{#invoke:Infobox mapframe|autocaption}}

如果模板中使用了{{#invoke:Check for unknown parameters}},请向其添加以下参数:

|mapframe|mapframe-area_km2|mapframe-area_mi2|mapframe-caption|mapframe-coord|mapframe-coordinates|mapframe-custom|mapframe-frame-coord|mapframe-frame-coordinates|mapframe-frame-height|mapframe-frame-width|mapframe-geomask|mapframe-geomask-fill|mapframe-geomask-fill-opacity|mapframe-geomask-stroke-color|mapframe-geomask-stroke-colour|mapframe-geomask-stroke-width|mapframe-height|mapframe-id|mapframe-length_km|mapframe-length_mi|mapframe-marker|mapframe-marker-color|mapframe-marker-colour|mapframe-point|mapframe-shape|mapframe-shape-fill|mapframe-shape-fill-opacity|mapframe-stroke-color|mapframe-stroke-colour|mapframe-stroke-width|mapframe-switcher|mapframe-width|mapframe-wikidata|mapframe-zoom

完成此操作后,模板即可使用上述参数。 这些参数也可以在前述#invoke调用中指定默认值,例如{{#invoke:Infobox mapframe|auto|mapframe-marker=library}}表示默认使用“library”图标,除非向模板传递不同的值。

  • 默认情况下地图是关闭的,这意味着除非在模板调用时出现|mapframe=yes,否则地图不会显示。要默认打开地图,可在上述#invoke调用中添加|onByDefault=yes——这意味着除非模板调用中包含|mapframe=no,否则将显示地图。onByDefault也可以设置为一个条件,例如:|onByDefault={{#if:{{pushpin_map|}}|no|yes}}
  • 更新模板文档中的参数说明。可以使用{{Infobox mapframe/doc/parameters}}。通过以|参数名=值的形式指定默认值(如果在#invoke调用中使用了默认值)。以下是默认输出:
延伸内容
  • 基本参数:
    • mapframe — 指定yesno以显示或隐藏地图,覆盖默认值。默认:no
    • mapframe-caption — 地图说明。默认: 空白(或如果设置了|mapframe-geomask=,则:“在<遮罩标签>的位置”)
    • mapframe-custom — 使用自定义地图代替自动地图框架。请使用{{maplink}}模板(或其他可生成地图框架的模板)或图像文件名称。如果使用,后续的mapframe参数将被忽略。默认:未指定
    • mapframe-ididqid — 要使用的维基数据项QID。默认:当前页面对应数据项
    • mapframe-coordinatesmapframe-coordcoordinatescoord — 指定的坐标,而不是维基数据上的坐标。使用{{Coord}}模板,例如:|coord={{Coord|12.34|N|56.78}}默认:来自维基数据的坐标
    • mapframe-wikidata — 当设置了|coord=时,设为yes以显示维基数据中的面/线特征(如果有)。默认: 未指定
  • 自定义显示哪些特征:
    • mapframe-point — 设为none时关闭点标记的显示。设为on时强制显示点标记。默认: 未指定
    • mapframe-line — 设为none时关闭线特征的显示。默认: 未指定
    • mapframe-shape — 设为none时关闭面特征的显示。设为inverse时使用反转形状(geomask)代替常规形状。默认: 未指定
    • mapframe-geomask — 用作遮罩的维基数据项(遮罩边界外的区域变暗)。可以是特定的维基数据项(QID),或数据项的属性(例如,P17表示国家 (P17)P131表示所在行政领土实体 (P131))。默认: 未指定
    • mapframe-switcher — 设置为autogeomaskszooms,以启用切换多个地图框架的功能(以Template:Switcher的风格)。默认: 未指定
      • auto — 以维基数据项的位置 (P276)所在行政领土实体 (P131)声称为遮罩进行切换,递归搜索。例如,数据项的城市、该城市的州以及该州的国家。
      • geomasks — 在mapframe-geomask参数中的维基数据项(QID)列表(以逗号分隔)指定的遮罩之间切换。
      • zooms — 在“zoomed in”/“zoomed midway”/“zoomed out”之间切换,其中“zoomed in”为默认缩放(最小值为3),“zoomed out”为1,而“zoomed midway”为平均值。
  • 其他可选参数:
    • mapframe-frame-widthmapframe-width — 框架宽度。默认:270
    • mapframe-frame-heightmapframe-height — 框架高度。默认:200
    • mapframe-shape-fill — 面特征的填充颜色。默认:#606060
    • mapframe-shape-fill-opacity — 面特征填充的不透明度,数值介于0和1之间。默认:0.5
    • mapframe-stroke-colormapframe-stroke-colour — 线特征、面特征轮廓的颜色。默认:#ff0000
    • mapframe-stroke-width — 线特征、面特征轮廓的粗细。默认:5
    • mapframe-marker — 用于坐标点标记的符号;具体选项参见mw:Help:Extension:Kartographer/Icons默认: 未指定(即blank)
      • 也可以设置为blank以覆盖默认标记符号。
    • mapframe-marker-colormapframe-marker-colour — 点标记的背景颜色。默认:#5E74F3
    • mapframe-geomask-stroke-colormapframe-geomask-stroke-colour — 遮罩轮廓的颜色。默认:#555555
    • mapframe-geomask-stroke-width — 遮罩轮廓的粗细。默认:2
    • mapframe-geomask-fill — 遮罩外部区域的填充颜色。默认:#606060
    • mapframe-geomask-fill-opacity — 遮罩外部区域填充的不透明度,数值介于0和1之间。默认:0.5
    • mapframe-zoom — 设置缩放级别,从“1”(全球地图)到 “18”(最大级别),用于无法根据对象长度或面积自动确定缩放级别的情况。默认:10
    • mapframe-length_kmmapframe-length_mimapframe-area_km2mapframe-area_mi2 — 通过输入对象的长度(以公里或英里为单位)或面积(以平方公里或平方英里为单位)来确定缩放级别。默认:未指定
    • mapframe-frame-coordinatesmapframe-frame-coord — 地图初始位置的备用坐标,使用使用{{coord}}模板。默认:衍生自项目坐标
  • 模板数据部分可插入下面的示例来更新:
延伸内容

无描述。

模板参数

参数描述类型状态
Show mapframe mapmapframe

Specify yes or no to show or hide the map, overriding the default

默认值
no
示例值
yes
字符串推荐
Mapframe captionmapframe-caption

Caption for the map. If mapframe-geomask is set, then the default is "Location in <<geomask's label>>"

字符串可选
Custom mapframemapframe-custom

Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, other mapframe parameters will be ignored.

模板可选
Mapframe Wikidata itemmapframe-id id qid

Id (Q-number) of Wikidata item to use.

默认值
(item for current page)
字符串可选
Mapframe coordinates mapframe-coordinates mapframe-coord coordinates coord

Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template.

默认值
(coordinates from Wikidata)
示例值
{{Coord|12.34|N|56.78|E}}
模板可选
Mapframe shapes from Wikidatamapframe-wikidata

et to yes to show shape/line features from the wikidata item, if any, when coordinates are specified by parameter

示例值
yes
字符串可选
Mapframe point featuremapframe-point

Override display of mapframe point feature. Turn off display of point feature by setting to "none". Force point marker to be displayed by setting to "on"

字符串可选
Mapframe shape featuremapframe-shape

Override display of mapframe shape feature. Turn off by setting to "none". Use an inverse shape (geomask) instead of a regular shape by setting to "inverse"

字符串可选
Mapframe widthmapframe-frame-width mapframe-width

Frame width in pixels

默认值
270
数字可选
Mapframe heightmapframe-frame-height mapframe-height

Frame height in pixels

默认值
200
数字可选
Mapframe shape fillmapframe-shape-fill

Color used to fill shape features

默认值
#606060
字符串可选
Mapframe shape fill opacitymapframe-shape-fill-opacity

Opacity level of shape fill, a number between 0 and 1

默认值
0.5
数字可选
Mapframe stroke colormapframe-stroke-color mapframe-stroke-colour

Color of line features, and outlines of shape features

默认值
#ff0000
字符串可选
Mapframe stroke widthmapframe-stroke-width

Width of line features, and outlines of shape features

默认值
5
数字可选
Mapframe markermapframe-marker

Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options

示例值
museum
字符串可选
Mapframe marker colormapframe-marker-color mapframe-marker-colour

Background color for the marker

默认值
#5E74F3
字符串可选
Mapframe geomaskmapframe-geomask

Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country, or P131 for located in the administrative territorial entity)

示例值
Q100
页面名称可选
Mapframe geomask stroke colormapframe-geomask-stroke-color mapframe-geomask-stroke-colour

Color of outline of geomask shape

默认值
#555555
字符串可选
Mapframe geomask stroke widthmapframe-geomask-stroke-width

Width of outline of geomask shape

默认值
2
数字可选
Mapframe geomask fillmapframe-geomask-fill

Color used to fill outside geomask features

默认值
#606060
字符串可选
Mapframe geomask fill opacitymapframe-geomask-fill-opacity

Opacity level of fill outside geomask features, a number between 0 and 1

默认值
0.5
数字可选
Mapframe zoommapframe-zoom

Set the zoom level, from "1" to "18", to used if the zoom level cannot be determined automatically from object length or area

默认值
10
示例值
12
数字可选
Mapframe length (km)mapframe-length_km

Object length in kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area

数字可选
Mapframe length (mi)mapframe-length_mi

Object length in miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area

数字可选
Mapframe area (km^2)mapframe-area_km2

Object arean square kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area

数字可选
Mapframe area (mi^2)mapframe-area_mi2

Object area in square miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area

数字可选
Mapframe frame coordinatesmapframe-frame-coordinates mapframe-frame-coord

Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}

示例值
{{Coord|12.35|N|56.71|E}}
模板可选
Mapframe switchermapframe-switcher

Set to "auto" or "geomasks" or "zooms" to enable Template:Switcher-style switching between multiple mapframes. IF SET TO auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country. IF SET TO geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter. IF SET TO zooms – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of 3), "zoomed out" is 1, and "zoomed midway" is the average.

字符串可选

参见