home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR8 / FOLD11.ZIP / READ.ME < prev   
Text File  |  1993-08-06  |  7KB  |  164 lines
  1. Hello,
  2.  
  3. (sorry for my perhaps bad english)
  4.  
  5. with this macro-package, it is possible to make TSE a very simple,
  6. folding editor. I don't want to describe, what the principle of folding
  7. editors in general is, that would be too complex here. I only want to
  8. describe shortly, how you can apply this macro to your own desires, and
  9. which bugs still are alive. As example, WHAT can be realized, you should
  10. execute the macro FOLD.MAC and then view the Sourcefile FOLD.S. Nice,
  11. isn't it? And easy to read...
  12.  
  13. (Some people told me, in USA, this sort of editor is called "outliner")
  14.  
  15. BTW: please configure the needed keys as YOU want it, I used Ctrl-F10,
  16. Ctrl-F11 and Ctrl-F12 and the others only as examples. Also, please
  17. define yourself an help file. If the macro becomes bigger, I think that I
  18. will supply such an help file.
  19.  
  20. How to configure this macro
  21. ===========================
  22. Within this package, you should find a file FOLD.CFG. The name of this
  23. file MUST remain. But anybody programming e.g. in Pascal instead of
  24. TSE-Macros should change the comment-characters as follows:
  25.  
  26. startcomment=(*
  27. endcomment=*)
  28.  
  29. Watch out, that neither before nor after the "=" character spaces may
  30. appear. You even have to write the keywords correctly, else you would
  31. get a little trouble.
  32.  
  33. Those who don't like, that folds are marked with "{{{" / "}}}" may use
  34. any characters, placed in the lines "startfold" and "endfold". Remember,
  35. that in ANY line not more than 6 characters are allowed.
  36.  
  37. One more thing: the "space" after "closedfold=" isn't really a "space".
  38. It's the Character #255 (0xff), and I chose this character
  39. intentionally.
  40.  
  41. The lines in the CFG-File may appear in any order. Side-Effect: you see,
  42. how to use Configuration Files without being supported directly by the
  43. Macro-language.
  44.  
  45. KNOWN BUGS
  46. ==========
  47.  
  48. There is no protection for the folding-lines, thus if someone changes
  49. the Line starting with the <closedfold> characters, he should know, that
  50. TSE is perhaps not in state to find the internal buffer. The reason is,
  51. that the description of the fold is taken as reference-name for this
  52. internal system buffer. Overwriting lines starting with <startfold>
  53. characters is not so harmful, but I advise you, NOT to do this.
  54. ("Enter at your own risk" - B.Simpson)
  55.  
  56. Nested folds are not possible yet. It would be too complex for me at the
  57. moment to implement this feature. But if you absolutely want it, there
  58. could be a dirty workaround, but I'm not sure, if it really works
  59. (especially while initial closing or final opening of all folds for
  60. saving the file): create one fold with a name, let's say "louie". Then,
  61. WITHIN this fold create some empty lines, and then create another fold
  62. with another name, let's say "foo". When you finished your work in
  63. "foo", close this fold, and after finishing work in "louie", close this
  64. fold too. Opening now must happen in reverse order: first open "louie",
  65. then open "foo" - voilà, it should have worked. But I recommend you,
  66. better NOT to do such things - leaving the editor would DEFINITELY
  67. destroy "foo", I think.
  68.  
  69. Improvements, new versions:
  70.  
  71. If I find the time, I'm surely interested in improving my macro. I
  72. think, in one of the next versions, the menu-driven configuration will
  73. be implemented. I also will _try_ to implement nested folds, but that's
  74. really complex, so this will take some time. Finally, in one of the next
  75. versions, there will be a function to DEactivate the macro.
  76.  
  77. If someone has suggestions or has done changes in sourcecode - please
  78. send them to me (see below for my email-addresses).
  79.  
  80. COPYRIGHT
  81. =========
  82. The complete archive comes with a copyright (c) 1993 Dirk Wissmann. But
  83. you can freely redistribute this file to everyone, but only WITHOUT ANY
  84. FEE. Thus, $00 is the only acceptable price. That implies, that
  85. Shareware- and Public-Domain-Libraries, which take a small fee for
  86. copying files, are NOT allowed to distribute this file or portions of
  87. it. The ONLY exeption: costs for floppy disks, which should be max.
  88. US$ 0.75 for 5.25 inch disks, and US$ 1.75 for 3.5 inch disks.
  89.  
  90. For more exceptions, I have to be asked, and I have to give them
  91. WRITTEN (including E-Mail), otherwise there are no exceptions.
  92.  
  93. So, but this should be enough of legal stuff
  94.  
  95. THE AUTHOR
  96. ==========
  97. ... is student in Aachen, Germany (informatics, what means, computer
  98. science) and can be reached as follows:
  99.  
  100. 1. via Semware BBS in conference TSE questions by public mail.
  101. I will receive this mail through a link into the German QEdit support BBS
  102. not very often, appr. once a month.
  103.  
  104. 2. via the german MausNet (Dirk Wißmann @ AC3, daily mail-exchange), but
  105. this is not available outside germany (exc. austria), so you have to use
  106. the internet-address for this location (shown in 4.)
  107.  
  108. 3. via FidoNet:  Dirk Wissmann @ 2:242/5.25 (daily) or
  109.                  Dirk Wissmann @ 2:246/9999.41 (biweekly)
  110. NOTE: GERMAN FIDONET IS BEING CHANGED AT THIS TIME! IT CAN *NOT* BE
  111. GUARANTEED THAT ANY MAIL ADDRESSED AS ABOVE WILL EVER REACH ME UNTIL THE
  112. SITUATION HAS CLEARED UP!
  113.  
  114. 4. via InterNet/UseNet:  dirk @ pool.informatik.rwth-aachen.de
  115.         (During lecture time: monday - friday only,
  116.          during vacation, there exists either a forwarding into MausNet
  117.          or a message that will tell you, when I'll be back.
  118.          PLEASE NO MAILS LARGER THAN 16KB PER DAY DURING VACATIONS.
  119.          IT WOULD BE TOO EXPENSIVE AND I WOULD HAVE TO CUT OFF THE
  120.          LINK INTO MAUSNET. NO COMMERCIAL MAILS ALLOWED!).
  121.  
  122.     MausNet Address via Internet (REMEMBER: MAX. 16KB PER DAY! NO
  123.                                   COMMERCIAL MAILS!)
  124.           dirk_wissmann@ac3.oche.de / dirk_wissmann@ac3.maus.de
  125.           (the first one is a bit quicker).
  126.  
  127. During the months july, august and september, the probability for being
  128. on holiday is a bit higher. So, if an answer from me lasts a bit longer
  129. than expected - don't worry, be happy ;-)
  130.  
  131. Snail Mail:
  132.  
  133. Dirk Wissmann
  134. Pley 39
  135. D-52146 Wuerselen
  136. GERMANY
  137.  
  138. THANKS TO THE FOLLOWING PEOPLE:
  139. ===============================
  140. (the numbers you see here are reference numbers for the section
  141. IMPROVEMENTS DONE SO FAR)
  142.  
  143. (01) David Mayerovitch, who gave me a small but very useful hint, how to
  144.      fix the problem, that the editor always thought, something in the
  145.      file has changed, even if there were no changes at all (caused by
  146.      using system buffers for cutting folds away or pasting them back).
  147.      His E-Mail Address: david.mayerovitch @ canrem.com
  148.  
  149. IMPROVEMENTS DONE SO FAR:
  150. =========================
  151. (Fixes without any reference-number were made by myself)
  152.  
  153. - V1.1:
  154.  
  155.  * fixed the erroneous file status (01)
  156.  * added mQuitFile, mSaveFile, mSaveAndQuitFile, so there normally
  157.    should be no more loss of data, when using the keys attached to these
  158.    functions (ctrl-k/d, ctrl-k/q and ctrl-k/s respectively)
  159.  * added the possibility to deactivate the macro. Before deactivation,
  160.    the macro will open all folds, so that no data will be lost.
  161.  * added keys to open or close all folds with one keystroke. The
  162.    functions already existed, but were not used with keys. They were
  163.    used only when a new file was loaded or a file was saved.
  164.