home *** CD-ROM | disk | FTP | other *** search
/ M.u.C.S. Disc 2000 / MUCS2000.iso / anwend / ideaform / ideaform.txt < prev   
Text File  |  1996-07-09  |  8KB  |  185 lines
  1. Anleitung zu IdeaForm v1.3
  2. --------------------------
  3.  
  4.  
  5. Umfang
  6. ------
  7. Der Ordner IDEAFORM enthält:
  8.   IDEAFORM.PRG : Programmdatei
  9.   IDEAFORM.RSC : Resourcedatei
  10.   IDEAFORM.TXT : diese Anleitung
  11.   KEY/IDEAFORM.KEY : Default-Schlüsseldatei
  12.       BAS.KEY      : Schlüsseldatei für Basic-Quellen
  13.       C.KEY        : Schlüsseldatei für C-Quellen
  14.       KBJ.KEY      : Schlüsseldatei für Kobold-Jobdateien
  15.       MOD.KEY      : Schlüsseldatei für Modula2-Quellen
  16.       PAS.KEY      : Schlüsseldatei für Pascal-Quellen
  17.       S.KEY        : Schlüsseldatei für Assembler-Quellen
  18.       TEX.KEY      : Schlüsseldatei für LaTeX-Dateien
  19.  
  20. Rechtliches
  21. -----------
  22. Autor: Christoph Bartholme, Dietrichstra₧e 9, D-76227 Karlsruhe, Germany
  23.  
  24. Entwickelt mit ST PASCAL+ (CCD) und Assembler
  25.  
  26. IdeaForm ist ein Public-Domain-Utility zu IdeaList (Shareware)
  27.  
  28. IdeaForm darf von jedermann/frau angewendet und weitergegeben werden, jedoch 
  29. mu₧ stets der gesamte unveränderte Inhalt des Ordners IDEAFORM kopiert 
  30. werden. Kürzungen und Änderungen verletzen die Copyright-Bestimmungen! 
  31. Sollten Sie nicht alle Dateien erhalten haben, so verständigen Sie bitte den 
  32. Autor.
  33.  
  34. Der Autor ist nicht verantwortlich für irgendwelche Schäden, welche, wie 
  35. auch immer, durch Anwendung von IdeaForm entstehen.
  36.  
  37. Die alte TTP-Version (v1.26) ist auf Anfrage erhältlich.
  38.  
  39.  
  40. Sinn und Zweck
  41. --------------
  42. IdeaForm ist ein Hilfsprogramm für IdeaList. Es dient dazu, Programmlistings 
  43. (oder vielmehr die Quelldateien dazu) zu formatieren. Das hei₧t, es werden 
  44. bestimmte Wörter und Kommentare durch spezielle Steuerzeichen markiert. Die 
  45. Ausgabedatei kann dann mit IdeaList ausgedruckt werden, wodurch die 
  46. Steuerzeichen in die entsprechenden Codes des verwendeten Druckers 
  47. umgewandelt werden (z.B. Fett- oder Kursiv-Druck). Das Programm wird über 
  48. eine Schlüsseldatei IDEAFORM.KEY an die Syntax der Programmiersprache 
  49. angepa₧t. Natürlich sind mit einer entsprechenden Schlüsseldatei auch 
  50. "normale" Textdateien verarbeitbar, z.B. Tabellen, Kalender oder einfach zur 
  51. Hervorhebung bestimmter Wörter.
  52.  
  53.  
  54. Installierung
  55. -------------
  56. IdeaForm benötigt eine Schlüsseldatei, die nach der Standard-Extension der 
  57. entsprechenden Programmiersprache benannt ist, also etwa BAS.KEY, PAS.KEY 
  58. oder MOD.KEY; oder einfach eine Schlüsseldatei namens IDEAFORM.KEY. Die 
  59. Schlüsseldatei mu₧ entweder auf der gleichen Ordner-Ebene oder im Ordner KEY 
  60. zu finden sein. Fermer mu₧ die Resourcedatei IDEAFORM.RSC vorhanden sein.
  61.  
  62.  
  63. Bedienung
  64. ---------
  65. Beim Programmstart kann IdeaForm eine Textdatei übergeben werden. Ansonsten 
  66. können Sie die zu formatierende Datei über den Button <Textdatei> in der 
  67. darauf erscheinenden Fileselectbox auswählen. IdeaForm versucht nun, eine 
  68. dem Quelltext entsprechende Schlüsseldatei zu finden. Für den Quelltext 
  69. CRAY_EMU.C sucht IdeaForm also nach der Schlüsseldatei C.KEY. Nach dem 
  70. Einstellen der Quelldatei kann mit dem Button <KEY-Datei> nachträglich eine 
  71. andere Schlüsseldatei gewählt werden. In der Infozeile des Fensters 
  72. erscheint eine Information über die gewählte KEY-Datei.
  73.  
  74. Die Ausgabedatei kann auf dem System-Clipboard oder im Ordner der Quelldatei 
  75. angelegt werden. Im ersten Fall wird SCRAP.TXT erzeugt, im zweiten nimmt 
  76. IdeaForm dazu den Namen der Quelldatei, hängt aber die Extension TXA (Text 
  77. mit Attributen) an. Die umformatierte Datei D:\QUELLE\CRAY_EMU.C landet also 
  78. in D:\QUELLE\CRAY_EMU.TXA.
  79.  
  80. Mit <Start> beginnt die Formatierung. IdeaForm lädt die Quelldatei und 
  81. öffnet eine Ausgabedatei. Der wachsende Balken zeigt, wie weit die 
  82. Formatierung fortgeschritten ist. IdeaForm arbeitet im Hintergrund. Sie 
  83. können währenddessen also mit Accessories oder (in einer 
  84. Multitaskingumgebung) mit anderen Programmen weiterarbeiten.
  85.  
  86. Achtung: Als Quelldatei darf nur ein reiner ASCII-Text verwendet werden, 
  87. keinesfalls tokenisierte Dateien (*.BAS, *.GFA, *.ASM etc).
  88.  
  89. Die Attributcodes, die in der Ausgabedatei eingefügt werden, sind keine 
  90. Steuercodes, die ein Drucker versteht, sondern druckerunabhängige 
  91. Markierungen. Daher sollte die Ausgabedatei stets über IdeaList oder 
  92. Wordplus ausgedruckt werden, und nicht etwa direkt vom Desktop aus oder mit 
  93. anderen Textverarbeitungen und Druckprogrammen ausgegeben werden.
  94.  
  95.  
  96. Aufruf aus IdeaList
  97. -------------------
  98. Von IdeaList aus kann IdeaForm einfach über einen Menüeintrag oder die 
  99. entsprechende Taste aufgerufen werden. IdeaForm startet dann sofort mit der 
  100. Ausgabe auf das Clipboard und beendet sich danach von selbst.
  101.  
  102.  
  103. Schlüsseldatei
  104. --------------
  105. Die Schlüsseldatei dient zur Anpassung des Programms an die 
  106. Programmiersprache der Quelldatei. Als Beispiel finden Sie im Ordner KEY 
  107. mehrere Beispiele für solche Dateien. Diese müssen Sie bei Bedarf auf die 
  108. Ordnerebene von IdeaForm kopieren oder verschieben und in IDEAFORM.KEY 
  109. umbenennen. Die Beispiele sind keinesfalls als vollständig zu betrachten. 
  110. Über selbsterstellte oder erweiterte Schlüsseldateien freut sich der Autor 
  111. immer.
  112.  
  113. Das Format der Schlüsseldateien ist ganz einfach:
  114.  
  115. Kommentare werden durch "+" gekennzeichnet. Relevante Eintragungen müssen am 
  116. Zeilenanfang beginnen.
  117.  
  118. - Die erste Eintragung TITEL DER DATEI wird von IdeaForm als Kennung 
  119. angezeigt.
  120.  
  121. - Die ATTRIBUTE FÜR SCHLÜSSELWÖRTER und ATTRIBUTE FÜR KOMMENTARE werden 
  122. jeweils durch eine "1" gesetzt. Jedes andere Zeichen (am besten eine "0") 
  123. schaltet das entsprechende Attribut ab. Mehrere Attribute dürfen kombiniert 
  124. werden. Wenn überhaupt keine Attribute vereinbart sind, werden in die 
  125. Ausgabedatei auch keine Attributcodes geschrieben. Somit kann man IdeaForm 
  126. auch verwenden, um einfach nur eine einheitliche Schreibweise der 
  127. Schlüsselwörter (etwa in Gro₧buchstaben) zu erhalten.
  128.  
  129. - Die STRING-MARKIERUNGEN bewirken, da₧ Textteile zwischen zwei solchen 
  130. Zeichen nicht als formatierbar betrachtet werden, sondern immer wie im 
  131. Quelltext belassen werden. Es sind zwei verschiedene Markierungszeichen 
  132. möglich, die direkt hintereinander angegeben werden müssen (z.B '" für 
  133. 'String' und  "String").
  134.  
  135. - IdeaForm unterscheidet zwei verschiedene KOMMENTARKLAMMERUNGEN. Falls die 
  136. Programmiersprache nur eine Kommentar-Art kennt, mu₧ das zweite Klammer- 
  137. paar als Leerzeichen definiert werden. Falls der Kommentar automatisch am 
  138. Zeilenende endet (Basic oder Assembler...), ist als Kommentarende `EOL' (End 
  139. Of Line) anzugeben.
  140.  
  141. - Maximal 255 SCHLÜSSELWÖRTER können definiert werden; weniger sind auch 
  142. erlaubt, überzählige werden ignoriert. Die Reihenfolge ist egal. Falls ein 
  143. Wort länger als 40 Zeichen ist, wird der Rest nicht beachtet. Als Buchstaben 
  144. sind "a" bis "z" und "A" bis "Z" sowie, falls nicht an erster Stelle,"0" bis 
  145. "9" und der Unterstrich "_" erlaubt. Gro₧- und Kleinschreibung im Quelltext 
  146. ist egal, in der Ausgabe werden die Wörter so geschrieben, wie sie in der 
  147. Schlüsseldatei definiert sind.
  148.  
  149.  
  150. Änderungen
  151. ----------
  152. v1.38:
  153. - Kommandozeile mit XARG, langen Dateinamen, und Parameter "-o=filename"
  154. - AP_TERM auswerten
  155.  
  156. v1.37: Iconify
  157.  
  158. v1.34 .. v1.36: kleine intere Änderungen und Bugfixes
  159.  
  160. v1.33: Bugfix: Kleine Ungereimtheiten bei gesperrten Buttons und bei der 
  161. Infozeile
  162.  
  163. v1.32: Bugfix: Parameterübergabe beim Start von IdeaList aus
  164.  
  165. v1.31: Bugfix: Hintergrundbedienung unter MagiC und MultiTOS
  166.  
  167. v1.30: GEM-Oberfläche (bisher: TTP)
  168.  
  169. v1.26: Wenn keine Attribute vereinbart, werden keine Esc-Sequenzen 
  170. geschrieben.
  171.  
  172. v1.25: Automatische Suche nach der zur Programmiersprache passenden 
  173. Schlüsseldatei
  174.  
  175. v1.24: Zwei verschiedene Stringmarkierungen (statt bisher eine)
  176.  
  177. v1.23: Maximal 255 Schlüsselworte (statt bisher 50)
  178.  
  179. v1.22: Bugfixes: Zugriffspfad, Kommentarklammerungen
  180.  
  181. v1.10: Erste veröffentlichte TTP-Version
  182.  
  183.  
  184. ------------------------- Ende von IDEAFORM.TXT ----------------------------
  185.