***************************** Copyright Notice ****************************
*                                                                         *
*                          (C)1990 Duco Fennema                           *
*                                                                         *
*    Read the 'Terms of Use' chapter at the end of this file to know      *
*             what you may and may not do with this program.              *
*                                                                         *
***************************************************************************


                    ReadMe file for !BasEdit v1.40


                   Yet another BasicEditor starter?

          Yes, but one with a difference, so please read on!



        Why !BasEdit ?_____________________________________________

        "Ok, this program is finished, let's save it.
        Oh oh, forgot to change the directory.
        Now where has that other !Runimage file gone?"

        If this sounds familiar to you,
        then you certainly need !BasEdit.



        Contents___________________________________________________

        This file contains 11 chapters in this order.
          -Preface
          -Introduction
          -Getting started
          -The options
          -Starting a new program
          -Editing an existing program
          -Using !BasEdit
          -Acknowledgements
          -Terms of use
          -Release information
          -Correspondence



        Preface____________________________________________________
                                                                  
        It is assumed that the reader has a working knowledge of
        the Archimedes desktop environment and the ARMBasicEditor.
        Therefore none of the terms related to them are explained
        here, please refer to the Archimedes User Guide or the BBC
        Basic Guide instead.



        Introduction_______________________________________________

        !BasEdit can do more than just starting the BasicEditor and
        loading a program into it.

        !BasEdit has options to:
          -automatically change the CSD so that a simple save from
           the Editor will go to the right place
          -intercept double clicks on a Basic file and drop it into
           the Editor instead of running it.

        !BasEdit always lets you:
          -load a Basic file by shift clicking in a filer window.
          -drag a Basic file to its icon to enter the Editor with
           that file.
          -enter the Editor with the last file loaded by simply
           clicking on its icon with Select.
          -enter the Editor at a given point.
          -start a new Basic program by clicking on its icon with
           Adjust instead of Select.
          -change the CSD by dragging a directory onto its icon.

        You see there is more behind this icon than meets the eye.



        Getting started____________________________________________

        In the !Run file inside the !BasEdit application directory
        two system variables are declared.
        These two variables control the way !BasEdit starts up and
        will be explained below.

          -BasEdit$Path:
           Controls to what directory the CSD will be set when a
           new Basic program is created.
           It is also the directory displayed by the OpenDir menu
           item when clicked upon.
           It must be a full path to a file inside(!) the directory
           of your choice, !BasEdit will strip the leaf.
           The named file does not have to exist but it will not
           cause an error if it does.
           
           If it is not set BasEdit$Dir will be used instead and
           because the leaf will be stripped your programs will
           appear alongside !BasEdit.
           
          -BasEdit$Options:
           Controls the state of the AutoCSD, AutoLoad and options
           in the iconbar menu.
           There are two keywords which may be used.
             -CSD  : if present the AutoCSD  option will be on.
             -Load : if present the AutoLoad option will be on.

           If a keyword is not present the option will be off
           initially.



        The options________________________________________________

        In its iconbar menu !BasEdit has two special menu entries.
        These are named AutoCSD and AutoLoad.
        These two entries toggle the state of the options with the
        same name.
        A displayed tick means it is on.

        If the AutoCSD option is on !BasEdit will set the CSD to
        the directory:
          -from which the file originates when it loads a Basic
           program.
          -to the directory specified by BasEdit$Path when it
           starts a new Basic program.

        If the AutoLoad option is on !BasEdit will prevent a double
        clicked Basic file from running, loading it into the Editor
        instead.



        Starting a new program_____________________________________

        If !BasEdit has installed itself on the iconbar you can
        start a new Basic program by clicking on the !BasEdit icon
        with Adjust.



        Editing an existing program________________________________

        If !BasEdit has just installed itself on the iconbar there
        are two ways in which you can edit an existing program.
          -By dragging its filer icon onto the !BasEdit icon.
          -By double clicking on its icon in a filer window while
           holding down the shift key.
          -By double clicking on its icon in a filer window if the
           AutoLoad option is on.

        If !BasEdit has loaded a file into the editor (from which
        you have returned) then there is a third possibility.
          -click on the !BasEdit icon.

        If the last edited file can still be found it will be
        loaded into the editor ready for you.
        Otherwise nothing will happen.



        Using !BasEdit_____________________________________________

        Most of the time you will find yourself editing a program,
        saving it and then test it.
        This cycle will probably be repeated many times before your
        program is finished.

        I agree that !BasEdit is not essential in this case, but if
        you have the AutoCSD option on, you will never have to
        worry if your save (i.e. <f3> <Return>) is going to the
        right place.

        But !BasEdit comes into its own when you edit more than one
        program in succession.
        For if you have the AutoCSD option on, each edited program
        will be saved to its original directory.

        If you want to enter the Editor at a particular point then
        enter the search string in the 'Enter at' submenu item.
        This search string will be effective as long as you don't
        change it.
        Even if you load a different program it will passed to the
        Editor.
        If you want to start at the top delete the search string.

        If you create a small program just to test something or as
        a result of some briliant idea just save it and exit to the
        desktop.
        Then choose OpenDir from the !BasEdit menu and a filer
        window will be opened with your brainchild in it.
        This also is a feature of AutoCSD it will set the CSD to a
        specified directory for newly created Basic program (i.e.
        clicking Adjust on the !BasEdit icon).
        One disadvantage here though: al programs must have a
        unique name because there al going to the same directory.

        If you want to edit a program and save it in a different
        directory then proceed as follows.
          -First turn the AutoCSD option off.
          -Then drag the destination directory upon the !BasEdit
           icon.
          -And load your Basic file into the editor as described
           before.
          -Now a save from the Editor will go into that directory.

        Remember though that this sequence does not change the path
        known to !BasEdit.
        So a click on the !BasEdit icon with Select will load the
        original program file, not the one saved in the new
        directory.

        This also means that if you put the AutoCSD back on and
        click on the !BasEdit icon with Select, the CSD will be set
        back to the directory where your original program file came
        from.

        When you click Select on the !BasEdit icon and the floppy
        containing the Basic file known to !BasEdit the normal adfs
        dialogue window will appear prompting you to insert the
        wanted disc.

        If you do so and click OK then the !BasEdit will load the
        file into the editor.

        If you click CANCEL however then nothing will happen.

        To leave the editor and return to the desktop press f1
        twice !BasEdit has programmed this key with *Quit|M so it
        will do just that.



        Acknowledgements___________________________________________

        Thanks to:
          -Ferdinand Oeinck for his CurrDir and BasicEdit
           applications which inspired me to make this program.
          -Joris Roling for his !Help application (you are probably
           staring at that right now).
          -Freddy Huttner for his excellent !NewModes module.
           (the 56Hz 896x360x16 mode is a dream to work with).
          -Acorn for developing this tremendous machine.
          -My dad for being such a wonderful spelling checker.
           (he's not responsible for mistakes made in this document
           after v1.00)
          -My girlfriend for putting up with so much lack of
           attention.



        Terms of Use_______________________________________________

        You may freely copy as long as:
          -all files in this application directory are included.
          -this is not for commercial purposes
          -you do not charge for copying.
          -you do not put this program or parts of it on a disc for
           wich you are charging (other than the costs of the disc
           itself).
          -the application is not tampered with, tailoring of the
           !Run file (as described above) apart.
          -this Readme file is always included without any change
           made to its contents.
          -you do not upload this on a bulletin board which charges
           for its downloads.

        You may not 'borrow' the program code as a whole for
        inclusion into your own programs.

        The author reserves the right to amend these terms in cases
        where he deems misuse.



        Release information________________________________________

        v1.00 First public release
        v1.01 Interactive help added
              Some cosmetic program changes
              One or two corrections made in this document
        v1.10 A removed but not dismounted floppy will no longer
              cause a task window to open when you try to return to
              your program with a click on the !BasEdit icon.
              Instead the normal prompt to insert the missing
              disc will appear.
        v1.20 AutoNew option added.
        v1.30 New programs will be saved to <BasEdit$Path>
              The new OpenDir entry in the menu allows you to view
              its contents.
              Shift clicking a Basic file will always load the
              program into the editor.
              A removed but not dismounted floppy will no longer
              cause a task window to open when you try to load a
              Basic file by double clicking it in a filer window
              which is still open.
        v1.40 The AutoNew option has been removed (it was pretty
              useless anyway)
              The 'Enter at' option has been added to return to a
              specific point in the program.
              Multiple installation now possible.



        Correspondence_____________________________________________

        Send remarks, bugs and praise to:

          Duco Fennema
          Eursingerweg 34
          9411 BB  BEILEN
          HOLLAND

          Telephone: 
          05930-2277 (05930-22277 from 31-12-1990)

          From outside Holland:
          <International entry code> 031 5930 (2)2277
