Beijing Paradise BBS Backup

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

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RATE10.ZIP / RATE.DOC < prev next >

Wrap

Text File | 1993-07-25 | 39.8 KB | 866 lines

▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ───▒▒█▀▒▒█──────▒▒█▀▒▒█───────▀▀▒▒█▀▀▀──────▒▒█▀▀▀▀───── ───▒▒▒▒▒▒█──────▒▒▒▒▒▒█─────────▒▒█─────────▒▒▒▒▄──────Version 1.0───── ───▒▒█▒▒█▀──────▒▒█▀▒▒█─────────▒▒█─────────▒▒█▀▀─────── ▒▒█ ▒▒█ ▒▒█ ▒▒█ ▒▒█ ▒▒▒▒▒▒▄ ▀▀ ▀▀ ▀▀ ▀▀ ▀▀ ▀▀▀▀▀▀ RaLin Ansi Text Editor - Remote Access Version - (C) Copyright 1993 Rand Nowell - RaLin Enterprises "Putting Bits Together" (tm) - ALL RIGHTS RESERVED - P R O G R A M D O C U M E N T A T I O N July 1993 RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 1 ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ LEGAL STUFF ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Rather than put this in each of the four manuals, this information, LEGAL, COPYRIGHT, LICENSE etc has been placed in a separate file. "PLEASE" read LEGAL.DOC ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ SYSTEM REQUIREMENTS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ You should have a system with 640K base memory, with 200K available. RCC will recognize and use, EMS or XMS memory during swaps to Shell and external programs. When doing so RATE releases all but 8K of memory which it retains. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ READ THIS !! ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ A temporary REGISTERED keyfile has been provided to allow you to try ALL the registered features. Once this key file expires, access will be as UNREGISTERED, and any limits, or Registered only functions will apply! *** The DEMO key expires September 1, 1993 *** The DEMO key is named TRIAL.KEY, rename it to RATE.KEY, and place in the same directory as RATE.EXE and RCC.EXE ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ FEATURES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ There are two additional features that will be activated once RATE is Registered, they are the High Ascii Chart, and the Calendar. These items are marked with {+} in this manual, and also in the Help file. If you press the Key Command for these items, a dialog box will pop up and advise you of this fact. The size of the file you may create/modify is smaller in the UnRegistered version too, see FILE SIZE below. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ WHERE TO PUT RATE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ RATE, the editor, and all other parts of the package, RCC,T2A,T2AVIEW MUST be placed in a directory that is in the DOS PATH statement, in your AUTOEXEC.BAT file. If not done, they will not always work correctly. This includes the help file, RATE.HLP. And possibly the configuration file, RATEINT.CFG (see Configuration below) Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 2 If you wish to place then in a directory of their own, you may, but be sure to add that directory to your PATH statement. The programs need to be able to find each other, no matter where they are working at on your drive. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ OVERVIEW ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ RATE allows you to create or modify a text file, generating a "Template File" which is then compiled into screens in ANSI, AVATAR and ASCII format which may be displayed in DOS or as BBS screens. This compiling is done by our screen compiler T2A.EXE, included in this package. This version for RemoteAccess BBS, contains popup lists, from which you can paste compiler codes into text. When these compiler codes are processed, by T2A, the screen compiler, they are transformed into the proper BBS codes for names, dates, and other BBS system variables. You can also paste in codes for color, these are written in the proper format for ANSI or AVATAR when the screens are created. Of course, no color codes are written to the ASCII screen file. These "template files" that are created with RATE, are useless as DOS or BBS screens until they have been compiled, then you can save the template for future modifications, or delete it. RATE uses, along with the popup pasting lists, Wordstar type command keys, and function keys, to carry out your commands. Some of the features are: Block Commands: Copy Block, Move Block, Write Block, Hide Block, Delete Block. File Commands: Save and Continue, Load New File, Read in a File, ZAP current text and restart, Change filename and more! RATE also allows you to resize and move its window. This window size and location is not saved in the configuration file. The reason for this, is if you run the editor in 43/50 line mode, resize the screen and exit, that window setting is saved. Now lets say you start up in 25 line mode next time, the window will be trashed, because RATE has tried to set it the way the config file says, which was in a different video mode. It can be fixed by re-sizing the screen again, but its not worth all the extra hassle, so we de-activated saving the window settings. Should we get a chance to modify the code to recognize the video mode, in relation to what the config file says, we may add that back in. When you desire to load a new file, you can enter one asterisk (*) which will display a list of all .T2A template files, OR *.* to list ALL available files in the directory. The dialog box that prompts for a new Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 3 file, will display the current file, any keypress blanks the field and accepts what you enter. MOUSE: RATE supports a mouse, if present, for many of the movement commands, and selections from lists. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ NUMBER LOCK SETTING ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The status of your NumLock key affects the way your arrow keys will work. We will assume you have an enhanced keyboard with 101+ keys. If the NumLock key is ON, you can only use the arrow keys (2,4,6,8) on the numeric keypad. The enhanced keyboard arrow key pad will not work. If the NumLock is OFF, you can use both sets of keys. Suggestion: Turn off the NumLock! ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ RUNNING THE EDITOR ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ COMMAND LINE USE: If you are running RATE from the command line, you can specify a filename, if the file does not exist, it will be loaded as a "New File", to create a new file, you do not need to give an extension, RATE will add the .T2A one if none is given, typing RATE NEWBBS will start the editor in NEw File mode, creating NEWBBS.T2A. if no filename is given, RATE will present a filelist from which you may select a file to edit. The filelist presented is filtered to only display T2A files. If you want a list of all files, type RATE *.*, or *.TXT, *.ASC etc. the editor will load, and display a list of all files matching the given file spec. You can specify a startup directory when you call RATE, it will change to that directory and display a list of template files. Upon exit, RATE will return to the directory you were in when you called it. If a filename is given with the directory, then RATE will load that file, and place you in edit mode. Or you can use *.* for the filename for a list of all files in that directory. When specifying a filename, if the file has a .T2A extension, you need not give the extension on the command line. If the name you specify does not exist with the extension of .T2A, then the editor will be more than willing to help you create one. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ FROM THE COMMAND CENTER ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 4 If you are running RATE from the command center, everything is handled for you, please refer to RCC.DOC. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ PICKLIST CHOOSING ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Load the file by selecting and pressing ENTER, or double clicking the left mouse button, when the mouse cursor is on the filename. You can scroll through the list with UpArrow, DnArrow, PgDn, PgUp, Home, End. If more files exist than can be displayed, direction arrows will show in the lower right corner, placing the mouse cursor on these and pressing the left button, will scroll the list ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ FILE SIZE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The EVALUATION copy will only allow the creation or modification of a file of up to 30 lines of text. The REGISTERED version will allow up to 1024 lines of text, about 17 pages of 60 lines per page text. When the configuration program is completed, you will be able to configure the editor to allow up to 16000 lines of text. All Registered users will receive the configuration update FREE. But the evaluation copy "is limited" to 30 lines. If you attempt to load a larger file, a dialog box will inform you of this limit, then load 30 lines in. The same thing happens if you try to create a file longer than 30 lines. Though the file size is somewhat limited, it will still allow you to create Menu type screens, and a text file longer than one page, so you can test the Pause, WaitForCR etc. I regret the necessity of this limitation, but....... The editor is the only one with any limits, or features/functions that do not work in UnRegistered mode. RCC,T2A,T2AVIEW are all the same as if registered, other than an occasional registration message. Once you receive your KEY file, there will be no limits, all functions will be activated, and no more Registration reminders. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ ONLINE HELP ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Help is available with the F1 key. This presents a Topic Menu, select the topic, and a screen will be displayed. Functions that only work in Registered Mode are marked with {+} The Help file is a plain ASCII text file named RATE.HLP. It may be Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 5 edited if you wish, but be sure to not remove any command listings. You can add a separate section for your own information if you want. The Topic menu has an item, Making your own Help, which explains a bit about it. Lines beginning with an asterisk (*) will be displayed in the menu. A number sign (#) is used to mark the end of the screen. Use the existing format to figure out the screen size you need to follow. If you design your own Help file, the next time you run the editor, you can press Shift-F1 and specify the name of your file. It will be saved in the config file, and the next time you run the editor, in the directory where that config file was saved, your help file will become the default for that session. (See CONFIGURATION below) You can have a different Help file in every directory, or just maintain one. With only one, make sure it is in a directory where RATE can find it, no matter where on your drive its working at. Make heavy use of the F1 key as you learn RATE. HELP REFERENCE SHEET: If you would like a reference sheet, simply print out the RATE.HLP file, and you will have a guide to refer to without calling the help file. IMPORTANT! The file RATE.HLP must be where RATE can find it, in the current directory or a PATH directory. All Editing Commands, Function Keys, Menu Keys are listed in RATE.HLP, make a backup of this file! ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ MENUS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ There are several menus presented in RATE during the course of inserting BBS codes etc. There is also a Calendar available, these are all assigned to a Command Key Set, and are listed below. All the below menus and picklists are ALSO available via a MAIN menu. This menu is accessed in one of two ways. Press Ctl-F1 or your RIGHT mouse button. This will display the 'MOUSE MENU', selections are made the same as any other menu. There are actually two MOUSE menus, the one that shows in UnRegistered Mode does not have the Calendar or High Ascii menu options. Once RATE is registered, these items will be included. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ A NOTE ON CODES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 6 The codes that are placed in your text while in the editor, are "Compiler Codes", if you were to try and display the *.T2A template file on your BBS, or from the command prompt, you would get just what you see in the editor. Your template file must be run through the screen compiler T2A.EXE to generate a finished product. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ BBS VARIABLES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Menu Selections are made by: 1. Placing the highlight bar on choice and pressing ENTER. 2. Clicking the left mouse button on the choice. 3. Pressing the highlighted letter of the choice. Picklist Selections are made by: 1. Placing the highlight bar an the file name and pressing ENTER. 2. Double clicking the left mouse button on the choice. Lists and menus can be exited with the ESC key, or, the Right Mouse Button when the mouse cursor is within the Menu/List border. The lists for BBS codes are accessed by pressing ALT-F2, this presents a menu, the choices are: User Codes Text Codes System Codes Abort (same as Esc) The above present the category list, from which you may select a code, and paste it into text by pressing ENTER. Most codes are understandable, but a few are a bit cryptic, so we have provided a file, CODES.REF that lists all the codes and what they mean. It also notes which codes are applicable only to RA ver 2.0g The above lists, called from the Alt-F2 menu, are also available directly, without going through the above menu, from the MOUSE MENU, Ctl-F1 or RIGHT mouse button. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ COLOR CODES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Color Codes are accessed with ALT-F1, this presents a Color Selection Chart. You will notice two bright yellow arrows sitting up in the upper left corner, when the chart first appears. These are your selection arrows, you move them with your cursor keys, up,down,left,right. If the arrow reaches an outside boundary, it will wrap to the opposite end. You also have the HOME and END keys available. HOME will place you at the first color selection, and END at the last. The spot in the upper left corner is black on black, this is an INVALID color choice. * Invalid * will be displayed in the sample box, and Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 7 should you press ENTER to select it, the PC will beep, and nothing will happen. As you move around the chart, a sample of the color is displayed at the bottom of the Chart. If you wish to use a Blinking foreground color, press 'B' on your keyboard, the display will change to blinking. Pressing 'B' again will turn it off. Pressing ENTER, will paste the selected color code into your text. Pressing ESCape will abort the Color Chart, and nothing will be pasted to your text. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ SYSTEM DATE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Pressing ALT-F3 will present a menu with several date formats displayed. Choosing any of these will paste the current System Date into your text, in the format shown. May be useful for Bulletins etc. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ CALENDAR {+} ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Pressing ALT-F6 will popup a Calendar, you can select a date in the current month, or change month, or year, once you have selected a date you will be prompted for the format to use when inserting into the text. The format menu is similar to that presented when you call for System Date. This function is really handy if you are creating a bulletin that references dates in the future, its a simple matter to select a date 3 months ahead, and paste it into the text in the FULL format, with Day, Month etc. as in Sunday August 10, 1994.... or any other format you choose. Keys for changing days, weeks, months and years in the calendar are: Right Arrow - Increment Day Left Arrow - Decrement Day Down Arrow - Increment Week Up Arrow - Decrement Week PgDn - Increment Week PgUp - Decrement Week End - Increment Year Home - Decrement Year ESCape - will abandon Date Selection Either the ENTER key, or clicking the left mouse button, will insert the highlighted date. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ HIGH ASCII CHARACTERS {+} ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ A chart of High Ascii characters is available, by pressing ALT-F5, this is a picklist. Select the code you wish to paste, and press ENTER, it Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 8 will be inserted into the text. We have left out the Alphabet and the Ulamut characters, but all the box characters, and the crazy things Sysops like to put in their screens are there, about 120 characters all told. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ CODE INSERTION ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ When a color, BBS, date or other type of code is inserted into the text, the cursor will move to the next word in the line. If there is no word, the cursor will jump to the right side of the screen, if this should happen, just press CTL-Left-Arrow, this will return you to the end of the line. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ TEMPLATE FORMAT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ File Name Extension: All template files should have an extension of .T2A, this is the default and simplifies matters. This is the default extension given to the file by the editor. When running RATE from the command line, you need only supply the eight character filename, RATE will append the extension. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ CONVERTING A TEXT FILE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ If you have a text file that you wish to convert to a template file, you can load it into RATE, either from the command line, or with F3 from the editor. The first step you should take, is to rename the file with the proper extension, .T2A. Press Shift-F4 you will be prompted: Change Name To: and the current name will be presented, press END, backspace over the existing extension, and type T2A. Of course you can change the root name to, if you wish....it's "your" file <smile>. This DOES NOT save the file to disk, just changes the name. The new filename will be displayed in the status line, you'll notice the asterisk next to the name, which means the file has "changed". When you rename a file, this flag is set, so you will be prompted to save, even if you make no other changes, thus preserving your "new" file. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ CREATING THE TEMPLATE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The editor starts with a word wrap column of 76, which should be sufficient for your screens. This can be changed with the Command Key: CTL-OR Word Wrap is turned "OFF" at startup, you may find it easier to create Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 9 screens with it OFF, CTL-OW will turn it on. You will have to determine what is best for you, entering codes as you go, or entering later. Personally, I type in the text first, then I go back in and paste BBS variables and Color Codes. A point to remember, many of the BBS codes expand to a string larger than the code itself, the FullName one is a good example, so keep this in mind as you create. I often also do a combination, sometimes pasting BBS codes and Dates as I go, but almost "ALWAYS", I paste in the color codes after all text has been entered. Because entering codes changes the text format to your eyes, it can be confusing if you insert everything as you go. Some of the BBS codes that expand when shown, you may want to insert as you go, to help you decide just how much text you should have on a line. Color Codes, will move your text around, but do not re-format, these codes will not be shown when the screen displays, thus your original format will be intact. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ CODES CHANGING THE FORMAT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Sometimes, if you enter a color code manually, after entering text, it will change the format, causing words to wrap to the next line, if you experience this problem, use the chart and paste the code.... this does not cause long lines to wrap. If you wish to use any of the characters reserved for the compiler (@ % ^ ` ~) be sure to enclose them with the "filter" (; semicolon) see T2A.DOC for more on this. A note on the Blink Attribute: All color codes when found, turn off the blink attribute, so you should never move the caret (^) that is appended to pasted color codes. The caret is the code for blinking color. An example: %031Hello there, we are %030^GLAD%031to see you! would display in bright white on blue, except the word GLAD, which would be blinking bright yellow on blue, then the next %031 reverts back to white on blue, and turns off the blink attribute. If you were to move the caret to the beginning of the %030, you would get undesirable results. You're welcome to experiment with it if you wish though. <grin> When you toggle BLINK on in the Color Selection Chart, and paste that Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 10 code, it is placed in the text in the proper format. Should you insert a non-blinking color code, and later wish to change it to blinking, you can manually type in the carat (^), just be sure to put it "after" the color code that you want to blink. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ MEMORY SWAPPING ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The next two sections cover functions which cause RATE to swap itself out of memory, so before we cover those, we'll touch on just what RATE does when it swaps. If you have EMS or XMS memory available, and the appropriate device driver loaded, RATE will recognize and use either. If you have both types, RATE will attempt to use EMS first, as it is a little more reliable, and in the long run faster. If neither type of memory is available, RATE will create a SwapFile on your drive, in the current directory. This file is named $RATESWP.$$$ and is given the HIDDEN/SYSTEM attributes, so it will not show up in a DOS dir command. But many viewers will show it, DO NOT DELETE this file while RATE is running, if you experience a power failure, or some other problem which causes RATE to shutdown prematurely, then you may safely delete the swap file before running again. Another note: Never load a Terminate & Stay Resident (TSR) program while you are in a DOS shell, memory corruption will be the result. Memory swapping is very quick, but if you must swap to disk, especially on a slower system such as an XT, it will take a few seconds. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ DOS SHELL ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ You may Shell to DOS from the editor. Press F10 to do so. RATE swaps itself out to memory or disk. See RCC.DOC for swapping information. The prompt is modified to remind you that your are in a DOS shell, if you have exited to DOS after RATE was called by RCC, you will see TWO messages, one for RATE and one for RCC. Please use some caution here, NEVER load a TSR type program while in a DOS shell, and if the Swap file for the editor is visible when using a viewer that shows hidden/system files, do NOT delete the file while the program is running. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ COMPILE CURRENT FILE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ F4 - Compile current screen file. Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 11 Without leaving the editor, you can compile the current file with T2A.EXE. This has been added for benefit of those who are running from the command line. This way you can compile, view, and exit back to the editor, making any corrections if needed. You MUST save the file with F2, Save and Continue, before calling the compiler. If its a new file, and not saved, T2A will simply abort, because there is no file of that name. If it's a modified file, and you have not saved it, you will be compiling the old version. Calling T2A from the editor cause's it to run with defaults. ALL screens are created, and you will be prompted to view. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ CONFIGURATION ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The first time you run RATE, it will create a configuration file, with default settings. RATE automatically saves certain settings in a special config file. This file is named RATEINT.CFG, and it holds internal configuration items. These are settings that you change while you are in the editor. This is all automatic, there is no manual Save/Yes Save/No at the current time. If no config file exists, a new one will be created in the current directory. If you only wish to use one config file, you should place this copy in a PATH directory. From then on that one file will be read and written to. You can have multiple CFG files, one in each directory you work in, if a RATEINT.CFG file exists in the current directory, it will be loaded. Otherwise RATE will search all PATH directories and load the first one it finds. The settings it saves are: * Printer Settings * Wrap Settings (wrap column number) * Help File Name (if you specify another w/Shft-F1) * Default Directory (not used currently) * Default Extension (not used currently) The last two items may be implemented in the future. Soon, there will be another configuration file, it will be named RATE.CFG, and will contain your custom settings for things such as color settings, maxlines, and several other settings. We are working on the configuration program now, due to the complexity Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 12 of the editor structure, and the related Code Menus, we just could not have it ready for Version 1.0 release. It will be available soon. If you are a registered user, you will get the update free of charge. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ MARKING A BLOCK ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ We need to mention something on marking a block of text, or one character. The MARK-BEGIN key is F7 and the MARK-END key is F8. Place your cursor on the "first" character you wish to mark, and press F7, then place the cursor "after" the last character you wish to mark, and press F8. The block is always ended at the character just before the cursor, when F8 is pressed. When a block of text has been marked, its color is changed to the "marked text" color, the default color is bright white on blue. Blocks are marked on a line by line basis, in other words, you cannot "cut" a section out of the middle of a sentence or paragraph, whatever lines are in between the start and end spot while marking, will be included in the Block Command, whatever it may be. Some examples on marking a block: To copy or delete the phrase "quick brown fox" from the line below, "The quick brown fox jumped over the lazy red dog." you would: ^ ^ F7 F8, the cursor would be at the space after the x in fox, if you wanted the space also, you would place the cursor on the j in jumped before pressing F8. To copy a character you would place the cursor on the character, press F7, then move to the character, or space, after it, and press F8. To copy or cut the X from the following line, you would: "The map say's that the X marks the spot!" ^^ F7/ \F8 place the cursor on the X, press F7, place the cursor on the space "after" the X and press F8. Now you can delete it, copy it etc. I realize that the above examples are not great, but they should give you an idea. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ PASTING (COPY) A BLOCK▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ When you press the F5 key, any text or character that was previously marked, will be copied to the cursor location. You should be one space to the left of where you want the copied block to be pasted. It is not pasted at the cursor location, but 1 space to the right. Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 13 ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ LINE DRAWING ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ At this time, the editor does not support any line drawing. We hope to add at least some "simple" line drawing at a later date. You can, however, draw lines etc in a roundabout way, and it takes a few moments longer, but...... Call the Ascii Chart with Alt-F5, paste in the upper left and upper right corners, in your line style choice, with one space between. Now paste in the - char, or just type ALT-196. Now mark the - char with F7/F8, make sure you are in INSert mode, and press the F5 (copy) key repeatedly, till the top is the correct length. Next, past in the vertical line, do a block copy + paste as above. Now, paste in the lower left and right characters, and repeat what you did for the top line above. You may have to do a little cleaning up, and I know it's not a "cool" way to draw a box..... but it will work! ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ EDITOR COMMAND KEYS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Rather than load up the manual with a list of all the command key presses available, and what they do, we suggest that you simply print out RATE.HLP and use it as a reference. It's a straight Ascii file and will print on any printer. But we would like to cover the Line Delete key (CTL-Y), as this acts differently depending on where its at in the file. If you are on the "LAST" line of a file, and you press CTL-Y, the line will be removed, and the cursor will move to the beginning of the line immediately above it. If you are NOT on the last line, e.g. anywhere else in the file, when you press CTL-Y, the line will be removed, and the cursor will maintain its position. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ UNWANTED BLANK LINES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ When you are creating a template, and you are at the end of a line, its just habit to press ENTER and move on to the next line. IF you are at the end of the file, and after doing this, realize that you do NOT want to put any more text in the file, you should be sure to delete any blank lines. Dedicated to the RemoteAccess BBS - The Greatest! RATE.DOC.... The RaLin Ansi Text Editor Version 1.0 Page 14 This is really only critical if you are using the Editor to create a BBS Menu, and you need to hold the screen length to 24 lines, any additional lines will cause RA to activate the More? prompt.... not cool on a menu. The compiler does NOT watch for this, to it, a blank line is the same as one with text on it, it goes in the screen!! So be sure to check, if its critical, that you do not have that stray line, as RATE does not show an end of file marker, you need to pay attention. If you can cursor down past your last line of text, then you have a line there, hit CTL-Y and delete it. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ AUTHOR CONTACT AND SUPPORT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ As we have four manuals here for this package, this information has been place in a separate document. Please see SUPPORT.DOC. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ REGISTRATION ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Upon receipt of your registration fee, you will receive a key file, which when placed in the programs directory, will unlock the file size limit, and remove the UNREGISTERED notices and replace them with REGISTERED information. All programs are registered with one form, one payment. Plus you receive a utility pack from RaLin with a bunch of great utilities for your use. See REGISTER.FRM Dedicated to the RemoteAccess BBS - The Greatest!