Strona polskiego tłumaczenia KDE

Strona główna

Projekt na SourceForge

Strona główna KDE

Dla użytkowników

Dla tłumaczy

Logo SourceForge.net

Jak tłumaczyć dokumentację?

W jaki sposób to działa?

Dokumentację, podobnie jak interfejs użytkownika, tłumaczy się poprzez tłumaczenie napisów znajdujących się w plikach .po. Inny jest natomiast sposób dalszej obróbki przetłumaczonych plików .po.

Dokumentacja jest przechowywana w formacie plików Docbook - jest to język opisu dokumentacji oparty na XML. Pliki .po używane są w ten sposób, że na podstawie oryginalnej dokumentacji w formacie Docbook i pliku .po generowany jest plik Docbook zawierający przetłumaczoną dokumentację.

Przetłumaczone pliki Docbook, po zainstalowaniu, są używane przez program khelpcenter (Centrum pomocy KDE) do wygenerowania (w locie) stron HTML, wyświetlanych następnie użytkownikowi.

Jak tłumaczyć pliki .po

Generalne zasady tłumaczenia dokumentacji są takie same jak zasady tłumaczenia plików interfejsu użytkownika opisane na stronie Jak tłumaczyć.

Niemniej są pewne różnice, dlatego przed rozpoczęciem tłumaczenia należy zapoznać się z opisem z Translation Howto znajdującym się tutaj.

Należy również zwrócić uwagę na następujące rzeczy:

  • Dla jednego programu może być więcej niż jeden plik .po dokumentacji, np. kate.po, kate_advanced.po, kate_configuring.po, ...

Specjalne komunikaty dla tłumaczy

Plik .po zawiera specjalne komunikaty, które służą do podania informacji o tłumaczu. Trzeba je wypełnić zgodnie ze wzorcem, bo inaczej dokumentacja się nie wygeneruje.

CREDIT_FOR_TRANSLATORS - należy wypełnić w postaci:

<para>Imię Nazwisko<email>adres-e-mail</email></para>

ROLES_OF_TRANSLATORS - należy wypełnić w postaci:

<othercredit role=\"translator\">
<firstname>Imię</firstname><surname>Nazwisko</surname>
<affiliation><address><email>adres-email</email></address></affiliation>
<contrib>Polskie tłumaczenie</contrib>
</othercredit>

Entities (wyrazy postaci &kde;)

Niektóre wyrazy bądź zwroty powinny być tłumaczone tak samo wszędzie. W celu uspójnienia tłumaczeń stosuje się tzw. entities, które są zastępowane przez ten sam tekst w całym tłumaczeniu.

Entities muszą w obecnej chwili być zainstalowane razem z pakietem kdelibs, dlatego nie można ich sobie dowolnie definiować. Na pewno zdefiniowane są nazwy programów, użyte w tekście oryginalnym. Oprócz tego zdefiniowane są polskie nazwy dla niektórych programów, których nazwy się odmieniają. Nazwa entity zawiera wtedy również przypadek, np. &konqueror-dopelniacz; zostanie zastąpione przez: Konquerora.

Uwaga: nie należy dodawać przypadku dla nazw nieodmienialnych, np. &kde;
Pełną listę nazw, których można używać (oprócz standardowych, nieodmienialnych nazw programów, np.&kgeography;) można znaleźć w tym pliku (dla KDE 3.5).

Jak zainstalować przetłumaczoną dokumentację

Żeby obejrzeć efekt tłumaczenia, trzeba wykonać 2 kroki:
  1. Wygenerować dokumentację z plików .po
  2. Zainstalować wygenerowaną dokumentację.

Generowanie dokumentacji z plików .po

Do wygenerowania dokumentacji z plików .po potrzebne są:
  • Przetłumaczone pliki .po (znajdujące się w katalogu kde-i18n/pl/messages/docs).
  • Pliki Docbook z oryginalną (angielską) dokumentacją.
  • Spolszczone wspólne elementy dokumentacji (elementy języka Docbook).
Kiedy już to wszystko mamy, można przystąpić do łączenia plików .po z oryginalnymi plikami Docbook.

Przetłumaczone pliki .po

Pliki .po można wyciągnąć z CVS-a zgodnie z instrukcjami na tej stronie.

Pliki Docbook z oryginalną dokumentacją

Pliki Docbook z oryginalną dokumentacją znajdują się w podkatalogu doc/ każdego modułu CVS-a z programami.

Np. dla modułu kdebase należy wyciągnąć moduł kdebase/doc/ w następujący sposób (zakładam, że źródła modułu kde-i18n zostały umieszczone w katalogu ~/src/kde-i18n zgodnie z opisem z tej strony):

  1. Wejdź do katalogu ~/src:
    cd ~/src
  2. Wykonaj polecenie:
    cvs -d :pserver:anonymous@anoncvs.kde.org:/home/kde co -r KDE_3_3_BRANCH kdebase/doc

Po początkowym wyciągnięciu plików z CVS-a można je uaktualniać w następujący sposób:

  1. Wejdź do katalogu ~/src/kdebase:
    cd ~/src/kdebase
  2. Wykonaj polecenie:
    cvs up -z3 -dP

Spolszczone wspólne elementy dokumentacji

Elementy tłumaczone w jednakowy sposób w całej dokumentacji są umieszczone w specjalnym miejscu. Żeby je zainstalować, należy wykonać następujące kroki:
  1. Wejdź do katalogu ~/src:
    mkdir ~/src
  2. Wykonaj polecenie:
    cvs -d :pserver:anonymous@anoncvs.kde.org:/home/kde co -r KDE_3_3_BRANCH kdelibs/kdoctools/customization/pl
  3. Jako administrator wykonaj polecenie:
    cp -a kdelibs/kdoctools/customization/pl `kde-config --prefix`/share/apps/ksgmltools2/customization/
Po początkowym wyciągnięciu plików z CVS-a można je uaktualniać w następujący sposób:
  1. Wejdź do katalogu ~/src/kdelibs/kdoctools/customization:
    cd ~/src/kdelibs/kdoctools/customization
  2. Wykonaj polecenie:
    cvs up -z3 -dP pl
  3. Jako administrator wykonaj polecenie:
    cp -a pl `kde-config --prefix`/share/apps/ksgmltools2/customization/

Łączenie plików .po z oryginalnymi plikami Docbook

Jest to najtrudniejszy etap, ponieważ wymaga podstawowej znajomości formatu Docbook. Do łączenia używa się skryptu skryptu update_xml, który znajduje się w katalogu głównym modułu CVS-a kde-i18n.

WAŻNA UWAGA DLA POSIADAJĄCYCH KONTO CVS: ten skrypt automatycznie dodaje pliki do CVS-a, więc proszę używać osobnej kopii źródeł, wyciągniętych z anonimowego CVS, albo pamiętać nie robić commit na plikach dodanych w katalogu kde-i18n/pl/docs/.

Żeby wygenerować przetłumaczoną dokumentację należy wykonać następujące kroki:

  1. Wejdź do katalogu ~/src/kde-i18n:
    cd ~/src/kde-18n
  2. Wykonaj polecenie:
    ./update_xml pl

Jeśli skrypt update_xml nie pokazał błędów, dokumentacja jest wygenerowana i gotowa do zainstalowania.

Jeśli skrypt update_xml wskazał, że wystąpiły błędy, należy wykonać polecenie:

./update_xml --nodelete pl
Potem należy poprawić wskazane błędy - połączony plik Docbook znajduje się w katalogu docs/nazwa_modułu/... np. pl/docs/kdebase/kcontrol/arts/midi.docbook. Skrypt update_xml wskazuje numer linii, w której wystąpił błąd, chociaż błąd faktycznie może być efektem niepoprawnej konstrukcji, która zaczęła się wcześniej. Uwaga Jeśli były błędy, to ten plik jest niepoprawny i należy go usunąć po obejrzeniu. Rady dotyczące poprawiania błędów:
  • Sprawdź, czy zgadzają się znaczniki otwierające i zamykające, np. <email> i </email>.
  • Sprawdź, jak ten napis został przetłumaczony w innym języku, np. w niemieckim (wyciągnij z CVS-a katalog ~/src/kde-i18n/de/ analogicznie jak ~/src/kde-i18n/pl/).

Instalowanie wygenerowanej dokumentacji

Instalowanie wygenerowanej dokumentacji odbywa się tak samo jak instalacja plików interfejsu użytkownika, więc należy postępować zgodnie z tym opisem.

Należy zwrócić uwagę, że instalowane są pliki znajdujące się w katalogu kde-i18n/pl/docs, a nie z katalogu kde-i18n/pl/messages/docs. Ten pierwszy zawiera wygenerowaną, przetłumaczoną dokumentację. Ten drugi zawiera pliki .po służące do wygenerowania dokumentacji.

Przysyłanie przetłumaczonej dokumentacji

Do koordynatora przysyła się przetłumaczone pliki .po, a nie wygenerowaną dokumentację. Natomiast przed przysłaniem należy koniecznie sprawdzić, czy dokumentacja generuje się prawidłowo.

Zrzuty ekranu

Żeby dokumentacja była w pełni spolszczona należy zrobić zrzuty ekranu odpowiadające tym z angielskiej dokumentacji. Zrzuty powinny być zgodne z wymaganiami zawartymi na tej stronie.
Uwagi dotyczące strony
Ostatnia modyfikacja: $Id: jak_tlumaczyc_dokumentacje.php,v 1.10 2006/01/28 18:34:03 klichota Exp $