Gentoo Logo

Przewodnik dla tłumaczy dokumentacji Gentoo na język polski

Spis treści:

1.  Wprowadzenie

Podstawową zasadą obowiązującą każdego tłumacza jest dobra znajomość języka angielskiego. Bardzo ważne jest tu słownictwo techniczne dotyczące systemu Linux, oprogramowania, sprzętu oraz samego Gentoo. Oprócz tego każdy chętny powinien posiadać wiedzę i doświadczenie w używaniu naszej dystrybucji.

Informacje zawarte w tym dokumencie zostały spisane, aby ułatwić nowym osobom dołączenie do projektu oraz w celu usystematyzowania wszystkich zasad i reguł obowiązujących obecnych członków naszego zespołu.

Wszelkie propozycje zmian tego tekstu należy kierować do koordynatora polskiego projektu tłumaczenia dokumentacji Gentoo.

Cała dokumentacja Gentoo oraz jej tłumaczenia są wydawane na zasadach licencji Creative Commons - Share Alike i każdy współpracownik projektu musi zgodzić się na opublikowanie swojej pracy na tej licencji. W przeciwnym wypadku jego tekst nie trafi na oficjalne strony Gentoo.

Zaczniemy od omówienia procesu tłumaczenia dokumentu:

2.  Przygotowanie środowiska pracy

Najpierw musimy pobrać angielski plik. W przykładzie pobieramy plik printing-guide.xml, który znajduje się na stronach Gentoo pod adresem http://gentoo.org/doc/en/printing-guide.xml i zapisujemy go na dysku za pomocą programu wget z opcją -O (czyli --output-document). Więcej informacji na ten temat można znaleźć na stronach man wget.

Listing 2.1: Pobieranie dokumentu w języku angielskim

$ wget http://gentoo.org/doc/en/printing-guide.xml?passthru=1 -O printing-guide.xml

Jeśli zakres prac jest szeroki i obejmuje więcej niż jeden lub nawet kilka dokumentów, znacznie wygodniej jest pobrać całe repozytorium z dokumentacją polską i angielską na dysk niż ściągać pliki jeden po drugim.

Listing 2.2: Pobieranie repozytorium z dokumentacją

$ cvs -d :pserver:anonymous@anoncvs.gentoo.org/var/cvsroot co gentoo/xml/htdocs/{proj,doc}/{en,pl}/

Uwaga: Kolejne aktualizacje repozytorium wykonuje się za pomocą polecenia cvs update -dP.

Kilka słów o katalogu, który zostanie pobrany na dysk w wyniku powyższego polecenia. Jest to katalog z całą stroną http://gentoo.org w języku angielskim i polskim. Znajdują się w nim pliki xml, z których strona ta jest generowana i to właśnie te pliki tłumaczymy i aktualizujemy.

Dokument można przetłumaczyć w dowolnym edytorze tekstu. Obowiązują jednak następujące zasady: ma to być tekst zakodowany w UTF-8 i z wierszami zawiniętymi po 80 znaku.

3.  Tłumaczenie dokumentu

Zaczynamy od otwarcia pobranego pliku .xml w edytorze tekstu. Tłumaczenie polega na zamianie angielskiego tekstu polskim i jednoczesnym unikaniu rujnowania składni xml.

Ważne: Dokumenty muszą być pisane w formie bezosobowej: "należy", "trzeba", "warto", którą czasami można poprzeć także liczbą mnogą: "robimy", "instalujemy", "klikamy" itp. Zakazane jest pisanie per "ty", nawet jeśli taka forma jest używana w oryginale. Nie wolno korzystać ze zwrotów "proszę coś zrobić", "uprasza się o" i tym podobnych ozdobników.

Kilka przykładów:

Listing 3.1: Nagłówek

(Na czerwono wszystkie zmiany jakie musi nanieść tłumacz)

<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<!-- $Header$ -->

<guide link="/doc/pl/home-router-howto.xml" lang="pl">
<title>Konfiguracja routera</title>

<author title="Autor">
  <mail link="swift@gentoo.org">Sven Vermeulen</mail>
</author>
<author title="Tłumaczenie">
  <mail link="rane@gentoo.org">Łukasz Damentko</mail>
</author>

<abstract>
Krótki opis umożliwiający skonfigurowanie routera łączącego domową sieć z Internetem.
</abstract>

<!-- The content of this document is licensed under the CC-BY-SA license -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>

<version>1.10</version>
<date>2005-08-14</date>
  1. Zaczynamy od przetłumaczenia tytułu dokumentu - znajdującego się wewnątrz taga <title>
  2. W linii <guide> zmieniamy w ścieżce dokumentu wpis en na pl i dodajemy parametr lang="pl". Dzięki temu będzie wyświetlana prawidłowa strona przeznaczona do druku oraz pojawi się polska wersja daty i komentarzy w pliku (np. "Ważne" zamiast "Warning").
  3. Role wszystkich autorów oryginału należy przetłumaczyć na język polski. Najczęściej występujące to "Autor" (Author) i "Redaktor" (Editor).
  4. Oczywiście należy się podpisać. Obowiązuje zasada, że dokumenty podpisujemy pełnym imieniem i nazwiskiem. Wzór wpisu znajduje się powyżej, adres e-mail jest opcjonalny i jego dodanie zależy od woli tłumacza. Jeśli nie chcemy go dodać, usuwamy wpisy <mail link=""> i </mail> wokół nazwiska.
  5. Należy także przetłumaczyć zawartość taga <abstract>. Jest ona wyświetlana jako krótkie podsumowanie zawartości dokumentu w prawym górnym rogu strony oraz we wszystkich spisach treści pod jego tytułem.

Listing 3.2: Akapit

<p>
Pliki "stage" znajdują się w katalogu
<path>/mnt/cdrom/stages</path> płyty instalacyjnej. Ich listę możemy
uzyskać poleceniem <c>ls</c>:
</p>

Uwagi:

Pamiętamy o wszystkich <path>, <c> i <e> z oryginału i podkreślamy je we właściwy sposób również w odpowiednich fragmentach przetłumaczonego tekstu.

  • <path> musi obejmować wszystkie ścieżki i nazwy plików,
  • <c> służy do wyróżnienia na niebiesko poleceń wpisywanych przez użytkownika,
  • <e> pozwala na wyróżnienie jakiegoś tekstu, który musi być zauważony przez czytelnika.

Listing 3.3: Przykład listingu

<pre caption="Edytowanie pliku client.conf">
# <i>vim /etc/cups/client.conf</i>

<comment>(Oczywiście wpis printserver.mydomain należy zastąpić nazwą odpowiedniego serwera wydruku)</comment>
ServerName <i>printserver.mydomain</i>
</pre>

Tu również musimy zachować oryginalne tagi.

  • <i> podkreśli polecenia wpisywane przez użytkownika na niebiesko, jest to lokalny odpowiednik <c> z akapitu.
  • Zawartość <comment> trzeba przetłumaczyć, w dokumencie jest ona wyświetlana na czerwono

W ten sposób, możliwie wiernie, zdanie po zdaniu, tłumaczymy cały dokument. Nie wolno kopiować gramatyki i interpunkcji oryginału, język polski ma zupełnie inne zasady i ślepe tłumaczenie słowo po słowie zwykle kończy się katastrofą i obłożeniem klątwą do siódmego pokolenia (włącznie) przez dział korekty.

Kiedy skończymy, musimy sprawdzić czy nie zrujnowaliśmy składni xml - dokonuje się tego przy pomocy programu xmllint:

Listing 3.4: Sprawdzanie poprawności składni XML

$ xmllint --valid --noout nazwa_pliku.xml

Ważne: Przed pierwszym użyciem xmllint należy dodać następujący wpis do pliku /etc/xml/catalog:

Listing 3.5: Plik /etc/xml/catalog

<rewriteURI uriStartString="/dtd" rewritePrefix="/usr/portage/metadata/dtd/"/>

W razie problemów z wpisaniem tej linii można skonsultować się z przykładowym plikiem, który znajduje się pod adresem http://dev.gentoo.org/~rane/other/tools/catalog.txt.

Jeśli program nie wydrukuje żadnych komunikatów o błędach, możemy przystąpić do (niezbędnej przed wysłaniem dokumentu w świat) korekty.

W tym momencie zapominamy o oryginalnym, angielskim tekście i poprawiamy cały dokument tak, aby wyglądał możliwie naturalnie dla naszych rodaków. Warto poprawić styl i budowę zdań. Staramy się również wyłowić wszystkie błędy ortograficzne, gramatyczne i interpunkcyjne jakie popełniliśmy w trakcie tłumaczenia. Wszelkie wątpliwości pomogą nam rozwiać:

W Internecie znajduje się wiele interesujących artykułów dotyczących tłumaczenia, które zawierają mnóstwo cennych i bardzo praktycznych wskazówek oraz zwracają uwagę na najczęściej popełniane podczas tłumaczenia błędy. Oto kilka wybranych:

Jeśli wciąż nie jesteśmy czegoś pewni, odwiedzamy kanał #gentoo-docs-pl w sieci freenode i pytamy przebywających tam innych tłumaczy o ich zdanie w kontrowersyjnej sprawie. Możemy również zapisać się i wysłać maila na listę dyskusyjną tłumaczy Gentoo, o której opowiem za chwilę.

Po zakończeniu korekty należy wysłać przetłumaczony plik na adres Łukasz Damentko i poczekać aż po wnikliwej i bezlitosnej weryfikacji trafi na oficjalną stronę Gentoo i zapewni nam sławę na wieki.

4.  Grupa dyskusyjna i kanał IRC

Wszystkich tłumaczy zapraszamy do zapisania się na specjalnie dla nich utworzoną listę mailingową. Wystarczy wysłać pusty mail pod adres gentoo-doc-pl+subscribe@gentoo.org i czekać na list powitalny. Jest to doskonałe miejsce do zadawania pytań w sprawach dotyczących tłumaczenia dokumentacji.

Zapraszamy również do odwiedzenia kanału #gentoo-docs-pl w sieci freenode, gdzie można dokładnie odpytać stałych uczestników projektu na tematy związane z tłumaczeniami.



Drukuj

Zaktualizowano 10 maja 2007

Podsumowanie: Przewodnik dla tłumaczy dokumentacji Gentoo na język polski.

Łukasz Damentko
Autor

Donate to support our development efforts.

Support OSL
Gentoo Centric Hosting: vr.org
Tek Alchemy
SevenL.net
Global Netoptex Inc.
Bytemark
Online Kredit Index
Copyright 2001-2009 Gentoo Foundation, Inc. Questions, Comments? Contact us.