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

Данное руководство по стилю (MoS или MOS) представляет собой рекомендуемое руководство по стилю для VRChat Wiki.

В общем:

• Весь контент на Wiki VRChat должен быть правдивым и точным.
• Авторы должны писать статьи, используя простой, лаконичный, понятный язык, и структурировать статьи с помощью единообразных, удобных для читателя макетов и форматирования.
• Если у вас возникли вопросы по стилю, макету или форматированию VRChat Wiki, обратитесь за помощью к одному из модераторов сообщества.

Ниже подробно изложены несколько конкретных рекомендаций по стилю:

Названия статей

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

Инструкции по форматированию см. в разделе формат заголовка статьи, принимая во внимание следующее:

• Начинайте с заглавной буквы, но в остальном следуйте регистру sentence case. VRChat использует регистр sentence case для предложений, названий статей, названий разделов, заголовков таблиц, подписей к изображениям, записей в списках (в большинстве случаев), а также записей в информационных полях и подобных шаблонах, среди прочего.
• Не используйте артикли (a, an или the) в качестве первого слова (VRChat Creator Economy, а не The VRChat Creator Economy), если только они не являются неотъемлемой частью названия (The Black Cat) или заголовка произведения (The VRChat Times).
• Используйте существительные или словосочетания с существительными: Early life, а не In early life. Такие фразы, как In early life, приемлемы (хотя и не обязательны) в качестве заголовков разделов. Они также часто используются как часть длинных заголовков статей, таких как VRChat Events, особенно когда более короткая конструкция (Events) может иметь проблемы с двусмысленностью.
• Последний символ не должен быть знаком препинания, если только он не является неотъемлемой частью названия (например, Do Androids Dream of Electric Sheep?), или аббревиатурой (VRChat Inc.), или когда требуется закрывающая круглая скобка или кавычка (Fantastic Avatars (and where to find them)).
• Всякий раз, когда появляются кавычки или апострофы, добавляйте перенаправление для того же заголовка, используя апострофы. Избегайте использования фигурных кавычек, поскольку прямые кавычки и апострофы проще вводить и они надежнее отображаются на большинстве платформ.

Заголовки разделов

Заголовки разделов должны соответствовать указаниям по названиям статей (см. выше) и должны быть представлены в регистре sentence case (How to feed your VRCat), а не в регистре title case (How To Feed Your VRCat).

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

По техническим причинам заголовки разделов должны:

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

В целях соблюдения единого стиля заголовки разделов должны:

• Не следует избыточно ссылаться на тему статьи например Early life, а не Smith's early life или His early life.
• Не ссылайтесь на заголовок более высокого уровня, если только это не будет короче или понятнее.
• Не следует нумеровать или обозначать буквами, как в плане.
• Не следует формулировать как вопрос например Languages, а не What languages are spoken in Mexico?.
• Не используйте цветные или необычные шрифты, которые могут вызвать проблемы с восприятием.
• Не используйте разметку, которая может нарушить отображение и вызвать другие проблемы с восприятием.

English word choice and capitalization

In order to make localization of the wiki content easier in the long run, consider a few style choices such as these:

• Quotations, titles of works (books, films, etc.) should be capitalized as given in the source (but see Typographic conformity, below);
• Proper names use the subject's own spelling and capitalization, e.g., "...joint project of VRChat Inc. and VRChat Community Labs..."; "International Avatar Federation"
• Generally, do not capitalize the word the in mid-sentence: throughout the United Kingdom, not throughout The United Kingdom.
• Use universally accepted terms rather than those less widely distributed, especially in titles. For example, "glasses" is preferred to the national varieties spectacles (British English) and eyeglasses (American English); "Ten million" is preferable to "one crore" (Indian English).
• If a variant spelling appears in a title, make a redirect page to accommodate the others, as with "artefact" and "artifact", so that all variants can be used in searches and linking.
• Use a commonly understood word or phrase in preference to one that has a different meaning because of national differences (rather than "alternate", use "alternative" or "alternating", as appropriate), except in technical contexts where such substitution would be inappropriate ("alternate reality"; "alternate universe").