**********************************************************************
*                                                                    *
*                Pakiet Polski czyli LaTeX2e po polsku               *
*                                                                    *
*                                                                    *
*                                                                    *
*  Copyright (C) 1994 by Mariusz Olko.                               *
*  Copyright (C) 1997 by Mariusz Olko and Marcin Woli\'nski.         *
*  Copyright (C) 2000,2002,2003,2007,2017,2021 by Marcin Woli\'nski. *
*                                                                    *
**********************************************************************


��������� Informacje og��lne

Pakiet ���Polski��� dostarcza narz��dzi potrzebnych do sk��adu dokument��w
w��j��zyku polskim LaTeXem 2e.  G����wne cechy pakietu

��� umo��liwia sk��ad ���czcionkami PL��� pochodz��cymi z pakietu MeX
��� umo��liwia sk��ad czcionkami w ukladzie T1 (europejskim)
��� umo��liwia sk��ad czcionkami w ukladzie QX, w szczeg��lno��ci krojami
  TeX Gyre (dawniej Quasi) tworzonymi przez JNS Team 
��� umo��liwia skompilowanie dokumentu nawet wtedy, gdy dost��pne s��
  jedynie oryginalne czcionki Computer Modern
��� wykorzystuje polskie wzorce przenoszenia
��� dzia��a z _formatem_ Babel z polskimi wzorcami przenoszenia
��� wspomaga prace z r����nymi wej��ciowymi stronami kodowymi
��� wspomaga ���notacj�� ciachow����� polskich znak��w
��� posiada tryb 99.99% zgodno��ci z LaMeXem (polsk�� adaptacj�� LaTeXa 2.09)

Dodatkowo do����czone s�� dwa pakiety, kt��re pozwol�� pos��u��y�� si��
LaTeXem 2e w najbardziej nawet nieprzyjaznym otoczeniu:

��� pakiet plprefix pozwala na uzyskanie polskich liter przy pomocy
  notacji prefiksowej z dowolnie wybranym prefiksem (pomocny
  np. do robienia wydrukow z CWEBa).
��� pakiet OT1patch dorabia ogonki wg najlepszych znanych standard��w do
  oryginalnych czcionek CM (kod Leszka Holenderskiego).

Nie zach��camy do stosowania tych pakietow, poza szczeg��lnymi
przypadkami.  S��dzimy, ��e powody do ich stosowania znik��y w
wi��kszo��ci system��w komputerowych co najmniej 10 lat temu.

  Obecnie nie ma powod��w ze strony samego TeXa ��eby nie u��ywa�� dla
polskich znak��w naturalnej notacji o��miobitowej.  Notacja prefiksowa
jest w dzisiejszych czasach nienaturalnym dziwactwem.  Wyj��tek
stanowi�� jeszcze pewne nieprzyjazne ��rodowiska obliczeniowe, w kt��rych
nie spos��b wy��wietli�� polskich znak��w.  Na t�� okoliczno���� polski.sty
oferuje notacj�� ciachow�� (polecenie \prefixing).

  Polskie znaki obecne w fontach zawsze b��d�� dawa�� lepsze efekty ni��
stosowanie protez zawartych w OT1patch.  Poza tym u��ywanie OT1patch
nie pozwala na pe��ne zastosowanie polskich wzorc��w przenoszenia.

��������� Licencja

���Polski��� stanowi oprogramowanie swobodne, mo��e by�� dystrybuowany w
zgodzie z licencj�� LaTeX Project Public License (zob. plik lppl.txt w
dystrybucji LaTeXa; CTAN:macros/latex/base/lppl.txt).

��������� Pliki wchodzace w sk��ad pakietu

W sk��ad pakietu wchodzi kilka plik��w zawieraj��cych udokumentowane 
(w wi��kszosci :-) ��r��d��a makr.

��� polski.dtx ��� zawiera ��r��d��a pakietu polski
��� polski.ins ��� g����wny skrypt instalacyjny
��� strony.dtx ��� plik z wej��ciowymi stronami kodowymi dla LaTeXa oraz
  definicj�� uk��adu czcionek OT4
��� plfonts.fdd ��� definicje czcionek PL do wykorzystania w LaTeXu
��� plprefix.dtx ��� zawiera ��r��d��a pakietu pozwalaj��cego na uzyskiwanie
  polskich liter za pomoc�� ���notacji prefiksowej���
��� plprefix.ins ��� skrypt instalacyjny dla plprefix.sty
��� ot1patch.dtx ��� zawiera ��r��d��a pakietu dorabiaj��cego ogonki
  do oryginalnych czcionek Computer Modern
��� ot1patch.ins ��� skrypt instalacyjny dla ot1patch.sty
��� czytaj.txt ��� ten plik
��� readme.txt ��� opis instalacji po angielsku
��� conowego.txt ��� lista zmian w pakiecie
��� sample-polski.tex ��� przyk��adowy dokument
��� sample-rysunek{.mp,1.mps} ��� rysunek do przyk��adowego dokumentu

��������� Instalacja pakietu

Po rozpakowaniu archiwum nale��y wygenerowa�� wszystkie potrzebne pliki
uruchamiaj��c skrypt polski.ins

      tex polski.ins 

Skrypt wygeneruje na pocz��tek podstawowe pliki, tzn. pakiet polski.sty
oraz opisy wejsciowych stron kodowych.  Nast��pnie generowane s�� pliki
opisuj��ce fonty Computer Modern w polskim uk��adzie OT4 (tzw. ���fonty
PL���). Na zako��czenie nale��y skopiowa�� pliki *.fd *.sty *.def *.cfg do
katalogu czytanego przez TeXa.

Do poprawnego sk��adu po polsku konieczna jest obecno���� polskich
wzorc��w przenoszenia wyraz��w w tzw. formacie LaTeXa.  Zestaw wzorc��w
przenoszenia wbudowany w format zale��y od zawarto��ci pliku
language.dat (zob. dokumentacj�� LaTeXa).  Wsp����czesne implementacje
TeXa zawieraj�� pomocnicze narz��dzia automatyzuj��ce generowanie
format��w.  Zwykle wi��c wystarczy w narz��dziu konfiguracyjnym wybra��
cz������ zatytu��owan�� ���J��zyki��� i zaznaczy�� odpowiednie wzorce
przenoszenia.
W systemie emTeX (pod MS DOS-em) do generowania formatu nale��a��o u��y��
polecenia:
	tex386  /i/o/r/8 /mt13000 latex.ltx


��������� Dokumentacja

Pliki dtx zawieraj�� teksty makr wraz z dokumentacj��.  S�� one gotowe
do wydruku po przetworzeniu przez LaTeXa.  Instrukcj�� pos��ugiwania si��
pakietem polski mo��na uzyska�� uruchamiaj��c
    latex polski.dtx
a dalej u��ywaj��c swojego ulubionego programu do podgl��du.


��������� Osmiobitowe wprowadzanie polskich liter

Aby z��o��y�� w TeXu dokument zapisany w tzw. stronie kodowej trzeba
wskaza�� TeXowi, w jakiej stronie dokument jest zapisany.  Mo��liwe s��
dwa sposoby:

��� Pos��u��enie si�� mechanizmem przekodowywania znak��w na posta��
wewn��trzn�� przez samego TeXa.  W chwili obecnej stosowne wsparcie jest
obecne co najmniej w web2c, teTeXu, TeXlive, fpTeXu, mikTeXu i emTeXu.

��� Zastosowanie standardowego pakietu inputenc.

Przekodowywanie nie pozwala na prac�� z kilkoma wej��ciowymi stronami
kodowymi w jednym dokumencie ani fontami o r����nych uk��adach polskich
znak��w.  Jest za to bardziej bezpieczne ze wzgledu na wsp����prac�� z
programami zewn��trznymi (np. MakeIndex).  Nale��y r��wnie�� zwr��ci��
uwag��, ��e przekodowanie na poziomie implementacji jest zale��ne od
uk��adu stosowanych font��w.  Definicje przekodowania przygotowane dla
font��w PL z konieczno��ci mapuj�� tylko ���polskie znaki���.  Dla
kontrastu definicje stron kodowych pakietu inputenc (np. cp1250 czy
cp852) obejmuj�� wszystkie znaki strony kodowej (w����cznie ze znakami
nieliterowymi).  Pakiet inputenc pozwala r��wnie�� przetwarza�� dokumenty
zakodowane w Unikodzie zapisanym w formie UTF-8 (opcja utf8).

Oto szczeg����y specyficzne dla implementacji:

������������������ web2c, teTeX, TeXlive, fpTeX, mikTeX

W tych implementacjach kodowanie dokumentu zadaje si�� za pomoc�� opcji
--translate-file wskazuj��cej plik definiuj��cy przekodowanie.  Na
przyk��ad

	latex --translate-file=il2-pl dokument.tex

przetwarza dokument z polskimi znakami zapisanymi w kodzie ISO
Latin-2.  Mo��na r��wnie��, i jest to rozwi��zanie zalecane, zada�� kod w
pierwszej linii dokumentu za pomoc�� nast��puj��cego ���magicznego���
komentarza:

%&latex --translate-file=il2-pl

W tym przypadku do przetwarzania dokumentu wystarczy

	latex dokument.tex

W standardowej dystrybucji zawarta jest spora gar���� plik��w
definiuj��cych przekodowanie.  Pliki te maj�� rozszerzenie .tcx i
rezyduj�� w podkatalogu texmf/web2c korzenia instalacji.  S�� to pliki
tekstowe, o realizowanym przekodowaniu mo��na dowiedzie�� si�� z
komentarza w pierwszych liniach pliku.

������������������ emTeX

W przypadku pracy z emTeXem przekodowanie musi zosta�� ���zaszyte��� w��plik
formatu.  Je��eli ma si�� do czynienia z dokumentami w r����nych stronach
kodowych, konieczny jest oddzielny plik formatu dla ka��dej strony.

Pliki przekodowa�� dla polskich znak��w dla emTeXa dostarczane s�� z
MeXem.  Na przyk��ad poni��sze polecenie generuje format LaTeX z
kodowaniem Mazovii:

    tex386  /i/o/r /cmaz2pl /mt13000 latex.ltx


������������������ implementacje nie zapewniaj��ce przekodowania

W przypadku korzystania z takiej implementacji (lub ch��ci u��ycia w
jednym dokumencie r����nie zakodowanych fragment��w) nale��y do preambu��y
dokumentu doda�� wywo��anie pakietu inputenc z opcj�� wskazuj��c�� stron��
kodow��, np.
    \documentclass{article}
    \usepackage{polski}
    \usepackage[mazovia]{inputenc}

Podczas instalacji pakietu Polski tworzone sa pliki ze stronami kodowymi:

mazovia     ��� dla popularnej (kiedy��) strony kodowej na PCetach.
amigapl     ��� dla polskiej strony kodowej u��ywanej na Amidze

Ponadto w dystrybucji LaTeXa zawarte s�� nast��puj��ce strony
interesuj��ce dla polskiego u��ytkownika:

cp1250      ��� dla Windowsowej strony centralnoeuropejskiej CP1250
latin2      ��� kodowanie ISO 8859-2 (Latin-2)
cp852       ��� dla DOS-owej strony CP852 (tzw. IBM Latin-2)
macce       ��� dla strony centralnoeuropejskiej na komputerach Macintosh
utf8        ��� kodowanie UTF-8 (Unikod; to w zasadzie nie jest strona
              kodowa, ale zasada u��ycia jest ta sama)

Wi��kszo���� instalacji TeXowych czyta osmiobitowe znaki zawarte w
dokumentach.  Niekt��re starsze implementacje wymagaj�� u��ycia do tego
specjalnej opcji podczas generowania formatu.

��������� Podzi��kowania

��� Marek Ry��ko i Bogus��aw Jackowski stworzyli MeXa i LaMeXa
��� Robert Ramiega przys��a�� tablic�� kodow�� u��ywan�� na Amidze
��� Staszek Wawrykiewicz napisa�� dokument przyk��adowy i, co wa��niejsze,
  zanurzy�� ca��o���� w kontekst TeXlive




**********************************************************************
 Marcin Woli\'nski                         mailto:wolinski@gust.org.pl
**********************************************************************