Anleitung zu IdeaForm v1.3 -------------------------- Umfang ------ Der Ordner IDEAFORM enth„lt: 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, Dietrichstraže 9, D-76227 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 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. Die alte TTP-Version (v1.26) ist auf Anfrage erh„ltlich. Sinn und Zweck -------------- IdeaForm ist ein Hilfsprogramm fr IdeaList. Es dient dazu, Programmlistings (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 Programmiersprache angepažt. Natrlich sind mit einer entsprechenden Schlsseldatei auch "normale" Textdateien verarbeitbar, z.B. Tabellen, Kalender oder einfach zur Hervorhebung bestimmter W”rter. 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. Fermer muž die Resourcedatei IDEAFORM.RSC vorhanden sein. Bedienung --------- Beim Programmstart kann IdeaForm eine Textdatei bergeben werden. Ansonsten k”nnen Sie die zu formatierende Datei ber den Button in der darauf erscheinenden Fileselectbox ausw„hlen. 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 nachtr„glich eine andere Schlsseldatei gew„hlt werden. In der Infozeile des Fensters erscheint eine Information ber die gew„hlte 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, h„ngt 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 beginnt die Formatierung. IdeaForm l„dt die Quelldatei und ”ffnet eine Ausgabedatei. Der wachsende Balken zeigt, wie weit die Formatierung fortgeschritten ist. IdeaForm arbeitet im Hintergrund. Sie k”nnen w„hrenddessen 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 druckerunabh„ngige Markierungen. 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 Programmiersprache der Quelldatei. Als Beispiel finden Sie im Ordner KEY mehrere Beispiele fr solche Dateien. Diese mssen Sie bei Bedarf auf die Ordnerebene von IdeaForm kopieren oder verschieben und in IDEAFORM.KEY umbenennen. Die Beispiele sind keinesfalls als vollst„ndig zu betrachten. šber selbsterstellte 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 angezeigt. - 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 Schlsselw”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 Buchstaben sind "a" bis "z" und "A" bis "Z" sowie, falls nicht an erster Stelle,"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. Žnderungen ---------- v1.38: - Kommandozeile mit XARG, langen Dateinamen, und Parameter "-o=filename" - AP_TERM auswerten v1.37: Iconify v1.34 .. v1.36: kleine intere Žnderungen und Bugfixes 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 MagiC und MultiTOS v1.30: GEM-Oberfl„che (bisher: TTP) v1.26: Wenn keine Attribute vereinbart, werden keine Esc-Sequenzen geschrieben. v1.25: Automatische Suche nach der zur Programmiersprache passenden Schlsseldatei v1.24: Zwei verschiedene Stringmarkierungen (statt bisher eine) v1.23: Maximal 255 Schlsselworte (statt bisher 50) v1.22: Bugfixes: Zugriffspfad, Kommentarklammerungen v1.10: Erste ver”ffentlichte TTP-Version ------------------------- Ende von IDEAFORM.TXT ----------------------------