Шаблон:Doc/doc: различия между версиями
AsnDen (обсуждение | вклад) м no docpage Метка: очистка |
Pok (обсуждение | вклад) Обновления под формат ру wiki |
||
| Строка 1: | Строка 1: | ||
{{docpage}} | |||
{{стили шаблона|Шаблон:Doc/styles.css}} | |||
Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «''Название текущей страницы''/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным). | |||
Проще всего вставить включение этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <code class="nowrap"><nowiki><noinclude>{{doc}}</noinclude></nowiki></code>, '''не перенося строку''' после последней строчки кода шаблона. | |||
Документация шаблона {{t|doc}} сформирована по тому же принципу, так что можно посмотреть код. | |||
Основная цель выноса документации на отдельную страницу — избежать [[ВП:Серверный кэш|перегенерации HTML]] для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. | |||
Шаблон поддерживает необязательный параметр. При вводе {{tc|doc|''Полное название страницы''}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. | |||
== См. также == | |||
* [[Проект:Технические работы/Шаблоны/Документирование|Проект по документированию шаблонов]] | |||
* Пара шаблонов {{tl|doc-inline}} и {{tl|doc-end}} | |||
== TemplateData == | |||
<templatedata> | |||
{ | |||
"params": { | |||
"1": {}, | |||
"2": {}, | |||
"3": {}, | |||
"4": {}, | |||
"5": {}, | |||
"SUBJECTPAGENAME": {} | |||
}, | |||
"format": "block" | |||
} | |||
</templatedata> | |||
<includeonly> | |||
[[Категория:Шаблоны:Для документирования шаблонов]] | |||
</includeonly> | |||