Wiki

Clone wiki

ogre-ru-api / Home

Здравствуйте

Добро пожаловать на страницу проекта перевода API документации по Ogre -- лучшему бесплатному графическому движку в мире!

О чем это мы

Здесь мы занимаемся переводом API документации по Ogre -- объектно-ориентированному графическому движку. Да, да вы не ослышались, именно переводом. Поэтому не стоит отправлять сюда ваши гениальные улучшения и баг-фиксы -- этот проект предназначен не для этого, загляните к синбаду.

Почему именно здесь? Просто потому, что другого места нет. Перевод документации такой огромной и постоянно развивающейся системы, как Ogre, вынуждает вести историю переводов. А сайты вроде нотабеноида не предназначены для перевода исходного кода. Дело в том, что при таком переводе не учитывается положение кусков текста, что они должны быть привязаны к определенным строкам в файле. Это нужно, во-первых, чтобы при слиянии было легче понять, где менялся код, так как комментарии меняются сравнительно редко.

Как присоединиться

Прежде всего, вы должны почитать правила. Я говорю почитать, а не прочитать, потому что их надо запомнить и применять, а не сразу забыть. Успех всего предприятия в немалой степени зависит от согласованности участников. После этого форкните этот репозиторий, либо, если у вас уже есть собственный форк, добавьте в его настройки новый псевдоним. Для этого отредактируйте файл <репозиторий>/.hg/.hgrc, добавив в раздел [paths] нужный псевдоним. У меня файл выглядит так:

[paths]
default = https://bitbucket.org/sinbad/ogre/
ru-api = https://bitbucket.org/mingun/ogre-ru-api

Также это можно сделать из TortoiseHg, на вкладке "Синхронизация". После этого вы сможете затягивать изменения из этого репозитория одним кликом мыши ;).

Перевод осуществляется в ветке api-translation-ru, так что переключитесь на нее, прежде, чем начать. Переводы принимаются в виде Pull request-ов. Это сделано для того, чтобы мне проще было контролировать соблюдение правил всеми участниками перевода. Если нареканий не возникнет, я приму запрос, а если нет, вам придется исправить замеченные ошибки. После этого можете попытаться снова. Как только ваш перевод вольется в данный репозиторий, можете с гордостью считать себя официальным членом команды перевода, я внесу вас в список переводчиков. Можете связаться со мной, если вы хотите, чтобы в списке кроме НИК-а была еще какая-то информация.

Также посмотрите глоссарий.

Как получить документацию

Собрать самому из исходников

Самый надежный способ -- использовать команду

hg clone https://bitbucket.org/Mingun/ogre-ru-api
cd ogre-ru-api/Docs

Теперь, если выполнить команду

doxygen src/html.cfg

будет сгенерирована русскоязычная документация по API OGRE в папке api/html_ru. Таким образом вы получите самый свежий перевод документации.

Загрузка готового перевода

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

Как улучшить перевод

Если вы по каким либо причинам не можете сами принять участие в переводе, вы все равно можете помочь в нем. Если вы заметили ошибку в переводе, как-то: опечатки, режущий слух оборот, тотальное несоответствие оригиналу и прочее, создайте задачу на баг-трекере проекта. Ваши замечания обязательно будут учтены. Так же не стесняйтесь распространять данный перевод среди русскоязычных пользователей OGRE.

Список страниц wiki

Перевод делается специально для ogre3d.su

Updated