--------------------------------------------------
A n l e i t u n g   z u   I d e a F o r m    V1.33
--------------------------------------------------


Umfang
------
Der Ordner IDEAFORM enthlt:
  IDEAFORM.PRG : Programmdatei
  IDEAFORM.RSC : Resourcedatei
  IDEAFORM.TXT : diese Anleitung
  KEY/IDEAFORM.KEY : Default-Schlsseldatei
      BAS.KEY      : Schlsseldatei fr Basic-Quellen
      C.KEY        : Schlsseldatei fr C-Quellen
      KBJ.KEY      : Schlsseldatei fr Kobold-Jobdateien
      MOD.KEY      : Schlsseldatei fr Modula2-Quellen
      PAS.KEY      : Schlsseldatei fr Pascal-Quellen
      S.KEY        : Schlsseldatei fr Assembler-Quellen
      TEX.KEY      : Schlsseldatei fr LaTeX-Dateien

Rechtliches
-----------
Autor: Christoph Bartholme, Ettlinger Strae 37, D-76137 Karlsruhe, Germany

Entwickelt mit ST PASCAL+ (CCD) und Assembler

IdeaForm ist ein Public-Domain-Utility zu IdeaList (Shareware)

IdeaForm darf von jedermann/frau angewendet und weitergegeben werden, jedoch
mu  stets  der  gesamte  unvernderte  Inhalt  des Ordners IDEAFORM kopiert
werden.  Krzungen  und  nderungen  verletzen  die  Copyright-Bestimmungen!
Sollten Sie nicht alle Dateien erhalten haben, so verstndigen Sie bitte den
Autor.

Der  Autor  ist  nicht  verantwortlich fr irgendwelche Schden, welche, wie
auch immer, durch Anwendung von IdeaForm entstehen.

Die alte TTP-Version (V1.26) ist auf Anfrage erhltlich.


Sinn und Zweck
--------------
IdeaForm  ist  ein  Hilfsprogramm  fr  IdeaList.  Es  dient dazu, Programm-
Listings (oder vielmehr die Quelldateien dazu) zu formatieren. Das heit, es
werden   bestimmte  Wrter  und  Kommentare  durch  spezielle  Steuerzeichen
markiert.  Die  Ausgabedatei  kann  dann  mit  IdeaList  ausgedruckt werden,
wodurch  die  Steuerzeichen  in  die  entsprechenden  Codes  des verwendeten
Druckers  umgewandelt  werden  (z.B.  Fett- oder Kursiv-Druck). Das Programm
wird  ber  eine  Schlsseldatei IDEAFORM.KEY an die Syntax der Programmier-
sprache  angepat.  Natrlich  sind  mit einer entsprechenden Schlsseldatei
auch  "normale"  Textdateien  verarbeitbar,  z.B.  Tabellen,  Kalender  oder
einfach zur Hervorhebung bestimmter Wrter.


Installierung
-------------
IdeaForm  bentigt  eine Schlsseldatei, die nach der Standard-Extension der
entsprechenden  Programmiersprache  benannt  ist, also etwa BAS.KEY, PAS.KEY
oder  MOD.KEY;  oder  einfach  eine  Schlsseldatei namens IDEAFORM.KEY. Die
Schlsseldatei mu entweder auf der gleichen Ordner-Ebene oder im Ordner KEY
zu finden sein. Fermer mu die Resourcedatei IDEAFORM.RSC vorhanden sein.


Bedienung
---------
Beim  Programmstart kann IdeaForm eine Textdatei bergeben werden. Ansonsten
knnen  Sie  die  zu  formatierende Datei ber den Button <Textdatei> in der
darauf  erscheinenden  Fileselectbox  auswhlen. IdeaForm versucht nun, eine
dem  Quelltext  entsprechende  Schlsseldatei  zu  finden. Fr den Quelltext
CRAY_EMU.C  sucht  IdeaForm  also  nach  der  Schlsseldatei C.KEY. Nach dem
Einstellen  der Quelldatei kann mit dem Button <KEY-Datei> nachtrglich eine
andere   Schlsseldatei  gewhlt  werden.  In  der  Infozeile  des  Fensters
erscheint eine Information ber die gewhlte KEY-Datei.

Die Ausgabedatei kann auf dem System-Clipboard oder im Ordner der Quelldatei
angelegt  werden.  Im  ersten  Fall wird SCRAP.TXT erzeugt, im zweiten nimmt
IdeaForm  dazu  den Namen der Quelldatei, hngt aber die Extension TXA (Text
mit Attributen) an. Die umformatierte Datei D:\QUELLE\CRAY_EMU.C landet also
in D:\QUELLE\CRAY_EMU.TXA.

Mit  <Start>  beginnt  die  Formatierung.  IdeaForm  ldt die Quelldatei und
ffnet eine Ausgabedatei. Der wachsende Balken zeigt, wie weit die Formatie-
rung  fortgeschritten  ist.  IdeaForm  arbeitet  im  Hintergrund. Sie knnen
whrenddessen  also mit Accessories oder (in einer Multitaskingumgebung) mit
anderen Programmen weiterarbeiten.

Achtung:  Als  Quelldatei  darf  nur ein reiner ASCII-Text verwendet werden,
keinesfalls tokenisierte Dateien (*.BAS, *.GFA, *.ASM etc).

Die  Attributcodes,  die  in  der  Ausgabedatei eingefgt werden, sind keine
Steuercodes, die ein Drucker versteht, sondern druckerunabhngige Markierun-
gen.  Daher  sollte  die  Ausgabedatei  stets  ber  IdeaList  oder Wordplus
ausgedruckt  werden,  und nicht etwa direkt vom Desktop aus oder mit anderen
Textverarbeitungen und Druckprogrammen ausgegeben werden.


Aufruf aus IdeaList
-------------------
Von  IdeaList  aus  kann  IdeaForm  einfach  ber einen Meneintrag oder die
entsprechende  Taste aufgerufen werden. IdeaForm startet dann sofort mit der
Ausgabe auf das Clipboard und beendet sich danach von selbst.


Schlsseldatei
--------------
Die  Schlsseldatei  dient  zur  Anpassung des Programms an die Programmier-
sprache  der  Quelldatei.  Als  Beispiel  finden  Sie  im Ordner KEY mehrere
Beispiele  fr  solche  Dateien. Diese mssen Sie bei Bedarf auf die Ordner-
Ebene von IdeaForm kopieren oder verschieben und in IDEAFORM.KEY umbenennen.
Die Beispiele sind keinesfalls als vollstndig zu betrachten. ber selbster-
stellte oder erweiterte Schlsseldateien freut sich der Autor immer.

Das Format der Schlsseldateien ist ganz einfach:

Kommentare werden durch "+" gekennzeichnet. Relevante Eintragungen mssen am
Zeilenanfang beginnen.

-  Die  erste Eintragung TITEL DER DATEI wird von IdeaForm als Kennung ange-
 zeigt.

- Die  ATTRIBUTE  FR  SCHLSSELWRTER  und  ATTRIBUTE FR KOMMENTARE werden
 jeweils  durch  eine "1" gesetzt. Jedes andere Zeichen (am besten eine "0")
 schaltet das entsprechende Attribut ab. Mehrere Attribute drfen kombiniert
 werden.  Wenn  berhaupt  keine  Attribute  vereinbart  sind, werden in die
 Ausgabedatei  auch keine Attributcodes geschrieben. Somit kann man IdeaForm
 auch  verwenden,  um einfach nur eine einheitliche Schreibweise der Schls-
 selwrter (etwa in Grobuchstaben) zu erhalten.

- Die  STRING-MARKIERUNGEN  bewirken,  da  Textteile  zwischen zwei solchen
 Zeichen   nicht  als  formatierbar  betrachtet werden, sondern immer wie im
 Quelltext  belassen  werden.  Es  sind zwei verschiedene Markierungszeichen
 mglich,   die  direkt  hintereinander  angegeben werden mssen (z.B '" fr
 'String' und  "String").

- IdeaForm  unterscheidet zwei verschiedene KOMMENTARKLAMMERUNGEN. Falls die
 Programmiersprache  nur  eine  Kommentar-Art kennt, mu das zweite Klammer-
 paar  als  Leerzeichen definiert werden. Falls der Kommentar automatisch am
 Zeilenende  endet  (Basic  oder  Assembler...), ist als Kommentarende `EOL'
 (End Of Line) anzugeben.

- Maximal  255  SCHLSSELWRTER  knnen  definiert werden; weniger sind auch
 erlaubt,  berzhlige werden ignoriert. Die Reihenfolge ist egal. Falls ein
 Wort  lnger  als  40  Zeichen ist, wird der Rest nicht beachtet. Als Buch-
 staben  sind "a" bis "z" und "A" bis "Z" sowie, falls nicht an erster Stel-
 le,"0"  bis  "9" und der Unterstrich "_" erlaubt. Gro- und Kleinschreibung
 im Quelltext ist egal, in der Ausgabe werden die Wrter so geschrieben, wie
 sie in der Schlsseldatei definiert sind.


Changes
-------
V1.33: Bugfix: Kleine  Ungereimtheiten  bei  gesperrten  Buttons und bei der
       Infozeile
V1.32: Bugfix: Parameterbergabe beim Start von IdeaList aus
V1.31: Bugfix: Hintergrundbedienung unter MAg!X und MultiTOS
V1.30: GEM-Oberflche (bisher: TTP)
V1.26: Wenn keine Attribute vereinbart, werden keine Esc-Sequenzen geschrie-
       ben.
V1.25: Automatische  Suche nach der zur Programmiersprache passenden Schls-
       seldatei
V1.24: Zwei verschiedene Stringmarkierungen (statt bisher eine)
V1.23: Maximal 255 Schlsselworte (statt bisher 50)
V1.22: Bugfixes: Zugriffspfad, Kommentarklammerungen
V1.10: Erste verffentlichte TTP-Version


------------------------- Ende von IDEAFORM.TXT ----------------------------