home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 1775.dms / in.adf / EdWord / EdWord.DOC < prev    next >
Encoding:
Text File  |  1992-03-15  |  17.8 KB  |  359 lines

  1.  
  2.                   ===========================================
  3.  
  4.                                               
  5.                                                   
  6.                                                   
  7.                                  
  8.                                      
  9.                                       
  10.                                   
  11.  
  12.                   ===========---- Version 2.2 ----===========
  13.  
  14.  
  15.                            THE SHAREWARE TEXT EDITOR
  16.  
  17.  
  18.                                MARTIN REDDY, 1992
  19.  
  20.  
  21.  
  22.  
  23.                                 WHAT IS EDWORD?
  24.                                 ~~~~~~~~~~~~~~~
  25.  
  26.   EdWord V2.2 was written  by  Martin Reddy, 1989-92.  It  was  designed as a
  27.  programmer's  text  editor but it  also  offers  many  numerous and powerful
  28.  functions that could be of use to absolutely anyone. It is moulded around an
  29.  extremely  user-friendly and  aesthetically pleasing environment in order to
  30.  make it easier  to  use  for  the  general  novice  as  well as the hardened
  31.  professional.
  32.  
  33.   EdWord has taken over two and a half years to develop. My initial aims were
  34.  to design an editor which could be used to create a powerful  yet simple aid
  35.  to a programmer by giving him  the  power  of  an integrated editor/compiler
  36.  environment which could be  used  for any  language (or even as a substitute
  37.  for a poorer environment).  Although, as time wore on, I added so many extra
  38.  functions and options that  it  has  grown into a formidable general purpose
  39.  text editor as well.
  40.  
  41.  
  42.  
  43.                               WHAT CAN EDWORD DO?
  44.                               ~~~~~~~~~~~~~~~~~~~
  45.  
  46.   EdWord supports all the  necessary  functions that would be expected of any
  47.  decent text editor these include :-"
  48.  
  49.  
  50.    · File Operations (including Load,Save,Save As,Delete & Rename)
  51.    · Block Operations (including Cut,Copy,Insert,Erase,Load,Save & Print)
  52.    · Search Operations (with options for specifying the direction, case
  53.      dependency and replace text)
  54.    · Jump to Line function to go directly to a specified line number
  55.    · Line operations such as Delete Line, Undelete Line, Delete to EOLn
  56.    · An Undo function to abort any changes made to a line in case you modify
  57.      something by mistake
  58.  
  59.  
  60.  
  61.                   WHAT FACILITIES DOES IT OFFER A PROGRAMMER?
  62.                   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63.  
  64.   EdWord also supports a  number  of  specialised functions which would be of
  65.  use to almost every programmer. Some of these are :-"
  66.  
  67.  
  68.    · An auto indenting facility
  69.    · Casing of language keywords (e.g. keywords are forced into uppercase)
  70.    · Access to AmigaDOS to allow the user the ability to run any DOS command
  71.      (This could be used to run a compiler or assembler through the editor)
  72.    · An ASCII table of all printable character codes with the ability to
  73.      insert any such character into the current text
  74.    · A number base converter to convert numbers  into and from either binary
  75.      octal,decimal or hexadecimal
  76.    · The ability to specify  a  filename  pattern  for the file requester so
  77.      that only certain files are shown  e.g. show only ".C" or ".GFA" files
  78.  
  79.  
  80.  
  81.                        SO WHAT'S SO SPECIAL ABOUT EDWORD?
  82.                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  83.  
  84.   In addition to these  operations, EdWord  has several other functions which
  85.  are more unique and would  normally  only  be  found  on quite highly priced 
  86.  commercial programs. 
  87.  
  88.  
  89.    · The ability to  modify  the  protection  bits (HSPARWED) on any file or
  90.      directory
  91.    · A statistical display of the systems current state including free chip,
  92.      fast,total memory; the disk label; physical disk size; disk free space;
  93.      disk protection etc.
  94.    · A constant display on the status  bar of the ASCII value of the current
  95.      character - useful for  working  out  the  ASCII value of non-printable
  96.      characters.
  97.    · A preferences module which allows  the user to set the screen colours &
  98.      various other options, and to save these in a configuration file
  99.    · The ability to  define  the  F-Keys  to  insert  a piece of text at the
  100.      cursor position 
  101.    · The ability to sort a block alphabetically. Could be used for arranging
  102.      a list of names, games etc.
  103.    · A word count and an occurence count facility
  104.    · Various screen resolutions including PAL and NTSC standards,  custom or
  105.      WorkBench screen and the ability to work in interlace mode.
  106.    · You may also use any  standard  Amiga 8x8  font  instead of the default
  107.      Topaz80 if you desire.
  108.    · A "point-and-click" status  line which allows you to access some of the
  109.      editor facilities directly.
  110.    · The ability to enter any character into the text from ASCII value 0-255
  111.      by depressing the Left-Amiga key and entering the decimal code.
  112.    · Finally, EdWord will also  check  RAM  for  any  viruses  when it first
  113.      starts up and warn the user of any suspicious looking programs!
  114.  
  115.  
  116.  
  117.                          SO WHAT DOES EDWORD -NOT- DO?
  118.                          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  119.  
  120.   EdWord is NOT a word processor - It is a text editor. This means is that it
  121.  does not format your text in such ways as setting margins, typestyles (bold,
  122.  italic ...), page numbers  or  sizes etc.  If  these are  functions that you
  123.  desire, then this is not the program for you.
  124.  
  125.   EdWord does  NOT  use any special embedded commands for its display - every
  126.  byte in a file is displayed ( except for the tab character which is expanded
  127.  into spaces). This means that it can be used to view or edit non-ASCII files
  128.  as well as plain vanilla texts.
  129.  
  130.   EdWord will NOT make any annoying little beeps or try to ruin your eyesight
  131.  by flashing the  screen  whenever  you  press the wrong key - I'm sorry, but
  132.  you'll have to learn to live without such luxuries !@?*!
  133.  
  134.   EdWord will  NOT  force you  to  use a particular  keymap - It will use the
  135.  current keymap ( as set by the SetMap command ) This is because most editors
  136.  have been written in America and they  force you  to use the American keymap
  137.  which can be kind of annoying if you've not got an American keyboard!
  138.  
  139.  
  140.  
  141.                        THE "TOTALLY EXCELLENT" BIT, DUDE!
  142.                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  143.  
  144.  Sounds good so far eh? All that for the price of a disk. Wow not bad, matey!
  145.  However, EdWord is a shareware program.  This  means  that if you use it and
  146.  enjoy  it ( or even if you use and don't enjoy it, I suppose ) then  I'd  be
  147.  awfully grateful if you would send me some dosh so that I can afford my next
  148.  bottle of Irn Bru.  It  doesn't  have to be much - a fiver is all that I ask
  149.  of you. So that's only a few pints that you have to sacrifice. Sounds a hell
  150.  of a lot better than slamming out just under £100.00 for a decent commercial
  151.  text editor if you ask me! 
  152.  
  153.   "So where do I send this money to?" I hear you crying out in an uncontroll-
  154.  able fit of enthusiasm.  Well, the address is as follows.  Even if you don't
  155.  want to register,  you can still write to me to offer suggestions for future 
  156.  versions of the software or to report any bugs in the program (none known at
  157.  this time) ...
  158.   
  159.                          ____________________________
  160.                         |                            |
  161.                         |      Martin Reddy,         |
  162.                         |      Lossiemouth House,    |
  163.                         |      33 Clifton Road,      |
  164.                         |      LOSSIEMOUTH,          |
  165.                         |      Moray,                |
  166.                         |      Scotland,             |
  167.                         |      IV31 6DP.             |
  168.                         |____________________________|
  169.                           
  170.  
  171.  
  172.  
  173.                 SO WHY SHOULD I PART WITH MY NICE LITTLE £5.00?
  174.                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  175.  
  176.   Okay, lets not be naive - why should you bother to send me a fiver when you
  177.  already have  the  best  text  editor under the sun for the price of a disk?
  178.  
  179.   Right, here comes the sales pitch ... There are 3 damn good reasons why you 
  180.  should send me some money  ( by the way a fiver was merely a suggestion - If
  181.  you have any surplus thousand pound notes  floating around which are getting
  182.  in your way then I'll gladly take them! - In the words of Frankie Howard ...
  183.  "Money is a burden, my brother. Let me relieve you of that burden"). Anyway,
  184.  back to the three reasons ...
  185.  
  186.         a) You will make me a very happy chappy  and as a result, your life
  187.            will take on new meaning and depth.
  188.  
  189.         b) You will instantly be marked up to go to heaven when you die and
  190.            spend the  rest  of  eternity  with  Michelle  Pfeiffer  as your
  191.            personal slave at your constant beck and call.
  192.  
  193.         c) (Getting a bit more serious now) I will send you the latest copy 
  194.            of EdWord along with an on-line help program which provides full
  195.            documentation for the program. I will also send you the complete
  196.            source code listing for the program  (written in GFA-BASIC V3.0)
  197.            so that you can doodle around with it and customise it yourself.
  198.            I will also send you all the support files for EdWord and one or
  199.            two other little goodies which I have been working on recently.
  200.  
  201.  
  202.  
  203.              HEY, WHAT'S ALL THIS ABOUT "LATEST VERSION" OF EDWORD?
  204.              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  205.  
  206.  The version of EdWord which has been released as Shareware (Version 2.2)  is
  207.  fully operational and has NO silly constraints like  you can't save or print
  208.  things. However, since completing the shareware version, I have dramatically
  209.  improved EdWord.  The whole program is now much more elegant and  robust and
  210.  many new features  have been added to it  with the prospect of more to come!
  211.  If you register with me,  then the copy of EdWord which I will send you will
  212.  have all of the latest improvements which I have incorporated.  At  present,
  213.  these include ...
  214.  
  215.  
  216.   · The Shareware notice in the About menu has been removed.
  217.   · Workbench 2.0 gadgets are now used (even on 1.2/1.3 machines)
  218.   · The Preference window has been split into two new windows (preferences
  219.     & colours) which offer more powerful facilities over config files (you 
  220.     can now load/save config files and specify where to put them) and you
  221.     can control which pen colours are used for the windows and which
  222.     direction the shadows on gadgets and boxes fall.
  223.   · The Word Count facility is more accurate and approx. 6000% faster !!!
  224.   · Uppercase/Lowercase word now automatically moves onto next word after 
  225.     the operation has been performed
  226.   · Added a "Match Brackets" option to the Search menu
  227.   · Vertical Block more friendly :- Cut/Erase No longer trash display on big
  228.     blocks and Insert will now insert past the End Of File.
  229.   · Added a "Show Line Feeds" switch to the preferences window.
  230.   · Text Casing routines speed up by around 40-50%
  231.   · The Proportional Slider Gadget now displays the document as it is moved
  232.   · Added a "Centre Line" option to the Edit menu
  233.   · Added a "Tabs to Space" option to the Tools menu to convert all tabs in
  234.     a document into the equivalent space characters. Also added a Tab->Space
  235.     switch to the preferences window to force spaces to be directly entered 
  236.     whenever a tab key is pressed.
  237.   · Included the ability to specify device name for the printer (i.e PRT:)
  238.   · String Gadget operation has been improved and now acts a lot more like
  239.     the intuition one.
  240.   · The printing options have been drastically improved - it is now possible
  241.     to specify left and right margins; the page length; page numbers; manual
  242.     feed etc. (checks are also made to ensure that the printer is on-line. 
  243.  
  244.  
  245.  
  246.   Well, their you have it - The  final decision rests with you, but you would
  247.  not  regret registering for this  latest  version - it is vastly superior to
  248.  the shareware release in all respects.
  249.  
  250.  
  251.                              A BRIEF HELPING HAND
  252.                              ~~~~~~~~~~~~~~~~~~~~
  253.  
  254.   Most of the facilities which  EdWord  offers  are fairly intuitive and need
  255.  little or no explaining (I won't insult your intelligence by telling you how
  256.  to load and save a file!).  However, one  or  two areas require a little bit 
  257.  explanation so that you can utilise their full potential.  ( If you register
  258.  with me then you will also get the "EdWordHelp" program which explains every 
  259.  aspect of using EdWord in full detail)
  260.  
  261.   1) Text Casing : This facility lets you force certain words into a certain
  262.      case. This is useful for programmers who, for example, may want all the
  263.      keywords in a language to be forced into uppercase and all variables to
  264.      be forced into Capitalised  form.  This  is  done  be reading in a file
  265.      (called a "Keyword Definition File" which lists  all  the keywords of a
  266.      language).  I have supplied on or two of these files with the shareware
  267.      release (you get more of them if you register - only £5.00, did I say?)
  268.      Try loading one of these into the Text Casing module ( in the Utilities
  269.      menu) and put the keyword casing on. Keyword Configuration files can be
  270.      recognised by the ".KEY" filename extension.   The following three such 
  271.      files have been included with the shareware release :-
  272.  
  273.       · AmigaDOS.key = List of AmigaDOS keywords (e.g. Dir,List,Copy etc.)
  274.       · Pascal.key   = List of ISO Pascal keywords (e.g. WriteLn,Begin,End )
  275.       · C.key        = List of C keywords (e.g. If,While,Int,Struct etc.)
  276.  
  277.      Try entering ":EdWord/Pascal" as the configuration filename  and select
  278.      the LOAD KEYWORDS gadget. (N.B Delimiters are symbols which inhibit the
  279.      casing operations within a certain range  i.e. comments)
  280.  
  281.   2) User Commands : EdWord will let you define 3 user commands.  These  are
  282.      just commands which you could type in at the CLI prompt but EdWord will
  283.      let you run them without having to quit the editor.  The "Delay switch"
  284.      can be used to force a wait for a keypress after completing the command
  285.      The "AutoSave" switch can be used to force  EdWord  to save the current
  286.      file before executing the command.  The actual command string which you
  287.      enter will be executed exactly as you enter it with three exceptions :-
  288.         
  289.       · any occurence of an "*" character will be replaced with the current
  290.         filename when the command is run.
  291.       · any occurence of an "@" character will be replaced with the current
  292.         filename with no file extensions. e.g. If the filename is "hello.c"
  293.         then the "@" character will be converted to "Hello"
  294.       · any occurence of a "|" character will be converted into a line feed
  295.         so that you can specify multiple commands with the one string.
  296.  
  297.      e.g.  The following Command String will display the name of the current
  298.      file being edited and perform an  AmigaDOS List command to find out the
  299.      size/date etc. of the file.
  300.  
  301.                   ECHO "The current filename is *' | List *
  302.  
  303.  
  304.  Using these two facilities you can create custom environments for just about
  305.  any language. I have used it successfully to make integrated editor/compiler
  306.  environments for AmigaBASIC, DevPac, Lattice C, North C & DICE  with amazing
  307.  ease, effortlessness and speed. N.B. In order to run User Commands, you must
  308.  have the AmigaDOS command RUN in your C: directory.  Finally,  I'll give you
  309.  a quick list of all the command line options which EdWord recognises :-
  310.  
  311.    Usage : EdWord {filename} {-C configfilename} {-NTSC} {-WB} {-REQ}
  312.                   {-NODIR} {-MEM size} {-T title} {-F fontname} {-D}
  313.                   {-GADGET} {-COLS number} {?}
  314.  
  315.     Where,
  316.            -C loads an EdWord configuration file (e.g EdWord.config)
  317.         -NTSC forces EdWord into an NTSC screen mode on start up.
  318.           -WB forces EdWord to use the WorkBench screen.
  319.          -REQ forces a file requester on start up.
  320.        -NODIR file requester will initially wait for new dir selection.
  321.       -GADGET makes EdWord use the standard Amiga system gadgets.
  322.         -COLS set the number of colours for the custom screen (2 or 4)
  323.          -MEM specifies the memory buffer size in bytes (default = 60000).
  324.            -T changes the program title (default = EdWord V2.2).
  325.            -F uses the specified 8 point font (default = topaz 80).
  326.            -D disables checks for viruses in RAM - best left on !
  327.             ? displays this help text and does not enter the editor.
  328.  
  329.  
  330.                   LAST CALL / REFLECTIONS / A FINAL THOUGHT
  331.                   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  332.  
  333.   Just before I go, I thought I would  share  this pearl of logical reasoning
  334.  with you, which is  offered  by  "The Hitch Hiker's Guide to the Galaxy"  in 
  335.  reference to the question, `What is the population of the Universe?'. 
  336.  
  337.          "It is known that there  are  an  infinite number of worlds,
  338.           simply because there  is  an  infinite  amount of space for 
  339.           them to be in. However, not every one of them is inhabited.
  340.           Therefore, there  must  be a  finite  number  of  inhabited
  341.           worlds.  Any finite number  divided  by infinity is as near
  342.           to nothing as makes no odds, so the  average  population of
  343.           all the planets in  the  Universe  can  be said to be zero.
  344.           From this, it  follows  that  the  population  of the whole
  345.           Universe is also  zero, and  that  any  people you may meet
  346.           from time to time  are  merely  the  products of a deranged
  347.           imagination."
  348.  
  349.                                                           Douglas Adams.
  350.  
  351.                
  352.                           ____________________________      
  353.                          |                            |     
  354.                          |  SHARE AND BE EXCELLENT !  |
  355.                          |____________________________|
  356.                            
  357.  
  358.  
  359.