home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / cookedit / cookedit.doc next >
Text File  |  1989-11-05  |  4KB  |  113 lines
  1. The Cookie Editor                                 11/2/89
  2.  
  3.  
  4.      Cookie n,: any of various small sweet flat or slightly raised cakes.
  5.                                         -- Webster's Dictionary
  6.                                         
  7.      Cookie n,: A short humorous saying or anecdote.
  8.                                         -- Any computer user
  9.                                         
  10.      This program was designed to allow all those out there using a 'Cookie'
  11. or 'Fortune' program to add to or edit their exsisting 'Cookie' files
  12. without having to resort to dragging out their text editors manuals to
  13. figure out how to embed control characters in their text. Also, when run
  14. as a Door application on a BBS to allow your users to add their 
  15. little flashes of wit to your 'Cookie' file. The Cookie Editor also
  16. will allow you to delete cookies your users may have left that are in
  17. poor or questionable taste:-)
  18.  
  19. Using the Cookie Editor:
  20.  
  21. When you first run The Cookie Editor only two commands are operational:
  22.  
  23. O - Open a Cookie File and Q- Quit the editor.
  24.  
  25. Pressing 'O' allows you to specify what file to start editing. Note that
  26. since The Cookie Editor was designed to also function as a door the
  27. GEM File Selector is NOT used for any file operations.
  28.  
  29. Pressing 'Q' will exit the program.
  30.  
  31. Once you have opened a file several other commands become active:
  32.  
  33. N - Show Next Cookie In Current File
  34.  
  35. B - Go Back One Cookie
  36.  
  37. D - Delete The Current Cookie Being Displayed
  38.  
  39. E - Edit Current Cookie Being Displayed
  40.  
  41. A - Add A Cookie To The Current File
  42.  
  43. When you select 'E' you are placed in the Editor where the following commands
  44. are allowed:
  45.  
  46. Command     Meaning    Action
  47.   a         append     Add additional text
  48.   l         list       List Cookie with line numbers
  49.   s         save       Save Cookie and exit editor
  50.   d         delete     Delete a line
  51.   r         replace    Replace part of an exsisting line
  52.   q         quit       Quit Editing Do NOT change Cookie
  53.   
  54. Append: Appends text to the end of the Cookie or if a line number is 
  55. specified, i.e. a4 the test is added after line 4 of the current cookie.
  56.  
  57. List:  List current cookie with line numbers.
  58.  
  59. Save: Save the current cookie and exit editor.
  60.  
  61. Delete: Delete a line. If you do not specify a line number you will be asked
  62. for one.
  63.  
  64. Replace: Replace a part of an exsisting line. If you do not specify a line
  65. number you will be asked for one.
  66.  
  67. Quit: Quit the editor and throw away all changes.
  68.  
  69. When you specify 'A' from the main menu you are placed in the editor in
  70. Append mode to enter your new cookie.
  71.  
  72.                   Running The Cookie Editor as a door:
  73.                   
  74. The Cookie Editor when it runs looks for a carrier present at the RS232
  75. port. If it finds one, it assume it is being run as a door. As a door
  76. the only commands operational are:
  77.  
  78.   n         next       Show next Cookie
  79.  
  80.   b         back       Show prior Cookie
  81.  
  82.   a         add        Add a Cookie
  83.  
  84.   q         quit       Quit 
  85.   
  86. Since Open and Close file are not available from remote you will need to
  87. tell The Cookie Editor the name of the cookie file to edit on the 
  88. commandline. To do this STadel you can define a line in your CTDLDOOR.SYS
  89. file like so:
  90.  
  91.      cookedit u g:\stadel\editor.tos cookie.dat
  92.           |   |         |                |
  93.           |   |         |            Name of Cookie File To Edit
  94.           |   |     Name Of Cookie Editor And The Dir It Lives In
  95.           | Anyone May Use This Door
  96.        Name Of Door
  97.        
  98. This way you could let your users edit on a copy of your cookie.dat file
  99. and check their additions before releasing them for general use.
  100.  
  101. The Cookie Editor is also 'Carrier Smart' in that if the remote user
  102. drops Carrier it will exit back to the calling BBS.  
  103.  
  104.                     The Cookie Algorithm
  105.                     
  106. Basically, a Cookie file is a collection of sayings seperated by CONTROL-L.
  107. When a Cookie program is run it generates a random number and seeks
  108. forward until it finds a CONTROL-L. The Cookie program then displays the
  109. text until it encounters another CONTROL-L. Notice that using this method
  110. that the first Cookie in the file is never used, but is just a filler.
  111.  
  112.  
  113.