Шаблон:Doc/Документация

Материал из Wiki.crossplatform.ru

Это шаблон для документирования шаблонов. Его необходимо использовать во всех шаблонах нашей вики.
Он создает ссылку на подстраницу с документаций для текущего шаблона.

Применение

При создании шаблона не добавляйте сам шаблон в какую либо категорию, а добавте в конец шаблона следующую строку:

<noinclude>{{doc}}</noinclude>

Затем сохраните шаблон, вы увидите ссылку НАЗВАНИЕ СТРАНИЦЫ/Документация. Перейдите по этой ссылке и напишите документацию. Категорию в которую надо поместить сам шаблон указывают на странице документации (см. заготовку).

Звготовка документации

<noinclude>{{template navigation}}</noinclude>
Тест документации, необходимые ссылки;

== Пример использования ==

=== Заготовка для копирования ===
<nowiki>ЗДЕСЬ ПОМЕЩАЕТСЯ ПРИМЕР ЗАПОЛНЕНИЯ ШАБЛОНА</nowiki>

=== Как выглядит ===
ЗДЕСЬ ПОМЕЩАЕТСЯ ПРИМЕР ЗАПОЛНЕНИЯ ШАБЛОНА,
но уже без тэга <nowiki></nowiki>,
т.е. будет отображен результат
=== Примечание ===
Если оно необходимо<includeonly>

[[Категория:КАТЕГОРИЯ_В_КОТОРУЮ_ПОМЕЩАЕТСЯ_ШАБЛОН]]
</includeonly><noinclude>

[[Категория:Документация к шаблонам]]
</noinclude>

Обратите внимание: открывающиеся тэги <noinclude> и <includeonly> пишутся всегда слитно с предыдущим текстом.

Примечание

Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.

Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.

Шаблон поддерживает необязательный параметр. При вводе {{doc|Название страницы}} вместо страницы /Документация будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.