Правила

Michael Pankov edited this page Aug 9, 2015 · 9 revisions

Правила разметки

  • Ширина текста - 80.

Правила перевода

  • Предложения, от первого лица единственного числа ("я пишу") - перефразируются в предложения, от первого лица множественного числа: "мы пишем", "мы получаем", и т.д.

  • Текст в примерах кода - переводится. [^0]

  • Сообщения об ошибках компилятора - не переводятся.

  • Специальные markdown заголовки в док-комментариях к коду Rust (например # Examples) - не переводятся. [^1]

  • Цитаты

    • "Декоративные" цитаты - заменять аналогичными по смыслу русскоязычными (при их наличии).
    • "Cмысловые" цитаты (несут в себе некий смысл, на который опирается дальнейшее повествование) - переводить близко к тексту.
  • Имена модулей, функций, переменных

    • В примерах - не переводятся
    • В сопроваждающем тексте - если это улучшает восприятие, при первом упоминании пишем перевод один раз в скобках.
  • Термины

    • Стараемся подобрать русское слово, наиболее подходящее по контексту. При вводе русского термина стоит один раз привести оригинальный термин в скобках. Например, контейнер (crate).
  • Название элементов структуры книги

    Всевозможные "section", "part" и т.д., заменяются на русские названия элементов. Уровень определяется так:

    • первый уровень списка в SUMMARY.md (напр., "Изучение Rust") - части;.
    • второй уровень списка в SUMMARY.md (напр., "Угадайка") - главы;
    • первый уровень заголовков в файле (напр., "Создание нового проекта" в "Угадайка") - разделы;
    • второй уровень заголовков в файле (напр., "Подготовка" в "Типажи-объекты") - под-разделы.

[^0]: Тонкий момент: не стоит переводить имена вроде Graydon и Niko как Григорий и Николай - это отсылка к создателям языка
[^1]: В разделе о документации сказано, что они не являются частью синтаксиса, но являются соглашением.

Правила пунктуации

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

Правила синтаксиса

  • Буква "ё" используется везде, где этого требуют правила русского языка.

Правила для ссылок

Относительные ссылоки на API документацию Rust заменяются на абсолютные. Пример: ../std/primitive.bool.html -> http://doc.rust-lang.org/std/primitive.bool.html

Словарь терминов

Если у вас есть вопросы или предложения по правилам - не стесняйтесь, обязательно предлагайте лучшие на ваш взгляд варианты!

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.