Monster Media 1994 #1

home *** CD-ROM | disk | FTP | other *** search

/ Monster Media 1994 #1 / monster.zip / monster / BBS_UTIL / FLATLINE.ZIP / FLATLINE.DOC < prev next >

Wrap

Text File | 1993-09-21 | 30KB | 721 lines

F L A T L I N E /\ _______________/ \ _________________ \ / \/ v 1 . 0 0 Copyright (c) 1993, The Thabes Co. All Rights Reserved ┌────────────────────────────────────────────────────────────────────────╖ │█▓▒░ FLATLINE v1.00 --- Copyright (c) 1993, the Thabes Co. ░▒▓█║ ╘════════════════════════════════════════════════════════════════════════╝ Giving credit where it's due: ---------------------------- The people that came up with the RIPscrip language did a very professional job. They spent a lot of time and energy developing it and a superb job documenting every aspect of it. Many thanks... RIPscrip - The "Remote Imaging Protocol" language Copyright (c) 1992-1993, TeleGrafix Communications, Inc. All Rights Reserved RIPscrip is a trademark of TeleGrafix Communications, Inc. .................................................................... CONTENTS: ======== IMPORTANT - Important information pertaining to FlatLine 2 OVERVIEW - Author's Notes . . . . . . . . . . . . . 2 REQUIRED - System Requirements . . . . . . . . . . . 2 INSTALL - Installation Notes . . . . . . . . . . . 3 REGISTRATION - Registering FlatLine . . . . . . . . . . . 3 DISCLAIMER - Protecting the Author . . . . . . . . . . 3 USAGE - Starting FlatLine . . . . . . . . . . . . 3 CONFIGURATION - FlatLine Setup . . . . . . . . . . . . . 4 USER INFO - File Path Setup and Registration Data CLEAR ALL - Starting a new file LINE STYLE - Setting the line style FILL STYLE - Setting the fill pattern CLIPBOARD - Clipboard drawing/animation {+} OBJECT EDIT - Object Browser/Editor {+} MAIN PANEL - Main Control Panel Buttons . . . . . . . . 5 TOOLS - Drawing Tools 6 TEXT PANEL - Text Control Panel . . . . . . . . . . . . 7 AREA PANEL - Creating RIP Buttons . . . . . . . . . . . 7 SUPPORT - Support Procedures . . . . . . . . . . . . 11 (FlatLine Documentation Pg. 1) .................................................................... IMPORTANT!! =========== A few important keyboard "Hot-Keys" are available yet not displayed within the FlatLine program: BACKSPACE - Undo the last action performed on the current file. ALT - While pressed, a grid is overlaid on the screen for more easily lining things up. SPACEBAR - Hides the MAIN CONTROL PANEL until pressed again. This document includes registered only features as well as the shareware version's features. Features available to registered users are denoted by - {+} .................................................................... OVERVIEW: Being a programmer by choice and profession, I like to ======== tell the computer what I WANT it to do, instead of having the computer tell me what it CAN do. As with RAMM, the RemoteAccess Menu Manager, I originally began writing FlatLine selfishly, only to help me create screens for my BBS to work with the RIPscrip protocol. I hadn't looked at another RIPscrip file editor prior to completing the first alpha version of FlatLine, so the format of FlatLine differs greatly from the established RIPscrip editing environment. This is most apparent in the use of "Word" buttons as opposed to "Icon" buttons. Icon buttons are nice in that they provide an example of the function they serve, however, selecting one icon from 40 on the screen can be a bit tedious, especially when many of the icons are similar or too small. I hope you find FlatLine as helpful as I intend it to be. .................................................................... REQUIRED: IBM 286 machine or compatible (minimum) ======== 1K Extended Memory (XMS) (minimum) MSDos 5.0 (or compatible version) (minimum) 580K Base RAM FREE (minimum) Microsoft Mouse or compatible pointing device VGA only (no EGA supported) hardware card and monitor. (FlatLine Documentation Pg. 2) .................................................................... INSTALL: To install FlatLine, copy the FLATLINE.EXE file to any ======= directory (preferably somewhere in your path). One configuration file (FLATLINE.DAT) will be created in the same directory as FLATLINE.EXE the first time you run it. This file houses the default settings to use for FlatLine (such as ICON FILE PATH, SAVE/LOAD PATH, etc.). .................................................................... USAGE: To load a RIP file from DOS, enter: FLATLINE RIPFILE ===== Where RIPFILE is the name of the RIP file to load. If you do not specify an extention, .RIP will be added for you. The file must exist in the CONFIG PANEL - USER INFO - RIP PATH setting or it will not be loaded at startup. .................................................................... REGISTRATION: FlatLine is not FreeWare! (close, but...) ============ ----------------------------------------- A lot of thought and programming time went into the FlatLine software to make it the easiest to understand yet still provide you with the most features and control over your RIPscrip files. The author grants you a limited license to use FlatLine only on a trial basis for 30 days, after which you must register the software or remove it from your system and discontiue its use. Extended features made available upon registration: -------------------------------------------------- {+} Clipboard {+} Object Browser/Editor {+} Icon Mouse and Non-Mouse Buttons {+} Button Configuration Loading/Saving To register FlatLine, please read the registration instructions in the FLATLINE.REG text file. .................................................................... DISCLAIMER: ========== FlatLine should in no way harm your computer hardware or software. At worst, you may have to reboot your system due to lockup (only if I missed checking for one of the many different scenarios that users can create). The Thabes Company, and it's affiliates both expressed and implied, are in no way responsible for any loss due to, or related to, the use or misuse of the FlatLine software. Use of FlatLine henceforth is an assent to this disclaimer. (FlatLine Documentation Pg. 3) .................................................................... CONFIG PANEL: ============ USER INFO. RIP PATH - Path [Drive:]Directory to *.RIP files --------- ICN PATH - Path [Drive:]Directory to *.ICN files USER NAME - Name of registered user. KEY-CODE - Registration Validation Key-Code. CLEAR ALL - Resets FlatLine with a new file. This will not affect --------- the current RIP file. No RIP files are touched LINE - Configures the current line style used for LINE, BOX, ---- SHAPE, and B CRV. You may select from the list of pre-set line styles, or create your own by selecting the "Other" button. FILL - Configures the current fill style used for BOX (FILL), ---- SHAPE (FILL), OVAL (FILL), and FLOOD. You may select from the list of pre-set fill styles, or create your own by selecting the "Other" button. {+} CLIPBOARD - The clipboard button will allow you to Cut and Paste --------- from and to the screen. The size of the clipboard is determined by the amount of free base memory. {+} EDIT OBJECT - The object editor/browser will let you move,edit, or ----------- delete an object previously drawn. This provides a fast, simple way to change the way something looks or works without UNDOing everything that was drawn after it. The maximum number of objects the browser can handle is 2000 (that's 2000 seperate actions per file). This may be increased in later versions depending upon its demand. MOVE - To Move an object, highlight the object and select the "move" button. Then position the highlight bar where you would like to place the object. The object will be inserted above the highlight bar. To move an object to the end of the file, move the last line up one after moving the object. KILL - Kill will delete the currently highlighted object. No prompting for confirmation will occur so make sure you have highlighted the correct object to delete. EDIT - When you select the "edit" button, the currently high- lighted object's settings will appear below the list of objects. Here you may edit the object's data. Changes will be effective upon exiting the object browser. It is recommended you save the current RIP file prior to editing in case you (or the program) makes an error. (FlatLine Documentation Pg. 4) .................................................................... MAIN PANEL: May be toggled ON/OFF by pressing the SPACEBAR. ========== QUIT - Exits FlatLine and returns you to your OS. If changes ---- have been made to the current RIP file, you will be asked whether you wish to save them to file or not. FILE - Load/Save a RIPscrip file. When loading, a list of ---- the files residing in the RIP FILE PATH (CONFIG) will be displayed. If changes have been made to the current file, you will be prompted to save them prior to loading a new file. WIN - The "win" button allows you to redefine the user's --- TEXT WINDOW. FlatLine forces the font size of the window to the 8X8 font (80 columns by 43 rows). If you notice the mouse cursor seems to jump as you move it, it is because the cursor jumps to the closest border fitting the 8X8 font. This is intentional and helps you more easily exact what the TEXT WINDOW's borders will be. HIDE - When selected, the TEXT WINDOW's border is hidden from ---- view. When creating a RIPscrip file, it is easier to work around the window when you can see it (shown as a green dashed line). TEXT - See TEXT PANEL. ---- AREA - See AREA PANEL. ---- CONFIG - See CONFIG PANEL. ------ COLOR BARS - In LINE, PLOT or BEZIER CURVE mode, the top color bar ---------- is the color to use when drawing with the left mouse button, the bottom with the right mouse button. In all other modes, the top color is the border color to draw, and the bottom is the fill color to use (if the FILLED switch is toggled on). With the FLOOD tool, the top color bar specifies the border of the fill region. Please read the explanation of the FLOOD tool for more information. FILLED - The "FILLED" toggle determines whether the BOX, OVAL, ------ or SHAPE is filled or not. If "FILLED" is on, then the drawing is filled with the current fill style. (FlatLine Documentation Pg. 5) .................................................................... ( MAIN PANEL continued... ) TOOLS - The drawing tools are on a scrollable (left and right) ----- bar. Use the RIGHT/LEFT arrow keys (or the mouse on the arrow keys) to scroll the list of tools. LINE - Press a mouse button to position the start of the line. While holding the mouse button, position the end of the line. The left mouse button will draw the line in the "LEFT" color and the right button in the "RIGHT" color. BOX - Press the left mouse button to position the start of the box (upper left corner). While holding the left mouse button, position the end of the box (lower right corner). The box will be drawn in the current border color. If FILLED is toggled on, a bar (solid box) in the current fill color will be drawn to the box's border. SHAPE - A polygon tool, press the left mouse button to position the first point of the polygon. Repeated left mouse button presses will add a new point at the current mouse location. Pressing the right mouse button will accept and draw the polygon in the current border color and (if FILLED is toggled on) the current fill color. PLOT - A putpixel tool, press a mouse button to place a pixel at the current mouse location. The left mouse button will plot the pixel in the "LEFT" color and the right button in the "RIGHT" color. FLOOD - A flood-fill tool, press the left mouse button at the position you wish to begin the flood. Be sure that the BORDER color is set to the border of the shape you wish to fill or you may have unexpected results. B. CRV - The Bezier Curve tool, press the left mouse button to position the start of the curve. While holding the left mouse button, position the end of the curve. Both endpoints of the curve may be relocated after they are initialized (first placed). Two point reference boxes will appear on the drawn line as well as the endpoint reference boxes. To move a reference, select it with the mouse cursor and reposition it while holding the button down. Experiment with this and you'll soon get the jist of what it does. Pressing the right mouse button will accept the curve currently displayed. (FlatLine Documentation Pg. 6) .................................................................... TEXT PANEL: The TEXT PANEL is used to display a line of text in a ========== specific font, size, and direction (either horizontally or vertically). This text is not necessarily displayed in/over the TEXT WINDOW (unless you force it to). FONT - There are 10 font styles to select from, plus the ---- default font used for the AREA buttons. Use the cursor keys or mouse arrow buttons to scroll the list. SIZE - The size may range from 1 to 10 (1 being the smallest). ---- It is not recommended that you use the default font at any size other than "1" (for cosmetics only) because it appears at the same resolution, even at larger sizes. VERTICAL - The text orientation, either Horizontal or Vertical, is -------- set with this switch. The default is horizontal (the vertical button is toggled OFF). Although the DEFAULT FONT in FlatLine may be displayed vertically, the RIPscrip terminal programs may not support a line of text in the DEFAULT FONT if it is displayed vertically. TEXT - Defaulting to "SAMPLE" at startup, the TEXT is the line ---- of characters to display. .................................................................... AREA PANEL: The AREA PANEL is by far the most intricate and confusing ========== of all the panels. But,it is also the most powerful use of the RIP protocol and the main reason for creating the the FlatLine program. Each AREA "button" created is displayed with the most efficient routines of the RIP protocol, making it the fastest way to put an image on your user's screen without manually drawing it. An AREA "button" may simply display a "plain" box, or, it may display a stylized icon company logo. It may be a button that performs an action (returns a valid response to the host computer), or, it may be a static (display only) button. It can have many different display configurations by using the special effects provided. For easing the use of the AREA PANEL, an example of the current configuration (other than an ICON button type) is displayed in the lower right of the panel. In this way, you may see what your user will see as you design each button. This helps when you are setting an AREA button's color scheme or its special effects configuration. (FlatLine Documentation Pg. 7) .................................................................... ( AREA PANEL continued... ) LABEL - If any, this is the text to display on the button. ----- The "Label Centering" portion of the panel determines where (in what relation to the button) the text will be placed. SEND TEXT - If any, this is the text to return to the host system --------- when the button is selected. Control characters are valid (i.e. "^M" would send a carriage return (ENTER/RETURN keypress) to the host system as if the user had pressed ENTER/RETURN). HOT-KEY - If any, this is the hot-key (non-mouse keypress) that ------- may be used to select the button. Control characters are valid (i.e. "^M" would allow the button to be selected by pressing ENTER/RETURN). ICON NAME - If the button is an {+} ICON type, this is the *.ICN --------- file to place on the button's surface. This is an easy way to paint the screen for the user (by placing icons on the screen as static (display only) buttons). LABEL CENTERING The text LABEL may be centered, forced left or --------------- right, or forced above or below the button. Centering Justification --------- ------------- ┌─┐ └─┘ ┌─┐┌─┐┌─┐ ┌─┐┌─┐┌─┐ └─┘└─┘└─┘ └─┘└─┘└─┘ L C R ┌─┐ └─┘ The LABEL Justification is only valid if the Centering toggle is Above, Center, or Below. L - Left Justified: [TEXT ] C - Centered on button: [ TEXT ] R - Right Justified: [ TEXT] If you have trouble understanding the centering process explained here, refer to the button example on the screen as you are creating a button. (FlatLine Documentation Pg. 8) .................................................................... ( AREA PANEL continued... ) SPECIAL EFFECTS: - The special effects are toggles (ON/OFF). ON is --------------- when the button is down. Beveled - Places a shaded border (Bright/Dark colors) around the perimeter of the button. Bev. Size - When "Beveled" is ON, you may set the size (thickness) of the bevel using "Bev. Size". The thickness is in pixels. Bear in mind that the size of the button is increased on each side by the size of the bevel. Chiseled - Places a chiseled rectangle (Bright/Dark colors) around the inside of the button. The distance from the sides of the buttons is determined by the width and height of the button. Sunken - Draws the border of the button as inverted (Dark/ Bright colors). Recessed - Draws an inverted (Dark/Bright colors) border around the perimeter of the button. If the button is "beveled" the border will extend to the edge of the bevel. Selected - Forces the button to be selected as the default when the user presses the ENTER/RETURN key. Underline - If the "Hot-Key" specified is found within the button's label, it will be underlined in the ULine color. Shadowed - Causes the label to cast a shadow upon the button surface. Inverted - Allows the button's colors to be inverted (reversed) when selected. Reset Win - Resets the TEXT WINDOW to full screen when the button is selected. This is handy when selecting the button sends the user to a text (ASCII/ANSI) only area of the host system. (FlatLine Documentation Pg. 9) .................................................................... ( AREA PANEL continued... ) FORCE W & H: Whenever a new button is created and placed on the ----------- screen, the button's width and height (minus the bevel and recessed borders) are stored in the button configuration. You may toggle the "FORCE W & H" to use the same value for successive buttons. Both pre-set Width and Height may be changed when the "FORCE W & H" button is ON. If the "FORCE W & H" button is OFF, when the button is placed on the actual screen, it is drawn via the "rubber-band" box (select the top-left corner of the button, then stretch the button's lower right corner to the location you wish). COLORS: Colors give the button depth, clarity, and style. ------ The light source is positioned at the upper left of the screen, so shadows are cast to the lower right and the brightest surface is that which faces the upper left. BRIGHT - This is the color where the light strikes directly. DARK - This is the color where the light doesn't strike. SURFACE - This is the main color of the button. FORE - This is the LABEL's foreground color. BACK - If "SHADOWED" is ON, this is the color of the LABEL's shadow on the surface of the button. UNDER - This is the color of the Hot-Key and/or Underline in the LABEL's text. CORNER - This is the color to place where BRIGHT meets BRIGHT and DARK meets DARK (Upper Left and Lower Right). Several illusions of depth can be created just through the use of colors. A dark SURFACE, a dark BRIGHT, and a light DARK will cause the button to appear pressed (good for outlining or defining the border of the TEXT WINDOW). The colors are set by selecting the color TYPE (Bright, Dark, etc.) and then the color VALUE (Black, Blue, Green, etc.) from the bar at the bottom of the panel. (FlatLine Documentation Pg.10) .................................................................... ( AREA PANEL continued... ) TYPES: Either PLAIN or ICON is always selected. ----- MOUSE may be ON or OFF. {+} ICON - If ICON is selected, the "ICON NAME" icon file will be used as the surface image of the button (otherwise the button is plain). PLAIN - If PLAIN is selected, the button will be drawn normally, as it appears in the AREA panel's example button ("Zzz"). MOUSE - If MOUSE is toggled ON (pressed), the button will be an ACTIVE (selectable by mouse or keyboard) button. {+} SAVE/LOAD: Up to 50 seperate button configurations may be saved --------- or loaded. This makes it easy to duplicate the same button at a later time or in a different RIP file. Use the cursor keys to highlight the button panel you wish to save/load and press RETURN/ENTER, or highlight the button panel with the mouse and then select it again (after it's highlighted) with the mouse. If you are saving a panel, you will be able to enter in a new name (up to 20 characters) for the panel as soon as it is selected. CANCEL/DONE: If you do not wish to place the button you have ----------- designed in the AREA panel, select "CANCEL". Selecting "DONE" will place you in edit mode and force you to place the button on the screen (remember, holding the ALT key will overlay a grid for lining things up, and pressing BACKSPACE will undo the last object placed on the screen). .................................................................... SUPPORT: Customer support for FlatLine is provided via modem: ======= The Thabes BBS ---------------------- 12-9600 (208)338-5145 FidoNet @1:347/21 24 hours -------------[ End of document FLATLINE.DOC Pg. 11 ]----------------