home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Workbench / Misc / WinArrange.lha / winarrange0.67beta / WinArrange_E.doc < prev    next >
Encoding:
GNU Info File  |  1995-04-10  |  12.6 KB  |  382 lines
  1. This is Info file WinArrange_E.guide, produced by Makeinfo-1.55 from
  2. the input file WinArrange_E.texi.
  3.  
  4.    Copyright 1995 Thomas Alexnat
  5.  
  6.    Full  documentation  and  hints  for WinArrange under AmigaOS.
  7. WinArrange sorts  in  many  ways Windows on a screen. (documentation
  8. for release 1.0 (Version 0.67 (02.03.95)) of WinArrange)
  9.  
  10. 
  11. File: WinArrange_E.guide,  Node: Top,  Next: Purpose,  Prev: (DIR),  Up: (DIR)
  12.  
  13.  
  14.  
  15. * Menu:
  16.  
  17. W I N A R R A N G E   ( e n g l i s h )  D O C U M E N T A T I O N
  18. ==================================================================
  19. Release of WinArrange:
  20.      1.0
  21.  
  22. WinArrange:
  23.      0.67 (02.03.95)
  24.  
  25. english documentation:
  26.      0.1 (21.02.95)
  27.  
  28. Operating system:
  29.      at least AmigaOS 2.04 (AmigaOS 3.1 is highly recommended!)
  30.  
  31.  
  32.  
  33.  
  34. Copyright (C) 1995 Thomas Alexnat
  35.  
  36. To  contact the author of all files which are involved with WinArrange (i.e.
  37. executable of WinArrange itself, the different documentations and some other
  38. relevant files), try to reach one of the following addresses:
  39.          Thomas Alexnat
  40.          Westendstrasse 7
  41.          82110 Germering (Germany)
  42.      
  43.          Fido:     2:2480/700.5
  44.          MAX:      91:5150/10.5
  45.          E-Mail:   alexnat@eikon.e-technik.tu-muenchen.de
  46.  
  47. Please read on for more information about using WinArrange.
  48.  
  49.  
  50. * Purpose::         Purpose of WinArrange
  51.  
  52. * Installation::    Installing WinArrange
  53.  
  54. * Usage::           How to handle with WinArrange
  55. * Tutorial::
  56. * Shell-Options::
  57. * Configuring::     Configure WinArrange
  58. * Hints::           Tips and Tricks
  59.  
  60. * Concept Index::   Word-Index
  61.  
  62. 
  63. File: WinArrange_E.guide,  Node: Purpose,  Next: Installation,  Prev: Top,  Up: Top
  64.  
  65. Purpose
  66. *******
  67.  
  68.    WinArrange is a small utility to rearrange your windows on the
  69. active screen.
  70.  
  71. Why WinArrange ?
  72. ================
  73.  
  74.    * In  former  days I went crazy, while sorting and arranging windows
  75.      on the  workbench  screen.  Serveral shell, editor and normal
  76.      workbench windows were  untidying  my  beautiful  workenvironment.
  77.      I wasn't really cabable of knowing  what was really going on. The
  78.      only solution for this problem was to rearrange all windows on
  79.      this screen. Unfortunally, this event took me a lot of time. After
  80.      rebooting and starting my programms my workbench was again in a
  81.      mess.  As you know time is money, I started to write this little
  82.      programm to   make  the  life  under  AmigaOS  with  Intuition
  83.      windows  and  screens peacefuller.
  84.  
  85.    * Another  important  point  is,  that I wanted to implement a
  86.      feature, which  nearly  every  operating  system should support:
  87.      The rearrangement of windows for accessing faster the applications.
  88.  
  89. What does it do ?
  90. =================
  91.  
  92.    WinArranges  has  got  the  abillity to reorganzie the windows on
  93. the active screen. This can be done in many different ways. You can
  94. cascade, shuffle or sort  the windows e.g. depending relatively on the
  95. current screen resolution or  aspect  ratio.  If  you don't want to
  96. have the windows sorted, which are owned  by the Workbench's task, you
  97. can just switch this off. Here is a list of some features:
  98.  
  99.    * * many different sorting methods: e.g. horizontal, shuffle, chess,
  100.      user-defined
  101.  
  102.    * * abillity to ignore windows for sorting (e.g. workbench window)
  103.  
  104.    * * executable since AmigaOS 2.04 (37.175)
  105.  
  106.    * * nearly all features AmigaOS provides are supported
  107.  
  108.    * * continuing support and development
  109.  
  110. 
  111. File: WinArrange_E.guide,  Node: Installation,  Next: Usage,  Prev: Purpose,  Up: Top
  112.  
  113. Installation
  114. ************
  115.  
  116.    At  first  you  must check out, which version of AmigaOS you have
  117. installed.  Ususally  it should be something like 2.1 oder higher.
  118. Otherwise update your Hardware,  to  enjoy this litte utility.
  119. Installing WinArrange is very easy.  There  are  two  possibillities
  120. of  making  WinArrange start-ready for your system:
  121.  
  122.   1. Double-click  on  the  `Install_English'  icon  (or  the desired
  123.      language).   For   novice  Users,  the  installation-script
  124.      auto-configures WinArrange.  For  detailed  information  read  the
  125.      concerning chapters. The installation-procedure will also copy
  126.      files like the onlinedocumentation and texinfofiles to the desired
  127.      directories.
  128.  
  129.   2. Expert-Users can also drop the `WinArrange' icon into the desired
  130.      drawer  of  your  workstation,  due  to the fact, that WinArrange
  131.      is not too complicated.
  132.  
  133. 
  134. File: WinArrange_E.guide,  Node: Usage,  Next: Tutorial,  Prev: Installation,  Up: Top
  135.  
  136. Usage
  137. *****
  138.  
  139.    This  chapter  will  introduce  you,  dealing with WinArrange. See
  140. these few pages  as  a  tutorial. You will learn how to start and
  141. configure WinArrange for  your  special  own  needs  and  wishes.
  142. Please make sure, that you have followed the installing instruction in
  143. the corresponding chapter and install script.
  144.  
  145. 
  146. File: WinArrange_E.guide,  Node: Tutorial
  147.  
  148. Tutorial
  149. ========
  150.  
  151.    If  you  want  a  fast image, what WinArrange can do for you, you
  152. may double click  on  the  WinArrange  icon. The default setting is,
  153. that all resizable Windows  on the active screen are sorted vertically.
  154.  
  155. Choosetype
  156. ----------
  157.  
  158.    If  you  don't want, that the WorkBench's windows (which are
  159. containing all the  icons)  are  sorted,  you  can  switch  this off by
  160. adding/changing the tooltype `CHOOSETYPE'. Changing this tooltype is
  161. very easy:
  162.  
  163.   1. Open the drawer on the WorkBench, where WinArrange is located.
  164.  
  165.   2. Select the WinArrange Icon (just click once, not twice)
  166.  
  167.   3. Hold down the menu button on your mouse (usually the right mouse
  168.      button), and select in the menu `ICON' the item `INFORMATION...'.
  169.  
  170.   4. Now you can see, if already entered, different tooltypes.
  171.  
  172.   5. Click on the line with the entry `(CHOOSETYPE=NOWB)'.
  173.  
  174.   6. Then remove the two brackets, or if the line doesn't exist, add the
  175.            tooltype `CHOOSETYPE=NOWB' also without the brackets
  176.      and save these settings.
  177.  
  178.    Now try to doubleclick on the icon. You will recognize, that
  179. WinArrange won't sort the WorkBench's windows.
  180.  
  181. Sorttype
  182. --------
  183.  
  184.    The  default sorting method of WinArrange is very boring. You can
  185. try to use another  system:  `CHESS'  --  You  have  only  to  change
  186. to tooltype `SORTTYPE'   from   `(SORTTYPE=HORIZ)'  to
  187. `SORTTYPE=CHESS'.  Please proceed in the same way a showed above.
  188.  
  189.    Now you have seen, what WinArrange can do for you. We'll start now,
  190. with the detailed documentation
  191.  
  192. 
  193. File: WinArrange_E.guide,  Node: Shell-Options
  194.  
  195. Shell-Options
  196. =============
  197.  
  198.    As you have noticed, WinArrange is able to be started via a command
  199. shell or the  AmigaOS WorkBench. At first I explain you the
  200. CLI-template-string. Open a  command  shell  and go to the directory
  201. where WinArrange is located (e.g.  double-click  the  `Shell'  Icon  in
  202. `SYS:System/'  and  type  in `CD Utilities'):
  203.  
  204.    To get the template-string(1) type the following sequence:
  205.  
  206.      `WinArrange ?' [RETURN]
  207.  
  208.    This should give you the follwing result:
  209.  
  210.      `H=Horiz/K/N,V=Vert/K/N,C=Chess/S,S=Shuffle/S,WB=WBOnly/S,NoWB/S,Min/S,Max/S:'
  211.  
  212. H=Horiz/K/N
  213.      The `Horiz' parameter requires an integer number. In other words,
  214.      it is are percentage number, which means, that in what way the
  215.      windows are expanded or shrinked horiontally.
  216.  
  217. V=Vert/K/N
  218.      Same parameters and effects like `Horiz', but the resizing affects
  219.      the vertical size.
  220.  
  221. C=Chess/S
  222.      This  is  a mutal exclude switch. All windows are sorted like a
  223.      chess table.  This  method  is  very interesting for big
  224.      resulutions and many windows. You can  keep  track  of all your
  225.      windows while seeing a part of the contents in the  windows.  The
  226.      `Horiz'  and  the  `Vert' have got the highest priority,  so  if
  227.      such  a parameter is set, the `Chess' sorting method will be
  228.      overiden by a normal `Shuffle' system.
  229.  
  230. S=Shuffle/S
  231.      This is a mutal exclude switch. The windows are here placed in a
  232.      diagonal line, beginning at the left side of the current screen.
  233.      The top side and the window step depends on the active screenfont.
  234.  
  235. WB=WBOnly/S
  236.      Using this switch will affect all windows which are owned by the
  237.      workbench task. WinArrange checks if the workbench flag is set.
  238.      Other windows are ignored. The opposite flag is `NoWB'
  239.  
  240. NoWB/S
  241.      All windows which are not owned by the wokbench are involved in
  242.      rearranging.  The opposite command is `WBOnly'.
  243.  
  244. Min/S
  245.      The  `Min' switch is some kind of a macro. It sets the `Horiz' and
  246.      `Vert'  options  to  1 percent. The `Min' command can be seen as a
  247.      global iconify option. The opposite function is `Max'
  248.  
  249. Max/S
  250.      This  option sets `Horiz' and `Vert' to the maximum. The result is
  251.      the opposite side of `Min', as described above.
  252.  
  253.    ---------- Footnotes ----------
  254.  
  255.    (1)  The template-string should help the user a  little  bit.  It
  256. displays all arguments and options, which are needed to start
  257. succsessfully a program. Usually this string can be accessed by adding
  258. a question mark ``?'' to the command.
  259.  
  260. 
  261. File: WinArrange_E.guide,  Node: Configuring
  262.  
  263. Configuring
  264. ===========
  265.  
  266.    As you have seen, WinArrange is a powerfull tool. To keep track of
  267. all windows and sorting methods, WinArrnge has got the abillity to be
  268. configured via a config-file. This  file  is  stored  in  the
  269. logically  drive  `ENV:'  and is named `WinArrange.config'.
  270.  
  271. Structure of the config-file
  272. ----------------------------
  273.  
  274.    The  config-file  uses  normal  ASCII  strings and tags and is also
  275. readable humans.   Here  follow  some  declarations  which  are  needed
  276. to  use  the config-file.
  277.  
  278. Semicolons
  279.      Semicolons  '`;''  are  treated  like  in  the  AmigaOS  shell or
  280.      Basic commands as remarks. A remark should start always at the
  281.      beginning of a new line. Multiple remarks in a line are not
  282.      allowed.
  283.  
  284. other conditions
  285.      Please note, that WinArrange hasn't got a professional config-file
  286.      parser. If something weired happens, feel free to contact me.
  287.  
  288.    To demomstrate, how the config-file works, I've included an example
  289. configuration-file.
  290.  
  291.      ; $VER: WinArrange.config 0.1 (20.07.94)
  292.      ; © 1994 by Thomas Alexnat
  293.      ;
  294.      ; This is a configfile for WinArrange
  295.      ;
  296.      ; 1.
  297.      ;   Please note, that the keyword 'configtype', is a identifier
  298.      ;   for WinArranges' configparser. It may happen, that the format
  299.      ;   of the config changes in future. At the moment, the is only existing
  300.      ;   one type: 1
  301.      ;
  302.      ; 2.
  303.      ;   Semicolons ';' are treated like in AmigaOS or Basic as remarks
  304.      ;
  305.      ; 3.
  306.      ;   It is also allowed to enter are blank line
  307.      ;
  308.      ; 4.
  309.      ;   At this point of time, you may not use linebreaks. This means, that a
  310.      ;   name has got to be at maximum, only a full line, preceeded by a normal
  311.      ;   AmigaOS linebreak command.
  312.      ;
  313.      ; 5.
  314.      ;   The config file should be plain AmigaOS-ASCII
  315.      ;
  316.      ; Thank you, for reading all this information. You may also cut out these
  317.      ; remarks for speed improvisation
  318.      
  319.      ;Global options:
  320.      WBONLY            FALSE
  321.      
  322.      
  323.      ;Now all options and patterns for the windows:
  324.      ACCEPTWINDOW        ToolmanagerDock
  325.      REJECTWINDOW        WorkBench
  326.      
  327.      ;Now all options and patterns for the tasks:
  328.      ACCEPTTASK        WorkBench
  329.      REJECTTASK        CEd
  330.  
  331. 
  332. File: WinArrange_E.guide,  Node: Hints,  Next: Concept Index,  Prev: Configuring,  Up: Top
  333.  
  334. Hints
  335. *****
  336.  
  337.    * Due to the fact, that WinArrange is not a AmigaOS Commodity, it
  338.      hasn't got the abillity to be started or activated via hotkeys. I
  339.      recommend you to assign some keys with e.g. ToolManager, DockTool.
  340.  
  341.    * WinArrange prints always his version string out. If you don't like
  342.      that, just copy the output to a file (e.g. `NIL:'). To keep in
  343.      control with your system, you may also enter something like this:
  344.      `WinArrange >LOGDIR:WinArrange.log'. If WinArrange has got some
  345.      problems, you'll see what WinArrange dumped in his logfile.
  346.  
  347. 
  348. File: WinArrange_E.guide,  Node: Concept Index,  Prev: Hints,  Up: Top
  349.  
  350. Concept Index
  351. *************
  352.  
  353. * Menu:
  354.  
  355. * Choosetype:                           Tutorial.
  356. * Configuring:                          Configuring.
  357. * fontsensitiv:                         Shell-Options.
  358. * Hints:                                Hints.
  359. * Installation:                         Installation.
  360. * Purpose:                              Purpose.
  361. * Shell-Options:                        Shell-Options.
  362. * Sorttype:                             Tutorial.
  363. * Structure of the config-file:         Configuring.
  364. * Tutorial:                             Tutorial.
  365. * Usage:                                Usage.
  366. * config-file:                          Configuring.
  367.  
  368.  
  369. 
  370. Tag Table:
  371. Node: Top331
  372. Node: Purpose1559
  373. Node: Installation3415
  374. Node: Usage4390
  375. Node: Tutorial4813
  376. Node: Shell-Options6389
  377. Node: Configuring8970
  378. Node: Hints11246
  379. Node: Concept Index11912
  380. 
  381. End Tag Table
  382.