home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / amigalib / d983 / yass.lha / Yass / Yass.doc < prev    next >
Encoding:
Text File  |  1994-04-05  |  11.7 KB  |  324 lines
  1.                             Yass V2.0 - Manual
  2.                             ~~~~~~~~~~~~~~~~~~
  3.  
  4. NAME
  5.      Yass - Yet Another Screen Selector
  6.  
  7.  
  8. DESCRIPTION
  9.      Yass is a (new) 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, ...) in ToolTypes
  28.  
  29.      o Nice GUI with some OS3.x features
  30.  
  31.      o Locale-support (OS2.1 + OS3.x)
  32.  
  33.  
  34. COPYRIGHT
  35.      Yass is freely distributable.
  36.      Yass is free to be spread on public-domain and shareware disks
  37.      especially on Fred Fish's AmigaLibDisks, as long as they are sold 
  38.      for a reasonable charge that is less than US $6 or DM 8.- .
  39.      For use in commercial products the permission of the authors is required.
  40.      Yass may be copied and distributed via electronic networks such
  41.      as the Internet, also it may be held available on anonymous ftp-servers,
  42.      mail-boxes or BBS's.
  43.      The Copyright is still by the Author.
  44.  
  45.  
  46. AUTHOR
  47.      Albert Schweizer
  48.      Kelterstr. 9
  49.      71032 Böblingen
  50.      Germany
  51.  
  52.      Internet: schweizr@rz.fht-esslingen.de
  53.  
  54.      PS. IF YOU LIKE THIS PROGRAM A LOT, SEND ME A POSTCARD !!
  55.      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56.  
  57.  
  58. REQUIREMENTS
  59.      o Any Amiga with Kickstart 2.04 (V37) or higher
  60.  
  61.  
  62. STARTING
  63.      Yass is a COMMODITY, therefore it _only_ runs under WB Release
  64.      2.0 (V37.175) and newer. A Commodity is normally started in the
  65.      "SYS:WBStartup" drawer. So it will be automatically started on the
  66.      workbench startup (LoadWB, usually in "S:Startup-Sequence").
  67.      So, just copy "Yass" and "Yass.info" to "SYS:WBStartup", or
  68.      click and move the icon to the drawer.
  69.  
  70.      To get Yass started without rebooting now, double-click the icon.
  71.      If the Tool Types weren't changed yet, a window shows up. Double-click
  72.      once more, if the window doesn't show up.
  73.  
  74.      You can start Yass from the CLI or another Shell.
  75.      (If started from CLI/shell, the 'Save Settings' feature is not available)
  76.      For example you can start Yass in the S:User-Startup:
  77.          Run >NIL: <NIL: Yass CX_POPUP=NO
  78.  
  79.  
  80. OPTIONS - TOOL TYPES
  81.      Yass knows some ToolTypes which can either be located within the 
  82.      .info file or may be issued on the command line. The syntax should 
  83.      be of the form ToolType=Value.
  84.  
  85.      Here are the ToolTypes the program recognizes.
  86.  
  87.      DONOTWAIT
  88.                  When started from WBStartup, let
  89.                  WB know that it doesn't have to wait
  90.                  for Yass.
  91.  
  92.      CX_PRIORITY=<-128 - 129>
  93.                  Priority in "commodities.library"'s queue
  94.                  Default: 0
  95.  
  96.      CX_POPUP=<YES | NO>
  97.                  When Yass is started, the Screenlist-Window may show
  98.                  up when set to 'YES' or any (!) other String than 'N*'.
  99.                  Default: YES
  100.  
  101.      CX_POPKEY=<HotKey>
  102.                  The hotkey which opens Yass' Window.
  103.                  You will get a DisplayBeep if the hotkey is not valid.
  104.                  Default: Shift Escape
  105.  
  106.      EXTPOPUP=<YES | NO>
  107.                  Yass' Screenlist-Window will popup on every screen
  108.                  (even on non-public screens !) when set to 'YES' or any 
  109.                  other string than 'N*'. See WARNINGS for more information.
  110.                  Will be changed by 'Save Settings'
  111.                  Default: YES
  112.  
  113.      SHOWWINDOWS=<YES | NO>
  114.                  The Screenlist will also contain windows when set 
  115.                  to 'YES' or any other string than 'N*'.
  116.                  Will be changed by 'Save Settings'
  117.                  Default: NO
  118.  
  119.      SCREENNAME=<Title | PubName>
  120.                  Show Screen-Title or PublicScreen-name (if available)
  121.                  Will be changed by 'Save Settings'
  122.                  Default: PubName
  123.  
  124.      LEFT=<startup X-position>
  125.                  Yass' Screenlist-Window x-position at startup.
  126.                  Will be changed by 'Save Settings'
  127.                  Default: 100
  128.  
  129.      TOP=<starup Y-position>
  130.                  Yass' Screenlist-Window y-position at startup.
  131.                  Will be changed by 'Save Settings'
  132.                  Default: 100
  133.  
  134.      WIDTH=<starup width>
  135.                  Yass' Screenlist-Window width at startup.
  136.                  Will be changed by 'Save Settings'
  137.                  Default: 260
  138.  
  139.      HEIGHT=<starup height>
  140.                  Yass' Screenlist-Window height at startup.
  141.                  Will be changed by 'Save Settings'
  142.                  Default: 243
  143.  
  144.      PREFEREDWINDOW=<Pattern>
  145.                  <Pattern> is a case-sensitive AmigaDOS-Pattern.
  146.                  If you select a screen with a window on it, which
  147.                  title matches <Pattern>, it will be activated.
  148.                  Default: #?Shell#?
  149.  
  150.      BACKPATTERN=<YES | NO>
  151.                  Yass' window will contain a background-pattern when
  152.                  set to 'YES' or any other string than 'N*'.
  153.                  The active-window-titlebar-color will be used to
  154.                  draw the background-pattern (use OS3.x-palette-prefs
  155.                  to change).
  156.                  Default: YES
  157.  
  158.      RENDERTYPE=<+|- [ NONE | RIDGE | BUTTON | ICONDROPBOX ]>
  159.                  Use '-' to draw BevelBoxes in recessed-mode.
  160.                  RIDGE | BUTTON | ICONDROPBOX selects rendertype for
  161.                  BevelBoxes ( OS3.x Only ).
  162.                  Use +NONE or -NONE to turn BevelBox-drawing off.
  163.                  OS2.x - BevelBoxes will always be drawn in BUTTON-look.
  164.                  (I prefer RIDGE or BUTTON, ICONDROPBOX looks ugly ;-)
  165.                  Default: +RIDGE
  166.  
  167.  
  168. USAGE
  169.      When the CX_POPUP Tooltype is set to 'YES' and Yass is being started
  170.      or when the hot key was pressed, the Screenlist-Window shows up.
  171.  
  172.      SCREENLIST WINDOW (V39 style):
  173.         Keys after _ are short-cuts. With them you can access the gadgets
  174.         with the keyboard w/o moving the mouse.
  175.  
  176.           +-+---------------------------+-+-+
  177.           |o| Yass <Shift Esc>          |Q|H|
  178.           +-+---------------------------+-+-+
  179.           |                                 |
  180.           | +-----------------------------+ |
  181.           | |    Screen / Window List     | |
  182.           | +---------------------------+-+ |
  183.           | |Workbench                  | | |    Use mouse or [SHIFT]+
  184.           | |  -Work 77 % voll, 43 M fre| | |    CURSOR-UP/DOWN/LEFT/RIGHT
  185.           | |  -AmigaShell              | | |    to select window/screen. 
  186.           | |CygnusEdScreen1            | | |
  187.           | |                           +-+ |
  188.           | |                           |A| |
  189.           | |                           |V| |
  190.           | +---------------------------+-+ |
  191.           |                                 |
  192.           | +-----------------------------+ |
  193.           | |   Default _PublicScreen     | |    CycleGadget:
  194.           | +---+-------------------------+ |    The value inside the
  195.           | | G |      Workbench          | |    Cycle-Gadget is set to
  196.           | +---+-------------------------+ |    the current default
  197.           |                                 |    Public screen.
  198.           | +-------+  +-------+  +-------+ |
  199.           | |_Select|  |_Window+  |_Cancel| |
  200.           | +-------+  +-------+  +-------+ |    
  201.           |                                 |
  202.           +-------------------------------+-+
  203.           |                               |/|
  204.           +-------------------------------+-+
  205.  
  206.      GADGET-KEYBOARD-CONTROL
  207.         o To select next/previous Screen/Window-List-Item use CURSOR-UP/DOWN.
  208.  
  209.         o If ShowWindows-Option is enabled use CURSOR-LEFT/RIGHT to
  210.           select next/previous Screen.
  211.  
  212.         o Press 'p' to change the default Public screen.
  213.           Use SHIFT to alter the entry in the other direction.
  214.  
  215.         o Press 's' or <return> to activate selected screen/window.
  216.  
  217.         o Press 'c' or <esc> to close the window w/o action.
  218.  
  219.         o Press 'w' or <SPACE> to show up windows of selected screen.
  220.  
  221.  
  222.      MENU ITEMS:
  223.         Menu items can also be used via the keyboard, use the shown
  224.         Command Keys.
  225.   
  226.         +---------+
  227.         | Project |
  228.         +-+-------+---------+ 
  229.           |Screenname      »|
  230.           |            +------------+   
  231.           |            |  Title    T|    Show Screentitle
  232.           |            |/ Public   P|    Show Public screen name
  233.           |            +------------+  
  234.           |/ Ext. Popup    E|            Enables extended popup-mode.
  235.           |  Show Windows  W|            Include windows in Screenlist.
  236.           |Save Settings   S|            Save Settings in Icon-ToolTypes.
  237.           |-----------------|
  238.           |About           ?|            Shows up the version and Copyright.
  239.           |-----------------|
  240.           |Quit            Q|            Exit Yass.
  241.           +-----------------+      
  242.  
  243.  
  244. WARNINGS
  245.      If you use the EXTENDED POPUP-MODE, Yass will try to open its window
  246.      on every Screen (even on non-public screens). This could cause problems
  247.      if a program trys to close the screen while Yass' window is open.
  248.      It might be possible that situations emerge which confuze the OS and
  249.      lead to a software failure. 
  250.  
  251.      In other words don't experiment with it when you haven't saved that
  252.      file you are editing yet. Remember you use this at your own risk!
  253.  
  254.  
  255. TESTING
  256.      This program was developed on an A4000/040 and was tested on the 
  257.      following configurations:
  258.  
  259.      o A1000, 120 MB IDE HD, Multivision FF, 512 KB Chip-RAM and
  260.        2 MB Fast-RAM. (OS2.1 + OS3.0+)
  261.  
  262.      o A2000, '030 25MHz, 200 MB SCSI HD, oMniBus-Gfx-System, 1 MB Chip-RAM
  263.        and some MB 32Bit-Fast-RAM. (OS3.0+)
  264.  
  265.      o A3000 25MHz, 1 GB SCSI HD, oMniBus-Gfx-System, 2 MB Chip-RAM and 
  266.        some MB Fast-RAM. (OS3.0+)
  267.  
  268.      o A4000/040, 2 x 170MB IDE HDs, oMniBus-Gfx-System, 2 MB Chip-RAM 
  269.        and 12 MB Fast-RAM. (OS3.0+)
  270.  
  271.      On all these configuration the program seems to work fine, so I guess 
  272.      you can run it on almost any machine (with a bit of spare memory).
  273.  
  274.  
  275. TODO
  276.      o Hotkeys for screens
  277.  
  278.      o MUI-Version ?!
  279.  
  280.      o Smartpointer-Option for window-selection
  281.  
  282.      If you have any suggestions, let me know!
  283.  
  284.  
  285. BUGS
  286.      Tell me about any you find!
  287.  
  288.  
  289. RELEASE NOTES
  290.      V0.xß - Internal releases, for betatesters only. DON'T USE.
  291.  
  292.      V1.0  - First Public release
  293.  
  294.      V1.1  - Fixed nasty resize-Bug
  295.            - Some internal changes
  296.  
  297.      V1.2  - PREFEREDWINDOW-Option/ToolType added
  298.  
  299.      V1.3  - New GUI
  300.            - Many internal changes
  301.            - Fixed Enforcer-hit in PREFEREDWINDOW-Option
  302.  
  303.      V1.4  - Background-pattern added                (was) *** OS3.x only ***
  304.  
  305.      V1.5  - Improved backbround-pattern colorscheme (was) *** OS3.x only ***
  306.            - Added Save-Config feature.
  307.  
  308.      V1.6  - BACKPATTERN-Option/ToolType added       (was) *** OS3.x only ***
  309.            - RENDERTYPE-Option/ToolType added              *** OS3.x only ***
  310.  
  311.      V1.7  - Fixed Listview-Render-Bug when backpattern was active.
  312.            - Backgroundpattern / BACKPATTERN-Option now available for OS2.x
  313.  
  314.      V2.0  - Fixed problems with public-screen-locking
  315.            - Fixed bug in POPKEY-ToolType-parsing (was introduced in V1.5)
  316.            - GUI completely rewritten
  317.            - Many internal changes
  318.            - New Feature: showing up windowlist for one screen
  319.                           (use window-gadget or <SPACE>)
  320.            - Added +/- and NONE switch to RENDERTYPE-option
  321.            - Width and Height no longer font-sensitive
  322.            - Locale-support (english + german)     *** OS2.1 + OS3.x only ***
  323.            - Inproved 'Save Settings' (now appends ToolTypes)
  324.