home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 63 / af063sub.adf / NoteIt! / NoteIt!.doc < prev    next >
Text File  |  1994-07-13  |  12KB  |  355 lines
  1. ____________________________________________________________________
  2.        
  3.                              NoteIt!
  4.  
  5.                            Version 1.4 
  6.                              _______ 
  7.  
  8.                         by Ryan J. Bruner
  9.  
  10.                           December, 1993
  11. ____________________________________________________________________
  12.  
  13. Welcome to NoteIt!, a Post-It style notepad program for the 
  14. Commodore Amiga.  Requires Workbench 2.0 or greater.
  15.  
  16.    I.   Why did I write it?
  17.    
  18.    II.  What does it do?
  19.    
  20.    III. What is to come?
  21.   
  22.    IV.  Who to contact?
  23.    
  24.    V.   Acknowledgements
  25.  
  26.  
  27. I.  Why did I write it?
  28. _______________________
  29.  
  30. I have always felt that the Amiga needed a Post-It© style notepad.
  31. Apparently, due to responses from NoteIt! users, others have also
  32. felt it is a need as well.  So, needless to say, I wrote one for 
  33. myself.  Admittedly, I haven't needed such a program very often for
  34. myself.  I originally started this project to teach myself more about
  35. programming for Amiga intuition.  I've had so much fun with it, plus
  36. enough of responses to deem continue improving it.
  37.  
  38.  
  39. Note:  I cannot be responsible for any system crashes caused
  40.        by this program.  :-)  I just hope they don't happen!
  41.        I have tried to thoroughly test this.
  42.  
  43.  
  44. II. What does it do?
  45. ____________________
  46.  
  47. NoteIt!'s features include multiple page editing, window minimizing,
  48. auto-save of notes, font-sensitivity, and custom size and location of
  49. the window.
  50.  
  51. NoteIt! version 1.4 provides several new features.  Graphical
  52. buttons, font-specification through a font requester, auto-minimizing
  53. window, and the ability to paste from the system clipboard are some
  54. of the new features.
  55.  
  56.  
  57.   A.  Startup
  58.   
  59.   B.  Tooltypes
  60.  
  61.   C.  Using NoteIt!
  62.   
  63.   D.  Configuration
  64.  
  65.  
  66. A.  Startup
  67. ___________
  68.  
  69. NoteIt! requires at least Workbench 2.0 to run.  NoteIt! can be
  70. started by either the CLI, or from the Workbench.  Several parameters
  71. are supported to configure NoteIt!.  These parameters are the same
  72. for the CLI as for the Workbench Tooltypes.
  73.  
  74.  
  75. B.  Tooltypes
  76. _____________
  77.  
  78. The following Tooltypes can either be used as a CLI parameter, or
  79. as a Tooltype set through NoteIt!'s icon information.  It is important
  80. to note that Tooltypes override any of the saved configuration
  81. information.
  82.  
  83. The Tooltypes are as follows:
  84.  
  85. TOP            You can specify the where the top of the NoteIt! window
  86.                will open using this Tooltype.  For example, to open
  87.                the window 100 pixels from the top of the screen, use
  88.                "TOP=100".  The default position is 20.
  89.  
  90. LEFT           Similar to TOP, except you can specify where the left
  91.                edge of the window will open.  Default position is 20.
  92.  
  93. WIDTH          Using WIDTH tells NoteIt! how many pixels across the 
  94.                window should be.  For example, to to have a window
  95.                300 pixels across, use "WIDTH=300".
  96.                Default is 100.
  97.  
  98. HEIGHT         Similar to WIDTH, except you can specify the number of
  99.                pixels up and down that can be displayed.  If you specify
  100.                fewer than the default, then NoteIt! will use the default.
  101.                Actual default varies with font size..
  102.  
  103. PUBSCREEN      You can specify which Public screen NoteIt! will open 
  104.                on with this Tooltype.  If the Public screen does not
  105.                exist, then it will default to the Workbench.
  106.  
  107. CONFIGFILE     This is the file and pathname of where to save the 
  108.                configuration file.  The default path is the directory
  109.                where NoteIt! was started from.
  110.  
  111. NOTEFILE       This is the file and pathname of where to save the note
  112.                file.  The default path is the program directory of
  113.                NoteIt!.
  114.                
  115. *** Important ***
  116. Previously the default note file path was found in ENVARC:noteit.notes.
  117. This is no longer the case.  The current default location for the
  118. notes is now PROGDIR:noteit.notes.  If you require to read the old 
  119. notefile, either set the NOTEFILE ToolType, or else copy the notefile
  120. from the ENVARC: directory to the program directory.
  121.  
  122.  
  123. Example of use:
  124.  
  125. To open NoteIt! with a top edge at 100, and left edge at 100 from the
  126. CLI, you would enter:
  127.  
  128.                NoteIt! TOP=100 LEFT=100
  129.                
  130.          
  131. C. Using NoteIt!
  132. ________________
  133.  
  134. Once NoteIt! is open, you can simply start typing text.  NoteIt! 
  135. automatically word-wraps text, so there is no need to use the return
  136. key for each paragraph.  Because of this, NoteIt! also knows when you
  137. start a new paragraph with the return key so that if you change the
  138. size of the window, the text will not wrap awkwardly.
  139.  
  140. NoteIt! supports multiple pages in the window, allowing you to leave 
  141. yourself several messages with only one NoteIt! program running.  
  142. Therefore, NoteIt! will only allow you to run one at a time.  This is 
  143. necessary since having more than one running could erase the notes in 
  144. the note file with the notes of another.  See below for more on the 
  145. note files. The multiple pages can be controlled either by the window
  146. gadgets, or through the menus.
  147.  
  148.   C.1  Menus
  149.  
  150.   C.2  Gadgets
  151.   
  152.   C.3  Saving
  153.   
  154.  
  155. C.1  Menus
  156. __________
  157.  
  158. Project menu:
  159.  
  160.    About NoteIt!...
  161.     I'm sure you can figure out what it does!  :-)
  162.  
  163.    Minimize                                    Shortcut:  Amiga-M
  164.     Choosing this item, or clicking on the size gadget of the
  165.     window will minimize the window to the size of the title bar.
  166.     All functions are disabled except for the system gadgets
  167.     this way.  Click on the size gadget to return to the 
  168.     previous size and location.  
  169.  
  170.    Quit                                        Shortcut:  Amiga-Q
  171.     This will quit out of NoteIt!, saving any remaining notes.  
  172.     (see section about saving notes below).  Using the Close
  173.     gadget will perform the same function.
  174.  
  175. Edit menu:
  176.  
  177.    Paste                                       Shortcut:  Amiga-V
  178.     This will paste any text that is in the system clipboard to
  179.     the current page.
  180.  
  181. Page menu:
  182.  
  183.    Add Page                                    Shortcut:  Amiga-A
  184.     Choosing "add page" will create a new empty page to type
  185.     into.
  186.            
  187.    Delete Page                                 Shortcut:  Amiga-D
  188.     Choosing "delete page" will delete the current page, and
  189.     advance to the next page.  If the current page is the only
  190.     page, then a requester will say you can't delete that page.
  191.  
  192.    Next Page                                   Shortcut:  Amiga-N
  193.     Choosing "next page" will advance to the next page, if 
  194.     one exists.
  195.  
  196.    Prev Page                                   Shortcut:  Amiga-P
  197.     Choosing "prev page" will move back to the previous page,
  198.     if one exists.
  199.  
  200. Settings menu:
  201.  
  202.    Font...                                     Shortcut:  Amiga-F
  203.     Opens a font requester which allows you to select any 
  204.     non-proportional font.  The font requester also allows you
  205.     to choose a font color, as well as background color.  The
  206.     background color is the color of the page.
  207.     Default font is Topaz 8.
  208.    
  209.    Autominimize                                Shortcut:  Amiga-Z
  210.     When set, this will cause the NoteIt! window to automatically
  211.     minimize when the window is not selected.  If you want it to
  212.     return to full size, then click on the Zoom gadget in the
  213.     upper right-hand corner of the window.
  214.     Default is off.
  215.    
  216.    Small to start                              Shortcut:  Amiga-S
  217.     If this item is selected, then the next time you start up
  218.     NoteIt!, it will automatically shrink down to a small size.
  219.     You must save the settings for this item to take affect for
  220.     the next time you start NoteIt!.
  221.     Default is off.
  222.     
  223.    Button Bar                                  Shortcut:  Amiga-B
  224.     When this item is selected, the navigation buttons will appear
  225.     in the NoteIt! window.  If it is not selected, then no buttons
  226.     will appear.
  227.     Default is on.
  228.     
  229.    Save settings
  230.     Saves the font and page color settings into the configuration
  231.     file.
  232.  
  233.  
  234. C.2 Gadgets
  235. ___________
  236.  
  237. There are four gadgets in the NoteIt! window, provided that you have
  238. the button bar turned on.
  239.  
  240.    Add Page is represented by a graphic of a page.  
  241.  
  242.    Delete Page has a crossed-out page.
  243.    
  244.    Previous Page is an arrow pointing to the left.
  245.    
  246.    Next page is represented by an arrows pointing to the right.
  247.  
  248. Each of the page functions match the respective menu items under the 
  249. Page menu.
  250.  
  251. You can also minimize the window to just the title bar by clicking on 
  252. the Zoom Gadget.  While the window is minimized to only a title bar, 
  253. menu functions, as well as keyboard input is disabled.  Just click
  254. the Zoom Gadget again to restore the window back to its original size
  255. and location.  
  256.  
  257.  
  258. C.3 Saving
  259. __________
  260.  
  261. NoteIt! also will save your notes between power cycles.  All notes
  262. will be stored in a file, found either in the program directory when
  263. NoteIt! is located, or the file specified by the NOTEFILE tooltype.  
  264. Every time NoteIt! is run, if a note file exists, it will read the 
  265. file and display the first one in the window.  Use Next Page, or 
  266. Previous Page to view any other notes.  
  267.  
  268. NoteIt! also saves the notes after approximately 10 seconds of
  269. inactivity, or if the NoteIt! window becomes inactive by selecting
  270. another window.  Leaving NoteIt! running until shutting power off 
  271. will not lose messages unless you shut off the power prior to the 
  272. 10 second time period.  Once you close the NoteIt! window, either 
  273. through the close gadget, or through the menu item "Quit", it will 
  274. save any messages.
  275.  
  276.  
  277. D.  Configuration
  278. _________________
  279.  
  280. Configuring NoteIt! can occur through the use of Tooltypes and the
  281. Settings menu.  Options for fonts, autominimizing, starting NoteIt!
  282. in minimized form, and having the button bar all are set using
  283. the menus.  Size and position of window, public screen, and the
  284. filenames for the configuration and notefiles are all set using
  285. Tooltypes.  
  286.  
  287. Once these configuration items are set, they can be saved using the
  288. Save Settings... item from the Settings menu.  Note that the Tooltypes
  289. will override anything you have saved in the configuration file.
  290.  
  291. The size and position of the window will be saved when you save 
  292. settings.  Simply position the window anywhere on the screen prior
  293. to saving the settings will then cause that position to be saved.
  294.  
  295. If you wish to not use the Tooltypes in the icon, but as CLI 
  296. parameters only once, then you may do so, and then save the settings.
  297. From then on, the window will open in the same location.
  298.  
  299.  
  300. III. What is to come?
  301. _____________________
  302.  
  303. I do plan to continue working on NoteIt! at least until this summer.
  304. While I have a list of features I would like to add, I do not
  305. guarantee that any of them will appear.
  306.  
  307. My current plans for future versions include:
  308.  
  309.   o  Ultimately replacing all TOOLTYPES with a configuration 
  310.      window within the program.
  311.   o  Support for the copying to the system clipboard
  312.   o  The ability to scroll the text in a window without using the 
  313.      keyboard.
  314.   o  Ability to insert cursor with mouse.
  315.   o  ARexx port.
  316.   
  317. Any other suggestions are greatly appreciated.
  318.  
  319.  
  320. IV. Who to contact?
  321. ___________________
  322.  
  323. I can be contacted through electronic mail at the following address:
  324.  
  325.    rbruner@engin.umich.edu
  326.   
  327. or through snail mail at:
  328.  
  329.    Ryan J. Bruner
  330.    3075 Whisperwood Dr.
  331.    Apt. 448
  332.    Ann Arbor, MI  48105
  333.    USA
  334.   
  335.  
  336. V. Acknowledgements
  337. ___________________
  338.  
  339. I first would like to thank Christopher Wolf, a.k.a. cwolf on the IRC
  340. (chris@alchemy.tn.cornell.edu), for the ParseParameters function so I
  341. could support Tooltypes.
  342.  
  343. Thanks to my beta testers, Xed, Dense, JanusMan, Timmer, colins, and
  344. DrDemento, all from the IRC.
  345.  
  346. I would also like to thank Martyn Knapton, a.k.a. B-Trayor on the IRC, 
  347. for the NoteIt! icon.  He designed several, but I could only use the
  348. smallest version until I find a way to use larger images in IconEdit.
  349.  
  350. I would like to thank all the guys on #amiga for all the assistance 
  351. they have provided while programming this.
  352.  
  353. Thanks, especially, to my Lord and Saviour, Jesus Christ!  God bless
  354. us all!
  355.