IBrowse² Documentation - Advanced Topics

Last Updated: 20th June 2003

<< SSL Chapter

Contents Chapter

Protocols Chapter >>

This section of the documentation is to cover some of the more advanced aspects of IBrowse², ranging from the configuration options not included in the Preferences, to CLI arguments and tooltypes. Whilst the default configuration of a fresh IBrowse² installation is a simple yet functional setup, by using the Preferences it is possible to customise or re-configure almost every aspect of IBrowse². However, one or two additional features are not available in the Preferences, and require a different approach in order to customise them.

The Transfer Animation is a single IFF image file that can be changed just by replacing the PROGDIR:images/TransferAnimation file. This file should consist of a single graphic with multiple images of equal size, which will make up each frame of the animation.
Example of Transfer Animation layout Note: The border is not required around each image, it is shown here for illustration purposes only.
The image can be in any format that you have a suitable datatype for installed on your system, and there are no minimum or maximum limitations to the frame size. The frame size itself will be automatically calculated as a square, resulting in the width of each frame being equal to the height of the over all image, and the speed of the animation will default to 10 frames per second (FPS) or 100ms. The number of frames will be calculated as follows: total image width / image height = number of frames
e.g.	If your image was 320 pixels wide, and the height was 32 pixels, the total number of frames will be calculated as 320/32 = 10 frames.
However, if your animation does not consist of square frames, or if you need to specify an alternate speed, the details can be specified in the tooltypes of the TransferAnimation.info file. The following tooltypes are allowed:
WIDTH=xx This tooltype should specify an integer number of the width of an individual frame of the animation.
HEIGHT=xx This tooltype should specify an integer number of the height of the animation.
FRAMES=xx This tooltype should specify an integer number of the total number of frames (images) in the animation.
SPEED=xx This tooltype should specify an integer number of milliseconds between each frame of the animation.
	All of these tooltypes are optional, any that are missing will be replaced with the calculations or default values as specified above.

The Image Place Holders are contained in a single IFF image file that can be changed just by replacing the PROGDIR:images/Picture file. This file should consist of a single graphic with multiple images of equal size, which will be used for each of the separate Image Place Holders.
Example of the default Image Place Holder layout
The image can be in any format that you have a suitable datatype for installed on your system, and there are no minimum or maximum limitations to the Image Place Holder size. The file should consist of the following five images in this order: Standard Image Error Image Loading Image Decoding Image Imagemap
	The Loading and Decoding images are no longer used by IBrowse², but must be present in the Image Place Holders file in order for it to function correctly. Dummy entries can be used as long as the requirement of all images being of equal widths is adhered to.

The bullet images are contained in separate IFF image files and can be changed just by replacing each of the PROGDIR:images/bullet#? files. The bullet images are used to display unordered lists e.g. <ul>, and are used for the different levels of nesting.
Example of the default bullet images (Enlarged for clarity)
The three image files should be named as follows: BulletCircle BulletDisc BulletSquare The images can be in any format that you have a suitable datatype for installed on your system, and there are no minimum or maximum limitations to the bullet sizes. The files should contain an image applicable to the name, i.e. a square shape for the BulletSquare image, a disc shape for the BulletDisc image etc. for consistency, but this is not a requirement.

The default Navigation Toolbar images are contained in a single IFF image file that can be changed just by replacing the PROGDIR:images/Navigation file. This file should consist of a single graphic with multiple images of equal size, which will be used for each of the separate default Navigation Toolbar buttons.
Example of the default Navigation Toolbar images (Enlarged for clarity)
The image can be in any format that you have a suitable datatype for installed on your system, and there are no minimum or maximum limitations to the Navigation Toolbar image size. The file should consist of the following seven images in this order: Back Button Image Forward Button Image Home Button Image Reload Button Image Load Images Button Image Search Button Image Stop Button Image

Whilst it is entirely possible to run IBrowse² on a screen of 256 (8 bit) colours or less, the number of individual colours (or pens) made available to IBrowse² for displaying images will depend on other factors such as any other images used on the screen, e.g. the Navigation Toolbar images. In order to get the best out of the World Wide Web and IBrowse², it is therefore recommended that it is displayed on a high (15/16 bit) or true (24/32 bit) colour screen. This eliminates the pen problem and avoids the need for image dithering, a process that tries to give the impression of extra colours by inter-dispersing similar colours to simulate one that is not available in the palette. By default, IBrowse² will open on your Workbench screen, which can be a disadvantage for two reasons: firstly you may run Workbench in fewer colours than you would like for IBrowse² to be displayed in, and secondly you may want to actually use Workbench while IBrowse² is running without reducing the windows size or constantly iconifying and uniconifying IBrowse². One of the features of AmigaOS® is the ability to run screens in different depths, therefore allowing Workbench to be running in fewer colours than you would perhaps require for IBrowse². As IBrowse² uses MUI, it is capable of opening on any public screen, or you can define a custom one for IBrowse² to use.
The following procedure will show you how to set up a custom screen for IBrowse² to open on each time it is launched: Launch IBrowse² as normal. Open the MUI Preferences via Menus » Preferences » MUI.... When the MUI Preferences opens, click on System in the list on the left of the window, and a new set of options will open in the right hand side. In the Public Screen section, click on the Call Inspector button.
A new window called PSI - Public Screen Inspector will now open, and should be used as follows: Click on the New button, and a new screen titled (unnamed) will appear in the list. (unnamed) will be automatically selected, so you can now click on the Edit button.
When the Edit Screen: (unnamed) window opens, configure the Attributes for the new screen as follows: Public Name: IBrowse Screen Title: IBrowse 2.3 You can leave the rest of the settings at their default values.
Click on the Display tab at the top of the window, and configure the new screen as follows: Screen Mode: Select a screen mode of your choice. Depth: Position the slider to your required screen depth (8/15/16/24/32 are recommended). You can leave the rest of the settings at their default values. Click on the OK button, and the Edit Screen window will close, returning you to the PSI window.
To accept your changes, proceed as follows: Click on the Save button, and the new screen will be saved. The PSI window will close, and you will be returned to the MUI Preferences.
Finally, select the newly created screen as follows: In the Public Screen section, click on the drop-down menu gadget. A list of all the screens defined in PSI will be shown. Scroll through the list if required, and select the IBrowse screen you created previously with a double click. The name of the new screen will appear in the Name: gadget. Click on the Save button if you wish to make the change permenent, or Use if you wish to try your new screen just for this session. The MUI Preferences and IBrowse² will close momentarily while the new screen opens, then IBrowse² will re-open on the new screen as per your configuration.

For further information on the other options in PSI and/or MUI, please refer to the MUI documentation itself.

The MUI system uses a number of pens to define how various elements of the screen are displayed. One of these pens, the Shine pen, is used by MUI to render the highlight edge of the 3D effect used by the MUI gadgets and Intuition window decoration. Within IBrowse² and MUI, there are in fact two shine pens: the MUI shine pen which is used as described above, and the IBrowse² shine pen which is used to render the highlight edge of certain HTML elements, such as the horizontal rule, <hr>;. The MUI shine pen also has one other use in IBrowse²: to highlight the title of a Browser Tab when the activity has finished and it's not the currently active tab.
The procedure for changing the MUI shine pen is as follows: Launch IBrowse² as normal. Open the MUI Preferences via Menus » Preferences » MUI.... When the MUI Preferences opens, click on System in the list on the left of the window, and a new set of options will open in the right hand side. In the Public Screen section, click on the Call Inspector button.
A new window called PSI - Public Screen Inspector will now open, and should be used as follows: Click on the name of the screen that IBrowse² opens on to highlight the entry. Click on the Edit button to open the Edit Screen window.
When the Edit Screen: IBrowse window opens, click on the Colors tab at the top of the window, and configure the screen as follows: Click on the colour gadgets and adjust to suit, if required. Click on the colour gadget that you wish to set the shine pen to, and drag over the highlighted Shine area. When the dropzone is highlighted, release the left mouse button to drop the colour selection. Click on the OK button when you are happy with the changes, and the Edit Screen window will close, returning you to the PSI window.
To accept your changes, proceed as follows: Click on the Save button, and the new screen will be saved. The PSI window will close, and you will be returned to the MUI Preferences.
Finally, save your changes as follows: Click on the Save button to accept your changes. The MUI Preferences, IBrowse² and the screen will close momentarily, then the screen will re-open with IBrowse² and your new pen settings as per your configuration.

For further information on the other options in PSI and/or MUI, please refer to the MUI documentation itself.

IBrowse² makes use of the MUI Bubble Help feature in various areas of the GUI. From displaying image errors or alternate text for images, to providing the actual URL for inline links or Fastlink buttons, the MUI Bubble Help can come in very handy. By pausing your mouse pointer over certain elements of the GUI, the Bubble Help will open after a predefined time, display the information relevant to the item under the pointer. It will remain displayed until it is cancelled by moving the mouse or pressing a key.
The MUI Bubble Help is controlled via the MUI Preferences as follows: Launch IBrowse² as normal. Open the MUI Preferences via Menus » Preferences » MUI.... When the MUI Preferences opens, click on System in the list on the left of the window, and a new set of options will open in the right hand side.
In the Bubble Help section, configure the options as follows: First Bubble: Set to the time you would like between pausing the mouse over an item, and the first bubble opening. Next Bubble: Set to the time you would like between pausing the mouse over an item, and the next bubble opening if a previous bubble was already open.

To disable the Bubble Help completely, position the sliders to the far left and the value will change to off.

Finally, save your changes as follows:

Click on the Save button to accept your changes.
The MUI Preferences and IBrowse² will close momentarily, then re-open with your new MUI Bubble Help settings as per your configuration.

For further information on the other options in MUI, please refer to the MUI documentation itself.

The MUI Drag & Drop settings are used to control how the graphical and/or data input Drag & Drop activities will behave. All of the options apply to the graphical Drag & Drop, but for data input Drag & Drop, the Frame setting is not applicable. Graphical Drag & Drop refers to the actions performed on the actual GUI elements when re-arranging the interface, rather than the activities designed to cut down on data input, such as Drag & Drop'ing a URL from a link to the Location gadget.
The procedure for changing the MUI Drag & Drop is as follows: Launch IBrowse² as normal. Open the MUI Preferences via Menus » Preferences » MUI.... When the MUI Preferences opens, click on Navigation in the list on the left of the window, and a new set of options will open in the right hand side.
The Drag & Drop options are as follows: Left Button: Enabling this option and entering an optional qualifier key will allow you to perform Drag & Drop operations with the left mouse button, whilst the qualifier key is held down, if specified. The qualifier is overridden if using the Autostart option. Middle Button: Enabling this option and entering an optional qualifier key will allow you to perform Drag & Drop operations with the middle mouse button, whilst the qualifier key is held down, if specified. The qualifier is overridden if using the Autostart option. Autostart: Enabling this option will cause the Drag & Drop activities to begin as soon as the mouse has moved the specified number of pixels while the left mouse button is held down. If Middle Button is also enabled, then the Drag & Drop can be performed with either mouse button. This option overrides the qualifier key even if specified. Frame: This option allows you to specify which frame type you would like to use for the Drag & Drop group when performing the operation. Look: This option allows you to specify the look of the Drag & Drop group when performing the operation. Options available are: always solid: the group will always be displayed as a solid image. ghosted on box: the group will be displayed as a solid image until over a dropzone when it will turn transparent. ghosted outside box: the group will be displayed as a transparent image until over a dropzone when it will turn solid. always ghosted: the group will always be displayed as a transparent image.
Finally, save your changes as follows: Click on the Save button to accept your changes. The MUI Preferences and IBrowse² will close momentarily, then re-open with your new MUI Drag & Drop settings as per your configuration.

For further information on the other options in MUI, please refer to the MUI documentation itself.

Like most Amiga compatible applications, IBrowse² supports a number of command line arguments that can be issued when launching IBrowse² from a Shell/CLI prompt.
URL/M This option allows you to specify one or more URLs that IBrowse² should attempt to load immediately after launching. Each URL will be loaded into a new window or browser, depending on your Preferences » General » Default new method, and will override any homepage specified in Preferences » Network » Location. e.g. `<path/to/ibrowse>/IBrowse URL=http://www.ibrowse-dev.net http://www.iospirit.de`
	You are not required to prefix the URL with http:// as IBrowse² will automatically prefix this protocol to the URL before the request is sent to the server, unless what you have entered begins with ftp., in which case ftp:// will be prefixed instead.
	You are not required to prefix any local files with file:/// or file://localhost/ as IBrowse² will automatically do this when opening any local files.
CONFIGDIR/K This option allows you to specify a different directory to load the default ibrowse.prefs file from. e.g. `<path/to/ibrowse>/IBrowse CONFIGDIR=alternate`
NOEDITHOTLIST/S This option allows you to disable the ability to edit the Hotlist Manager. Doing so will remove the Add button from the URL Toolbar, along with the controls within the Hotlist Manager itself. This option has no effect on Contact Manager, but will still remove the Add button from the URL Toolbar even if Preferences » General » Use Contact Manager for bookmarks is enabled. e.g. `<path/to/ibrowse>/IBrowse NOEDITHOTLIST`
NOPREFS/S This option allows you to disable the ability to alter the preferences for IBrowse². Doing so will remove the settings options from Menus » Preferences, but retain the quick override options. e.g. `<path/to/ibrowse>/IBrowse NOPREFS`
	Although Menus » Preferences » MUI... entry is removed, it is still possible to edit the MUI settings for IBrowse² via the MUI popup menu, or settings gadget if shown in the window border of IBrowse².

Like most Amiga compatible applications, IBrowse² supports a number of icon tooltypes that can be issued when launching IBrowse² via its icon.
URL=www.somesite.com This option allows you to specify a URL that IBrowse² should attempt to load immediately after launching.
	You are not required to prefix the URL with http:// as IBrowse² will automatically prefix this protocol to the URL before the request is sent to the server, unless what you have entered begins with ftp., in which case ftp:// will be prefixed instead.
	You are not required to prefix any local files with file:/// or file://localhost/ as IBrowse² will automatically do this when opening any local files.
CONFIGDIR=dir This option allows you to specify a different directory to load the default ibrowse.prefs file from.
NOEDITHOTLIST This option allows you to disable the ability to edit the Hotlist Manager. Doing so will remove the Add button from the URL Toolbar, along with the controls within the Hotlist Manager itself. This option has no effect on Contact Manager, but will still remove the Add button from the URL Toolbar even if Preferences » General » Use Contact Manager for bookmarks is enabled.
NOPREFS This option allows you to disable the ability to alter the preferences for IBrowse². Doing so will remove the settings options from Menus » Preferences, but retain the quick override options.
	Although Menus » Preferences » MUI... entry is removed, it is still possible to edit the MUI settings for IBrowse² via the MUI popup menu, or settings gadget if shown in the window border of IBrowse².

<< SSL Chapter

Contents Chapter

Protocols Chapter >>



IBrowse² Documentation v2.3 © 2002, 2003 Dave Fisher ~ IBrowse² Development Team	Revision 1.0