Menu
CTAN
Comprehensive TeX Archive Network
Cover Upload Browse Search

Direc­tory tex-archive/support/redit

--------------------------------------------------------------------------
     Dokumentation zum REdit 2.10 von Michael Rogalla      01.11.1993
--------------------------------------------------------------------------
--------------------------------------------------------------------------
     A small Documentation for REdit 2.10 can be find since line 886
--------------------------------------------------------------------------


Inhalt:    1. Ziel des Programms
           2. Dateien von REdit
           3. Installation
              a. Installation
              b. Programmstart
              c. Erzeugung der TeX-Dokumentation
              d. Dateiinhalt von REDIT2_0.ZIP
           4. Begriffe
           5. Bedienung
              a. Der Aufruf
              b. Die Pull-Down-Men�s
              c. Die Statuszeile
              d. Editor-Befehle
              e. Die Hilfe
              f. Die eckigen Klammern in LaTeX-Texten
              g. Die Datei REDIT.MEN
              h. Die Datei REDIT.INI
              i. Die Datei REDIT.CMD
              j. REdit als Mini-Oberfl�che
              k. Alte Version von REdit
              l. Lexika
           6. Autor
           7. Nutzungsrechte
           8. Zukunft
           9. Vergangenheit


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


1. Ziel des Programms

   REdit wurde mit Turbo Vision (TP 6.0) von Borland International ge-
   schrieben. 
   Ziel von REdit ist es, die Arbeit mit LaTeX zu vereinfachen, indem der
   Benutzer �ber Pull-Down-Men�s LaTeX-Befehle in den zu bearbeitenden
   Text einf�gen kann. Besonders der Anf�nger soll leichter in die Arbeit
   mit LaTeX eingef�hrt werden, in dem Rechtschreibfehler beim Schrieben 
   von LaTeX-Befehlen durch die Benutzung der gegebenen Hilfsmittel ver-
   mieden werden. Um sich einen �berblick �ber die Editorfunktionen zu
   verschaffen, sollten Sie zuerst alle Men�s �ffnen und mit Hilfe der
   Taste "F1" sich die Hilfe zur jeweiligen Men�option durchlesen.


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


2. Dateien von REdit

   Zu REdit 2.10 geh�ren folgende Dateien:

     REDIT.EXE      Dies ist das eigentliche Programm. Um die inte-
                    grierte Hilfe nutzen zu k�nnen, ben�tigt es die
                    Datei REDIT.HLP.
                     
     REDIT.HLP      In dieser Datei ist die komplette Hilfe enthalten,
                    die von REDIT.EXE aufgerufen wird. Es sollte im
                    gleichen Verzeichnis stehen, wie das eigentliche
                    Programm.

     REDIT.DEU,     Men�dateien von REDIT.EXE. Hier sind viele Men�eintr�ge
     REDIT.ENG,     des Editors vorhanden. Um sie nutzen zu k�nnen, braucht
     REDIT.FRA      man nur eine dieser Dateien in REDIT.MEN umbenennen.

     REDIT.MEN      Es ist m�glich �ber eine Batch-Datei den Pfad der
                    Men�datei (REDIT.MEN), die von dem Editor genutzt
                    wird, vorzugeben. Somit ist es leicht den Editor
                    an eine andere Sprache z.B. Englisch anzupassen.

     REDIT.INI      Datei zum Einlesen der Zusatzmen�struktur. Wie REDIT.MEN
                    kann diese Datei �ber eine Batch-Datei neu erzeugt werden.

     REDIT.PAL      In dieser Datei wird die Fensterfarbwahl des Editors
                    gespeichert.

     REDIT.LEX      In dieser Datei sind rund 80000 W�rter gespeichert.
                    Das W�rterbuch l��t sich auf circa 120000 W�rter
                    erweitern. Je voller das W�rterbuch ist, desto
                    langsamer arbeitet die Rechtschreibkorrektur.

     LATEX.LEX      In dieser Datei sind die wichtigsten LaTeX-Befehle zu
                    einem W�rterbuch zusammengefa�t (ausbauf�hig!).

     REDIT.CMD      Die von REDIT.EXE ben�tigte Datei zum Einlesen der
                    einzubindenden LaTeX-Befehle.

     REDITC.DEU     Diese Dateien sind zur Anpassung der CMD-Datei
     REDITC.ENG     an die jeweilige Sprache gedacht. Dies ist durch
     REDITC.FRA     die Batch-Datei "SPRACHE.BAT" m�glich.

     REDITI.DEU     Diese Dateien sind zur Anpassung der INI-Datei
     REDITI.ENG     an die jeweilige Sprache gedacht. Dies ist durch
     REDITI.FRA     die Batch-Datei "SPRACHE.BAT" m�glich.

     REDIT.DOC      Diese Datei. Mini-Dokumentation. Wird eines Tages besser!

     EDIT.BAT       Dies ist ein Beispiel, wie man den Editor starten
                    kann, ohne ihn als Mini-TeX-Oberfl�che zu nutzen.

     REDIT.BEI,     Zwei Dateien, die zusammen ein Beispiel f�r die
     BEISPIEL.BAT   Nutzung des Editors als Mini-TeX-Oberfl�che geben.
                    REDIT.BEI ist die Men�datei und BEISPIEL.BAT die
                    Batchdatei zum Aufruf der Mini-TeX-Oberfl�che.

     MAK\*.MAK      Eine Sammlung von einfachen Makro-Beispielen. Diese
                    Sammlung soll ebenfalls eines Tages verbessert werden.
                    Wer sch�ne Makros hat, der kann sie mir schicken. Bei
                    gefallen werden sie beim Editor mitgeliefert.

     *.TEX          Dies ist ein Beispiel f�r einen mit REdit erstellten
                    LaTeX-Text.

     PICINPAR.STY,  Zwei von dem Beispiel DEMO.TEX ben�tigten STY-Dateien.
     EPIC.STY

     *.PK           Die f�r die Einbindung eines Demobildes ben�tigten
                    Schriftsatzdateien.

     MONAA.TFM      Eine von TeX ben�tigte Datei zur Einbindung eines
                    Demobildes.

     SPRACHE.BAT    Eine Hilfsdatei zum Anpassen der Men�datei an die
                    gew�nschte Sprache.

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


3. Installation


 a. Installation
 
    Die Datei REDIT2_0.ZIP ist ein mit PKZIP erzeugtes Archiv. Die
    verwendete PKZIP-Version 2.04g gibt es erst seit Anfang 1993.
    Um die Datei zu entpacken, kopiert man diese Datei in das
    Verzeichnis, in das der Editor installiert werden soll, und
    gibt folgende Zeile ein:

    pkunzip -d redit2_1

    Und schon ist die Installation fast beendet. Es werden alle zum
    REDIT geh�renden Dateien und deren Verzeichnissse erzeugt. Vor
    dem ersten Programmstart mu� jetzt nur noch eventuell die Datei
    EDIT.BAT ge�ndert werden.
    Die sprachliche Anpassung des Editors wird �ber die �nderung
    der Men�dateien vorgenommen. Hierzu wird als Hilfe die Datei
    SPRACHE.BAT mitgeliefert. Die Anpassung erfolgt z.B durch:

    sprache deu

    Dabei bedeutet:
       sprache        Name der Batch-Datei
       deu            K�rzel f�r die Anpassung an die deutsche Sprache.


 b. Programmstart

    Der einfachste Weg den Editor zu starten ist die Eingabe:

    redit

    Nach dieser Eingabe werden automatisch die Dateien REDIT.MEN und 
    REDIT.INI geladen, um die Men�eintr�ge zu laden. Wird der Editor zum
    ersten mal gestartet, so gibt er die Meldung "REDIT.DSK konnte nicht
    ge�ffnet werden" und "REDIT.PAL konnte nicht ge�ffnet werden" aus,
    denn bei jedem Programmstart werden diese Dateien ben�tigt, um den zu
    letzt vorhandenen Zustand wiederzuerlangen. Es wird in der REDIT.DSK
    gespeichert, welche Fenster ge�ffnet sind und an welcher Stelle sich
    der Cursor befindet und REDIT.PAL speichert die Men�farben. Wird dem
    Editor beim Programmstart in der Kommandozeile gesagt, welche Datei
    er laden soll, so wird der in der REDIT.DSK gespeicherte Zustand nicht
    mehr ber�cksichtigt. Wird der Editor �ber "ALT-X" oder "Datei/Ende"
    verlassen, so legt der Editor die Dateien REDIT.DSK und REDIT.PAL an
    und speichert den Zustand des Editors vor dem Verlassen des Programms.
    Alle f�r den Start ben�tigten Dateien m�ssen dabei in dem aktuellen
    Verzeichnis sein.

    Beim Programmstart ist es m�glich mehrere Dateien �ber die Kommando-
    zeile direkt zu Beginn der Arbeit einzuladen. Z.B.:
     
    redit name1.tex name2.tex name3.tex     oder
    redit name1 name2 name3

    Dabei bedeutet:

       redit          Name des Programms

       name1..3.tex,  Dateien, die zu Beginn der Arbeit geladen werden
       name1..3       sollen. In den Dateinamen k�nnen auch Wildcardes
                      wie "*" oder "?" enhalten sein. Diese werden dann
                      interpretiert und durch das "Datei �ffnen"-Men�
                      eingeladen. Wird eine Datei ohne Endung angegeben,
                      so wird ".TEX" als Standard vorgegeben.

    Falls Sie mit emTeX arbeiten, k�nnen Sie den Editor auch �ber den
    Kommandobefehl "e" von TeX aus aufrufen. Denn es ist m�glich mit
    Hilfe des zweiten Parameters der Kommandozeile direkt in die ange-
    gebene Zeile der im ersten Parameter angegebenen Datei zu springen.
    Z.B.:

    redit name1.tex 6 name2.tex

    Dabei bedeutet:

       redit          Name des Programms

       name1.tex      Name der Datei, bei der der Cursor automatisch
                      in die angegebene Zeile springt

       6              Zeilennummer, in die der Cursor zu Beginn der
                      Arbeit springen soll

       name2.tex      Datei, die zu Beginn der Arbeit geladen wird

    F�r den Aufruf des Editors mit Hilfe von Batch-Dateien werden zwei
    Beispiele mitgeliefert. Sie sollen zeigen, wie man den Editor ent-
    weder als reinen Editor oder als Mini-TeX-Oberfl�che nutzen kann.
    Wie man an den Batch-Dateien erkennen kann gibt es f�nf Environment -
    Variablen:

                a) stdhlp
                b) stdmen
                c) stdcmd
                d) stdini
                e) stdlex.

    Bei allen Variablen wird der jeweilige Pfad f�r die ben�tigte Datei
    angegeben. Z.B:

    stdhlp=d:\tex\redit

    Dabei bedeutet:

       stdhlp         Name der Environment-Variablen

       d:\tex\redit   In diesem Verzeichnis befindet sich die Datei
                      REDIT.HLP

    Gibt man den Environment-Variablen keine Zuweisung, so m�ssen die
    vom Editor ben�tigten Dateien in dem aktuellen Verzeichnis oder in
    den mit "PATH" gekennzeichneten Verzeichnissen stehen.

 c. Erzeugung der TeX-Dokumentation

    Um die TeX-Dokumentation erzeugen zu k�nnen, m�ssen die Dateien
    *.STY, *.PK und MONAA.TFM in den richtigen Verzeichnissen stehen.
    Die TeX-Dokumentation kann mit emTeX direkt erzeugt werden, da alle
    ben�tigten Dateien, die mit dem Befehl "\input" eingef�gt werden,
    unter Verwendung der emTeX-specials geschrieben worden sind. F�r alle
    die nicht emTeX nutzen mu� eine kleine dokumentierte �nderung der
    Datei DEMO.TEX vorgenommen werden. An den Stellen wo der Befehl
    "input" benutzt wird, kann eine Alternativdatei angew�hlt werden.
    Zus�tzlich mu� durch weglassen des Zeichens "%" folgende Zeile
    aktiviert werden:

      \documentstyle[picinpar,german,epic]{report} .

    Nat�rlich mu� die equivalente Zeile f�r emTeX mit dem Zeichen "%"
    deaktiviert werden.

    In welchen Verzeichnissen sollen die zur Erstellung der
    TeX-Dokumentation ben�tigten Dateien stehen?

    Die Dateien mit der Endung *.TEX oder *.STY sollen entweder in
    dem aktuellen Verzeichnis oder in dem durch die Environment -
    Variable (bei emTeX: TEXINPUT) vorgegebenen Verzeichnissen zu
    finden sein.
    Die Datei MONAA.TFM sollte in dem durch die Environment-Variable
    (bei emTeX: TEXTFM) vorgegebenen Verzeichnis zu finden sein.
    Falls man nicht wei�, wo die Dateien *.PK stehen m�ssen, folgt f�r
    emTeX ein kleines Beispiel f�r die Suche nach dem richtigen Pfad.

    Beispiel:

      Um den Pfad der Dateien *.PK zu finden mu� man bei emTeX die
      Dateien mit der Endung ".CNF" durchsehen. Im Regelfall ist nur
      ein Drucker f�r TeX installiert worden. Somit ist die Aufl�sung
      der ben�tigten Schriftsatzdateien festgelegt. Wer einen Laser-
      drucker nutzt, wird die Datei MONAA.PK aus dem Verzeichnis 300DPI
      ben�tigen, um das Bild in die Dokumentation einf�gen zu k�nnen.
      Bei der Nutzung eines Laserdruckers wird von emTeX die Datei
      LJ.CNF ben�tigt.

      Datei LJ.CNF:

        Zeile  1:  % lj.cnf (300x300 DPI using LJ fonts)
        Zeile  2:  /pd={,$DVIDRVINPUT:}@i
        Zeile  3:  /pl=$DVIDRVFONTS:lj_{0,h,1,2,3,4,5a,5b,sli}
        Zeile  4:  /pf=$DVIDRVFONTS:pixel.lj\@Rrdpi\@f{.pk,.pxl}
        Zeile  5:  /pg={,$DVIDRVGRAPH:}{@Rrdpi\,}@PBf{@Ef,.msp,.pcx,.bmp}
        Zeile  6:  /r=300
        Zeile  7:  /rf=300
        Zeile  8:  /fs=1
        Zeile  9:  /fm=hplaser
        Zeile 10:  /fd=2

     Anhand der Zeile 4 ist es nun m�glich das von emTeX gesuchte Ver-
     zeichnis f�r die Datei MONAA.PK zu erkennen:

       a) DVIDRVFONTS: Environment-Variable f�r das Verzeichnis der
                       von emTeX ben�tigten Schriftsatzdateien *.FLI
                         z.B.: d:\emtex\texfonts
       b) @Rrdpi:      Platzhalter f�r die Angabe der Druckeraufl�sung
                         z.B.: 300 dpi
       c) @f:          Platzhalter f�r den Namen der ben�tigten Schrift-
                       satzdatei
                         z.B.: MONAA.PK    .

     F�r unser Beispiel w�rde emTeX die Datei MONAA.PK in dem Verzeichnis
     "d:\emtex\texfonts\pixel.lj\300dpi" suchen.
     Wenn alle Dateien im richtigen Verzeichnis stehen und alle Ein-
     stellungen in der Datei DEMO.TEX vorgenommen worden sind, kann die
     TeX-Dokumentation von (La)TeX �bersetzt werden.

 d. Dateiinhalt von REDIT2_0.ZIP

   Verzeichnis von REdit:

     ZUSATZ       <DIR>     31.07.93    3:33
     MAK          <DIR>     31.07.93    3:33
     REDIT    EXE    201376 01.11.93    2:10
     REDIT    CMD      5707 01.11.93    2:10
     REDIT    HLP    254962 01.11.93    2:10
     EDIT     BAT       201 01.11.93    2:10
     REDIT    MEN      3915 01.11.93    2:10
     LATEX    LEX    131072 01.11.93    2:10
     REDIT    INI      3371 01.11.93    2:10
     REDIT    LEX    262144 01.11.93    2:10

    Verzeichnis von \MAK:

     ARR1     MAK        72 01.11.93    2:10
     ARR2     MAK        72 01.11.93    2:10
     ARR3     MAK        72 01.11.93    2:10
     ARR4     MAK        72 01.11.93    2:10
     DREISTOF MAK      1276 01.11.93    2:10
     FIG1     MAK       159 01.11.93    2:10
     FIG2     MAK       860 01.11.93    2:10
     PIC1     MAK       403 01.11.93    2:10
     PIC2     MAK      9646 01.11.93    2:10
     PIC3     MAK      5510 01.11.93    2:10
     PIC4     MAK     12277 01.11.93    2:10
     PIC5     MAK      7489 01.11.93    2:10
     TAB1     MAK       465 01.11.93    2:10
     TAB2     MAK        83 01.11.93    2:10
     TAB3     MAK       302 01.11.93    2:10
     TAB4     MAK       396 01.11.93    2:10
     TAB5     MAK       583 01.11.93    2:10
     TAB6     MAK       336 01.11.93    2:10

    Verzeichnis von \ZUSATZ:

     BEISPIEL BAT      3280 01.11.93    2:10
     SPRACHE  BAT        86 01.11.93    2:10
     REDIT    BEI      3940 01.11.93    2:10
     REDIT    DEU      3915 01.11.93    2:10
     REDITC   DEU      5707 01.11.93    2:10
     REDITI   DEU      3282 01.11.93    2:10
     REDIT    ENG      3238 01.11.93    2:10
     REDITC   ENG      5629 01.11.93    2:10
     REDITI   ENG      3215 01.11.93    2:10
     REDIT    FRA      3910 01.11.93    2:10
     REDITC   FRA      5699 01.11.93    2:10
     REDITI   FRA      3297 01.11.93    2:10
     RLOGO180 PK      14532 01.11.93    2:10
     RLOGO300 PK      16824 01.11.93    2:10
     EPIC     STY     26404 01.11.93    2:10
     DOKU     PS     253641 01.11.93    2:10
     RLOGO180 TFM       228 01.11.93    2:10
     RLOGO180 TEX       614 01.11.93    2:10
     RLOGO300 TEX       614 01.11.93    2:10
     RLOGO300 TFM       228 01.11.93    2:10
     REDIT    DOC     44902 01.11.93    2:10
     DOKU     TEX     61813 01.11.93    2:10


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


4. Begriffe

   Fast alle Begriffe der Pull-Down-Men�s "LaTeX", "Umgebung", "Mathe"
   und "Bilder" sind in der Orginalbefehlsform �bernommen worden. Dies
   soll helfen die Befehle von Beginn an im richtigen Zusammenhang zu
   sehen. Nur bei "Mathe" sind die Befehle im zweiten Bereich nicht in
   der Orginalnotation benutzt worden, um f�r Anf�nger die Erstellung
   von Formeln zu erleichtern. Dies soll allerdings nicht dazu f�hren,
   da� der Anf�nger faul wird und nicht die Befehle lernt; es soll ihm,
   wie bereits erw�hnt, nur den Einstieg erleichtern. Wenn n�tig k�nnen
   die Befehlsnamen durch manipulieren der Datei REDIT.MEN oder REDIT.INI
   ver�ndert werden. Die folgenden Beispiele sollen dies verdeutlichen:

   REDIT.MEN:

   alt ==>  Zeile 34:  ~F~inde ...
   neu ==>  Zeile 34:  S~u~chen nach ...

   REDIT.INI:

   alt ==>  Zeile 94:  newitem=~B~ruch,111,1370
   neu ==>  Zeile 94:  newitem=~f~rac,111,1370

   Die Datei REDIT.MEN hat eine vorgegebene Struktur, die nicht durch
   Neueintr�ge ver�ndert werden darf. In jedem Befehl mu� ein Buchstabe
   hervorgehoben werden, damit man den Befehl auch mit der Tastatur
   aktivieren kann. Zus�tzlich kann keine neue Zeile eingef�gt werden,
   da die Datei nur bis zur 223. Zeile interpretiert wird.
   Durch die Datei REDIT.INI ist es m�glich eine eigene LaTeX-Men�struktur
   zu erzeugen. Dies ist relativ leicht und wird weiter unten beschrieben.
   

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


5. Bedienung

 a. Der Aufruf
 
    Der Editor kann aus einem beliebigen Verzeichnis gestartet werden,
    wenn er in einem Pfad der PATH-Variable steht. In der Kommandozeile
    k�nnen optional ein oder mehrere Dateinamen angegeben werden. Bei
    jedem Dateinamen mu� eine Extention angegeben werden, wenn die Exten-
    tion TEX nicht automatisch an das Ende des Dateinamen gesetzt werden
    soll. Nat�rlich mu� dem Editor �ber die Environment-Variablen mitge-
    teilt werden, wo er die Dateien REDIT.HLP, REDIT.CMD, REDIT.INI,
    REDIT.MEN und REDIT.LEX bei Bedarf finden kann.

    Beispiel: EDIT.BAT

      @echo off
      set STDHLP=D:\TEXTE
      set STDMEN=D:\TEXTE
      set STDCMD=D:\TEXTE
      set STDINI=D:\TEXTE
      set STDLEX=D:\TEXTE
      redit %1 %2 %3 %4 %5
      set STDHLP=
      set STDMEN=
      set STDCMD=
      set STDINI=
      set STDLEX=


 b. Die Pull-Down-Men�s

    In der Men�-Leiste am oberen Bildschirmrand sind alle wichtigen
    Funktionen des Editors, nach Gruppen geordnet, erreichbar. Jeder
    Gruppenname enth�lt einen farblich hervorgehobenen Buchstaben, der
    �berall im Editor eine schnelle Anwahl der zugeordneten Funktion
    erm�glicht.
    Ist 'D' der hervorgehobene Buchstabe, w�hlt "Alt-D" die Funktion aus.
 
    - Mit F10 wird die Men�-Leiste aktiviert, erkennbar an einem selek-
      tierten Eintrag der Leiste. Mit den Cursor-Tasten kann dann die
      gew�nschte Funktionen-Gruppe ausgew�hlt werden; die Enter-Taste
      oder die Cursor-Down-Taste �ffnen das zugeh�rige Untermen�. Aus
      diesem kann wiederum mit den Cursor-Tasten und der Enter-Taste
      die gesuchte Funktion gew�hlt werden.
    - Mit seinem Tastenk�rzel kann ein Untermen� ge�ffnet werden und
      aus diesem mit dem Tastenk�rzel eine Funktion gew�hlt werden.
    - Mit "Esc" kann das Men� ohne erfolgte Befehlseingabe verlassen
      werden. Es wird dann nat�rlich auch kein Befehl ausgef�hrt.
    - Ein Klick mit der Maus auf den Namen eines Untermen�s �ffnet die-
      ses, ein Klick auf die gew�nschte Funktion aktiviert diese.
    - W�hrend eines Dialogs ist die Men�-Leiste nicht aktivierbar. Bei
      dem Men� "Datei �ffnen" (F3) kann man dies leicht ausprobieren.

 
 c. Die Statuszeile
 
    In der Statuszeile sind wichtige Funktionen des Editors direkt
    erreichbar. Sie k�nnen dort mit der Maus oder durch dr�cken der
    zugeordneten, hervorgehobenen Tastenkombinationen aktiviert werden.

    
 d. Editor-Befehle
 
    Die Editor-Befehle sind von Turbo Vision �bernommen worden und
    gleichen dadurch diesen fast komplett. Eine Liste der Befehle
    erhalten Sie bei ge�ffnetem Editor durch "F1".  

 e. Die Hilfe

    Zu (fast) jeder LaTeX-Funktion steht ein Hilfe-Text bereit, der mit
    der F1-Taste abgerufen werden kann. Das Hilfe-Fenster mu� mit der
    Esc-Taste oder dem Schlie�-Button geschlossen werden, bevor mit
    anderen Fenstern gearbeitet werden kann.
    Einige Hilfe-Texte enthalten Verweise auf andere Texte. Diese sind
    farblich abgehoben und einer dieser Verweise ist immer selektiert.
    Mit Tab und Shift-Tab kann jeder Verweis selektiert und mit der
    Enter-Taste zum zugeordneten Text verzweigt werden.
    Bei einem editierten Text ist es m�glich �ber die Tasten "Strg-F1"
    einen Hilfe-Text zu dem LaTeX-Befehl zu erhalten, auf dem der
    Cursor gerade steht. Steht der Cursor z.B. auf dem Wort "\sigma",
    so �ffnet sich ein Texte �ber "griechische Buchstaben". Dies ist
    auch �ber die Maus zu erreichen. Mit der linken Maustaste positio-
    niert man den Cursor im Text und mit der rechten Maustaste �ffnet
    man das Hilfe-Fenster.
    Mit "Shift-F1" wird der Hilfe-Index ge�ffnet. Von dort aus, k�nnen
    alle anderen Befehle �ber Verweise erreicht werden.

 f. Die eckigen Klammern in LaTeX-Texten

    Sie sollten, wenn Sie die eckigen Klammern nicht nutzen diese auch
    aus dem Kontext l�schen, da es sonst eventuell zu unvorhergesehenen
    Folgen f�hren kann. 
    Z.B. kann es in der Inhaltsangabe zu unterlassenen Eintr�gen f�hren.

 g. Die Datei REDIT.MEN

    In der Datei REDIT.MEN sind zur Laufzeit vom Editor ben�tigte
    Men�eintr�ge vorhanden. Wichtig ist, da� bei dieser Datei die
    Anzahl der Zeilen nicht ver�ndert werden darf, aber der Inhalt
    der Zeilen variabel gestalltet werden kann. Ist eine Zeile leer,
    also ohne Inhalt gelassen, so wird der f�r diese Zeile vorgesehene
    Men�eintrag ignoriert und die zugeh�rige Funktion kann nicht mehr
    aufgerufen werden. Da diese Datei vom Editor zeilenweise eingelesen
    wird, mu� jede Zeile mit CR LF (ASCII 13 10) getrennt sein. Zus�tz-
    lich darf jede Zeile nicht mehr als 128 Zeichen lang sein.
    Die Bedeutung der einzelnen Zeilen geht am deutlichsten aus den
    mitgelieferten Men�dateien hervor. Allerdings gibt es bei einigen
    Zeilen noch einige Besonderheiten.


    Zeilen
        55-63:  In diesen Zeilen werden die Befehle f�r die Mini-Ober-
                fl�che eingetragen.
    Zeilen
        77-80:  In diesen Zeilen findet man die Laufzeitvariable "%s".
                "%s" ist Platzhalter f�r den Namen der aktuellen Datei
                und darf daher nicht aus diesen Zeilen entfernt werden,
                da man sonst nicht die n�tigen Informationen erh�lt.

    Zeile 179:  Mit dieser Zeile wird festgelegt, welches Zeitformat bei
                der Darstellung der Dateiattribute genutzt wird. Standard
                ist die deutsche Darstellung der Dateiattribute. Dies wird
                �ber das Wort "deutsch" vorgegeben. Wenn in dieser Zeile
                ein beliebiges andere Wort genutzt wird, so wird die
                englische Darstellung der Dateiattribute gew�hlt.

    Zeile 180:  In dieser Zeile wird f�r den automatischen Zeilenumbruch
                die Umbruchspalte definiert. Es d�rfen nur Zahlen eingesetzt
                werden, die zur Klasse der "ganzen Zahlen" geh�ren. Nach
                der in dieser Zeile angegebenen Spalte wird in der laufende
                Zeile der Zeilenumbruch durchgef�hrt.

                Beispiel:         erlaubt: 45 oder 80
                            nicht erlaubt: 80.5 oder -10 oder 0

 h. Die Datei REDIT.INI

    In der Datei REDIT.INI wird die Men�struktur der LaTeX-spezifischen
    Befehlsstruktur festgelegt. Der Editor sucht in dieser Datei nach
    vier Befehlen:

       a) newsub    Mit "newsub" wird der Beginn eines neuen Men�s definiert.
                    Beispiel:  newsub=~L~aTeX,1057
                    Der erste Eintrag ist der Name des Men�s und der zweite
                    Eintrag die f�r den Hilfetext ben�tigte Adressnummer.
                    Diese Nummer darf nicht ver�ndert werden, da sonst der
                    falsche Hifetext auf dem Monitor erscheint.

       b) endsub    Mit "endsub" wird das Ende eines Men�s definiert.
                    Beispiel:  endsub=~L~aTeX
                    Der Eintrag mu� dem ersten Eintrag von "newsub"
                    entsprechen. Die beiden Befehle m�ssen immer paarweise
                    auftreten.

       c) newitem   Mit "newitem" wird eine Men�zeile definiert.
                    Beispiel:  newitem=~p~arbox,42,1084
                    Wie bei "newsub" ist der erste Eintrag der Name der
                    Men�zeile. Der ditte Eintrag dient als Adressnummer des
                    Hilfetextes und der zweite als Befehlsnummer.
                    F�r ihre eigenen Befehle sollten sie die Zahlen zwischen
                    1110 und 1200 w�hlen, da es sonst zu einer doppelten
                    Belegung der Befehlsnummern kommen kann. Soll der in der
                    Datei REDIT.CMD definierte Befehl aufgerufen werden, so
                    wird er anhand dieser Nummer identifiziert.
                    Die Hilfe-Adressnummer sollte f�r neue, von mir nicht
                    definierte, Befehle die Nummer 1000 f�r die "(La)TeX
                    Syntax-�bersicht" erhalten.

       d) newline   Mit "newline" wird ein Men�trenner in das Men� eingef�gt.

 i. Die Datei REDIT.CMD

    In der Datei REDIT.CMD sind die Befehlstexte eingebunden. Von dort aus
    werden die LaTeX-Befehle in den Text eingebunden. Das Einbinden ei-
    gener LaTeX-Konstrukte wird durch die �nderung des ASCII-Textes in
    REDIT.CMD einfach. Der einzubindende Befehl ist in dieser Datei in
    einem bestimmten Format abgelegt.

    Beispiel:

    begin ~b~efehl
    12
    Mein Name ist Hase!
    end ~b~efehl

    Dabei bedeutet:

      begin, end      Dies sind die Randmarken des Befehls

        ~b~efehl      Dies ist der Name des Befehls. Er wird genau so
                      geschrieben, wie der Men�eintrag in der Datei
                      REDIT.INI.

              12      Dies ist die Stelle, an der der Cursor nach dem
                      Einbinden des Textes stehen soll. Es wird dabei
                      vom alten Stand des Cursors aus gez�hlt und jeder
                      Buchstabe erh�ht diese Zahl um den Betrag 1.
                      Bedingt durch den LF am Ende einer Zeile, mu� der
                      Beginn einer neuen Zeile mit einer Addition von 2
                      ber�cksichtigt werden.
                      In dieser Zeile mu� eine Zahl stehen, da sonst das
                      Programm den Befehl nicht korrekt ausf�hren kann.

       Mein N...      Dies ist der eingzuf�gende Text. Nach dem Einbinden
                      wird der Cursor auf dem Buchstaben "s" des Wortes
                      "ist" stehen.

    Jeder Befehl darf eine L�nge von maximal 12 kByte haben.

    Die in den Dateien REDIT.INI und REDIT.MEN vorhandenen Befehlsnamen sind
    festgelegt, so da� eine nachtr�gliche �nderung der Befehlsnamen innerhalb
    einer Datei nicht m�glich ist, da sonst der gew�nschte Befehl nicht
    gefunden werden kann. Wenn ein LATeX-Befehl einen neuen Men�eintrag
    erhalten soll, so m�ssen in beiden Dateien die Eintr�ge ver�ndert werden.

 j. REdit als Mini-Oberfl�che

    Durch eine Option des Editors ist es m�glich diesen auch als Mini-
    Oberfl�che nutzen zu k�nnen. Dies ist m�glich durch Nutzung der
    Errorlevel-Abfragung in Batchdateien. Durch die oben erw�hnten Ein-
    tragungen werden Befehle im Editor aktiviert, die ein beenden des
    Editors zur Folge haben. Wenn der Editor beendet wird �bergibt er
    einen Errorlevel, der von einer Batchdatei gelesen werden kann.
    Ein kleines Beispiel finden sie unter REDIT.BEI und BEISPIEL.BAT.
    Innnerhalb der Datei REDIT.MEN (Zeile 55 bis 63) kann der Men�-
    eintrag vorgenommen werden. Ist in einer der Zeilen kein Eintrag
    vorhanden, so wird diese Zeile nicht im Men� "�" sichtbar. Die
    zugeh�rige Errorlevel-Nummer kann somit nicht mehr in der Batch-Datei
    genutzt werden.

 k. Alte Version von REdit

    Wenn Sie eine alte Version von REdit besitzen, so m�ssen Sie die
    alte Version der REDIT.DSK l�schen, damit es nicht zu unliebsamen
    �beraschungen kommt.

 l. Lexika

    Zusammen mit dem Editor werden zwei Dateien ausgeliefert, die f�r
    den Wortschatz der Rechtschreibkorrektur verantwortlich sind.
    Im REDIT.LEX sind schon viele gebr�uchliche deutsche W�rter vorhanden.
    Es l��t sich relativ leicht erweitern und kann neben den bereits
    80000 noch weitere 50000 W�rter aufnehmen. Die Korrektur verlangsamt
    sich allerdings mit zunahme des W�rterbuchinhaltes und es sollte
    daher nicht mehr als zu 90% gef�llt sein.
    Das LATEX.LEX enth�llt schon einige LaTeX-Befehle und ist noch stark
    erweiterbar. Diese Datei kann bis zu 60000 W�rter aufnehmen. Es gelten
    auch hier die gleichen Geschwingkeitsbedingungen.

    Es gibt zwei Typen von Lexika. Die Datei REDIT.LEX geh�rt zum Typ
    "Hauptw�rterbuch" und wird automatisch zur Korrektur herangezogen.
    Der Typ "Benutzerw�rterbuch" (LATEX.LEX) kann optional als weiteres
    W�rterbuch benutzt werden. Pro Korrektur kann nur ein Benutzerw�rter-
    buch verwendet werden. Ein neues Benutzerw�rterbuch erzeugt man durch
    Eingabe eines neuen Dateinamens im Dialog "Benutzerw�rterbuch �ffnen".

    Die Lexika haben unabh�ngig von ihrem F�llungsgrad immer die gleiche
    Gr��e. Pro Wort wird ein Platz von zwei Byte ben�tigt, so da� es
    unabh�ngig von der L�nge eines Wortes nicht n�tig ist die Dateigr��e
    �ndern. Das hei�t, das die Lexika schon bei ihrer Erzeugung schon die
    Originalgr��e besitzen und keinen weitern Platzbedarf hervorrufen.

    Soll die Rechtschreibkorrektur nicht genutzt werden, so gen�gt es,
    die Lexika nicht zu kopieren. Werden keine Lexika gefunden (aktuelles
    Verzeichnis, PATH oder Environmet-Verzeichnis), so erscheinen auch
    keine Men�eintr�ge. Letzteres ist aber auch ein Zeichen f�r die Angabe
    einer falschen Environmentvariablen.


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


6. Der Autor

   Ich studiere Maschinenbau an der Universit�t-Gesamthochschule Duisburg.
   Meine Adresse lautet

       Michael Rogalla
       Am Tannenbaum 6
       42499 H�ckeswagen
       email: michael@zeus.uni-duisburg.de 

   Ich bitte f�r Vorschl�ge, Fragen etc. meine Anschrift zu verwenden,
   da ich nach dem 31.12.1993 nicht wei�, wie lange die email-Adresse
   noch g�ltig ist.
   Da dies mein erstes Programm ist, bin ich �ber jedes konstruktives
   Echo erfreut und werde darauf nat�rlich auch antworten.
   Wenn Ich �ber email antworten sollte, so kann es durchaus auch mal
   mehr als eine Woche dauern, da ich nicht sehr oft am zugeh�rigen
   Computer arbeite.

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


7. Nutzungsrechte

   Alle Rechte an diesem Programm liegen bei mir, dem Autor. Obwohl
   nat�rlich vieles getan wurde, Fehler zu vermeiden, kann ich keine
   Garantie f�r eine fehlerfreie Funktion des Programms geben.
   ==> Die Verwendung des Programms erfolgt auf eigene Gefahr!
   
   Ich �bernehme keine Haftung f�r irgendwelche Sch�den, die direkt oder
   indirekt durch den Einsatz dieses Programms entstehen.
   
   Dieses Programm kann privat, in frei zug�nglichen Einrichtungen und
   in Forschungseinrichtungen eingesetzt werden. Jede kommerzielle
   Nutzung erfordert meine schriftliche Zustimmung. Ich w�rde mich
   �ber eine Registrierung freuen und Sie �ber neue Versionen meines
   Programms informieren und ein Update erm�glichen, sofern Sie es
   w�nschen. Das Update w�re dann zur Zeit zum Selbstkostenpreis von
   6,- DM. Darin enthalten w�ren Diskettenkosten, Porto oder andere
   anfallenden Kosten beim Versand der neuen Versionen. 
   
   Die Weitergabe dieses Programms ist nur unentgeltlich (allenfalls
   zum Selbstkostenpreis maximal in H�he der Material- und Versand-
   kosten) und als unver�nderte Archiv-Datei gestattet. Die Verbrei-
   tung �ber Mailboxen und �hnliche Einrichtungen ist ausdr�cklich
   erw�nscht.

   Die Rechte an den Quelltexten f�r die (La)TeX-Hilfe liegen bei
   Addison-Wesley und Helmut Kopka: Copyright 1992 Helmut Kopka und
   Addison-Wesley (Deutschland) GmbH.


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


8. Zukunft

   F�r k�nftige Versionen ist eine Erweiterung mit PICTEX-Befehlen vor-
   gesehen, eine Einbindung von LaTeX-Befehlen zum Erstellen von ein-
   fachen Bildern und eine verbesserte Hilfe.

   Wegen meiner Diplomarbeit hatte ich bisher keine Zeit die mit Version
   2.0 angek�ndigten Erweiterungen vorzunehmen. Ich werde sie allerdings
   in der n�chsten Version umsetzen.

   Da seit erscheinen der Version 2.0 keine Reaktion auf eine Version
   unter WINDOWS festzustellen war, werde ich keine Schritte in diese
   Richtung unternehmen.

   Weitere Verbesserungen ergeben sich aus dem "wichtigen" Dialog mit
   den Nutzern des Programms.

   Als gro�es Ziel habe ich mir eine Rechtschreibkorrektur vorgenommen.
   Die in der Version 2.1 vorliegende Form ist zwar noch nicht meine
   Wunschumsetzung des Moduls, aber immerhin ein Anfang. Durch die
   kleinen Verbesserungen ist das arbeiten allerdings schon etwas
   angenehmer und sicherer geworden.

   Es wird auch an verbesserten und neuen Makros gearbeitet. Die
   bisherigen Makros sind nat�rlich nur ganz einfache Beispiele f�r die
   Nutzung der Makrofunktion.

   Die �bersetzung der deutschen Texte nach anderen Sprachen ist f�r
   mich zur Zeit eine der wichtigsten Aufgaben. Daher suche ich noch
   Personen, die mir bei dieser Aufgabe helfen. Ich wei� das es keine
   leichte Aufgabe sein wird, aber was w�hre aus TeX ohne den Idealismus
   vieler Personen geworden? Wer sich also zutraut diesen Text und Teile
   der Hilfe (ohne Kopka-Texte) in eine andere Sprache (z.B. Englisch,
   Franz�sisch, T�rkisch, ...) zu �bersetzen, der kann mit mir Kontakt
   aufnehmen.

   Ich bin kein Freund von schnellen Updates, darum wird ein Update im
   Regelfall fr�hestens ca. 3-4 Monate nach erscheinen der letzten
   Programmversion zu erwarten sein.


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


9. Vergangenheit

   V 1.0 (07.03.1993):
     Grundversion des Editors mit festen Men�s

   V 1.01 (21.03.1993):
     - bei der Umlautkonvertierung '\3' durch '"s' ersetzt
     - freie Men�farbwahl m�glich

   V 1.10 (06.05.1993):
     - �nderung der Environment-Variablen "menu"
     - Men�datei auch in Englisch vorhanden
     - Men�datei in Teilen auch f�r franz�sich vorhanden
     - Wordumbruch "nur" bei Texteingabe �ber Tastatur
     - nach der Umlautkonvertierung bleibt der Cursor in der
       urspr�nglichen Zeile
     - Anzeige der Dateil�nge zus�tzlich zu den Zeilen- und
       Spaltenangaben neben dem Scrollbalken, wenn die Datei
       gr��er als 62 kByte ist
     - das Einf�gen der LaTeX-Befehle wird �ber die Datei
       REDIT.CMD flexibel, so da� man die einzuf�genden Texte
       selber editieren kann; jeder Befehl kann eine Gr��e von
       bis zu ca. 12 kByte haben

   V 1.20 (01.07.1993):
     - Diese Version ist nur an einige Personen gegangen, die mit
       mir schriftlichen Kontakt hatten. Da ich jedoch in relativ
       kurzer Zeit einen einfachen Ansatz f�r eine Rechtschreib-
       korrektur implementieren konnte, wurde diese Version nicht
       auf dem Server in Stuttgart hinterlegt. Einige Neuerungen
       der Version 2.0 waren schon in Version 1.20 vorhanden.

   V 2.0 (15.07.1993):
     - �nderung der Datei REDIT.MEN
     - neue Men�datei REDIT.INI
     - erg�nzte Hilfedatei
     - nach Anregung durch den TeX-Stammtisch Wuppertal ge�ndertes
       Zeilenumbruchverhalten; es wird jetzt nur noch bei nach einem
       Leerzeichen ein Umbruch vorgenommen => TeX-Anpassung
     - mit der Tastenkombination "Alt-F1" kann die zuletzt aufgerufene
       Hilfe wieder aktiviert werden
     - l�schen des gesamten Desktop ist m�glich
     - das Men� Fenster f�llt weg und wird durch ein Men� pro
       Datei-Fenster ersetzt; das Men� l��t sich �ber die Tastatur
       mit der Tastenkombination "Ctrl-F3" aktivieren; altenativ
       auch �ber Anklicken des Schlie�buttons des Datei-Fensters mit
       der Maus; mit einem Doppelklick l��t sich nun die Datei schlie�en
     - Umbenennung der Environmet-Variablen "MENU" in "STDMEN"
     - nach der Umlautkonvertierung bleibt der Cursor auf der
       urspr�nglichen Position
     - neue Datei REDIT.PAL; diese Datei wird beim Programmstart geladen
       und wird f�r die Farbwahl des Editors ben�tigt; wird das Programm
       verlassen, so wird die Datei erneuert
     - eine einfache Rechtschreibkorrektur ist im Programm integriert; der
       Editor wird um die Dateien REDIT.LEX und LATEX.LEX erweitert
     - als Option kann nun die Tastaturbelegung der deutschen Umlaute
       bestimmt werden

   V 2.10 (1.11.1993):
     - einige Fehler der Rechtschreibkorrektur behoben
     - das Rechtschreibkorrekturmodul erkennt deutsche Umlaute und
       Trennvorgaben wie z.B. \"a oder \-
     - Bildschirmschoner wird automatisch nach ??? Sekunden aktiviert;
       in der Zeile 51 der Datei "REDIT.MEN" wird die Aktivierungszeit
       in Sek. eingegeben; deaktiviert wird mit jeder Aktion von
       Tastatur und Maus; bei g�ffnetem Hilfefenster wird der
       Bildschirmschoner nicht aktiv; bei 0 wird der Bildschirmschoner
       nicht aktiviert
     - es gibt jetzt die M�glichkeit die Befehle "\begin{}" und
       "\end{}" allein in den Text einzubinden; der Inhalt der Klammer
       kann frei gew�hlt werden; sinnvoll f�r nachtr�gliches Einf�gen
       von z.B. Schriftart�nderungen


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


P.S. Hiermit m�chte ich mich noch bei folgenden Personen f�r Ihre Hilfe
     bedanken:
     
     - Helmut Kopka => f�r die spontane Bereitstellung der Hilfe-Quellen
     - Anton Liebetrau => f�r die wichtigsten Module der Rechtschreib-
                          korrektur (aus seinem Buch entnommen)
     - J�rgen Schlegelmilch => f�r die Beantwortung meiner Fragen zur
                               Erstellung des Programms
     - Dorit Isselhorst => f�r Teile der ersten franz�sischen Men�datei
     - Marc Torzynski => f�r die Verbesserung der ersten franz�sischen
                         Men�datei
     - Manuel Cariba => f�r Teile der ersten englischen Men�datei
     - Friedhelm Sowa => f�r die spontane Unterst�tzung w�hrend der
                         Programmentwicklung (Versuchskaninchen?!) und
                         f�r viel Geduld mit mir und den Programmfehlern
     - meiner Frau Uta => f�r sehr sehr viel Geduld bei der Erstellung
                          des Programms

     Und ich bedanke mich nat�rlich auch noch bei den Personen, die mir,
     durch Ihre Anregungen, bei der Entdeckung von Programmfehlern geholfen
     haben und auch viele Ideen zur Verbesserung des Editors geliefert haben.

     Die vielen positiven Reaktionen auf mein Programm haben mich besonders
     gefreut, zeigen sie doch, da� die Idee, die hinter dem Programm steckt,
     angenommen wird.   Vielen Dank!

     Im Anfang war das Wort, und das Wort war bei Gott, und Gott war das
     Wort. Dasselbe war im Anfang bei Gott. Alle Dinge sind durch dasselbe
     gemacht, und ohne dasselbe ist nichts gemacht, was gemacht ist. In
     ihm war das Leben, und das Leben war das Licht der Menschen. Und das
     Licht scheint in der Finsternis, und die Finsternis hat's nicht
     ergriffen.
                    Joh. 1, 1-5


--------------------------------------------------------------------------
         Ende der Dokumentation zum REdit 2.10 von Michael Rogalla
--------------------------------------------------------------------------
--------------------------------------------------------------------------
      Documentation for REdit 2.10 by Michael Rogalla     01.11.1993
--------------------------------------------------------------------------


Contents:  1. Purpose
           2. Future
           3. Installation
           4. The author
           5. Your license


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


1. Purpose

   REdit is written using Turbo Vision supplied with
   Borland International's Turbo Pascal 6.0.
   The aim of REdit is to simplify the work with LaTeX by using the menus
   to insert LaTeX commands into the text.
   Especially the beginner should have be an easier start with LaTeX,
   because he hasen't any wrong LaTeX-command by using the given
   command-menus. I finaly wrote REdit for german beginners in LaTeX. But
   in future I want to support an english and france version.


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


2. Future

   In future I will have an english and france help-text, so I search for
   somebody who translate the original help-sources. I can't speak english
   very well, so I'm not able to get a good translation by my self.
   I don't have learned france too. So I'm not able to translate the text
   to france. I hope to find someone who do this. If you are interested
   into this tasks, please contact with me.


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


3. Installation

   To install the editor you only have to use the program PKUNZIP 2.XX.

   pkunzip -d redit

   After this you must convert the menu-file REDIT.MEN. This must be
   done, because there you find the correct menuscript for your language.
   You convert the menu-file with SPRACHE.BAT:

   sprache eng

      eng:   the suffix of the language-compatible menu-file.


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

4. The author

   I study mechanical engineering at the University of Duisburg in
   Germany. My postal address is

       Michael Rogalla
       Am Tannenbaum 6
       W-5609 H�ckeswagen
       Germany
       email: michael@zeus.uni-duisburg.de

   If you have suggestions or problems, please use e-mail, if possible.
   After 01.12.1993 I don't know how long I can use e-mail, so since
   this day please use my postal address.


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


5. Your license

   All rights on the program are reserved to me, the author. I did a lot
   of testing to find errors, but there is no warranty of correctness:
   the use of the program is on your own risk! I have no liability for
   any direct or indirect damage caused by use of the program.
   This program may be used by individuals, in public environments such as
   computer centers or public computer pools and in research institutions;
   no fee is necessary, but I would be delighted to get a postcard from
   users outside Germany. Use of the program in commercial environments
   requires my written permission.
   Passing on copies of this program is encouraged as long as no fee is
   charged for it (except for cost price: at most the cost for material
   and postage) and the unchanged archive file is used. Distributing this
   program via BBS's is explicitly encouraged.
   If you want to get a update by postal address you have to pay 10 DM for
   stames or something else.
   The copyright on the source file of the syntax help of (La)TeX-Help
   remains entirely reserved to Addison-Wesley und Helmut Kopka:
     Copyright 1992 Helmut Kopka und Addison-Wesley (Deutschland) GmbH.


--------------------------------------------------------------------------
     End of the small documentation of REdit 2.10 by Michael Rogalla
--------------------------------------------------------------------------

Files

Name Size Date Notes
43890 1993-11-25 01:00 ==> /sup­port/redit/redit.doc
redit.doc 43890 1993-11-25 01:00
redit2_1.zip 562278 1993-11-25 01:00 Menu-based ed­i­tor
Guest Book Sitemap Contact