Шаблон:Doc/doc: различия между версиями

Материал из Русского эксперта
Перейти к навигации Перейти к поиску
(Новая страница: «Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «''…»)
 
Нет описания правки
Строка 10: Строка 10:
<!--
<!--
{{другие названия шаблона|документация}}-->
{{другие названия шаблона|документация}}-->
 
<!--
== TemplateData ==
== TemplateData ==
<templatedata>
<templatedata>
Строка 26: Строка 26:
}
}
</templatedata>
</templatedata>
 
<!--
<includeonly>
<includeonly>
[[Категория:Шаблоны:Для документирования шаблонов]]
[[Категория:Шаблоны:Для документирования шаблонов]]
</includeonly>
</includeonly>

Версия от 22:44, 31 мая 2017

Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «Название текущей страницы/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным).

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

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

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