wiki
This page contains an outdated translation of the original content. Please check the English version for the most accurate information (and consider updating the translation if you are able to help out)!

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

См. также: Содержание статей

Локали

Примечание: osu! wiki показывает версию статьи на языке, выбранном в настройках сайта. Если перевода не существует, будет показана английская версия.

Ниже приведён список локалей, поддерживаемых osu! wiki:

Имя файла статьи Язык Самоназвание языка
en.md Английский English
ar.md Арабский اَلْعَرَبِيَّةُ
be.md Белорусский Беларуская мова
bg.md Болгарский Български
ca.md Каталанский Català
cs.md Чешский Česky
da.md Датский Dansk
de.md Немецкий Deutsch
el.md Греческий Ελληνικά
es.md Испанский Español
fi.md Финский Suomi
fil.md Филиппинский Wikang Filipino
fr.md Французский Français
he.md Иврит עִבְרִית
hu.md Венгерский Magyar
id.md Индонезийский Bahasa Indonesia
it.md Итальянский Italiano
ja.md Японский 日本語
ko.md Корейский 한국어
lt.md Литовский Lietuvių kalba
nl.md Нидерландский Nederlands
no.md Норвежский Norsk
pl.md Польский Polski
pt.md Португальский Português
pt-br.md Бразильский португальский Português (Brasil)
ro.md Румынский Română
ru.md Русский Русский
sk.md Словацкий Slovenčina
sl.md Словенский Slovenščina
sr.md Сербский Српски
sv.md Шведский Svenska
th.md Тайский ไทย
tr.md Турецкий Türkçe
uk.md Украинский Українська мова
vi.md Вьетнамский Tiếng Việt
zh.md Упрощённый китайский 简体中文
zh-tw.md Традиционный китайский (тайваньский) 繁體中文(台灣)

Метаданные

Все дополнительные сведения о статье, называемые метаданными, или сборным листом (front matter), помещаются в самое её начало. Они пишутся в формате YAML и отделяются тройными дефисами (---) с обеих сторон, после чего идёт пустая строка.

Статьи на доработку

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

Если статью нужно переоформить, дополнить или переписать, к ней необходимо добавить пометку needs_cleanup:

needs_cleanup: true

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

Устаревшая информация

Примечание: по возможности не переводите статьи с этим тегом. Если тег есть у оригинала, он должен быть и у перевода.

Если оригинал перевода был обновлён или английская статья содержит неактуальную или ошибочную информацию, к ним нужно добавить пометку outdated:

outdated: true

Старайтесь оставить в теле статьи комментарии с пояснением, что именно требуется обновить, чтобы можно было убрать эту пометку.

Устаревший перевод

Если вы изменяете содержание английской статьи, а перевод — нет (стилистические правки, исправление опечаток и прочее — не в счёт), то к переводу нужно добавить метку outdated_translation:

outdated_translation: true

Помимо этого, нужно указать хэш коммита, в котором была сделана влияющая на содержание правка, с помощью метки outdated_since:

outdated_since: 29eac89cd535f8b071ca000af8fe4f0be22bdc9b

Ключевые слова (теги)

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

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

tags:
  - beatmap discussions
  - modding V2
  - MV2
  - моддинг карт
  - система моддинга
  - моддинг V2

Непроверенный перевод

Примечание: этот тег ставят администраторы osu! wiki перед тем, как влить изменения.

Бывает так, что перевод статьи добавляется в osu! wiki без проверки носителями языка. В этом случае на него ставится пометка no_native_review, чтобы предупредить остальных о возможной необходимости проверки:

no_native_review: true

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

См. также: имена директорий и заголовок статьи

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

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


Исключение из этого правила — статьи про конкурсы и турниры: в названии директории используется сокращение, а в названии статьи — полная расшифровка.

Файловая структура

Имена директорий

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

В названиях директорий разрешены только следующие символы:

  • Строчные и заглавные латинские буквы;
  • Цифры;
  • Подчёркивания (_);
  • Дефисы (-);
  • Восклицательные знаки (!).

Имена файлов статей

Формат названий описан в разделе про локали. Кроме того, перевод должен храниться в той же директории, что и оригинал.

Индексные статьи

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

Статьи с определениями

Если термин или явление имеет несколько значений, для него стоит создать статью со списком возможных расшифровок. Такая статья должна храниться в директории /wiki/Disambiguation, откуда на неё должна быть поставлена ссылка.
После этого необходимо исправить имеющиеся перенаправления, чтобы они указывали на свежесозданную статью.

Пример статьи с определениями: Неоднозначность/Мод.

Все статьи с расшифровками должны содержать выноску «Другие значения».

HTML

В оформлении статей запрещено использовать любые HTML-теги, за исключением комментариев.

Комментарии

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

Пример:

HTML-комментарии<!-- TODO: написать объяснение получше --> нужны, чтобы составлять планы по доработке статей.

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

Перевод строки

Примечание: если файлы Markdown используют CRLF для перевода строки, при загрузке через GitHub это поведение сохранится.

Файлы Markdown должны использовать последовательность LF для перевода строки (это поведение можно настроить в вашем текстовом редакторе).

Экранирование разметки

Символы, которые используются в Markdown для управления разметкой, можно экранировать, если их нужно отобразить «как есть». Экранирование необходимо только в тексте статьи, но не в её названии. Перед каждым таким символом нужно поставить обратный слэш (\). Пример:

* [Red\_Pixel](https://osu.ppy.sh/users/4170932) is playing [kors k - Playing With Fire (Sota Fujimori Remix) (xlni) \[Pyrotechnics\]](https://osu.ppy.sh/beatmapsets/202252#osu/478605) (osu!)

Параграфы

Параграфы должны отделяться друг от друга одной пустой строкой.

Переводы строк

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

Выноски

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

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

Основная статья

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

*Основная статья: {ссылка на статью}*

*Основные статьи: {ссылка на статью} и {ссылка на другую статью}*

См. также

Выноска, которая содержит ссылку на статью по связанной теме. Она должна начинаться со слов См. также. Пример:

*См. также: {ссылка на статью}*

*См. также: {ссылка на статью} и {ссылка на другую статью}*

Подробнее о

Разновидность выноски «См. также», которая содержит ссылку на подробную статью (или несколько), раскрывающую текущий раздел более развёрнуто. Она обычно начинается со слов Подробнее о. Пример:

*Подробнее о {каком-то явлении}: {ссылка на статью}*

Предмет статьи

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

# Игровой модификатор

*Эта статья — о различных игровых механиках. О поиске недочётов в карте см. [Моддинг](/wiki/Modding).*

Другие значения

Выноска, которая нужна для связи похожих терминов. Она всегда ссылается на статью значений. Пример:

*У этого термина существуют и другие значения, см. {название явления} (значения).*

Примечание

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

Примеры:

*Примечание: имя pippi пишется со строчной буквы «p», так же как и peppy.*

*Внимание: эта кнопка работает без подтверждения.*

*Предупреждение: [правила osu!](/wiki/Rules) запрещают иметь более одного аккаунта!*

Использование нескольких выносок и примечаний

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

*Внимание: {что-нибудь, требующее внимания}.*\
*См. также: {ссылка на статью}*

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

Форматирование текста

Полужирный шрифт

Чтобы придать тексту полужирное начертание, используйте двойные звёздочки (**). Старайтесь выделять не отдельные слова, а фразы — так их проще заметить.

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

Курсив

Чтобы применить курсив, используйте одинарные звёздочки (*). Курсивом выделяются названия игр и произведений (например, песен или изображений), за исключением osu!, а также первое упоминание аббревиатуры или сокращения.

Помимо перечисленного, курсив служит для выделения логического ударения.

При упоминании песен вся конструкция вида {исполнитель} — {название} является названием произведения и должна быть выделена курсивом:

После запуска osu! можно услышать одну из трёх музыкальных тем, среди которых встречается *cYsmix - triangles*.

Имена исполнителей во всех прочих случаях курсивом не выделяются, так как являются самостоятельной частью предложения:

*Blue Zenith* от xi получила статус культовой песни после того, как один известный игрок поставил рекорд на одноимённой карте.

Курсив и ссылки

Ссылки и так выделяются за счёт отдельного цвета, и их не нужно выделять курсивом:

[Camellia - OOPARTS](https://cametek.bandcamp.com/track/parts) является примером песни, созданной специально для osu!, поскольку она была записана для тайбрейкера osu! World Cup 2020.

Тем не менее, курсив стоит добавить, если в ссылку входит не только название работы:

[Карта от Voltaeyx на *TheFatRat - Mayday (feat. Laura Brehm)*](https://osu.ppy.sh/beatmapsets/756794) обрела популярность в 2018 году из-за своих уникальных оверлапов.

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

Заголовки

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

Максимальный уровень вложенности заголовков — 5.

Заголовок статьи

См. также: Названия статей
Примечание: в названиях статей не должно применяться экранирование, поскольку в них не используется разметка.

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

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

Разделы

Заголовки разделов должны быть на уровне от 2 до 5. В них также нельзя использовать форматирование или ссылки, но допускается наличие небольших иконок.

Уровень вложенности заголовков должен увеличиваться без пропусков: например, нельзя после заголовка уровня 2 вставлять заголовок уровня 4.

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

Нестандартные ссылки

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

## Время кулдауна прошло. Как подать апелляцию? {id=appeal}

## Various examples of osu! gameplay {id=osu!-gameplay}

Идентификатор можно вставить в произвольное место статьи, чтобы на неё можно было дать ссылку:

> That's it! You're well on your way to becoming an osu! rhythm champion!
{id=tutorial-quote}

Списки

Максимальный уровень вложенности в списках — 4. Между элементами списка не должно быть пустых строк.

Если список вложенный, каждый новый уровень должен быть выровнен по началу предыдущего.

Неправильно:

1. Заварить чай.
 - вскипятить воду;
  - поставить чайник;
 - бросить пакетик;
 - отойти подальше.
2. Выпить чай.

Правильно:

1. Заварить чай.
   - вскипятить воду;
     - поставить чайник;
   - бросить пакетик;
   - отойти подальше.
2. Выпить чай.

Ненумерованные списки

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

- osu!:
  - Нота:
    - номер в комбо,
    - сужающийся круг.
  - Слайдер:
    - голова и тело,
    - тело слайдера,
    - слайдертики.
  - Спиннер.
- osu!taiko:
  - ...

Пунктуация в конце элементов списка расставляется по следующим правилам:

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

Нумерованные списки

Номер каждого следующего элемента в списке должен увеличиваться на 1. Пример:

1. Скачайте установщик osu!.
2. Запустите установщик.
   1. Чтобы выбрать директорию установки, кликните по тексту под индикатором прогресса.
   2. Выберите желаемую директорию.
3. osu! запустится после завершения установки.
4. Войдите в аккаунт.

Смешанные списки

Используйте подобные списки только при необходимости.

1. Скачайте скин.
2. Загрузите скин в osu!.
   - Если скин имеет формат `.zip`, распакуйте его и переместите содержимое в директорию `Skins` внутри директории osu!;
   - Если скин имеет формат `.osk`, дважды кликните по нему или перетащите в окно osu!.
3. Откройте osu! и выберите скин в списке настроек.
   - Этот шаг можно пропустить, если скин имел формат `.osk`.

Код (моноширинный шрифт)

Часть элементов статей должна быть оформлена в виде кода. Для этого оберните текст в обратный апостроф, (`). Если вам нужно использовать обратный апостроф в коде, окружите его двойными обратными апострофами и пробелами:

Найдите на клавиатуре клавишу `` ` `` и сильно на неё нажмите. Раздастся щелчок.

Сочетания клавиш

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

При упоминании сочетаний клавиш используйте заглавные буквы для одиночных букв и/или символов. Названия модификаторов также пишутся с заглавной буквы. Сами названия клавиш объединяются через плюс (+). Пример:

Имя pippi пишется со строчной буквы «p», так же как и peppy.

Нажмите `Ctrl` + `O`, чтобы открыть диалог выбора.

Пробел правильно упоминать так: `Пробел`.

Названия кнопок и прочих элементов меню

Описывая содержимое меню или название элемента управления, сохраняйте регистр:

Если у вас есть саппорт, справа в главном меню будет расположена кнопка `osu!direct`.

Названия директорий

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

По умолчанию osu! будет установлена в директорию `AppData/Local`, если не выбирать другой путь.

Ключевые слова и команды

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

В настоящее время поля `Name` и `Author` в файле настроек скина (`skin.ini`) ни для чего не используются.

Названия файлов

Сохраняйте регистр написания имён файлов. Пример:

Чтобы запустить osu!, дважды кликните по файлу `osu!.exe`.

Расширения файлов

Примечание: форматы файлов (не путать с расширениями) пишутся заглавными буквами и не начинаются с точки.

Расширения файлов должны начинаться с точки (.) и содержать имя расширения, написанное строчными буквами. Пример:

Файлы формата JPEG обычно имеют расширения `.jpg` или `.jpeg`.

Названия каналов чата

Название канала чата должно начинаться с решётки и быть написано строчными буквами. Пример:

В этом канале запрещено общаться на русском языке, перейдите в `#russian`.

Блоки кода

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

Ссылки

См. также: сноски

В osu! wiki используется два типа ссылок: встроенные и выносные.

Примеры встроенных ссылок:

[Игровые модификаторы](/wiki/Gameplay/Game_modifier)

<https://osu.ppy.sh/home>

Пример выносной ссылки (обратите внимание на скобки):

[Игровые модификаторы][game mods link]

[game mods link]: /wiki/Game_modifier

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

Внутренние ссылки

Примечание: внутренние ссылки ведут на страницы, которые расположены в домене https://osu.ppy.sh.

Вики-ссылки

Любые ссылки, ведущие на статьи на вики, должны начинаться с /wiki/, после чего следует путь до статьи без имени файла. Также можно использовать относительные ссылки. Примеры:

[Правила](/wiki/Rules)
[pippi](/wiki/Mascots#-pippi)
[Карты](../)
[Паттерн](./Pattern)

Вики-ссылки не должны содержать перенаправления или иметь слэш на конце.

Неправильно:

[Критерии оформления статей](/wiki/ASC)
[Разработчики](/wiki/Developers/)
[Разработчики](/wiki/Developers/#game-client-developers)

Правильно:

[Критерии оформления статей](/wiki/Article_styling_criteria)
[Разработчики](/wiki/People/Developers)
[Разработчики](/wiki/People/Developers#game-client-developers)
Ссылки на вложенные статьи

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

*См. также: [Редактор карт/Дизайн](/wiki/Client/Beatmap_editor/Design)*
Ссылки на разделы

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

В ссылках на разные разделы внутри статьи можно использовать символ параграфа (§), чтобы отделить название статьи от раздела:

*Подробнее о правилах тайминга: [Критерии ранкинга § Тайминг](/wiki/Ranking_criteria#тайминг)*

Другие страницы osu! web

Вставляйте полную ссылку на страницу, например, https://osu.ppy.sh/community/chat.

Профили игроков

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

Ссылка на профиль должна содержать идентификатор игрока, а текст ссылки должен быть его текущим ником. Чтобы получить правильную ссылку, откройте профиль игрока через новый сайт (https://osu.ppy.sh/users/{username}).

Сложности

Ссылаясь на отдельную сложность, используйте текст такого формата:

{artist} - {title} ({creator}) [{difficuty_name}]

Ссылка, в свою очередь, должна вести на конкретную сложность и иметь вид https://osu.ppy.sh/beatmapsets/{BeatmapSetID}#{mode}/{BeatmapID}. Имя сложности можно оставить за пределами ссылки, но такой стиль должен быть использован по всей статье.

Карты

Ссылаясь на карту в целом, используйте текст такого формата:

{artist} - {title} ({creator})

Ссылка при этом должна иметь вид https://osu.ppy.sh/beatmapsets/{BeatmapSetID}.

Внешние ссылки

Примечание: внешние ссылки ведут на страницы, не расположенные в домене https://osu.ppy.sh.

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

Чтобы обозначать различие между внутренними и внешними ссылками, указывайте название сайта во всплывающей подсказке. Пример:

*Подробнее о теории музыки: [Теория музыки](https://ru.wikipedia.org/wiki/Теория_музыки)*

Изображения

Ссылки на изображения могут быть двух типов: встроенные и выносные. Примеры:

Встроенная ссылка

![Золотая корона](/wiki/shared/crown-gold.png "Первое место")

Выносная ссылка

![Золотая корона][GCrown]

[GCrown]: /wiki/shared/crown-gold.png "Первое место"

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

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

Альтернативный текст и подписи

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

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

Отображение

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

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

::: Infobox
![](img/mod-response.png "Пример ответа на мод-пост")
:::

Кэширование изображений

Изображения, загруженные на osu! wiki, кэшируются на срок до 60 дней, причём сравнение происходит не по содержимому, а по его адресу.

Из этого следует, что при обновлении изображения нужно либо его переименовывать, либо дописывать параметры типа ?1 к ссылке на изображение внутри статьи. Это необходимо сделать во всех статьях, которые на него ссылаются.

Форматы и качество

Большинство изображений в osu! wiki должны храниться в формате JPG с уровнем качества 8 (в некоторых графических редакторах — 80%). Используйте формат PNG, если в изображении есть прозрачность или текст, читаемость и внешний вид которого важно сохранить. Если необходимо вставить анимацию, можно использовать формат GIF. Стоит учесть, что анимированные изображения в целом имеют бо̀льший размер и замедляют загрузку страницы.

Размер файла

Размер изображения должен быть строго меньше одного мегабайта, в противном случае оно не будет показано. Это требование почти всегда можно выполнить, уменьшив картинку и понизив её уровень качества где-нибудь до 80%.

Старайтесь максимально оптимизировать изображения. В этом может помочь утилита jpeg-archive, которую для единообразия результатов рекомендуется запускать так:

jpeg-recompress -am smallfry <input> <output>

Помимо jpeg-recompress, конвертировать и оптимизировать изображения можно через сервис ezgif.com.

Имена изображений

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

Чтобы разделять слова в имени изображения, используйте дефисы (-). Старайтесь давать изображениям короткие, но содержательные имена.

Сами изображения должны находиться в поддиректории img, расположенной в директории статьи. В случае, когда изображение используется в нескольких статьях, оно должно находиться в директории /wiki/shared/.

Максимальная ширина

osu! wiki масштабирует изображения, ширина которых превышает ширину страницы, поэтому их лучше сжать самостоятельно. Старайтесь умещать ширину изображений в 800 пикселей.

Аннотации

Чтобы нанести на изображение поясняющий текст, используйте шрифт Torus Regular. Если в тексте есть китайские, корейские или японские иероглифы, используйте шрифт Microsoft YaHei.

Старайтесь использовать аннотации как можно реже, чтобы не добавлять работы остальным редакторам и переводчикам osu! wiki.

Перевод аннотаций

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

  • hardrock_mod_vs_easy_mod.jpg (оригинал);
  • hardrock_mod_vs_easy_mod-RU.jpg (русская версия);
  • hardrock_mod_vs_easy_mod-ZH-TW.jpg (перевод на традиционный китайский).

Скриншоты игрового процесса

Все скриншоты должны быть сделаны в стабильной версии osu!. Исключение — игровые элементы, которые туда не добавлены (например, режим Target Practice). Чтобы сделать скриншот, используйте встроенную функциональность osu! (F12).

Игровые настройки

Примечание: если вы не хотите изменять свои настройки ради osu! wiki, сделайте копию файла osu!.<ComputerUser>.cfg, а потом верните её на место.
Примечание: язык в настройках можно поменять на язык статьи, для которой делаются скриншоты.

Делайте скриншоты osu!, пользуясь указанными ниже настройками (все остальные параметры должны быть выставлены в значения по умолчанию):

  • Select language: English;
  • Prefer metadata in original language: Enabled;
  • Resolution: 1280x720;
  • Fullscreen mode: Disabled;
  • Parallax: Disabled;
  • Menu tips: Disabled;
  • Seasonal backgrounds: Never;
  • Always show key overlay: Enabled;
  • Current skin: Default (первая опция);

Ссылки и изображения

Изображения не должны быть вставлены в текст ссылок.

Флаги

Для вставки флагов используйте следующий синтаксис:

::{ flag=XX }::

Здесь XX — двухбуквенный код страны по ISO 3166-1 alpha-2.

Таблицы

Для таблиц в osu! wiki заголовки можно указывать только в первой строке.

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

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

  • :-- (выравнивание по левому краю);
  • :-: (выравнивание по центру);
  • --: (выравнивание по правому краю);

Пример таблицы:

| Красная команда | Очки | Синяя команда | Средняя сложность карт |
| :-- | :-: | --: | :-- |
| **peppy** | 5 - 2 | pippi | 9.3 звёзд |
| Aiko | 1 - 6 | **Alisa** | 4.2 звёзды |
| Ryūta | 3 - 4 | **Yuzu** | 5.1 звёзд |
| **Taikonator** | 7 - 0 | Tama | 13.37 звёзд |
| Maria | не участвовали | Mocha |  |

Инфобокс

Инфобокс — это блок фиксированного размера, который расположен справа на странице. В него можно поместить изображение, которое иллюстрирует раздел или параграф, или блок навигации со ссылками на другие статьи из той же категории.

Пример использования (результат см. справа, либо внизу, если экран узкий):

Значок мода Sudden Death

::: Infobox
![](/wiki/shared/mods/SD.png "Значок мода Sudden Death")
:::

В некоторых ситуациях от инфобокса лучше отказаться:

  • Если раздел статьи слишком короткий, то заголовок следующего раздела появится только после инфобокса, а значит, в статье будет большая «дыра».
  • Если вы хотите вставить несколько изображений сразу, лучше каждое из них завернуть в отдельный инфобокс: так статья будет опрятнее смотреться.

Внутри инфобоксов стоит использовать только заголовки 4 и 5 уровней: их не будет видно в оглавлении статьи, а ещё все остальные заголовки слишком крупные. Чтобы статья прошла прекоммитные проверки, их, скорее всего, понадобится отключить.

Сноски

Сноски — это короткие примечания, приведённые в конце статьи. Они используются для ссылок на источники информации, а также содержат поясняющие комментарии, которые нельзя вставить прямо в текст статьи. В сносках можно использовать ссылки и форматирование.

В osu! wiki сноски реализованы с помощью специального синтаксиса ([^identifier]). В качестве идентификатора можно использовать, в принципе, что угодно: в статье сноски будут показаны как числа, идущие в порядке возрастания по мере их появления. В переводах статьи должны использоваться такие же идентификаторы, как в оригинале.

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

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

Примеры:

osu! wiki — проект, пришедший на замену системе FAQ.[^wiki-faq] Его назвали в честь ритм-игры osu![^osu] и крупнейшей онлайн-энциклопедии — Википедии. С самого начала в работе над osu! wiki участвуют опытные переводчики[^wiki-tl] и редакторы.

## Ссылки

[^wiki-faq]: https://osu.ppy.sh/community/forums/topics/68525
[^wiki-tl]: https://osu.ppy.sh/community/forums/posts/1177500
[^osu]: https://osu.ppy.sh/community/forums/posts/1178153

Ссылки на источник

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

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

Примеры:

Первая версия osu!api увидела свет 2 июля 2013 г.[^api-first-usage] и была высоко оценена пользователями.[^api-praise] Новая версия API, выпущенная несколькими годами позднее, предоставляла больше возможностей.[^api-v2-2020] Версионирование API — стандартная практика среди веб-сервисов.[^web-api]

## Ссылки

[^api-first-usage]: [«osu!api open beta», тема от peppy, 02.07.2013](https://osu.ppy.sh/community/forums/posts/2403913)
[^api-praise]: [Пост от Menchi в теме «osu!api open beta», 02.11.2013](https://osu.ppy.sh/community/forums/posts/2662247)
[^api-v2-2020]: [Твит @ppy, 20.03.2020](https://twitter.com/ppy/status/1263083636363948032)
[^web-api]: [Web API — Википедия](https://en.wikipedia.org/wiki/Web_API)

Примечания

Сноски можно использовать для пояснительных комментариев, которые плохо вписываются в текст статьи или не являются настолько же важными. У них нет единого формата.

Пример:

Неопытные и непроверенные игроки не должны участвовать в организации турнира.[^staff]

## Примечания

[^staff]: *Неопытным* называется тот игрок, который в сумме потратил на osu! менее часа своей жизни.

Блоки цитирования

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

> plz enjoy game

rrtyui

Горизонтальная черта

Горизонтальная черта служит для разделения двух разнотипных параграфов. Наиболее частые сценарии использования включают:

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

Чтобы провести горизонтальную черту, используйте три дефиса, отделённые от остального текста пустой строкой с каждой стороны:

Смеркалось. Вдалеке запел зяблик.

---

«Чтобы подтвердить профиль в osu!, скачайте и запустите игровой клиент», — пробормотал Дмитрий.