Шаблон:Docparam: различия между версиями
MrGorun (обсуждение | вклад) м (Замена текста — «\[\[en:.*» на «») |
Нет описания правки |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 2: | Строка 2: | ||
--><div class="va-docparam"><!-- | --><div class="va-docparam"><!-- | ||
--><div class="va-docparam-icon">{{#switch:{{{req}}}|no={{ | --><div class="va-docparam-icon">{{#switch:{{{req}}}|no={{Иконка|optional}}|semi={{Иконка|semi-required}}|yes|#default={{Иконка|required}}}}</div><!-- | ||
-->{{#if:{{{default|}}}|<div class="va-docparam-default">(по умолчанию: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}| or {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!-- | -->{{#if:{{{default|}}}|<div class="va-docparam-default">(по умолчанию: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}| or {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!-- | ||
--><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}|| }}| >> |''' вплоть до '''}}| // |''' или '''}}| ++ |''', '''}}|Name?}}</span>'''<!-- | --><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}|| }}| >> |''' вплоть до '''}}| // |''' или '''}}| ++ |''', '''}}|Name?}}</span>'''<!-- | ||
| Строка 12: | Строка 12: | ||
--></onlyinclude> | --></onlyinclude> | ||
<noinclude>{{ | <noinclude>{{documentation}} | ||
Template:Docparam]] | Template:Docparam]] | ||
</noinclude> | </noinclude> | ||
Текущая версия от 16:56, 20 марта 2023
Description?
Шаблон для стардантизации форматируемых параметров шаблона из страниц категории документация шаблонов.
Использование
{{Docparam|name=параметр|req=yes|desc=описание}}
Параметры
Название параметра(ов). Еслиии параметров несколько, они указываются через специальные управляющие комбинации символов.
Управляющие комбинации (для распознавания должны быть окружены пробелами):
>>преобразуется во фразу «вплоть до»; используется для указания ряда (например, «игра1 вплоть до игра5»).//преобразуется в «или», используется для альтернативных вариантов (например, «безымянный1 или название»).++преобразуется в запятую с пробелом («, »), используется для включения в список параметров с другим именем, но схожим функционалом (например, «contentA1, contentB1»).
Значение(я) параметра по умолчанию.
Описание параметра.
(по умолчанию: "yes")
reqУказывает, является ли этот параметр необходимым для корректной работы шаблона.
Доступные опции:
- no: Необязателен.
- semi: Требуется при определенных обстоятельствах, но при других нет. Для ряда параметров (заданного через
>>) это означает, что по крайней мере один из них требуется. - yes: Всегда требуется.
Копировать/вставить
{{Docparam|name=|req=|default=|desc=
}}
Пример
Простой
{{Docparam|name=параметр|req=yes|default=|desc=
Описание
}}
результат:
Описание
Продвинутый
{{Docparam|name=параметр // альтернатива ++ аналогичный1 >> аналогичный3|req=no|default=default setting|desc=
Описание
}}
результат:
(по умолчанию: "default setting")
параметр или альтернатива, аналогичный1 вплоть до аналогичный3Описание
Template:Docparam]]