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

Текущая версия от 13:58, 12 июня 2024

Документация	[просмотр] [править] [история] [обновить]

Шаблон для автоматического добавления документации на страницы шаблонов.

Другие названия этого шаблона: {{Documentation}}, {{Template doc}}, {{Документация}}, {{Dokumentation}}.

Включает для текущего шаблона подстраницу с документацией. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным. Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.

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

<noinclude>{{doc}}</noinclude>

При этом на странице шаблона Шаблон:Имя шаблона отображается его документация — соответствующая подстраница Шаблон:Имя шаблона/doc, если она создана, или сообщение об отсутствии документации со ссылкой к её созданию, если не создана.

К шаблону можно добавить документацию от другого шаблона. Для этого надо указать в коде шаблона {{doc}}, добавляемого в шаблон, полное имя нужной страницы документации. Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. Например, чтобы добавить к шаблону Шаблон:Имя шаблона страницу документации от шаблона Шаблон:Имя шаблона 2, нужно в код шаблона Шаблон:Имя шаблона добавить:

<noinclude>{{doc|Шаблон:Имя шаблона 2/doc}}</noinclude>

Страница от шаблона Шаблон:Имя шаблона 2 будет добавлена в Шаблон:Имя шаблона, если она существует.

Частью шаблона {{doc}} являются подшаблоны {{doc/begin}} и {{doc/end}}. Приглашение создать отсутствующую документацию задаётся с помощью шаблона {{Документируйте}}.

См. также {{docpage}} — шаблон, добавляемый на страницы документации.

Шаблоны для документирования шаблонов ↑ [+]
Ссылки на шаблоны	{{T}} {{Tl}} {{Tlp}} {{Tls}} {{Днш}}
Документация	{{Doc}} {{Template doc begin}} {{Docpage}} {{Doc-inline}} {{Doc-end}} {{Документируйте}} {{Noinclude}}
Ссылки/навигация	{{Template navigation}} {{Tlinks}} {{Lts}} {{TRef}}
Демонстраторы кода	{{Tc}} {{Para}} {{Tlf}} {{Пример}}

@@ Строка 1: / Строка 1: @@
-<includeonly><templatestyles src="Шаблон:Doc/styles.css" />
+<includeonly>__NOEDITSECTION__<div
-<div class="ts-doc-doc" id="doc">
+style="
-<div class="ts-doc-header" id="Документация">
+  border:1px dotted #8BCBFF;
-<div class="ts-doc-heading">Документация</div>
+  background:#F0F8FF;
-{{#if: {{{inline|}}} || {{tlinks|lc={{{1}}}|nowatch=yes}} }}
+  margin-top:10px;
-</div>
+  padding:10px;
-<div class="ts-doc-content"></includeonly><noinclude>
+  clear:both;
-{{doc}}
+"><table
-</noinclude>
+bgcolor="transparent"
+cellpadding="0"
+cellspacing="0"
+width="100%"
+border="0"><tr><td
+align="left"
+nowrap
+style="
+  line-height:11pt;
+  font-size:11pt;
+">[[Файл:Wiki.png|20px|text-top|link=|alt=(i)|Документация]]&nbsp;Документация&nbsp;</td><td
+align="right"
+valign="middle"
+style="
+  padding-top:1px;
+">{{tlinks|lc={{{1}}}|diswatchlink=yes}}</td></tr><tr><td
+colspan="2"><hr></td></tr></table></includeonly><noinclude>[[Категория:Подстраницы шаблонов]]{{doc|{{ns:Template}}:Doc/doc}}</noinclude>