User:RMN/Formatting

From Miranda NG
Jump to navigation Jump to search
Todo: Finish; add recommendations for English at least.

A draft of recommendations on formatting articles in this wiki.

Russian

In a nutshell: (1) «angle quotes» instead of "typewriter quotes"; (2) em dash () with spaces, not en dash (–).

Quotation marks

In Cyrillic typography «angle quotes» are used instead of "typewriter quotes", e.g.

  • статусы «Отсутствую» и «Недоступен»
  • знак «;»
  • функция «Системная история»
  • уведомление «Пользователь в сети»

The same applies to English words used in Cyrillic text (if the rules require quotes):

  • статус «translatable»
  • режим «Big Picture»
  • слово «miranda»
  • секция «File Transfers»..

In case of nested quotes (i.e. quotes inside quotes) „…“ is used:

  • значок «Уведомление „В сети“»
  • опция «Интервал перевода в „Невидимый“»

Dashes

Traditionally Cyrillic script uses only one kind of dash: em dash () with spaces around it. En dash (–) is allowed in ranges:

  • в пределах 10–300 секунд

since em dash looks a bit strange there. Note that no spaces should be used around the dash in ranges.

Template Button

Template {{Button}} is used to format Miranda interface buttons (no quotation marks reqiured):

  • нажмите OK
  • нажмите кнопку Загрузка
  • скопировать отчёт, нажав Копировать в буфер

Please use {{Button}} only for buttons with text, do not use it for "icon-buttons". For buttons with icons the word кнопка is used followed by its name that you can read in tooltip when the button is hovered with the mouse pointer (sometimes the name of corresponding icon is used), enclosed in «»:

  • кнопка «Помощь»
  • кнопка «Модернизация»
  • кнопка «Информация о пользователе»

Template Menu

Template {{Menu}} is used to format Miranda menu selections (no quotation marks reqiured). Do not use {{Menu}} for bracketed English menu selections when they follow their Russian equivalents (no need to italicize them):

  • откройте Настройки → Тонкая настройка → Языки (Options → Customize → Languages)
  • откройте Настройки → Тонкая настройка → Меню (Options → Customize → Menus)
  • заходите в Список контактов → Поведение → Парковать (Contact List → Behavior → Dock to sides)

Miranda interface element names: italicize or not

Miranda interface elements, namely tab names in options and option/setting names, checkboxes, radio buttons and menu item names are enclosed in «» and italicized. Usually they are preceeded by words вкладка, галка, опция, настройка, пункт which helps to easily recognize them:

  • вкладка «Основные настройки»
  • галка «Принимать RTF»
  • галка «Автовход»
  • опция «Версия в разработке»
  • настройка «Сокращённые ссылки для вложений с аудио»
  • настройка «Use remote message timestamps»
  • пункт «Перезапуск»

This formatting is also applied when such a name occur without any preceeding words but its belonging to tab / option / setting names, etc. is clear form the context:

  • выберите «Компоненты для установки» в главном меню (menu item is meant)
  • «Уведомления о дружбе» отделены от «Других событий» в настройках уведомлений (changes in Facebook settings described)

Like menu selections, bracketed English interface elements names are not italicized when they follow their Russian equivalents:

  • пункт «Обновлять значки» (Update Icons)
  • галка «Разрешать передачу файлов только внутри потока» (Accept only in band incoming filetransfers)
  • опция «Не открывать окно чата при входе в чат-комнату» (Do not pop up the window when joining a chat room)

The rest of Miranda interface elements preceeded by words значок (icon), переключатель (switch), поле (field), статус (status), окно (window), выпадающий список (drop-down list) and others are not italicized:

  • значок «Информация»
  • переключатель «Звуки»
  • поле «Пароль»
  • статус «in meeting» (аналог статуса «Занят»)
  • хСтатус «Мобильный»
  • функция «Системная история»
  • уведомление «Пользователь в сети»

More examples:

  • раздел настроек «Статус»
  • страница настроек «Горячие клавиши»
  • секция «File Transfers»
  • группа «Настроить»
  • категория «Предустановленные сообщения»
  • выпадающий список «Запуск в служебном режиме с» (Start in Service Mode with)
  • список «Шаблон протокола»
  • окно «Список компонентов»
  • ошибка «Время отправки истекло»
  • сообщение «Контакта больше нет в списке на сервере»