Справочная Gamepedia

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

ПОДРОБНЕЕ

Справочная Gamepedia
AttemptToCallNil (обсуждение | вклад)
Dand0 (обсуждение | вклад)
(Перевод)
Строка 1: Строка 1:
 
{{Документация/Шапка|плохдок=1}}
 
{{Документация/Шапка|плохдок=1}}
 
{{Lua}}
 
{{Lua}}
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.
+
Для шаблон впишите <code><nowiki><noinclude>{{subst:doc}}</noinclude></nowiki></code> в конец шаблона, потом сохраните страницу, это вставит <code>{<nowiki/>{documentation}}</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:doc}}</code> при создании страницы или позже добавлены в <code>{<nowiki/>{documentation}}</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.
+
Устанавливает «тип» документации, то есть к примеру шаблон, модуль, сообщение и так далее. Параметр будет использован как часть нескольких сообщений, которые может использовать шаблон, так же как и категоризация. <!-- Не понял предложение. Оригинал: 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 ===
+
=== нетдок ===
   
  +
Если шаблон не имеет документации и вы не знаете, как его использовать, добавте {{Код|nodoc=1}}на страницу документации этого шаблонаe. Задний фон станет красным и станет более заметчивым и будет автоматически добавлена в категорию [[:Категория:Шаблоны без документации]], если это шалон.
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 ===
+
=== плохдок ===
   
  +
Как и {{Код|nodoc}}, этот параметр используется, чтобы пометить шаблоны, которые '''имеют''' документацию, но она не очень качественна. Это может иметь ввиду, что шаблон не имеет достаточно примеров, не объясняет все функции как следует, или не объясняет назначение шаблона должным образом. Задний фон документации станет жёлтым, чтобы быть более заметчивым, и страница будет добавлена в категорию [[:Категория:Шаблоны с плохой документацией]], если это шаблон.
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>
 
<!-- Здесь следует размещать категории и интервики шаблона-->
 
<!-- Здесь следует размещать категории и интервики шаблона-->

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

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

Документация этого шаблона была отмечена как плохая. Пожалуйста, дополните или улучшите её.

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

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

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

Документация будет автоматически добавлена в категорию Категория:Документация.

Необязательные параметры

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

тип

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

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

страница

Страница, на которой находится документация. По умолчанию, название подстраница — «док».

нетдок

Если шаблон не имеет документации и вы не знаете, как его использовать, добавте Шаблон:Кодна страницу документации этого шаблонаe. Задний фон станет красным и станет более заметчивым и будет автоматически добавлена в категорию Категория:Шаблоны без документации, если это шалон.

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

плохдок

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