Шаблон:Док

Материал из S.T.A.L.K.E.R. Wiki
Перейти к: навигация, поиск
Template-info.png Документация

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

Создайте подстраницу шаблона с названием doc, поставьте {{док/начало}} в начало документации и {{док/конец}} в её конец. Перейдите на страницу шаблона и на новой строке после кода шаблона поставьте <noinclude>{{Док}}</noinclude>. Подстраницы /Док будут автоматически добавляться в Категория:Документационные шаблоны.

Дополнительные параметры

clear

Если на странице с шаблоном есть плавающий контент, но вы не хотите, чтобы он закрывал документацию, замените строку {{док/начало}} на странице документации строкой {{док/начало|clear}}.

Это также можно применять в шаблонах, не использующих <includeonly>, так как в таком случае между шаблоном и документацией будет увеличено расстояние.

нетдок=1

Если у шаблона, которым вы не знаете, как пользоваться, нет документации, замените строку {{док/начало}} на странице документации строкой {{док/начало|нетдок=1}} (а если нужно также использование параметра clear, строкой {{док/начало|clear|нетдок=1}}).

Фон документации станет красным, чтобы увеличить её заметность, и страница будет добавлена в Категория:Шаблоны без документации.

плохдок=1

Использование почти такое же, как и у параметра нетдок, но этот параметр используется для шаблонов, у которых документация есть, но низкого качества. Например, это документация, не включающая достаточно примеров, не объясняющая все функции шаблона или его применение.

Фон документации станет жёлтым, чтобы увеличить её заметность, и страница будет добавлена в Категория:Шаблоны с плохой документацией.

Если и параметр нетдок, и параметр плохдок заданы, плохдок будет проигнорирован.