workbench/tools/BoingIconBar/BiB_Eng.guide

   1 @database BoingIkonBar_guide
   2 @$VER: BIB guide 1.02 (26.04.2012) ©2012 Robert 'Phibrizzo' Krajcarz
   3 @macro title "@{B}@{FG HighLight}"
   4 @macro utitle "@{UB}@{FG Text}"
   5 @node main "BoingIconsBar - description of the program"
   6 @{jcenter}
   7 @{title}Boing Icons Bar@{utitle}
   8
   9 Version 1.02
  10
  11 @{I}This program is distributed as Freeware@{UI}
  12 @{jleft}
  13
  14                    @{"   What is it?  " link description}
  15
  16                    @{"  Installation  " link installation}
  17
  18                    @{" How to operate " link configuration}
  19
  20                    @{"    History     " link history}
  21
  22                    @{"     Author     " link author}
  23 @endnode
  24 @node description " What is it ? "
  25
  26     This program creates a toolbar with icons similar to AmiDock,
  27     to which it can be an alternative.
  28     It requires:
  29
  30     AmigaOS 3.5+
  31     AmigaOS 4.x
  32     MorphOS 2.x
  33     AROS
  34
  35     There is a separate version of a program for each system.
  36
  37     Toolbar supports icon types used in:
  38
  39     a) AmigaOS 3.5+
  40
  41     - plain icons (4 colours)
  42     - MagicWB
  43     - NewIcon
  44     - GlowIcon 32
  45     - GlowIcon 256 - only with icon.library ver. 46.4.191+
  46
  47     b) AmigaOS 4.x
  48
  49     - plain icons (4 colours)
  50     - MagicWB
  51     - NewIcon
  52     - GlowIcon 32
  53     - GlowIcon 256
  54     - PNG - after installing additional PNG plugin
  55
  56     c) MorphOS 2.x
  57
  58     - PNG
  59
  60     d) AROS
  61
  62 @endnode
  63 @node Installation "Installation"
  64
  65    Installation of this program is very easy and it can be done manually:
  66
  67    1. Copy the settings of the program to ENVARC: and ENV:
  68
  69    2. Copy the file, suitable for your operating system, to WBStartup or
  70      to any other place that you like and then run it from user - startup.
  71
  72    3. Copy the BiBPrefs file to Sys:Prefs
  73
  74    In the "bibgfx" folder you can place three gfx files, which can be
  75    used as a background (option):
  76
  77      left - left edge of the background
  78    middle - middle
  79     right - right edge of the background
  80
  81    You can only use file "middle", the rest is not required.
  82
  83    New for AROS: gfx files are installed in SYS:System/Images/bibgfx.
  84
  85 @endnode
  86 @node configuration "How to operate and configure"
  87 @wordwrap
  88     After running without any parameters the program always runs hidden.
  89     In order for it to be visible you have to go down with your mouse pointer near the middle part of the screen and wait about one second.
  90
  91     After that time the toolbar with icons should appear on your screen.
  92     The change of the levels can be done using:
  93
  94         a) scroll in your mouse
  95         b) after pressing the right mouse button and choosing the option form the menu
  96         c) with keys; @{B}F2@{UB} - next level, @{B}F3@{UB} - previous level
  97
  98     There are additional keyboard shortcuts:
  99
 100     @{B}LShift + ESC @{UB}- exit program
 101     @{B}F1@{UB} - executing REMAP function on icons to the actual colour palette
 102         ( check AUTOREMAP parameter )
 103
 104
 105     Available options & parameters (valid as icon tooltypes):
 106
 107     @{FG HighLight}SPACE/N/K@{FG Text} - an interval between the icons measured in pixels, default option is set to 5 pixels
 108
 109     @{FG HighLight}STATIC/N/K@{FG Text} - if we want our toolbar to be visible after having been run, you have to specify this parameter with a number bigger than 0. This number informs us about the time in seconds after which the window will be displayed on the screen e.g. during the start up of the operating system.
 110
 111     @{FG HighLight}AUTOREMAP/S@{FG Text} - this parameter is unavailable for MorphOS users. It can happen that the icons might be displayed inappropriately, e.g. after choosing an option from the menu of Workbench "Tools -> ResetWB". Using this parameter causes automatic remapping of icons to the actual colour palette, before displaying the toolbar.
 112
 113     @{FG HighLight}BACKGROUND/S@{FG Text} - (AROS only) Displays the toolbar background images.
 114         Images are:
 115             SYS:Sytem/Images/bibgfx/left
 116             SYS:Sytem/Images/bibgfx/middle
 117             SYS:Sytem/Images/bibgfx/right
 118
 119     Additionally, there is a one more parameter for MorphOS users:
 120
 121     @{FG HighLight}SIZE/N/K@{FG Text} - Icon scaling. Icons will be displayed in their standard size without this parameter. Stating the number bigger than 0, causes icon scaling every 16 pixels e.g.
 122         1 - icons will have a size of 16 pixels
 123         2 - 32 pixels
 124         3 - 48 pixels
 125         etc.
 126
 127 @endnode
 128 @node history "History"
 129
 130     1.0  - first public release
 131     1.02 - first AROS SVN release
 132
 133 @endnode
 134 @node author "Author"
 135
 136
 137     The author of this program is:
 138
 139         Robert 'Phibrizzo' Krajcarz - jgn@interia.pl
 140
 141     Preferences program has been written by:
 142
 143         Adam 'Adater' Terlecki
 144         Pawel 'Stefkos' Stefanski
 145
 146     English Translation has been done by:
 147
 148         Lukasz 'Sir_Lucas' Kucharuk
 149
 150     AROS-ification, locale by:
 151         Luke Jerry
 152         Olivier Adam
 153
 154 @endnode