WREVIEW Version 1.00k What is it? WReview is a program that will allow you to review the messages and user commands in your WigWam script file prior to upload. You can choose to allow editing of messages only or both messages and commands. WReview was designed to work with any WigWam setup it finds. It does this by examining your WigWam configuration files on invocation. WREVIEW is called via a small replacement for. You can also invoke WReview from the DOS prompt or from within the WigWam program group. WReview scans your script file for messages and commands and displays those found in a menu. You can use the cursor keys or mouse to highlight a message/command and either edit it, delete it or defer it till later. In addition, you can edit the recipient list for mail messages. When you have finished reviewing your messages/commands, you can choose to return to WigWam or to make your connection to the host system. If WReview finds no messages/commands at all in either the script file or it's deferrals file, it terminates immediately. As a result, WReview can be invoked just prior to host connection and, if no messages or commands are found, continue with the connection immediately. If messages or commands are found and you don't want to review them, a single keypress will initiate host connection. Also, a time out feature will continue with the connection if no keys are pressed for a specified period following invocation (default 30 seconds). Installation Be sure to read this section very carefully! 1. If you have any messages or user commands in your current script file, connect to the host system to upload them. If you already have a Wreview installation, you should also clear the deferrals file. 2. Since you are already reading this file you should have uncompressed the files into a temporary directory by executing the .EXE file. 3. If you dont already have BWCC.DLL (the library for Borland dialog controls) you should copy it into your windows\system directory. If you are using Windows 3.0 then you should also copy TOOLHELP.DLL into your windows\system directory. 4. Please ensure that you have a correctly installed copy of WigWam installed on your system. As always when installing a new piece of software you should backup you system (you do this anyway dont you?) incase anything goes wrong. 5. Run the INSTALL.EXE supplied in the package. If you are installing Wreview for use with the networked version of WigWam (Pow-Wow) then answer Yes to the dialog box. Set 6 will be missed out if you answer No. 6. You will be asked which service you wish to install Wreview for. For example you may want to install it for 'CIX'. This step can be repeated as many times as you like for each service. Simply press Cancel when you have added Wreview support to all the services. 7. This will popup a dialog with the following fields for you to fill in. The configuration parameters are described below: WigWam directory Defaults to WWCIX. If TP.INI does not exist in this directory then the 'Ok' button will be grayed out. Review directory Enter the full path for the directory you want to place WREVIEW into. eg: C:\WWCIX\%UTILS\REVIEW Text editor Enter the program name of your preferred editor. If the editor is not in a directory on your path, you should enter the full path for the editor. eg C:\WINDOWS\NOTEPAD.EXE If you leave this field blank, then you default to the supplied editor. User Command editing Set this parameter to Yes if you want to use WReview to view and edit user commands contained in the script file. History If you set this option to "On", WReview will maintain a history file. Each time you connect to the host, the script file contents will be saved into the history file. This file can then be used to recover if your your connection fails for any reason. Compuserve If you installing for use with Compuserve, set this parameter to Yes. Usenet Access If you are installing for Cix and internal comms and you want to connect to the usenet gateway, set this parameter to Yes. This requires the use of mwhite's usenet package (USN-2_3), which is available from addons4tp/files or addons4tp/beta. Get UseNet on cmd If you enable this option then your script will not automatically collect UseNet messages - you will have to tell it to, by using the new script command 'usenet' This is useful if you dont wish to connect to usenet at peak rate times. Add Icon to PM This option makes the install program add a new icon for WReview to the WWCIX/WWCIS group. Under Windows 3.0 if you already have a WReview icon then you should turn this off - under Windows 3.1 it automatically deletes the old version before adding the new one. Ok This button will save the information you have entered and start the installation. Cancel This button will exit the menu without installing WReview. If INSTALL gives you any error or warning messages during installation, you must take the actions indicated before proceeding. 8. Invoke WReview from the Program Manager. If all is well, a menu with a single item (Exit Review) will be displayed. If Review has any difficulties determining your configuration information, it will display appropriate messages. If you get any error messages, refer to the sections on default configuration and REVIEW.CFG. 9. You are now ready to use WReview. NOTE: If you reinstall or upgrade WigWam or your external script, you will need to install WReview again. INSTALL, however, will remember all of your answers when installing for the second time. Calling Review Depending on your installation, you can invoke Review using up to three different methods: 1. From the DOS prompt. Type WREVIEW at the DOS prompt. 2. From Program Manager. Double click on the Wreview Icon. 3. Automatic invocation. Review will get called automatically when you ask WigWam to connect to the host. You will only notice this if the script file or Review's deferrals file contain any messages/commands to review. If WReview is automatically invoked prior to host connection, a 30 second timer is activated. If you do nothing for longer than 30 seconds, you will automatically be connected to the host. As soon as you press a key, this feature is disabled. The duration of the time out can be changed from within WReview or turned off. Command details WReview *will* provide a context sensitive help facility. For help on a particular script item, highlight the item and press . Editing messages and commands To edit a message or command, use the cursor keys or mouse to highlight it and press (or the left mouse key). If you choose to edit a message, the message text gets copied into a temporary file and your editor is invoked to edit that file. When you quit your editor, the script file is updated to include the new message text. If you choose to edit a command, you will get WigWam style prompts and dialog boxes to make the changes. will allow you to edit the complete script file. Only use this option if you are sure what you're doing. Viewing messages and commands To view a message without shelling out to your editor, use the cursor keys or mouse to highlight it and press . You can also use this to view user commands as they appear in the script file. To view the entire script file, press . Deleting messages and commands To delete a message or command, use the cursor keys or mouse to highlight it and press . The message or command highlighted will be removed from your script file altogether. will delete all messages and commands in the script file. You will be prompted for a confirmation of this before any action is taken. Deferring messages and commands To defer a message or command, use the cursor keys or mouse to highlight it and press . Review will remove the highlighted item from your script file and store it in a deferrals file from which you can retrieve it later. will defer all messages and commands in the main script file. will undefer all messages and commands in the deferrals file. Deferring ALL commands A defer all commands key, , is provided to transfer all user commands (not messages) to the deferrals file. In this way, you can happily add user commands during a WigWam session, but defer them until you are performing a blink during a cheap rate period. Mail recipients and cc's To see the recipients of a mail message or reply, use the cursor keys or mouse to highlight it and press . You will be shown the main recipient and list of cc's. You can delete , edit , or add a cc. When you have finished making changes, press to return to the main menu. Viewing original messages for comments To see the text of the message being commented to or mail message being replied to, use the cursor keys or mouse to highlight the comment and press . Changing the message number for comments To change the number of the message being commented to, use the cursor keys or mouse to highlight the comment and press . Fcommenting This command is like the Fcomment command in WigWam. For comments and replies, it will append the original message to the end of the comment. Each message line will be prefixed with "> ". To do this, highlight the comment or reply and press . Show title This command only applies to Compuserve installations. It will add the text from the first line of the selected message to Review's display for thread and delete commands. will perform this operation for all thread and delete commands in the currently selected script file. Remove duplicate commands When Review scans your script file, it searches for duplicate user commands. Review highlights these commands by placing a star <*> at the start of their menu lines. You can delete these by highlighting them and pressing . Alternatively, Review will delete all duplicate user commands automatically if you press . Review will not let you connect to the host if your script file contains duplicate commands. Restore original script If you make a real # of editing your script file, you can press . This restores the script and deferrals files to their state when Review was invoked. You will be prompted for a confirmation of this before any action is taken. Switch to deferrals When you defer messages or commands, they are stored in Review's deferrals file (REVIEW.DEF or .DEF for TPNET). To review the deferrals file, press . Reviewing the deferrals file You can use all the same commands to review the contents of the deferrals file. To transfer a command or message back to the main script file, highlight it and press . will transfer all messages and commands back to the main script file. will transfer all user commands in the deferrals file back into the main script file. will switch back to the main script file. Switch to history When you connect to the host, Review will store the contents of the main script file in the history file (REVIEW.HST or .HST for TPNET). To review the history file, press . Reviewing the history file You can use all the same commands to review the contents of the history file. To transfer a command or message back to the main script file, highlight it and press . You will notice that, in addition to the normal script items, the history file contains a header for each connection showing the date and time. These items may only be viewed or deleted. If you delete a header, all the script items for that connection will also be deleted from the history file. will switch back to the main script file. Automatic deferrals There is a feature to defer certain commands automatically if the date and time reported by your system clock do not correspond to BT cheap rate and to undefer them at the next cheap rate connection (6pm - 8am or weekend days). To use this feature, you will need tell Review which command to defer automatically from the configure menu (Alt-C). Review reports on any items it moves when this feature is enabled. Automatically deferred items are stored in a separate automatic deferrals script file. Only commands held in this file will be automatically undeferred. In this way, commands that you defer manually will remain deferred until you choose to undefer them. Switch to automatic deferrals When Review performs automatic deferrals, it places the deferred items in the automatic deferrals file (REVIEW.ATD or .ATD for TPNET). To review the automatic deferrals file, press . Reviewing the automatic deferrals file You can use all the same commands to review the contents of the automatic deferrals file. To transfer a command or message back to the main script file, highlight it and press . will switch back to the main script file. About Review This command will display Review version information. Free Disk Space This command will display the amount of free disc space for all your fixed disks. Prune History File This command will prune old connection information from the history file. You will be prompted for a date from which to keep connection information. You can specify any valid date or you can indicate the number of days back to keep by entering a negative number (eg -10 will keep connection information from the last 10 days). You will also be asked if you wish to keep all mail. Problems? If you have any problems with REVIEW or WREVIEW let either of us know and we'll try to help. Thanks to CIX now enabling telnet access to CIX I am still able to connect to CIX even during term-time. This means that you can connect me 365 days a year via my CIX account. Pete C. (petec@cix) or from CompuServe, >INTERNET:petec@cix.compulink.co.uk Notes Although I've tried to test this program fairly well - there are still bugs left in it. Can I suggest that you take a backup copy of your REPLY.BSC before running the program - just in cUsers Manual for Review for WigWam ase there is a problem. This program should work okay under both Windows 3.0 and 3.1. Although, the development and most of the testing was done under 3.1. Please report any bugs/ideas to me. Helpful bug reports - preferably with instructions on how to reproduce the bug are a god send. If you have DrWatson then please send any logs you have for the UAEs to me - there is no point posting them to conferences - cos it bugs me and all the other users. Appendix: You should not need to refer to this section of the document unless you are experiencing difficulties with the installation. What INSTALL does The REVINST installation program performs a few simple tasks to install Review to work with your WigWam setup. ADDINST gathers information about how you want to use Review and stores it in tp.ini. REVINST reads this and performs the following tasks. 1. Modifies WigWam's configuration file. If you have elected to allow command editing, REVINST modifies the user command lines to allow WigWam to insert some command identifier information into the script file when you issue a user command. This information is necessary as many of the commands are very similar in their contents. This additional command identifier information is stripped out of the script file just prior to host connection. If you have elected to allow Review invocation from the WigWam system menu, an appropriate line is added to WigWam's configuration file. 2. Ensures automatic Review invocation if you have elected to allow command editing. For users of external comms, some lines are added to the BEFORE.BAT batch file. For users of internal comms, the WigWam TPC program is moved and replaced by Review's "dummy" TPC (see later section). REVIEW's Default Configuration REVIEW picks up most of it's configuration information from WigWam's configuration file. If it gets any of this information wrong, you can set up the information manually in the [review] or [reviewservice] scrions of TP.INI (see the section below). The REVINST installation program assumes that you use AUTO.BAT to invoke your external comms program and that it, in turn, invokes BEFORE.BAT. If, however, you do this in a different way, you will need to edit your batch/script file manually. All you need to do is to add these two lines to the start of your batch/script file: review -a (review -s -a for TPNET) if errorlevel 255 goto abort: (Review actually returns an errorlevel of -1 if you abort the connection, but users of 4DOS will have problems unless 255 is used) and this line to the very end: :abort It is preferable however to use the BEFORE.BAT and AFTER.BAT scheme. This is used by other WigWam addons. To tell your batch/script file to invoke BEFORE.BAT and AFTER.BAT, you should add these lines to the start: if exist before.no del before.no if exist before.bat /c before.bat %1 %2 %3 %4 %5 if exist before.no goto abort and these to the end: if exist after.bat /c after.bat %1 %2 %3 %4 %5 :abort The should be changed to whatever your's is (eg C:\DOS\COMMAND.COM). For TPNET, the scheme is only slightly different. The lines at the start should read: if exist before.no del before.no if exist \\before.bat /c \\before.bat %1 %2 %3 %4 %5 if exist before.no goto abort if exist \\after.bat /c \\after.bat %1 %2 %3 %4 %5 :abort rem *** Always delete reply.bsc for TPNET installation if exist reply.bsc del reply.bsc What Review Does On invocation, Review determines your setup details. It first examines REVIEW.INI to find out where WigWam is located. It than examines TP.INI for the editor, filenames and directories to use and for any commands overriding the default setup. It then completes the picture by examining and interpreting WigWam's configuration file. If you are using mwhites usenet pre- and post-processors, Review will also examine TP_CNF.USN. By determining your setup on invocation, WReview can be used unchanged on a wide variety of different internal and external setups and can understand new setups as you upgrade WigWam and your comms script. Next, WReview scans through the script file for mail, messages and user commands. As it encounters each, it adds a line to the menu describing the item and notes it's position in the script file. When you choose to edit a message, WReview goes to the correct position in the script file, extracts the message, places it in a temporary file (REVIEW.MSG), and invokes your editor. When you have finished editing the message, Review recreates the script file with the new message text in it. Whenever you choose to edit, delete or defer messages and commands, WReview updates the script file immediately. It would be faster to keep all messages and commands in memory, but WReview works in the way described in order to keep as much memory as possible available for shelling out to your editor. WReview is able to determine whether you have called it from the WigWam system menu or the DOS prompt or whether it was called prior to host connection (from BEFORE.BAT or the "dummy" TPC.EXE). If WReview was called as part of the host connection, and you choose to connect (rather than abort and return to WigWam), it strips the command identifier information from the script file. WReview is, however, able to put the command identifier information back into the script file if the host connection was not successful. You will, therefore, still see the user commands if you WReview again. How WReview Works With WigWam's Internal Comms If you are using command editing, WReview needs to be run just prior to connection in order to strip some temporary command identifier information from the script file. For internal comms users, however, WigWam invokes WWTERM.EXE (the internal comms program) when you choose to connect to the host. To get round this, the WReview installation program copies WigWam's WWTERM.EXE to WWTERMX.EXE and replaces it with it's own WWTERM.EXE (this is the file named WWFAKE.EXE in this package). Now, when WigWam invokes WWTERM, the replacement program is executed instead. WReview's WWTERM.EXE is a very simple program that does the following: 1. Calls WREVIEW.EXE 2. Waits for WREVIEW to finish. 3. If connection is going ahead it calls tp2usn if usenet is enabled. 4. Invokes WWTERMX.EXE. 5. If usenet is enabled calls usn2tp. Changes between versions Changes to 1.00a 1) Initial release. Changes to 1.00b 1) Task switch problem fixed 2) Delete & defer GPEs fixed 3) LoadString problems fixed 4) Trendy Alert/YesNo dialog :-) 5) Timeout option setup added 6) History file on/off added 7) Auto-deferrals setup added 8) If called with '-a' parameter then it creates a file called 'WREVIEW.YES' if calling process should continue and connect to CIX. Otherwise file 'WREVIEW.NO' is created. Only one of these files will exist on exit. If an error occurs then the file 'WREVUEW.ERR' should exist - unless the error is so serious that it cannot even do that! 9) WWnet service selection done 10) Edit CC's 11) A button bar. I could do with some bitmaps for defer etc. Ideas? 12) Connect to CIX - has support for WWTERM.EXE only 13) Help - just a straight port of DOS Review at the moment - needs a bit of work. Changes to 1.00c 1) Added extra help for most of the script command. 2) Split the 'File' menu into 2 parts. There is a now an 'Edit' menu. 3) Comment Number changing now works. 4) Edit message/file no longer selects all the text at startup. 5) Duplicate commands are now flagged with a '*' at the left side. 6) Edit menu on 'Edit message/file' dialog - it doesnt look quite right yet though. 7) View now works ok. 8) View Orig was including the message header instead of skipping it - this led to the message being truncated. 9) More buttons on button bar. Added status line info for them as well. 10) Help buttons on all dialogs. (Not context sensitive yet) 11) If 'Edit script' the last line is messed up cos it strips off the CRLF pair. - At least I think I've fixed this if that was the problem. 12) All compile time warnings removed - apart from the ones in windows.h... 13) Connect to CIX should now work okay for WWTERM. 14) Timeout was not reseting on keypresses/mouse movements. Changes to 1.00d 1) I've finally nailed the random crashes on exit. 2) Got rid of the helppath not defined error when running under a pure WigWam setup. 3) I apologise for saying 'Connect to CIX' was working. It didnt - I'm having a few more problems than I thought I would. The version of WWFAKE.EXE in this version may work if called from program manager instead of from WW. I'm waiting for more info from wlees before I can do anything else to it. Changes to 1.00e 1) Timeout = 0 now disables the timeout feature. 2) Pointer style was not changing when mouse was over borders. 3) Gives way to other processes when pruning etc. 4) Clicking on Ok when editing no longer inserts a CR into the text. 5) Widened the edit dialog - now takes approximately 70 chars across. 6) Delete item on history file didnt work properly. 7) Word-wrap on editor. 8) History prune now works. 9) Uses auto-load stub files so that you can run it straight from the DOS prompt. 10) Install program. 11) Window remembers last position. 12) External comms support. (not tested) Changes to 1.00f 1) Now works with WWTERM even from within WW. 2) REPLY.BSC is deleted after a blink properly. 3) External comms support. (tested and fixed - I hope) 4) Stub file returns errorcode 255 on abort/error from WREVIEW -a, or 0 if no problems and connect is to go ahead. This means you can run AUTO.BAT to connect to CIX - although it wont work from within a DOS box, due to the fact that you cant run Windows programs in one! So if you use external comms you will have to quit Windows and run AUTO.BAT manually. 5) More buttons on button bar. 6) Larger/intuitive (who am I trying to kid?) bitmaps on button bar. 7) Optional toolbar - allows user to use SuperBar etc instead. 8) No longer complains if no editor= line in TP.INI 9) Install program didnt allow user to specify different directory. Changes to 1.00g 1) Option to exit Windows when connecting to CIX - useful for DOS based connection scripts. 2) Partitioned buttons for easier use. 3) The .YES/.NO files are always created in the directory of WREVIEW.EXE. 4) Usenet install shouldnt put a /nickname in tp.cnf. 5) After.bat is wrong for usenet (was looking for usemsg in root) 6) Dont set "TempPath=." in tp.ini - use the TEMP directory - look at getenv("TEMP") or failing that :\TEMP 7) Option to when installing to put user command "usenet" in to collect usenet messages and the "q" does not automatically collect them. 8) Install program no longer warns user if REVIEW.INI doesnt exist. 9) Install program now looks in the right place to put usemsg. 10) WWFAKE wasnt calling addconw properly - fixed. 11) WWFAKE also calls PKXARC.EXE if SCRATCHP.ARC exists 12) REPLY.BSC is now deleted after successful blink. 13) Centre all dialogs. (Including install program one) 14) WWCIX.OLD was created root directory because .INI routines couldnt cope with a '.' in the directory names. 15) Optional external editor - set the name to nothing to use the internal one. 16) Menu on built-in edit dialog - removed - use NOTEPAD instead 17) Automatic addition of WReview icon to program manager group when installing. 18) Stoped the install program from putting extra entries in BEFORE.BAT and AFTER.BAT when rerun. 19) Install program also puts a '@ECHO OFF' statement at the start of your BEFORE.BAT & AFTER.BAT. 20) Install program now creates a WREVIEW.BAT file - it ignores the REVIEW.BAT in case you wish to be able to use either version. 21) If no commands in REPLY.BSC and blinking and no deferrals it wasnt connecting - fixed. 22) Didnt remember setting of Connect & Exit. 23) Install program was always looking for TP.INI in C:\WWCIX - fixed. 24) WWFake always looks for .YES/.NO/.ERR files in the directory of WREVIEW.EXE 25) Enhanced error reporting in WWFAKE.EXE Changes to 1.00h 1) When changing between files - the buttons grayed out werent changed - fixed. 2) Smoother multitasking when pruning. 3) WWFAKE doesnt do the addconing & deleteing of scratchp/reply.bsc, this is left upto WWCIX.EXE just like it should be. 4) Better built-in editor - remembers position etc. Word-wrap. 5) Some documentation. As you can see its in Windows Write format. 6) After editing a message, the list was incorrectly updated. 7) Usenet support wasnt installing properly - fixed. 8) Now checks that share.exe is loaded. Extra option in [Review] section of TP.INI called ShareType. Set to the following values: 0 - default - complains if share wasnt loaded. 1 - if you want to use file sharing, and your network supports SHARE.EXE compatible calls - but you dont want to load SHARE.EXE. 2 - if you want to disable all filelocking. 9) Checked under "stress", should now work even when low on memory/file handles etc. 10) Under Windows 3.0, the listbox was knackered - fixed. 11) Bullet proof filelocking of REPLY.BSC - now safe to run WW & WReview at the same time - now no chance of Wreview getting confused if you add a command to REPLY.BSC at the same time as you are editing one. 12) Fixed problem with Editing CC's - no longer GPEs, and corruption of listbox text fixed. 13) Fixed problem with divide by zero when viewing original when there was only 1 message in the topic. 14) Fixed bug with install & progman (b*stard took 4 hours to find - and it only needed a "w" prefixing to a command :-() Changes to 1.00i 1) Put hard newlines at end of lines in the editor. 2) Problems with internal comms and WW4CIS fixed. Could do with a bit more testing though. 3) Install program now looks for REVIEW.EXE, if that is found then the BEFORE.BAT calls that instead of WREVIEW.EXE - this means you can now blink from Windows using external comms. 4) Fixed error reporting problem in internal comms addon. Changes to 1.00j 1) Fixed problem with calling NETTERM.EXE instead of CISTERM.EXE in WWCIS. 2) Looks at [usenet] section of TP.INI for location of mwhite's Usenet utilities. 3) No longer assumes width of editor font is 8 pixels. 4) Remembered to change version number in about box this time. 5) Now works okay when SHARE.EXE is not loaded. Remember to check the 'exclusive access' box when installing if you dont use share.exe. 6) No more problems with /nickname and using mwhites usenet utils. 7) Improved help file (still under work) - all comments welcome. 8) Looks in [Usn2Tp] InpScrPad= for location of usenet messages. 9) WWFAKE no longer calls Usn2Tp if there is no scratchpad. 10) 'Quiet connection to just remove cmd# lines from REPLY.BSC when blinking. 11) Install program looks at 'downdir=' for location of usenet messages. Changes to 1.00k 1) Review editor lost focus when ran out of memory. Fixed. 2) General connection button for CIS/CIX/BIX connections. 3) Strips out '\r' from usenet paths when installing. 4) No longer adds 'usenet' user command if its already installed. 5) Usenet problems with mail to /nickname etc fixed. 6) Context sensitive help. 7) REPLY.BSC preprocessor now supports Pow-Wow. 8) Uses the TPINI, TPCINI and TPNINI environment vars properly. 9) Fixed cosmetic problems with "Say:", "Comment:" and "Subject:" 10) Support for PowWow (WigWam/Net) in main program. (Service selection) 11) Updated this text file to cope with Pow-Wow. 12) Installation program for WReview with PowWow. 13) Doesnt complain if message width is > 70 chars. 14) Text edit window no longer has maximise bug. 15) Now works okay with Manual Connections in WigWam 1.21+ 16) Made easier to port to Windows/NT. (I hope) 17) Informs user about problems when trying to run it from a DOS window under Windows. 18) A dialog is now used for the options on the Option menu. This should help avoid users from accidently changing the settings. Known problems and things to do. 1) Deferral problem when using usenet commands. (Not reproduced) 2) New help file is on its way. 3) Support the new DDE interface of Wigwam (when I've written it anyway) 4) One person found it didnt do anything at all. Dunno why yet...