Zanurkuj w Pythonie/Zalecenia dla autorów
O podręczniku
edytujKsiążka ta jest tłumaczeniem „Dive into Python” (czyli „Zanurkuj w Pythonie”), udostępnionej na licencji zgodnej z licencją Wikibooks (GNU Free Documentation License). Możesz zajrzeć do sekcji O podręczniku. Pomysł przetłumaczenia tego podręcznika został dany przez Warszka. Praca nad powstawaniem tego podręcznika była koordynowana przez Piotra.
Tłumaczenie
edytujProces tłumaczenia został już zakończony. Teraz trzeba zrobić poprawki.
Poprawki
edytujPodręcznik wymaga:
- zmiany kodu,
- ujednolicenia sposobu zwracania się do Czytelnika,
- ujednolicenia pojęć technicznych (w tym "section" to nie "sekcja", tylko podrozdział),
- poprawy błędów ortograficznych, stylistycznych, składniowych itp.
- wytłumaczenia niektórych pojęć dla osób, które nigdy wcześniej nie programowały,
- zmniejszenia ilości zbędnych porównań do innych języków programowania,
Zmiany w kodzie
edytujW plikach źródłowych należy zmienić klasy na klasy w nowym stylu. Ponadto należy przetłumaczyć notki dokumentacyjne i komentarze na język polski. Wszelkie łańcuchy znaków z polskimi znakami tworzymy w unikodzie. Poniżej przedstawione są pliki źródłowe, a po poprawie przekopiujemy je do odpowiednich podrozdziałów.
Poniżej znajdują się pliki do poprawy (być może niektóre trzeba będzie przekopiować z http://diveintopython.org):
- Zanurkuj w Pythonie/Źródła/fileinfo.py (ok)
- Zanurkuj w Pythonie/Źródła/apihelper.py (ok)
- Zanurkuj w Pythonie/Źródła/odbchelper.py (ok)
- Zanurkuj w Pythonie/Źródła/fibonacci.py (ok)
- Zanurkuj w Pythonie/Źródła/kgp/stdout.py (ok)
- Zanurkuj w Pythonie/Źródła/kgp/toolbox.py (ok)
- Zanurkuj w Pythonie/Źródła/kgp/stderr.py (ok)
- Zanurkuj w Pythonie/Źródła/kgp/kgp.py (ok)
- Zanurkuj w Pythonie/Źródła/BaseHTMLProcessor.py (ok)
- Zanurkuj w Pythonie/Źródła/dialect.py (ok)
- Zanurkuj w Pythonie/Źródła/urllister.py (ok)
- Zanurkuj w Pythonie/Źródła/soundextest.py (ok)
- Zanurkuj w Pythonie/Źródła/odbchelpertest.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage9/romantest9.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage9/roman9.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage5/roman5.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage5/romantest5.py
- Zanurkuj w Pythonie/Źródła/roman/stage3/roman3.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage3/romantest3.py
- Zanurkuj w Pythonie/Źródła/roman/stage4/romantest4.py
- Zanurkuj w Pythonie/Źródła/roman/stage4/roman4.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage8/roman83.py
- Zanurkuj w Pythonie/Źródła/roman/stage8/roman82.py
- Zanurkuj w Pythonie/Źródła/roman/stage8/romantest81.py
- Zanurkuj w Pythonie/Źródła/roman/stage8/roman81.py
- Zanurkuj w Pythonie/Źródła/roman/stage8/romantest83.py
- Zanurkuj w Pythonie/Źródła/roman/stage8/romantest82.py
- Zanurkuj w Pythonie/Źródła/roman/stage6/roman62.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage6/roman61.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage6/romantest62.py
- Zanurkuj w Pythonie/Źródła/roman/stage6/romantest61.py
- Zanurkuj w Pythonie/Źródła/roman/stage7/roman71.py
- Zanurkuj w Pythonie/Źródła/roman/stage7/romantest71.py
- Zanurkuj w Pythonie/Źródła/roman/stage7/romantest72.py
- Zanurkuj w Pythonie/Źródła/roman/stage7/roman72.py
- Zanurkuj w Pythonie/Źródła/roman/stage2/roman2.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage2/romantest2.py
- Zanurkuj w Pythonie/Źródła/roman/stage1/roman1.py (ok)
- Zanurkuj w Pythonie/Źródła/roman/stage1/romantest1.py
- Zanurkuj w Pythonie/Źródła/parsephone.py
- Zanurkuj w Pythonie/Źródła/kgptest.py
- Zanurkuj w Pythonie/Źródła/makerealworddoc.py
- Zanurkuj w Pythonie/Źródła/pyfontify.py
- Zanurkuj w Pythonie/Źródła/pluraltest.py
- Zanurkuj w Pythonie/Źródła/regression.py
- Zanurkuj w Pythonie/Źródła/search.py
- Zanurkuj w Pythonie/Źródła/openanything.py
- Zanurkuj w Pythonie/Źródła/fileinfo_fromdict.py
- Zanurkuj w Pythonie/Źródła/fullpath.py
- Zanurkuj w Pythonie/Źródła/plural/stage5/pluraltest5.py
- Zanurkuj w Pythonie/Źródła/plural/stage5/plural5.py
- Zanurkuj w Pythonie/Źródła/plural/stage3/plural3.py
- Zanurkuj w Pythonie/Źródła/plural/stage3/pluraltest3.py
- Zanurkuj w Pythonie/Źródła/plural/stage4/plural4.py
- Zanurkuj w Pythonie/Źródła/plural/stage4/pluraltest4.py
- Zanurkuj w Pythonie/Źródła/plural/stage6/plural6.py
- Zanurkuj w Pythonie/Źródła/plural/stage6/pluraltest6.py
- Zanurkuj w Pythonie/Źródła/plural/stage2/plural2.py
- Zanurkuj w Pythonie/Źródła/plural/stage2/pluraltest2.py
- Zanurkuj w Pythonie/Źródła/plural/stage1/plural1.py
- Zanurkuj w Pythonie/Źródła/plural/stage1/pluraltest1.py
- Zanurkuj w Pythonie/Źródła/autosize.py
- Zanurkuj w Pythonie/Źródła/unicode2koi8r.py
- Zanurkuj w Pythonie/Źródła/apihelpertest.py
- Zanurkuj w Pythonie/Źródła/argecho.py
- Zanurkuj w Pythonie/Źródła/soundex.py
- Zanurkuj w Pythonie/Źródła/roman.py
- Zanurkuj w Pythonie/Źródła/piglatin.py
- Zanurkuj w Pythonie/Źródła/romantest.py
- Zanurkuj w Pythonie/Źródła/colorize.py
- Zanurkuj w Pythonie/Źródła/builddialectexamples.py
- Zanurkuj w Pythonie/Źródła/statsout.py
- Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3c.py
- Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3d.py
- Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3b.py
- Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3a.py
- Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4a.py
- Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4c.py
- Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4d.py
- Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4b.py
- Zanurkuj w Pythonie/Źródła/soundex/stage2/soundex2a.py
- Zanurkuj w Pythonie/Źródła/soundex/stage2/soundex2b.py
- Zanurkuj w Pythonie/Źródła/soundex/stage2/soundex2c.py
- Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1b.py
- Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1e.py
- Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1a.py
- Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1d.py
- Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1c.py
- Zanurkuj w Pythonie/Źródła/plural.py
Sposób zwracania się do czytelnika
edytujUjednolicenie terminologii
edytujWszelkie tłumaczenia technicznych pojęć muszą się pokrywać z przedstawionymi w słowniku. Jeśli jakiegoś pojęcia nie ma, to powinno się je dodać. W podręczniku podczas pierwszego wystąpienia jakiegoś technicznego zwrotu, należy w nawiasie umieścić jego angielski odpowiednik.
Słownik
edytuj- dictionary
- słownik
- delimiter
- separator (coś co oddziela), ogranicznik (coś co ogranicza)
- dispatcher
- funkcja pośrednicząca
- doc string
- notka dokumentacyjna
- file-like object
- obiekt plikopodobny
- multi-variable assignment
- wielozmienne przypisanie
- nested scope
- zagnieżdżona przestrzeń nazw
- overload
- nadpisywać
- tuple
- krotka
- unit testing
- testowanie jednostkowe
- slice
- wycinek
- slicing
- wycinanie
- string
- napis (tłumaczenie bardziej intuicyjne dla początkującego) albo łańcuch znaków. Z reguły krótkie łańcuchy znaków będziemy tłumaczyć jako napis, dłuższe jako łańcuch znaków.
- list comprehension
- wyrażenie listowe, jeśli chodzi o konstrukcję
[x for x in y]
. W odniesieniu do czynności — odwzorowywanie listy.
Poprawa różnych błędów
edytujKolorowanie kodu
edytujNie kolorujemy ręcznie kodu. Jest to zbyt pracochłonne i niszczy czytelność źródła strony. Do tego celu został stworzony skrypt, który to robi za nas, automatycznie podczas wgrywania strony (wymaga JavaScriptu). Aby włączyć podświetlanie składni do każdej strony wstawiamy kod {{Podświetl|py}}, a następnie każdy kod Pythona pod znaczniki <code>...</code> np. <code>def</code> lub pod blok pre.
Szablony
edytujW podręczniku wykorzystujemy poniższe szablony:
- Nawigacja
{{Nawigacja|Zanurkuj w Pythonie| [[../Instalacja|Instalacja]]| [[../Wbudowane typy danych|Wbudowane typy danych]]| }}
- Porada, informacja
{{Infobox|Tekst}}
Otrzymamy:
Tekst |
- Uwaga
{{Uwaga|Tekst uwagi}}
Otrzymamy:
Uwaga!
|