Шаблон:Doc/begin — различия между версиями

Материал из Wikipedia PC-SUPP
Перейти к: навигация, поиск
(Новая страница: «<noinclude>{{docpage}}</noinclude> Включает подстраницу с документацией для текущего шаблона. Точнее, в…»)
 
Строка 6: Строка 6:
 
Документация шаблона {{t|doc}} сформирована по тому же принципу, так что можно посмотреть код.
 
Документация шаблона {{t|doc}} сформирована по тому же принципу, так что можно посмотреть код.
  
Основная цель выноса документации на отдельную страницу — избежать [[ВП:Серверный кэш|перегенерации HTML]] для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
+
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
  
 
Шаблон поддерживает необязательный параметр. При вводе {{tc|doc|''Полное название страницы''}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
 
Шаблон поддерживает необязательный параметр. При вводе {{tc|doc|''Полное название страницы''}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
Строка 13: Строка 13:
  
 
== См. также ==
 
== См. также ==
* [[Проект:Технические работы/Шаблоны/Документирование|Проект по документированию шаблонов]]
 
 
* Пара шаблонов {{tl|doc-inline}} и {{tl|doc-end}}
 
* Пара шаблонов {{tl|doc-inline}} и {{tl|doc-end}}
  

Версия 14:26, 27 марта 2018

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

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

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

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

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

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

См. также

TemplateData

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

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

У шаблона есть предопределенный формат.

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

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный
22

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный
33

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный
44

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный
55

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный
Editsectioneditsection

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный
SUBJECTPAGENAMESUBJECTPAGENAME

без описания

По умолчанию
пусто
Пример
пусто
Авто-значение
пусто
Неизвестнонеобязательный