Шаблон:Doc

Материал из OpenCorpora
Версия от 17:05, 22 ноября 2014; Andrey Kruglov (обсуждение | вклад) (Первая редакция шаблона)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
Перейти к навигации Перейти к поиску



Документация


Шаблон Doc взят из русской википедии. См. тут: wikipedia:Шаблон:Doc

Включает подстраницу с документацией для текущего шаблона.

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

Документация располагается всегда в файле название страницы/doc и шаблон Doc, фактически, подключает страницу с таким именем.

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