Minecraft Wiki:Руководство по стилю

В этом документе рассматриваются рекомендации и указания по стилю и оформлению статей Minecraft Wiki.

Введение

Целью этого руководства является устранение возможных противоречий в плане того, как должны быть написаны статьи для Minecraft Wiki. Вопросы могут возникнуть как из-за недостатка информации, так и из-за отсутствия единого мнения о том, каких правил придерживаться. Кроме того, это руководство даёт представление новичкам о том, как следует писать статьи.

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

Прежде чем приступить к написанию статьи, следует выяснить, соответствует ли её предмет критериям значимости. Если не соответствует, то либо статья не может быть написана, либо стоит добавить содержимое в другую статью, близкую по теме. Кроме того, для статьи необходимо выбрать название, соответствующее требованиям именования.

Текст статьи

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

Текст статей следует писать в научном стиле от третьего лица. При этом следует избегать использования непонятной терминологии без разъяснения её значения (в этом случае полезен шаблон {{Всплывающий текст}}). С другой стороны, следует избегать жаргонных и просторечных выражений. В случае необходимости обращения к читателям (чаще всего в руководствах) допустимо использовать местоимение «вы», а при доказательстве утверждений возможно использование глаголов 1-го лица множественного числа (допустим, предположим и т. д.).

Содержимое статьи должно как можно шире охватывать свою тему, отражая все возможные нюансы обсуждаемого предмета. С другой стороны, не должно быть отклонений от темы. Содержимое, представляющее собой полное руководство, должно быть выделено в отдельную статью (см. Minecraft Wiki:Значимость#Другие виды статей).

MCW:ПРОВЕРЯЕМОСТЬ
MCW:ПРОВ

Информация должна быть проверяемой. Если речь идёт не о тривиальном факте, который можно подтвердить внутри игры или программы, то следует выделить ссылку на источник факта с помощью тегов <ref></ref>, а внизу статьи создать раздел «Примечания» с использованием одноимённого шаблона {{Примечания}}. Точно так же выделяются и собственно вставные примечания к тексту статьи. Количество используемых в статье домыслов и неподтверждённых фактов должно сводиться к минимуму; при необходимости их использования следует точно давать понять о том, что они не подтверждены. Список официальных источников располагается здесь.

Не допускаются явные грамматические и орфографические ошибки в тексте. См. также раздел Орфография и грамматика.

Историческая информация и ожидаемые изменения

Содержимое статей об элементах игры, программы или модификации должно отражать последнее полное обновление. Допускается упоминание изменений, планируемых в следующей невыпущенной версии, если они подтверждены разработчиками или реализованы в публично выпущенной предварительной сборке. В этом случае информация о них может быть помечена шаблоном {{Запланированный}} с указанием версии, а при большом количестве текста — выделена в отдельный раздел «Ожидаемые изменения». Если сам предмет статьи недоступен в последнем полном обновлении игры или модификации, но статья про него может быть создана, то вверху неё следует установить шаблон {{Запланированное}} или {{Предварительное}}.

Информация, касающаяся истории описываемого предмета статьи, а равно актуальная только для предыдущих версий игры, программы или модификации, должна помещаться в особый раздел «История» (см. Структура статей). Если предмет статьи неактуален как таковой, то вверху статьи следует установить шаблон {{Устаревшее}}; статья при этом должна отражать состояние последней версии, при которой предмет был актуален. Недопустимо смешение в одном месте информации о различных версиях, так как она может отвлечь или, что ещё хуже, запутать читателя.

При выпуске каждого нового полного обновления следует проводить обновление информации. Шаблоны, связанные с версиями, следует переставить или удалить в зависимости от результата обновления, а устаревшую информацию (если таковая есть) перенести в раздел «История».

Сторонний контент

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

Касательно описания взаимодействия одной модификации со свойствами элемента из другой правил пока не установлено.

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

В начале основных статей о стороннем контенте или статей, представляющих собой список стороннего контента, необходимо размещать шаблон {{Отказ от ответственности}}.

Оформление статей

Статьи должны быть оформлены качественно, чтобы повысить их читаемость и улучшить восприятие.

Форматирование и типографика

Для выделения обычного текста следует использовать курсивное начертание. Полужирным начертанием следует выделять только первое упоминание названия описываемого термина в статье. Комбинацию этих начертаний, а также нестандартные виды регистра вроде MINECRAFT (за исключением аббревиатур, таких как ССИС или МФСУ) или MiNeCrAfT использовать нельзя.

Ручное переопределение цвета текста допустимо только в следующих случаях:

в широко используемых шаблонах общего назначения, в целях цветового кодирования элементов ограниченным множеством неярких цветов. Примеры:
- {{Достоинства}} и {{Недостатки}} (используются для облегчения читателям перехода к ключевой информации);
- {{Таблица выбора}} (используется в таблицах, обычно сортируемых, чтобы более наглядно отображать различия между разными объектами одного класса, например в шаблоне {{Таблица разрушаемости}});
в целях представления использующегося в игре цветового кодирования на вики. Примеры:
- {{Слот}} (всплывающая подсказка может использовать цветовое оформление).

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

Если заголовок статьи целиком является таким названием, используйте шаблон {{Курсив}}.
При необходимости выделить курсивом только часть заголовка, используйте ключевое слово {{DISPLAYTITLE}}, например {{DISPLAYTITLE:Книги о ''Minecraft''}}.

Рекомендуется использование в тексте типографских символов:

В качестве кавычек рекомендуется использовать символы « и » (« и »), а для внутренних кавычек — символы „ и “ (&bdquo; и ”). Машинописные кавычки " следует использовать в программном коде.
Для символа апострофа (используется в иноязычных названиях) рекомендуется использовать символ ’ (’). Машинописный апостроф ' используется в вики-коде для форматирования, а также в программном коде.
Рекомендуется использовать символ длинного тире — (—). Перед ним желательно использовать вместо обычного пробела неразрывный пробел ( ).

Автоматическую замену машинописных символов на типографические, а также некоторые прочие мелкие изменения можно сделать с помощью викификатора.

Разделы статьи начинаются с заголовков 2-го уровня (== Заголовок ==). Уровни заголовков разделов определяются количеством символов «равно» с каждой стороны названия раздела. Следует увеличивать уровень заголовка вместе с глубиной раздела. Заголовок 1-го уровня (= Заголовок =) автоматически добавляется программным обеспечением сайта в качестве заголовка всей статьи; добавлять такие заголовки вручную не следует.

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

Для дат в тексте следует использовать формат ДД ммм ГГГГ [г.] (например, 18 марта 2010, 4 ноября 2017 г.) Использовать фрагмент «г.» не обязательно, но рекомендуется. Для дат в сортируемых таблицах следует использовать формат ГГГГ-ММ-ДД (например, 2010-03-18, 2017-11-04), причём для дня и месяца обязательно следует использовать по две цифры — это облегчит сортировку таблиц по датам.

Орфография и грамматика

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

Использование буквы Ё обязательно везде, где она может использоваться. Замена букв Ё на Е (так называемая «деёфикация») недопустима.

Названия объектов игры или её модификаций (блоков, предметов, мобов, биомов, построек и природных образований), не являющиеся именами собственными, обязательно должны писаться в соответствии с правилами, принятыми для имён нарицательных (песчаник, звезда Нижнего мира, чешуйница, столовая гора, город Края, ущелье). Именами собственными являются названия измерений (Верхний мир, Нижний мир, Край; то же самое относится к измерениям из модификаций). В оригинальной локализации игры (en-US, американский английский), как правило, для названий используется регистр, где каждое слово начинается с прописной буквы, вне зависимости от того, имя собственное ли это или нет (например, End Stone, Wither Skeleton) — в русском языке такое не принято (указанные примеры переводятся как камень Края, скелет-иссушитель).

Названия чар, эффектов, режимов игры всегда пишутся в кавычках с заглавной буквы и в именительном падеже (чар «Острота IV», в режиме «Творчество», от эффекта «Регенерация»). Названия этапов разработки игры (кроме официального релиза игры), такие как Indev, Alpha, Beta, пишутся также с заглавной буквы и не переводятся на русский язык.

Отдельные слова, связанные с тематикой Minecraft, требуют особого внимания при написании:

крафт (не «крафтинг»);
спаун (не «спавн»; то же самое относится к производному слову спаунер);
чары (не «зачарования»);
модификация (не «мод»);
дополнение (не «аддон», являющееся транслитерацией английского слова add-on).

Ссылки

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

Количество ссылок не должно составлять более 10 % от всего текста статьи.
Следует избегать размещения ссылок на различные статьи друг рядом с другом таким образом, что внешне они выглядят как одна ссылка, если это не ухудшит восприятие текста.
Следует избегать излишних ссылок на одну и ту же статью, так как это может, во-первых, отвлечь читателя, а во-вторых, вызвать ложное впечатление того, что это ссылки на разные статьи. Между ссылками на одну и ту же статью следует выдерживать расстояние, но не слишком большое. Рекомендуется оставлять по одной ссылке на одну и ту же статью на один или небольшое количество разделов, если они маленькие, чтобы читатели, попавшие через ссылки из других статей на конкретные разделы, смогли не тратить время на поиск ссылок на термин.
Следует при возможности использовать сокращённый синтаксис ссылок с дописыванием окончания сразу после закрывающих скобок ([[кирпич]]ей вместо [[кирпич|кирпичей]]). Если используемая в тексте форма термина, для которого есть статья, совпадает с формой его именительного падежа (например, не хватает зелья — форма родительного падежа единственного числа совпадает с формой именительного падежа множественного числа), то лишнее переопределение текста ссылки (не хватает [[зелья|зелья]]) делать не стоит.
Для ссылки на статьи об элементах модификаций существует особый шаблон {{Короткая ссылка}}, по вариантам использования схожий с обычными ссылками (в частности, он также поддерживает дописывание окончания). Например: {{с|алмаз|gt}}ы → алмазы.
Допустимо ссылаться на перенаправления ([[одуванчик]]и, при этом страница Одуванчик перенаправляет на статью Цветы), если только не используется синтаксис изменения текста ссылки ([[статья|текст]]) и если ссылка размещается не на шаблоне или иной включаемой странице. С другой стороны, не следует забывать о том, что при наведении курсора мыши (для компьютеров) на ссылку отображается всплывающий текст с названием статьи, что полезно, например, при расшифорвке аббревиатур; в этом случае предпочтительно ссылаться прямо на статью, а не создавать перенаправление (например, {{с|универсальная жидкостная капсула|ic2|УЖК}} → УЖК). Обратное, впрочем, иногда тоже верно — так, страница IndustrialCraft 2/Пепел перенаправляет на отдельный раздел статьи IndustrialCraft 2/Твердотопливный теплогенератор, однако лучше (и проще) при упоминании пепла ссылаться именно на пепел, хотя особенности склонения этого слова не позволяют использовать простой синтаксис дописывания окончания ({{с|пепел|ic2|пепла}} → пепла).

Иллюстрации, схемы и видеофайлы

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

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

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

Изображения, показывающие устаревшее содержимое, должны быть либо обновлены, либо помещены в подраздел галереи «История» (см. Галерея), либо удалены.

Для отображения схематических изображений из блоков, схем из красного камня или иных схематических изображений рекомендуется при возможности не загружать новые файлы, а использовать шаблоны {{Схема}}, {{БлокСетка}}, {{Многослойная схема}} и им подобные.

Использование видеофайлов регулируется особыми правилами.

Цитаты

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

Для вставки цитат используется шаблон {{Цитата}}. Возможно добавление изображения источника (фотографию человека, аватарку сотрудника Mojang Studios, эмблему организации) слева от текста цитаты. Вставка оригинала цитаты (если она на иностранном языке) на данный момент шаблоном не поддерживается.

Объём цитат не должен превышать одной трети от всего объёма текста.

Прочее

Если существует необходимость добавления содержимого, которое не должно быть показано сразу при открытии страницы, но которое может быть отображено позднее, то такое содержимое должно быть помещено в раскрывающуюся таблицу (CSS-класс collapsible collapsed) или раскрывающийся контейнер, такой как шаблон {{Спойлер}}. Если таблица должна иметь возможность раскрытия и сокрытия, но содержимое должно быть показано сразу, то для неё следует использовать класс collapsible, без collapsed.

Структура статей

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

Введение статьи

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

Ведро — инструмент, используемый для сбора, переноски и установки жидкостей.

При указании происхождении термина или оригинального названия его следует указать в скобках (само оригинальное название должно при этом быть выделено курсивом): крафт (от англ. craft — ремесло).

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

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

Дёрн - один из первых появившихся в игре блоков. Изначально дёрн появляется на верхнем слое земли.

В Indev дёрн погибал, если над ней располагался любой непрозрачный блок или жидкость. С Beta, благодаря динамическому освещению, дёрн может расти в частичной темноте. По физическим свойствам идентична земле, добыча травы также приводит к выпадению блока земли. Дёрн растёт не только при солнечном свете, но и при свете факелов, что позволяет «провести» его в любое уютненькое подземельице. Для роста требуется уровень света не менее 4. Дёрн может быть добыт инструментом с зачарованием Шелковое касание и установлен в Нижнем мире.

После Halloween Update, при добавлении биомов, дёрн стал иметь разный цвет в различных биомах. При этом только верхняя сторона имела цвет биома, цвет травы же на боках блока оставался сочно зеленым. Это было исправлено в обновлении Beta 1.5 (однако на низких настройках графики это до сих пор не исправлено), также в этом обновлении изменился цвет травы на более реалистичный и красивый.

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

Дёрн — один из первых появившихся в игре блоков, генерирующийся в качестве верхнего слоя земли.

С другой стороны, обратное тоже недопустимо. Развивая пример выше, следует отметить, что введение в виде «Дёрн — это блок» также не подходит, так как не указывает основное значение предмета статьи.

Перед текстом введения размечаются различные шаблоны в следующем порядке:

индикаторы состояния страницы;
карточки;
информационные шаблоны (плашки);
шаблоны разрешения неоднозначности, такие как {{О}} или {{НеодСсылка}}.

Виды статей

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

Страницы разрешения неоднозначности

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

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

Значения перечисляются в маркированных списках. Если имеется статья, объясняющая то или иное значение, то ссылка на неё обязательна.

Страницы разрешения неоднозначности должны быть помечены в заключении шаблоном {{Неоднозначность}}.

На Википедии есть более подробное описание средств разрешения неоднозначности.

Основные разделы

В основных разделах указывается описание предмета статьи.

Значительная часть разделов специфична для определённого вида статей. Для полного их списка см. Виды статей.

Галерея

Галерея содержит изображения, связанные с темой статьи, но не расположенные в других её разделах.

Для создания галереи необходимо использовать тэг gallery:

<gallery> Изображение 1.png|Изображение 1 Изображение 2.png|Изображение 2 </gallery>

Если галерея состоит преимущественно из скриншотов (наиболее типичный случай) или иных файлов с соотношением сторон, далёким от квадратного (чаще всего 16:9 или 4:3), то для улучшения читаемости следует использовать галереи с режимом packed (mode="packed"):

<gallery mode="packed"> Изображение 1.png|Изображение 1 Изображение 2.png|Изображение 2 </gallery>

Перед размещением изображений в галереях необходимо ознакомиться с положением об иллюстрациях.

Интересные факты

В разделе «Интересные факты» помещаются сведения, которые не входят в рамки остальных разделов.

В разделе не должны присутствовать домыслы или чьи-то мнения.
Факты должны быть именно интересными — они должны предоставлять информацию, которая читателям мало известна, но может вызвать у них интерес. Слишком очевидные факты не допускаются.
Исторические факты не допускаются (они должны размещаться в разделе «История», если таковой существует).
Факты о внешнем виде элемента игры или модификации указывать не рекомендуется. Если они не относятся к тому пакету ресурсов, который используется в игре или модификации по умолчанию, то приводить их вообще недопустимо.

Заключение

В заключении размещаются ссылки на прочие статьи, близкие по теме, сноски с примечаниями, категории и ссылки на аналогичные статьи в других языковых разделах (интервики).

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

После раздела «См. также» (если он существует) размещается раздел «Примечания». Здесь помещается шаблон {{Примечания}}, который отображает все сноски на статье. С помощью параметров можно расположить сноски в несколько колонок ({{Примечания|2}}, {{Примечания|3}} и т. д.). Раздел «Примечания», если он существует, должен быть самым последним в статье.

После всех разделов располагаются в следующем порядке:

навигационные шаблоны;
функция парсера {{DEFAULTSORT:}}, используемая при необходимости указать другое название для сортировки в списках статей (например {{DEFAULTSORT:Бергенстен, Йенс}});
категории (например, [[Категория:Твёрдые блоки]]);
ссылки на статьи в других разделах (интервики-ссылки), например [[en:Chicken]] или [[de:Huhn]]. Они будут добавлены на боковую панель слева. Рекомендуется размещать интервики в алфавитном порядке по кодам языков.

Примечания

Некоторые положения руководства по стилю были скопированы из версии страницы правил Minecraft Wiki от 16:50, 17 октября 2017 года (история) и из версии черновика участника AttemptToCallNil от 15:01, 27 марта 2016 года (история). Все времена, указанные в этом пункте, московские (UTC+3).