Справочная Gamepedia

Добро пожаловать на русскоязычный раздел Справочной Gamepedia! Этот проект только ещё начинается, в нём сделана лишь мизерная часть того, чего требуется. Но он непременно будет развиваться. Если вы хотите помочь зарождающейся справочной — то смело включайтесь в дело!

ПОДРОБНЕЕ

Справочная Gamepedia
AttemptToCallNil (обсуждение | вклад)
AttemptToCallNil (обсуждение | вклад)
м
Строка 13: Строка 13:
 
=== тип ===
 
=== тип ===
   
Задаёт «тип» документированной страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий.
+
Задаёт «тип» документируемой страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий.
   
 
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно.
 
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно.
Строка 29: Строка 29:
 
=== плохдок ===
 
=== плохдок ===
   
Подобно параметру <code>нетдок</code>, этот параметр используется для указания страниц, у которых '''есть''' документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией]].
+
Подобно параметру <code>нетдок</code>, этот параметр используется для указания страниц, у которых '''есть''' документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией|Шаблоны с плохой документацией]].
 
<includeonly>
 
<includeonly>
 
<!-- Здесь следует размещать категории и интервики шаблона-->
 
<!-- Здесь следует размещать категории и интервики шаблона-->

Версия 13:31, 16 октября 2014

Это страница документации, её следует включить в основную страницу этого шаблона. Для дополнительной информации см. Шаблон:Документация.

Lua logo.svg
Этот шаблон использует Модуль:Документация, написанный на языке программирования Lua.
Пожалуйста, просмотрите wikipedia:Wikipedia:Lua и mw:Extension:Scribunto (обе англ.) для понимания работы модуля.

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

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

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

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

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

тип

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

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

страница

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

нетдок

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

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

плохдок

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