Модул:Isomer/doc

This is the documentation page for Модул:Isomer

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

Функции

Section

{{#invoke:Isomer|Section|full-width|half-width|title-background|desc-background|data-background|border-color|shortnames|title|mandatory-title|wide-column|collapsed|nocat|1|2|3|…}} — отображает несколько строк (секцию) таблицы. Перед первым вызовом функции в тексте должно быть начало таблицы ({|) или начало новой строки (|-), после последнего — окончание таблицы (|}) или следующая строка. Параметры вызова:

half-width: Ширина блока, расположенного в правой ячейке.
full-width: Ширина блока, занимающего две объединённые ячейки.
title-background: Цвет фона заголовка секции.
desc-background: Цвет фона левой ячейки.
data-background: Цвет фона правой ячейки.
border-color: Цвет границы заголовка секции.
shortnames: Краткое имя, список, элементы которого идентифицируют отображаемое значение как относящееся к определённому изомеру.
title: Текст заголовка секции, при отсутствии заголовок не отображается.
mandatory-title: Заголовок отображается даже для пустой секции (любое непустое значение).
wide-column: Таблица должна иметь три столбца (см. например {{drugbox}}), если параметр равен 1 — объединяются первый и второй столбец, если 2 — второй и третий.
collapsed: Секция свёрнута (любое непустое значение).
nocat: Автоматическая категоризация (см. ниже category) отключена (любое непустое значение).

Далее идут тройки безымянных параметров:

1: Описание параметра, текст левой ячейки. При пустом значении ячейки объединяются.
2: Величина параметра, текст правой ячейки. Если все параметры 2 в секции пустые, секция не отображается.
3: Дополнительные параметры.

Строка может иметь несколько дополнительных параметров, которые отделяются друг от друга точкой с запятой. Значения параметра, если они имеются, отделяются от его имени двоеточием. Значение параметра не должно содержать точку с запятой, знаки равенства должны экранироваться. Дополнительные параметры:

unit:единица\минимальная степень\максимальная степень\используемая степень: Отображается физическая величина с нормализацией значения.

единица — единица физической величины, обычно используется без приставок, например «г»;
минимальная и максимальная степень — степени десятичных множителей, используемые для данной величины, например «г\-6\3» указывает, что могут использоваться микрограммы, миллиграммы, граммы, килограммы, но не мегаграммы («0\0» запрещает модификацию значения, в этом случае можно указывать величину с приставкой, например «нм\0\0»);
используемая степень — множитель, применяющийся для величины, например «Дж\\\3» означает, что энергия указывается в килоджоулях.

Параметр 2 может быть диапазоном значений.
link:ссылка: Отображается указанная ссылка, параметр 2 добавляется к ссылке и используется как её заголовок.
columns:колонки: Указывает число колонок, используется для вывода изображений. Параметр 2 интерпретируется как имя файла, если файл не найден, то значение параметра выводится без изменений.
templates:шаблон: Параметр 2 передаётся в указанный шаблон.
word-wrap: Длинные слова могут разбиваться для переноса.
image-width:ширина: Ограничивает ширину изображения по сравнению с расчётной по ширине поля или колонки.
category:категория: Если параметр 2 пустой, страница включается в указанную категорию.
multivalue-separator:входной\выходной: Разделитель нескольких значений параметров внутри изомера, по умолчанию «; \<br />». Входной используется для разделения входных значений, выходной добавляется к обработанным строкам. Если указан пустой входной разделитель, строка будет обрабатываться целиком, без разделения.
extension:расширение: Используется дополнительная обработка значения параметра 2.

GHS — коды разделённые произвольным, но одинаковым для всей строки символом передаются в шаблон {{H-фраза}} или {{P-фраза}}.
NFPA704 — четыре значения, разделённые запятыми, используются в качестве соответствующих параметров шаблона {{NFPA 704}}.
ICD10 — каждое значение из списка, разделённого запятыми, используется в шаблоне {{ICD10}} (с необходимым разделением на части).
capitalise — заменяет первый символ на заглавный.

IsomerButtons

{{#invoke:Isomer|IsomerButtons|1}} — отображает строку — список изомеров. Параметры вызова:

title-background: Цвет фона заголовка.
border-color: Цвет границы заголовка.
dark-color: Цвет тёмного фона.
light-color: Цвет светлого фона.
title: Текст заголовка, см. выше.
1: Краткое имя, см. shortnames выше.

Isomers

{{#invoke:Isomer|Isomers|1|2|unit|link|columns|width}} — отображает значения параметра для каждого изомера. Функция в шаблоне {{Изомеры}} непосредственно больше не используется (заменена на Section) и будет исключена из модуля. Параметры вызова:

1: Краткое имя, см. выше.
2: Отображаемая величина, ссылка, файл.
unit: Отображается физическая величина с нормализацией значения, см. выше.
link: Отображается указанная ссылка, см. выше.
columns: Указывает число колонок, см. выше.
width: Ширина поля или общая ширина всех колонок.