**********************************************************************
*                                                                    *
*                   PLaTeX 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 by Marcin Woli\'nski.                *
*                                                                    *
**********************************************************************


--- Informacje ogolne

Pakiet PLaTeX dostarcza narzedzi potrzebnych do skladu dokumentow
w jezyku polskim LaTeXem 2e.  Glowne cechy pakietu

* wspiera sklad czcionkami `pl' pochodzacymi z pakietu MeX
* wspiera sklad czcionkami w ukladzie T1 znanymi jako czcionki EC
* wspiera sklad czcionkami w ukladzie QX, w szczegolnosci krojami
  'Quasi' tworzonymi przez JNS Team 
* umozliwia skompilowanie dokumentu nawet wtedy gdy dostepne sa
  jedynie czcionki `CM'
* wspolpracuje z polskimi wzorcami przenoszenia
* dziala z _formatem_ Babel z polskimi wzorcami przenoszenia
* pozwala wygenerowac format LaTeX z polskimi wzorcami przenoszenia,
  zgodny z Bablem ale bez jego makr
* wspomaga notacje `ciachowa'
* posiada tryb 99.99% zgodnosci z LaMeXem
* wspomaga prace z roznymi wejsciowymi stronami kodowymi

Dodatkowo dolaczone sa dwa style, ktore pozwola posluzyc sie 
LaTeXem 2e w najbardziej nawet nieprzyjaznym otoczeniu.

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

Nie zachecamy do stosowania tych pakietow, poza szczegolnymi
przypadkami.

  Obecnie nie ma powodów ze strony samego TeXa żeby nie używać dla
polskich znaków naturalnej notacji ośmiobitowej.  Notacja prefiksowa
staje się z wolna nienaturalnym dziwactwem.  Wyjątek stanowią jeszcze
pewne nieprzyjazne środowiska obliczeniowe.  Na tę okoliczność
polski.sty oferuje notację ciachową.  Niezaleznie od opinii na dobor
takiego czy innego znaku jako prefix uwazamy, ze im mniej sprzecznych
,,standardow'' tym lepiej.  Jeśli trzeba, używajcie ciacha!

  Polskie znaki sa powszechnie dostepne w MeXu od lat a obecnie
rowniez w zestawie czcionek EC dostepnych w wiekszosci dystrybucji
TeXa i zawsze beda dawac lepsze efekty niz stosowanie protez zawartych
w OT1patch.  Poza tym uzywanie OT1patch nie pozwala na pelne
zastosowanie polskich wzorcow przenoszenia.

--- Licencja

PLaTeX 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 sklad pakietu

W sklad pakietu wchodzi kilka plikow zawierajacych udokumentowane 
(w wiekszosci :-) zrodla makr.

* polski.dtx - zawiera zrodla pakietu polski
* strony.dtx - plik z wejsciowymi stronami kodowymi dla LaTeXa oraz
  definicja ukladu czcionek OT4
* plfonts.fdd - definicje czcionek `PL' do wykorzystania w LaTeXu
* platex.ins - glowny skrypt instalacyjny
* polski.ins - skrypt generujacy podstawowe pliki pakietu
* plprefix.dtx - zawiera zrodla stylu pozwalajacego na uzyskiwanie
  polskich liter przy pomocy znakow innych niz /
* plprefix.ins - skrypt instalacyjny dla plprefix.sty
* ot1patch.dtx - zawiera zrodla stylu dorabiajacego ogonki
  do czcionek CM
* ot1patch.ins - skrypt instalacyjny dla ot1patch.sty
* czytaj.txt - ten plik
* readme.txt - opis instalacji po angielsku
* conowego.txt - lista zmian w pakiecie

--- Instalacja pakietu

Po rozpakowaniu pakietu nalezy wygenerowac wszystkie potrzebne pliki
uruchamiajac skrypt platex.ins
      tex platex.ins 
Skrypt wygeneruje na poczatek podstawowe pliki pakietu tzn. styl
polski.sty, plik konfigurujacy wzorce przenoszenia wyrazow wczytywane
przez LaTeX oraz opisy wejsciowych stron kodowych.  Nastepnie
uzytkownik jest pytany czy ma zainstalowane czcionki `PL' pochodzace z
instalacji MeXa.  Jesli czcionki sa zainstalowane, generowane sa pliki
definiujace polskie czcionki dla LaTeXa.  Jesli czcionki nie sa
zainstalowane w systemie, nalezy zadbac aby nie bylo tez pliku
ot4cmr.fd na sciezce LaTeXa, aby nie wprowadzic w blad procedury
rozpoznajacej srodowisko w stylu polski.sty.  Na zakonczenie nalezy
skopiowac pliki *.fd *.sty *.def *.cfg oraz plhyph.tex do katalogu
czytanego przez TeXa podczas kompilacji.

Ostatnim etapem jest wygenerowanie nowego formatu LaTeXa.  Jest to
potrzebne dla umieszczenia w formacie polskich wzorcow przenoszenia.
Sposob generowania formatu zalezy od implementacji.  W wiekszosci
wspolczesnych implementacji trzeba wywolac program tex ze specjalna
opcja na pliku latex.ltx.  W teTeXu, web2c, TeXlive jest to
	tex -ini latex.ltx
w emTeXu
	tex386  /i/o/r /mt13000 latex.ltx

Uwaga: wygenerowanie formatu przy pomocy plikow konfiguracyjnych
zawartych w PLaTeXu powiedzie sie tylko jezeli LaTeX znajdzie pliki
hyphen.cfg i language.dat _przed_ analogicznymi plikami z pakietu
Babel, ktore moga jednoczesnie byc obecne w systemie.  Mozna to
osiagnac manipulujac zmiennymi w srodowisku (stosownie do
implementacji) lub umieszczajac hyphen.cfg i language.dat w biezacym
katalogu.
Uwaga 2: wspolczesne implementacje czesto zawieraja pomocnicze
narzedzia automatyzujace generowanie formatow.

--- Dokumentacja

Pliki dtx zawieraja teksty makr wraz z dokumentacja.  Sa one gotowe
do wydruku po przepuszczeniu przez LaTeX.  Instrukcje poslugiwania sie
stylem polski mozna uzyskac uruchamiajac
    latex polski.dtx
a dalej uzywajac swojego ulubionego podgladacza.


--- Osmiobitowe wprowadzanie polskich liter

Niezawodnym sposobem wprowadzania polskich znakow jest skorzystanie z
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.

W implementacjach, które nie dają takiego wsparcia, można zastosować
podejście przez znaki aktywne implementowane w standardowym pakiecie
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 zewnetrznymi.  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 (włącznie ze znakami nieliterowymi).

Oto szczegóły specyficzne dla implementacji:

------ web2c, teTeX, TeXlive, fpTeX, mikTeX

W tych implementacjach kodowanie dokumentu zadaje się przy pomocy
opcji --translate-file zadają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 przy pomocy 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
układach, konieczny jest oddzielny plik formatu dla każdego układu. 

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 PLaTeXa tworzone sa pliki ze stronami kodowymi:

mazovia     - dla popularnej (kiedyś) strony kodowej na PCetach.
amigapl     - dla polskiej strony kodowej uzywanej 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)

Wiekszosc instalacji TeXowych czyta osmiobitowe znaki zawarte w
dokumentach.  Niektore starsze implementacje wymagaja uzycia do tego
specjalnej opcji podczas generowania formatu.  W przypadku emTeXa jest
to opcja /8, format nalezy wygenerowac komenda
    tex386 /i /8 /mt13000 latex.ltx
Parametr /mt zwieksza wewnetrzne tablice emTeXa tak by zmiescily sie
dwa komplety wzorcow przenoszenia, amerykanski i polski.

--- Podziekowania

* Markowi i Jackowi za MeXa i LaMeXa
* Robert Ramiega przyslal tablice kodowa uzywana na Amidze




**********************************************************************
 Marcin Woli\'nski                         mailto:wolinski@gust.org.pl
                                     http://www.mimuw.edu.pl/~wolinski
**********************************************************************
