Шаблон:Doc

Документация

[просмотр | править | история | обновить]

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

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

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

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

Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.

Другое название этого шаблона — {{документация}}.

См. также

• Проект по документированию шаблонов
• Пара шаблонов {{doc-inline}} и {{doc-end}}

TemplateData

Нет описания.

Параметры шаблона

Шаблон использует блочное форматирование параметров.

Параметр		Описание	Тип	Статус
1	1	без описания	Неизвестно	необязательный
2	2	без описания	Неизвестно	необязательный
3	3	без описания	Неизвестно	необязательный
4	4	без описания	Неизвестно	необязательный
5	5	без описания	Неизвестно	необязательный
editsection	editsection	без описания	Неизвестно	необязательный
SUBJECTPAGENAME	SUBJECTPAGENAME	без описания	Неизвестно	необязательный

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