home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine 1995 / ARCHIVE95.iso / discs / shareware / share_37 / bas_edit / !BasEdit / !Help / Readme < prev    next >
Text File  |  1991-01-15  |  14KB  |  363 lines
  1. ***************************** Copyright Notice ****************************
  2. *                                                                         *
  3. *                          (C)1990 Duco Fennema                           *
  4. *                                                                         *
  5. *    Read the 'Terms of Use' chapter at the end of this file to know      *
  6. *             what you may and may not do with this program.              *
  7. *                                                                         *
  8. ***************************************************************************
  9.  
  10.  
  11.                     ReadMe file for !BasEdit v1.50
  12.  
  13.  
  14.                    Yet another BasicEditor starter?
  15.  
  16.           Yes, but one with a difference, so please read on!
  17.  
  18.  
  19.  
  20.         Why !BasEdit ?_____________________________________________
  21.  
  22.         "Ok, this program is finished, let's save it.
  23.         Oh oh, forgot to change the directory.
  24.         Now where has that other !Runimage file gone?"
  25.  
  26.         If this sounds familiar to you,
  27.         then you certainly need !BasEdit.
  28.  
  29.  
  30.  
  31.         Contents___________________________________________________
  32.  
  33.         This file contains 11 chapters in this order.
  34.           -Preface
  35.           -Introduction
  36.           -Getting started
  37.           -The options
  38.           -Starting a new program
  39.           -Editing an existing program
  40.           -Using !BasEdit
  41.           -Acknowledgements
  42.           -Terms of use
  43.           -Release information
  44.           -Correspondence
  45.  
  46.  
  47.  
  48.         Preface____________________________________________________
  49.                                                                   
  50.         It is assumed that the reader has a working knowledge of
  51.         the Archimedes desktop environment and the ARMBasicEditor.
  52.         Therefore none of the terms related to them are explained
  53.         here, please refer to the Archimedes User Guide or the BBC
  54.         Basic Guide instead.
  55.  
  56.  
  57.  
  58.         Introduction_______________________________________________
  59.  
  60.         !BasEdit can do more than just starting the BasicEditor and
  61.         loading a program into it.
  62.  
  63.         !BasEdit has options to:
  64.           -automatically change the CSD so that a simple save from
  65.            the Editor will go to the right place
  66.           -intercept double clicks on a Basic file and drop it into
  67.            the Editor instead of running it.
  68.  
  69.         !BasEdit always lets you:
  70.           -load a Basic file by shift clicking it in a filer
  71.            window.
  72.           -drag a Basic file to its icon to enter the Editor with
  73.            that file.
  74.           -enter the Editor with the last file loaded by simply
  75.            clicking on its icon with Select.
  76.           -enter the Editor at a given point.
  77.           -start a new Basic program by clicking on its icon with
  78.            Adjust instead of Select.
  79.           -change the CSD by dragging a directory onto its icon.
  80.  
  81.         You see there is more behind this icon than meets the eye.
  82.  
  83.  
  84.  
  85.         Getting started____________________________________________
  86.  
  87.         In the !Run file inside the !BasEdit application directory
  88.         the system variable BasEdit$Options is declared.
  89.         This variable controls the way !BasEdit starts up and will
  90.         be explained below.
  91.  
  92.         There may be three keywords folowed by a parameter:
  93.  
  94.           -SaveTo  : Controls to what directory the CSD will be set
  95.                      when a new Basic program is created.
  96.                      It is also the directory displayed by the
  97.                      OpenDir menu item when clicked upon.
  98.                      It must be a full path to the directory of
  99.                      your choice.
  100.                      If it is not given '<BasEdit$Dir>.Saved' will
  101.                      be used instead.           
  102.           -EnterAt : The given text will be placed in the 'EnterAt'
  103.                      submenu.
  104.                      If it is not given 'EnterAt' will be empty.
  105.           -FS      : Controls wich filing system will be selected
  106.                      if you use the NoDir option.
  107.                      You must give the command which performs the
  108.                      desired selection i.e. -FS adfs or -FS ram.
  109.                      If it is not given adfs will be selected.
  110.  
  111.         There may be three state keywords.
  112.         These control the state of the AutoCSD, AutoLoad and NoDir
  113.         options in the iconbar 'Options' submenu.
  114.  
  115.           -CSD     : if present the AutoCSD option will be on.
  116.           -Load    : if present the AutoLoad option will be on.
  117.           -NoDir   : if present the NoDir option will be on.
  118.  
  119.         If a state keyword is not present the option will be off
  120.         initially.
  121.  
  122.         The parameter string template is:
  123.  
  124.           'SaveTo,EnterAt,CSD/S,Load/S,NoDir/S,FS'
  125.  
  126.         The three keywords preceding a parameter are optional and
  127.         strings without a keyword must appear in the correct
  128.         sequence.
  129.  
  130.  
  131.  
  132.         The options________________________________________________
  133.  
  134.         In the iconbar 'Options' submenu !BasEdit has three menu
  135.         special entries.
  136.         These are named AutoCSD, AutoLoad and NoDir and toggle the
  137.         state of the options with the same name.
  138.         A displayed tick means it is on.
  139.  
  140.         If the AutoCSD option is on !BasEdit will set the CSD to
  141.         the directory:
  142.           -from which the file originates when it loads a Basic
  143.            program.
  144.           -to the directory specified by BasEdit$Path when it
  145.            starts a new Basic program.
  146.  
  147.         If the AutoLoad option is on !BasEdit will prevent a double
  148.         clicked Basic file from running, loading it into the Editor
  149.         instead.
  150.  
  151.         If the NoDir option is on !BasEdit will perform a *NoDir
  152.         command when you return from the editor.
  153.         After it has done so it will select a filing system with
  154.         the command given by the -FS parameter in the options
  155.         string.
  156.         This option is overruled by the AutoCSD option; if AutoCSD
  157.         is off so is the NoDir option.
  158.  
  159.  
  160.  
  161.         Starting a new program_____________________________________
  162.  
  163.         If !BasEdit has installed itself on the iconbar you can
  164.         start a new Basic program by clicking on the !BasEdit icon
  165.         with Adjust.
  166.  
  167.  
  168.  
  169.         Editing an existing program________________________________
  170.  
  171.         If !BasEdit has just installed itself on the iconbar there
  172.         are two ways in which you can edit an existing program.
  173.           -By dragging its filer icon onto the !BasEdit icon.
  174.           -By double clicking on its icon in a filer window while
  175.            holding down the shift key.
  176.           -By double clicking on its icon in a filer window if the
  177.            AutoLoad option is on.
  178.  
  179.         If !BasEdit has loaded a file into the editor (from which
  180.         you have returned) then there is a third possibility.
  181.           -click on the !BasEdit icon.
  182.  
  183.         If the last edited file can still be found it will be
  184.         loaded into the editor ready for you.
  185.         Otherwise nothing will happen.
  186.  
  187.  
  188.  
  189.         Using !BasEdit_____________________________________________
  190.  
  191.         Most of the time you will find yourself editing a program,
  192.         saving it and then test it.
  193.         This cycle will probably be repeated many times before your
  194.         program is finished.
  195.  
  196.         I agree that !BasEdit is not essential in this case, but if
  197.         you have the AutoCSD option on, you will never have to
  198.         worry if your save (i.e. <f3> <Return>) is going to the
  199.         right place.
  200.  
  201.         But !BasEdit comes into its own when you edit more than one
  202.         program in succession.
  203.         For if you have the AutoCSD option on, each edited program
  204.         will be saved to its original directory.
  205.  
  206.         If you want to enter the Editor at a particular point then
  207.         enter the search string in the 'Enter at' submenu item.
  208.         This search string will be effective as long as you don't
  209.         change it.
  210.         Even if you load a different program it will passed to the
  211.         Editor.
  212.         If you want to start at the top delete the search string.
  213.  
  214.         If you create a small program just to test something or as
  215.         a result of some briliant idea just save it and exit to the
  216.         desktop.
  217.         Then choose OpenDir from the !BasEdit menu and a filer
  218.         window will be opened with your brainchild in it.
  219.         This also is a feature of AutoCSD it will set the CSD to a
  220.         specified directory for newly created Basic program (i.e.
  221.         clicking Adjust on the !BasEdit icon).
  222.         One disadvantage here though: al programs must have a
  223.         unique name because there al going to the same directory.
  224.  
  225.         If you want to edit a program and save it in a different
  226.         directory then proceed as follows.
  227.           -First turn the AutoCSD option off.
  228.           -Then drag the destination directory upon the !BasEdit
  229.            icon.
  230.           -And load your Basic file into the editor as described
  231.            before.
  232.           -Now a save from the Editor will go into that directory.
  233.  
  234.         Remember though that this sequence does not change the path
  235.         known to !BasEdit.
  236.         So a click on the !BasEdit icon with Select will load the
  237.         original program file, not the one saved in the new
  238.         directory.
  239.  
  240.         This also means that if you put the AutoCSD back on and
  241.         click on the !BasEdit icon with Select, the CSD will be set
  242.         back to the directory where your original program file came
  243.         from.
  244.  
  245.         When you click Select on the !BasEdit icon and the floppy
  246.         containing the Basic file known to !BasEdit the normal adfs
  247.         dialogue window will appear prompting you to insert the
  248.         wanted disc.
  249.  
  250.         If you do so and click OK then the !BasEdit will load the
  251.         file into the editor.
  252.  
  253.         If you click CANCEL however then nothing will happen.
  254.  
  255.         To leave the editor and return to the desktop press f1 
  256.         twice !BasEdit has programmed this key with *Desktop|M and
  257.         it will do just that.
  258.  
  259.  
  260.  
  261.         Acknowledgements___________________________________________
  262.  
  263.         Thanks to:
  264.           -Ferdinand Oeinck for his CurrDir and BasicEdit
  265.            applications which inspired me to make this program.
  266.           -Joris Roling for his !Help application (you are probably
  267.            staring at that right now).
  268.           -Freddy Huttner for his excellent !NewModes module.
  269.            (the 56Hz 896x360x16 mode is a dream to work with).
  270.           -Acorn for developing this tremendous machine.
  271.           -My dad for being such a wonderful spelling checker.
  272.            (he's not responsible for mistakes made in this document
  273.            after v1.00)
  274.           -My girlfriend for putting up with so much lack of
  275.            attention.
  276.  
  277.  
  278.  
  279.         Terms of Use_______________________________________________
  280.  
  281.         You may freely copy as long as:
  282.           -all files in this application directory are included.
  283.           -this is not for commercial purposes
  284.           -you do not charge for copying.
  285.           -you do not put this program or parts of it on a disc for
  286.            wich you are charging (other than the costs of the disc
  287.            itself).
  288.           -the application is not tampered with, tailoring of the
  289.            !Run file (as described above) apart.
  290.           -this Readme file is always included without any change
  291.            made to its contents.
  292.           -you do not upload this on a bulletin board which charges
  293.            for its downloads.
  294.  
  295.         You may not 'borrow' the program code as a whole for
  296.         inclusion into your own programs.
  297.  
  298.         The author reserves the right to amend these terms in cases
  299.         where he deems misuse.
  300.  
  301.  
  302.  
  303.         Release information________________________________________
  304.  
  305.         v1.00 First public release
  306.         v1.01 Interactive help added
  307.               Some cosmetic program changes
  308.               One or two corrections made in this document
  309.         v1.10 A removed but not dismounted floppy will no longer
  310.               cause a task window to open when you try to return to
  311.               your program with a click on the !BasEdit icon.
  312.               Instead the normal prompt to insert the missing
  313.               disc will appear.
  314.         v1.20 AutoNew option added.
  315.         v1.30 New programs will be saved to <BasEdit$Path>
  316.               The new OpenDir entry in the menu allows you to view
  317.               its contents.
  318.               Shift clicking a Basic file will always load the
  319.               program into the editor.
  320.               A removed but not dismounted floppy will no longer
  321.               cause a task window to open when you try to load a
  322.               Basic file by double clicking it in a filer window
  323.               which is still open.
  324.         v1.40 The AutoNew option has been removed (it was pretty
  325.               useless anyway)
  326.               The 'Enter at' option has been added to return to a
  327.               specific point in the program.
  328.               Multiple installation now possible.
  329.         v1.41 'Wimp_ProcessKey now handled correctly (Key Pressed
  330.               event used to be a dead end)
  331.         v1.42 If the directory specified by <BasEdit$Path> does not
  332.               exist you won't be confronted with an obscure error
  333.               message when you click Adjust on the BasEdit icon.
  334.         v1.43 Files from RamFS will be loaded now, it didn't before
  335.               because ADFS_FreeSpace was used regardless of where
  336.               the file game from.
  337.         v1.50 Bug when reading BasEdit$Dir fixed. 
  338.               All options are moved to the new 'Options' submenu.
  339.               The new 'NoDir' option makes !Basedit perform a
  340.               *NoDir when you return from the editor.
  341.               A filing system may be specified to be selected after
  342.               returning from the editor.
  343.               The default 'EnterAt' string may now be specified.
  344.               <BasEdit$Options> is now being used to specify which
  345.               directory to use for newly created programs.
  346.  
  347.  
  348.  
  349.         Correspondence_____________________________________________
  350.  
  351.         Send remarks, bugs and praise to:
  352.  
  353.           Duco Fennema
  354.           Eursingerweg 34
  355.           9411 BB  BEILEN
  356.           HOLLAND
  357.  
  358.           Telephone: 
  359.           05930-2277 (05930-22277 from 31-12-1990)
  360.  
  361.           From outside Holland:
  362.           <International entry code> 031 5930 (2)2277
  363.