Перевод документации OpenERP

Требования

Вы должны быть в состоянии собрать непереведённую документацию. Так что Sphinx должен быть установлен на вашем компьютере и вы должны знать, как им пользоваться.

Если это не проблема, почитайте Построение документации в Руководстве Сообщества

Вы можете скачать исходники документации с launchpad:

bzr branch lp:openobject-doc

Понимание структуры каталогов

Мы предполагаем, что <openobject-doc> — корневой каталог документации Open Object в ветви bazaar.

Непереведённые исходники расположены в <openobject-doc>/source.

Переведённая документация будет расположена в <openobject-doc>>/i18n/<язык>/source.

Например, документация на французском будет расположена в <openobject-doc>/i18n/fr/source и будет собираться в <openobject-doc>/i18n/fr/build/html, например.

Итог

Каталог	Описание
<openobject-doc>/source	непереведённые исходники
<openobject-doc>/i18n/<lang>/source	переведённые исходники
<openobject-doc>/i18n/<lang>/build/html	переведённая документация в html

Создание структуры каталогов для перевода

Используйте команду make (с сцелью i18n) для создания шаблонов перевода. Вам понадобится передать команде make код языка в качестве дополнительного параметра.

Например, если вы хотите переводить документацию на французский:

make i18n LANG=fr

Эта команда произведёт такие действия:

• создаст каталоги, если они ещё не созданы:
  • i18n
  • i18n/fr
  • i18n/fr/source
  • i18n/fr/build
• скопирует в каталог i18n/fr/ файлы, необходимые для сборки html:
  • MakeFile
  • conf.py
• создась шаблоны перевода на основе переведённых неструктурированных текстовых файлов. Они будут созданы в i18n/fr/source
• скопирует все остальные необходимые файлы (например, изображения)

Шаблоны перевода

Структура шаблонов для отдельного файла очень проста. каждая секция предваряется оригинальным контекстом. Например, вот заголовок:

.. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%
.. i18n: Open Object Documentation
.. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%

%%%%%%%%%%%%%%%%%%%%%%%%%
Open Object Documentation
%%%%%%%%%%%%%%%%%%%%%%%%%

Контекст — закоментированная часть, начинающаяся с .. i18n:. Он поможет вам воспринимать раздел в его контексте. Он также поможет вам помнить оригинальную часть.

А вот так выглядит переведённая часть:

.. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%
.. i18n: Open Object Documentation
.. i18n: %%%%%%%%%%%%%%%%%%%%%%%%%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Documentation sur Open Object
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Управление изменениями в исходнике

Если кто-либо добавляет или изменяет что-то в документации, изменённую часть нужно будет перевести заново. Но все остальные части, скорее всего, останутся переведёнными.

Когда вы получите изменения в документации с помошью bzr pull, например, новые разделы и некоторые изменённые разделы будут сброшены к непереведённому состоянию, если вы пересоберёте перевод с помощью команды make i18n LANG=fr.

Сборка документации на вашем языке

Это очень просто в силу соответствия структуры каталогов и файлов перевода изначальной структуре

i18n
`-- fr
    |-- build
    `-- source

В качестве примера, в i18n/fr вы просто должны выполнить make:

make html

И html-документация будет собрана в i18n/fr/build/html.

Загрузка на Launchpad

Как только вы перевели несколько страниц, следует зафиксировать эти изменения на launchpad. Чтобы сделать это, ваш аккаунт на launchpad должен состоять в группе openobject-community.

Чтобы загрузить ваши изменения, вы должны зафиксировать из на launchpad:

bzr add ВАШИ_НОВЫЕ_ФАЙЛЫ_ИЛИ_КАТАЛОГИ bzr ci bzr push

Состояние

В настоящее время этот скрипт имеет статус “альфа” и не был в достаточной степени проверен. Он должен работать, но учитывайте возможное появление неожиданных ошибок. Свяжитесь с olt НА openerp.com если заметите какие-нибудь проблемы.