Difference between revisions of "Guidelines (Русский)"

Line 9: Line 9:
 
Тем не менее, мы всецело разрешаем добавлять информацию о других вещах, которые попадают за пределы этих категорий.
 
Тем не менее, мы всецело разрешаем добавлять информацию о других вещах, которые попадают за пределы этих категорий.
  
Если вы собирайтесь, сделать серьезные изменения в вики например внедрение новой структуры для встроенных типов, не спешите. В начале вы ''обязаны'' осудить это с [[User:Rude|Rude]] в противном случае высока вероятность того, что ваши изменения будут отменены.
+
Если вы собирайтесь, внести серьезные изменения в вики например внедрение новой структуры для встроенных типов, не спешите. В начале вы ''обязаны'' осудить это с [[User:Rude|Rude]] в противном случае высока вероятность того, что ваши изменения будут отменены.
  
 
== Конфликт Имен ==
 
== Конфликт Имен ==

Revision as of 16:57, 20 February 2016

Все зарегистрированные пользователи могут редактировать Вики, но, пожалуйста, следуйте этим рекомендациям на предмет их соответствия. Если вы думаете, что они должны быть изменены, или должны содержать дополнительную информацию, пожалуйста, не стесняйтесь обращаться к Rude.

Цель

Основные цели вики заключаются в следующем.

  1. Документировать LÖVE API, а также предоставлять руководства, туториалы.
  2. Предоставлять информацию об играх и библиотек, использующих LÖVE.

Тем не менее, мы всецело разрешаем добавлять информацию о других вещах, которые попадают за пределы этих категорий.

Если вы собирайтесь, внести серьезные изменения в вики например внедрение новой структуры для встроенных типов, не спешите. В начале вы обязаны осудить это с Rude в противном случае высока вероятность того, что ваши изменения будут отменены.

Конфликт Имен

Чтобы избежать большого количества URL-адресов, страницы документации носят простые названия без префиксов или суффиксов. Например, тип Image может внешне отображаться виде http://love2d.org/wiki/Image.

Это может иногда привести к конфликту имен, и в этом случае страница документации всегда будут иметь приоритет. Если создать игру под названием Отлично, и LÖVE позже решит выставить тип с именем Отлично (маловероятно но не всегда), то ваша игра будет отображена по другому.

Стиль

Если вы говорите о типах встроенных в LÖVE, создайте на них ссылку. Например, Image это объект, который может быть отображен на экране.

При обращении к переменным и к блокам кода внутри обычного предложения используйте тэг <code> повысить удобочитаемость. Например: когда вы пишите foo и bar, результат будет таким foobar.

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

Страницы документации обязаны иметь одинаковую структуру если документация будет полезной.

Все страницы документации должны иметь семантическую ссылку на своего родителя в секции Смотрите также. Без этого, пункт не появится в автоматических списках на всей вики. Семантическая ссылка добавляется, в качестве функции, типа или переменной перечисления в love.audio (Русский):

[[parent::love.audio (Русский)]]

Все страницы документации также должны иметь семантическое, 'дружелюбное' описание. Это делается путем добавления следующего кода в конце страницы:

{{#set:Description=Рисует [[Image (Русский)]] на экране.}}

Модули

Для '2-го уровня' допускаются следующие заголовки, но их следует использовать, только если эти заголовки ничего не содержат.

  • Типы
  • Функции
  • Перечисления
  • Примечания
  • Примеры
  • Смотрите также

Все модули должны быть связаны с Category:Modules.

Типы

Для '2-го уровня' допускаются следующие заголовки, но опять же, не используйте их и оставляйте пустыми.

  • Функции
  • Перечисления
  • Родительские типы
  • Подтипы
  • Примечания
  • Примеры
  • Смотрите также

Все типы должны быть связаны с Category:Types.

Функции

Для функций, необходимы все заголовки, за исключением "Заметки", "примеры" и "Смотрите также". Это означает, что если функция ничего не возвращает, она должна напрямую сказать, что она ничего не возвращает. То же самое касается и аргументов.

Аналогичным образом, если нет конструктора для определенного типа(например Contact), это должно быть явно упомянуто.

Внешние элементы в списке ниже заголовков '2-го уровня' , а внутренние ниже заголовков '3-го уровня'.

  • Конструкторы
  • Функция
    • Краткое содержание
    • Аргументы
    • Возвращает
  • Примечание
  • Примеры
  • Смотрите также

Если функция перегружена, повторите заголовок "функция" для каждой перегрузки. Это не требуется для конечных дополнительных аргументов; вместо этого просто указывайте в скобках значение по умолчанию.

Аргументы и возвращаемые значения должны быть представлены в виде списка определений, используещего Template:param.

Все функции должны быть связаны с Category:Functions.

Перечисления

Для перечисления, допускается следующие заголовки:

  • Константы
  • Примечание
  • Смотрите также

Константы должны быть перечислены в виде четкого списка.

Все перечисления должен быть связан с Category:Enums.

Игры

Для игр, вы можете выбрать собственную структуру, но вы всегда должны добавлять некоторые семантические свойства страницы, чтобы страница правильно отображалась в Списке игр:

{{#set:Name=NoGame}} (Имя - должно быть такое же, как заголовок страницы)
{{#set:Author=User:Ivan}} (Имя автора игры)
{{#set:Genre=First person shooter}} (Жанр вашей игры)
{{#set:LOVE Version=0.6.1}} (Версия LÖVE)
{{#set:Description=First person shooter with tactical elements.}} (Краткое описание вашей игры)
{{#set:Screenshot=File:ScreenshotURL.png}} (Ссылка на скриншот игры)

Размер скриншота будет автоматически изменено на 161x100 пикселей.

Кроме того, поместите вашу игру под категорию Category:Games чтобы она автоматически появилась на странице Games. Чтобы поместить игру в правильную категории, добавьте эту строку в конце страницы.

[[Category:Games]]

Рекомендуется также, представить скриншоты вашей игры.

Библиотеки

Нет строгих правил, но как и для игр, вы должны добавить эти семантические свойства:

{{#set:LOVE Version=0.6.1}} (Версия вашей библиотеки)
{{#set:Description=A small and effective object-orientation framework.}} (Краткое описание вашей библиотеки)

Поместите вашу библиотеку под категорию Category:Libraries чтобы она автоматически появилась на странице Libraries. Чтобы поместить библиотеку в правильную категории, добавьте эту строку в конце страницы.

[[Category:Libraries]]

Другие языки