Beijing Paradise BBS Backup

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

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

Wrap

Text File | 1993-01-14 | 24.9 KB | 661 lines

WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) OVERVIEW WWIVEdit is a full screen editor designed for WWIV 4.xx BBS system. WWIVEdit has been designed with simplicity in mind. WWIVEdit has many of the features of a word processor, while remaining fully modem compatible. WWIVEdit is an evolving software product, originally designed for use with the WWIV BBS. While it may never be complete, its getting there. MEMORY REQUIREMENTS WWIVEdit requires a minimum of 150K free to load, and 175K to be useful (ie, have 100 lines free for text entry). When I say 150K free, I mean, when you type //STAT at WWIV's main menu, it says "Heap free: 150K". If you have at least 16K EMS free, in addition to the 150K the BBS reports, everything will work fine. WWIVEdit will allocate up to 64K of EMS, but requires that some of its data structures be located in normal memory, and hence the 150K requirement. INSTALLATION INSTRUCTIONS Throughout this file, certain assumptions have been made: 1. Your WWIV directory is C:\WWIV 2. You are a sysop. If you are using WWIV 4.21a or greater, simply unzip WWIVEdit into a temporary directory, and type INSTALL. WWIVEdit is preconfigured to run under WWIV 4.21a, and should run without problems on later versions. If you are running WWIV 4.21 or less, or a non-WWIV BBS, you will need to do some special things, and so you should read this entire document before starting the installation program. The install program will prompt you for your WWIV directory, and where you want to install WWIVEdit to, and then create the needed directory structure and copy the proper files into place. It will also configure the command lines correctly for you. If by some odd chance the INSTALL program can't/doesn't get the command lines right, for reference, they are: Remote: C:\WWIV\WWIVEDIT\WWIVEDIT %1 %2 %3 %4 Local: C:\WWIV\WWIVEDIT\WWIVEDIT %1 %2 %3 %4 -key:local -set:local For reference: %1 = Filename %2 = Screen Width %3 = Screen Height %4 = Maximum number of lines -key: specifies which keyboard file to use (from the CONFIG dir) -set: specifies which settings file to use (from the CONFIG dir) - 1 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) The install program for WWIVEdit will create the following directory structure: ───WWIV────WWIVEDIT───┬─CONFIG ├─DICT └─DOC The WWIVEDIT directory should contain: MACROS.LCL, NOTAG.BBS, WWIVEDIT.EXE, WWIVEDIT.HLP, WWIVEDIT.KEY, INDEX1.TAG, INDEX2.TAG, and USER.TAG. The last three files are created during the first run of WWIVEdit. The CONFIG directory should contain: LOCAL.DEF, LOCAL.KEY, DEFAULT.DEF, DEFAULT.KEY, ECLIPSE.DEF, OTHER.KEY, FOSSIL.DEF, DOS.DEF, and COM.DEF. Only the first four of these are necessary. The others are provided for compatibility with other BBS/Communications programs. After the first run of WWIVEdit with a particular DEF and/or KEY file, new files will appear. For example, from LOCAL.DEF, LOCAL.SET will be created, and from LOCAL.KEY, LOCAL.KBD will created. These are the binary forms of the "text" files. They will be used the next time WWIVEdit is run to speed up loading. You may also type WWIVEDIT -f to force these files to be created. The install program will ask you to do this when it is done running. The DICT directory will contain dictionary files. These include WWIVEDIT.DIC, HASH, and U*.DIC (if you allow personal dictionaries). The DOC directory contains various files (such as this one). That is all that you will need to setup WWIVEdit if you are running WWIV 4.22 or higher. If you are running WWIV 4.21a, you should install the EMP-HANG.MOD which will be in the WWIVEdit DOC dir. If you are using WWIV 4.21 or lower, you should see the section on the EDITINFO.MOD (available from the Authors BBS), or seriously consider upgrading to a newer version of WWIV. You should read the rest of the documentation thoughoughly to avoid problems. You will especially want to look at the accompanying files called CONFIG.DOC and KEY.DOC. They give a complete discussion of configuring WWIVEdit to your system. - 2 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) FEATURES OF WWIVEDIT USER MACROS ----------- WWIVEdit knows how to use the Control-A, Control-D, and Control-F user macros which WWIV provides. WWIV allows Control-P Control-A to execute a users macro in an external program. I felt it would be nicer if a user could use his Control-A macro, without having to prefix it with Control-P, so I have it set up, that if you hit Control-A, it will first put Control-P, then Control-A into the keyboard buffer. This then allows WWIV to send the macro. The problem is, there is a difference in how some computers store their keyboard buffers. To remedy this, the KEYBOARD: [] parameter is provided. If your users experience problems with their Control-A, Control-D, or Control-F macros, please refer to the CONFIG.DOC for a possible solution. If that does not work, users may still use their macros if they go ahead and type Control-P first. Another problem exits with users who use their terminal programs macro facility to do macros. Under most circumstances, they will work fine, but occassionally, either WWIV or WWIVEdit will loose some characters. I have not determined the exact cause of this, and it is still being looked at. LOCAL MACROS ------------ WWIVEdit now provides three kinds of local macros through the MACROS.LCL file. The first is key-stroke based, the second is literal text, and the third is batch command macros. The following naming scheme is used for the three macro key types: A thru Z relate to Alt-A thru Alt-Z 1 thru 0 relate to Alt-1 thru Alt-0 F1 thru F0 relate to F1 thru F10 $F1 thru $F0 relate to Shift-F1 thru Shift-F10 ^F1 thru ^F0 relate to Control-F1 thru Control-F10 !F1 thru !F0 relate to Alt-F1 thru Alt-F10 ^IN and $IN are Control Insert and Shift Insert ^DL and $DL are Control Delete and Shift Delete $TB is Shift Tab HOM is the Home Key END is the End Key UP, RT, LF, and DN are the Arrow keys Up, Right, Left, and Down PU and PD are Page Up and Page Down INS and DEL are the insert and delete keys ^LF and ^RT are Control Left Arrow and Control Right Arrow ^PU and ^PD are Control Page Up and Control Page Down ^HO and ^EN are Control Home and Control End - and = are Alt - and Alt = Many of the above keys are standard editing functions, and will be of no practical use as macro names, but they are included just in case. - 3 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) All three types of macros are stored in the file MACROS.LCL, located in the WWIVEdit directory. The file is a plain text file that can be edited with WWIVEdit. An example file is provided with the editor. The file WWIVEDIT.KEY must also be in your WWIVEdit directory, and you must also set WWIVEDITMACROS: [Y] in the DEF file that you are using (LOCAL.DEF). The best way to edit the file is to type //EDIT from the main menu prompt in WWIV, and then enter WWIVEDIT\MACROS.LCL as the filename. You could also edit it from DOS level, by changing to the WWIVEdit directory and typing: WWIVEDIT MACROS.LCL -key:local -set:dos To specify a key-stroke macro, you need to use the following layout: NAME: Macro Text Line 1 Macro Text Line 2 . . Macro Text Line N :NAME To specify a literal text macro, you need to use the following layout: NAME" Macro Text "NAME The difference between the two types is that if a control character, such as an escape character appears in the macro text, in the first (:) format, it will be interpreted as if you hit that key (for example, Escape), where as in the second ("), it will be inserted into your text (for use in an ANSI graphic for exampe). In both of these formats the tilde (~) has special meaning when it appears at the beginning or end of a line. When it appears at the beginning of a line, it serves as a place holder and is ignored when the macro is executed. This is very helpful if you want your macro to end with a "slash" command. For example, say you wanted to make an F2 macro that saved your message. If you simply Typed "F2: [ENTER] /ES [ENTER]", it would save immediately the Macros file (assuming you are using WWIVEdit to edit the macros file). On the other hand, this macro would do what you want: F2: ~/ES :F2 When a tilde appears at the end of a line, it means that ENTER should not be sent during macro execution. This is useful if you don't want a new line to be started after the macro is done executing. Extending the above macro's second line to ~/ES~ would make it so that you would have to hit ENTER after pressing F2 to save the file, in case you accidently hit F2. - 4 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) The third and final macro format is a DOS batch file format. To specify it, you use the following format: NAME; COMMAND 1 COMMAND 2 . . COMMAND N ;NAME Using this format, everything between the two ';'s is extracted out into a batch file, and then executed by WWIVEdit in a DOS subshell. For and example of how to use this, see the MACROS.LCL file that came with WWIVEdit. DOS SHELL --------- WWIVEdit provides a DOS shell. To enter the DOS shell, you need to hit Control-Alt (or whatever you define it as in LOCAL.DEF). WWIVEdit will then swap itself to either EMS (if enough is available), or disk. WWIVEdit creates a file called WWIVEDIT.SWP if it is swapped to disk. This file will be erased when you exit the DOS shell, and you need not worry about it. I just thought I would mention it because someone had mentioned it to me. CHAT MODE --------- WWIVEdit supports a two-way color chat that looks very similar to the Two-Way chat mode in WWIV 4.xx. You can enter chat mode by pressing both shift keys at the same time (or whatever you define it as in the .DEF file.) The chat mode looks a lot like the WWIV Two-Way chatmode. To exit chatmode, either ESC or F10 will work. If you are running WWIV 4.21a or less, then, there is one problem you should be aware of. If the user should happen to hang up/get disconnected while in chat mode, the BBS will lock-up the next time a key is pressed on the keyboard. This shouldn't be a problem because the only way to get into chat mode is for the sysop to be there, and if the user hangs up in chat mode, the sysop will be there to reset the BBS (and computer). WWIV 4.22 fixes this problem by providing a hangup detection mechinism which WWIVEdit takes advantage of. - 5 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) TAG LINES --------- WWIVEdit supports two kinds of tag lines. Personal Tag Lines, and BBS Tag Lines. Both are optional. Personal Tag Lines are defined by the user, and are appended to every message that the user posts unless one of the following is true: 1) The user saves with /SY or /ESY 2) The user disables taglines for that particular message. 3) You have set up a NOTAG file NOPERSON: [Filename] is in the DEF file. 4) TAG: [1] is in the DEF file. 5) You are running WWIV 4.21a (or above) and have disable tags set in //BOARDEDIT and do not have BBSDISABLE: [1] set in the DEF file. BBS Tag lines are definable by the Sysop. To create BBS Tag Line(s), create in your WWIVEDIT directory, files called BBSxxxxx.TAG. The xxxxx can be anything you want, and you can create as many of these files as you want. If more than one of them exists, WWIVEdit will select one at Random and append it to the message unless one or more of the following is true: 1) The file already existed when WWIVEdit was loaded. 2) BBSTAG: [1] is in the DEF file 3) You has set up a NOTAG file NOTAG: [Filename] is in the DEF file. 4) You are running WWIV 4.21a (or above) and have disable taglines set in //BOARDEDIT and do not have BBSDISABLE: [2] set in the DEF file. TAGLINE "Netiquete" ------------------- It it considered highly rude to place raw ANSI into your BBS taglines. By raw ANSI, I mean anything generated by an ANSI editor such as TheDraw. You may put color in your taglines, but it should be WWIV color codes (such as those put in by WWIVEdit). In short, you should NOT use programs like TheDraw to make your BBS*.TAG files. WWIVEdit also makes use of a WWIV 4.21+'s optional lines parameter to hide taglines from person who do not want to see them. To do this, it prefixs each line of personal and BBS taglines with Control-D #. User taglines have a # of 9, the first line of a BBS tagline 8, and each additional line goes down by one. What this means is that if you go into WWIV's defaults section and select optional lines: 10, you will see nothing in the way of taglines generated by WWIV. If you set it to 9, you will only see personal taglines. If you set it to 8 or lower, you will see progressively more lines of peoples BBS taglines. A setting of 0, will let you see everything. - 6 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) DISABLING TAGLINES ------------------ There are a few different ways to disable Taglines with WWIVEdit. The first and easiest is to use the Disable Tag? feature in //BOARDEDIT in WWIV 4.21a and above. Using this will disable both user and BBS taglines unless you specify the BBSDISABLE: [1 or 2] parameter noted above. The other way is to use a NOTAG file (noted above and explained below) NOTAG FILE ---------- NOTAG files are used to selectively disable taglines based on the message destination. For example, if you want BBS taglines disabled on local subs, you would use a NOTAG file. There are two parameters in the .DEF files that you can set. The first is the NOTAG: parameter, and the other is the NOPERSON: parameter. Each of these is a filename of file in your WWIVEdit directory. These files contain a list of substrings which, if found in the "destination" line of a post will cause taglines to be disable. The NOTAG: parameter specifies the filename that disables BBS taglines, and the NOPERSON: paramter specifies the filename the disables the personal taglines. By default, WWIVEdit comes with a NOTAG.BBS file (which is specified as the NOTAG: parameter) that contains the "#" sign. This disables BBS taglines on personal E-Mail. WWIVEdit will check each line in the NOTAG file to see if it is a "substring" of the Destination line. Whenever personal E-Mail is sent on a system the Destination line will appear as "User Name #10" or whatever. In this case, the "#" in the NOTAG file matches the "#" in the "#10". You are not limited to symbols though. You can just as easily type in a full message base name (these are CASE SENSITIVE). For Example, if you have a word association base and you don't want Tag lines in it, your NOTAG file would look like this: ----- # Word Association ----- One side effect of having the # in the NOTAG file occurs if you subscribe to a message base that has a # in the name. For example, I subscribe to the Alternate #1 Sysop's Net. Because the # appears in the sub name, taglines are disabled on that sub also, even though I don't want them to be. The only way arround this dilema is to change the name of the sub in //BOARDEDIT. - 7 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) NONSTANDARD SETUPS This section contains information on how to setup WWIVEdit for anything other than WWIV 4.21a+. EDITINFO.MOD ------------ Because of its size, the EDITINFO.MOD is not included in the distribution file. It may be extracted from the WWIVEdit 2.3 archive available on most major WWIV BBS's, or may be obtained for the author. My thanks go out to Wayne Bell for making this unneccesary for people using WWIV 4.21a or higher. EDITINFO.MOD is a modification that I wrote so that WWIVEdit can more effectively communicate with the BBS. EDITINFO.MOD communicates with the BBS through two different files. The first file is called EDITOR.INF. The BBS creates this file before invoking the editor. This file contains information about the messages's destination, title, and information about its author. The second file is created by WWIVEdit. This file contain the "Anonymous" state of the message just saved, and its title. Enhancements enabled by this modification: /TI : Title Change /ESN : Non-Anonymous save without that annoying Anonymous? prompt /ESY : Anonymous save without prompt "Title:" and "Dest:" will always be correct Fixes problems that appear under special situations (//CHUSER) While WWIVEdit can be run without the EDITINFO.MOD in place in older version of WWIVEdit, it is not recommended, as it may open up some security problems. MS-DOS 5.0 ---------- If you are running MS-DOS 5.0 and Wayne Bell's DOS 5.0 fix for WWIV 4.12, you need to do some additional work. Go into RETURN.C and search for ni_stack[100]. Change it to ni_stack[1024]. Next, search for &ni_stack[98] and change it to &ni_stack[1022]. Repeat these in EXTRN.C, and that should fix everything (including problems with other editors). TURBO C 2.0 ----------- I have heard that there may be a problem if you compile WWIV using Turbo C 2.0. This may cause the editor to "hang" on your system. If you are having problems with lockups on your system, try installing a stock copy of WWIV 4.xx and see if WWIVEdit will work with it. If it doesn't, please let me know so I can correct the problem if possible. BACKSPACE/DELETE ---------------- WWIV 4.21 and below has a "bug" that causes the delete key to be mapped as the backspace key. What that means is that from remote, when the user presses his delete key expecting the character under the - 8 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) cursor to be deleted, the editor will instead delete the character to the left of the cursor. The EDITINFO.MOD included with WWIVEdit has a few steps in it that will fix this bug for all external editors, without affecting other externals or the internal WWIV editor. WWIV 4.21a fixes this problem also. NON-WWIV BBS'S -------------- This section is not yet complete. Contact the author for further instructions. DISCLAIMERS WWIVEdit is a name that I arbitrarily choose in the process of writing this program. If there is any other editor out there that uses this name, it is unknown to me. WWIVEdit is the product of the work of Adam Caldwell. All routines used in this program were either written by Adam Caldwell, or directly modified to suit the purposes of this program with the following exception: EXECSWAP unit by TurboPower software The Author of this program is not responsible for any damages, frustrations, or other things that may result from the use of this program, nor does he guarantee that it will work on any system but his own. This program is provided As-Is. The Author will make modifications specifically requested by people who donate money, and may even do it for people who have not donated money, however, the Author does not guarantee this. PLEA FOR MONEY! --------------- WWIVEdit is distributed on a BegWare basis (I beg you to send me money!). If you find this program useful, PLEASE send me some money. If you send me $10 or more, I will mail the next version of WWIVEdit to you when it becomes available. This is the current registration policy, and replaces all other policies. This program may be freely distributed, so long as the terms set forward in the LICENSE.DOC file are adhered to. If you did not recieve that file, then someone has violated the licensing agreement. All future version of this program will be distributed in a BegWare fashion. My BBS phone number is (614) 593-7836. I don't gaurantee that it will always be in service, but barring unforeseen hardships, it will be in service until June 1993. I can be contacted at: Adam Caldwell (Preferred till June 1993) 114 Grosvenor St Athens, Ohio 45701 OR Adam Caldwell 16952 Nash Rd Middlefield, Oh 44062 - 9 - WWIVEdit Version 2.5 By Adam Caldwell (1@16470 Link, 1@6470 Net) If you have internet, you can E-Mail me at any of the following: acaldwel@oucsace.cs.ohiou.edu acaldwel@bigbird.cs.ohiou.edu Note: I can't respond to UUCP mail recieved at those addresses because of the system setup. And finally, (the preffered method) via WWIV Net/Link 1 @16470 Link The First Galactic Empire (Link) 1 @6470 Net The First Galactic Empire (Net) Thank you for trying WWIVEdit The Emporer (Adam Caldwell) Sysop of "The First Galactic Empire" Tel: (614) 593-7836 (WWIV 4.xx/USR HST DS 16.8K) (614) 594-3051 (Voice) THANK YOU NOTES The Duelist - For Beta Testing my editor, getting me involved in WWIV, and helping me set up my board so long ago... Jim Wire - For help beyond the call of duty... Trader Jack - For the initial beta testing of WWIVEdit 2.3 Niloc - For his suggestions and beta testing of the editor on my system. Thanks also go to: Parapuke, Filo, Trojan, Ken, Aahz, Lance Halle, Raistlin, Blondie & The Warden, Phantom, Joe Hallahan, Gene Wells, and anyone everone who sent me suggestions and bug reports (and more importanly, money). WHAT'S NEW Version 2.5 (Release Version) - Added external strings - Fixed a few more things Version 2.4 (Beta version) ----------- - Numerous little/big bugs fixed - Added a quoter - Added a cursor toggle for insert/overwrite mode - Insert File now behaves a little differently (gives you a list of files) - More memory efficient -- Now will allocate up to 64K of EMS if available. - 10 -