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

Текущая версия от 05:28, 14 июля 2022

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

Шаблон documentation включен в документацию по шаблону/модулю. Этот шаблон следует использовать только на подстраницах с названием «doc».

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

Поместите {{documentation}} вверху страницы документации.

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

Шаблон попытается автоматически обнаружить и связать вызовы {{#Invoke:}} с документацией шаблона или require()/ mw.loadData() список зависимостей в документации модуля. Если вы хотите подавить автоматически сгенерированный список зависимостей, используйте {{documentation}}

Примечание

Этот шаблон ссылается на /doc, который может показаться бесполезным, однако он существует для того, чтобы связать навигационные и пользовательские ящики с документацией их базового шаблона.

TemplateData

Шаблон документации включен в документацию по шаблону/модулю. Этот шаблон следует использовать только на подстраницах с названием "doc".

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

@@ Строка 1: / Строка 1: @@
-{{Doc}}
+{{Documentation}}
-Этот шаблон используется для создания инструкций к шаблонам и модулям.
+Шаблон '''documentation''' включен в документацию по шаблону/модулю. Этот шаблон следует использовать только на подстраницах с названием «doc».
-==Использование==
+== Использование ==
-# Наберите <pre><nowiki><noinclude></nowiki>{{/doc}}<nowiki></noinclude></nowiki></pre> в конце страницы шаблона, для которой необходима инструкция.
+Поместите {{t|documentation}} вверху страницы документации.
-# Поместите <pre>{{doc}}</pre> на самом верху страницы с документацией.
-===Пример документации===
+Если страница для документирования является подстраницей, используйте {{t|documentation|имя страницы для документирования}} вверху страницы документации. Например, страница документации Template:Foo/bar будет использовать {{t|documentation|Template:Foo/bar}}.
-<pre>
-Описание. Этот шаблон используется для чего-то.
-==Использование==
-Наберите <code>{{t|название шаблона}}</code>.
-===Пример===
-Например, если набрать <code>&lt;nowiki>{{название шаблона|абв}}&lt;/nowiki></code>, получится
-{{название шаблона|абв}}
-<includeonly>Категории, в которые следует включить сам шаблон</includeonly><noinclude>[[Категория:Документация шаблонов|{{PAGENAME}}]]</noinclude>
+Шаблон попытается автоматически обнаружить и связать вызовы <code><nowiki>{{#Invoke:}}</nowiki></code> с документацией шаблона или <code>require()</code>/<code> mw.loadData()</code> список зависимостей в документации модуля. Если вы хотите подавить автоматически сгенерированный список зависимостей, используйте {{t|documentation|DependencyList=no}}
-</pre>
-==TemplateData==
+== Примечание ==
+Этот шаблон ссылается на /doc, который может показаться бесполезным, однако он существует для того, чтобы связать навигационные и пользовательские ящики с документацией их базового шаблона.
+<includeonly></includeonly>
+== TemplateData ==
 <templatedata>
 {
 	"params": {},
-	"description": "Этот шаблон используется только на подстраницах с пометкой \"doc\"."
+	"description": "Шаблон документации включен в документацию по шаблону/модулю. Этот шаблон следует использовать только на подстраницах с названием \"doc\"."
 }
 </templatedata>
-<includeonly>[[Категория:Основные шаблоны|{{PAGENAME}}]]</includeonly><noinclude>[[Категория:Документация шаблонов|{{PAGENAME}}]]</noinclude>