Модуль:Infobox mapframe/doc
Это страница документации Модуль:Infobox mapframe.
Этот модуль оценён как бета-версия. Он готов для широкого применения, но должен применяться с осторожностью. |
Применение
[править код]Модуль, который автоматически создаёт прямоугольник с географической картой (mapframe), подходящей для размещения в шаблоны-карточки статей, с минимальными усилиями со стороны редактирующего участника.
Общие положения о применении
[править код]Просто используйте шаблон {{Infobox mapframe}} в соответствии с его документацией на его странице. Этот модуль также можно импортировать в другой модуль Lua.
Автоматически создаваемые географические карты в шаблонах карточках
[править код]Отредактируйте шаблон карточки (или его песочницу). Добавьте в шаблон карточки стро́ки подобно приведённым в примерах. Замените числа (4 или с 97 по 99) подходящим числом в зависимости от того, сколько других параметров с изображением или данными уже присутствуют.
При размещении в верхней части карточки | При размещении в нижней части карточки |
---|---|
| image4 = {{#invoke:Infobox mapframe|auto}} | caption4 = {{#invoke:Infobox mapframe|autocaption}} |
| header97 = {{#if:{{{mapframe|}}}|Location}} | 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
с утвердительным значениемyes
. Чтобы карты по умолчанию отображались, в процедуру вызова #invoke, приведённую выше, добавьте парамщ|onByDefault = yes
с утвердительным значениемyes
– в таком случае карты отображаться будут, если только в процедуре вызова шаблона не будет присутствовать параметр|mapframe = no
с отрицательным значениемno
. Отображение по умолчанию с помощью onByDefault можно также сделать условным, скажем, в случае присутствия других параметров, например|onByDefault = {{#if:{{{pushpin_map|}}}|no|yes}}
- Добавьте эти новые параметры к документу. Можно использовать
{{Infobox mapframe/doc/Параметры}}
. Укажите значение по умолчанию (если при вызове #invoke используются хоть какие-нибудь), добавляю параметры следующим образом:parameter-name=value
, гдеparameter-name
это название параметра, аvalue
- его значение. Вот в свернутом виде показан результат по умолчанию:
<!-- Infobox mapframe: all parameters, no aliases (29) --> <!-- Basic parameters: --> | mapframe = | mapframe-caption = | mapframe-custom = | qid = | mapframe-coordinates = | mapframe-wikidata = <!-- Customise features displayed: --> | mapframe-shape = | mapframe-point = | mapframe-line = | mapframe-geomask = | mapframe-switcher = <!-- Other optional parameters: --> | mapframe-frame-width = | mapframe-frame-height = | mapframe-shape-fill = | mapframe-shape-fill-opacity = | mapframe-stroke-color = | mapframe-stroke-width = | mapframe-marker = | mapframe-marker-color = | mapframe-geomask-stroke-color = | mapframe-geomask-stroke-width = | mapframe-geomask-fill = | mapframe-geomask-fill-opacity = | mapframe-zoom = | mapframe-length_km = | mapframe-length_mi = | mapframe-area_km2 = | mapframe-area_mi2 = | mapframe-frame-coordinates =
- Параметры также можно добавить в данные шаблоны (TemplateData) путём копирования из
См. также
[править код]