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

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

(Различия между версиями)
Перейти к: навигация, поиск
(Исправил категорию)
(исправил категорию)
Строка 10: Строка 10:
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Название страницы}} вместо страницы <code>/Документация</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.<includeonly>
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Название страницы}} вместо страницы <code>/Документация</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.<includeonly>
[[Категория:Шаблоны для шаблонов|{{PAGENAME}}]]
[[Категория:Шаблоны для шаблонов|{{PAGENAME}}]]
-
</includeonly><noinclude>[[Категория:Шаблоны]]
+
</includeonly><noinclude>[[Категория:Документация к шаблонам]]
</noinclude>
</noinclude>

Версия 09:24, 30 сентября 2008

Шаблон:Doc · Документация · Обсуждение

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

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

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

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

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