Polskie tłumaczenie dokumentacji PHP

To repozytorium zawiera pliki polskiego tłumaczenia dokumentacji na php.net, a ten dokument opisuje, w jaki sposób można uczestniczyć w procesie tłumaczenia.

Spis treści

1. Instalacja
2. Zbuduj dokumentację
3. Śledzenie wersji
4. Tłumaczenie
   1. Słowniczek
   2. Inne porady dot. tłumaczenia
5. Praca z git
6. Obecny stan polskiego tłumaczenia

Instalacja

Aby wziąć udział w tworzeniu tłumaczenia dokumentacji PHP na język polski, musisz zacząć od zrobienia forka tego repozytorium, tj. doc-pl.

Uwaga: Jeśli posiadasz konto na php.net (przydzielane ręcznie za długotrwały wkład) i uprawnienia do tego repozytorium, to możesz pracować bez użycia forka, ale jest to rzadka sytuacja, więc skupmy się na tym, co dotyczy większości ludzi.

Poza doc-pl potrzebujesz jeszcze dwóch dodatkowych repozytoriów. W zdecydowanej większości sytuacji nie ma potrzeby dokonywać w nich żadnych zmian, aby pracować nad polską dokumentacją, tak więc nie ma potrzeby ich forkować. Możesz sklonować je prosto z oryginalnych repozytoriów organizacji PHP na GitHubie.

Najlepiej jest stworzyć jeden katalog, do którego zostaną sklonowane wszystkie trzy repozytoria, na przykład phpdoc.

• php/doc-base: to repozytorium zawiera narzędzia do tworzenia dokumentacji. Repozytorium znajduje się pod adresem https://github.com/php/doc-base
• php/doc-en: angielska wersja dokumentacji, która jest używana m.in. wtedy, gdy dana podstrona nie została przetłumaczona na j. polski. Repozytorium znajduje się pod adresem https://github.com/php/doc-en
• php/doc-pl: polskie tłumaczenie dokumentacji PHP. Jak wspomniane wyżej, prawdopodobnie musisz stworzyć fork tego repozytorium i sklonować repozytorium znajdujące się na Twoim własnym koncie GitHub

Uwaga: upewnij się (przy klonowaniu lub zmieniając nazwę bezpośrednio po nim), że folder z angielską dokumentacją nazywa się en, a polską pl. Innymi słowy, upewnij się, że w sklonowanych repozytoriach katalogi z wersjami językowymi (poza doc-base) nie zaczynają się od doc-!

Zbuduj dokumentację

Po dokonaniu jakichkolwiek zmian w tłumaczeniu powinieneś skorzystać ze skryptu, który buduje dokumentację, aby upewnić się, że kod XML nie zawiera żadnych błędów. W tym momencie powinieneś mieć następującą strukturę katalogów:

|- phpdoc
 |- doc-base
 |- en
 |- pl
  |- ...

Jeśli znajdujesz się w katalogu pl, to musisz uruchomić po prostu następujące polecenie:

php ../doc-base/configure.php --with-lang=pl

Jeżeli wszystko poszło okej, to zobaczysz komunikat podobny do tego:

All good. Saving .manual.xml... done.
All you have to do now is run 'phd -d /home/user/Dev/phpdoc/doc-base/.manual.xml'
If the script hangs here, you can abort with ^C.
         _ _..._ __
        \)`    (` /
         /      `\
        |  d  b   |
        =\  Y    =/--..-="````"-.
          '.=__.-'               `\
             o/                 /\ \
              |                 | \ \   / )
               \    .--""`\    <   \ '-' /
              //   |      ||    \   '---'
         jgs ((,,_/      ((,,___/

 (Run `nice php configure.php` next time!)

W przeciwnym razie zobaczysz informację o błędach, które wystąpiły w plikach XML.

Uwaga: mimo iż proces nazywa się "budowanie", to ten krok nie tworzy jeszcze plików dokumentacji, które można wygodnie czytać (np. plików HTML). Komenda powyżej tworzy jedynie jeden gigantyczny plik XML i sprawdza jego poprawność, a renderowaniem dokumentacji do czytelnej formy zajmuje się phd

Śledzenie wersji

Kluczową sprawą przy tłumaczeniu dokumentacji jest jej zgodność z angielskim pierwowzorem. W tym celu powstał system revcheck, który jest dostępny m.in. na doc.php.net, który śledzi zmiany, jakie wystąpiły w angielskiej wersji manuala, a więc to, co musimy zmienić w polskim tłumaczeniu, aby było ono aktualne.

Cały system opiera się o hashe commitów gita i komentarze zawarte na górze każdego przetłumaczonego pliku XML:

<!-- EN-Revision: git-hash Maintainer: XXXX Status: ready -->

Kiedy tłumaczymy jakiś plik, to git-hash w komentarzu powyżej musi być zamieniony na hash angielskiej wersji pliku, na którym opieraliśmy tłumaczenie. Pomaga w tym wspomniana witryna doc.php.net. Na przykład zakładka "Outdated files" pokazuje, które z plików przetłumaczonych już na język polski, wymagają aktualizacji. Podaje ona wtedy, o jaki hash jest oparte obecne tłumaczenie, hash najnowszej angielskiej wersji, a także diff (wykaz zmian) między nimi. Hash najnowszej angielskiej wersji musimy umieścić w polu EN-Revision wyżej wspomnianego komentarza.

Podobnie ma się sprawa przy tłumaczeniu nowych stron, przechodzimy do sekcji "Untranslated files" http://doc.php.net/revcheck.php?p=missfiles&lang=pl, wybieramy katalog na górze, po czym widzimy, jakie pliki nie zostały przetłumaczone i jaki jest ich obecny hash commita w angielskiej wersji manuala. Wtedy do naszego nowego tłumaczenia dodajemy komentarz jak powyżej, a podany na stronie hash umieszczamy jako wartość EN-Revision.

Uwaga: informacje na stronie doc.php.net są aktualizowane co cztery godziny. Czasy ostatniej aktualizacji, podane tam w stopce, są w UTC.

Jeżeli chodzi o pole Maintainer to przy aktualizacji tłumaczeń zasadniczo nie zmieniamy go. W wypadku nowych tłumaczeń możemy tam podać którąś z istniejących już wartości lub, jeśli bierzemy już częstszy udział w tłumaczeniu na j. polski, pokusić się o "stworzenie" własnego nicku. Nie wymaga to żadnej rejestracji, a jedynie dodania wpisu do pliku translation.xml, znajdującego się w głównym katalogu tego repozytorium.

Tłumaczenie

Pliki XML powinny używać wcięć o szerokości jednej spacji. W tym repozytorium dołączono plik .editorconfig, więc jeśli używasz edytora, który wspiera ten standard (bezpośrednio lub przez wtyczki), to powinno to zostać wykryte automatycznie.

Tłumacząc pliki, warto zadbać o to, aby tekst był podzielony na nowe linie w tych samych miejscach, co angielski pierwowzór. Bardzo ułatwia to późniejszą analizę diffów na doc.php.net, a więc i aktualizację tłumaczeń. Wiadomo, że nie zawsze jest to możliwe, bo często szyk zdania w języku polskim jest zupełnie inny niż w angielskim, ale warto dbać o to tam, gdzie to możliwe.

Słowniczek

Poniżej zamieszczono listę kilku z częściej występujących i mniej oczywistych tłumaczeń, na które łatwo się natknąć w dokumentacji PHP.

Uwaga: żadna z osób biorących udział w pracach nad polską wersją podręcznika PHP nie jest zawodowym tłumaczem. Pewne frazy można zapewne przetłumaczyć lepiej, więc sugestie są mile widziane. Dobrze byłoby jednak zadbać o spójność, więc do momentu osiągnięcia ewentualnego konsensusu w sprawie nowego tłumaczenia, stosujmy się do tych, które już są używane w polskiej wersji i zostały wymienione poniżej.

Angielski wyraz lub wyrażenie	Polskie tłumaczenie	Komentarz
constructor property promotion	automatyczne tworzenie właściwości	Pomimo wielu poszukiwań nie znalazłem żadnego tłumaczenia w polskim internecie. To tylko moja radosna twórczość, jestem otwarty na lepsze propozycje
handler	funkcja obsługi
Locale settings	Ustawienia regionalne (locale)	Jako iż nie ma powszechnie używanego tłumaczenia na j. polski to zawieramy też oryginalne słówko, aby ułatwić np. Googlowanie
locale-dependent / locale-specific	z uwzględnieniem ustawień regionalnych (locale)
locale-independent	bez uwzględnienia ustawień regionalnych (locale)
null-coalescing operator	-	Nie jest mi znane żadne tłumaczenie, tym bardziej żadne powszechnie zrozumiałe
property	właściwość	W kontekście właściwości klas
scope	zasięg	W kontekście zmiennych
string	ciąg znaków	Ewentualnie łańcuch znaków, jeśli gdzieś chcemy uniknąć powtórzeń
trait, traits	trait, traity	Brak tłumaczenia, jedynie polska odmiana
variable variables	zmienne zmiennych
will generate deprecation notice	wygeneruje komunikat <constant>E_DEPRECATED</constant>
<constant>E_WARNING</constant> is raised	generowane jest ostrzeżenie (<constant>E_WARNING</constant>)
<parameter>foo</parameter>	Parametr <parameter>foo</parameter>	Poprzedzić słowem "parametr" przynajmniej przy pierwszym opisywaniu danego parametru na danej stronie. W przeciwnym razie dostajemy mieszkankę polskiego i angielskiego, która nie zawsze jest zrozumiała
<parameter>foo</parameter> is nullable now	Parametr `foo dopuszcza teraz &null;
<function>bar</function> example	Przykład użycia <function>bar</function>	W tytułach większości przykładów
&array;	<link linkend="language.types.array">Tablica</link>	Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej
&bool;	<link linkend="language.types.bool">Wartość logiczna</link>	Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej
&float;	<link linkend="language.types.float">Liczba zmiennoprzecinkowa</link>	Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej
&integer;	<link linkend="language.types.integer">Liczba</link>	Czasami też "liczba całkowita". Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej
&object;	<link linkend="language.types.object">Obiekt</link>	Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej
&resource;	<link linkend="language.types.resource">Zasób</link>	Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej
&string;	<link linkend="language.types.string">Ciąg znaków</link>	Nie zawsze warto tłumaczyć, patrz pkt. 4 poniżej

Inne porady dot. tłumaczenia

1. Nie należy się bać zmian szyku zdania. Zbyt dosłowne przekładanie szyku zdania z angielskiego jest chyba najczęstszym powodem, dla którego polska treść, mimo iż zrozumiała, jest mocno nienaturalna w odbiorze.
2. <refpurpose> czyli jednozdaniowy opis na górze strony funkcji tłumaczymy w trybie oznajmującym, czyli np. "Pobiera obecną datę", a nie "Pobierz obecną datę"
3. Odpowiedniki wielu angielskich wyrażeń, np. As of PHP X, Prior to PHP X, czy however, nie mają po sobie obowiązkowego przecinka w języku polskim
4. Jeśli chodzi o encje reprezentujące link do opisu typu danych (np. &array; czy &string;) to nie zawsze jest konieczność linkowania ich do konkretnej strony. Ze względu na brak konieczności tłumaczenia i odmiany tych wyrazów w j. angielskim, te encje są używane znacznie częściej niż jest to niezbędne
   1. Ponadto ciężko tutaj o regułę, ale nie widzę konieczności każdorazowego tłumaczenia np. "string" na "ciąg znaków". W tych czasach nazwy typów są raczej zrozumiałe nawet dla ludzi nieposługujących się j. angielskim. Osobiście staram się przetłumaczyć nazwę typu przynajmniej raz na stronie, a potem nie mam problemu z pozostawieniem angielskiej wersji

Praca z git

Przygotuj jakąś ilość zmian. Możesz zająć się jednym lub kilkunastoma plikami, ale zalecane jest, aby na początek brać mniejsze ilości plików. W ten sposób będzie mniej do ewentualnej poprawki po procesie code review. Później można stopniowo zwiększać ilość zmian, wraz z nabieraniem doświadczenia ...choć też bez przesady ze zmianami w jednym pull requeście, żeby przeglądanie zmian nie trwało wieków, bo to może być demotywujące :)

Opisy commitów tworzymy w języku angielskim, choćby ze względu na to, że pewne zmiany struktury są wykonywane przez ludzi z różnych krajów dla wszystkich tłumaczeń jednocześnie, tak więc w ten prosty sposób znacząco ułatwiamy pracę komukolwiek spoza Polski.

Po przygotowaniu zmian w forku należy otworzyć pull request do repozytorium php/doc-pl, a następnie poczekać na przejrzenie i zatwierdzenie zmian. Najlepiej zapoznać się z całą sekcją "Propose changes" w spisie treści wyświetlanym po lewej stronie, po otwarciu powyższego linku. Można też oczywiście poszukać materiałów w języku polskim na ten temat.

Obecny stan polskiego tłumaczenia

Mówiąc w wielkim skrócie: gorsza wiadomość jest taka, że polskie tłumaczenie nie jest obecnie widoczne na php.net. Znacznie lepsza wiadomość to taka, że polskie tłumaczenie jest jednocześnie w najlepszym stanie od przynajmniej ośmiu lat i że w perspektywie około miesiąca (tj. okolice czerwca, ewentualnie lipca 2024) powinno się to zmienić.

Polskie tłumaczenie nie ma może największej ilości przetłumaczonej treści (na maj 2024 jest to około 5% całości), ale też sam manual PHP jest gigantyczny. Większość zawartości manuala PHP to opisy rozszerzeń, w tym takich rzadko używanych lub niemal martwych rozszerzeń PECL, z których nikt nie korzysta i niemal nikt nie czyta ich dokumentacji. Polskie tłumaczenie skupia się w większości na najczęściej wykorzystywanych funkcjach i rozdziałach podręcznika.

W połączeniu z faktem, że polska wersja ma małą ilość zdeaktualizowanych tłumaczeń, stawia nas to w naprawdę dobrej pozycji wyjściowej w porównaniu do większości innych języków. Nie widać tego obecnie na doc.php.net, ale faktycznych tłumaczeń dokumentacji PHP jest około 30. Większość z nich po prostu jest w stanie tak złym, że zrezygnowano z cyklicznego analizowania ich statusu w tym narzędziu do momentu, gdy ktoś zabrałby się za ich wskrzeszenie i zapewnił aktualne tłumaczenie przynajmniej dla kilku setek plików. Jest to coś, czego polska wersja robić nie musi :)