README for asc2iso Version 0.526 alpha

asc2iso 0.526 is an alpha-test version of a filter for converting
a text containing the German transcriptions ae oe ue ss/sz for the
umlaut vowels and the sharp s to a text containing the corresponding
8-bit characters according to ISO-8859-1.  It was written by adding
minor changes to what was found on
ftp.uni-stuttgart.de:/pub/tex/support/umlaute_tex.txt
which contains a program written by Dorai Sitaram (Rice University,
1990   dorai@titan.rice.edu Version 1.0) and updated by  Gustaf
Neumann (Wirtschaftsuniversitaet Wien, October 1990,
neumann@dec4.wu-wien.ac.at to become Version 1.1).
Since the original program was producing LaTeX output and this one is
producing ISO-8859-1 output the name was altered from diac to asc2iso
and the version count was set to 0.500.  This has been done by Karl
Brodowsky (University of Heidelberg, Germany, December 1993,
bro@clio.iwr.uni-heidelberg.de).  Since this program is very specific
for handling German texts the rest of this README has been written in
German.



asc2iso 0.526 ist eine alpha-test Version eines Filters fr die
Konvertierung von Texten, die die Umschreibungen der Umlaute und des
scharfen s durch ae oe ue und ss oder sz enthalten, in einen
gleichlautenden Text, der Umlaute gem ISO 8859-1 enthlt.  Dies
Programm wurde von Karl Brodowsky durch geringfgige nderungen an
einem in 
ftp.uni-stuttgart.de:/pub/tex/support/umlaute_tex.txt
liegenden Programm, dessen Autoren Dorai Sitaram und Gustaf Neumann
waren, erzeugt.  Diese nderung bezogen sich hauptschlich darauf, da
die Ausgabe nicht mehr ein LaTeX-Datei, sondern eine Textdatei mit
ISO-Umlauten ist und da jetzt auch die Umschreibung des scharfen s
mit sz verstanden wird.

STATUS:

asc2iso ist Freeware.  Es wird keine Garantie fr die korrekte
Funktionsweise oder die Brauchbarkeit in irgendeiner Form bernommen.
Es wurden Funktionen von flex-2.4.5 bernommen, die in Dateien mit
Namen flex-2.4.5-*.c liegen und die bentigt werden, um asc2iso auf
Maschinen zu kompilieren, denen libfl.a fehlt.  Autor ist in dem Fall
Vern Paxson und die Rechte liegen bei "`The Regents of the University
of California"'.  Die Dateien wurden (bis auf das Anfgen von
flex-2.4.5- am Anfang der Namen) nicht verndert.

INSTALLATION:

make

make check

make install

make clean

fertig.

Dabei kann es zu Problemen kommen, da das ganze im Grunde genommen
darauf aufbaut, da mit gcc kompiliert wird und mit flex statt lex
gearbeitet wird.  Weil das Ganze nach meiner Erfahrung mit lex
berhaupt nicht funktioniert, ist das von flex erzeugte C-Programm mit
Namen asc2iso.c im Lieferumfang enthalten und neuer als seine
eigentliche Quelle asc2iso.l.  Wer flex zur Verf"ugung hat oder f"ur
diesen Zweck installiert (was nach meiner Erfahrung sehr einfach ist),
kann auch asc2iso.l nach eigenen Bed"urfnissen "andern.

Dabei knnen einige Makevariablen durch 
make ... VARIABLE=wert
... abweichend von der Vorgabe gesetzt werden, wie man beim Ansehen
des Anfangs der Datei Makefile leicht sieht.  Wichtig sind folgende
Variablen:

CC (Vorgabe gcc)

Ein anderer C-Kompilierer ist nicht getestet worden.

CFLAGS (Vorgabe -O6)

Gute Optimierung ist zu empfehlen, aber lt sich auch abstellen.

LEXLIB (Vorgabe -lfl)

Dies gibt an, wie die Lex/Flexbibliothek dazuzubinden ist.  Wenn die
Vorgabe -lfl nicht funktioniert, mte -ll gehen oder <pfad>/libfl.a,
wenn vorhanden.  Da flex 2.4.5 verwendet wurde, um asc2iso.c zu
erzeugen und deshalb drei Funktionen benutzt werden, die in libfl.a
enthalten sind, aber in libl.a fehlen, wurden Teile des Quelltextes
von flex mitgeliefert, erkennbar an Namen der Form  flex-2.4.5-*.c.
Zur Zeit ist dies nur eine Datei von ca. 500 Byte Umfang.  Diese wird
mitkompiliert und bei Bedarf zur Anwendung gebracht.

TESTFILE (Vorgabe test-file)

Wird fr make check verwendet.  Liegt eine rechtschreibfehlerarme
Textdatei mit ISO-Umlauten vor, kann man diese auch einmal zum Testen
nehmen.  Erfahrungsgem treten dann Fehler auf und es werden auch
unter Umstnden Rechtschreibfehler gefunden.

DIFF (Vorgabe diff)

Hier sollte bevorzugt der Name verwendet werden, unter dem sich
GNU-diff verbirgt, so weit vorhanden.  Grund ist die Verfgbarkeit der
Option --text.

DIFFOPTS=--text

Diese Option ist ntzlich, weil es sonst passieren kann, da die
verglichenen Dateien wegen der Umlaute als Binrdateien verstanden
werden und nur eine Aussage ber die bereinstimmung oder die
Nichtbereinstimmung gemacht wird.  Die mitgelieferte Datei test-file
sollte natrlich hier keine Probleme bereiten, aber wer eigene Dateien
testen will, wird diese Option schtzen, soweit sie vorhanden ist.

BINDIR (Vorgabe /usr/local/bin)

Verzeichnis, in das asc2iso installiert werden soll.  Bei make install
bitte unbedingt angeben.  Oft ist hier  
make install BINDIR="$HOME/bin"
das, was man haben will.

VERWENDUNG:

asc2iso < Datei_mit_ae > Datei_mit_ISO_umlauten

sollte die Konvertierung durchfhren.  Es wird im Prinzip erkannt, ob
ein ae, oe, ue, ss oder sz als solches gemeint ist oder als
Umschreibung.  Fehler werden dabei natrlich noch auftreten, siehe
nchsten Abschnitt.  Problematisch sind solche Wrter, deren
Transkription zweideutig ist, etwa Masse oder Busse.  Dies Problem
wurde dadurch gelst, da hier jeweils Masse bzw. Busse verstanden
wurde, whrend man Masze oder Busze schreiben mu, um Mae und Bue zu
erhalten.  In diesem Fall lt sich (ebenso wie bei Eigennamen) nie
eine vollstndig befriedigende Lsung finden.

Neu ab der Version 0.526 hinzugekommen ist die Datei asc2iso.el, die
eine Schnittstelle zum Anwenden von asc2iso fr den emacs bietet.
Nheres entnehme man bitte der Datei asc2iso.el selbst.

FEHLER:

Die Dokumentation ist noch unvollstndig, was sich im Laufe der Zeit
hoffentlich ndern wird.

Fehler bei der Konvertierung treten sicher noch auf.  Damit diese in
zuknftigen Versionen eliminiert werden knnen, wre ich fr
diesbezgliche Mitteilungen dankbar.  Obwohl einige geographische
Namen verstanden werden, ist dies wohl ein Fa"s ohne Boden.  Daher
bitte ich darum, zumindest von Fehlermeldungen bez"uglich
fremdsprachiger geographischer Namen abzusehen.  Deren korrekte
Behandlung kann nur im Ausnahmefall Aufgabe dieses Programms sein und
sollte dann gegebenenfalls in einer "Anderung der eigenen Version von
asc2iso.l Ber"ucksichtigung finden.

Ebenso ist das ganze mglicherweise auf der einen oder anderen
Architektur nicht ganz so glatt kompilierbar oder nachher nicht
funktionsfhig.  Mit gcc ist es unter Nextstep, Sun-Sparc, Aix und
Linux getestet worden.  Auch Mitteilungen ber solche Fehler werden
mglicherweise in kommenden Versionen bercksichtigt, wobei ich jedoch
den Schwerpunkt auf die Untersttzung der Kompilierbarkeit durch den
gcc unter Unix-Derivaten (und eventuell VMS und OS/2) lege.

Karl Brodowsky
<bro@clio.iwr.uni-heidelberg.de>
<bk1@ix.urz.uni-heidelberg.de>
