Модуль:parameters/Документация

Модуль предоставляет функции проверки и обработки аргументов шаблонов

обработка

process(args, params, return_unknown) Обрабатывает аргументы с заданным списком параметров и возвращает таблицу, содержащую обработанные аргументы. Параметр args определяет аргументы, которые будут обработаны; это аргументы, которые вы могли бы извлечь из frame:getParent().args. Параметр params определяет список допустимых параметров, и состоит из таблицы. Если аргумент не встречается в таблице параметров, возвращается ошибка.

Таблица параметров должна иметь имена параметров в качестве индексов, и (возможно, пустую) таблицу параметров тэгов в качестве значения. Пустая таблица в качестве значения лишь констатирует, что параметр существует, но не должен принимать какие-либо специальную обработку. Возможные тэги параметров перечислены ниже. Пример таблицы параметров (из Module:translations):

{
	[1] = {required = true, default = "und"},
	[2] = {},
	[3] = {list = true},
	["alt"] = {},
	["sc"] = {},
	["tr"] = {},
}

Параметр return_unknown, если установлено значение true предотвращает функцию от включения ошибки, когда функция проходит через аргумент с несуществующим именем. Вместо этого возвращаемое значение будет пара значений: первое, обычно обработанные аргументы, второе содержит все нераспознанные аргументы, которые были оставлены необработанными. Это позволяет выполнять многоступенчатую обработку, где весь набор аргументов, которые шаблон должен принимать заранее не известен. Например, таблица интонаций может сделать некоторую общую обработку над некоторыми аргументами, но затем отложить обработку остатка функции, которая обрабатывает конкретный тип интонации.

Тэги параметров

required=true

Обязательный параметр, если отсутствует, возвращается ошибка. Исключение страница шаблона сама по себе; здесь ошибка не возращается.

allow_empty=true

Если аргумент-пустое значение строки, аргумент не преобразуется в nil, а остается как есть.

type=

Определяет в какой тип данных преобразуется значение аргумента. По умолчанию, значение остается в виде текстовой строки. Альтернативы:

type="boolean"

Значение рассматривается как логическое значение, либо "истина"(true), либо "ложь"(false). Без значения, пустая строка, и строки "0", "no", "n" и "false" рассматриваются как "ложь"(false), все остальные значения считаются "истина"(true).

type="number"

Значение преобразуется в число, если только оно не равно нулю.

alias_of=

Рассматривает параметр как псевдоним другого. Когда для данного параметра указаны аргументы, то аргументы автоматически будут переименованы и сохранены под псевдонимом. Это позволяет параметрам с несколькими альтернативными именами, в то же время, рассматривать их как если бы они имели только одно имя. Это возможно даже для alias_of= иметь имя, которое не является параметром самим по себе.

list=

Рассматривает параметр список значений, каждый из которых имеет свое собственное имя параметра, а не одно значение. Параметры будут иметь номер в конце, за исключением первого. Например, list=true в параметре с именем "head" будет включать параметры head=, head2=, head3= и т.д. Если имя параметра является числом, другое число не добавляется, но подсчет просто продолжается, например, для параметра 3, последовательность 3=, 4=, 5= и т.д. Параметры списка возвращаются в виде нумерованных списков, поэтому для шаблона, который задается параметрами head=a|head2=b|head3=c, обработанные значения параметра head будут {"a", "b", "c"}.

Значение для list= также может быть строкой. Это говорит модулю, что параметры, кроме первого, должны иметь другое имя, которое используется, когда первый параметр в списке-число, а остальные именованы. Примером могут быть данные полов: list="g" в параметре с именем 1 будет иметь параметры 1=, g2=, g3= etc. Если номер не находится в конце, он может быть указан, постановкой знака равенства "=" в номере позиции. Например, параметры "f1accel", "f2accel", ... могут быть захвачены использованием имени параметра "f=accel", как в Module:headword/templates.

allow_holes=true

Это используется в сочетании с параметрами списочного типа. По умолчанию значения плотно упакованы в результирующий список. Это означает, что если, например, запись указана head=a|head3=c но не head2=, возвращенный список будет {"a", "c"}, со значениями, сохраненными как индексы 1 and 2, not 1 and 3. Если желательно сохранить нумерацию нетронутой, например, если число нескольких параметров списка коррелируют друг с другом, то этот тег может быть определен.

Если allow_holes=true определен, могут быть значения nil между двумя вещественными значениями, что сделает так, что многие из функций обработки таблиц Lua больше не будут работать, подобно # или ipairs. Чтобы решить эту проблему, результирующая таблица будет содержать дополнительное именованное значение, maxindex, которое скажет вам самый высокий числовой индекс, который присутствует в таблице. В приведенном выше примере, в результирующей таблице будет теперь {"a", nil, "c", maxindex=3}. Таким образом, вы можете перебирать значения от 1 до maxindex, в то же время пропустив значения nil между ними.

default=

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

Если используется вместе с required=true, умолчание применяется только к самой странице шаблона. Это может быть использовано, чтобы показать пример текста.