Руководство по стилю
/File/en/Wiki/StyleGuide.png

Contents

На этой странице описана политика создания и правки статей вики OpenTTD.

Если вы ренее не редактировали вики-статьи, обратитесь к справке по редактированию страниц данной вики.

Очень важные правила

  1. Всегда подписывайтесь, когда оставляете комментарий. Используйте четыре тильды: "~~~~".
  2. Всегда используйте кнопку Preview/Предварительный просмотр перед сохранением страницы.
  3. Обращайтесь к этой странице при редактировании страниц.

Общие правила

Обсуждение

Код Результат
==Комментарии по теме==
содержание обсуждения ~~~~
:ответ ~~~~

Комментарии по теме


содержание обсуждения MeusH 11:21, 6 June 2007 (CEST)
ответ Zojj 11:21, 6 June 2007 (CEST)

Заголовки статей

Единственное и множественное число

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

Можно также создать страницу для единственного числа с перенаправлением на множественное:

#REDIRECT [[Поезда/Ru]]

Если возникают сомнения (что должно быть редко), используйте единственное число.

Заглавные буквы

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

Страницы на языках, отличных от английского

Заголовок статьи должен быть на том же языке, что и статья, причем он должен оканчиваться слешем / и кодом языка. Например:

За указателем статей на языках, отличных от английского, обращайтесь к категории Articles in other languages (en)

Тестовые страницы

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

Пространства имен

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

Содержимое статьи

Изображения

Используйте наиболее подходящий формат. Для графики из игры обычно лучше всего подходят файлы PNG. Типичный способ вставки изображения:

Код Результат
[[File:en/Archive/Manual/Settings/Longerbridges.png|frame|Подпись]]
Подпись

Аннотированные скриншоты

Как делать подписи на скриншотах

Если вы размещаете скриншоты, чтобы объяснить какие-то концепции OpenTTD или устройство развязок, вам следует свести к минимуму количество заметок в самом скриншоте, оставив на нем лишь метки, комментарии к которым следует дать в тексте. Метки следует выполнять контрастным цветом (для умеренного климата хорошо подходит белый), используя сглаженный жирный шрифт sans-serif на прозрачном фоне. При необходимости можно использовать стрелки, но лучше разместить метки рядом с местами, к которым они относятся. Данный подход продемонстрирован на рисунке справа (помните, что метки не обязаны быть в виде букв или цифр, лишь бы они не загромождали скриншот, а объяснение к ним давалось в основном тексте).

Скриншоты окон

Если вам нужно привести скриншот внутриигрового окна, постарайтесь вырезать его ровно по границе. Окна OpenTTD являются ровными прямоугольниками, так что это должно быть просто. При необходимости используйте увеличение.

Последовательности действий

Для выделения этапов используйте упорядоченные или неупорядоченые списки:

Код Результат
#шаг 1
#шаг 2
#* примечание к шагу 2
#* примечание к шагу 2

  1. шаг 1
  2. шаг 2
    • примечание к шагу 2
    • примечание к шагу 2

Версия игры

Сконцентрируйтесь на написании страниц руководства к последней версии игры, но не к ночным сборкам. Особенности ночных сборок могут обсуждаться на страницах, посвященных разработке. Если уж совсем никак нельзя обойти стороной какую-то фичу из ночной сборки, используйте плашку {{en/Nightly}}.

Внутриигровые кнопки, пункты меню и т.д.

Цитируя названия кнопок, пунктов меню, команд и т.п., используйте курсив, без кавычек. Например:

Чтобы изменить настройки патчей, кликните Configure Patches.

Использование "метаслов"

Избегайте использования слова вики и иных слов, относящихся к технической основе проекта, если на то нет существенной необходимости. То, что вы редактируете — документация, руководства и т.д. Вики — лишь способ доставки контента и, в идеале, вообще не должна упомянаться.

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

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

Патчи

Используйте оформление, как на странице Longer bridges (en).

Шаблоны

Формат шаблонов

Используйте тот же формат, как и в шаблоне {{ru/Версия разработчиков}}. Распишите инструкции для других пользователей!

Используйте цветовую схему, наиболее подходящую сообщению, которое вы хотите донести: красный — для грядущих потрясений (типа удаления статьи), желтый — для предупреждения, зеленый — для текущих задач, синий — для информационных сообщений.

Общие шаблоны

Основная статья: Общие шаблоны

Категории

Формат категорий

Используйте тот же формат, что и в случае Requests for deletion (en).

Добавление статьи в категорию

Добавьте свою в одну-две категории, если она к ним подходит. Это упрощает поиск.

Разместите код в самом низу статьи.

[[category:categoryname]]

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

Сценарии

Инструкции даны здесь: Scenarios Team (en)#procedure-to-add-a-scenario. Размещайте сценарии в соответствующем пространстве имен:

Смотрите также