@DATABASE SIW.guide
@MASTER "HELP:english/SIW.guide"
@$VER: ScreenInWindow_english.guide 37.7 (22.03.95) by Thomas Igracki
@AUTHOR Thomas Igracki
@(c) by Thomas Igracki
@WIDTH 78

@NODE Main "ScreenInWindow Documentation"

                                                    @{b}/@{ub}
                              @{b}ScreenInWindow v1.0  /@{ub} by Thomas Igracki
                           _______________________@{b}/@{ub}

                      @{"     AFD - C O P Y R I G H T     " link AFD-COPYRIGHT/Main}

       @{" What should be in the archive? " link Archiv    } @{" The history of the program     " link History}
       @{" What is it for?                " link WhatItIs  } @{" How to contact me?             " link Me     }
       @{" How to start?                  " link HowToStart} @{" -------- To do - list -------- " link ToDo   }

                            @{b}---------------------
@{fg shine}
    This software is subject to the "Standard Amiga FD-Software Copyright Note"
    It is @{"GIFTWARE" link AFD-COPYRIGHT/Main 91} as defined in paragraph 4g. [...]
    For more information please read "AFD-COPYRIGHT" (Version 1 or higher).
@{fg text}@{ub}
@ENDNODE

@NODE Archiv "ScreenInWindow/What should be in the archive?"
@{LINDENT 3}
The following files should be in the archiv:

   @{b}help/deutsch/SIW.guide@{ub}        --> german documentation, AmigaGuide-Format
   @{b}help/deutsch/AFD-COPYRIGHT.de@{ub} --> german COPYRIGHT-Note
   @{b}help/english/SIW.guide@{ub}        --> english documentation, AmigaGuide-Format
   @{b}help/english/AFD-COPYRIGHT@{ub}    --> english COPYRIGHT-Note
   @{b}SIW@{ub}                           --> the program for OS >= v38 (2.1)
@ENDNODE

@NODE WhatItIs "ScreenInWindow/What is this program for?"
@{LINDENT 3}
This program shows a part of a pubscreen in a window on another pubscreen!

Thats  usefull  for example if you are reading your emails and want to
watch the download of your terminal program, but didn't want to switch
between the screens.
With  @{b}ScreenInWindow@{ub} you  could set up a  small window  in the bottom-
right edge with the interresting part of the screen!

The  window  is fully sizeable (as large as the monitored screen) and has a
vertical and a horizontal slider for choosing the right part of the screen!

You can also 'drag' the content of the window with the left mousebutton!
Simple  press (& hold) the button anywhere in the window and move the mouse
to change the part of the screen!

@ENDNODE

@NODE HowToStart "ScreenInWindow/How to start"
@{LINDENT 3}
@{b}Start from a shell:@{ub}

   Run @{b}SIW@{ub} @{"MS=MonitorScreen/A" link Arg_MonScr},@{"PS=PubScreen" link Arg_PubScr},
           @{"VS=VertStep/N" link Arg_vStep},@{"HS=HorizStep/K/N" link Arg_hStep},
           @{"IU=InactiveUpdateRate/K/N" link Arg_iUpdate},@{"AU=ActiveUpdateRate/K/N" link Arg_aUpdate},
           @{"WL=WinLeft/K/N" link Arg_WinLeft},@{"WT=WinTop/K/N" link Arg_WinTop},
           @{"WW=WinIWidth/K/N" link Arg_WinIWidth},@{"WH=WinIHeight/K/N" link Arg_WinIHeight},
           @{"SL=ScrLeft/K/N" link Arg_ScrLeft},@{"ST=ScrTop/K/N" link Arg_ScrTop},
           @{"VF=VertFactor/K/N" link Arg_vFac},@{"HF=HorizFactor/K/N" link Arg_hFac},@{"RS=ReverseScroll/S" link Arg_revScroll}


@{b}Start from Workbench:@{ub}
  
   No tooltype support yet.
@ENDNODE

@NODE Arg_MonScr "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}MS=MonitorScreen/A@{ub}
@{LINDENT 6}
This options specifies the pubscreen which should be monitored.

This must be used!
@ENDNODE

@NODE Arg_PubScr "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}PS=PubScreen@{ub}
@{LINDENT 6}
This options specifies the pubscreen on which @{b}ScreenInWindow@{ub} should open its window.

This is optional, default is "Workbench".
@ENDNODE

@NODE Arg_vStep "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}VS=VertStep/K/N@{ub}
@{LINDENT 6}
This  options  specifies  the  number  of  pixels the content of the window
should move if the user presses the up or down button.

This is optional, default is 3 pixels.
@ENDNODE

@NODE Arg_hStep "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}HS=HorizStep/K/N@{ub}
@{LINDENT 6}
This  options  specifies  the  number  of  pixels the content of the window
should move if the user presses the left or right button.

This is optional, default is 6 pixels.
@ENDNODE

@NODE Arg_iUpdate "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}IU=InactiveUpdateRate/K/N@{ub}
@{LINDENT 6}
This  options  specifies  the rate (1/50 secs) how often the content of the
window should get updated if its @{b}inactive@{ub}.

This is optional, default is 50 (every second).

If its 0, the content won't be updated if the window is inactiv!

Maximum value for this option is 500, that means 10 seconds.
@ENDNODE

@NODE Arg_aUpdate "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}AU=ActiveUpdateRate/K/N@{ub}
@{LINDENT 6}
This  options  specifies  the rate (1/10 secs) how often the content of the
window should get updated if its @{b}active@{ub}.

This is optional, default is 1 (every 1/10 second).

If  its 0, the content will be updated (if the window is activ) only if the
user changes the desired part, that means drag the mouse or use the gadgets.

Maximum value for this option is 50, that means 10 seconds.
@ENDNODE

@NODE Arg_WinLeft "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}WL=WinLeft/K/N@{ub}
@{LINDENT 6}
This options specifies the left edge where the window should open.

This is optional, default is 200.
@ENDNODE

@NODE Arg_WinTop "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}WT=WinTop/K/N@{ub}
This options specifies the top edge where the window should open.

This is optional, default is 100.
@ENDNODE

@NODE Arg_WinIWidth "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}WW=WinIWidth/K/N@{ub}
@{LINDENT 6}
This options specifies the inner (w/o borders) width of the window.

This is optional, default is 400.
@ENDNODE

@NODE Arg_WinIHeight "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}WH=WinIHeight/K/N@{ub}
@{LINDENT 6}
This options specifies the inner (w/o borders) height of the window.

This is optional, default is 100.
@ENDNODE

@NODE Arg_ScrLeft "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}SL=ScrLeft/K/N@{ub}
@{LINDENT 6}
This  options  specifies  the  left  edge  of the monitored pubscreen where
monitoring should start.

This is optional, default is 0.
@ENDNODE

@NODE Arg_ScrTop "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}ST=ScrTop/K/N@{ub}
@{LINDENT 6}
This  options  specifies  the  top  edge  of  the monitored pubscreen where
monitoring should start.

This is optional, default is 0.
@ENDNODE

@NODE Arg_vFac "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}VF=VertFactor/K/N@{ub}
This options specifies the vertical factor for the @{b}drag-feature@{ub} of
@{b}ScreenInWindow@{ub}.

This is optional, default is MontoredScreen.height / Window.InnerHeight.

Values > 0 will move the content like the slider.
Values < 0 will move the content in the direction of the mouse.
@ENDNODE

@NODE Arg_hFac "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}HF=HorizFactor/K/N@{ub}
@{LINDENT 6}
This  options specifies the horizontal factor for the @{b}drag-feature@{ub} of
@{b}ScreenInWindow@{ub}.

This is optional, default is MonitoredScreen.width / Window.InnerWidth.
   
Values > 0 will move the content like the slider.
Values < 0 will move the content in the direction of the mouse.
@ENDNODE

@NODE Arg_revScroll "ScreenInWindow/Argument"
@{LINDENT 3}
@{b}RS=ReverseScroll/S@{ub}
@{LINDENT 6}
This option is only usefull if @{"VertFactor" link Arg_vFac} and @{"HorizFactor" link Arg_hFac} aren't specified are you are using the
@{b}drag-feature@{ub}!

If  the option is used the content will move in the direction of the mouse,
if not, it will move the sliders.

You should try it!
@ENDNODE

@NODE ToDo "ScreenInWindow/ToDo-List"
@{LINDENT 3}
@{b}The things I want to add:@{ub}
@{LINDENT 6}
- menus to change the values of the parameters during run-time
- lens function!

@{LINDENT 3}
Please send me any suggestion you wish to see in a future version!

@ENDNODE

@NODE History "ScreenInWindow/Programhistory"

@{b}Release 1.0:@{ub}@{LINDENT 3}
  37.7 (22.03.95):
       Chg: Using timer.device instead of Dos.Delay() to update the window
            if its inactiv, so I can abort the delay!
  37.6 (20.03.95):
       New: 'vFac/K/N' and 'hFac/K/N' -> Factor for moving with mouse
  37.5 (18.03.95):
       New: Now you can scroll the area by moving the mouse while holding the left buton!
       New: 'InactiveUpdate/K/N' -> Update rate (1/50 secs) when window is INACTIVE, 0 = OFF
       New: 'ActiveUpdate/K/N'   -> Update rate (1/10 secs) when window is ACTIVE, 0 = OFF
  37.4 (16.03.95): Chg: Using 'idcmpUpdate' also for the props, instead of 'mouseMove'.
       New: SL=ScrLeft/K/N,ST=ScrTop/K/N
  37.3 (15.03.95):
       Chg: Using idcmpUpdate instead of gadgetDown/Up for arrow buttons.
  37.2 (13.03.95):
       Chg: 'PubScreen' is now optional, default is "Workbench"
       New: WL=WinLeft/K/N,WT=WinTop/K/N,WW=WinIWidth/K/N,WH=WinIHeight/K/N
  37.1 (12.03.95):
       It works!
  37.0 (11.03.95):
       Started.

@{b}@{u}Abbreviations:@{uu}@{ub}

  New: Something new added.
  Chg: Something has changed.
  Fix: Some bugs removed.
  Doc: Documentation changed/improved.
@ENDNODE

@NODE Me "ScreenInWindow/How to contact me?"
@{LINDENT 3}
This program was written and tested on a Amiga 4000/040 running OS3.1.
If  you  have a different system (with graphic-cards), then please write to
me if it works or not.

If  you  have  suggestions, bug reports or any question you can reach me by
the following addresses, e-mail preferred!

     Z-Netz: T.Igracki@BAMP.berlinet.in-berlin.de
     FIDO  : Thomas_Igracki%2:2410/103.40
     UseNet: lokai@cs.tu-berlin.de     -or-
             t.igracki@bamp.berlinet.in-berlin.de (preferred!)
     Mail  : Thomas Igracki, Siegener Str. 34, Germany-13583 Berlin

If you want to send me some money for my work on @{b}ScreenInWindow@{ub}, then
contact me, and I'll give you my bank-account!

Enjoy my program!
@ENDNODE