home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / e / extrabar / !Help next >
Encoding:
Text File  |  1997-02-10  |  17.4 KB  |  457 lines
  1. ExtraBar Version 0.77
  2. =====================
  3. Purpose
  4. =======
  5. Extrabar is one of those desktop utilies that you will either hate or decide
  6. you can't live life with out it. It has been designed to ease the use of the
  7. desktop. It does this by creating a new tool bar for the desktop, which can
  8. have buttons created on it.
  9.  
  10. These buttons can do a number of things;
  11.  
  12.   • Opening a 'Filer_Menu' which shows the contents
  13.     of a directory and leads to it's sub-
  14.     directories.
  15.   • 'Insert_text' to enter frequently used text in
  16.     to an application.
  17.   • 'Emulate_Key' presses for use with applications
  18.     that do not have tool bars.
  19.   • Move the caret.
  20.   • Issue any star command.
  21.   • Dynamic buttons. These can have a system variable, the current time,
  22.     amount of free memory or freespace on a disc.
  23.  
  24. and it also features;
  25.  
  26.   • Easy save. Just drag a file from the Save As
  27.     window of any application on to the ExtraBar and
  28.     it will get saved in to a central directory just
  29.     like with a normal directory. So no more messing
  30.     around opening filer windows.
  31.  
  32. It can also issue multiple commands so that with one mouse click you could
  33. run your internet software, mail reader as well as a desktop publiser and
  34. graphics program. Why is, of course, another question :-)
  35.  
  36. Connected
  37. =========
  38. If you have seen the latest pre-christmas Intel adverts about 'connectted'
  39. software and are wondering what this has to do Acorn, well.
  40.  
  41.              ***** THIS IS A CONNECTED APPLICATION *****
  42.  
  43. In the Info window is a button, containing the words 'WWW home
  44. page',clicking on that will take you straight to the Extrabar home page
  45. where upgrades are placed when they become available. Upgrading is now much
  46. easier than before.
  47.  
  48. This is only available is you have a supporting web browser loaded.
  49. Currently that includes Webite, Fresco and ArcWeb.
  50.  
  51. Older versions
  52. ==============
  53. Version 0.40 of Extrabar contained a small buglet. When a button was setup
  54. the wrong bits of the data flag where setup. So when a button file was
  55. loaded in to a older or new version of Extrabar it would look different. The
  56. horizontal gaps became vertical gaps. This has been fixed in this version of
  57. Extrabar however it could mean that some of you tool bars could look
  58. different to how you expected them.
  59.  
  60. Using
  61. =====
  62. To use ExtraBar you first need to load it, a window will then open. This is
  63. the extra bar. On the extra bar there will be an icon with the time and date
  64. in it. Dragging files, directories and applications on to the bar will
  65. create a button with the items name and sprite in it. Clicking on that icon
  66. runs the item that created it. Shift and Ctrl have the same effect as they
  67. normally would have if you where double clicking in a directory.
  68.  
  69. You can also create an empty button from the 'Button > New button' menu
  70. item. Selecting this item creates a blank button with the name Undefined and
  71. a small ExtraBar file for it's sprite. It has no commands defined for it so
  72. clicking on it will show an error. You can alter any button that you create
  73. at anytime.
  74.  
  75. If you click on the background of the extra bar with MENU and also have the
  76. Ctrl key held down then the extra bar's position will be toggled. If it is
  77. hidden then it will come to the front, if it is already at the front then it
  78. will go to the back.
  79.  
  80. To save any buttons that you have created you need to use the save window.
  81. If you click on the save menu item that leads to the save window then the
  82. file will be saved to where it was loaded from or the save window will open.
  83.  
  84. Auto loading a file
  85. ===================
  86. You can make Extrabar load a set of buttons every time it's loaded by saving
  87. a buttons file as the default. This is very simple as all you need to do is
  88. from the 'Toolbar' submenu select the 'Save default' menu item. So long as
  89. ExtraBar is not loaded via a double click on one of it's buttons it will
  90. load.
  91.  
  92. Altering a button
  93. =================
  94. If you wish to change a button's configuration then by opening the main menu
  95. over it and going the to main menu and then to the;
  96.  
  97.                 Button => Alter button
  98.  
  99. dialogue box allows you change it configuration easily. The top icon is
  100. where you can enter the text that will appear in the button, and the icon
  101. below that is the sprite name for the the sprite you want to appear in the
  102. button. Below these are the command icons where you type in the the command
  103. that you want to be issued when the button is clicked on with SELECT or
  104. ADJUST.
  105.  
  106. You can also make the button the last one on the row which forces any
  107. subsequent button to move downwards as well as putting a gap after the
  108. button.
  109.  
  110. At present you can make the button run a number of commands. You can also use
  111. the short two letter version of the command if you wish.
  112.  
  113. They can be;
  114.  
  115.   • A star command.
  116.  
  117.     Syntax:  * <command>
  118.  
  119.   • 'Caret_Back' moves the caret back n places.
  120.  
  121.     Syntax:  Caret_Back <places>
  122.  
  123.   • 'Caret_Forward' moves the caret forward n places.
  124.  
  125.     Syntax:  Caret_Forward <places>
  126.  
  127.   • Emulate a key press. You will need to use
  128.     KeyCode to find out the value to use.
  129.  
  130.     Syntax:  Emulate_Key <Key code>
  131.  
  132.   • Opens a menu created from the contents of a
  133.     directory.
  134.  
  135.     Syntax:  Filer_Menu <Directory path>
  136.  
  137.   • Opens a menu created from a user definable menu file.
  138.  
  139.     Syntax:  User_Menu <Menu file path>
  140.  
  141.   • 'Insert_Contents' moves the caret forward n places.
  142.     Takes a file and sends it's contents to the the
  143.     current application with the input focus.
  144.  
  145.     Syntax:  Insert_Contents <file>
  146.  
  147.   • 'Insert' takes a string and sends to an
  148.     application, no special actions are taken except
  149.     changing '|m' to a Return press.
  150.  
  151.     Syntax:  Insert "<text>"
  152.  
  153.   • 'Insert_text' in to an application, after
  154.     passing it to GSTrans and inserting any time
  155.     variables that may have been used. ie. %m3 will
  156.     become Jun, Dec, etc.
  157.  
  158.     Any system variables that are named will be
  159.     convertted to the value that they are set to.
  160.     ie. Insert_text "<Wimp$State>" will send the
  161.     work 'desktop' to the application.
  162.  
  163.     If you want to send a < or " to an application
  164.     you must first put a | in front of it. You can
  165.     also send a Return with |m and a | with ||.
  166.  
  167.     Syntax:  Insert_text "<string>"
  168.  
  169.   • 'Save_file' opens a window allowing you to save
  170.     a file from one place to another. For example
  171.     you could use this call to allow the user to
  172.     save a file to a directory after a processing
  173.     activity (Jpeg to Sprite, etc...)
  174.  
  175.     Syntax:  Save_File <directory>
  176.  
  177.   • 'Web' Will send a request to any web browsing
  178.     software to go to a particual page. Can be
  179.     http://, mailto:, telnet:// or any other
  180.     protocolo.
  181.  
  182.     Supported by Termite and Fresco
  183.  
  184.     Syntax:  Web <Web address>
  185.  
  186.   • 'Task_Loaded' will execute a command if an application is loaded or an
  187.     optional command if it is not.
  188.  
  189.     Syntax:  Task_loaded <appname> then <command> [else <command>]
  190.  
  191.   • 'Task_NotLoaded' will execute a command if an application is not loaded
  192.     or an optional command if it is. The application name <appname> is the
  193.     same as the one that appears in the task window. It is a case-
  194.     sensitive. If the application's name includes spaces it should be
  195.     surrounded by quotes.
  196.  
  197.     Syntax:  Task_notloaded <appname> then <command> [else <command>]
  198.  
  199.   • 'ModTask_Loaded' will execute a command if an module task is loaded or
  200.     an optional command if it is not.
  201.  
  202.     Syntax:  ModTask_loaded <appname> then <command> [else <command>]
  203.  
  204.   • 'ModTask_NotLoaded' will execute a command if an module task is not
  205.     loaded or an optional command if it is. The module task name <appname>
  206.     is the same as the one that appears in the task window. It is a case-
  207.     sensitive. If the module's name includes spaces it should be surrounded
  208.     by quotes.
  209.  
  210.     Syntax:  ModTask_notloaded <appname> then <command> [else <command>]
  211.  
  212.   • 'AllTask_Loaded' will execute a command if an module task or application
  213.     is loaded or an optional command if it is not.
  214.  
  215.     Syntax:  ModTask_loaded <appname> then <command> [else <command>]
  216.  
  217.   • 'AllTask_NotLoaded' will execute a command if an module task or
  218.     application is not loaded or an optional command if it is. The module
  219.     task name or application name <appname> is the same as the one that
  220.     appears in the task window. It is a case-sensitive. If the application's
  221.     or module's name includes spaces it should be surrounded by quotes.
  222.  
  223.     Syntax:  ModTask_notloaded <appname> then <command> [else <command>]
  224.  
  225.   • 'Report' opens up a standard Risc OS error window with a message in it.
  226.     If the message includes spaces it should be surrounded by quotes.
  227.  
  228.     Syntax:  Report <message>
  229.  
  230.   • 'Task_Kill' forces a task to be killed.
  231.  
  232.     Syntax:  Task_Kill <taskname>
  233.  
  234.   • 'Dragged_on' switches the commands depending on whether a command was
  235.     run by dragging a file on to the button rather than clicking on it with
  236.     the mouse button.
  237.  
  238.     Syntax:  Dragged_on [<filetypes>] then <command> [else <command>]
  239.  
  240.   • 'Swap_sprites' switchs between two different sprites for a button.
  241.     useful when used with dynamic buttons.
  242.  
  243.     Syntax:  Swap_sprites <sprite 1>,<sprite 2>,<sprite 3>,<sprite 4>,etc.
  244.  
  245.     If <sprite n> includes a ; then the text after it is assumed to be for
  246.     the extra info for the button and is placed in to it whe the sprite is
  247.     swapped.
  248.  
  249. Multiple commands
  250. =================
  251. You can also make it run a number of different commands. Each command must
  252. be seperated by {com}.
  253.  
  254. Example;
  255.  
  256. To run my internet software and the mail reader that came with it I would
  257. use;
  258.  
  259.      Run ADFS::4.$.Internet.!Termite{com}Run ADFS::4.$.Internet.!Offlite.
  260.  
  261. so that with a single click both !Termite and !Offlite would load.
  262.  
  263. User menu files
  264. ===============
  265. Users menus are simply text files which are used to define menus. The format
  266. is currently still under construction but the following has been set down
  267. already.
  268.  
  269.     1st line is the title for the menu. Nothing for no title.
  270.     Following lines are for menu items, infomation seperated by tabs.
  271.  
  272.         <Menu item text><tab><Command to excute when clicked on>
  273.  
  274. If you want there to be an line across the menu then you will need to use a
  275. single dash '-' on a line of it's own. It is intended that the user menu
  276. should be as close to the format that StrongEd uses, however, Extrabar is
  277. currently lacking submenus so you need to be careful when using the tab key.
  278. DON'T put any at the start of a line.
  279.  
  280. You can also include comments if you want by putting a # at the start of the
  281. line. If you have a line which is simply a - then a line will be placed in
  282. the menu at that point. There *could* also be problems involving the use of
  283. the following commands in a user menu in this version:
  284.  
  285.       Filer_Menu,
  286.       User_Menu,
  287.  
  288. Dragged on
  289. ==========
  290. When you select 'Run dragged on', in the alter button dialogue box, the
  291. command will be also be issued when a file is dragged on to it. If you want
  292. to make sure that it is only run when certain filetypes are dragged on then
  293. you need to use the dragged_on command.
  294.  
  295. To insert the path of the file dragged onto it in to the command use %*0
  296. where you would normally put the filename. You can also insert the leaf name
  297. by using %*1 and get a random leaf name by using %*2.
  298.  
  299. Sprites in buttons
  300. ==================
  301. It is possible to use sprites in buttons other then those that have already
  302. been loaded by the wimp manager. To load these sprites you must open the
  303. 'load sprites' window from the 'Toolbar' submenu. When you drag the sprite
  304. on to the window they are loaded and you can use any sprites named.
  305.  
  306. If you have already loaded a sprite file then these can be cleared first
  307. from the 'Toolbar > Clear sprites' menu item. If it is shaded then you have
  308. not loaded any.
  309.  
  310. When you save a button file any sprites that are used and are *NOT* in the
  311. Wimp sprite poll when the file is saved will be stored in the file.
  312.  
  313. Dynamic buttons
  314. ===============
  315. You can now create Dynamic buttons which can change the text they display.
  316. These are setup via the alter button window and can can be;
  317.  
  318.         the current time.
  319.         the amount of free memory.
  320.         the freespace on a disc.
  321.  
  322. To set these you click on the 'Dynamic button' tick box and in to the icon
  323. sprite writable icon enter;
  324.  
  325.         #currenttask    the name of the task that the mouse pointer is
  326.                         currently over.
  327.         #freemem        to display the amount of free memory.
  328.         #freespace      to display the amount of free space on a disc.
  329.                         (Enter the path to the disc in the extra info
  330.                          writable icon, ie ADFS::4, SCSI::5)
  331.         #machineon      how long the computer has been switched on.
  332.         #system         to display a system variable.
  333.         #time           to display the current time.
  334.                         (format displayed is defined in extra info space)
  335.         #mouse          the position of the mouse.
  336.         #whandle        the window handle that the mouse pointer is over.
  337.         #ihandle        the icon handle that the mouse pointer is over.
  338.  
  339. BEWARE: #mouse,#whandle,#ihandle and #currenttask both require ExtraBar to
  340. take much more control over the desktop than normal. If you require more
  341. processing power for a task, ie. downloading a file, then remove any buttons
  342. that make use of these functions. A good idea would be to use the
  343. 'Swap_sprites' command with them so that can be quickly switched of and on
  344. again.
  345.  
  346. Changing the time format
  347. ========================
  348. The time icon can be altered by using the Choices... menu item to open the
  349. choices window. The time format used by Extrabar is the same as for Alarm.
  350. To alter it enter the format in the options window. You can also choose what
  351. side the clock should appear on and whether it should appear at all as three
  352. clocks can be a bit annoying!
  353.  
  354. The time format can be made up of the following items;
  355.  
  356.  
  357.    Item    Description                     Example
  358.   -----------------------------------------------------
  359.    %se     Seconds                         12
  360.    %mi     Minutes                         45
  361.    %12     Hour in 12 hour clock           2
  362.    %24     Hour in 24 hour clock           14
  363.    %am     AM                              am
  364.    %pm     PM                              pm
  365.    %we     Weekday                         Friday
  366.    %w3     Three letter week name          Fri
  367.    %wn     Weekday as a number             5
  368.    %dy     Day of the monh                 05
  369.    %st     St, nd, rd or th of day         st
  370.    %mo     Month name in full              January
  371.    %m3     Month name, three letters       Jan
  372.    %mn     Month name, as number           1
  373.    %ce     Century                         19
  374.    %yr     Year with in century            96
  375.  
  376. use a 'z' after the % to remove any extra 0's
  377.  
  378. Insert_text speed
  379. =================
  380. In the choices (button section) window there is an option called
  381. 'Type speed'. This can be a value between 1 to 19. 19 is the fastest, 1 is
  382. the slowest.
  383.  
  384. Easy file saving
  385. ================
  386. Easy file saving works in much the same way as saving to a disc. You simply
  387. open up the Save As dialogue box and then drag the file icon on to an area
  388. of the ExtraBar and it is saved. The file name that is used in the Save as
  389. box is also used for the easy saving and if there is a file already with
  390. that name then an error message appears. If you decide to overwrite the file
  391. then the file will be saved as normal. If you decide not to overwrite the
  392. file then it will not be saved.
  393.  
  394. Help!!!
  395. =======
  396.  
  397.  Q¹ When I use the Insert_text command not all the
  398.     text I want to be sent is?
  399.  
  400.  A¹ Because of the way ExtraBar processes the
  401.     Insert_text command you need to put a | before
  402.     any < and " that you want to be sent.
  403.  
  404.  Q² When I use the Filer_Menu command I can only
  405.     open the display 8 directories deep. Why?
  406.  
  407.  A² Because Risc OS does not like there to be more
  408.     than 8 sub menus so I had to limit it :(
  409.  
  410. If you still have any other problems *E-mail* me with the FULL command that
  411. is giving the trouble and I will see what I can do.
  412.  
  413. Future versions
  414. ===============
  415. • Compressed file data using Squash module.
  416. • Possibly, but unlikely, build the ExtraBar commands in to a module.
  417. • Multiple tool bars. Possible floating bars but this is currently very
  418.   unlikely cause it will quite a bit of work and I'm busy at college.
  419.  
  420.   Any other suggestions. ??????????
  421.  
  422. Copyright
  423. =========
  424. This program is FreeWare. This means that Extrabar maybe freely copied and
  425. distributed as long as only a small charge is made for costs. (Small means
  426. less than 5 pounds. If you want to charge any more per disc ask my
  427. permission first). I, the author, keep full copyright over Extrabar and you
  428. may not alter it in any way.
  429.  
  430. Disclaimer
  431. ==========
  432. I, the author, do not accept any liability for the loss or damage to your
  433. computer or any data stored on it, however caused, arising as a result of
  434. the use or misuse of this program.
  435.  
  436. The main !RunImage file for ExtraBar has been compressed using Cy Bookers
  437. BasCompress due to the Source being over 105K of pure Basic code. If you
  438. want a copy then please e-mail and I will be happy to send you a copy. If
  439. you do use any code that has been borrowed from Extrabar I don't mind, so
  440. long as you give me some credit!
  441.  
  442. Contacting the author
  443. =====================
  444. You can contact by any of the following methods. If you have any problems or
  445. if you have any suggestions for ExtraBar then please do contact me as it'll
  446. give me some ideas as to what other people would like adding.
  447.  
  448. E-mail     : davemac@rylands.demon.co.uk
  449.  
  450. WWW        : http://www.atlantic.oaktree.co.uk/
  451.  
  452. Snail mail : David McCormack,
  453.              2 Cornwall Avenue,
  454.              Beeston Rylands,
  455.              Nottingham,
  456.              NG9 1NL
  457.