Skip to content
This repository has been archived by the owner on Oct 7, 2022. It is now read-only.

Latest commit

 

History

History
92 lines (70 loc) · 5.5 KB

translation-rules.md

File metadata and controls

92 lines (70 loc) · 5.5 KB
Raw
layout title
page
Правила перевода книг

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

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

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

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

  • Текст в примерах кода - переводится. 1

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

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

  • Цитаты

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

  • Имена модулей, функций, переменных

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

  • Термины

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

  • Название элементов структуры книги

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

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

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

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

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

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

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

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

Правила синхронизации перевода книг

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

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

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

  • Проверка актуальности перевода проводится посредством сравнения различия файлов оригинальной ветви и ветви с переводом. Для сравнения используется команда git diff. Пример:

git diff master translate -- index.md

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

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

Footnotes

  1. Тонкий момент: не стоит переводить имена вроде Graydon и Niko как Григорий и Николай - это отсылка к создателям языка ↩