home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 511.lha / Ruler_v5.00 / Ruler.doc.pp / Ruler.doc
Encoding:
Text File  |  1991-06-07  |  6.9 KB  |  161 lines
  1.  
  2.                  Ruler Version 5.00
  3.        ©1989, 1991 by Dave Schreiber, Chad Netzer, and Thad Floryan
  4.  
  5.      Ruler is a small utility designed to assist in the alignment or
  6. constrainment of text;    specificially, it was originally conceived as a
  7. method of insuring that filename lengths didn't exceed the maximum length
  8. allowable by the Amiga filesystem. The program opens a borderless window,
  9. initially on the Workbench screen, that displays a ruler with ticks one
  10. character (of the size of the default font) apart. The window can be moved
  11. to any position on any screen, and to any other screen currently open.    The
  12. initial size can be specified in the CLI version, as can the tick width;
  13. both can be changed once the program is running.
  14.  
  15.     There are two versions of Ruler supplied.  The first is in the CLI
  16. directory, and is meant for use from the command line.    It has the
  17. following command line options available:
  18.  
  19.      -z<size>  -- Width of the ruler, in ticks.
  20.      -s<scale> -- Width between the ruler ticks, in pixels.
  21.  
  22. Either, or both, can be specified;  neither are required.  If the scale
  23. isn't given, the width of characters in the default font is used.  If the
  24. size isn't given, the default is 30.  You can also just type the size
  25. and scale (in that order) without typing the switches.  Typing 'Ruler ?'
  26. will give you a short listing of these options.
  27.  
  28.     The second version of Ruler is in the Workbench directory.    It
  29. won't open a secondary window when from the Workbench, and since it isn't
  30. meant to be used from the command line (in fact, it will crash the machine
  31. if you run it from the CLI), it doesn't have the command line options
  32. available. You can, however, specify a default size and scale by changing
  33. the tool types within the Information requester from Workbench. To do so,
  34. click on Ruler's icon, then select "Info" or "Information" (depending on
  35. what version of Workbench you're running) from the Workbench menus.
  36.  
  37.     There are two tool types that can be edited.  To change the default
  38. size, change the number after the SIZE= tool type to reflect the desired
  39. ruler width (in ticks).  To change the default scale, put the width (in
  40. pixels) after the SCALE= tool type.  Deleting either (or both) causes Ruler
  41. to use the defaults specified two paragraphs up.
  42.  
  43.     Once you're in Ruler, there are a number of actions you can perform.
  44. Moving and sizing the window are, of course, two of those options (even
  45. though the sizing gadget is invisible;    click where it should be, and
  46. you'll be able to size as usual).  Clicking on the close gadget will
  47. cause the program to exit.
  48.  
  49.     There are four menu items that control other actions.  The Project
  50. menus has two items:  About opens a small, informational window (which can
  51. be closed by use of the close gadget on that window), and Quit will stop
  52. the program (it has the same effect as clicking on the close gadget in
  53. Ruler's main window).  The Change menus also has two choices:  Scale will
  54. let you change the current tick width. To do so, select Scale, then click
  55. on a window.  The width of the default font in that window will become the
  56. width between the ticks (NOTE:  the font in the window must not be
  57. proportional;  if it is, Ruler will print an error and refuse to change the
  58. tick width).  Finally, the Screen item will let you move Ruler's window
  59. from screen to screen;    to move the window, select the Screen item, then
  60. click on the destination screen.  The window will shrunk if necessary to
  61. fit it on that screen.
  62.  
  63.     That's it.  If you have any questions/comments/etc., please don't
  64. hestitate to get it touch with me via one of the e-mail addresses below.
  65.  
  66.                      -Dave Schreiber
  67.  
  68. The following is the revision history, compilation instructions, and e-mail
  69. addresses of the authors.  A copy of this can be found in the source code
  70. file Ruler.c.
  71.  
  72.  
  73.        Version 5.0   ??-Apr-1991  ©1991 Dave Schreiber, Chad Netzer, and
  74.                     Thad Floryan
  75.            Based upon code from:
  76.  
  77.        Version 4.0   29-Dec-1989  ©1989  Chad Netzer and Thad Floryan
  78.  
  79.            Based upon code, idea, and logic from:
  80.  
  81.        Version 1.0   7-Nov-1988   ©1988 Thad Floryan
  82.  
  83.  
  84.        Revision history:
  85.         14-April-1991 - (Ver. 5.00) (DKS):
  86.            1 Window is sized to make room for > 8 point fonts in the
  87.          title bar and main window (for compatibility with AmigaOS
  88.          2.x)
  89.            2 Added the ability to put Ruler's window on any screen at
  90.          will.
  91.            3 Added the ability to get the font scale from any window.
  92.            4 Added menus for:
  93.          * About
  94.          * Quit
  95.          * Change Screen (#2)
  96.          * Change Font (#3)
  97.          These menus are layed out by the 2.x function
  98.          LayoutMenusA().  This function is called only if Ruler
  99.          is running under 2.0 or later (i.e. Ruler is 1.3
  100.          compatible).
  101.            5 The ARP version is no longer being supported (the purpose
  102.          for the support, so as to gain access to a shared printf
  103.          function, is no longer an issue;  printfs have been
  104.          expunged from version 5.00).
  105.            6 There are, though, two versions: one for the command line,
  106.          and another for the Workbench (the Workbench version is
  107.          slightly smaller, and doesn't open a console window when
  108.          run from it's icon.
  109.  
  110.        29-December-1989 - (Ver. 4.0) - Added an offset so that you can
  111.            just stick the window on the left edge of the workbench
  112.            screen, and it will automatically be lined up with the
  113.            characters. Fixed some more minor bugs and rearranged the
  114.            code a bit. Added ARP support for those who want it. (CFN)
  115.  
  116.        09-March-1989 - (Ver. 3.1) - Fixed a visual bug so that scale can
  117.            no longer be less than eight. (CFN)
  118.  
  119.        06-Dec-1988 - (Ver. 3.0) - Added support for measuring fonts of
  120.            varying widths (selectable scale). (CFN)
  121.  
  122.        22-Nov-1988 - (Ver. 2.2) - More adjustments to code, No major
  123.            changes.  Program size is slightly smaller.  (CFN)
  124.  
  125.        14-Nov-1988 - (Ver. 2.1) - Fixed a few minor (harmless) bugs.
  126.            The right edge of the ruler is now always redrawn after
  127.            resizing. I got rid of that GOTO statement (which in 'C', is
  128.            considered a bug. :-)  Version 2.1 now lets you open a ruler
  129.            to be as low as 12 characters wide, which 2.0 only
  130.            advertised. (CFN)
  131.  
  132.        13-Nov-1988 - (Ver. 2.0) - I added minor enhancements, most
  133.            noteably, the ability to resize the window, and support for
  134.            overscanned screens.    (CFN)
  135.  
  136.  
  137.        Feel welcome to use this program for any non-commercial purposes or
  138.        for your personal learning.  Commercial users are requested to
  139.        contact Thad at either:
  140.  
  141.        UUCP:   thad@cup.portal.com (OR) ..!sun!portal!cup.portal.com!thad
  142.        BBS:    BBS-JC, 415/961-7250 (300/1200/2400), "Thad Floryan" | "SYSOP"
  143.  
  144.        Chad at:
  145.  
  146.        UUCP:   chad@ucscb.ucsc.edu     (during school term)
  147.        UUCP:   chad@cup.portal.com     (holidays, summer, etc.)
  148.        BBS:    BBS-JC, 415/961-7250 (300/1200/2400), "Chad Netzer"
  149.  
  150.        or Dave at:
  151.  
  152.        UUCP:   davids@ucscb.ucsc.edu
  153.        BBS:    BBS-JC, "Dave Schreiber"
  154.  
  155.  
  156.        Building instructions (SAS/C V5.10):
  157.  
  158.          lc -Lcd Ruler5
  159.  
  160.  
  161.