home *** CD-ROM | disk | FTP | other *** search
/ Computer Club Elmshorn Atari PD / CCE_PD.iso / pc / 0400 / CCE_0498.ZIP / CCE_0498.PD / IDEATOOL / ENGLISH / IDEAFORM.TXT < prev    next >
Text File  |  1993-11-22  |  3KB  |  77 lines
  1. ---------------------------
  2. I d e a F o r m    v 1 . 3
  3. ---------------------------
  4.  
  5.       -------------------------------------------------
  6.       Written by 
  7.             Christoph Bartholme,
  8.             Ettlinger Str. 37
  9.             D-76137 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.
  18.       -------------------------------------------------
  19.  
  20. IdeaForm is public domain (Remember: IdeaList is Shareware!).
  21. It may be copied and used by everyone. The condition is to copy the COMPLETE 
  22. and  UNCHANGED contents of the folder IDEAFORM.
  23.  
  24. These are the files:
  25.   IDEAFORM.PRG
  26.   IDEAFORM.RSC
  27.   IDEAFORM.TXT
  28.   KEY\BAS.KEY
  29.       \C.KEY
  30.       \KBJ.KEY
  31.       \MOD.KEY
  32.       \PAS.KEY
  33.       \S.KEY
  34.       \TEX.KEY
  35.       \IDEAFORM.KEY
  36.  
  37. IdeaForm  is  a tool in addition to IdeaList, that can be launched as a kind 
  38. of module but also runs as "stand alone".
  39.  
  40. If  launched by IdeaList, IdeaForm starts its work automatically and returns 
  41. to  IdeaList  after  having  done it. You can abort the work by klicking the 
  42. window  closer  button  or  the selected "Start" button. IdeaForm completely 
  43. works in the background and does not block other processes.
  44.  
  45. IdeaForm formats source code files by inserting text attributes for comments 
  46. and  key  words.  These  attributs  (bold,  light,  italic,  underlined) are 
  47. compatable  to  the  ones  used  by Wordplus (But not codes a printer under- 
  48. stands directly!).
  49.  
  50. These  languange  specific  parameters are found in a KEY file. Depending on 
  51. what  extension  the source file has, IdeaForm selects the corresponding KEY 
  52. file  from the folder KEY: For formatting EXAMPLE.C IdeaForm takes C.KEY. If 
  53. no KEY can be matched IdeaForm uses IDEAFORM.KEY by default. 
  54.  
  55. Of  course  IdeaForm dos not overwrite the source file but creates a new one 
  56. for  the formatted output. Either a file with the source file's name but the 
  57. extension TXA ("Text with attributs"); or SCRAP.TXT at the system clipboard.
  58.  
  59. The KEY file contains the following entries:
  60. - Comments inside the KEY file are initialised by a "+". 
  61.  
  62. - The first entry names the title of the file and is displayed in IdeaForm's 
  63. info line.
  64.  
  65. - The attributs fot the keywords and the comments are switched separately. A 
  66. "1" Switches on, any other character ("0" is best) switches off.
  67.  
  68. -  The  string markers cause the text between them not to be formated. There 
  69. are two different markers declarable, following character by character.
  70.  
  71. -  A  maximum  of  255  keywords  may  be  defined,  every word up to fourty 
  72. characters  long.  There  is no difference if a character is upcased or not. 
  73. Characters  between "A" and "Z" are as possible as the digits "0" to "9" and 
  74. underscores  inside  a  keyword.  It  is not allowed to begin a keyword by a 
  75. digits or a underscore. There is no need to sort the keywords.
  76.  
  77. -----------------------------------------------------------------------------