home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / txttools / annotate.lha / Annotate.Doc < prev    next >
Text File  |  1992-04-26  |  19KB  |  405 lines
  1. ****************************************************************************
  2. *                                                                          *
  3. *                     USER DOCUMENTATION -- Annotate 1.0                   *
  4. *                                                                          *
  5. * Annotate Version 1.0 program and concept by Doug Bakewell                *              
  6. *                                                                          *
  7. * Annotate Version 1.0 documentation by Kevin Buckham                      *
  8. *                                                                          *
  9. *                                                                          *
  10. ****************************************************************************
  11.  
  12. -WHAT FILES YOU SHOULD HAVE
  13.      Ann - executable
  14.      Annotate.Doc - this file
  15.      Anntools - example tools file for annotate
  16.      Readme - a quick note about Anntools
  17.  
  18.  
  19.                           TABLE OF CONTENTS
  20.                                         
  21. -OVERVIEW
  22.  
  23. -FUNDAMENTALS
  24.  
  25. -SETUP
  26.  
  27. -MENUS
  28.      Project
  29.      Edit
  30.      Search
  31.      View
  32.      Tools
  33.  
  34. -QUESTIONS AND ANSWERS
  35.  
  36. -DISCLAIMER
  37.  
  38.  
  39. _______________________________________________________________________________
  40. _______________________________________________________________________________
  41.  
  42.  
  43.  
  44. -OVERVIEW
  45.  
  46.  
  47.  
  48.      First of all I will give a brief summary of Annotate, and the purpose
  49. for  it's being. Annotate was a concept first dreamt up by Doug while 
  50. finishing his last year of high school.  Annotate was created as an answer 
  51. to a lack of good public domain text editors for programming purposes.  Some 
  52. P.D. text editors existed (and exist) for this purpose, but tend to be 
  53. confusing, and non-intuitive.  So Mr.Bakewell, the crusader he is, attempted 
  54. to put right what once went wrong.  Annotate 1.0, is Doug's first widespread 
  55. release of this text editor, and it seems to have reached his goals and 
  56. expectations.  Annotate has become far more encompassing than the original 
  57. plan, and many new features have been added.  
  58.  
  59.      This text editor has been designed on and Amiga 3000 running 
  60. AmigaDOS 2.04, and is designed to only run in 2.04.  So if you don't yet 
  61. have 2.04, get it!  This program's optimum performance is realized with a 
  62. 3000 and a large virtual screen (however if the screen is too large 
  63. scrolling speed will be sacrificed).  This program will come up on the 
  64. currently ACTIVE PUBLIC SCREEN, but it will not run if the screen is too 
  65. small (less than 640 x 200).  Annotate may be run from the WorkBench by 
  66. merely double clicking the icon or run from the CLI or shell by typing its 
  67. name and an optional file or files to load. ie: ann [file] [file] ...
  68.  
  69.  
  70. -FUNDAMENTALS
  71.  
  72.  
  73.  
  74.      Some of the basic concepts of this text editor are far different than 
  75. regular text editors.  
  76.  
  77.      Firstly, Annotate has a cursor separate from the selection.  For 
  78. instance,one could move the cursor wherever he or she pleases without losing 
  79. the selection.  In fact, if one was to edit the text inside the selection, 
  80. the highlight would resize accordingly.  As this text editor was created 
  81. with  programmers in mind, it has many features useful to programmers.
  82.  
  83.      When editing text in Annotate, one would notice the current status line 
  84. at the bottom.
  85. A typical display would look like:
  86.  
  87. "work:Ann/AnnotateDoc"  Col: 30  Line:   85/   85  Modified Srl Sel
  88.  
  89. On the very left is the current document you are editing. Next is the 
  90. current column and line display, then "Modified".  If Modified is present, 
  91. then the text has been edited since the last save, and will prompt for 
  92. saving changes, if one tries to exit.  "Sel" is used to indicate if there 
  93. is any text currently selected.  This is useful as many menu items act on 
  94. a selection, and not neccesarily the cursor.  Also, any error messages are 
  95. conveyed on this bottom line, temporarily replacing the stats.
  96.  
  97.      A very important part of annotate is it's ScrollStores, these beasties 
  98. are used to save your current position in the document.  It is useful when 
  99. programming, when trying to find the little piece of code within 3000 lines 
  100. or more.  All one has to do, is set a ScrollStore there, and then call that 
  101. same ScrollStore when one wants to return.  There are 6 different ScrollStore 
  102. locations, so up to six positions may be saved.  - Note: ScrollStore merely
  103. identifies line number, not the text, so your text may not be where you left 
  104. it.
  105.  
  106.      One other recently added "feature" is the "shift-TAB".  By holding down 
  107. the shift key and hitting TAB, the cursor will delete the number of 
  108. characters the current TAB is set to.  This is useful for programming when 
  109. one wants to move out one tab space.  **Caution, this will delete characters 
  110. as well as spaces.
  111.  
  112. -SETUP
  113.  
  114.      Under the tools menu, is an item called "Config...".  If Config is 
  115. modified, it creates a file in "s:" called "AnnConfig".  The config item 
  116. will bring up a requestor that will permit the user to define many options. 
  117.  
  118.  
  119.      Another feature is a tools menu.  Any program may be added to this menu 
  120. by merely creating a file in "s:" called "AnnTools".
  121.  
  122. IE:
  123.  
  124. Calculator
  125. run sys:tools/calculator >nil:
  126.  
  127. This "AnnTools" would put the word "Calculator" in the tools menu, and as it 
  128. is the first entry it would become function F1.  When F1 is hit, or the menu 
  129. is selected, the line below the word "Calculator" would be executed.  To add 
  130. a second, merely repeat the pattern of "name" and on the next line the 
  131. "statement" to be executed. 
  132.  
  133.  
  134.  
  135. -MENUS
  136.  
  137.   PROJECT
  138.      
  139.      ABOUT - This item merely give some information on this version of
  140.              Annotate and a brief description. ( And a plea for "gifts".)
  141.      
  142.      NEW - This will start a "new" document in a new window (it will be the
  143.            front one). 
  144.            Quick Key is Right-Amiga-N, (CAPITAL "N" only)
  145.            
  146.      OPEN NEW - This will bring up the AmigaDOS 2.04 requester for opening
  147.                 files and will open the selected one on a new screen 
  148.                 placed in the front. 
  149.                 Quick Key is Right-Amiga-O, (CAPITAL "O" only)
  150.                 
  151.      OPEN - This will bring up the AmigaDOS 2.04 requester for opening
  152.             files and will open the selected one. Careful this is
  153.             destructive, it will replace current document. 
  154.             Quick Key is Right-Amiga-o, (lower "o" only)
  155.      
  156.      SAVE AS - Lets you save the file as a different name, and this will 
  157.                remain the current name. 
  158.                Quick Key is Right-Amiga-s, (lower "s" only)
  159.                
  160.      SAVE - This just saves the file. (As it's current name - rewriting the
  161.             old file if there was one.)  It will prompt for a name if this
  162.             is a "new" document.
  163.             Quick Key is Right-Amiga-S, (CAPITAL "S" only)
  164.             
  165.      LAST SAVED - This will "revert" the text to the last version saved.
  166.                   Caution - destructive!
  167.                   
  168.      DELETE FILE... - This will bring up an AmigaDOS 2.04 requester
  169.                       prompting for which file to delete.  
  170.                       This is obviously DESTRUCTIVE!
  171.                       
  172.      SAVE ALL/QUIT - This option saves all current documents open (like 
  173.                      doing a "SAVE" for each one) and quits the program. 
  174.                      Quick Key is Right-Amiga-Q, (CAPITAL "Q" only)
  175.                      
  176.      QUIT - This option lets the user quit without saving the documents.
  177.             If changes have been made, a requester will pop up asking if
  178.             you wish to really quit.
  179.             Quick Key is Right-Amiga-q, (lower "q" only)
  180.             
  181.   EDIT
  182.           
  183.      CUT - This will allow you to "cut" ( which copies to the clipboard and
  184.            deletes ) to one of six clipboards from the current selection. 
  185.            Quick Key is  Right-Amiga-x, (lower "x" only) for clipboard 0,
  186.            and the Quick Key is Right-Amiga-X, (CAPITAL "X" only) for 
  187.            clipboard 1.                
  188.      
  189.      COPY - This will allow you to "copy" ( which copies to the clipboard )
  190.             to one of six clipboards from the current selection.. Quick Key
  191.             is  Right-Amiga-c, (lower "c" only) for clipboard 0, and the 
  192.             Quick Key is Right-Amiga-C, (CAPITAL "C" only) for clipboard 1.
  193.                 
  194.      PASTE - This will allow you to "paste" ( which prints from the 
  195.              clipboard ) from one of six clipboards to current cursor 
  196.              position. Quick Key is Right-Amiga-v, (lower "v" only) for
  197.              clipboard 0, and the Quick Key is Right-Amiga-V, (CAPITAL "V"
  198.              only) for clipboard 1.
  199.           
  200.      ERASE - This will delete the current selection. Caution - destructive. 
  201.              Quick Key is Right-Amiga-d, (lower "d" only)
  202.                   
  203.      FOLD - This will fold the currently selected lines. 
  204.             Quick Key is Right-Amiga-(   (Yes, a "(" !)
  205.             
  206.      UNFOLD - This will unfold the line the cursor is currently on.
  207.               Quick Key is Right-Amiga-)   (Yes, a ")" !)
  208.               
  209.      UNFOLD ALL - This will unfold all of the folded lines in the current
  210.                   document.
  211.           
  212.      SHIFT RIGHT - This will shift all of the characters in the current 
  213.                    selection right on the assumption that ENTIRE lines are
  214.                    selected.
  215.                    Quick Key is Right-Amiga-]
  216.      
  217.      SHIFT LEFT - This will shift all of the characters in the current
  218.                   selection left on the assumption that ENTIRE lines are
  219.                   selected.
  220.                   Quick Key is Right-Amiga-[
  221.                         
  222.      UPPER CASE - This will shift all of the characters in the current
  223.                   selection to upper case.
  224.                   Quick Key is Right-Amiga-U, (UPPER "U" only)
  225.                        
  226.      LOWER CASE - This will shift all of the characters in the current 
  227.                   selection to lower case.
  228.                   Quick Key is Right-Amiga-u, (lower "u" only)
  229.      
  230.      DUPLICATE LINE - This will take the line the curent cursor is on, and
  231.                       will duplicate it on the next line.
  232.                       Quick Key is Right-Amiga-L, (UPPER "L" only)
  233.                       
  234.      MERGE LINE - Merge line takes the current line the cursor is on and
  235.                   tacks the next line to the end of it. (Try it and you
  236.                   will see what I meen.)
  237.                   Quick Key is Right-Amiga-M, (UPPER "M" only)
  238.                        
  239.      DELETE LINE - This menu item deletes the line the cursor is on.
  240.                    Quick Key is Right-Amiga-D, (UPPER "D" only)
  241.                        
  242.   SEARCH
  243.           
  244.      FIND... - Find produces a "find" requester.  The "string" gadget
  245.                accepts a string of characters to find.
  246.                Quick Key is Right-Amiga-f, (lower "f" only)
  247.                
  248.      FIND NEXT - Uses the string from the original find requester to find
  249.                  the next instance of the string.
  250.                  Quick Key is Right-Amiga-=
  251.                       
  252.      REPLACE - Produces a "replace" requester with several option gadgets.
  253.                The string gadgets accepts strings to search for and replace
  254.                with.  There are cycle type gadgets from search type and
  255.                prompt type.
  256.                Quick Key is Right-Amiga-r, (lower "r" only)  
  257.                
  258.      Sel->Find - Takes the current selection and places it in the "find"
  259.                  requester of Find or Replace.
  260.                  Quick Key is Right-Amiga-F, (UPPER "F" only)
  261.                  
  262.      Sel->Replace - Takes the current selection and places it in the 
  263.                     "replace" requester.
  264.                     Quick Key is Right-Amiga-R, (UPPER "R" only)
  265.      
  266.      Line Number... - Brings up a requester prompting for the line number
  267.                       you wish to go to.
  268.                       Quick Key is Right-Amiga-l, (lower  "l" only)
  269.                       
  270.      Match Brace - This finds the opposite bracket or brace and takes the
  271.                    cursor to it.
  272.                    Quick Key is Right-Amiga-b, (lower "b" only)
  273.                    
  274.      Match Brace/Sel - This finds the opposite bracket or brace and selects
  275.                        everything between the two.
  276.                        Quick Key is Right-Amiga-B, (UPPER "B" only)
  277.                             
  278.      Select All - Simply selects the entire document.
  279.                   Quick Key is Right-Amiga-a, (lower "a")
  280.                             
  281.      Select Line - Selects entire line the cursor is on.
  282.                    Quick Key is Right-Amiga-W, (UPPER "W" only)
  283.                         
  284.      Select Word - Selects the word your cursor is on.
  285.                    Quick Key is Right-Amiga-w, (lower "w" only)
  286.                         
  287.   View
  288.           
  289.      Shrink Ann - Makes Annotate shrink to minimum possible size.
  290.                   Quick Key is Right-Amiga-, , (Yes, ",")
  291.                   
  292.      Enlarge Ann - Makes Annotate grow to a maximum possible size.
  293.                    Quick Key is Right-Amiga-. , (Yes, ".")
  294.                    
  295.      Ann to Front - Takes Annotate's window and pushes it front.
  296.                     Quick Key is Right-Amiga-m, (lower "m")
  297.                     
  298.      Ann to Back - Takes Annotate's window and pushes it to the back.
  299.                    Quick Key is Right-Amiga-n, (lower "n" )
  300.                    
  301.      Go->ScrollStore - (1 - 6) Goes to previously set scrollstore from one
  302.                        to six.
  303.                        Quick Key is Right-Amiga-(1-6), (1,2,3,4,5, or 6)
  304.                             
  305.      Set->ScrollStore - (1 - 6) Sets the "scroll store" to the current
  306.                         location of the cursor.  ( One may call the
  307.                         location back at any time by using the 
  308.                         Go->ScrollStore. )
  309.                         Quick Key is Right-Amiga-(!-^), (UPPER "(1-6)")
  310.                              
  311.      Goto Cursor - Moves your "scroll" or view back to the cursor.  It may
  312.                    not be at the cursor if you have used the Scroll Store.
  313.                    Quick Key is Right-Amiga-g, (lower "g" only)
  314.  
  315.      Goto Selection - Moves your "scroll" or view to the currently selected
  316.                       text.
  317.                       Quick Key is Right-Amiga-G, (UPPER "G" only)
  318.                       
  319.      Scroll/Num - Sets the keypad between scroll movement and typing
  320.                   numbers. Much like a "NumLock" key on an IBehM.
  321.                   Quick Key is Right-Amiga-/, (Yes, a "/")
  322.                   
  323.      Redraw All - This will redraw all of Annotate's current windows.
  324.                   Quick Key is Right-Amiga-e, (lower "e")
  325.                   
  326.   Tools
  327.           
  328.      Config... - This is the item for changing the default configuration of
  329.                  Annotate.  Almost everything here is self explanatory
  330.                  except for a few items.  The "scroll unit" is the number
  331.                  of characters from all sides of the window, where Annotate
  332.                  will decide to scroll if you are in. ( - Note: you may
  333.                  wish to make it quite small, if you are using a small
  334.                  window size.  It will let you to continue to operate with
  335.                  scrolling intact.  The "Window TopEdge" is where you want
  336.                  the top, left edge of Annotate to default to (in pixels
  337.                  from the top, left of your screen).  "Window Width" and 
  338.                  "Height" are also set the default configuration of Ann's
  339.                  window in pixels.  The make .info file switch, determines
  340.                  if icons are created for your text files. (If there is a
  341.                  .info file, there is an icon.)  The make .bak switch sets
  342.                  wether or not the program creates ".bak" backup files, of
  343.                  your current version of the text you are editing.  Auto
  344.                  Indent tells Annotate if it should automatically indent
  345.                  you when you press return to where you indented to on the
  346.                  previous line.  You can also set the default search and
  347.                  prompt type for the various requesters throughout Annotate
  348.                  (ie. Search and Replace requesters).
  349.                       
  350.      -Tool Items - after this menu item, are the tools that may be added.
  351.                    Tools may be added by adding them to the text file 
  352.                    "AnnTools.  Explained previously in the setup section.
  353.                    If they are added correctly, they will be here.
  354.  
  355.  
  356. -QUESTIONS AND ANSWERS
  357.  
  358.      Q.:  Why is my window not scrolling?
  359.      
  360.      A.:  There may be several reasons.  Your window may be too small to 
  361.           scroll, and a message stating this should be printed on the bottom 
  362.           of the window.  You should also check the settings for the scroll 
  363.           unit in the config menu item.
  364.           
  365.      Q.:  After moving my scroll by using Go->ScrollStore, I start typing, 
  366.           but my scroll goes back to it's origanal posinsion.
  367.           
  368.      A.:  Most likely, your cursor is where you left it, and you are typing
  369.           there.  After going to a scroll store, click the cursor at the 
  370.           current position you wish to type.  One of the most common 
  371.           mistakes using Ann is not checking where your cursor is, as it is 
  372.           a completely separate identity from what you are looking at.
  373.           
  374.      Q.: (From Doug) Why is this "doc" file so short?
  375.      
  376.      A.: (By Doug( YES IT IS A RETORICAL QUESTION! )) Well, it could be the 
  377.           fact Kevin just got a girlfreind, or the fact I have to proof read
  378.           this, and have never read anything unless it has pictures.
  379.      
  380.      Q.: (From Doug ) Why did Doug really make Ann?
  381.      
  382.      A.: (By Doug) He's too cheap buy Turbo Text.
  383.      
  384. -DISCLAIMER
  385.  
  386.  
  387.                             DISCLAIMER OF WARRANTY
  388.  
  389.     This software and manual file are offered "as is" and without
  390.     warranties as to performance. Any statments made about the uses of this 
  391.     software do not constitute warranties and shall not be relied on by the 
  392.     user in deciding to use this program.
  393.  
  394.     This program is given without any express or implied warranties
  395.     whatsoever. Because of the diversity of conditions and hardware under
  396.     which this program may be used, no warranty of fitness for a particular
  397.     purpose is offered. The user is advised to test the program thoroughly
  398.     before relying on it. The user must assume the entire risk of using the
  399.     program.
  400.  
  401.  
  402.  
  403.  
  404.                                    =-=-=-=-=-=
  405.