Help:RU/Editing Guidelines

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
[[{{{image}}}|link=|]] Важное примечание: Эта вики, более старой версии (1.36.2), функциональные возможности описанные в справочных страницах Mediawiki, могут быть не работоспособны.

Прежде чем вы посодействуете Multi Theft Auto Wiki, вы должны изучить/понять основы MediaWiki. Эта статья, является руководством, как правильно редактировать MTA Wiki.

Редактирование страниц

Главная справочная страница MediaWiki: Редактирование страниц
[[{{{image}}}|link=|]] Примечание: Не дублируйте содержимое если вы хотите его использовать на нескольких страницах, используйте шаблоны, что-бы содержимое можно было изменять одновременно на всех страницах.

Малые изменения

Сделайте пометку "малые изменения", если изменения между отредактированной и предыдущей версией, лишь поверхностные: вроде исправления ошибок, форматирования и изменений вида, перестроения текста без его модификации, и т.п. Малое изменение является версией, которой верит редактор без её просмотра, и она не становится предметом обсуждения. Опция "малые изменения", это первое что становится доступно зарегистрированным пользователям.

Редактирование страниц функций/событий

Формат страницы функции

Специфическая информация для редактирования MTA вики.

Оглавление страниц Функций/событий

Страницы функций и событий, имеют легко идентифицируемый и последовательный формат. Прежде чем добавлять страницы функций и/или событий, убедитесь что они есть в ядре MTA или хотя-бы есть ли такая страница на английском(посмотрите кто её добавил, во вкладке история).

Формат страницы функции
  • Не показывать содержание: __NOTOC__
  • Для указания функции клиента и/или сервера:
    • Функция сервера: {{RU/Server function}}
    • Функция клиента: {{RU/Client function}}
    • Функция клиента и сервера: {{RU/Server client function}}
  • Объясните функцию
  • Синтаксис: для выделения кода используйте <syntaxhighlight lang="lua"></syntaxhighlight>
    • Обязательные параметры
    • Необязательные параметры (не всегда нужно)
  • Возвращает
  • Примеры
  • Смотрите также: добавьте шаблон чтобы сгруппировать это содержимое.
Формат страницы события
  • Не показывать содержание: __NOTOC__
  • Для указания события клиента или сервера:
    • Событие сервера: {{RU/Server event}}
    • Событие клиента: {{RU/Client event}}
  • Параметры
  • Источник: источник события.
  • Пример
  • Смотрите также

События могут быть серверными или клиентскими, но не одновременно.

Советы
  • При создании новой страницы для функции или события, вам нужно редактировать шаблон для 'смотрите также' тоже. Если вы не будете добавлять функцию/событие к групповому шаблону, эта страница - окажется сиротой.
  • Когда вы не хотите добавлять пример, добавьте вначале страницы: {{RU/Needs Example}}.
  • Если вы добавили пример на страницу, уберите ссылку на шаблон, {{RU/Needs Example}}.

Примеры скриптов

[[{{{image}}}|link=|]] Примечание: При написании примера скрипта, обязательно проверяйте и тестируйте ваш пример на работоспособность, если он не будет работать вы отнимите время всех.
  • Предпочтительно использовать четыре пробела, вместо табуляции.
  • Используйте подсветку кода, предусмотренную на этой вики. (<syntaxhighlight lang="lua">(Вводите код сюда)</syntaxhighlight>)
  • Если событие или функция, является одновременно серверной и клиентской, используйте шаблон для выделения:
    • Примеров на серверной стороне: <section name="Пример 1" class="server" show="true"></section>
    • Примеров на клиентской стороне: <section name="Пример 2" class="client" show="false"></section>

Когда событие/функция, только серверная или клиентская, вы не должны использовать шаблон для выделения.

Если есть уже достаточно примеров скриптов, уберите {{RU/Needs Example}} или [[Category:Needs Example]].

Шаблоны

Главная справочная страница MediaWiki: Шаблоны

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

[[{{{image}}}|link=|]] Подсказка: Если вы хотите убрать оглавление страницы, используйте __NOTOC__ перед другими шаблонами и/или волшебные словами, т.е. лучше если это будет первым словом на странице.

Использование шаблонов рекомендуется, если используемое содержимое, повторяется на множестве страниц. Это сохраняет ваше время, на изменении одного и того же содержимого, и позволяет менять его одновременно на всех страницах.

Защищенные страницы

Защищенные страницы не могут быть изменены обычными пользователями, если вам необходимо изменить такую страницу, обратитесь к тому есть права для их редактирования.[1]

Страницы-сироты

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

Иконки

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

Полезные ссылки

Ссылки