Введение
Данный документ описывает порядок и правила перевода документации на русский язык.
Начало работы
Общая схема работы над переводом выглядит так:
- выбор раздела для перевода
- перевод с оглядкой на правила
- добавление/обновление файла в репозитории
- синхронизация версий по мере обновления оригинала
Перед началом работы необходимо выгрузить содержимое репозитория.
Далее необходимо выбрать еще не переведенную тему.
Файлы перевода должны быть сконвертированы в формат UTF-8 для корректного отображения.
Перевод
Общие правила
Ниже приведены общие правила, которых необходимо придерживаться, работая над переводом документации:
- повествование в соответствии с оригиналом ведется от первого лица мноножественного числа (мы);
- многие термины не имеют однозначного и широко распространенного перевода на русский язык, поэтому, если в тексте встречается такой термин, в скобках возле первого упоминания необходимо указать английский вариант; (список используемых вариантов перевода терминов см. ниже);
- если кажется, что при переводе какая-то часть текста теряет смысл и вы не уверены в том, как ее правильно перевести, публикуйте вопрос на форуме.
- при переводе избегайте фактических ошибок!
- в тексте встречаются ссылки на внешние источники, если ссылка ведет на статью, определение термина и т.п., то при наличии русского варианта на этом же ресурсе или ином авторитетном ресурсе, даем ссылку на русский вариант. Например http://en.wikipedia.org/wiki/Captcha => http://ru.wikipedia.org/wiki/Captcha
- комментарии в коде переводятся, если не искажают первоначального смысла;
- добавление собственных комментариев-дополнений возможно, но не приветствуется поскольку во избежание хаоса оригинал должен быть один. В случае такой необходимости в конце комментария нужно добавить "(прим. пер.)";
- после проведения общей правки документа настоятельно рекомендуется самостоятельно вносить исправления только грамматических, а также фактических ошибок, имеющих отношение только к данному разделу. В остальных случаях необходимо вынести предложение по исправлению, улучшению на обсуждение и в случае необходимости централизованно внести коррективы во все разделы документа.
Грамматика
- обращайте внимание на общую стилистику, орфографию и пунктуацию, перед заливкой конечного варианта перевод можно прогнать через любую программу с встроенной проверкой;
Список терминов
| action | действие |
| active record | без перевода |
| attach handler | «назначить обработчик» или «связать обработчик (с событием)» |
| attribute of the model | атрибут модели |
| customization | (тонкая) настройка Ранее встречался перевод "кастомизация", желательно этот вариант не использовать |
| column | столбец (если речь про БД) |
| content | содержимое |
| controller | контроллер |
| debug (mode) | отладочный (режим) (см. production mode) |
| eager loading | метод жадной загрузки/жадная загрузка (см. lazy loading) |
| PHP extension | расширение PHP |
| field (of the table) | поле (или атрибут) таблицы |
| framework | фреймворк |
| front-controller | фронт-контроллер |
| getter | метод чтения (см. setter) |
| (event) handler | обработчик (события) |
| hash | хэш |
| helper | хелпер |
| id | идентификатор |
| instance | экземпляр |
| lazy loading | отложенная загрузка (загрузим как понадобится и не раньше) |
| method | метод (объекта) Внимание! У объета/класса нет функций, есть только методы |
| model | модель, модель данных |
| model form | модель формы |
| parameter | параметр (у метода или функции, никак не у класса) |
| to parse | обрабатывать, если контекст непонятен — парсить |
| placeholder | маркер |
| production (mode) | производственный (режим) (см. debug mode) |
| property | свойство (объекта) |
| to render | рендерить, формировать |
| resolve request | предварительная обработка запроса |
| route | маршрут |
| row (of the table) | строка (таблицы) |
| setter | метод записи (см. getter) |
| tabular input | табличный ввод |
| to validate | проверять |
| valid | корректный |
| validator | валидатор |
| validator class | класс валидатора |
| view | представление |
Работа с репозиторием
Для работы с репозиторием можно использоваться любой SVN-клиент В Windows удобно пользоваться Tortoise SVN. Подробное руководство по работе на русском языке
Перед заливкой измененного файла на сервер, необходимо обновить локальную копию. В случае, если изменений вашего файла со стороны других участников не было, можно заливать его на сервер. В противном случае, придется сравнивать и объединять вариант на сервере с локальным вариантом.
К каждому коммиту в SVN нужно сделать краткое примечание, описывающее суть измененений.
предлагаю to parse переводить, как "разбирать" (текст, код), text parsing - "разбор текста". также наверное, есть смысл рядом с route, добавить также слово routing - "маршрутизация" А в остальном и целом с правилами согласен, буду стараться придерживаться.