Template:Doc/doc

From FragoriaWiki

(Difference between revisions)
Jump to: navigation, search
(Новая страница: «<noinclude>{{docpage}}</noinclude> Включает подстраницу с документаций для текущего шаблона. Точнее, вклю…»)
Line 13: Line 13:
<includeonly>
<includeonly>
-
[[Категория:Википедия:Шаблоны для документирования шаблонов|{{PAGENAME}}]]
+
[[Категория:Шаблоны:Для шаблонов|{{PAGENAME}}]]
</includeonly>
</includeonly>

Revision as of 19:29, 21 August 2010

[[:Шаблон:{{{1}}}]] · Документация · [[:Обсуждение шаблона:{{{1}}}|Обсуждение]] · [[Служебная:Whatlinkshere/Шаблон:{{{1}}}|Где используется]]

Doc/doc


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

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

Документация шаблона {{doc}}

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

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

Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}}

вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.

См. также проект по документированию шаблонов.


Personal tools