Шаблон:Docparam/док

Материал из ARK Wiki
Перейти к навигации Перейти к поиску

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

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

{{Docparam|name=parameter|req=yes|desc=description}}

Параметры

<unnamed 1> или name

Имя параметра(ов). Некоторые строки автоматически переводятся, чтобы можно было указывать альтернативные варианты или диапазоны параметров.

Переведенные строки (все они должны быть заключены в пробелы):

  • >> преобразуется в тире с пробелами вокруг него ("-"); используется для обозначения диапазонов параметров (например, "game1 - game5").
  • // преобразуется в " или "; используется для альтернативных вариантов (например, "<unnamed 1> или заголовок").

преобразуется в запятую с завершающим пробелом (","); используется для перечисления параметров, которые являются отдельными, но работают одинаково (например, "contentA1, contentB1").

Значение(я) параметра по умолчанию.

Описание параметра.

Указывает, требуется ли этот параметр для работы шаблона.

Доступные Варианты:

  • no: совершенно необязательно.
  • semi: Параметр является обязательным в определенных обстоятельствах, но необязательным в других. Для диапазона параметров (устанавливаемых через до это означает, что хотя бы один из них обязателен.
  • yes: Требуется всегда.

Копировать/вставить

{{Docparam|name=|req=|default=|desc=

}}

Примеры

Простой

{{Docparam|name=parameter|req=yes|default=|desc=
Описание
}}

приводит к:

Описание

Дополнительно

{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Описание
}}

приводит к:

(default: "default setting")
parameter или alternative, similar1 up to similar3

Описание