May 1999. Staszek Wawrykiewicz (StaW@gust.org.pl). Public domain.

Dokumentacja po polsku i po angielsku (nizej).
The documentation in Polish and in English (below).

------------------------------------------------------------------------
POLSKI (bez znakow diakrytycznych):
------------------------------------------------------------------------

Pakiet PLaTeX dostarcza narzedzi potrzebnych do skladu dokumentow
w jezyku polskim LaTeXem 2e.
Autorzy pakietu: Mariusz Olko i Marcin Woli\'nski.
Wiecej informacji na temat samego pakietu -- patrz plik czytaj.txt.
Dokumentacja ponizsza omawia pokrotce tworzenie formatow ze wsparciem
dla jez. polskiego i ich uzycie w srodowisku opartym na web2c.

I. Przygotowanie formatu LaTeX2e do obslugi jez. polskiego
   Istnieja tu dwie metody:
   1. tzw. ,,standardowa'': nalezy uruchomic program texconfig, a w nim
      menu ,,Hyphen'', ktore pozwala na modyfikacje pliku language.dat.
      Nalezy uaktywnic wzorce dzielenia wyrazow dla jez. polskiego (usunac
      znak `%' przed plhyph.tex i ew. zablokowac takim znakiem niepozadane
      wzorce dzielenia). Po opuszczeniu menu wygenerowany zostanie format
      latex.fmt zawierajacy wybrane wzorce dzielenia oraz mechanizm Babel;
      texconfig tworzy ponadto dowiazanie (lub program) uruchamiane
      poleceniem `latex'.
   2. ,,niestandardowa'', ktora tworzy ,,czysty'' format LaTeX2e zawierajacy
      jedynie wybrane wzorce dzielenia wyrazow, bez zbednego smiecia Babel. 
      Jest to metoda preferowana przez wielu polskich uzytkownikow. ;-)
      Niniejsza dystrybucja umozliwia wygenerowanie takiego formatu
      o nazwie platex.fmt przy pomocy programu texconfig, menu ,,Formats''.
   Deklaracje formatow znajduja sie w pliku texmf/web2/fmtutil.cnf
   Plik ten mozna modyfikowac zgodnie z zawartymi w nim wskazowkami, po czym
   uruchomienie programu
          fmtutil --all
   wygeneruje wszystkie potrzebne formaty (`fmtutil --help' wyswietla 
   dostepne opcje).
   Uwaga: w podobny sposob mozna wygenerowac format pdflatex.fmt
   dla programu pdfTeX -- wersji TeX-a tworzacej od razu pliki PDF.

II. Uzycie: aktualne implementacje bazujace na webc 7.3 pozwalaja wreszcie
      na prawidlowe przekodowanie znakow diakrytycznych w pliku TeX-owym
      na wewnetrzna reprezentacje. Przekodowanie dziala tez w druga
      strone, kiedy TeX wyswietla komunikaty i zapisuje pliki .log, .toc,
      .idx itp. Do tego celu uzywa sie zewnetrznych, czytelnych plikow TCX.
      Co wiecej, przekodowanie (plik TCX) moze byc deklarowane bezposrednio
      w pliku TeX-owym. Jesli _pierwszy_ wiersz pliku zawiera np.:
           %&platex --translate-file=il2-pl
      moze byc przetworzony za pomoca polecenia: `tex plik.tex'.
      Zostanie wtedy wczytany format platex.fmt oraz tablica il2-pl.tcx
      przekodowania z iso8859-2 (latin2) do ukladu fontow PL (wewnetrznego
      dla programu TeX). Tym samym zbedna jest deklaracja w preambule pliku
      LaTeX-owego
           \usepackage[latin2]{inputenc}
      Mozemy uzyc takze polecenia:
          `platex --translate-file=TCXFILE myfile.tex' lub wrecz
          `platex myfile.tex'
      gdy plik `myfile.tex' zawiera w _pierwszym_ wierszu:
           %& --translate-file=TCXFILE
      W tej dystrybucji dostarczono szereg plikow TCX. Mozna je znalezc
      w katalogu texmf/web2c/:
           amiga-pl.tcx   AmigaPL <--> kodowanie PL
           il2-pl.tcx     iso8859-2 (latin2) <--> kodowanie PL
           cp1250-pl.tcx  Windows cp1250 <--> kodowanie PL
           cp852-pl.tcx   IBM cp852 <-->  kodowanie PL
           maz-pl.tcx     Mazovia <--> kodowanie PL

III. Polskie fonty PostScriptowe
     Instalacja podstawowa moze nie zawierac wersji Type 1 fontow PL,
     znajduja sie one wsrod pakietow dodatkowych (goodies).
     Fonty te mozna pobrac takze z najblizszego wezla CTAN lub jego kopii:
         CTAN/fonts/psfonts/polish/plpsfont/
     albo skopiowac z CD TeX Live.
     Pliki .pfb nalezy skopiowac do nowo utworzonego katalogu instalacji:
     texmf/fonts/type1/public/pl/
     po czym nalezy zaktualizowac baze danych instalacji (`mktexlsr').
     Sterownik Dvips jest juz przygotowany do pracy z fontami PL, wystarczy
     uruchomic:
          dvips -P pl plik.dvi
     Po dolaczeniu zawartosci pliku texmf/dvips/config/pl.map
     do pliku texmf/dvips/config/psfonts.map podawanie parametru `-Ppl'
     bedzie zbedne i polskie fonty .pfb beda ladowane przez program Dvips.
     Aby fonty PL Type 1 byly uzyte przez program pdfTeX mozna dodac do
     zawartosci pliku texmf/pdftex/config/pdftex.cfg wiersz: 
          map +pl.map
     albo dolaczyc zawartosc pl.map do pliku texmf/dvips/config/pdftex.map.
     Aktualizacje map fontowych dla programow Dvips, pdfTeX i in. ulatwia
     obecnie skrypt texmf/dvips/config/updmap -- wystarczy go zmodyfikowac
     i uruchomic. Powyzszy opis mial na celu jedynie przyblizenie
     Czytelnikowi tego, co wykonuje updmap. ;-)

------------------------------------------------------------------------
ENGLISH:
------------------------------------------------------------------------

PLaTeX provides tools to typeset documents in Polish using LaTeX2e.
Authors: Mariusz Olko & Marcin Woli\'nski.
This document describes shortly creation of latex.fmt (or platex.fmt)
for Polish and usage in web2c based environement.
See readme.txt for more informations about the PLaTeX package.

I. Preparing LaTeX2e format for Polish
   There are two methods:
   1. `standard': just run texconfig and activate polish hyphenation patterns;
       as a result, latex.fmt including Babel machinery will be generated.
   2. `non standard': it produces a clean and generic LaTeX2e without Babel
       deadwood, containing only patterns for Polish and US English; this
       method is prefered by many users in Poland. ;-)
       The distribution allows to generate such a format: platex.fmt.
       It can be build with texconfig, `Formats' menu.
   Declarations of all formats are in texmf/web2/fmtutil.cnf self-documented
   file. Just modify it and run 
          fmtutil --all
   to regenerate all needed formats (see `fmtutill --help' for other options).

II. Usage: the current implementations based on web2c 7.3 allow (hopefully)
       proper reencoding of input national characters into internal TeX's, 
       and back again, for all messages, .log, .toc, .idx files written by
       TeX, etc. External readable TCX translation files are used and they
       can be specified explicitly in the TeX file or in the command line.
       If the _first_ line of TeX's file contains a structured comment
       of the form
           %&platex --translate-file=il2-pl
       it suffices to run `tex file.tex' with platex.fmt and il2-pl.tcx
       translation table (iso8859-2 latin2 to internal PL reencoding).
       You can use TCX tables instead of LaTeX's
           \usepackage[latin2]{inputenc}
       If we use latex.fmt with Polish patterns we can compile our file
       with the command `latex --translate-file=TCXFILE myfile.tex'
       or just `latex myfile.tex,' where the first line of myfile.tex
       contains a structured comment
           %& --translate-file=TCXFILE
       Several TCX files are provided; they can be found in the texmf/web2c/
       directory:
           amiga-pl.tcx   AmigaPL <--> PL encoding
           il2-pl.tcx     iso8859-2 (latin2) <--> PL encoding
           cp1250-pl.tcx  Windows cp1250 <--> PL encoding
           cp852-pl.tcx   IBM cp852 <--> PL encoding
           maz-pl.tcx     Mazovia <--> PL encoding

III. Polish PostScript fonts in Type 1 format
     The base installation usually does not contain Type 1 PL fonts,
     however they can be found in additional `goodies' package.
     PFB files can be also dowloaded from the nearest CTAN node or its mirror:
         CTAN/fonts/psfonts/polish/plpsfont/
     or copied from CD TeX Live.
     PFB files should reside in the newly created directory of
     our installation: texmf/fonts/type1/public/pl/
     The final step is refreshing the ls-R database of installation:
     `mktexlsr.'
     Dvips is already prepared for PL fonts in Type 1; just run:
          dvips -Ppl myfile.dvi
     If the contents of texmf/dvips/config/pl.map is included
     into the standard texmf/dvips/config/psfonts.map, `-Ppl' is not even
     needed. In order to use Type 1 fonts with pdfTeX the line
         map +pl.map 
     can be added to the contents of texmf/pdftex/config/pdftex.cfg, or
     the contents of `pl.map' can be added to texmf/dvips/config/pdftex.map.
     The process of preparation of map files for Dvips, pdfTeX, etc.,
     is now much easier: it suffices to modify and next to run
     texmf/dvips/config/updmap script. The above description is only
     a reference what is done by updmap script. ;-)

------------------------------------------------------------------------
