Справочная Gamepedia

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

ПОДРОБНЕЕ

Справочная Gamepedia
Dand0 (обсуждение | вклад)
(Перевод)
м (13 версий импортировано)
 
(не показано 8 промежуточных версий 4 участников)
Строка 1: Строка 1:
{{Документация/Шапка|плохдок=1}}
+
{{Документация/Шапка}}
 
{{Lua}}
 
{{Lua}}
  +
{{msgbox|некат=1
Для шаблон впишите <code><nowiki><noinclude>{{subst:doc}}</noinclude></nowiki></code> в конец шаблона, потом сохраните страницу, это вставит <code>{<nowiki/>{documentation}}</code> и комментарий редакторам куда ставить категории и интервики ссыллки. Для других типов страниц документационный шаблон уже должен быть.
 
  +
|текст='''Инструкция по миграции с {{шс|Док}}'''
  +
<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/>{subst:doc}}</code> при создании страницы или позже добавлены в <code>{<nowiki/>{documentation}}</code>.
+
Эти параметры могут быть добавлены как к шаблону <code>{<nowiki/>{subst:Док}}</code> при создании страницы, так и к шаблону <code>{<nowiki/>{Документация}}</code> после этого.
   
 
=== тип ===
 
=== тип ===
   
  +
Задаёт «тип» документируемой страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий.
Устанавливает «тип» документации, то есть к примеру шаблон, модуль, сообщение и так далее. Параметр будет использован как часть нескольких сообщений, которые может использовать шаблон, так же как и категоризация. <!-- Не понял предложение. Оригинал: This will be used as part of some messages the template might display, as well as categorisation. -->
 
   
Тип автоматически основывается на пространстве имён, поэтому в общем не следует указывать этот параметр.
+
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно.
   
 
=== страница ===
 
=== страница ===
   
Страница, на которой находится документация. По умолчанию, название подстраница «док».
+
Страница, где должна быть расположена документация. По умолчанию это подстраница текущей страницы с названием «док».
   
 
=== нетдок ===
 
=== нетдок ===
   
Если шаблон не имеет документации и вы не знаете, как его использовать, добавте {{Код|nodoc=1}}на страницу документации этого шаблонаe. Задний фон станет красным и станет более заметчивым и будет автоматически добавлена в категорию [[:Категория:Шаблоны без документации]], если это шалон.
+
Если у шаблона нет документации, а вы не знаете, как его использовать, добавьте <code>нетдок=1</code> к шаблону Документация/Шапка на странице документации. Фон документации станет красным для увеличения заметности, и страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны без документации|Шаблоны без документации]].
   
По умолчанию это ставится, если страницы документации не существует, поэтому в целом, этот параметр указывать не нужно.
+
Этот параметр задаётся автоматически, если страница документации не существует, поэтому обычно его указывать не нужно.
   
 
=== плохдок ===
 
=== плохдок ===
   
Как и {{Код|nodoc}}, этот параметр используется, чтобы пометить шаблоны, которые '''имеют''' документацию, но она не очень качественна. Это может иметь ввиду, что шаблон не имеет достаточно примеров, не объясняет все функции как следует, или не объясняет назначение шаблона должным образом. Задний фон документации станет жёлтым, чтобы быть более заметчивым, и страница будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией]], если это шаблон.
+
Подобно параметру <code>нетдок</code>, этот параметр используется для указания страниц, у которых '''есть''' документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией|Шаблоны с плохой документацией]].
 
<includeonly>
 
<includeonly>
 
<!-- Здесь следует размещать категории и интервики шаблона-->
 
<!-- Здесь следует размещать категории и интервики шаблона-->

Текущая версия на 12:24, 24 марта 2017

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

Lua logo.svg
Этот шаблон использует Модуль:Документация, написанный на языке программирования Lua.
Пожалуйста, просмотрите wikipedia:Wikipedia:Lua и mw:Extension:Scribunto (обе англ.) для понимания работы модуля.
Инструкция по миграции с {{Док}}
  • В шаблоне:
    • Замените <noinclude>{{/док}}</noinclude> на <noinclude>{{subst:Док}}</noinclude>.
    • Переместите категории и интервики-ссылки в страницу документации (/док) внутрь тегов <includeonly>.
  • На странице документации (/док):
    • Замените {{Док/начало}} на {{Документация/Шапка}}.
    • Удалите {{Док/конец}}.
  • Дополнительные параметры:
    • Удалите clear; более не нужно.
    • Удалите нетдок; {{Документация}} автоматически сделает это.
    • Удалите плохдок; если документация качественна.

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

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

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

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

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

тип

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

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

страница

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

нетдок

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

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

плохдок

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