模组:Mapframe/doc

这是Module:Mapframe的文档页面

此页面是Module:Mapframe的模块文档。
此页面可能包含了模板的使用说明、分类和其他内容。

此模块文档被引用于约205,000个页面。
为了避免造成大规模的影响，所有对此模块文档的编辑应先于沙盒或测试样例上测试。
测试后无误的版本可以一次性地加入此模块文档中，但是修改前请务必于讨论页发起讨论。

模板引用数量会自动更新。

此模块使用Lua语言：

Module:Transcluder

本模块使用以下模板样式：

Template:Maplink/styles-multi.css

本模块用于 {{Maplink}}

用法

标准用法

只需使用 {{Maplink}}，它默认会将参数传递给此模块的主函数（main）。

如果使用 {{Maplink}} 渲染页面时，Lua 的渲染时间在 5 秒到 10 秒之间，那么使用类似

{{#tag:mapframe|[raw GeoJSON]|frameless=[1 for frame]|align=[left/right/center]|text=[caption]|width=[in px]|height=[in px]|latitude=[decimal degrees]|longitude=[decimal degrees]|zoom=[zoom factor]}}

的语法直接调用模块可以节省 Lua 的开销。这种替换的示例见 https://en.wikipedia.org/w/index.php?diff=970846012 。这样的代码可以最大限度地降低后端服务器繁忙时触发 10 秒 Lua 超时的概率。

通过另一个模块使用

导入此模块，例如 local mf = require('Module:Mapframe')
将参数名称和值的表传递给 _main 函数。有关参数名称和说明，请参阅 {{Maplink}} 文档。例如 local mapframe = mf._main(parameters)
在返回 _main 的输出之前对其进行预处理，例如 return frame:preprocess(mapframe)