home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / util / edit / edword / features < prev    next >
Encoding:
Text File  |  1993-12-21  |  10.9 KB  |  198 lines
  1.  
  2.                   ===========================================
  3.  
  4.                                               
  5.                                                    
  6.                                                    
  7.                                   
  8.                                       
  9.                                        
  10.                                    
  11.  
  12.                   ===========---- Professional ----==========
  13.  
  14.  
  15.                                     FEATURES
  16.  
  17.  
  18.                                MARTIN REDDY, 1993
  19.  
  20.  
  21.  
  22.  
  23.  EdWord is an extremely powerful, general  purpose text editor which offers a
  24.  host of useful and helpful facilities. It was initially released as a Share-
  25.  ware program,  but since that time it has undergone a myriad of improvements
  26.  and updates resulting in the current version which provides an indispensable
  27.  aid for every Amiga user.  As you might expect, the basic function of EdWord
  28.  is to edit text and in this role,  it  offers all the rudimentary facilities
  29.  which any text editor  might  offer,  but  what  makes  EdWord that bit more 
  30.  special are the extra options which it provides. These have made the program
  31.  quite large in size but, as  any  woman  will  tell you, the old saying that
  32.  size isn't everything is a load of crap. Bigger is better and EdWord has got
  33.  it where it counts!  The  following  is  a  list of some of the more notable
  34.  functions which are supported by version 4.1 :-
  35.  
  36.      · Multiple Documents:  you  can  edit  up to 15 documents at once
  37.        (memory permitting, of course)  with  a  split screen option to
  38.        view two of them together  and  the ability to cut & paste etc.
  39.        between them all.
  40.      · A Macro Facility:  lets  you record any sequence of keypresses/
  41.        mouse clicks and menu selections, and then play them back. This
  42.        is very useful for automating small repetitive jobs.
  43.      · An ARexx port  offering an extensive and comprehensive range of
  44.        commands (over 100) to provide full automation of EdWord;  with
  45.        the ability to  enter  these  commands  directly (without using
  46.        ARexx),  as well as run any ARexx script from within the editor
  47.        (documentation for the ARexx commands is not  supplied with the
  48.        demo version)
  49.      · PowerPacker Support:  EdWord  will  (optionally)  decrunch  any  
  50.        data files which have been packed with this cruncher
  51.      · A new few feature called  Auto  Suggest  whereby if you type in
  52.        a filename which doesn't exist when loading,  then  EdWord will
  53.        make an intelligent suggestion  as  to  what you actually meant
  54.        to type in by finding the filename which closet matches it!
  55.      · AppWindow Support:  When  running EdWord on a WorkBench screen,
  56.        it is possible to load a file  by simply dragging its icon into
  57.        the editor's window (WorkBench 2.0 only)
  58.      · An iconify feature under WorkBench 2.0  via  the zoom gagdet on
  59.        the editor's window (when on the WorkBench screen).
  60.      · A calculator which lets you perform basic arithmetic as well as
  61.        convert numbers between different bases including decimal,hexa-
  62.        decimal, octal and binary
  63.      · An auto indenting facility  as  well  as  a  symbolic indenting
  64.        facility  (i.e. EdWord  can  automatically  indent your source
  65.        code as you enter it)
  66.      · Text Casing of language keywords.  i.e. certain keywords can be
  67.        forced into a certain case (UPPERCASE,lowercase or Capitalised)
  68.        Useful to maintain a consistent look to a piece of source code
  69.        (a couple of Keyword Files are provided for this purpose).
  70.      · Access to AmigaDOS to allow the user the ability to run any DOS
  71.        command (This could be  used  to  run  a  compiler or assembler
  72.        through the editor or open a NewShell etc.)
  73.      · The ability to use either the standard EdWord file requester or
  74.        the arp.library or asl.library ones
  75.      · An Auto Save facility to  make  EdWord  automatically save your
  76.        document every so often.
  77.      · An ASCII table of printable character codes with the ability to
  78.        insert any such  character  into  the  current text (from ASCII
  79.        code 0 to 255)
  80.      · The ability to sort a block alphabetically - this could be used
  81.        for arranging a list of names, games etc.
  82.      · checks RAM for any viruses or suspicious programs when it first
  83.        loads up and alerts the user if it finds anything strange.
  84.      · Various screen resolutions are supported including PAL and NTSC
  85.        standards,  custom or WorkBench screen and the ability to work
  86.        in interlace mode.
  87.      · Powerful printing options including the setting of margins, the
  88.        page length, the ability to include page numbers and to specify
  89.        the print pitch and quality.
  90.      · Tested under V1.2, V1.3, V2.0 and V3.0  of  WorkBench  and will
  91.        work on any Amiga (although 1 Meg of RAM is recommended).
  92.  
  93.  
  94.  
  95.  
  96.                               A BRIEF HELPING HAND
  97.                               ~~~~~~~~~~~~~~~~~~~~
  98.  
  99.  Most of the facilities which  EdWord  offers  are  fairly intuitive and need
  100.  little or no explaining (I won't insult your intelligence by telling you how
  101.  to load and save a file!).  However, one  or  two areas require a little bit 
  102.  explanation so that you can utilise their full  potential.  (If you register
  103.  with me then you will also get the "EdWordHelp" program which explains every 
  104.  aspect of using EdWord in full detail)
  105.  
  106.   1) Text Casing : This facility lets you force certain words into a certain
  107.      case. This is useful for programmers who, for example, may want all the
  108.      keywords in a language to be forced into uppercase and all variables to
  109.      be forced into Capitalised  form.  This  is  done  be reading in a file
  110.      (called a "Keyword Definition File" which lists  all  the keywords of a
  111.      language).  I  have  supplied one or two of these files with this demo.
  112.      Try loading one of these into the Text Casing module  (in the Utilities
  113.      menu) and put the keyword casing on. Keyword Configuration files can be
  114.      recognised by the ".KEY" filename extension.   The following three such 
  115.      files have been included with the shareware release :-
  116.  
  117.       · AmigaDOS.key = List of AmigaDOS keywords (e.g. Dir,List,Copy etc.)
  118.       · Pascal.key   = List of ISO Pascal keywords (e.g. WriteLn,Begin,End )
  119.       · C.key        = List of C keywords (e.g. If,While,Int,Struct etc.)
  120.  
  121.      Just click on the "Load" gadget in the Text Casing facility and use the
  122.      file requester to choose your Keyword File. (N.B Delimiters are symbols
  123.      which inhibit the casing operations within a certain range eg comments)
  124.  
  125.   2) Symbolic Indentation : This  facility  will  let you make EdWord indent 
  126.      your source code as you type it.  It  is very similar to the "Automatic
  127.      Indentation" feature of  the  Lattice/SAS  C  editor  but  it  is fully
  128.      configurable.  Information  for  this  facility  is  also stored in the 
  129.      Keyword Definition file  so  if you load the "C.key" file into the Text
  130.      Casing facility then when you return to the editor,  whenever  you  end
  131.      a line with a "{" symbol EdWord  will  indent  the  next line until you
  132.      end a line with a "}"  symbol  when  EdWord  will  un-indent that line.
  133.      Obviously, if you load  the  "Pascal.key"  file  then  this  works with 
  134.      "Begin" and "End" instead of "{" and "}".
  135.  
  136.   3) User Commands : EdWord will let you define 3 user commands.  These  are
  137.      just commands which you could type in at the CLI prompt but EdWord will
  138.      let you run them without having to quit the editor.  The "Delay switch"
  139.      can be used to force a wait for a keypress after completing the command
  140.      The "AutoSave" switch can be used to force  EdWord  to save the current
  141.      file before executing the command.  The actual command string which you
  142.      enter will be executed exactly as you enter it with three exceptions :-
  143.          
  144.       · any occurrence of an "*" character will be replaced with the current
  145.         filename when the command is run.
  146.       · any occurrence of an "@" character will be replaced with the current
  147.         filename with no file extensions. e.g. If the filename is "hello.c"
  148.         then the "@" character will be converted to "Hello"
  149.       · any occurrence of a "¶" character (Alt+P), will be replaced with the
  150.         current file's full pathname
  151.       · any occurrence of a "|" character will be converted into a line feed
  152.         so that you can specify multiple commands with the one string.
  153.  
  154.      e.g.  The following Command String will display the name of the current
  155.      file being edited and perform an  AmigaDOS List command to find out the
  156.      size/date etc. of the file.
  157.  
  158.                    ECHO "The current filename is *" | List *
  159.  
  160.  
  161.  Using these facilities you  can  create  custom  environments for just about
  162.  any language. I have used it successfully to make integrated editor/compiler
  163.  environments for AmigaBASIC, DevPac, Lattice C, North C & DICE  with amazing
  164.  ease, effortlessness and speed. N.B. In order to run User Commands, you must
  165.  have the AmigaDOS command RUN in your C: directory (This  is  in  ROM if you
  166.  have WorkBench 2.0 or higher anyway so is only relevant to WB1.2 & 1.3)
  167.  
  168.  
  169.  
  170.  
  171.                           ACKNOWLEDGEMENTS AND THANKS
  172.                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  173.  
  174.  I would like to take this opportunity  to  thank some of the people who have
  175.  helped me during the development of  EdWord and have put up with my constant
  176.  ravings about what totally excellent new feature I've added to it.  Firstly,
  177.  to Sandy McNair without whom  EdWord  probably wouldn't exist because it was
  178.  him who challenged me to write  it  in  the  first place and he has given me
  179.  buckets full of help in debugging it.  In the same vein, thanks to a certain
  180.  Graham Lynch for all of his comments along the lines  of  "I bet that EdWord 
  181.  doesn't do this ..." which promptly forced me to incorporate it just so that 
  182.  I could say "yes".  Thanks  also  to  Keith  Sharp for his invaluable aid in 
  183.  finding bugs (which  he  seemed  to  take  great pleasure in doing!) and for 
  184.  letting me test the program  on  a  WorkBench 2.0  machine. Thanks to Lesley 
  185.  Stronach (I spelt it right this time!) and  Merle  Stevenson  for keeping me
  186.  sane and just for being there.  Thanks  to  my mum for the last twenty years
  187.  and for being totally brill.  Thanks  to  all  the  nice people who actually
  188.  registered for  the  shareware  release  of  EdWord - much appreciated guys. 
  189.  (In particular,  many thanks  to  Simon  Dick for all of his help in testing
  190.  EdWord and also for his help  with  AppWindows  and  ARexx  and  his general 
  191.  suggestions for improvement.  I've  no  doubt  that EdWord wouldn't offer as
  192.  much power today if it wasn't for his aid).  Thanks to the music of Bon Jovi
  193.  Gun, Sisters of Mercy, U2 and Dire Straits  and finally,  thanks to Michelle 
  194.  Pfeiffer just for being a totally gorgeous and desirable woman.
  195.  
  196.  
  197.  
  198.