home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd2.bin / bbs / util / yass-2.3.lha / Yass / Yass.doc < prev    next >
Text File  |  1994-09-25  |  23KB  |  533 lines
  1.                             Yass V2.3 - Manual
  2.                             ~~~~~~~~~~~~~~~~~~
  3.  
  4. NAME
  5.      Yass - Yet Another Screen Selector
  6.  
  7.  
  8. DESCRIPTION
  9.      Yass is a Screen & Window-Selector Commodity for Amigas with
  10.      OS2.0 or higher. Here's a rundown of Yass' features:
  11.  
  12.      o Completely controllable via keyboard.
  13.        (of course you can use your mouse, if you really want to).
  14.  
  15.      o Shows Screens and Windows (option).
  16.  
  17.      o Shows PublicScreenname or ScreenTitle (option).
  18.  
  19.      o Ability to change the default PublicScreen.
  20.  
  21.      o Opens window even on non-public screens (option).
  22.  
  23.      o Font-sensitive.
  24.  
  25.      o Resizeable window.
  26.  
  27.      o Saves settings (position, size, hotkeys, ...) in ToolTypes
  28.  
  29.      o Nice GUI with some OS3.x features
  30.  
  31.      o Locale-support (OS2.1 + OS3.x)
  32.  
  33.      o configurable hotkeys for screens and windows
  34.  
  35.      o configurable mousebutton-popup-feature
  36.        (completely controllable via mouse)
  37.  
  38.      o Screen- and Window-shuffle via hotkeys
  39.  
  40.  
  41. COPYRIGHT
  42.      Yass is freely distributable.
  43.      Yass is free to be spread on public-domain and shareware disks
  44.      especially on Fred Fish's AmigaLibDisks, as long as they are sold 
  45.      for a reasonable charge that is less than US $6 or DM 8.- .
  46.      For use in commercial products the permission of the authors is required.
  47.      Yass may be copied and distributed via electronic networks such
  48.      as the Internet, also it may be held available on anonymous ftp-servers,
  49.      mail-boxes or BBS's.
  50.      The Copyright is still by the Author.
  51.  
  52.  
  53. AUTHOR
  54.      Albert Schweizer
  55.      Kelterstr. 9
  56.      71032 Böblingen
  57.      Germany
  58.  
  59.      e-mail: schweizr@rz.fht-esslingen.de
  60.      www:    http://www.fht-esslingen.de/~schweizr
  61.  
  62.      PS. IF YOU LIKE THIS PROGRAM, SEND ME A POSTCARD !!
  63.      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  64.  
  65.      »»»»»»»»»»»»»»»»»»»»»»»»»»«««««««««««««««««««««««««««
  66.      »»»» up to this day (September 1994) I've got    ««««
  67.      »»»» only 4 postcards/letters and some mails :-( ««««
  68.      »»»»»»»»»»»»»»»»»»»»»»»»»»«««««««««««««««««««««««««««
  69.  
  70.  
  71. REQUIREMENTS
  72.      o Any Amiga with Kickstart 2.04 (V37) or higher
  73.  
  74.  
  75. STARTING
  76.      Yass is a COMMODITY, therefore it _only_ runs under WB Release
  77.      2.0 (V37.175) and newer. A Commodity is normally started in the
  78.      "SYS:WBStartup" drawer. So it will be automatically started on the
  79.      workbench startup (LoadWB, usually in "S:Startup-Sequence").
  80.      So, just copy "Yass" and "Yass.info" to "SYS:WBStartup", or
  81.      click and move the icon to the drawer.
  82.  
  83.      To get Yass started without rebooting now, double-click the icon.
  84.      If the Tool Types weren't changed yet, a window shows up. Double-click
  85.      once more, if the window doesn't show up.
  86.  
  87.      You can start Yass from the CLI or another Shell.
  88.      (If started from CLI/shell, the 'Save Settings' feature is not available)
  89.      For example you can start Yass in the S:User-Startup:
  90.          Run >NIL: <NIL: Yass CX_POPUP=NO
  91.  
  92.  
  93. OPTIONS - TOOL TYPES
  94.      Yass knows some ToolTypes which can either be located within the 
  95.      .info file or may be issued on the command line. The syntax should 
  96.      be of the form ToolType=Value.
  97.  
  98.      Here are the ToolTypes the program recognizes.
  99.  
  100.      DONOTWAIT
  101.                  When started from WBStartup, let
  102.                  WB know that it doesn't have to wait
  103.                  for Yass.
  104.  
  105.      CX_PRIORITY=<-128 - 129>
  106.                  Priority in "commodities.library"'s queue
  107.                  Default: 0
  108.  
  109.      CX_POPUP=<YES | NO>
  110.                  When Yass is started, the Screenlist-Window may show
  111.                  up when set to 'YES' or any (!) other String than 'N*'.
  112.                  Default: YES
  113.  
  114.      CX_POPKEY=<HotKey>
  115.                  The hotkey which opens Yass' Window.
  116.                  You will get a DisplayBeep if the hotkey is not valid.
  117.                  Default: Shift Escape
  118.  
  119.      CX_MOUSEKEY=<any combination of left,right,mid or off>
  120.                  (actually you only need a combination of lovercase l,r or m)
  121.                  To turn this feature off, use 'off' as keyword. (CX_MOUSEKEY=off)
  122.                  Default: left+right mousebutton
  123.  
  124.      NEXTWIN=<HotKey>
  125.                  Hotkey for next window (windowshuffeling).
  126.                  To turn this feature off, use 'off' as hotkey. (NEXTWIN=off)
  127.                  Default: LCommand Right
  128.  
  129.      PREVWIN=<HotKey>
  130.                  Hotkey for previous window (windowshuffeling).
  131.                  To turn this feature off, use 'off' as hotkey. (PREVWIN=off)
  132.                  Default: LCommand Left
  133.  
  134.      NEXTSCR=<HotKey>
  135.                  Hotkey for next screen (screenshuffeling).
  136.                  To turn this feature off, use 'off' as hotkey. (NEXTSCR=off)
  137.                  Default: LCommand Down
  138.  
  139.      PREVSCR=<HotKey>
  140.                  Hotkey for previous screen (screenshuffeling).
  141.                  To turn this feature off, use 'off' as hotkey. (PREVSCR=off)
  142.                  Default: LCommand Up
  143.  
  144.      EXTPOPUP=<YES | NO>
  145.                  Yass' Screenlist-Window will popup on every screen
  146.                  (even on non-public screens !) when set to 'YES' or any 
  147.                  other string than 'N*'. See WARNINGS for more information.
  148.                  Will be changed by 'Save Settings'
  149.                  Default: YES
  150.  
  151.      SHOWWINDOWS=<YES | NO>
  152.                  The Screenlist will also contain windows when set 
  153.                  to 'YES' or any other string than 'N*'.
  154.                  Will be changed by 'Save Settings'
  155.                  Default: NO
  156.  
  157.      SCREENNAME=<Title | PubName>
  158.                  Show Screen-Title or PublicScreen-name (if available)
  159.                  Will be changed by 'Save Settings'
  160.                  Default: PubName
  161.  
  162.      WIDTH=<starup width>
  163.                  Yass' Screenlist-Window width at startup.
  164.                  Will be changed by 'Save Settings'
  165.                  Default: 260
  166.  
  167.      HEIGHT=<starup height>
  168.                  Yass' Screenlist-Window height at startup.
  169.                  Will be changed by 'Save Settings'
  170.                  Default: 243
  171.  
  172.      PREFEREDWINDOW=<Pattern>
  173.                  <Pattern> is a case-sensitive AmigaDOS-Pattern.
  174.                  If you select a screen with a window on it, which
  175.                  title matches <Pattern>, it will be activated.
  176.                  Default: #?Shell#?
  177.  
  178.      BACKPATTERN=<YES | NO>
  179.                  Yass' window will contain a background-pattern when
  180.                  set to 'YES' or any other string than 'N*'.
  181.                  The active-window-titlebar-color will be used to
  182.                  draw the background-pattern (use OS3.x-palette-prefs
  183.                  to change).
  184.                  Will be changed by 'Save Settings'
  185.                  Default: YES
  186.  
  187.      RENDERTYPE=<+|- [ NONE | RIDGE | BUTTON | ICONDROPBOX ]>
  188.                  Use '-' to draw BevelBoxes in recessed-mode.
  189.                  RIDGE | BUTTON | ICONDROPBOX selects rendertype for
  190.                  BevelBoxes ( OS3.x Only ).
  191.                  Use +NONE or -NONE to turn BevelBox-drawing off.
  192.                  OS2.x - BevelBoxes will always be drawn in BUTTON-look.
  193.                  (I prefer RIDGE or BUTTON, ICONDROPBOX looks ugly ;-)
  194.                  Will be changed by 'Save Settings'
  195.                  Default: +NONE
  196.  
  197.      SMARTSELECTOR=<YES | NO>
  198.                  Next screen will be the active Screenlist-item when
  199.                  set to 'YES' or any other string than 'N*'. If you don't
  200.                  like this behavior, use NO, and the actual screen will
  201.                  be the active Screenlist-item.                 
  202.                  Will be changed by 'Save Settings'
  203.                  Default: YES
  204.  
  205.      HOTKEY<num>=P(<Publicscreenname>) S(<Screenname>) W(<Windowname>) H(<HotKey>)
  206.                  <num> is the hotkeynumber. This should be 0,1,2,3, ... ,9,10, ...
  207.                  <publicscreenname>, <screenname>, <windowname> are case-sensitive
  208.                  AmigaDOS-Patterns for the desired (pub)screens and windows.
  209.                  <HotKey> is a valid CX-hotkey-description.
  210.  
  211.                  Examples: HOTKEY0=W(#?Shell#?) H(shift f1)
  212.                            HOTKEY1=P(Workbench) H(shift f2)
  213.                            HOTKEY2=P(CygnusEdScreen1) H(shift f3)
  214.                            HOTKEY3=P(DOPUS#?) H(shift f4)
  215.                            HOTKEY4=P(TERM) H(shift f5)
  216.                            HOTKEY5=S(GadToolsBox#?) H(shift f6)
  217.  
  218.  
  219. HOTKEY-PRIORITY-SCHEME
  220.  
  221.                  xx: Publicscreenname
  222.                  yy: Screenname
  223.                  zz: Windowname
  224.  
  225.                       ______________
  226.                      /              \
  227.                     /   installed    \
  228.                     \ Hotkey pressed /
  229.                      \______________/
  230.                             |
  231.                           __|__
  232.                          /     \
  233.                         / P(xx) \__________\_____
  234.                         \   ?   /      yes /     |
  235.                          \__ __/                 |
  236.                             |               _____|_____
  237.                             |              |  search   |
  238.                             |no            | for xx in |
  239.                             |              |  public-  |
  240.                            \./             |screenlist |
  241.                             |              |___________|
  242.                             |                    |
  243.                             |                 ___|___
  244.                             |                /       \
  245.                             |_________/_____/xx found \_____________
  246.                             |         \ no  \    ?    / yes         |
  247.                             |                \_______/              |
  248.                             |                                       |
  249.                             |                                       |
  250.                           __|__                                     |
  251.                          /     \                                   \./
  252.                         / S(yy) \__________\_____                   |
  253.                         \   ?   /      yes /     |                  |
  254.                          \__ __/                 |                  |
  255.                             |               _____|_____             |
  256.                             |              |  search   |            |
  257.                             |no            | for yy in |            |
  258.                             |              |  title-   |            |
  259.                            \./             |screenlist |            |
  260.                             |              |___________|            |
  261.                             |                    |                  |
  262.                             |                    |                  |
  263.                             |                 ___|___               |
  264.                             |                /       \              |
  265.                             |________/______/xx found \             |
  266.                             |        \  no  \    ?    /             |
  267.                             |                \_______/              |
  268.                             |                    |                  |
  269.                             |                   \./                 |
  270.                             |                    |                  |
  271.                             |                    |yes               |
  272.                        _____|_____          _____|_____        _____|_____
  273.                       |    no     |        | use yy as |      | use xx as |
  274.                       |  SCREEN   |        |  SCREEN   |      |  SCREEN   |
  275.                       | specified |        |___________|      |___________|
  276.                       |___________|              |                  |
  277.                             |                    |                  |
  278.                            \./                   |______/___________|
  279.                             |                    |      \
  280.                             |                    |
  281.                           __|__                __|__
  282.                          /     \              /     \
  283.             _______/____/ W(zz) \            / W(zz) \____\_________
  284.            |       \ no \   ?   /            \   ?   / no /         |
  285.            |             \__ __/              \__ __/               |
  286.            |                |                    |                  |
  287.            |                |yes                 |yes               |
  288.            |                |                    |                  |
  289.            |                |                    |                  |
  290.            |           _____|_____          _____|_____             |
  291.            |          |  search   |        |  search   |            |
  292.            |          |  window   |        |  window   |            |
  293.            |          |    zz     |        |    zz     |            |
  294.            |          |  on all   |        |  only on  |            |
  295.            |          |  screens  |        |  SCREEN   |            |
  296.            |          |___________|        |___________|            |
  297.            |                |                    |                  |
  298.            |             ___|___              ___|___               |
  299.            |            /       \            /       \              |
  300.            |______/____/zz found \          /zz found \____\________|
  301.            |      \ no \    ?    /          \    ?    / no /        |
  302.            |            \_______/            \_______/              |
  303.            |                |                    |                  |
  304.            |                |yes                 |yes               |
  305.            |                |                    |                  |
  306.       _____|_____      _____|_____          _____|_____      _______|_______
  307.      |           |    | use zz as |        | use zz as |    |     use       |
  308.      | forget it |    |  WINDOW   |        |  WINDOW   |    |PREFEREDWINDOW |
  309.      |___________|    | and set   |        |___________|    |   patttern    |
  310.            |          |  SCREEN   |              |          |_______________|
  311.            |          |___________|              |                  |
  312.            |                |                    |                  |
  313.            |                |____________________|__________________|
  314.            |                           |
  315.            |                           |
  316.            |                     ______|______
  317.            |                    |  activate   |
  318.            |                    | SCREEN and  |
  319.            |                    |   WINDOW    |
  320.            |                    |_____________|
  321.            |                           |
  322.  
  323.  
  324. USAGE
  325.      When the CX_POPUP Tooltype is set to 'YES' and Yass is being started
  326.      or when the mouse/keyboard-hotkey was pressed, the Screenlist-Window shows up.
  327.  
  328.      SCREENLIST WINDOW (V39 style):
  329.         Keys after _ are short-cuts. With them you can access the gadgets
  330.         with the keyboard w/o moving the mouse.
  331.  
  332.           +-+---------------------------+-+-+
  333.           |o| Yass <Shift Esc>          |Q|H|
  334.           +-+---------------------------+-+-+
  335.           |                                 |
  336.           | +-----------------------------+ |
  337.           | |    Screen / Window List     | |
  338.           | +---------------------------+-+ |
  339.           | |Workbench                  | | |    Use mouse or [SHIFT]+
  340.           | |  -Work 77 % voll, 43 M fre| | |    CURSOR-UP/DOWN/LEFT/RIGHT
  341.           | |  -AmigaShell              | | |    to select window/screen. 
  342.           | |CygnusEdScreen1            | | |
  343.           | |                           +-+ |
  344.           | |                           |A| |
  345.           | |                           |V| |
  346.           | +---------------------------+-+ |
  347.           |                                 |
  348.           | +-----------------------------+ |
  349.           | |   Default _PublicScreen     | |    CycleGadget:
  350.           | +---+-------------------------+ |    The value inside the
  351.           | | G |      Workbench          | |    Cycle-Gadget is set to
  352.           | +---+-------------------------+ |    the current default
  353.           |                                 |    Public screen.
  354.           | +-------+  +-------+  +-------+ |
  355.           | |_Select|  |_Window+  |_Cancel| |
  356.           | +-------+  +-------+  +-------+ |    
  357.           |                                 |
  358.           +-------------------------------+-+
  359.           |                               |/|
  360.           +-------------------------------+-+
  361.  
  362.      GADGET-KEYBOARD-CONTROL
  363.         o To select next/previous Screen/Window-List-Item use CURSOR-UP/DOWN.
  364.  
  365.         o If ShowWindows-Option is enabled use CURSOR-LEFT/RIGHT to
  366.           select next/previous Screen.
  367.  
  368.         o Press 'p' to change the default Public screen.
  369.           Use SHIFT to alter the entry in the other direction.
  370.  
  371.         o Press 's' or <return> to activate selected screen/window.
  372.  
  373.         o Press 'c' or <esc> to close the window w/o action.
  374.  
  375.         o Press 'w' or <SPACE> to show up windows of selected screen.
  376.  
  377.  
  378.      MENU ITEMS:
  379.         Menu items can also be used via the keyboard, use the shown
  380.         Command Keys.
  381.   
  382.         +---------+
  383.         | Project |
  384.         +-+-------+---------+ 
  385.           |About           ?|            Shows up the version and Copyright.
  386.           |Hide            H|            Close window.
  387.           |-----------------|
  388.           |Quit            Q|            Exit Yass.
  389.           +-----------------+      
  390.  
  391.         +-------------+
  392.         | Preferences |
  393.         +-+-----------+-----+ 
  394.           |Screenname      »|
  395.           |            +------------+   
  396.           |            |  Title    T|    Show Screentitle
  397.           |            |/ Public   P|    Show Public screen name
  398.           |            +------------+  
  399.           |/ Ext. Popup    E|            Enables extended popup-mode.
  400.           |  Show Windows  W|            Include windows in Screenlist.
  401.           |/ Smartselector M|            Use smart selection.
  402.           |/ Backpattern   B|            Draw Window-Backpattern.
  403.           |Rendertype      »|
  404.           |            +------------+
  405.           |            |/ None     N|    Don't draw textboxes.
  406.           |            |  Button   U|    use Buttonstyle
  407.           |            |  Icon     I|    use Icondropboxstyle
  408.           |            |  Ridge    R|    use Ridgestyle
  409.           |            |------------|    
  410.           |            |  Recessed D|    draw in recessed mode.
  411.           |            +------------+
  412.           |-----------------|
  413.           |Save Settings   S|            Save Settings in Icon-ToolTypes.
  414.           +-----------------+
  415.  
  416.  
  417. MOUSE-POPUP
  418.      Since V2.3 it is possible to popup Yass' ScreenList-Window by pressing
  419.      the configured combination of mousebuttons. The default mousebutton-popupkey
  420.      is left+right-mousebutton. If you don't like this feature, you can turn
  421.      it off as described above. To cancel Yass' window after using the
  422.      mousebutton-popup you can click the "Cancel" or closewindow-gadget, press
  423.      <Escape> or "c"-Key or click anywhere outside the window. 
  424.  
  425.  
  426. WARNINGS
  427.      If you use the EXTENDED POPUP-MODE, Yass will try to open its window
  428.      on every Screen (even on non-public screens). This could cause problems
  429.      if a program trys to close the screen while Yass' window is open.
  430.      It might be possible that situations emerge which confuze the OS and
  431.      lead to a software failure. 
  432.  
  433.      In other words don't experiment with it when you haven't saved that
  434.      file you are editing yet. Remember you use this at your own risk!
  435.  
  436.  
  437. TESTING
  438.      This program was developed on an A4000/040 and was tested on the 
  439.      following configurations:
  440.  
  441.      o A1000, 120 MB IDE HD, Multivision FF, 512 KB Chip-RAM and
  442.        2 MB Fast-RAM. (OS2.1 + OS3.0+)
  443.  
  444.      o A2000, '030 25MHz, 200 MB SCSI HD, oMniBus-Gfx-System, 1 MB Chip-RAM
  445.        and some MB 32Bit-Fast-RAM. (OS3.0+)
  446.  
  447.      o A3000 25MHz, 1 GB SCSI HD, oMniBus-Gfx-System, 2 MB Chip-RAM and 
  448.        some MB Fast-RAM. (OS3.0+)
  449.  
  450.      o A4000/040, 430 MB IDE HD, oMniBus-Gfx-System, 2 MB Chip-RAM 
  451.        and 16 MB Fast-RAM. (OS3.0+)
  452.  
  453.      On all these configuration the program seems to work fine, so I guess 
  454.      you can run it on almost any machine (with a bit of spare memory).
  455.  
  456.  
  457. TODO
  458.      o (external?) Preference-Editor for HotKeys and Settings (?) (request-count: 0)
  459.  
  460.      o MUI-Version ?!                                             (request-count: 1)
  461.  
  462.      o (App-)icons for screens                                    (request-count: 1)
  463.  
  464.      o Smartpointer-Option for window-selection                   (request-count: 1)
  465.  
  466.      If you have any suggestions, let me know!
  467.  
  468.  
  469. BUGS
  470.      Tell me about any you find!
  471.  
  472.  
  473. HISTORY
  474.  
  475.      V0.xß - Internal releases, for betatesters only. DON'T USE.
  476.  
  477.    + V1.0  - First Public release
  478.  
  479.      V1.1  - Fixed nasty resize-Bug
  480.            - Some internal changes
  481.  
  482.      V1.2  - PREFEREDWINDOW-Option/ToolType added
  483.  
  484.      V1.3  - New GUI
  485.            - Many internal changes
  486.            - Fixed Enforcer-hit in PREFEREDWINDOW-Option
  487.  
  488.    + V1.4  - Background-pattern added                (was) *** OS3.x only ***
  489.  
  490.      V1.5  - Improved backbround-pattern colorscheme (was) *** OS3.x only ***
  491.            - Added Save-Config feature.
  492.  
  493.      V1.6  - BACKPATTERN-Option/ToolType added       (was) *** OS3.x only ***
  494.            - RENDERTYPE-Option/ToolType added              *** OS3.x only ***
  495.  
  496.      V1.7  - Fixed Listview-Render-Bug when backpattern was active.
  497.            - Backgroundpattern / BACKPATTERN-Option now available for OS2.x
  498.  
  499.    + V2.0  - Fixed problems with public-screen-locking
  500.            - Fixed bug in POPKEY-ToolType-parsing (was introduced in V1.5)
  501.            - GUI completely rewritten
  502.            - Many internal changes
  503.            - New Feature: showing up windowlist for one screen
  504.                           (use window-gadget or <SPACE>)
  505.            - Added +/- and NONE switch to RENDERTYPE-option
  506.            - Width and Height no longer font-sensitive
  507.            - Locale-support (english + german)       *** OS2.1 + OS3.x only ***
  508.            - Inproved 'Save Settings' (now appends ToolTypes)
  509.  
  510.      V2.1  - SMARTSELECTOR-Option/ToolType added (suggested by Martin Stengle)
  511.            - français/suomi Locale-support added *** OS2.1 + OS3.x only ***
  512.  
  513.      V2.2  - (tooltype-)configurable HOTKEYS for (pub)screens and windows added
  514.            - AmigaDOS-Pattern for HOTKEY-Screen/Window-description added
  515.            - Menu-structure changed
  516.            - BACKPATTERN/RENDERTYPE-options now configurable via menu
  517.              (settings will be saved by 'Save Settings')
  518.            - français/suomi Locale-support removed
  519.              (no longer uptodate, I need new translations !)
  520.  
  521.    + V2.3  - MouseButtonPopup-feature added (suggested by Oliver Bausch)
  522.            - MBP now should support 3-button-mouse... (never tested :-)
  523.            - Window opens with active listview-element under mousepointer
  524.            - TOP/LEFT-Tooltype removed (no longer needed!)
  525.            - MBP-Inactive-close-feature added (suggested by Oliver Bausch)
  526.            - Information about installed hotkeys added (About-menue)
  527.            - Yass' own window no longer appears in windowlist
  528.            - NEXTWIN/PREVWIN added (suggested by Martin Stengle and Oliver Bausch)
  529.            - NEXTSRC/PREVSCR added
  530.  
  531. ____________
  532.  
  533.    + Vx.x = AmiNet-Release