ФЭНДОМ


(required) Icon required
Name?
Description?
Wiki Документация

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

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

{{Docparam|name=параметр|req=yes|desc=описание}}

Параметры

(required) Icon required
безымяный1 или name
Название параметра(ов). Еслиии параметров несколько, они указываются через специальные управляющие комбинации символов.

Управляющие комбинации (для распознавания должны быть окружены пробелами):

  • >> преобразуется во фразу «вплоть до»; используется для указания ряда (например, «игра1 вплоть до игра5»).
  • // преобразуется в «или», используется для альтернативных вариантов (например, «безымянный1 или название»).
  • ++ преобразуется в запятую с пробелом («, »), используется для включения в список параметров с другим именем, но схожим функционалом (например, «contentA1, contentB1»).
(optional) Icon optional
default, default2
Значение(я) параметра по умолчанию.
(required) Icon required
desc
Описание параметра.
(semi-required) Icon semi-required
(по умолчанию: "yes")
req
Указывает, является ли этот параметр необходимым для корректной работы шаблона.

Доступные опции:

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

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

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

}}

Пример

Простой

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

результат:

(required) Icon required
параметр
Описание

Продвинутый

{{Docparam|name=параметр // альтернатива ++ аналогичный1 >> аналогичный3|req=no|default=default setting|desc=
Описание
}}

результат:

(optional) Icon optional
(по умолчанию: "default setting")
параметр или альтернатива, аналогичный1 вплоть до аналогичный3
Описание
Материалы сообщества доступны в соответствии с условиями лицензии CC-BY-SA , если не указано иное.