home *** CD-ROM | disk | FTP | other *** search
/ Dream 60 / Amiga_Dream_60.iso / Atari / Prog / ifrm139e.txt next >
Text File  |  1997-01-29  |  8KB  |  172 lines
  1. ----------------------------
  2. I d e a F o r m    v 1 . 3 7 
  3. ----------------------------
  4.  
  5.            -------------------------------------------------
  6.       Written by
  7.             Christoph Bartholme,
  8.             Dietrichstra₧e 9
  9.             D-76227 Karlsruhe
  10.             Germany
  11.  
  12.             EMail: Christoph_Bartholme@ka2.maus.de
  13.  
  14.       Developed using
  15.             ST Pascal Plus (CCD) and Assembler (Devpac)
  16.  
  17.       A German version is also available on request, including the old 
  18.       TTP version (V1.26).
  19.  
  20.            -------------------------------------------------
  21.  
  22. IdeaForm is public domain (remember: IdeaList is Shareware!).
  23. It may be copied and used by everyone. The condition is to copy the COMPLETE
  24. and UNCHANGED contents of the folder IDEAFORM.
  25.  
  26. These are the files:
  27.   IDEAFORM.PRG     : The program file
  28.   IDEAFORM.RSC     : The associated resource file
  29.   IDEAFORM.TXT     : These instructions
  30.   KEY\BAS.KEY      : Key file for Basic  source files
  31.       \C.KEY       : Key file for C source files
  32.       \KBJ.KEY     : Key file for Kobold Job files
  33.       \MOD.KEY     : Key file for Modula-2 source files
  34.       \PAS.KEY     : Key file for Pascal source files
  35.       \S.KEY       : Key file for Assembler source files
  36.       \TEX.KEY     : Key file for LaTeX files
  37.       \IDEAFORM.KEY: Default key file (Pascal).
  38.  
  39. The author excludes liability for any damage that may be caused in any way 
  40. by using IdeaForm.
  41.  
  42.  
  43.  
  44. Purpose
  45. -------
  46. IdeaForm is an additional tool for IdeaList  which can be launched as a kind
  47. of module, but also runs as a 'stand alone' program.
  48.  
  49. IdeaForm  makes source code listings easier to read  by emphasising comments 
  50. and keywords with text attributes  (bold, light, italic, underlined).  These
  51. are produced by escape codes inserted into output files written by IdeaForm.
  52. The files produced  may be printed out  from IdeaList,  which translates the
  53. escape codes into the control codes used by various printers.
  54.  
  55. The program is adapted to the syntax  of the programming language  via a key 
  56. file IDEAFORM.KEY.  With a corresponding key file 'normal' text files can be
  57. processed also, e.g. tables, calendars or just emphasising certain words.
  58.  
  59.  
  60. Installation
  61. ------------
  62. IdeaForm needs a key file that is named after  the standard extension of the
  63. corresponding programming language (such as BAS.KEY, PAS.KEY, or MOD.KEY for
  64. instance),  or simply a key file named IDEAFORM.KEY.  The key file has to be
  65. stored either at the same folder level or in the KEY folder and the resource
  66. file IDEAFORM.RSC has to be present.
  67.  
  68.  
  69. Usage
  70. -----
  71. At program start IdeaForm can be passed a text file by IdeaList (see below),
  72. or from a command line or multi-tasking system.  Alternatively you can start
  73. the program by double-clicking on it from the desktop,  then select the file
  74. you want to work on  in the file selector that appears  after a click on the 
  75. 'Text file...' button.  IdeaForm now looks for a  key file  corresponding to
  76. the source text: For formatting CRAY_EMU.C, IdeaForm uses C.KEY, for example.
  77. If no .KEY file can be matched, IdeaForm uses IDEAFORM.KEY by default.
  78.  
  79. If desired a different key file can be loaded with the 'KEY file...' button.
  80. The name of the selected key file will be shown in the window's info line.
  81.  
  82. Of  course  IdeaForm doesn't overwrite the source file but creates a new one
  83. for  the formatted output:  Either a file SCRAP.TXT in the system clipboard, 
  84. or, if preferred, a file with the source file's name but the extension 'TXA' 
  85. (TeXt with Attributes) in the same directory as the source;  so reformatting 
  86. the file D:\SOURCE\CRAY_EMU.C will result in D:\SOURCE\CRAY_EMU.TXA).
  87.  
  88. Formatting commences by clicking on 'Start'.  IdeaForm loads the source file
  89. and opens the output file. The growing bar shows the progress of formatting.
  90. You can abort the work by clicking the window  closer-button or the selected
  91. 'Start' button. IdeaForm works completely in the background  and so does not
  92. block other processes.  You can work with desk accessories or  (under multi-
  93. tasking) with other programs in the meanwhile.
  94.  
  95. Warning: The source file has to be a pure ASCII file,  NOT  a tokenised file
  96. (such as *.BAS, *.GFA or *.ASM etc.).
  97.  
  98. The attribute codes inserted in the output file are not control codes that a
  99. printer understands directly but printer-independent markings (compatible to 
  100. those used by  1st Word Plus).  Therefore the output file  should be printed
  101. via  IdeaList  or Wordplus, and not directly from the desktop  or other text
  102. processors or printing programs.
  103.  
  104.  
  105. Calling from IdeaList
  106. ---------------------
  107. The program can be launched from IdeaList  with  'Launch IdeaForm...'  or by  
  108. pressing the corresponding key.  IdeaForm  will start working  automatically
  109. and output to the clipboard on the boot drive, then returns to IdeaList.
  110.  
  111.  
  112. Key file
  113. --------
  114. The .KEY file serves to adapt the program to the programming language of the
  115. source file. You will find several examples for such files in the KEY folder
  116. on the disk.  You have to  copy  or move these  to the same folder level  as 
  117. IdeaForm,  and it is a good idea to rename the most frequently used file  to
  118. IDEAFORM.KEY. The examples are by no means comprehensive; the author will be
  119. glad to receive any key files you have written or extended.
  120.  
  121. The format of key files is quite simple:
  122.  
  123. - Any comments about entries in the KEY file are preceded by a '+'.
  124.  
  125. - All relevant entries have to begin at the start of the line.
  126.  
  127. - The first entry names the TITLE OF THE FILE and is displayed in IdeaForm's
  128.   info line.
  129.  
  130. - ATTRIBUTES FOR THE KEYWORDS  and THE COMMENTS  are switched separately.  A
  131.   '1' switches them on, any other character ('0' is best) switches them off. 
  132.   Several attributes may be combined. If no attributes are defined then none
  133.   will be written to the output file.  In that way one can achieve a uniform
  134.   way of writing the keywords (perhaps in capitals).
  135.  
  136. -  STRING MARKERS cause the text between them not to be formated but to stay
  137.    as in the  source text.  Two different markers  are declarable,  with one
  138.    following directly after the other (e.g. '" for 'String' and "String").
  139.  
  140. -  IdeaForm differentiates between two different COMMENT PARENTHESES. If the
  141.    programming  language  only  understands  one type of comments,  then the
  142.    second pair of parentheses  (brackets/braces)  must be defined as spaces. 
  143.    If the comment  automatically  finishes  at the end of a line  (Basic  or
  144.    Assembler...) then  'EOL' (End Of Line)  should be assigned to the end of 
  145.    the comment.
  146.  
  147. -  A  maximum  of  255  KEYWORDS  may be  defined; fewer are also permitted,
  148.    any above 255  will be ignored.  The order is immaterial.  If any word is 
  149.    more than 40 characters long,  the rest will be ignored.  Characters from
  150.    'a' and 'z' or 'A' and 'Z' are allowed inside  a  keyword, as well as the
  151.    digits  '0' to '9'  (but not in the first position)  and underscores '_'.
  152.    It does not matter whether words in the source text are in capitals or in
  153.    lower case; they will be output in the form defined in the key file.
  154.  
  155.  
  156. Changes
  157. -------
  158. V1.34 .. V1.37: Small internal changes
  159. V1.33: Bugfix: Problems with greyed out buttons and the info line.
  160. V1.32: Bugfix: Parameter passing when starting from IdeaList.
  161. V1.31: Bugfix: Operation in background under MagiC and MultiTOS.
  162. V1.30: GEM operation (previously .TTP).
  163. V1.26: If no attributes defined, no escape sequences will be written.
  164. V1.25: Automatic search for keyword file matching the programming language.
  165. V1.24: Two different string markings (previously only one).
  166. V1.23: Maximum of 255 keywords (previously 50).
  167. V1.22: Bugfixes: Access path, commentary parentheses.
  168. V1.10: First distributed .TTP version.
  169.  
  170. ---------------------------------------------------------------------------
  171.  
  172.