home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / fish / disks / d1054.lha / Programs / EdWordDemo / Documents / Features < prev    next >
Encoding:
Text File  |  1994-10-19  |  11.6 KB  |  218 lines
  1.  
  2.                  ===========================================
  3.  
  4.                                              
  5.                                                  
  6.                                                  
  7.                                 
  8.                                     
  9.                                      
  10.                                  
  11.  
  12.                  ========---- Professional V5.0 ----========
  13.  
  14.  
  15.                                    FEATURES
  16.  
  17.  
  18.                               MARTIN REDDY, 1994
  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 5.0 :-
  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 "Auto Completion" facility  to  automatically  complete  the
  44.        current word, based upon  the  contents of the currently loaded
  45.        Keyword Definition File (ALT+SPACE).
  46.      · A "Find Functions" facility to list all functions/procedures in
  47.        a source code file and  allow  the user to jump directly to any
  48.        of these by clicking over its name.
  49.      · An ARexx port  offering an extensive and comprehensive range of
  50.        commands (over 100) to provide full automation of EdWord;  with
  51.        the ability to  enter  these  commands  directly (without using
  52.        ARexx),  as well as run any ARexx script from within the editor
  53.        (documentation for the ARexx commands is not  supplied with the
  54.        demo version)
  55.      · PowerPacker Support:  EdWord  will  (optionally)  decrunch  any
  56.        data files which have been packed with this cruncher
  57.      · A new few feature called  Auto  Suggest  whereby if you type in
  58.        a filename which doesn't exist when loading,  then  EdWord will
  59.        make an intelligent suggestion  as  to  what you actually meant
  60.        to type in by finding the filename which closet matches it!
  61.      · AppWindow Support:  When  running EdWord on a WorkBench screen,
  62.        it is possible to load a file  by simply dragging its icon into
  63.        the editor's window
  64.      · An iconify feature via a Workbench AppIcon  or a zoom gagdet on
  65.        the editor's window (when on the WorkBench screen) and
  66.      · A calculator which lets you perform basic arithmetic as well as
  67.        convert numbers between different bases including decimal,hexa-
  68.        decimal, octal and binary (Separate Program)
  69.      · An auto indenting facility  as  well  as  a  symbolic indenting
  70.        facility  (i.e. EdWord  can  automatically  indent your source
  71.        code as you enter it)
  72.      · Text Casing of language keywords.  i.e. certain keywords can be
  73.        forced into a certain case (UPPERCASE,lowercase or Capitalised)
  74.        Useful to maintain a consistent look to a piece of source code
  75.        (a couple of Keyword Files are provided for this purpose).
  76.      · Access to AmigaDOS to allow the user the ability to run any DOS
  77.        command (This could be  used  to  run  a  compiler or assembler
  78.        through the editor or open a NewShell etc.)
  79.      · The ability to use either the standard EdWord file requester or
  80.        the reqtools.library or asl.library ones
  81.      · An Auto Save facility to  make  EdWord  automatically save your
  82.        document every so often.
  83.      · An ASCII table of printable character codes with the ability to
  84.        insert any such  character  into  the  current text (from ASCII
  85.        code 0 to 255)
  86.      · The ability to sort a block alphabetically - this could be used
  87.        for arranging a list of names, games etc.
  88.      · checks RAM for any viruses or suspicious programs when it first
  89.        loads up and alerts the user if it finds anything strange.
  90.      · Various screen resolutions are supported including PAL and NTSC
  91.        standards,  custom or WorkBench screen and the ability to work
  92.        in interlace mode.
  93.      · Powerful printing options including the setting of margins, the
  94.        page length, the ability to include page numbers and to specify
  95.        the print pitch and quality.
  96.      · Tested under Workbench V2.0 and V3.0.  Requires WB2.0 or higher
  97.        (1 Meg. of RAM minimum is recommended).
  98.  
  99.  
  100.  
  101.  
  102.                               A BRIEF HELPING HAND
  103.                               ~~~~~~~~~~~~~~~~~~~~
  104.  
  105.  Most of the facilities which  EdWord  offers  are  fairly intuitive and need
  106.  little or no explaining (I won't insult your intelligence by telling you how
  107.  to load and save a file!).  However, one  or  two areas require a little bit
  108.  explanation so that you can utilise their full  potential.  (If you register
  109.  with me then you will also get the "EdWordHelp" program which explains every
  110.  aspect of using EdWord in full detail)
  111.  
  112.   1) Text Casing : This facility lets you force certain words into a certain
  113.      case. This is useful for programmers who, for example, may want all the
  114.      keywords in a language to be forced into uppercase and all variables to
  115.      be forced into Capitalised  form.  This  is  done  be reading in a file
  116.      (called a "Keyword Definition File" which lists  all  the keywords of a
  117.      language).  I  have  supplied one or two of these files with this demo.
  118.      Try loading one of these into the Text Casing module  (in the Utilities
  119.      menu) and put the keyword casing on. Keyword Configuration files can be
  120.      recognised by the ".KEY" filename extension.   The following three such
  121.      files have been included with the shareware release :-
  122.  
  123.       · AmigaDOS.key = List of AmigaDOS keywords (e.g. Dir,List,Copy etc.)
  124.       · Pascal.key   = List of ISO Pascal keywords (e.g. WriteLn,Begin,End )
  125.       · C.key        = List of C keywords (e.g. If,While,Int,Struct etc.)
  126.  
  127.      Just click on the "Load" gadget in the Text Casing facility and use the
  128.      file requester to choose your Keyword File. (N.B Delimiters are symbols
  129.      which inhibit the casing operations within a certain range eg comments)
  130.  
  131.   2) Symbolic Indentation : This  facility  will  let you make EdWord indent
  132.      your source code as you type it.  It  is very similar to the "Automatic
  133.      Indentation" feature of  the  Lattice/SAS  C  editor  but  it  is fully
  134.      configurable.  Information  for  this  facility  is  also stored in the
  135.      Keyword Definition file  so  if you load the "C.key" file into the Text
  136.      Casing facility then when you return to the editor,  whenever  you  end
  137.      a line with a "{" symbol EdWord  will  indent  the  next line until you
  138.      end a line with a "}"  symbol  when  EdWord  will  un-indent that line.
  139.      Obviously, if you load  the  "Pascal.key"  file  then  this  works with
  140.      "Begin" and "End" instead of "{" and "}".
  141.  
  142.   3) User Commands : EdWord will let you define 10 user commands.  These are
  143.      just commands which you could type in at the CLI prompt but EdWord will
  144.      let you run them without having to quit the editor.  The "Delay switch"
  145.      can be used to force a wait for a keypress after completing the command
  146.      The "AutoSave" switch can be used to force  EdWord  to save the current
  147.      file before executing the command. The "Async" switch specifies whether
  148.      you want the command to be  run  in  the  background or foreground. The
  149.      actual command string which  you  enter will be executed exactly as you
  150.      enter it with three exceptions :-
  151.  
  152.       · any occurrence of an "*" character will be replaced with the current
  153.         filename when the command is run.
  154.       · any occurrence of an "@" character will be replaced with the current
  155.         filename with no file extensions. e.g. If the filename is "hello.c"
  156.         then the "@" character will be converted to "Hello"
  157.       · any occurrence of a "¶" character (Alt+P), will be replaced with the
  158.         current file's full pathname
  159.       · any occurrence of a "|" character will be converted into a line feed
  160.         so that you can specify multiple commands with the one string.
  161.  
  162.      e.g.  The following Command String will display the name of the current
  163.      file being edited and perform an  AmigaDOS List command to find out the
  164.      size/date etc. of the file.
  165.  
  166.                    ECHO "The current filename is *" | List *
  167.  
  168.  
  169.  Using these facilities you  can  create  custom  environments for just about
  170.  any language. I have used it successfully to make integrated editor/compiler
  171.  environments for AmigaBASIC, DevPac, Lattice C, North C & DICE  with amazing
  172.  ease, effortlessness and speed.
  173.  
  174.  
  175.  
  176.                           ACKNOWLEDGEMENTS AND THANKS
  177.                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  178.  
  179.  I would like to take this opportunity  to  thank some of the people who have
  180.  helped me during the development of  EdWord and have put up with my constant
  181.  ravings about what totally excellent new feature I've added to it.  Firstly,
  182.  to Sandy McNair without whom  EdWord  probably wouldn't exist because it was
  183.  him who challenged me to write  it  in  the  first place and he has given me
  184.  buckets full of help in debugging it.  In the same vein, thanks to a certain
  185.  Graham Lynch for all of his comments along the lines  of  "I bet that EdWord
  186.  doesn't do this ..." which promptly forced me to incorporate it just so that
  187.  I could say "yes".  Thanks  also  to  Keith  Sharp for his invaluable aid in
  188.  finding bugs (which  he  seemed  to  take  great pleasure in doing!) and for
  189.  letting me test the program  on  a  WorkBench 2.0  machine. Thanks to Lesley
  190.  Stronach (I spelt it right this time!) and  Merle  Stevenson  for keeping me
  191.  sane and just for being there.  Thanks  to  my mum for the last twenty years
  192.  and for being totally brill.  Thanks  to  all  the  nice people who actually
  193.  registered for  the  shareware  release  of  EdWord - much appreciated guys.
  194.  (In particular,  many thanks  to  Simon  Dick for all of his help in testing
  195.  EdWord and also for his help  with  AppWindows  and  ARexx  and  his general
  196.  suggestions for improvement.  I've  no  doubt  that EdWord wouldn't offer as
  197.  much power today if it wasn't for his aid).  Thanks to the music of Bon Jovi
  198.  Gun, Sisters of Mercy, U2 and Dire Straits and of course, thanks to Michelle
  199.  Pfeiffer for just being a totally gorgeous and desirable woman.
  200.  
  201.  Finally,  I  would  like to take this opportunity to thank my little band of
  202.  Beta Testers who provided lots  of  helpful criticism & suggestions prior to
  203.  this release of EdWord.  Thanks  to  their  dilligent  efforts, I feel a lot
  204.  more confident about the  stability  and  robustness  of  this package.  The
  205.  Beta Testers for EdWord Professional V5.0 were (in alphabetical order) :
  206.  
  207.     · Andrew Davidson
  208.     · Daniel Feal
  209.     · Jim Beck
  210.     · Magnus Johnson
  211.     · Simon Dick
  212.  
  213.  Cheers,
  214.  
  215.     Martin.
  216.  
  217.  
  218.