[kde-russian] К вопросу о переводе документации

["Yuri Chornoivan" <yurchor@ukr.net>]

Я сейчас пробую создать свою версию справки для переводчиков. Поскольку  
тут ещё недавно спрашивали о тестировании документации, возможно  
кому-нибудь будет полезен этот фрагмент (в формате вики):


== Перевод справки ==

Если вы переводите документацию, помните, что переведенный вами файл  
справки будет собран и добавлен в пакеты KDE, только если переведено будет  
100% сообщений.

=== Сборка ===

Ниже мы будем предполагать, что вами уже была установлена система контроля  
версий SVN и скачан основной набор скриптов перевода KDE:

  svn co svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4/scripts

Также следует установить пакет kdesdk-po2xml и скачать оригинальную  
документацию к программе и все русские переводы документации. Загрузку  
оригинальной документации следует выполнить в папку «корневая папка  
перевода/documentation/название модуля/название программы» командой:

  svn co  
svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4/documentation/название  
модуля/название программы

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

По завершению перевода справки попробуйте собрать документацию программы  
командой

  scripts/update_xml uk название модуля/название программы

выполненной из корневой папки ваших переводов.

=== Ошибки ===

Если при компиляции будут показаны сообщения об ошибках, вам следует  
внимательно с ними ознакомиться. Причин ошибок может быть три: ошибки в  
тегах XML во время перевода, создание новых записей авторов и названий  
программ (entities), ошибки в оригинальном файле DocBook.

Разберем все возможные варианты последовательно:

1) Вы допустили ошибку во время перевода. Внимательно прочитайте  
сообщение, выведенные скриптом update_xml. Найдите первую ошибку. Если  
легко удается идентифицировать ошибочное сообщение, откройте его в  
Lokalize, перейдите в конец сообщения и нажмите комбинацию клавиш''  
'Ctrl'''+''' T'''. В ответ программа покажет список тегов сообщения.  
Обратите внимание на тег, который подсвечен: возможно, именно его вы  
пропустили или расположили неправильно. Если идентифицировать ошибочное  
сообщение не удалось, вы можете попытаться собрать черновик документации и  
определить сообщения по строке ошибки: скопируйте соответствующий файл  
.docbook и файл .po в одну папку и выполните команду

   po2xml название.docbook название.po> translated.docbook

По номеру строки с ошибкой определите с помощью файла translated.docbook  
ошибочное сообщение и исправьте его.

2) Авторы документации создали новые записи в файлах стандартных записей  
(такие ошибки можно обнаружить по характерным сообщениями о неопределенных  
записях entities). Для сборки документации в этом случае вам придётся  
загрузить новые файлы записей

   svn co  
svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs/kdoctools/customization/entities

и переписать их в /usr/share/apps/ksgmltools2/customization/entities

3) Если два описанных способа не дали результатов, попробуйте проверить  
оригинальный DocBook на корректность командой

  checkXML index.docbook

Если отображается сообщение об ошибках, сообщите о них в  
[https://mail.kde.org/mailman/listinfo/kde-i18n-doc список рассылки  
переводчиков KDE].

=== Тестирование ===

Скопируйте готовые файлы справки (update_xml создаст их в каталоге  
/ru/docs/название модуля/название программы) в отдельный каталог  
тестирования. Для преобразования документации в формат HTML воспользуйтесь  
командой

  meinproc4 index.docbook

Попробуйте прочитать документацию, начиная с файла index.html, и исправить  
ошибочно переведенные сообщения.

=== Снимки окон и другая графика ===

Конечно же, переведенная документация лучше всего смотрится с полностью  
локализованными элементами. Для создания снимков окон можно  
воспользоваться KSnapshot (просто откройте окно локализованной программы и  
нажмите клавишу PrintScreen). Образцы соответствующих снимков можно найти  
в каталоге /documentation с оригинальной документацией. Следует  
придерживаться размеров изображений оригиналов  (откройте файлы в  
начальном разрешении в Gwenview и подгоните размеры окна под  
оригинальные), а также использовать стандартную тему KDE (в текущей версии  
Oxygen) и формат файлов PNG.

Сжать готовые изображения можно с помощью такого скрипта:

  #!/bin/bash

  for i in *.png
  do
       pngnq -s 1 $i && optipng ${i%.*}-nq8.png && mv -f ${i%.*}-nq8.png $i
  done

(Предварительно следует установить пакеты программ pngnq и optipng)