Template:Wp/kum/Doc/doc
Template:Wp/kum/Doc · Документация · Обсуждение · Где используется (использование шаблона · параметры [?])
Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «Название текущей страницы/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным).
Проще всего вставить включение этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{Wp/kum/doc}}</noinclude>, не перенося строку после последней строчки кода шаблона.
Документация шаблона {{Wp/kum/doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе Template:Wp/kum/Tlp вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
Template:Wp/kum/другие названия шаблона
См. также
[edit source]- Проект по документированию шаблонов (в русском разделе)
- Пара шаблонов {{Wp/kum/doc-inline}} и {{Wp/kum/doc-end}}
TemplateData
[edit source]No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | no description | Unknown | optional |
| 2 | 2 | no description | Unknown | optional |
| 3 | 3 | no description | Unknown | optional |
| 4 | 4 | no description | Unknown | optional |
| 5 | 5 | no description | Unknown | optional |
| editsection | editsection | no description | Unknown | optional |
| SUBJECTPAGENAME | SUBJECTPAGENAME | no description | Unknown | optional |