Документация/док

[обновить]

Эта страница документации, она должна быть включена в основную страницу. Больше информации на странице Шаблон:Документация.

Этот шаблон использует Модуль:Документация, написанный на языке программирования Lua.
Пожалуйста, просмотрите Википедия:Модули и Extension:Scribunto/ru для понимания работы модуля.

Инструкция по миграции с {{Док}}

В шаблоне:
- Замените <noinclude>{{/док}}</noinclude> на <noinclude>{{subst:Док}}</noinclude>.
- Переместите категории и интервики-ссылки в страницу документации (/док) внутрь тегов <includeonly>.
На странице документации (/док):
- Замените {{Док/начало}} на {{Документация/Шапка}}.
- Удалите {{Док/конец}}.
Дополнительные параметры:
- Удалите clear; более не нужно.
- Удалите нетдок; {{Документация}} автоматически сделает это.
- Удалите плохдок; если документация качественна.

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

Нажмите кнопку «Создать» в самом верху страницы, и откроется окно редактирования страницы документации с некоторым изначальным содержимым, облегчающим форматирование.

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

Содержание

1 Дополнительные параметры

Дополнительные параметры

Эти параметры могут быть добавлены как к шаблону {{subst:Док}} при создании страницы, так и к шаблону {{Документация}} после этого.

тип

Задаёт «тип» документируемой страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий.

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

страница

Страница, где должна быть расположена документация. По умолчанию это подстраница текущей страницы с названием «док».

нетдок

Если у шаблона нет документации, а вы не знаете, как его использовать, добавьте нетдок=1 к шаблону Документация/Шапка на странице документации. Фон документации станет красным для увеличения заметности, и страница, если она является шаблоном, будет добавлена в категорию Шаблоны без документации.

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

плохдок

Подобно параметру нетдок, этот параметр используется для указания страниц, у которых есть документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию Шаблоны с плохой документацией.