Zanurkuj w Pythonie/Zalecenia dla autorów

Z Wikibooks, biblioteki wolnych podręczników.
Skocz do: nawigacja, szukaj

O podręczniku[edytuj]

Książ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[edytuj]

Proces tłumaczenia został już zakończony. Teraz trzeba zrobić poprawki.

Poprawki[edytuj]

Podrę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[edytuj]

W 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):

  1. Zanurkuj w Pythonie/Źródła/fileinfo.py (ok)
  2. Zanurkuj w Pythonie/Źródła/apihelper.py (ok)
  3. Zanurkuj w Pythonie/Źródła/odbchelper.py (ok)
  4. Zanurkuj w Pythonie/Źródła/fibonacci.py (ok)
  5. Zanurkuj w Pythonie/Źródła/kgp/stdout.py (ok)
  6. Zanurkuj w Pythonie/Źródła/kgp/toolbox.py (ok)
  7. Zanurkuj w Pythonie/Źródła/kgp/stderr.py (ok)
  8. Zanurkuj w Pythonie/Źródła/kgp/kgp.py (ok)
  9. Zanurkuj w Pythonie/Źródła/BaseHTMLProcessor.py (ok)
  10. Zanurkuj w Pythonie/Źródła/dialect.py (ok)
  11. Zanurkuj w Pythonie/Źródła/urllister.py (ok)
  12. Zanurkuj w Pythonie/Źródła/soundextest.py (ok)
  13. Zanurkuj w Pythonie/Źródła/odbchelpertest.py (ok)
  14. Zanurkuj w Pythonie/Źródła/roman/stage9/romantest9.py (ok)
  15. Zanurkuj w Pythonie/Źródła/roman/stage9/roman9.py (ok)
  16. Zanurkuj w Pythonie/Źródła/roman/stage5/roman5.py (ok)
  17. Zanurkuj w Pythonie/Źródła/roman/stage5/romantest5.py
  18. Zanurkuj w Pythonie/Źródła/roman/stage3/roman3.py (ok)
  19. Zanurkuj w Pythonie/Źródła/roman/stage3/romantest3.py
  20. Zanurkuj w Pythonie/Źródła/roman/stage4/romantest4.py
  21. Zanurkuj w Pythonie/Źródła/roman/stage4/roman4.py (ok)
  22. Zanurkuj w Pythonie/Źródła/roman/stage8/roman83.py
  23. Zanurkuj w Pythonie/Źródła/roman/stage8/roman82.py
  24. Zanurkuj w Pythonie/Źródła/roman/stage8/romantest81.py
  25. Zanurkuj w Pythonie/Źródła/roman/stage8/roman81.py
  26. Zanurkuj w Pythonie/Źródła/roman/stage8/romantest83.py
  27. Zanurkuj w Pythonie/Źródła/roman/stage8/romantest82.py
  28. Zanurkuj w Pythonie/Źródła/roman/stage6/roman62.py (ok)
  29. Zanurkuj w Pythonie/Źródła/roman/stage6/roman61.py (ok)
  30. Zanurkuj w Pythonie/Źródła/roman/stage6/romantest62.py
  31. Zanurkuj w Pythonie/Źródła/roman/stage6/romantest61.py
  32. Zanurkuj w Pythonie/Źródła/roman/stage7/roman71.py
  33. Zanurkuj w Pythonie/Źródła/roman/stage7/romantest71.py
  34. Zanurkuj w Pythonie/Źródła/roman/stage7/romantest72.py
  35. Zanurkuj w Pythonie/Źródła/roman/stage7/roman72.py
  36. Zanurkuj w Pythonie/Źródła/roman/stage2/roman2.py (ok)
  37. Zanurkuj w Pythonie/Źródła/roman/stage2/romantest2.py
  38. Zanurkuj w Pythonie/Źródła/roman/stage1/roman1.py (ok)
  39. Zanurkuj w Pythonie/Źródła/roman/stage1/romantest1.py
  40. Zanurkuj w Pythonie/Źródła/parsephone.py
  41. Zanurkuj w Pythonie/Źródła/kgptest.py
  42. Zanurkuj w Pythonie/Źródła/makerealworddoc.py
  43. Zanurkuj w Pythonie/Źródła/pyfontify.py
  44. Zanurkuj w Pythonie/Źródła/pluraltest.py
  45. Zanurkuj w Pythonie/Źródła/regression.py
  46. Zanurkuj w Pythonie/Źródła/search.py
  47. Zanurkuj w Pythonie/Źródła/openanything.py
  48. Zanurkuj w Pythonie/Źródła/fileinfo_fromdict.py
  49. Zanurkuj w Pythonie/Źródła/fullpath.py
  50. Zanurkuj w Pythonie/Źródła/plural/stage5/pluraltest5.py
  51. Zanurkuj w Pythonie/Źródła/plural/stage5/plural5.py
  52. Zanurkuj w Pythonie/Źródła/plural/stage3/plural3.py
  53. Zanurkuj w Pythonie/Źródła/plural/stage3/pluraltest3.py
  54. Zanurkuj w Pythonie/Źródła/plural/stage4/plural4.py
  55. Zanurkuj w Pythonie/Źródła/plural/stage4/pluraltest4.py
  56. Zanurkuj w Pythonie/Źródła/plural/stage6/plural6.py
  57. Zanurkuj w Pythonie/Źródła/plural/stage6/pluraltest6.py
  58. Zanurkuj w Pythonie/Źródła/plural/stage2/plural2.py
  59. Zanurkuj w Pythonie/Źródła/plural/stage2/pluraltest2.py
  60. Zanurkuj w Pythonie/Źródła/plural/stage1/plural1.py
  61. Zanurkuj w Pythonie/Źródła/plural/stage1/pluraltest1.py
  62. Zanurkuj w Pythonie/Źródła/autosize.py
  63. Zanurkuj w Pythonie/Źródła/unicode2koi8r.py
  64. Zanurkuj w Pythonie/Źródła/apihelpertest.py
  65. Zanurkuj w Pythonie/Źródła/argecho.py
  66. Zanurkuj w Pythonie/Źródła/soundex.py
  67. Zanurkuj w Pythonie/Źródła/roman.py
  68. Zanurkuj w Pythonie/Źródła/piglatin.py
  69. Zanurkuj w Pythonie/Źródła/romantest.py
  70. Zanurkuj w Pythonie/Źródła/colorize.py
  71. Zanurkuj w Pythonie/Źródła/builddialectexamples.py
  72. Zanurkuj w Pythonie/Źródła/statsout.py
  73. Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3c.py
  74. Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3d.py
  75. Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3b.py
  76. Zanurkuj w Pythonie/Źródła/soundex/stage3/soundex3a.py
  77. Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4a.py
  78. Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4c.py
  79. Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4d.py
  80. Zanurkuj w Pythonie/Źródła/soundex/stage4/soundex4b.py
  81. Zanurkuj w Pythonie/Źródła/soundex/stage2/soundex2a.py
  82. Zanurkuj w Pythonie/Źródła/soundex/stage2/soundex2b.py
  83. Zanurkuj w Pythonie/Źródła/soundex/stage2/soundex2c.py
  84. Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1b.py
  85. Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1e.py
  86. Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1a.py
  87. Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1d.py
  88. Zanurkuj w Pythonie/Źródła/soundex/stage1/soundex1c.py
  89. Zanurkuj w Pythonie/Źródła/plural.py

Sposób zwracania się do czytelnika[edytuj]

Ujednolicenie terminologii[edytuj]

Wszelkie 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[edytuj]

Kolorowanie kodu[edytuj]

Nie 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[edytuj]

W podręczniku wykorzystujemy poniższe szablony:

  • Nawigacja
 {{Nawigacja|Zanurkuj w Pythonie|
  [[../Instalacja|Instalacja]]|
  [[../Wbudowane typy danych|Wbudowane typy danych]]|
 }}
  • Porada, informacja
{{Infobox|Tekst}}

Otrzymamy:

  • Uwaga
{{Uwaga|Tekst uwagi}}

Otrzymamy: