home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / RIPSK110.ZIP / RSKETCH.DOC < prev    next >
Text File  |  1994-09-07  |  19KB  |  458 lines
  1.  
  2.                                    RIP Sketch
  3.  
  4.                                   Version 1.10
  5.  
  6.                                    Shareware
  7.  
  8.                            Copyright 1994 Wayne Thomas
  9.  
  10.  
  11.  
  12. Introduction
  13. ============
  14.  
  15.  RIP Sketch is a simple, easy to use drawing program that generates RIPscrip
  16.  files for use with online communications.  It is designed to generate very
  17.  efficient files to save on transfer time.  It supports all the basic RIP
  18.  commands and nearly all of the more complicated ones, making it very 
  19.  compatible with the RIPscrip 1.54 standard.  It supports buttons and mouse
  20.  regions, allowing you to create quality RIP menus and screens.
  21.  
  22.  RIP Sketch is also a command line viewer, with the /V command line switch,
  23.  to view one or more RIPs from the command line.
  24.  
  25.  
  26.  
  27. Requirements
  28. ============
  29.  
  30.  EGA with 256Kb video memory or better graphics.
  31.  Microsoft mouse & compatibles.   (not required for viewing)
  32.  
  33.  Recommended at least 450Kb free memory.
  34.  Also supports the Adlib sound card & compatibles.
  35.  
  36.  
  37.  
  38. Files
  39. =====
  40.  
  41.  The following files are part of the RIP Sketch package:
  42.  
  43.  RSKETCH.EXE   Main program
  44.  DISPICON.EXE  Program to display icon files
  45.  RSKETCH.DOC   This file
  46.  REGISTER.DOC  Information on how to register
  47.  HISTORY.110   Revision history information
  48.  FILE_ID.DIZ   Description of this package
  49.  
  50.  RIP Sketch will generate more files:
  51.  
  52.  RSKETCH.CFG   Configuration file
  53.  RSKETCH.REG   Registration file (if registered)
  54.  
  55.  
  56.  
  57. Quick Start
  58. ===========
  59.  
  60.  Copy all the files to a subdirectory on your hard drive, and run RSKETCH.EXE.
  61.  You will be asked to enter the name of the directory where you keep all your
  62.  icons.  (Example: c:\ripterm\icons)  You will then be asked for the maximum
  63.  line length for your saved RIP files.  (Range 39-200, the default is 79.) 
  64.  Then RIP Sketch will start up.  Use the right mouse button to toggle from 
  65.  the menu to the drawing screen.  There is a help bar at the top of the screen 
  66.  to tell you what every button does when you move the mouse cursor to it.
  67.  Please keep an eye on this help bar, because at times it will ask you for 
  68.  information that you will need to type in.  Also, pressing the F1 key will
  69.  give you additional help for keyboard options.
  70.  
  71.  Note: RIP Sketch can be executed from another drive or from the path.  It 
  72.  will know where to find the configuration file and the icon files.
  73.  
  74.  
  75.  
  76. Command line options
  77. ====================
  78.  
  79.   /Q              Quiet mode.  This will disable sound card support.
  80.   
  81.   /V[delay] file  Viewer mode.  This option allows RIP Sketch to be a command
  82.                   line viewer.  The delay ranges from 1-9 and is optional.  If
  83.                   a wildcard is used, the file name will be displayed at the
  84.                   bottom of the screen.  The default extension is .RIP
  85.  
  86.   /C              Compatibility mode.  Use this option if other RIP viewers 
  87.                   that you are using can not display the RIP files generated 
  88.                   by RIP Sketch.  Not using this switch will result in a more
  89.                   efficient and smaller RIP files.
  90.   
  91.   /NT             No text mode.  No text will be displayed in the text window 
  92.                   with this option.  Without this option, any non-RIP text
  93.                   will be displayed in the text window, if defined.
  94.  
  95.   /M              Mouse compatibility mode.  Use this option if the mouse does 
  96.                   not work properly, or if the mouse pointer is not visible.  
  97.                   If you want a plain cross-hair mouse pointer, use this 
  98.                   option.
  99.  
  100.   /L              Left hand mouse mode.  This command line option will swap 
  101.                   the functions of the left and right mouse buttons.
  102.  
  103.   /F              Flood fill mode.  This command allows you to add flood fills
  104.                   to the scene.
  105.  
  106.  Note:  A dash, '-' can be used instead of a slash, '/' and the parameters are 
  107.  not case sensitive.  If you want to always use some of the above functions,
  108.  then it is recommended to create a batch file with those desired command line
  109.  switches.
  110.  
  111.  
  112.  
  113. Disclaimer
  114. ==========
  115.  
  116.  No warranty is expressed or implied.  Use at your own risk.  The author will
  117.  not be held responsible for any damages from the use of this product.  It has
  118.  been tested on many systems without problems, but it has not or could not
  119.  have been tested on every type of system.
  120.  
  121.  
  122.  
  123. Options
  124. =======
  125.  
  126.  
  127.  Main commands
  128.  -------------
  129.  
  130.   Load:  Load a .RIP file from disk.  This button brings up a file menu that 
  131.        allows you to load RIP files.
  132.  
  133.   Save:  Save the picture as a .RIP file.  This button brings up a file menu
  134.        that allows you to save your RIP file.  There are three screen 
  135.        preparation options that allow you to clear the text window, clear the
  136.        graphics window and to remove all mouse fields.  Selecting all three
  137.        (the default) will cause RIP Sketch to use a reset windows command
  138.        instead.
  139.  
  140.   Edit:  Find, display and remove previously drawn objects.  This button will
  141.        bring up a sub menu that shows the data for the RIP commands and their
  142.        functions.  It defaults to the last function, with buttons to go the
  143.        top or the bottom command, and to step forward or backward by one 
  144.        command.  The view button will show the RIP up to that point in the RIP
  145.        scene, with the last command delayed by one half second.  The delete
  146.        button will remove the command from the RIP scene.
  147.  
  148.   Undo:  Remove all the objects that were made since you last toggled to the
  149.        menu screen, if any.
  150.  
  151.   View:  View contents of the clipboard, if any.
  152.  
  153.   Show:  Show invisible regions.  These are the mouse regions, the text viewport
  154.        and the graphic viewport.
  155.  
  156.   New:   Clear the RIP scene and start over.
  157.  
  158.   Quit:  Exit RIP Sketch and return to DOS.  Pressing Esc will also exit the
  159.        program.
  160.  
  161.   Register:  Enter registration code to register RIP Sketch.  This removes all
  162.        shareware notices and delays.
  163.  
  164.   Show X,Y:  This will display the mouse coordinates while in the drawing
  165.        screen.
  166.  
  167.   Zoom:  This will show an enlarged area from around the mouse pointer while 
  168.        in the drawing screen.
  169.  
  170.  
  171.  Draw options
  172.  ------------
  173.  
  174.   Draw color: Change the draw color to one of sixteen colors.
  175.  
  176.   Change palette:  Change the palette of the currently selected draw color.
  177.        Please note:  When clicking back to draw mode, all the palette changes
  178.        are added to the RIP scene.  If you wanted to make a color fade in or
  179.        out, you would have to click back to draw mode for every shade you
  180.        changed.
  181.  
  182.   Write mode:  Toggle the write mode from COPY to XOR (exclusive or).  In XOR
  183.        mode, the object's lines are XORed with the screen.  If you draw the
  184.        same lines over each other in XOR mode, it will make them disappear.
  185.  
  186.   Font:  Change the current font style.  There are eleven fonts.
  187.  
  188.   Font size:  Change the font size.  There are ten font sizes.
  189.  
  190.   Font direction:  Change the font direction.  There are two directions, from
  191.        left to right and from bottom to top.
  192.  
  193.   Line style:  Change the current line style.  There are five line styles
  194.        available.  The last one is the user defined line style.
  195.  
  196.   Line thickness:  Toggle the line thickness between thin and thick.
  197.  
  198.   Line pattern:  Create a user defined line pattern.
  199.  
  200.  
  201.  Fill options
  202.  ------------
  203.  
  204.   Fill style:  Change the current fill style.  There are thirteen fill styles
  205.        available.  The last one is the user defined fill pattern.  Please note
  206.        that the first (fill with background color) does not work with all
  207.        objects.
  208.  
  209.   User fill:  Set the pattern for the user fill pattern.
  210.  
  211.   Fill color:  Change the fill color to one of the sixteen colors.
  212.  
  213.  
  214.  Button options
  215.  --------------
  216.    
  217.   Chisel:  Display chisel special effect on the button.  This gives the 
  218.        impression of an indented gutter just on the inside of the button's
  219.        border.
  220.  
  221.   Bevel:  Display bevel special effect around the button.  This makes it appear
  222.        to emerge from the picture.
  223.  
  224.   Sunken:  Display sunken special effect on the button.  This places a thin
  225.        inverted bevel on the inside edge of the button, giving it a sunken
  226.        appearance.
  227.  
  228.   Mouse:  Make the button a clickable mouse region.  Without this option set, 
  229.        the button would be just for looks.
  230.  
  231.   Stamp:  Auto-stamp the button image onto the clipboard.  This will also cause
  232.        the button settings to change after the button is drawn.
  233.  
  234.   Explode:  Zoom out when the button is clicked.  This will only work if the
  235.        button is a mouse button.
  236.  
  237.   Reset:  Reset screen after the button is clicked.  This will only work if the
  238.        button is a mouse button.
  239.  
  240.   Invertible:  Invert the button when clicked.  This will only work if the
  241.        button is a mouse button.
  242.  
  243.   Recessed:  Display recessed special effect around the button.  This places a
  244.        one pixel wide bevel around the entire button image.  It is not
  245.        considered part of the button.
  246.  
  247.   Dropshadow:  Dropshadow the button label.  This will make the label appear to
  248.        have a shadow on the button.
  249.  
  250.   Underline:  Underline the hot-key in the button label.  This will only work
  251.        if the button is a mouse button.
  252.  
  253.   Highlight:  Highlight the hot-key character in the button label.  This will
  254.        only work if the button is a mouse button.
  255.  
  256.   Button type:  Select type of button, Plain, Icon or Clipboard.  The clipboard
  257.        button will only be available if there is a clipboard.
  258.  
  259.   Orientation:  Select the button label orientation.  The label can be on the
  260.        button, above, below, to the left or to the right of it.
  261.  
  262.   Color boxes:  The top four buttons select the button feature colors, while
  263.        the bottom three select the text label colors.
  264.  
  265.  
  266.  Draw commands
  267.  -------------
  268.  
  269.   Draw lines:  Uses line pattern and thickness, draw color and write mode.
  270.        Point to where you want the line to start and press the left mouse
  271.        button and hold it down to the point where you want the line to end.
  272.  
  273.   Draw connected lines:  Uses the draw color, line pattern, line thickness and
  274.        write mode.  Point to where you want the first line to start, press the
  275.        left mouse button and let go, move to where you want the first line to
  276.        end and the second line to begin.  Press the right mouse button to stop
  277.        drawing lines.
  278.  
  279.   Draw rectangles:  Uses the draw color, line pattern, line thickness and write
  280.        mode.  Point to where you want a corner of the box to be and press the
  281.        left mouse button.  Hold it down and move the mouse to where you want the
  282.        diagonally opposite corner to be and release the button.
  283.  
  284.   Draw filled rectangles:  Uses the fill pattern and color.  Works the same way
  285.        as rectangles above, except it draws solid bars.
  286.  
  287.   Draw polygons:  Uses the draw color, line pattern, line thickness and write
  288.        mode.  Works the same way as connected lines above, except that when
  289.        pressing the right mouse button, the first and last line is connected.
  290.  
  291.   Draw filled polygons:  Uses the draw color, line pattern and thickness, write
  292.        mode, fill pattern and color.  Works the same way as polygons above,
  293.        except that they are filled with the current draw color and pattern.
  294.  
  295.   Draw ovals:  Uses the draw color and line thickness.  Point to where you want
  296.        the center of the oval, hold down the left mouse button and move the
  297.        mouse to create the desired oval size and shape.
  298.  
  299.   Draw filled ovals:  Uses the draw color, line thickness, fill pattern and
  300.        color.  Works the same way as ovals above, except that they are filled
  301.        with the current draw color and pattern.
  302.  
  303.   Draw circles:  Uses the draw color and line thickness.  Works the same way
  304.        as ovals above.
  305.  
  306.   Draw filled circles:  Uses the draw color, line thickness, fill pattern and
  307.        color.  Works the same way as filled ovals above.
  308.  
  309.   Draw circular arcs:  Uses the draw color and line thickness.  First, draw a
  310.        circle, then after releasing the left mouse button, choose the start
  311.        angle for the arc, then press the left mouse button.  Next, choose the
  312.        ending angle for the arc.  The arc is drawn counter clockwise.
  313.  
  314.   Draw circular pie slices:  Uses the draw color, line thickness, pattern
  315.        fill color and pattern.  Works the same way as circular arcs above,
  316.        except that it is filled with the fill color and pattern to make a pie
  317.        slice.  It will be split from the right side.  (No start and ending
  318.        angle).
  319.  
  320.   Draw oval arcs:  Uses the draw color and line thickness.  Works the same way
  321.        as circular arcs above.
  322.  
  323.   Draw oval pie slices:  Uses the draw color, line thickness and pattern, fill
  324.        color and pattern.   Works the same way as circular pie slices above.
  325.  
  326.   Draw single dots:  Uses the draw color.  When the left mouse button is
  327.        pressed, a single pixel will appear in the center of the box.
  328.  
  329.   Draw smooth curves:  Uses the draw color, line thickness, line pattern and
  330.        the write mode.  First draw the curve like a line, then four boxes will
  331.        appear on it.  By moving the mouse cursor inside the boxes and pressing
  332.        the left mouse button, you can move them to change the shape of the
  333.        curve.  The two middle boxes can be moved off the curve to make it
  334.        bend.  If the curve becomes obstructed by the boxes, press the space 
  335.        bar to temporarily hide them.  Press the right mouse button to draw the 
  336.        curve.  Curve smoothness is automatically adjusted for each curve.
  337.  
  338.   Display text:  Uses the font, font size and direction.  When clicking this
  339.        option, you are asked what text you want to use.  A box will appear
  340.        when the left mouse button is pressed.  You can move the box to where
  341.        you want and let go of the button to put the text where the box is.
  342.  
  343.   Filled poly-bezier:  Uses the draw color, line pattern and thickness, write
  344.        mode, fill pattern and color.  Works the same way as filled polygons 
  345.        above, except that the space bar or the middle mouse button toggles the 
  346.        curve functions on and off.  This command is not available with the /F
  347.        command line option.
  348.  
  349.   Flood fill:  Uses the fill color and pattern.  The fill will start where
  350.        the mouse cursor is and fill up everything to the currently selected
  351.        draw color.  This command is only available with the /F command line
  352.        option.  This drawing command will not be processed by programs that
  353.        use RIPscrip 2.0 and later versions.
  354.  
  355.  
  356.  Area commands
  357.  -------------
  358.  
  359.   Graphic viewport:  This box defines the area in which all graphics are to be
  360.        displayed.  Pressing the right mouse button defaults it to the full
  361.        screen.
  362.  
  363.   Text viewport:  This box defines the area in which all text from the host is
  364.        to be displayed.  There are five screen resolutions to choose from.
  365.        The text can either wrap to the next line, or be chopped off at the end
  366.        of the line.
  367.  
  368.   Copy to clipboard:  This command takes an area of the screen and copies it
  369.        to the clipboard.
  370.  
  371.   Paste clipboard:   This command takes the clipboard and pastes it to the
  372.        screen.  There are five write modes to choose from.
  373.  
  374.   Load icon:  This command loads a icon from the disk and pastes it to the
  375.        screen.  There are five write modes to choose from.  It first searches
  376.        the directory where RIP Sketch was run for the icon file, then searches
  377.        the directory where you keep your icons.
  378.  
  379.   Save icon:  This command saves the clipboard as an icon.  It is saved in the
  380.        directory where RIP Sketch was run.  On the users terminal, it will also
  381.        be saved in an appropriate subdirectory.
  382.  
  383.   Mouse region:  This command creates a hot mouse region.  When the user clicks
  384.        the left mouse button while in this area, the text specified will be
  385.        transmitted to the host.  The area can be inverted when clicked.  The
  386.        text window and screen can be reset.  You can use a caret to represent
  387.        control codes.  For example, ^M will be a carriage return.
  388.  
  389.   Button:  This command will create a button using the current button settings.  
  390.        This command also uses the current font and font size.
  391.  
  392.   Import text:  This command will allow you to load text from a file and place
  393.        it on the screen in a rectangular area, using the current font and 
  394.        font size.
  395.  
  396.   Copy region:  This command copies a large (or small) area of the screen
  397.        either up or down very quickly, without using the clipboard.
  398.         
  399.           
  400.  Other commands
  401.  --------------
  402.  
  403.   Add sound:  This command will add one of six RIP sound effects to the 
  404.        current point in the RIP file.
  405.  
  406.  
  407.  
  408. Troubleshooting
  409. ===============
  410.  
  411.  There has been some problems reported with RIP Sketch and some mice.  The
  412.  problem may be corrected with the /M command line switch.  If this does not
  413.  cause RIP Sketch to work with your mouse, see if you can find an updated
  414.  mouse driver.  If your mouse is hardware compatible with a Microsoft mouse, 
  415.  then try using MOUSE.COM that comes with DOS 6.  If none of the above works,
  416.  then you may still use RIP Sketch as a RIP command line viewer, because for
  417.  viewing, it does not require or use a mouse.
  418.  
  419.  
  420.  
  421. Registration
  422. ============
  423.  
  424.  RIP Sketch is shareware.  Please support this product by filling out
  425.  REGISTER.DOC and mailing it with a check or money order for $15.
  426.  You will receive a registration code that will remove the registration
  427.  delays and messages.  This code will work for future versions of RIP
  428.  Sketch.
  429.  
  430.  
  431.  
  432. Contacting the author
  433. =====================
  434.  
  435.  I can be reached with a public message in the RIP conference in the following
  436.  nets: RIME, Intelec, ILink, PlanoNet.  I can also be reached at the Brewster 
  437.  BBS, (914) 279-2514.  The latest versions of RIP Sketch will be uploaded 
  438.  there as soon as they become available.
  439.  
  440.  Also by the author:  Freeview, a freeware *.RIP file viewer.
  441.  
  442.  
  443.  
  444. Coming soon!
  445. ============
  446.  
  447.  - ANSI in the text window
  448.  - More button options
  449.  - Object editor
  450.  - Icon editor
  451.  
  452.  
  453.  
  454. Trademarks
  455. ==========
  456.  
  457.  RIPscrip and RIPterm are trademarks of TeleGrafix Communications, Inc.
  458.