AttemptToCallNil (обсуждение | вклад) |
Ivan-r (обсуждение | вклад) м (13 версий импортировано) |
||
| (не показано 7 промежуточных версий 4 участников) | |||
| Строка 1: | Строка 1: | ||
{{Документация/Шапка}} |
{{Документация/Шапка}} |
||
{{Lua}} |
{{Lua}} |
||
| + | {{msgbox|некат=1 |
||
| + | |текст='''Инструкция по миграции с {{шс|Док}}''' |
||
| + | <div style="text-align: left;"> |
||
| + | * '''В шаблоне:''' |
||
| + | ** '''Замените''' <code><nowiki><noinclude>{{/док}}</noinclude></nowiki></code> на <code><nowiki><noinclude>{{subst:Док}}</noinclude></nowiki></code>. |
||
| + | ** '''Переместите''' категории и интервики-ссылки в страницу документации (<code>/док</code>) внутрь тегов <code><nowiki><includeonly></nowiki></code>. |
||
| + | * '''На странице документации (<code>/док</code>):''' |
||
| + | ** '''Замените''' <code><nowiki>{{Док/начало}}</nowiki></code> на <code><nowiki>{{Документация/Шапка}}</nowiki></code>. |
||
| + | ** '''Удалите''' <code><nowiki>{{Док/конец}}</nowiki></code>. |
||
| + | * '''Дополнительные параметры:''' |
||
| + | ** '''Удалите''' <code>clear</code>; более не нужно. |
||
| + | ** '''Удалите''' <code>нетдок</code>; {{шс|Документация}} автоматически сделает это. |
||
| + | ** '''Удалите''' <code>плохдок</code>; если документация качественна. |
||
| + | </div> |
||
| + | }} |
||
Для шаблонов: вставьте <code><nowiki><noinclude>{{subst:Док}}</noinclude></nowiki></code> после кода шаблона и сохраните страницу. Это действие поместит <code>{<nowiki/>{Документация}}</code> и комментарий, сообщающий редакторам, куда размещать категории и интервики. Для других типов страниц: шаблон документации уже должен быть там. |
Для шаблонов: вставьте <code><nowiki><noinclude>{{subst:Док}}</noinclude></nowiki></code> после кода шаблона и сохраните страницу. Это действие поместит <code>{<nowiki/>{Документация}}</code> и комментарий, сообщающий редакторам, куда размещать категории и интервики. Для других типов страниц: шаблон документации уже должен быть там. |
||
| Строка 13: | Строка 28: | ||
=== тип === |
=== тип === |
||
| − | Задаёт «тип» |
+ | Задаёт «тип» документируемой страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий. |
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно. |
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно. |
||
| Строка 29: | Строка 44: | ||
=== плохдок === |
=== плохдок === |
||
| − | Подобно параметру <code>нетдок</code>, этот параметр используется для указания страниц, у которых '''есть''' документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией]]. |
+ | Подобно параметру <code>нетдок</code>, этот параметр используется для указания страниц, у которых '''есть''' документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией|Шаблоны с плохой документацией]]. |
<includeonly> |
<includeonly> |
||
<!-- Здесь следует размещать категории и интервики шаблона--> |
<!-- Здесь следует размещать категории и интервики шаблона--> |
||
Текущая версия на 12:24, 24 марта 2017
Это страница документации, её следует включить в основную страницу этого шаблона. Для дополнительной информации см. Шаблон:Документация.
 |
Этот шаблон использует Модуль:Документация, написанный на языке программирования Lua. Пожалуйста, просмотрите wikipedia:Wikipedia:Lua и mw:Extension:Scribunto (обе англ.) для понимания работы модуля. |
Инструкция по миграции с {{Док}}
|
Для шаблонов: вставьте <noinclude>{{subst:Док}}</noinclude> после кода шаблона и сохраните страницу. Это действие поместит {{Документация}} и комментарий, сообщающий редакторам, куда размещать категории и интервики. Для других типов страниц: шаблон документации уже должен быть там.
Нажмите кнопку «Создать» в самом верху страницы, и откроется окно редактирования страницы документации с некоторым изначальным содержимым, облегчающим форматирование.
Страницы документации автоматически будут добавлены в категорию Страницы документации.
Дополнительные параметры
Эти параметры могут быть добавлены как к шаблону {{subst:Док}} при создании страницы, так и к шаблону {{Документация}} после этого.
тип
Задаёт «тип» документируемой страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий.
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно.
страница
Страница, где должна быть расположена документация. По умолчанию это подстраница текущей страницы с названием «док».
нетдок
Если у шаблона нет документации, а вы не знаете, как его использовать, добавьте нетдок=1 к шаблону Документация/Шапка на странице документации. Фон документации станет красным для увеличения заметности, и страница, если она является шаблоном, будет добавлена в категорию Шаблоны без документации.
Этот параметр задаётся автоматически, если страница документации не существует, поэтому обычно его указывать не нужно.
плохдок
Подобно параметру нетдок, этот параметр используется для указания страниц, у которых есть документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию Шаблоны с плохой документацией.