Справочная Gamepedia

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

ПОДРОБНЕЕ

Справочная Gamepedia
AttemptToCallNil (обсуждение | вклад)
(Отмена правки 227624)
м (13 версий импортировано)
 
(не показано 10 промежуточных версий 4 участников)
Строка 1: Строка 1:
{{Документация|плохдок=1}}
+
{{Документация/Шапка}}
 
{{Lua}}
 
{{Lua}}
  +
{{msgbox|некат=1
For templates, insert <code><nowiki><noinclude>{{subst:doc}}</noinclude></nowiki></code> at the end of the template, then save the page, this will place <code>{<nowiki/>{documentation}}</code> and a comment advising editors where to place categories and interwiki links. For other types of pages, the documentation template should already be there.
 
  +
|текст='''Инструкция по миграции с {{шс|Док}}'''
  +
<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> и комментарий, сообщающий редакторам, куда размещать категории и интервики. Для других типов страниц: шаблон документации уже должен быть там.
   
  +
Нажмите кнопку «Создать» в самом верху страницы, и откроется окно редактирования страницы документации с некоторым изначальным содержимым, облегчающим форматирование.
Click "create" at the top of the page and the documentation page will be opened with some pre-formatting.
 
   
  +
Страницы документации автоматически будут добавлены в категорию [[:Категория:Страницы документации|Страницы документации]].
Documentation pages will automatically be added to [[:Category:Documentation pages]].
 
   
  +
== Дополнительные параметры ==
== Optional parameters ==
 
   
This parameters can either be added to the <code>{<nowiki/>{subst:doc}}</code> template when creating the page, or added to the <code>{<nowiki/>{documentation}}</code> template afterwards.
+
Эти параметры могут быть добавлены как к шаблону <code>{<nowiki/>{subst:Док}}</code> при создании страницы, так и к шаблону <code>{<nowiki/>{Документация}}</code> после этого.
   
=== type ===
+
=== тип ===
   
  +
Задаёт «тип» документируемой страницы: модуль, шаблон, сообщение, и т. д. Это будет использовано в некоторых отображаемых шаблоном сообщениях, а также в названиях проставляемых категорий.
Sets the "type" of documentation this is, e.g. template, module, message, etc. This will be used as part of some messages the template might display, as well as categorisation.
 
   
  +
Тип задаётся автоматически в зависимости от того, в каком пространстве имён находится страница, поэтому обычно его переопределять не нужно.
The type is automatic based on the namespace, so it shouldn't generally need to be set.
 
   
=== page ===
+
=== страница ===
   
  +
Страница, где должна быть расположена документация. По умолчанию это подстраница текущей страницы с названием «док».
The page where the documentation should be. This defaults to a subpage of the current page called "doc".
 
   
=== nodoc ===
+
=== нетдок ===
   
  +
Если у шаблона нет документации, а вы не знаете, как его использовать, добавьте <code>нетдок=1</code> к шаблону Документация/Шапка на странице документации. Фон документации станет красным для увеличения заметности, и страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны без документации|Шаблоны без документации]].
If a template has no documentation and you don't know how to use it, add nodoc=1 to the documentation template on the documentation page. The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]], if it's a template.
 
   
  +
Этот параметр задаётся автоматически, если страница документации не существует, поэтому обычно его указывать не нужно.
This is automatically set if the documentation page doesn't exist, so this generally isn't necessary to set.
 
   
=== baddoc ===
+
=== плохдок ===
   
  +
Подобно параметру <code>нетдок</code>, этот параметр используется для указания страниц, у которых '''есть''' документация, но она низкого качества. Это может означать, что в документации недостаточно примеров использования, объяснены не все возможности или цель и методы использования документируемого шаблона. Чтобы увеличить заметность, цвет фона будет изменён на жёлтый, а страница, если она является шаблоном, будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией|Шаблоны с плохой документацией]].
Similar to nodoc, this is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template properly. The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]], if it's a template.
 
 
<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 к шаблону Документация/Шапка на странице документации. Фон документации станет красным для увеличения заметности, и страница, если она является шаблоном, будет добавлена в категорию Шаблоны без документации.

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

плохдок

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