-------------------------------------------------- A n l e i t u n g z u I d e a F o r m V1.26 -------------------------------------------------- Umfang ------ Der Ordner IDEAFORM enth„lt: IDEAFORM.TTP : Programmdatei IDEAFORM.TXT : diese Anleitung KEYS/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 Straže 37, W-7500 Karlsruhe 1, Germany (ab 1.7.1993: D-76137 Karlsruhe) 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 unver„nderte Inhalt des Ordners IDEAFORM kopiert werden. Krzungen und Žnderungen verletzen die Copyright-Bestimmungen! Sollten Sie nicht alle Dateien erhalten haben, so verst„ndigen Sie bitte den Autor. Der Autor ist nicht verantwortlich fr irgendwelche Sch„den, welche, wie auch immer, durch Anwendung von IdeaForm entstehen. Sinn und Zweck -------------- IdeaForm ist ein Hilfsprogramm fr IdeaList. Es dient dazu, Programm- Listings (oder vielmehr die Quelldateien dazu) zu formatieren. Das heižt, es werden bestimmte W”rter 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 angepažt. Natrlich sind mit einer entsprechenden Schlsseldatei auch `normale' Textdateien verarbeitbar, z.B. Tabellen, Kalender oder einfach zur Hervorhebung bestimmter W”rter. Voraussetzungen --------------- Da IdeaForm eine reine TOS-Anwendung ohne Grafikuntersttzung ist, l„uft das Programm unter jeder Bildschirmaufl”sung. Installierung ------------- IdeaForm ben”tigt 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. Bedienung --------- IdeaForm kann entweder direkt vom Desktop aus oder aus einer Kommandoshell heraus gestartet werden. Als šbergabeparameter erwartet das Programm den Pfad und Namen der zu formatierenden Datei. Geben Sie also in der TTP-Box des Desktops z.B FILENAME.EXT an wenn die gewnschte Datei FILENAME.EXT im selben Ordner wie IdeaForm zu finden ist, oder C:\ORDNER\FILENAME.EXT, wenn sich die Datei FILENAME.EXT auf Laufwerk C im Ordner ORDNER befindet. Žhn- liches gilt beim Aufruf aus einer Kommandoshell. Weitere Eingaben sind nicht erforderlich. IdeaForm ”ffnet nun eine Ausgabe- datei mit dem Namen der Quelldatei in deren Ordner-Ebene, wobei der Extender in TXA (`Text mit Attributen') ge„ndert wird. Die Formatierung der Quell- datei CRAY_EMU.MOD wird also in CRAY_EMU.TXA ausgegeben. Die Quelldatei wird dabei natrlich nicht ge„ndert, denn eine TXA-Datei drfte kein Compiler verarbeiten k”nnen. Achtung: Als Quelldatei darf nur ein reiner ASCII-Text verwendet werden, keinesfalls tokenisierte Dateien (*.BAS, *.GFA, *.ASM etc). Falls die Quelldatei oder Schlsseldatei nicht gefunden werden, oder zu wenig RAM verfgbar ist, um die Quelldatei zu laden, bricht das Programm mit einer Fehlernennung ab. Ebenso wird gemeldet, wenn das Speichermedium (Dis- kette, Partition, RAM-Disk) voll ist. Die Attributcodes, die in der Ausgabedatei eingefgt werden, sind keine Steuercodes, die ein Drucker versteht, sondern druckerunabh„ngige Markierun- gen. Daher sollte die Ausgabedatei immer ber IdeaList ausgedruckt werden, und nicht etwa direkt vom Desktop aus oder mit anderen Textverarbeitungen und Druckprogrammen ausgegeben werden.. Aufruf aus IdeaList ------------------- Von IdeaList aus (ab V3.0) kann IdeaForm einfach ber einen Meneintrag oder die Taste aufgerufen werden. Der Name der aktuellen Datei wird dann automatisch an IdeaForm bermittelt. Nach Ende des Programms installiert IdeaList automatisch die Ausgabedatei (*.TXA), welche dann ausgedruckt werden kann. Vor dem Ausdrucken k”nnen Sie die Attribute mit der Zeilenlupe kontrollieren. 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 vollst„ndig 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 FšR SCHLšSSELW™RTER und ATTRIBUTE FšR 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- selw”rter (etwa in Grožbuchstaben) 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 m”glich, 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 SCHLšSSELW™RTER k”nnen definiert werden, weniger sind auch erlaubt, berz„hlige werden ignoriert. Die Reihenfolge ist egal. Falls ein Wort l„nger 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 W”rter so geschrieben, wie sie in der Schlsseldatei definiert sind. Internes -------- IdeaForm und IdeaList verwenden standardisierte Attributcodes, welche auch von Wordplus benutzt werden. Unter Umst„nden k”nnen Ausgabedateien also auch damit weiterbearbeitet werden. Anregungen, Wnsche und Bugmeldungen sind immer willkommen! Changes ------- 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.1 : Erste ver”ffentlichte Version ------------------------- Ende von IDEAFORM.TXT ----------------------------