Шаблон:Doc

Материал из Foxhole Wiki
Перейти к навигации Перейти к поиску
Template-info.svg Документация

Для использования создайте подстраницу шаблона с названием doc, поставьте {{doc/start}} в начало документации и {{doc/end}} в её конец.

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

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

clear

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

nodoc=1

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

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

baddoc=1

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

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

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