模組: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)