Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
79 lines (54 sloc) 3.53 KB

Как предложить свой вариант перевода?

  1. Для начала, вам нужно сделать Fork текущего репозитория с переводом
  2. В своем репозитории перевода создайте branch и внесите законченный набор изменений в перевод. Желательно, чтобы изменения касались не более чем 10 файлов на один Pull Request
  3. Актуальную версию английской документации берите из репозитория symfony-docs
  4. Когда вы закончили правки в переводе, из нужного branch сделайте Pull Request
  5. Для бОльшего удобства при определении изменений в файле перевода необходимо:

5.1. При создании нового перевода добавить в конец файла такую конструкцию (не будет отображаться при генерации):

toctree

hidden

Translation source: YYYY-mm-dd REV

где
YYYY-mm-dd дата когда был взят исходник перевода, REV - короткий хеш ревизии (можно посмотреть командой git log --oneline [file])

5.2. При обновлении перевода добавить в историю правок строку

Corrected from: YYYY-mm-dd REV

5.3. Пример этой конструкции можно подсмотреть в конце этого файла, так как он не виден в распарсеном документе.

где
YYYY-mm-dd - дата когда был взят исходник для коррекции REV - также хеш ревизии по которой делалась коррекция

Соглашения по переводу

  1. Некоторые частные случаи:
Исходный вариант Правильный перевод Неправильный перевод
Response object объект Response объект ответа

Не переводятся

  1. Служебная разметка:

    - :orphan:
    - .. glossary::
    - .. note::
    - .. tip::
    - .. toctree::
         :maxdepth: 2
         :glob:
         :numbered:
    
  2. Служебные слова: "API", "HTTP", "Symfony2", "Controller", "Response", etc.

Полезные ссылки

  • Правила форматирования документации: `Symfony2 Documentation Format

<http://symfony.com/doc/current/contributing/documentation/format.html>`_ и reStructuredText Markup Specification

.. toctree::
    :hidden:

    Translation source: 2011-01-01 [REV]
    Corrected from: