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

Версия от 09:16, 31 января 2021

Это подстраница документации для Шаблон:Doc.Он содержит информацию об использовании, категории и другой контент, который не является частью исходной страницы template.

Этот шаблон используется для создания инструкций к шаблонам и модулям.

Использование

Наберите <noinclude>{{doc}}</noinclude> в конце страницы шаблона, для которой необходима инструкция.
Поместите {{doc}} на самом верху страницы с документацией.

Если документированная страница является подстраницей, используйте {{doc|<название страницы>}} в самом верху страницы документации. Например, документация для страницы Шаблон:Foo/bar будет указана, как {{doc|<Шаблон:Foo/bar>}}.

Пример документации

;Описание.
:Этот шаблон используется для чего-то.
;Использование. 
:Наберите <code>{{t|название шаблона}}</code>.
;Пример.
:Например, если набрать <code><nowiki>{{название шаблона|абв}}</nowiki></code>, получится
:{{название шаблона|абв}}

<includeonly>Категории, в которые следует включить сам шаблон</includeonly><noinclude>[[Категория:Документация шаблонов|{{PAGENAME}}]]</noinclude>

TemplateData

Этот шаблон используется только на подстраницах с пометкой "doc".

Параметры шаблона
Параметр		Описание	Тип	Статус
Не указано ни одного параметра

@@ Строка 1: / Строка 1: @@
-{{Documentation}}
+{{Doc}}
-Шаблон '''documentation''' включен в template/module документацию. Этот шаблон используется только на подстраницах с пометкой "doc".
+Этот шаблон используется для создания инструкций к шаблонам и модулям.
 ==Использование==
-Поместите {{t|documentation}} на самом верху страницы с документацией.
+# Наберите <code><nowiki><noinclude></nowiki>{{t|doc}}<nowiki></noinclude></nowiki></code> в конце страницы шаблона, для которой необходима инструкция.
+# Поместите {{t|doc}} на самом верху страницы с документацией.
-If the page to be documented is a subpage, use {{t|documentation|pagename of page to be documented}} at the top of the documentation page. Например, документация страницы Шаблон:Foo/bar должен быть указан, как {{t|documentation|Шаблон:Foo/bar}}.
+Если документированная страница является подстраницей, используйте {{t|doc|название страницы}} в самом верху страницы документации. Например, документация для страницы Шаблон:Foo/bar будет указана, как {{t|doc|Шаблон:Foo/bar}}.
-The template will attempt to auto detect and link <code><nowiki>{{#Invoke:}}</nowiki></code> calls on template documentations or the <code>require()</code>/<code>mw.loadData()</code> depedency list on module documentations. If you want to supress the auto generated dependency list, use {{t|documentation|DependencyList=no}}
+===Пример документации===
+<pre>
+;Описание.
+:Этот шаблон используется для чего-то.
+;Использование.
+:Наберите <code>{{t|название шаблона}}</code>.
+;Пример.
+:Например, если набрать <code>&lt;nowiki>{{название шаблона|абв}}&lt;/nowiki></code>, получится
+:{{название шаблона|абв}}
-==Заметка==
+<includeonly>Категории, в которые следует включить сам шаблон</includeonly><noinclude>[[Категория:Документация шаблонов|{{PAGENAME}}]]</noinclude>
-This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.
+</pre>
-<includeonly></includeonly>
 ==TemplateData==
@@ Строка 17: / Строка 25: @@
 {
 	"params": {},
-	"description": "Шаблон документации включен в template/module документацию. Этот шаблон используется только на подстраницах с пометкой \"doc\"."
+	"description": "Этот шаблон используется только на подстраницах с пометкой \"doc\"."
 }
 </templatedata>