home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / a / armedit / Docs / FrontEnd < prev    next >
Encoding:
Text File  |  1997-02-21  |  13.2 KB  |  332 lines
  1. File        : FrontEnd
  2. Date        : 21-Feb-97
  3. Author      : © A.Thoukydides, 1996, 1997
  4. Description : Description of the WIMP front-end "!ARMEdit" that is part of
  5.               the ARMEdit suite.
  6.  
  7.  
  8. INTRODUCTION
  9.  
  10. The "!ARMEdit" front-end adds functionality to the ARMEdit suite. It is
  11. necessary for the operation of some, but not all, of the other components.
  12. The front-end supports interactive help; use Acorn's !Help application to
  13. obtain information about the item under the mouse pointer.
  14.  
  15. The utilities that use this front-end are:
  16.  
  17.     ARMEDIT.COM     The front-end is required to use the External Data
  18.                     Editing Protocol.
  19.  
  20.     PUTFILE.COM     The front-end is used for the "Save as" method of
  21.                     specifying a destination filename.
  22.  
  23.  
  24. STARTING THE PROGRAM
  25.  
  26. Start the front-end by simply double-clicking SELECT on the "!ARMEdit" icon
  27. in a directory viewer. After a short delay the application icon will appear
  28. on the icon-bar.
  29.  
  30. The front-end may be loaded at any time, before or after the PC software has
  31. been started.
  32.  
  33. If the banner window is found to be annoying, then it may be disabled by
  34. commenting out the last line of the "!ARMEdit.!Run" file (by placing a "|"
  35. character before the "Run" statement). Please do not distribute this software
  36. with the banner disabled - always copy the original files.
  37.  
  38.  
  39. THE ICON BAR
  40.  
  41. Clicking MENU on the icon which appears on the iconbar opens the main program
  42. menu which offers the following options:
  43.  
  44.     Info            Moving over the sub-menu arrow displays a standard
  45.                     program information window. The version number should be
  46.                     the same as the version of the ARMEdit module being used.
  47.                     Leaving the window open for 5 seconds will show some
  48.                     other messages.
  49.  
  50.     PC card         Clicking SELECT starts the configured PC card front-end
  51.                     software using the current PC card configuration. Moving
  52.                     over the sub-menu arrow displays a list of named
  53.                     configurations. Clicking SELECT on one of the
  54.                     configurations will activate that configuration, and then
  55.                     start the PC card software.
  56.  
  57.     Speed...        Clicking SELECT or moving over the sub-menu arrow displays
  58.                     a dialogue box allowing the multitasking speed of the PC
  59.                     card to be controlled.
  60.  
  61.     Relog devices   Clicking SELECT forces a relog of any ARMEDIT.SYS devices.
  62.                     Moving over the sub-menu arrow and selecting the "Now"
  63.                     option forces an immediate relog. These options are
  64.                     equivalent to using the *ARMEdit_DevicesRelog command
  65.                     without or with the "-now" switch.
  66.  
  67.     Configure...    Clicking SELECT opens up a dialogue box that allows
  68.                     ARMEdit to be configured.
  69.                     
  70.     Quit            Quits the front-end program. The module is not affected.
  71.  
  72.  
  73. SPEED CONTROL WINDOW
  74.  
  75. The PC card speed control window allows the multitasking speed of the PC card
  76. to be controlled. This provides a convenient interface to the
  77. *ARMEdit_Polling command. The speed may be set independently for when the PC
  78. window has got the input focus (foreground) and when it has not got the focus
  79. (background).
  80.  
  81. When the option buttons are not selected the default speed is used. Clicking
  82. SELECT on an option button allows the speed to be adjusted. Larger values
  83. increase the performance of the PC card at the expense of slowing down the
  84. desktop.
  85.  
  86.  
  87. CONFIGURATION WINDOW
  88.  
  89. The top area of the configuration window shows an icon for each area of
  90. ARMEdit that may be configured. Clicking on an icon will open another window
  91. allowing relevant options to be adjusted. The icons are:
  92.  
  93.     Front-end       Configuration options specific to the !ARMEdit front-end
  94.                     application.
  95.     
  96.     Speed control   Control of the multitasking speed of the PC card.
  97.     
  98.     Paths           Default paths for the PC card front-end, configuration
  99.                     utility and primary DOS partition. These are used for the
  100.                     multiple named configurations.
  101.     
  102.     Configurations  Configuration of multiple named PC card configurations.
  103.  
  104.     Auto run        Specify obey files to run when the PC card is reset or
  105.                     quit.
  106.  
  107. There are also two buttons at the bottom of the window:
  108.  
  109.     Save            Save and use the modified configuration. The changes will
  110.                     also be used when !ARMEdit is started in the future.
  111.     
  112.     Cancel          Abandon any changes. If ADJUST is used then the
  113.                     configuration window(s) are kept open, and the previously
  114.                     saved configuration is restored.
  115.  
  116.  
  117. CONFIGURATION WINDOW: FRONT-END
  118.  
  119. A single option is supported for configuring the !ARMEdit front-end:
  120.  
  121.     Quit with PC software
  122.     
  123.                     Selecting this option will result in the front-end
  124.                     quitting at the same time as the PC software. This is
  125.                     useful if the application is started automatically when
  126.                     the PC software is run.
  127.  
  128.  
  129. CONFIGURATION WINDOW: SPEED CONTROL
  130.  
  131. The default multitasking speed of the PC card can be set in this window.
  132.  
  133.     Foreground      This is the setting to use when the PC card has the input
  134.                     focus.
  135.     
  136.     Background      This is the setting to use when the PC card has not got
  137.                     the input focus.
  138.  
  139. Clicking on the READ CURRENT icon will set the icons from the currently
  140. active speed. This can be useful if the main speed control option has been
  141. used to set the required speed.
  142.  
  143.  
  144. CONFIGURATION WINDOW: PATHS
  145.  
  146. This window allows the default application paths to be specified. The
  147. writable fields may be typed into directly, or alternatively the relevant
  148. icon may be dragged from a filer window and dropped in the appropriate place.
  149. The required paths are:
  150.  
  151.     PC card front-end
  152.     
  153.                     This is the PC card front-end software, e.g. !PC, !PCx86
  154.                     or !PC486.
  155.     
  156.     Configuration tool
  157.     
  158.                     This is the associated application used to edit the PC
  159.                     card configuration, e.g. !PCconfig.
  160.     
  161.     Primary partition
  162.     
  163.                     This is the main PC partition. Direct SCSI DOS devices
  164.                     are only supported if they can be accessed via DOSFS.
  165.  
  166.  
  167. CONFIGURATION WINDOW: CONFIGURATIONS
  168.  
  169. The multiple PC card configurations offered by the main !ARMEdit menu can be
  170. viewed or configured using this window. The top section of the window
  171. contains a single option:
  172.  
  173.     Include DOS files
  174.     
  175.                     Selecting this option causes CONFIG/SYS and AUTOEXEC/BAT
  176.                     to be automatically included with copies of the
  177.                     "Current configuration".
  178.  
  179. The main area of the window allows the actual configurations to be edited.
  180. At the top is a writable icon giving the name of the selected configuration.
  181. The name of any configuration (other than the "Current configuration") may be
  182. changed by simply typing a new name into the icon.
  183.  
  184. Clicking SELECT on the popup button to the right of the configuration name,
  185. or MENU anywhere in the window, opens a menu giving a couple of options and
  186. a list of the defined configurations. The options are:
  187.  
  188.     Copy            Create a copy of the selected configuration. The copy is
  189.                     as exact duplicate of the existing configuration, except
  190.                     when the "Current configuration" is selected. When the
  191.                     current configuration is copied it is given the name
  192.                     "New configuration" and the "Include DOS files" option
  193.                     is used.
  194.     
  195.     Delete          Delete the selected configuration. The current
  196.                     configuration cannot be deleted.
  197.  
  198. Clicking on one of the configuration names selects that configuration for
  199. editing.
  200.  
  201. Below the configuration name some icons are shown. Clicking on an icon will
  202. either perform an action or open another window allowing aspects of the
  203. configuration to be edited. The icons are:
  204.  
  205.     Config utility  Clicking on this icon will start the PC card configuration
  206.                     tool to edit the selected configuration. The application
  207.                     to use may be changed in either the global or
  208.                     configuration specific paths option.
  209.     
  210.     Text editor     Clicking on this icon loads the selected configuration
  211.                     into a text editor. This uses the External Data Editing
  212.                     Protocol, so !Edit is not supported. Use this to include
  213.                     non-standard options in the configuration.
  214.     
  215.     Paths           Open a window allowing the paths specific to this
  216.                     application to be changed.
  217.     
  218.     DOS files       Open a window listing the DOS files associated with the
  219.                     selected configuration. This allows the list to be
  220.                     changed, and for the copies of the files to be updated.
  221.  
  222. CONFIGURATION WINDOW: CONFIGURATIONS - PATHS
  223.  
  224. This window allows the application paths associated with a configuration to
  225. be specified. This is similar to the default paths window; the main
  226. difference being that the window is split into two sections with associated
  227. radio buttons:
  228.  
  229.     Default         Selecting this option uses the default paths for this
  230.                     configuration.
  231.     
  232.     Other           Selecting this option allows the paths to be changed for
  233.                     this configuration.
  234.  
  235. Each configuration may have its own independent path settings.
  236.  
  237.  
  238. CONFIGURATION WINDOW: CONFIGURATIONS - DOS FILES
  239.  
  240. The top half of this window lists the DOS files associated with the selected
  241. configuration. If a file is referenced with respect to the primary partition
  242. then the partition path is displayed in grey. Click on the name of a file to
  243. select it.
  244.  
  245. The lower half of the window allows the details of a file to be viewed or
  246. changed. The writable field may be typed into directly, or alternatively the
  247. relevant icon may be dragged from a filer window and dropped on the arrow.
  248. The "Relative to partition" option controls whether the primary partition
  249. path should be prefixed to the filename.
  250.  
  251. There are two special buttons near the bottom of the window:
  252.  
  253.     Remove          Remove the selected file from the configuration.
  254.     
  255.     Update copies   Make new copies of the files associated with this
  256.                     configuration. This should be used after adding any files
  257.                     to store a copy with the configuration.
  258.  
  259.  
  260. CONFIGURATION WINDOW: AUTO RUN
  261.  
  262. This window allows obey files to be specified that can be executed
  263. automatically at the following times:
  264.  
  265.     PC booted       This file is run when the PC card is either booted or
  266.                     reset. It could be used to ensure that other support
  267.                     software, such as !PCEx is loaded.
  268.     
  269.     PC front-end quit
  270.     
  271.                     This file is run when the PC card front-end is quit.
  272.                     The default file kills any PC related modules that are
  273.                     not needed when the PC card is not being used.
  274.  
  275. The writable fields may be typed into directly, or alternatively the relevant
  276. icon may be dragged from a filer window and dropped in the appropriate place.
  277.  
  278. Note that the obey files will only be executed when the desktop is active.
  279. However, if the PC card is running in single-tasking mode, then one obey file
  280. may be run when the desktop is reentered.
  281.  
  282.  
  283. THINGS TO DO
  284.  
  285. The following are changes that may be made to the !ARMEdit front-end sometime
  286. in the future.
  287.     
  288.     Load a configured text editor if external edit messages returned.
  289.     
  290.     Support file conversions between common DOS and RISC OS formats.
  291.     
  292.     Provide access to the Windows clipboard.
  293.     
  294.     Support execution of commands in a TaskWindow from the OSCLI command.
  295.     
  296.     Include an installer to copy files to PC partition and change CONFIG.SYS
  297.     and AUTOEXEC.BAT files.
  298.     
  299.     Add option to automatically start the PC front-end when loaded.
  300.  
  301.  
  302. VERSION HISTORY
  303.  
  304. 0.00 (10-Sep-96)    Original development version.
  305.  
  306. 0.01 (11-Sep-96)    Added ability to set cursor position of external edits.
  307.                     "Save as" window added for PUTFILE command.
  308.  
  309. 0.02 (03-Oct-96)    Icons resized to contain complete text with system font.
  310.                     Menu closed before exiting to avoid bug in Toolbox code.
  311.                     Unused Toolbox modules no longer loaded.
  312.                     Added support for multiple PC card configurations.
  313.  
  314. 0.03 (09-Oct-96)    Fixed SaveAs window handling for PUTFILE utility.
  315.                     Moved configuration editor to a different executable.
  316.  
  317. 0.04 (17-Oct-96)    Child tasks started indirectly to avoid Toolbox problems.
  318.  
  319. 0.05 (19-Dec-96)    External edits of configuration files clear modified flags.
  320.                     Rewritten and improved multiple configuration handling.
  321.                     Some new sprites within configuration editor.
  322.  
  323. 0.06 (24-Dec-96)    PC front-end booted before starting configuration editor.
  324.                     Modified paths used by configurations editor before save.
  325.  
  326. 0.07 (17-Jan-97)    Added menu options to force a relog of the device driver.
  327.  
  328. 0.08 (05-Feb-97)    Obey files can be automatically run when PC booted or quit.
  329.  
  330. 0.09 (10-Feb-97)    Corrected copyright message.
  331.  
  332. 1.03 (21-Feb-97)    First official release version.