Millennium Time Capsule/AC2000.BIN/disks/ac1_disk/appline.21e/appline.stg

Text File | 1996-07-04 | 20KB | 595 lines

##ACE-STGPAR 4 0348
@database "AppLine"
@author "Holger Weets/Joe Connor"
@$VER: APPLINE.HYP (@:"__DATE__")
@subject "Documentation/Utilities"
@options "+z-s-j-d12"

@node main "AppLine"
@symbol r AppLine
@{B}@{"AppLine v2.1                                                        AppLine" ignore} @{0}
@line 1 75 0 0 7

@limage appline.img 1



 What does AppLine do?
 Installation
 System requirements
 Limitations and tips
 Operation

 Status, liability and registration

 History

@endnode

@node "What does AppLine do?
@{B}@{"What does AppLine do?                                               AppLine" ignore} @{0}
@line 1 75 0 0 7

AppLine installs an AV compatible button bar capable of selecting
between all running (GEM) applications.

Applications can be selected, closed, configured (hide, hide others,
freeze etc) and passed parameters via the AV protocol.

The screen manager is automatically ignored and other applications can
be 'switched off' in the file APPLINE.INF.

@endnode

@node "Installation"
@{B}@{"Installation                                                        AppLine" ignore} @{0}
@line 1 75 0 0 7

@{B}Important!@{b}
AppLine is a MagiC application and doesn't run under TOS.

-Copy APPLINE.APP and APPLINE.INF to your APPS folder.
-If you're running in a monochrome resolution you should use the mono
 RSC file. To do this rename APPLINE.RSC to APPLINE.RSX then rename
 APPLINEM.RSC to APPLINE.RSC.
-AppLine is configured via APPLINE.INF which should be edited to your
 personal preferences using any ASCII text editor (Notice, Everest
 etc). The following options are available:

* @{B}<name>@{0}
  Listed applications are not displayed on the AppLine button bar.
  Example: WBDAEMON

@symbol ai "!<name>"
* @{B}!<name>@{0}
  Applications which crash AppLine when topped with no open windows can
  be listed here; AppLine refrains from provoking such applications!
  Example: !CAT

@symbol ai "-<name>"
* @{B}-<name>@{0}
  Informs AppLine the application <name> doesn't possess its own menu
  bar. Such applications are topped when selected.
  Example: ST-GUIDE

@symbol ai "=<name>"
* @{B}=<name>@{0}
  Sets the text colour used for the AppLine button. Values between 0
  and 15 are allowed.
  The default colour is set via '=*' and appears in black.
  Example: =THING 11       # Displays in green

Note:
Filenames must be entered in upper case up to a maximum of eight
characters without the file extension.

The following switches are provided to control the behaviour of
AppLine:

/topwind          -AppLine window to foreground
/backwind         -AppLine window always in the background
/nocloser         -AppLine closer button not displayed
/default          -Action assigned to AppLine button
/showmem          -Display free memory after last button
/large            -Memory display in large system font
/topline          -Position button bar immediately under menu bar
/select           -Select button for the active application
/timer            -Sets the interval before updating the button bar
/resize           -Button bar automatically resizes to suit number of buttons
/rstart           -Button bar grows from right to left
/vertical         -Buttons stacked vertically instead of horizontal
/deskfirst        -Desktop is the first button
/fkeys            -Buttons selectable via function keys
/xoff             -Horizontal offset from left screen edge
/yoff             -Vertical offset from lower/top screen edge
/space            -Spacing between button groups
/nowind           -Buttons for applications with no open windows greyed out
/frozen-disabled  -Buttons for frozen applications struck through
/border           -Boldness of 3D effect

@endnode


@node "/topwind"
@xref "/backwind"
@{B}@{"/topwind                                                            AppLine" ignore} @{0}
@line 1 75 0 0 7

  Setting this option means AppLine is topped on starting.

@endnode


@node "/nocloser"
@xref "/default"
@{B}@{"/nocloser                                                           AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option if the closer icon (left hand edge) is not required.

@endnode


@node "/showmem"
@xref "/large"
@{B}@{"/showmem                                                            AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to display the free memory at the right hand end of
  the AppLine button bar.
  Note:
  The text is overwritten by buttons if they extend close to the right
  hand edge.

@endnode


@node "/topline"
@{B}@{"/topline                                                            AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to display the AppLine button bar directly under the
  menu bar instead of along the bottom of the screen.

@endnode


@node "/select"
@{B}@{"/select                                                             AppLine" ignore} @{0}
@line 1 75 0 0 7

  If this option is set AppLine selects the application which owns the
  topped window. If no windows are open the application which owns the
  menu bar is selected. If AppLine itself is topped the 'Action
  button' (left hand edge of the button bar) is selected.

@endnode


@node "/timer"
@{B}@{"/timer                                                              AppLine" ignore} @{0}
@line 1 75 0 0 7

  Sets the interval before updating the AppLine button bar. This value
  defaults to 2 seconds unless otherwise specified.

@endnode


@node "/resize"
@{B}@{"/resize                                                             AppLine" ignore} @{0}
@line 1 75 0 0 7

  Sets AppLine to automatically re-size the width of the button bar to
  accomodate the available buttons, no underying box remains.

@endnode


@node "/rstart"
@xref "/resize"
@{B}@{"/rstart                                                             AppLine" ignore} @{0}
@line 1 75 0 0 7

  This option adds buttons from right to left if the /resize option is
  active.

@endnode


@node "/vertical"
@{B}@{"/vertical                                                           AppLine" ignore} @{0}
@line 1 75 0 0 7

  Displays the button bar in the top left hand corner and stacks
  buttons vertically downwards. The position can be adjusted using the
  /xoff and /yoff options. The following options are affected:
  /resize   ;always active
  /rstart   ;has no effect
  /topline  ;always active
  /showmem  ;not available
  /large    ;no /showmem, no /large

@endnode


@node "/backwind"
@xref "/topwind"
@{B}@{"/backwind                                                           AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to force the AppLine button bar to remain in the
  background.
  Disadvantages:
  AppLine is ignored by 'Cycle window' options
  Drag&Drop of files onto AppLine buttons isn't possible.

@endnode


@node "/default"
@xref "/nocloser"
@{B}@{"/default                                                            AppLine" ignore} @{0}
@line 1 75 0 0 7

  This option determines the function of the icon at the left hand
  edge of the AppLine button bar.
  Options are: 'close', 'top' or 'bottom' -anything else is ignored
  and results in the popup being displayed.

@endnode


@node "/deskfirst"
@{B}@{"/deskfirst                                                          AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to force the desktop button to the left hand edge of
  the AppLine button bar (i.e. the first button) -otherwise the desktop
  appears after any ACCs.
  Note:
  If the desktop is set to unload from memory during program execution
  the desktop button is still displayed if this option is set.

@endnode


@node "/fkeys"
@{B}@{"/fkeys                                                              AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to selection buttons using the function keys. The
  leftmost closer button is not taken into account, therefore the first
  button to the right of the closer can be selected by pressing F1,
  the next by pressing F2 and so on.
  Disadvantage:
  The buttons can no longer pass files via Drag&Drop as an AV Server.

@endnode


@node "/large"
@xref "/showmem"
@{B}@{"/large                                                              AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to display the free memory using the normal system
  font (9 point). Unless this option is set the free memory is
  displayed in the same point size as the button text.

@endnode


@node "/xoff"
@xref "/yoff"
@{B}@{"/xoff                                                               AppLine" ignore} @{0}
@line 1 75 0 0 7

  Sets the distance, in pixels, between the left hand edge of the
  screen and the left hand edge of AppLine. This enables iconified
  windows to be displayed down the left hand screen edge without being
  obscured by AppLine.
  Example: /xoff 72

@endnode

@node "/yoff"
@xref "/xoff"
@xref "/topline"
@{B}@{"/yoff                                                               AppLine" ignore} @{0}
@line 1 75 0 0 7

  Sets the distance, in pixels, between the lower edge of AppLine and
  the bottom of the screen. This enables iconfied windows to be
  displayed along the bottom of the screen without being obscured by
  AppLine.
  Example: /yoff 4

@endnode


@node "/space"
@{B}@{"/space                                                              AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to insert a small gap between any desired button. The
  action button on the left hand end of the AppLine button bar is
  ignored.
  This can be used to create a gap between ACCs and APPs etc.
  Example: /space 3 -adds a gap after the third button.

@endnode


@node "/nowind"
@xref "/frozen-disabled"
@{B}@{"/frozen                                                             AppLine" ignore} @{0}
@line 1 75 0 0 7

  Set this option to grey out any AppLine buttons for applications with
  no currently open windows.
  The display can be adjusted using the /frozen-disabled switch

@endnode


@node "/frozen-disabled"
@{B}@{"/frozen-disabled                                                    AppLine" ignore} @{0}
@line 1 75 0 0 7

  Any application/s with no open windows are displayed with struck
  through buttons. Frozen applications are displayed in light text.

@endnode


@node "/border"
@{B}@{"/border                                                             AppLine" ignore} @{0}
@line 1 75 0 0 7

 This option sets the 'boldness' of the 3D effect in pixels. The bigger
 the value the bolder the frame.

@endnode


@node "System requirements"
@{B}@{"System requirements                                                 AppLine" ignore} @{0}
@line 1 75 0 0 7

AppLine only runs under MagiC >= v3.0 and MagiC Mac but is otherwise
resolution and platform independent.

@endnode


@node "Limitations and tips"
@{B}@{"Limitations and tips                                                AppLine" ignore} @{0}
@line 1 75 0 0 7

So long as enough space is available all AppLine buttons are displayed
at the same width. If space becomes limited the button width is
reduced to the minimum until space is exhausted, beyond that tough
luck! Unless you're running lots of small applications you're likely
to run out of memory before running out of space for buttons, but
there's always one isn't there?
Tips:
-You could rename lengthy applications (Note: some programs don't like
 this) enabling more buttons to be crammed onto the AppLine bar.
-If you find the small buttons and text to puny you can change the
 buttons to the standard system font (9 point). User defined fonts will
 not be implemented.

@endnode


@node "Operation"
@{B}@{"Operation                                                           AppLine" ignore} @{0}
@line 1 75 0 0 7

A single click on an AppLine button tops all the windows of the
selected application to the foreground in the correct sequence. If the
application has no open window a VA_START message with a null pointer
as a parameter is sent to activate the selected application.

@box 1 70 12

  There are a few programs which cannot cope:
      - Thing: fixed in the current beta
      - CAT: fixed in the current beta
      - QED: fixed in next release
      - COMA: Works from v3.20
      VT52, Kandinsky, TakeOff, Esscode, Zoom, Hex-Edit, Interface
      still have problems.
  If you're confronted by two bombs when attempting to top an
  application please write to the author of the relevant program and
  ask them to fix their programs!



@{B}Options popups@{b}
A popup appears if you hold down the [Control] key, or right mouse
click, or double click, on on the AppLine button bar. The following
options are available:@{0}

@limage popup.img 1 0 0

@symbol ai "To foreground"
    To foreground   Tops all windows belonging to the selected
                    application to the foreground (with a single click)

@symbol ai "To background"
    To background   Bottoms all windows belonging to the selected
                    application to the background (with a single click)

@symbol ai "Hide"
    Hide            Hides all the windows belonging to the selected
                    application. This corresponds to the same function
                    available in the MagiC menu and actions can be
                    mixed between the MagiC and AppLine functions.
                    Note:
                    The hide feature has not always existed under
                    earlier MagiC versions and has only been
                    tested under MagiC v4.0.

@symbol ai "Hide others"
    Hide others     Hides the windows of all applications except the
                    application selected in AppLine.
                    Notes:
                    Inevitably some programs don't liek this treatment,
                    AppLine can but try!
                    If the selected application doens't have any open
                    windows then the hide functions are ignored.

@symbol ai "Freeze" "Thaw"
    Freeze
    Thaw            A frozen application is quasi terminated. All
                    windows belonging to a frozen application are
                    removed from screen and the application receives no
                    computer time. AppLine displays frozen
                    applications with struck through buttons.
                    Thawing an application brings it back to life!

@symbol ai "Close"
    Close           The application is send a AP_TERM message which
                    should cause the application to exit cleanly.

@symbol ai "Terminate"
    Terminate       The application is forcibly removed from the system
                    and is 'dirty'. The application has no opportunity
                    to save its data and may lead to a total system
                    crash!
                    Note:
                    Terminate is for Emergency use only! Use Close
                    wherever possible.

Files can be Drag&Dropped onto AppLine buttons and they are passed to
the relevant application.

A popup appears if you click on the symbol at the left hand end of the
AppLine button bar. The following options are available:

@symbol ai "Show all" "Show defaults"
    Show all
    Show defaults   Select 'Show all' to add applications excluded in
                    APPLINE.INF (e.g. WBDAEMON, WINCOM etc) to the
                    button bar. 'Show defaults' removes excluded
                    applications from the button bar.

@symbol ai "All unhide"
    All unhide      Performs the same function as the 'all unhide'
                    option in the MagiC (>=v4) popup.
                    All hidden windows are restored to their original
                    positions. This option only makes sense if at least
                    one window has been hidden.

@symbol ai "Quit"
    Quit            Exits AppLine, removing the button bar from the
                    screen and releases any memory used.

@endnode


@node "Status, liability and registration"
@{B}@{"Status, liability and registration                                  AppLine" ignore} @{0}
@line 1 75 0 0 7

Status
AppLine is Fairware and may be freely distributed in non-commercial
channels. AppLine and its documentation must always remain together,
complete with all its files and documentation.

If you regularly use AppLine you are expcted to register your copy,
either directly with me or via the InterActive support scheme run by
Joe Connor, please refer to SUPPORT.TXT included with this distribution
for more details.

Liability
Neither I or any agent I may appoint accept any liability or
responsibility for any direct or indirect damage that may arise, either
financial, material or any other kind from either the use or misuse of
this software and associated documentation. All trademarks used are
recognised and acknowledged.

Registration
You can either register directly with the author or via the InterActive
software support scheme. Please refer to SUPPORT.TXT included with this
distribution for more details.

The author:
Holger Weets
Tangastr. 45
26121 Oldenburg
Germany

Konto (Account No): 023-182 041
BLZ (Sort code):    280 501 00

Email:
Maus net: Holger Weets @ OL
Internet: [e-mail]

InterActive software support
Joe Connor
65 Mill Road
Colchester
CO4 5LJ
England

Email:
Internet: [e-mail]
NeST:      90:102/[e-mail]
Fanfiles:  95:110/[e-mail]

Telephone:
[phone] and leave a message on the answerphone!

@endnode


@node "History"
@{B}@{"History                                                             AppLine" ignore} @{0}
@line 1 75 0 0 7

@{B}V2.0 -> V2.1@{0}
· New RSC file APPLINEB.RSC included with buttons in larger font,
  simply rename to APPLINE.RSC to use.
· If both /rstart and /vertical are active the button bar grows from
  the bottom upwards.
· New /border option sets the boldness of the 3D-effect.
· The closer icon includes a new popup with 'Show all/selection',
  'All unhide' and 'Quit' options.
· Application popups now show memory used.

@{B}V1.9 -> V2.0@{0}
· If /deskfirst is active numbers no longer appear in the first button,
  if the Desktop still has not been launched because AppLine was
  launched from the APPS folder.
· The /resize operation may caused window scrolling problems for some
  users, now fixed.
· New option /rstart allows the button bar to /resize from right to
  left.
· New option /vertical stacks buttons vertically downwards.
· New options /frozen-disabled. After multiple requests from one user
  the visual display of frozen applications can now be displayed in
  light text, same as /nowind option.

@{B}V1.8 -> V1.9@{0}
First English version available -earlier history text available in
German only.

@endnode


@pnode "Joe Connor"
InterActive software support

@{B}Joe Connor@{0}
65 Mill Road
Colchester
CO4 5LJ
Engand

@{B}Email:@{0}
jconnor@@cix.compulink.co.uk
@endnode