home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 131.lha / WNote.doc < prev    next >
Text File  |  1986-11-21  |  12KB  |  217 lines
  1. *****************************************************************************
  2. *
  3. *   Program:  WNote V1.0 (C) The Puzzle Factory 1988       Author: Jeff Lavin
  4. *  Function:  Easy creation & editing of FileNotes.       Created: 05/14/88
  5. *                                                     Last UpDate: 05/14/88
  6. *      Use:  1> [run] WNote
  7. *
  8. *        Written entirely in assembly language to be small and fast.
  9. *        Works with expanded memory, including 'sync-ram' at $C00000.
  10. *
  11. *     Raison d'etre
  12. *     -------------
  13. *     FileNotes or comments are extremely useful for all sorts of things.
  14. *     As you collect more Amiga programs, pictures, text files, etc., it
  15. *     becomes difficult to remember just what that particular item was
  16. *     without taking the time to load it and check it out.
  17. *
  18. *     Many bulletin boards use FileNotes as the description you see when
  19. *     you ask for a file directory of listing.  This particular use of
  20. *     FileNotes is the principal reason for this program's existance.  I
  21. *     run an Amiga developer's BBS, and putting comments into all the
  22. *     esoteric source files just got to be too much of a chore, hence
  23. *     WNote (The "W" is short for Window'd... FileNote was already taken).
  24. *
  25. *     This program makes creation, change, and removal of FileNotes a
  26. *     breeze, and with the arp.library to make copying FileNotes and
  27. *     DateStamps automatic, there is no longer any reason not to keep
  28. *     your files organized!
  29. *
  30. *     Instructions
  31. *     ------------
  32. *     1. First of all, WNote must be invoked from the CLI.  I didn't feel
  33. *        there was much need to use this program from WorkBench.
  34. *
  35. *     2. WNote uses HiRes and Lace modes and needs Topaz 11 font.  This
  36. *        font must be in your SYS:font directory.  If not found WNote will
  37. *        use Topaz 8, and the display will not look as intended.  Topaz 11
  38. *        can be found on your 1.2 WorkBench disk.
  39. *
  40. *        If it's not already there, create a subdirectory named "fonts/Topaz"
  41. *        on your system disk, and copy the file named "fonts/Topaz/11" from
  42. *        the 1.2 WorkBench disk to the "Topaz" directory.  Copy the file
  43. *        named "fonts/topaz.font" to your "fonts" directory.
  44. *
  45. *     3. The arp.library, version 34 (REL 2) is used extensively by this
  46. *        program.  If WNote can't find the arp.library, it will complain and
  47. *        exit.  A copy should be available on a bulletin board near you.
  48. *
  49. *        Copy it to your system disk in the "libs" directory.  If this seems
  50. *        like a bother, consider that the arp.library and commands will:
  51. *
  52. *            * Save space on your system disk
  53. *            * Commands will be faster and much more flexible
  54. *            * The CLI will be much easier to use
  55. *            * You will be able to do things that are either difficult
  56. *              or unlikely from the CLI
  57. *            * Many programs will require the arp.library
  58. *
  59. *     4. When you first run WNote, you will see a full size window open on
  60. *        a custom screen.  I have done no color selection, this is just a
  61. *        HiRes, Lace, 2 bitplane screen.  Feel free to adjust the colors
  62. *        any way you like.  Low contrast combinations will tend to reduce
  63. *        flickering to acceptable proportions, but this is a very personal
  64. *        thing - some people are more sensitive to this than others.
  65. *
  66. *     5. There are 3 menu items:
  67. *
  68. *    FILE -  This will bring up the Arp File Requester (thanks to C. Heath).
  69. *            You should immediately see all the files in your current
  70. *            directory.  By using the RIGHT mouse button, you can bring up
  71. *            a list of all the physical and logical devices on your Amiga.
  72. *            Click on the directory you want to list with the LEFT mouse
  73. *            button.  Please remember that for WNote, you are selecting a
  74. *            *directory*, NOT a file!  When you have selected a directory
  75. *            you may click on "OK" immediately, without waiting for the
  76. *            requester to finish displaying files.  If you click on cancel,
  77. *            no change will be made to the current directory or the display.
  78. *
  79. *    ABOUT - This item will display the obligatory shareware notice.  Please
  80. *            take it seriously.
  81. *
  82. *    QUIT -  This selection will free all resources, and exit WNote right
  83. *            now.  No second chance.  This way to the egress.
  84. *
  85. *     6. Assuming you have at this point selected a *directory* and clicked
  86. *        on "OK", you should see a number of files displayed on your screen
  87. *        in this format:
  88. *
  89. *    ---------------------------------------------------------------------
  90. *   |   FileName (22 chars)   | Size | Date |    FileNote (38 chars)      |
  91. *    ---------------------------------------------------------------------
  92. *
  93. *        You may have more of less than a full screen of files.  Please
  94. *        note that no directories are displayed, and that all FileNames are
  95. *        truncated to 22 characters, and FileNotes to 38 characters.  The
  96. *        truncation only affects the display portion in order to show one
  97. *        file per line.  You will be able to enter a full 80 character
  98. *        FileNote.  You cannot use WNote to attach FileNotes to directories.
  99. *
  100. *     7. If you have more files in the selected directory than are able to
  101. *        fit on the screen at one time, you may scroll to the beginning and
  102. *        end of the list by using the up and down arrow keys, respectively.
  103. *        If there are less than a full screen of files listed, the arrow
  104. *        keys will be inoperative.
  105. *
  106. *     8. Select a FileNote to alter by clicking anywhere on that line with
  107. *        the LEFT mouse button.  The line will be hilighted and a string
  108. *        requester will appear in the lower third of the screen.  If there
  109. *        was a FileNote attached to the file, it will be displayed in the
  110. *        string requester.  Clicking anywhere except on a line listing a
  111. *        file will have no affect.
  112. *
  113. *        The string requester has been activated for you, but because of a
  114. *        small undocumented bug in Intuition by the nice folks at C/A, it
  115. *        may not always activate.  If this happens, just click in it before
  116. *        you start typing.
  117. *
  118. *     9. You may now edit the string requester using all the normal Amiga
  119. *        editing functions:  Backspace, delete, R/L-Arrow, ShiftR/L-Arrow,
  120. *        R-Amiga Q or X.  There is an arrow "V" on the string requester
  121. *        indicating where 38 characters end.  Many BBS listings only allow
  122. *        38 or 40 characters.  The arrow points at the 38th character.  You
  123. *        may leave the FileNote unchanged by pressing <return> without
  124. *        altering the text.  You may also remove a FileNote by deleting all
  125. *        the text, and pressing <return>.  In any case, press <return> when
  126. *        you are finished editing the FileNote.  Your new FileNote will be
  127. *        displayed on the screen, and written to the file on disk.  Remember
  128. *        to leave the disk write-enabled.  If WNote cannot write the FileNote
  129. *        to the disk, or fails for any reason, it will call DisplayBeep, and
  130. *        flash the screen or whatever is appropriate.  All requesters, such
  131. *        as "Insert Volume XX..." should appear on the WNote screen.
  132. *
  133. *        On the subject of disk errors, one of 3 situations is possible:
  134. *
  135. *        1. If you have removed the disk being displayed and there is no disk
  136. *           in the drive, you will get a system requester saying, "No disk in
  137. *           drive X".  If you then click on cancel, WNote will beep at you.
  138. *
  139. *        2. If you have write-protected the disk being displayed, you will
  140. *           get a system requester saying, "Volume XX is write protected".
  141. *           If you then click on cancel, WNote will beep at you.
  142. *
  143. *        3. If you have removed the disk being displayed and replaced it with
  144. *           another disk, WNote will beep at you, but you *will not* get a
  145. *           system requester.
  146. *
  147. *        In any case, the filenote will be displayed on the screen as you
  148. *        have altered it, but it *WILL NOT* be written to the disk.  Please
  149. *        remember this.  You may get a fresh screen display by selecting the
  150. *        "file" menu, and immediately clicking "OK" when the requester
  151. *        appears.
  152. *
  153. *    10. Because of the way WNote deals with MouseButton events, the
  154. *        following situation may occur:  You have been using WNote and have
  155. *        pulled down or pushed back the WNote screen to use the CLI, or some
  156. *        other program.  You have now returned to WNote to find that the
  157. *        window is not active, and clicking in the title bar will not
  158. *        activate it.  You also have more than 32 files listed, and there is
  159. *        no blank space under the file names in which to click.
  160. *
  161. *        You may click on a FileName and press <return>.  If you don't want
  162. *        to do that because your friend, who has just left on an extended
  163. *        trip to Outer Mongolia, borrowed the disk that is being displayed,
  164. *        and you are deathly afraid of system requesters, do the following:
  165. *        The bottom 4 lines of the window are not trapped, so you may move
  166. *        the mouse cursor to the extreme bottom edge of the window and click
  167. *        there.
  168. *
  169. *        * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  170. *
  171. *     I hope you enjoy using WNote.  If you like it, please send me $10.
  172. *     If you don't like it enough not to send the $10, don't use it.  It's
  173. *     all between you and your concience.  If shareware ceases to be viable,
  174. *     there won't be any more shareware, and there certainly won't be any
  175. *     public updates to WNote.  'Nuff said.
  176. *
  177. *     If you have any comments or suggestions about the program or the
  178. *     quality of the documentation, I would like to hear them.  Leave a
  179. *     message on the board listed below, or write me a letter via US Snail.
  180. *     If you have problems with WNote, please try to document them as
  181. *     thoroughly as possible, so as to facilitate bug hunting.
  182. *
  183. *                                                              The Author
  184. *
  185. *     >> No warrantee of any kind whatsoever expressed or implied! <<
  186. *
  187. *     This program is shareware, NOT public domain, and is copyrighted
  188. *     by the author.  All rights are reserved.  This program may be freely
  189. *     distributed if the following conditions are observed:
  190. *
  191. *       1. This notice must be distributed intact with the program.
  192. *       2. The following files must be distributed intact with the program.
  193. *
  194. *               WNote            -    Executable
  195. *               WNote.doc        -    Documentation
  196. *
  197. *       3. Only a reasonable distribution fee may be charged, such
  198. *          as by Users' Group PD Libraries.
  199. *       4. Commercial use is prohibited without the author's written
  200. *          consent.
  201. *
  202. *     The assembly source for this program, WNote.asm, may be obtained
  203. *     by sending either a 3 1/2" disk and $10.00, or $15.00 to the address
  204. *     listed in the "About" requester in the program.
  205. *
  206. *       I can be reached at:      The Symposium
  207. *                             Amiga Development BBS
  208. *                        1 Meg Memory - 33 Meg Hard Drive
  209. *                     300/1200, 8-N-1, 24 hr, (503) 935-7883
  210. *                           Another Citadel-68K BBS
  211. *
  212. *     (This BBS is devoted to Amiga software and hardware development, and
  213. *      all users are required to register.  Just follow the instructions.)
  214. *
  215. *                Amiga is a trademark of Commodore-Amiga, Inc.
  216. *****************************************************************************
  217.