Шаблон:Doc

Материал из BSTU
(перенаправлено с «Шаблон:Documentation»)
Перейти к навигации Перейти к поиску
Документация

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

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

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

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

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

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

См. также

TemplateData

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

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

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

ПараметрОписаниеТипСтатус
11

без описания

Неизвестнонеобязательный
22

без описания

Неизвестнонеобязательный
33

без описания

Неизвестнонеобязательный
44

без описания

Неизвестнонеобязательный
55

без описания

Неизвестнонеобязательный
editsectioneditsection

без описания

Неизвестнонеобязательный
SUBJECTPAGENAMESUBJECTPAGENAME

без описания

Неизвестнонеобязательный