Шаблон:Легенда/Документация

Этот шаблон предназначен для демонстрации легенды условных обозначений, снабжённой цветными квадратиками. Одно употребление шаблона соответствует одному квадратику и его подписи.

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

{{легенда|цвет фона|подпись|inline|цвет и толщина границы квадратика|скругление границы квадратика|цвет текста в квадратике|текст в квадратике|масштаб|текст всплывающей подсказки}}

Передача параметров

Шаблон представяет из себя два HTML тега <span>, один в другом. Внешний тег определяет масштаб и положение на странице квадратика и подписи. Внутренний — стиль квадратика. Параметры, указанные пользователем шаблона, определяют, что передаётся в атрибуты style обоих тегов. Некоторые параметры передаются без изменений, для некоторых лишь факт присутствия что-то определяет.

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

Пример
Текст{{легенда}}вплотную	Текст вплотную

Описание смысла параметров и их возможных значений ниже.

Цвет фона

Определяет цвет фона квадратика. В случае присутствия передаётся напрямую, при отсутствии передаётся none, то есть „нет цвета“. Возможные значения определены стандартом CSS.^[1] Например, красный цвет может быть задан следующими способами.

Пример
{{легенда\|#F00}} {{легенда\|#FF0000}} {{легенда\|rgb(255, 0, 0)}} {{легенда\|hsl(0, 100%, 50%)}}

Подпись

Текст написанный справа от квадратика. Положение текста относительно квадратика в этой версии шаблона изменить нельзя. Но так как весь шаблон — это по сути текст, то можно, задав параметр inline, написать нужный текст слева с пробелом после. Нужно учесть также, что масштаб текста подписи по умолчанию 90%, и, возможно, придётся масштабировать текст слева. Масштаб текста подписи (и квадратика) меняется другим параметром. Цвет текста не устанавливается, значит, подчиняется внешним спецификаторам, то есть весь шаблон можно погрузить в другой цвет, и он адаптируется. Так же можно задать стиль внутри параметра шаблона (следует помнить об необходимости использования {{=}}^[2]). Вики-форматирование работает, но цвет ссылок глобального стиля имеет приоритет над локальным цветом пользователя.

Пример

{{легенда|#180|Австралия}}
Австралия слева {{легенда|#180|и справа|inline}}
<span style="font-size:90%">Австралия слева </span>{{легенда|#180|и справа|inline}}
{{легенда|#F00|Китай}}
{{color|red|{{легенда|#F00|Красный Китай}}}}
{{легенда|#F00|<font color{{=}}"#FF0">Жёлтый [[Китай]]</font>}}

Австралия Австралия слева и справа
Австралия слева и справа Китай Красный Китай Жёлтый Китай

inline

Параметр определяет положение шаблона внутри окружающего текста: как текст или как блок (с переносами по краям). Наличие значения inline влечёт первый вариант, отсутствие или другое значение — второй.

Пример
Найдите {{легенда\|#00F\|Либерию}} на карте. Найдите {{легенда\|#1EB53A\|Руанду\|inline}} тоже!	Найдите Либерию на карте. Найдите Руанду тоже!

Цвет и толщина границы квадратика

Определяет стиль границы квадратика. В случае присутствия передаётся напрямую, при отсутствии передаётся 1px solid {{{1}}}, то есть: толщина 1 пиксель, линия сплошная, цвет из первого параметра (цвет квадратика). Как, вероятно, уже понятно, строка значения состоит из трёх параметров: толщина линии, стиль линии и цвет линии.^[3] При этом любой из параметров может отсутствовать, но надо иметь в виду, что стиль по умолчанию — none, то есть „никакой“, поэтому стиль надо задавать всегда. Толщина по умолчанию — medium („средняя“), цвет по умолчанию совпадает с цветом текста в квадратике.

Пример

{{легенда||||solid}}
{{легенда|red|||solid}}
{{легенда|red|— нет границы, не задан стиль||green}}
{{легенда|red|— задан стиль, есть граница||solid yellow}}

— нет границы, не задан стиль — задан стиль, есть граница

Толщина может быть задана в числовых единицах измерения (пикселях, миллиметрах и т.п.) : 12px, 1mm, … или в виде одной из трёх констант: thick, medium, thin (толстая, средняя, тонкая). Константы от чисел отличаются тем, что на разных браузерах поведение при изменении масшаба отображения разное для разных видов значений.

Пример

{{легенда||||thick solid red}}
{{легенда||||medium solid red}}
{{легенда||||thin solid red}}
{{легенда||||1px solid blue}}
{{легенда||||2px solid blue}}
{{легенда||||1mm solid purple}}

Стиль линии задают строковой константой из фиксированного набора заданных констант, из которых наибольший интерес представляют следующие: dotted, dashed, solid, double, groove, ridge, inset и outset.

Пример

{{легенда||||medium dotted magenta}}
{{легенда||||medium dashed magenta}}
{{легенда||||medium solid magenta}}
{{легенда||||medium double magenta}}
{{легенда||||medium groove magenta}}
{{легенда||||medium ridge magenta}}
{{легенда||||medium inset magenta}}
{{легенда||||medium outset magenta}}

Цвет задают обычным способом, см. параметр цвет фона.^[1]

Скругление границы квадратика

Параметр определяет радиус(-ы) кривизны углов границы квадратика. В случае присутствия передаётся напрямую, при отсутствии передаётся 0%, то есть „нет скругления“. Задаётся в числовых единицах (пикселях, миллиметрах и т. п.). Может быть задан в процентах от максимального значения. Значения свыше максимально возможного приводятся к максимальному.^[4]

Пример

{{легенда|gray|0%|||0%}}
{{легенда|gray|10%|||10%}}
{{легенда|gray|20%|||20%}}
{{легенда|gray|30%|||30%}}
{{легенда|gray|40%|||40%}}
...
{{легенда|gray|100%|||100%}}

0% 10% 20% 30% 40% ... 100%

Может быть задан в виде нескольких чисел: от одного до четырёх. В этом случае значения применяются к углам последовательно по часовой стрелке начиная с левого верхнего. Когда числа заканчиваются, начинаются сначала, с первого.

Пример

{{легенда||— номер трассы||2px solid RoyalBlue|25px 25px|RoyalBlue|&nbsp;'''346'''&nbsp;}}
{{легенда|#8AC007|— другой номер||1px solid #8AC007|7px 0px 7px 0px|white|&nbsp;'''40'''&nbsp;}}
{{легенда|#E2A046|— батон||1px solid #AC6015|20px 15px|#FDD576|&nbsp;/&nbsp;/&nbsp;/&nbsp;/&nbsp;}}

346 — номер трассы 40 — другой номер / / / / — батон

Цвет текста в квадратике

Задаёт цвет текста, отображаемого в квадратике. Текст по умолчанию — четыре пробела  , и для них цвет безразличен, хотя и может быть формально установлен. При отсутствии параметра передаётся black („чёрный“).

Пример
{{легенда\|yellow\|— чёрный\|\|\|\|Black\| '''R''' }} {{легенда\|black\|— белый\|\|\|\|White\| '''S''' }} {{легенда\|red\|— оранжевый\|\|\|\|Orange\| '''B''' }}	R — чёрный S — белый B — оранжевый

Текст в квадратике

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

Пример

{{легенда|darkblue|||||White|'''Обычный'''}} 
{{легенда|black|— жирный|inline|1px solid black||white|'''Platform 9¾'''}}
{{легенда|darkgreen|||||White|''Курсив''}}
{{легенда|darkred|||||White|'''''И жирный, и курсив'''''}}
{{легенда|purple|← выделите текст||1px solid purple||purple|'''Секрет секрет'''}}
{{color|red|{{легенда|black|||||White|Попытка изменить цвет}}}}
{{легенда|black|||||White|{{color|red|Удачная попытка}}}}
{{color|yellow}}{{легенда|black||||||Тоже работает}}}}

Обычный Platform 9¾ — жирный Курсив И жирный, и курсив Секрет секрет ← выделите текст Попытка изменить цвет Удачная попытка Тоже работает

Масштаб

Определяет степень увеличения всего шаблона (и квадратика, и подписи). Задаётся в процентах. Значение по умолчанию — 90%.

Пример

{{легенда|#ff0|300%|8=300%}}
{{легенда|#ff0|200%|8=200%}}
{{легенда|#ff0|150%|8=150%}}
{{легенда|#ff0|100%|8=100%}}
{{легенда|#ff0|90% — по умолчанию|8=90%}}
{{легенда|#ff0|50%|8=50%}}

300% 200% 150% 100% 90% — по умолчанию 50%

Текст всплывающей подсказки

Это тот текст, который видит пользователь, когда наводит курсор мыши на квадратик. По умолчанию — это цвет квадратика. Такое поведение было взято из шаблона Vorlage:Farbindex немецкой Википедии.

Пример

{{легенда||— наведите курсор на квадратик||2px solid blue|25%|blue|
    &nbsp;'''R'''&nbsp;||Этот город был взят Александром Македонским 
    всего за три дня, а вот Наполеону потребовалось больше недели}} 
{{легенда|black|||2px solid black||White|подсказка: „black“}}

R — наведите курсор на квадратик подсказка: „black“

Различные примеры

Исходный код

1 2 3 400 5 6 7 8 9

{{легенда|red|||1px solid red|25%|white|&nbsp;'''1'''&nbsp;}}
{{легенда||||2px solid red|25%|black|&nbsp;'''2'''&nbsp;}}
{{легенда||||2px solid green|100%|green|&nbsp;'''3'''&nbsp;}}
{{легенда|#8AC007||inline|2px solid #8AC007|15px 50px|white|&nbsp;'''400'''&nbsp;}}
{{легенда||||2px dotted orange|100%|orange|&nbsp;'''5'''&nbsp;}}
{{легенда||||3px double|100%|purple|&nbsp;'''6'''&nbsp;}}
{{легенда||||6px ridge|100%|gray|&nbsp;'''7'''&nbsp;}}
{{легенда||||2px groove|0%|gray|&nbsp;'''8'''&nbsp;}}
{{легенда|aqua|||2px solid teal|0%||&nbsp;'''9'''&nbsp;}}

См. также

Примечания

↑ ^а ^б Положение стандарта о константах цветов(англ.) Проверено 08-04-2015 г.
Список констант цветов(англ.) Проверено 08-04-2015 г.
↑ См. Механизм шаблонов.
↑ См. Описание из стандарта CSS(англ.) Проверено 08-04-2015 г.
↑ Пояснения по радиусу границы(англ.) Проверено 08-04-2015 г.

демонстрация легенды условных обозначений, снабжённая цветными квадратиками. Одно употребление шаблона соответствует одному квадратику и его подписи.

Параметры шаблона[Править данные шаблона]
Параметр		Описание	Тип	Статус
Цвет квадратика	`1`	без описания По умолчанию нет цвета Пример #FF0000, rgb(255, 0, 0)	Неизвестно	необязательный
подпись	`2`	Текст написанный справа от квадратика.	Неизвестно	необязательный
inline	`3`	Параметр определяет положение шаблона внутри окружающего текста: как текст или как блок (с переносами по краям). Наличие значения inline влечёт первый вариант, отсутствие или другое значение — второй. Пример inline	Неизвестно	необязательный
цвет и толщина границы квадратика	`4`	стиль границы квадратика. строка значения состоит из трёх параметров: толщина линии, стиль линии и цвет линии. По умолчанию 0px solid цвет_квадратика Пример medium dotted magenta Толщина: thick, medium, thin (толстая, средняя, тонкая), 12px, 1mm; Стиль линии: dotted, dashed, solid, double, groove, ridge, inset и outset;	Неизвестно	необязательный
скругление границы квадратика	`5`	радиус(-ы) кривизны углов границы квадратика Задаётся в числовых единицах (пикселях, миллиметрах и т. п.). Может быть задан в процентах от максимального значения. Значения свыше максимально возможного приводятся к максимальному. Может быть задан в виде нескольких чисел: от одного до четырёх. В этом случае значения применяются к углам последовательно по часовой стрелке начиная с левого верхнего. По умолчанию 0% Пример 40%	Неизвестно	необязательный
цвет текста в квадратике	`6`	без описания По умолчанию black Пример White	Неизвестно	необязательный
текст в квадратике	`7`	без описания	Неизвестно	необязательный
масштаб	`8`	тепень увеличения всего шаблона (и квадратика, и подписи). Задаётся в процентах По умолчанию 90% Пример 150%	Неизвестно	необязательный
текст всплывающей подсказки	`9`	текст, который видит пользователь, когда наводит курсор мыши на квадратик По умолчанию цвет квадратика, значение из первого параметра	Неизвестно	необязательный

[css-colors-1] а ^б Положение стандарта о константах цветов(англ.) Проверено 08-04-2015 г.
Список констант цветов(англ.) Проверено 08-04-2015 г.

[2] См. Механизм шаблонов.

[3] См. Описание из стандарта CSS(англ.) Проверено 08-04-2015 г.

[4] Пояснения по радиусу границы(англ.) Проверено 08-04-2015 г.

[1]

[2]

[3]

[4]