Шаблон:Doc/doc: различия между версиями
Новая страница: «<noinclude>{{docpage}}</noinclude> Включает подстраницу с документацией для текущего шаблона. Точнее, вкл...» |
Trol (обсуждение | вклад) Нет описания правки |
||
| Строка 1: | Строка 1: | ||
<noinclude>{{docpage}}</noinclude> | <!-- <noinclude>{{docpage}}</noinclude> --> | ||
Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон <code style="white-space:nowrap"><span style="opacity:0.5">название страницы</span>/doc</code>. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным. | Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон <code style="white-space:nowrap"><span style="opacity:0.5">название страницы</span>/doc</code>. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным. | ||
| Строка 10: | Строка 10: | ||
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. | Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. | ||
См. также [[Википедия:Проект:Документирование шаблонов|проект по документированию шаблонов]]. | <!-- См. также [[Википедия:Проект:Документирование шаблонов|проект по документированию шаблонов]]. --> | ||
<includeonly> | <!-- <includeonly> | ||
[[Категория:Википедия:Шаблоны для документирования шаблонов|{{PAGENAME}}]] | [[Категория:Википедия:Шаблоны для документирования шаблонов|{{PAGENAME}}]] | ||
</includeonly> | </includeonly> --> | ||
Текущая версия от 10:36, 7 декабря 2010
Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.