Шаблон:Маршрутная карта

Документация

[просмотр | править | история | обновить]

Этот шаблон реализован на основе Lua с использованием функции route() из модуля Routemap.

Прежде чем вносить какие-либо изменения в данный шаблон, просьба оттестировать их в /песочница и проверить результат на странице с /контрольными примерами. Изменения могут быть внесены после этого в данный шаблон всего одной правкой.

Другое название этого шаблона — {{Routemap}}.

Использование

Шаблон предназначен для отображения транспортных систем в виде диаграммы: железнодорожных линий, водных путей, автодорог и др.

[Править данные шаблона]
Параметры шаблона
Параметр	Описание	Тип	Статус
Заголовок таблицы	`заголовок` `title`	Заголовок таблицы. Значения «нет», «no» или «0» скроют шапку таблицы (при этом теряется возможность сворачивания) По умолчанию	Строковый (без форматирования)	необязательный
Цвет заголовка	`цвет заголовка` `title color`	Цвет заголовка таблицы По умолчанию #FFFFFF	Строковый (без форматирования)	необязательный
Цвет фона заголовка	`цвет фона заголовка` `title bg color`	Цвет фона заголовка По умолчанию #27404E	Строковый (без форматирования)	необязательный
Возможность свернуть таблицу	`сворачиваемый` `collapsible`	По умолчанию таблица сворачиваема, значения «no» или «0» уберут такую возможность	Строковый (без форматирования)	необязательный
Состояние свёрнутости таблицы	`collapse`	Допустимые значения: «collapsed», «autocollapse» и «[пусто]» (= «expanded»)	Строковый (без форматирования)	необязательный
Ссылки на шаблон	`navbar` `tnavbar`	Непустое значение параметра поместит ссылки на шаблон в левом верхнем углу; используйте {{subst:PAGENAME}} По умолчанию	Строковый (без форматирования)	необязательный
Расположение ссылок на шаблон	`navbar pos`	Значение «1» переместит ссылки под шапку таблицы, «2» — в низ таблицы По умолчанию	Строковый (без форматирования)	необязательный
Ссылка на легенду	`легенда` `legend`	Имя страницы, содержащей легенду маршрута. Значения «нет», «no» или «0» скроют ссылку на легенду По умолчанию Шаблон:Маршрутная карта/Условные обозначения	Имя страницы	необязательный
Обтекание таблицы	`обтекание` `float`	Положение и обтекание внешней таблицы: «left», «right» или «none» По умолчанию right	Строковый (без форматирования)	необязательный
Цвет фона	`цвет фона` `bg`	Цвет фона всей таблицы По умолчанию #F9F9F9	Строковый (без форматирования)	необязательный
CSS-стиль таблицы	`стиль` `style`	Дополнения к CSS-стилю внешней таблицы	Строковый (без форматирования)	необязательный
Подзаголовок или пояснение	`вверху` `on top`	Пояснение вверху таблицы	Строковый (без форматирования)	необязательный
Пояснение, примечание	`внизу` `footnote`	Пояснение внизу таблицы	Строковый (без форматирования)	необязательный
Ширина колонок с текстом	`ширина текста` `text-width`	Ширина колонок с текстом через запятую (рекомендовано при использовании сворачиваемых блоков) По умолчанию	Строковый (без форматирования)	необязательный
Карта маршрута	`1` `map`	Карта маршрута в определённом ниже формате	Строковый (без форматирования)	обязательный

Замена множеству маршрутных шаблонов в виде единственного шаблона, поддерживает все их функции. Имеет всего один обязательный параметр — собственно карту пути.

Для копирования:

{{Маршрутная карта|заголовок= |цвет заголовка= |цвет фона заголовка= |collapse= |tnavbar={{subst:PAGENAME}}|ширина текста=,,|1=
<!-- набросайте на этом месте вашу карту -->
|внизу=
}}

Формат описания диаграммы

{{Маршрутная карта|заголовок=Маршруты Eurostar|ширина текста=25,110,90|1=
KBHFa~~0:00~~'''[[Лондон]] ([[Сент-Панкрас (вокзал)|Сент-Панкрас]])'''~~(c 2007 г.)
exKBHFa\STR\~~ ~~ ~~Лондон ([[Ватерлоо (вокзал)|Ватерлоо]]) (до 2007 г.)
exSTR\HST\~~0:14~~Эббсфлит
exKRWl\eKRWg+r\
HST~~0:29~~Эшфорд
tSTRa~~''0:31''~~
tSTR!~lZOLL~~ ~~[[Евротоннель]]~~ ~~{{BSsplit{{!}}Великобритания|Франция|line=yes}}~~bg=#558cd3
tSTRe~~''0:51''~~
HST~~0:55~~[[Кале]] (Кале-Фретен)
BHF~~1:22~~[[Лилль]] ([[Лилль-Европа]])
\KRWgl\KRW+r
\STR\STR!~lZOLL~~ ~~ ~~ ~~{{BSsplit{{!}}Франция|Бельгия|line=yes}}
KRW+l\KRWgr\KBHFe~~2:01~~'''[[Брюссель]] (Южный вокзал)'''
KBHFe\KRWgl\KRW+r~~2:16~~'''[[Париж]] ([[Северный вокзал (Париж)|Северный вокзал]])'''
\STR\KBHFe~~2:40~~[[Диснейленд (Париж)|Диснейленд]] (Марн-ла-Вале — Шесси)
-startCollapsible--replace
\CONTf\~~ ~~ ~~''сезонные маршруты''
KRW+l\KRWgr\
HST\KRWgl\KRW+r~~4:34~~[[Лион]] (Пар-Дьё)
STR\STR\KHSTe~~5:36~~ [[Авиньон]] (Центральный вокзал)
HST\STR\~~5:52~~Авиньон — [[TGV]]
KHSTe\STR\~~6:17~~[[Экс-ан-Прованс]] — TGV
HST~~7:12~~Мутье — Сален — Брид-ле-Бен
HST(R)~~7:30~~Эме — Ла Плань
KHSTe~~7:51~~[[Бур-Сен-Морис]]
-endCollapsible-
|внизу=Приведённые интервалы — кратчайшее время<br>движения по расписанию от Сент-Панкрас.
}}

Формат строк

Параметр 1 определяет вывод строк карты маршрута. Каждая строка в самом простом формате выглядит следующим образом:

первая иконка\вторая иконка\третья иконка и т. д.~~название станции

Полный формат при задании текста только справа иконок может быть таким:

иконка1\иконка2 и т. д.~~километраж или время~~основная информация~~пояснение мелким шрифтом~~пояснение по правому краю~~свойства строки

Основная информация выводится обычным шрифтом с выравниванием по левому краю, пояснения и километраж — уменьшенным шрифтом. Первое пояснение выводится следом за основной информацией, второе пояснение — в том же поле, но с выравниванием по правому краю. Километраж (или время) отображается отдельной колонкой между иконками и основным текстом. Для изменения форматирования текста в каком-либо поле рекомендуется использовать вспомогательные шаблоны, {{align}}, блоки <img> и др. О задании свойств см. ниже.

Километраж, информация, пояснения и свойста не обязательны: после иконок можно вообще ничего не указывать, либо же оборвать задание строки после нужного количества текстовых полей. Для пропуска ненужных параметров можно заменить их пробелом, к примеру код WBRÜCKE~~34,7~~ ~~мост выведет инонку, километраж и уменьшенный текст «мост». Если в строке после иконок только одна пара тильд, то считается, что указана основная информация о пункте (а не километраж); для указания только километража (времени) используйте иконки~~''км''~~.

Шаблону в качестве параметра 1 можно передать сколько угодно строк (разделённых как обычный викитекст). Пустые строки «проглатываются» и не влияют на итоговую таблицу, в том числе в начале и в конце, а также в блоке colimg. Для разбиения текстовых полей на строки используйте <br> или {{BSsplit}} (параметры которого, возможно, придётся разделять не |, a {{!}}).

Задание иконок

Список кодов иконок приведён в каталоге пиктограмм. Более полная версия есть в каталоге на Викискладе.

Коды иконок отделяются друг от друга обратной косой чертой (\), их количество в строке не ограничено. При отсутствии кода между двумя чертами (\\) вместо иконки отображается пустое пространство, равное по ширине стандартной иконке (по умолчанию 20px). Для отображения пустой иконки () используйте код leer; доступны пустые иконки четвертной ширины: (c), половинной: (d), трёхчетвертной: (cd) и двойной: (b).

Блок с иконками выравнивается по центру соответствующей области для каждой строки по отдельности. Таким образом, если в одной строке указаны три иконки, а в следующей одна, то она будет расположена ровно под центральной из трёх сверху. Иконки, в коде которых присутствует префикс d, — половинной ширины: две такие иконки, идущие подряд, прижимаются друг к другу и занимают столько же места, как и одна обычная. Иконки, представляющие пару параллельных путей, напр. (vSTR), соответствуют двум иконкам половинной ширины с одним путём в каждой. (В некоторых браузерах при использовании функции увеличения выравнивание иконок может сбиваться на несколько пикселей, в особенности половинных и т. п.)

В одну «ячейку» можно поместить несколько иконок, наложенных поверх друг друга. Код накладываемой сверху иконки указывается после кода нижней через символы !~; таким же образом можно добавить ещё одну и т. д. Поддерживается неограниченное количество наложений. При наложении половинной иконки поверх обычной верхняя выравнивается по левому краю нижней; если обычную наложить поверх половинной, то с другими иконками они будут выравниваться, как половинная, но верхняя будет также перекрывать часть иконки, следующей за ними справа.

Переход на страницу файла с иконкой при нажатии на иконку отключён. Ссылку, по которой должна вести самая верхняя иконка в ячейке, можно добавить, приписав !@имя страницы после кодов всех иконок в ячейке, например, uSTRq!~BHF!@Тестовская (переход на статью о платформе Тестовская).

Текст слева и справа от иконок

{{Маршрутная карта|заголовок=Казанское направление|1=
vCONTg~~ ~~ ~~на Москву
~~20,7! !vINT~~20,7~~Люберцы I
SHI1+l\SHI1+r
Панки~~22,8! !HST\BHF~~23,7~~Люберцы II
Томилино~~25,4! !HST\ABZg3!~lCONTf3~~ ~~ ~~на Кореневский завод
р. Пехорка~~ ~~ ~~! !hKRZWae\hKRZWae~~ ~~ ~~ ~~р. Пехорка
Красково~~27,3! !HST\HST~~27,7~~Коренёво
Малаховка~~28,9! !HST\ÜWBr
Удельная~~31,5! !d\HST\ABZg+l\dKBSTeq~~ ~~ ~~Балластный Карьер
на Октябрьский~~ ~~! !dCONTgq\ABZg+r\BHF\d~~30,0~~Овражки
Быково~~33,4! !BHF\CONTf~~ ~~ ~~на Гжель
на Раменское~~ ~~! !CONTf\
}}

Возможен вывод текста с обеих сторон от иконок, как вариант — только слева. Дополнительные текстовые поля отделяются от остальной части строки двумя восклицательными знаками через пробел (! !), формат — симметричен:

свойства~~пояснение 2~~поянение 1~~основная информация~~километраж! !иконки~~километраж~~основная информация~~пояснение 1~~пояснение 2~~свойства

Все параметры не обязательны. Выравнивание текстовых полей слева симметрично выравниванию текстовых полей справа. Если с левой стороны только одно текстовое поле (то есть нет пары тильд), то считается, что указан основной текст слева. Для указания слева только километража, используйте ~~''км''! !иконки.

Маршрутную карту можно расположить по левой стороне страницы, если основное основное направление текста — справа налево, или например, для размещения небольшой диаграммы слева при наличии основной диаграммы справа. Для этого шаблону необходимо передать параметр обтекание = left. При использовании в таком случае текста только слева иконок (перед символами ! !), результат будет абсолютно симметричен стандартному виду диаграммы.

Свойства строки

Свойства переопределяют то, как будет выведена строка. Каждое свойство имеет вид имя=значение, одно от другого отделяется символами !@. Для стандартной строки свойства указываются после примечания по правому краю, за пятым разделителем ~~. Если текст задается только слева от иконок, то свойства можно указать аналогичным образом перед наиболее левым примечанием слева, то есть за четыре разделителя ~~ перед ! !. При указании свойств и слева, и справа, учитываться будут только правые.

На данный момент поддерживаются следующие свойства строки:

bg — задает цвет фона области иконок (но не текстовых полей). Предполагается, что внизу диаграммы (с помощью параметра внизу) будет дано описание выделенного таким образом участка. В качестве значения допускаются стандартные цвета HTML или RGB-коды с символом #, напр. silver или #С0С0С0. Фон меняется для соответствующей ячейки общей таблицы, по ширине равной максимальному для всей диаграммы числу иконок в строке; то есть если в каком-то месте диаграммы присутствуют пять иконок в ряд, а фон поменять для строки с одной иконкой, область с измененным цветом в ширину будет равна пяти иконкам. Необходимо учитывать, что некоторые иконки имеют участки с непрозрачным фоном (#F9F9F9), которые могут стать заметными при изменении фона строки или таблицы.

Ключевые слова

Модуль шаблона распознаёт и обрабатывает ключевые слова, расширяющие его функциональность. Все ключевые слова выглядят как -КлючевоеСлово[-параметры]. Параметры не всегда являются обязательными; между собой их нужно также разделять знаком -.

Сворачивающиеся блоки

Шаблон поддерживает сворачивающиеся блоки. Для их применения нужно указать начало и конец блока с помощью ключевых слов startCollapsible и endCollapsible соответственно (в точно таком написании, расположенные на отдельных строках). Блоки могут идти один за другим или могут быть вложены друг в друга, но при этом после startCollapsible обязательно должна идти строка без ключевых слов (при использовании функции замещения — две строки). Данная строка будет отображаться постоянно; оставшиеся строки будут добавляться или убираться снизу от нее.

Открывающее блок ключевое слово поддерживает три необязательных параметра.

Изначальное состояние свёрнутости блока: collapsed (свёрнут, значение по умолчанию) или expanded (развёрнут).
Использование замещения. При указании любого непустого значения (рекомендуется replace) вторая после startCollapsible строка будет использована для замещения первой строки в развёрнутом состоянии блока. (Фактически, вторая строка будет расположена поверх первой, перекрывая её).
Свойства блока. Формат такой же, как и для обычных строк. Поддерживается bg — цвет фона всех строк блока, включая первую и строку замещения. Текстовые поля также будут отображены с данным фоном.

Параметры должны указываться именно в таком порядке. Если нет необходимости задавать какой-то из них, ограничивающие его дефисы ставятся подряд. Таким образом, возможны в том числе следующие записи: -startCollapsible, -startCollapsible-expand, -startCollapsible--replace, -startCollapsible-expand-replace-bg=silver и т. д.

Триггер [развернуть] / [свернуть] по умолчанию добавляется в крайне правую ячейку строки таблицы вместо второго примечания. Само примечание при этом будет расположено в том же поле, что и основной текст с первым примечанием, и может перекрыть их сверху. Для корректировки этого используйте параметр ширина текста (см. ниже). Для варианта использования маршрутной карты, при котором весь текст указывается только слева иконок, триггер целесообразно переместить в крайне левую ячейку строки, также вместо второго (левого) примечания. Для этого необходимо задать ширина текста = ,,,,,, либо другие необходимые значения, но с пустыми последними тремя полями. При этом текст триггера будет изменён на [показать] / [скрыть] (поскольку используется другой класс сворачивающихся блоков).

Поскольку сворачивающийся блок фактически представляет собой отдельную таблицу с независимым выравниванием столбцов, помещенную в объединённую ячейку основной диаграммы, для совпадения выравнивания иконок и текста зачастую необходимо пользоваться следующими правилами.

Количество иконок в первой строке сворачивающегося блока, а при использовании функции замещения — и во второй строке, должно совпадать с максимальным числом иконок в ряд за всю таблицу. Точнее, ширина полосы иконок в первой строке (первых двух) с учётом использования пустых, половинных и др. иконок должна быть равна максимальной таковой ширине за всю таблицу. Для этого по краям полосы иконок можно добавить пустые иконки. Если внутри сворачивающегося блока есть строка с большей шириной полосы иконок, чем вне его, то необходимо увеличить ширину полосы одной из строк вне блока пустыми иконками.
Если внутри сворачивающегося блока суммарная ширина текстовых полей одной из строк превышает таковую для всех строк вне блока; или если где-либо в диаграмме используется поле километража (времени); или если в первой строке (первых двух) задано достаточно длинное текстовое поле; и во всех случаях использования текста слева от иконок — необходимо указать параметр шаблона ширина текста. В нём фиксируется ширина используемых текстовых полей через запятую; при отсутствии единиц измерения (px, em и т. п.), подставляются пиксели.
- Если задано одно значение (ширина текста = 120), оно изменяет ширину столбца, в котором размещается основной текст справа с первым примечанием.
- Если задано три значения (ширина текста = 25,120,75 или ширина текста = ,,75), оно изменяет ширину столбцов справа: километража, основной информации с первым примечанием и второго примечания.
- Если задано шесть значений (ширина текста = 50,110,25,25,120,75 или ширина текста = ,120,25,,,), оно изменяет ширину столбцов слева и справа: второго левого примечания, основного теста слева с первым примечанием, километража слева, километража справа, основной информации справа с первым примечанием и второго примечания справа.
Обычные значения для километража: 25px для текста «123,4»; 32px для «1234,5»; 12px для иконки {{инвалид}}.
Необходимо учитывать, что в строках, для которых не задано второе примечание, столбцы для него и для основной информации объединяются, и ширина такого поля не зависит напрямую от параметра ширина текста. Основной текст с первым примечанием при этом вполне могут превышать по ширине заданное для соответствующей колонки значение. Таким образом, для выбора ширины второго столбца справа ориентироваться надо на максимальную ширину основного текста только из тех строк, где есть второе примечание.
При использовании функции замещения рекомендуется всегда задавать как минимум 72px для третьего правого столбца (или 50px для первого левого столбца), поскольку без этого некоторые браузеры (в том числе Google Chrome) могут отобразить строку замещения немного сдвинутой. Заданием ширины столбца основного текста также можно регулировать сокрытие теста замещённой (первой) строки.
Параметр ширина текста помимо этого убирает 6px пустого пространства слева от иконок, остающиеся от столбца левого километража, если задать менее шести значений или если левые три значения будут пустыми. При задании шести значений, правые три из которых пусты, пустое пространство убирается справа, а триггер [показать] / [скрыть] переносится в самый левый столбец.

Текст в ширину таблицы

Чтобы вывести некоторый текст во всю ширину таблицы, применяется ключевое слово colimg. Следующие за ним строки будут обработаны как обычный викитекст и помещены в одну объединённую ячейку. Действие данного ключевого слова прекращается после указания на очередной строке -colimg-end. К открывающему ключевому слову может быть добавлен необязательный параметр — число строк к объединению (не включая само открывающие слово colimg). Указания -colimg-end в таком случае не требуется, но если оно встретится раньше, чем заданно строк, обработка ключевого слова закончится.

Вторым необязательным параметром является список свойств в стандартном формате, которые будут применены к объединённой ячейке. Для colimg поддерживаются:

bg — фон ячейки. Займет практически всю ширину таблицы, за исключением внутренних отступов (padding);
align — выравнивание текста, напр. left, right или center;
style — дополнения к CSS-стилю ячейки, напр. padding:5px 0px;.

Поскольку текст, помещенный в данный блок, всё же передается в качестве параметра шаблона, элементы форматирования таблиц необходимо заменять на {{!}}, {{!-}}, {{!}} и т. д. Помимо этого, пустые строки предварительно «проглатываются» и не оказывают влияния на подсчет строк к объединению и на форматирование текста. Для разбиения текста внутри блока на строки используйте <br>. До появления -colimg-end либо истечения строк счетчика, обработка других ключевых слов не производится.

Строка-заполнитель

Вместо блока иконок строится таблица, имитирующая ряд иконок STR () нужных цветов, но с возможностью выставить произвольную высоту (аналогично шаблону {{BS!}}). Может применяться для разделения двух строк карты, если высота обычных иконок (20px) излишня. Ключевое слово — filler, первый параметр — высота строки, при его отсутствии используется 5px. Второй параметр аналогичен обычной строке с тем же набором разделителей и параметров. Вместо названий иконок указываются RGB-коды очередной линии или же название набора иконок на Викискладе (см. {{BS-color}} и категорию). Например, вместо (uexSTR) указать uex, вместо (STR orange) — orange, вместо (exSTR orange) — ex_orange; для стандартного набора ( (STR)) указать bahn или -. Каждая ячейка занимает 20px в ширину; отсутствие кода или названия (\\) оставляет ячейку пустой.

Категоризация

При ошибках в заполнении модуль шаблона помещает статьи в категорию Википедия: Статьи с неверно заполненными маршрутными картами.

См. также