QWKRR128 v5.1 Documentation - Part 4 of 4

Documentation: Page 1 | Page 2 | Page 3 | Page 4

Macro Menu

Keyboard macros allow a quick easy method of entering words and phrases with only a few key presses. Macros are "triggered" by typing the letter(s) or word defined as a macro, AND the spacebar.

The macro menu can be bought up by pressing <M>acros from the options menu, or via the F7 key from most menus.

The macro menu consists of :

<L>oad <S>ave <V>iew <$> <E>dit <Q>uit <M>ode

<L>oad Loads a new macro file

<S>ave Saves the currently installed macros to disk.

<E>dit Edit the current loaded macros.

<$> Selective Disk directory.

<Q>uit Quit to previous menu

<V>iew View installed macros, as they would be used by QWKRR.

<M>ode Toggle macros on/off

Note: Unlike other QWKRR support files, the macros are edited with the full screen editor. Editing macros will destroy any message currently in memory. QWKRR will warn you of such an occurrence before you have a chance to lose anything. Pressing 'E' from the macro menu will copy the currently loaded or installed macros into the text editor for editing.

Macro EDITOR Commands

in<S>tall Install current macros into memory.

<A>bort Abort editing with no changes (w/ CTRL key only).

<V>iew View edited macros, as they will appear in use.

HELP Command help.

Macro Formatting

Macro's consist of either one or more characters, an `=', your definition and finally a carriage return, (xx=definition of macro).

Examples:

RG=Rod Gasson
i=I
G=<Grin>
Ismeal=Ismael

There should be no blank lines between each definition, and the first macro MUST start on the first screen line. There is no limit to the number of macros, nor is there any limit on the size of any one macro. There is however a memory limit of about 7,000 bytes total. This means you can have one macro that takes up about 30 disk blocks, or 1,000 macros if you limit them to 7 characters each. Macros are case sensitive.

Since it is possible for QWKRR to deal with macros of any length special steps need to be taken for the inclusion of carriage returns, and a means of letting QWKRR know that the following lines are all part of a single macro. The key presses to do this are:

^ - (up arrow) Carriage Return.
| - (shifted @ symbol) signifies that text of macro continues to the next line.

If you are happy with your newly edited macros you can then in<S>tall them ready for use, or you can press CTRL=A to abort the editor with no changes made.

After installing your macros, test them. If all is ok then you should save them to disk. Installing macros is not the same as saving them. Install is more akin to "Load", but it loads them from the editor rather than from disk.

There are no special key presses involved to invoke a macro, all it requires is for you to type in your key word followed by a space. It is the space character that acts as the `trigger'. If you find that single or double letter macros cause macros to trigger at the endings of words you've typed, consider making the trigger macro longer to reduce this effect.

Macro Tips

Tip #1

You can use QWKRR's macro file as a spelling corrector by adding the words you misspell frequently and defining the correct word as the replacement.

TIP #2

To use a macro in a reply, type the letter(s)/word defined and then the spacebar to cause the macro to appear. If you type the same and use the cursor key instead, the macro will not appear.

TIP #3

Import the macro file as text file and then print it for easy reference.

TIP #4

To edit the macros while writing a message, <W>rite your text to disk, edit the macros file, then i<M>port the message back into the message editor and continue.

QWKRR Internal Macros

These are "special" macros in that they are continually being updated by QWKRR itself. These can be nested into your own macros to produce a customised macro for any particular person or topic.

The QWKRR Macros are:

*1 - INTRO Line *n - Quote Initials
---------------------------------------------------------------
*a - FROM first name *b - FROM last name
*c - TO first name *d - TO last name
---------------------------------------------------------------
*e - DATE of last read msg *f - TIME of last read msg
*g - SUBJECT of last read msg
---------------------------------------------------------------
*h - FROM actual first name *i - FROM actual last name
*j - TO actual first name *k - TO actual last name
---------------------------------------------------------------
*l - CURRENT date *m - CURRENT time

Examples:

Macro: +1=On *e, *a *b was speaking to *c *d, and said the following:^

Result:
On 08 May'97, Rod Gasson was speaking to Gaelyne Gasson, and said the following:

Macro: z=Cheers and Das Vedanya, *j.gaelyne
Result:
Cheers and Das Vedanya, Rod.
Gaelyne

Macro: rp=This is your FINAL Warning, *j *k!^Russell Prater, CBM Moderator^

Result:
This is your FINAL warning, Rod Gasson!
Russell Prater, CBM Moderator

Macro: rp=This is your FINAL Warning, *j *k!^*h *i, CBM Moderator^
Result:
This is your FINAL Warning, Rod Gasson!
Russell Prater, CBM Moderator

Note the second example doesn't include the name of the person sending the message, but defaults to the last read "FROM" first and last names. Note too, the extra lines appearing after these lines of text, due to the carriage return (^) added to the end of the macro definition.

FKey Macros

In addition to the user defined and QWKRR macros are the FKey macros. These are available from the editor at all times, continually updated, and are always used in INSERT mode.

F2 - Full name of the last read FROM.
F4 - Full name of the last read TO.
F6 - Date and time of last read message.
F8 - Quote initials in the following format " XX> "
(Also available through the Line Feed key )

Special Feature Macros

QWKRR v5 has three new macro features that can be used within messages. These are: Scrap Macro, Redefine Quote and ASCII Input.

Scrap Macro ^^ ^

You can define a scrap macro that can be used while replying to a message. The macro is defined by typing *^^ and a space. To trigger the macro, type *^ and space.

When you define this, you'll see the "^^" characters disappear; type the text that you want to appear and press return. The text you've typed will be erased and replaced by the new scrap macro.

Note: If you happen to press the delete key while defining a
macro, you'll end up with an odd character within it. In this case,
just define it again.

Redefine Quote *F8

This allows you to redefine the " xx>" text that's used when quoting a message, or when executing QWKRR's internal macros such as the *n, F8 or the Line feed key. QWKRR automatically updates the quotes used for each reply, so this macro is only in effect for the current message.

To define the quote macro, type *F8 space. (The "F" must be upper case). The "F8" will be erased leaving only the "*" character. Type the two-character initial you want to be used for quoting. The asterisk and initials will disappear. You can verify that the quote initials you typed are being used by QWKRR by quoting the message or pressing F8 or the Line Feed key.

ASCII Input *@

You can input any ASCII character from 1-255 in a message. To allow this, QWKRR uses an ASCII Input macro. This is useful for BBS's that require a special character for mail door commands, such as for Netmail or Email addresses or BBS kludge lines.

Defining the ASCII Input macro is similar to the Scrap and Redefine Quote macros, but doesn't store the anything in memory. To use it, type *@ and a space. As with the previous macros, the @ symbol will disappear. Type the number of the ASCII character you want and press return or the spacebar. The requested ASCII character will replace the
asterisk.

NOTE WELL: Do not use this feature indiscriminately!

This feature gives you enough rope to hang yourself. The BBS receiving your replies will act upon certain ASCII characters that can be added to your messages. It's STRONGLY recommended that you do not use this feature unless you know what characters your BBS requires for special treatment (such as for Email or Netmail address formatting).

Intro (Salutation)

An `Intro' is basically just another macro, with two main differences. It' saved with the DEFAULTS file rather than a macro file and is automatically added to the start of every message. Intro's can be toggled ON/OFF in the OPTION menu. When off, the Intro can still be used manually by typing *1. All QWKRR macros are available for use with this intro.

Intro Examples:

Macro: Hi *j,^
Result:
Hi John,

Macro: On *e, *a *b had the following to say to *c *d:^
Result:
On May 10, 1997 John Doe had the following to say to Jane Doe:

Macro: Hi *j,^On *e, *a *b had the following to say to *c *d:^
Result:
Hi John,
On 22 Feb'97, Doc Reader had the following to say to All Qwkrr Users:

General Information

Joystick controls

These controls will work at a page break or at the bottom of each message when the menu is displayed. For instance, joy-right at a Page Break will take you straight to the next message. Joystick controls have the following functions:

Right : <N>ext message/reply/tagline.
Left  : <P>revious message/reply/tagline.
Up    : <A>gain.
Down  : <RETURN> i.e. read past a page break or read the
	next/previous message subject to reading direction.
Fire  : <M>ark / unmark message when reading mail, or
	<Q>uit to the Opening menu when viewing Replies.

DOS Information

<@> This option will display the User Drive window showing the current Drive and Path and a `>' prompt, awaiting for your DOS command. Entering a `@' at this point will cause the error channel to be read and displayed, likewise a `$' will display the directory. All legal CBM DOS commands are accepted, such as "s:filename" to scratch a file or "r:newname=oldname" to rename files etc.

To change the USER drive or path, enter `u' at the prompt. This will then allow you to select the Drive and Path as you did when first loading QWKRR.

An alternative command is `cu' followed by the desired number, e.g. `cu9' to select drive #9 as the User Drive. This follows the same pattern as the CMD `cp' and `cd' commands.

NOTE: These commands are the only way to change the drive unit you are working with once inside the program. CMD owners should NOT use the swap function to change drives. Pattern matching and CMD date stamped directory listings are not supported. For CMD paths, use a double slash for changing directories such as cd//dir1/dir2

Customising

You can make changes to QWKRR to suit your particular needs. Before you begin, ensure that you are using a BACK UP copy of QWKRR128.

Load but do not run the program. Make your changes by typing one or more of the following poke statements from BASIC. Scratch the program from disk, and then save the changed version.

Ignore Disk Drive or Printer Interface

Primarily intended to avoid problems with the SG Gold printer interface. It can however be used to ignore any disk drive.

POKE 7233,x - (x is the device number).

Prevent Reply Scratching

Unless there is a pressing need, I advise against this change. Unless you ensure you manually scratch or remove the <BBSid>.Rxxx files after this poke, then you run a high risk of uploading duplicated mail.

POKE 7234,1 - to prevent reply scratching.
POKE 7234,0 - toggle normal reply scratching. This is the default.

Screen Blanking

QWKRR128 features a screen saver routine. If there is no user input for a period of time, the screen will blank. Pressing any key will restore it.

POKE 7235,x - Each digit represents 4 seconds. The Default is 30 (120 seconds). Range 1-255.

Warm/Cold Reset on Exit

These pokes effectively reverse the operation of the shift key when exiting.

The normal condition causes a cold reset, whereas pressing the same exit option *with* the shift key causes a warm reset. Poking any non zero value into 7326 causes the opposite to occur. The shift key will now cause a cold reset, and unshifted keys a warm reset.

POKE 7326,1 - warm reset upon exiting QWKRR.
POKE 7326,0 - cold reset (default).

Jean Parrot Poke

This poke will pause the screen on exit so you can read QWKRR's instructions such as "You may now upload your <BBSid>.rep file to the BBS".

POKE 7232,x - Waits for the user to press a key before resetting. (1-255)

POKE 7232, 0 - QWKRR displays comments then resets the computer without delay. (Default)

Character Sets

The character sets used in QWKRR v5.0 are incompatible with previous QWKRR versions. However, you can use the same character sets as used by Desterm or Browser IBM sets, so you should already have access to several to choose from, and several sets are included in the release package. Several additional character sets can be found in an archive named qwkrr5chr.sfx. If you wish to use Browser or Desterm character sets, you will need to rename them so they begin with "qc.". You can of course modify or create your own character sets. Fontigus is an excellent character editor for this.

QWKRR uses two character sets at any given time. The user-loaded set is for message and editor display, while the 'system' character set (QS.CHARS) is used for menus, borders, header data, etc. This allows QWKRR to have the nice borders and lets you read messages using the character set of your choice.

If for some reason you want to use your own set for the system text too, replace the file named "QS.CHARS" on your boot disk with the set of your choice. QWKRR will need to be reloaded for this to take effect. Please be aware that in doing this you may cause odd looking displays if any of the graphics characters that QWKRR is using gets changed.

QWKRR v5 supports a full 255 character ASCII set, including the following `special' characters:

CharASCII      Name			 Key press	     Appearance
---------      ----			 --------	    ----------
   92	       backslash		 pound sterling		 \
   94	       caret			 up arrow		 ^
   95	       underline		 left arrow		 _
   96	       reversed single quote	 shift *		 `
  123	       left curly bracket	 shift +		 {
  124	       vertical bar		 shift @		 |
  125	       right curly bracket	 shift -		 }
  126	       tildes			 shift up arrow		 ~

To access other special ASCII characters (from 1-254), see the ASCII Insert section in the Special Macros section.

Keyboard Tables

QWKRR v5.0 uses ASCII exclusively. As there are several ASCII codes that don't have matching keys on our C128 keyboard, the use of keyboard tables was implemented. The keyboard table defines what character is used in your messages when you press a specific key. QWKRR users in Germany, France, Sweden and other countries can modify this table so their specific language keys produce the characters they require.

You can redefine your own keyboard layout by modifying the "QS.KEYBOARD" file. QWKRR only allows the modification of three of the six possible tables.

The tables that can be modified are:

Normal set

Shifted set

Caps Lock set

The tables that can't be modified are: with ALT, with C= and with CTRL. Modification of these three sets can and will have undesirable side effects.

If modifying the keyboard layout for specific languages, the Caps Lock set is the same as the DIN set.

The current keyboard tables have been modified from the original to produce true ASCII (rather than PETASCII) and with the characters |`~{} being mapped to the same keys as QWKRR v4. All the other keys have been left untouched, which means you can get oddball characters with some keys, such as shift-British pound or the stop key. How these characters actually look depend on the character set being used of course, but the actual *values* are the same as 'normal' CBM.

Hide List

The QS.HIDELIST file can be used to hide lines of text that you prefer not to see when reading your mail. It was designed primarily for those with Internet accounts that contain a screen or more of header information before the actual message.

This feature works by searching the message for matching text that occurs immediately after a carriage return. In other words, you can only hide text that's at the BEGINNING of a line of text. This file can only be 255 bytes (or 1 disk block), if you attempt to use a larger list, memory corruptions and other undesirable effects *WILL* occur.

The qs.hidelist file can be edited with QWKRR, or any other editor capable of saving text in ASCII format. If you need a tab character in this list, you will have to use another program other than QWKRR to edit the file, as QWKRR converts tabs to spaces. Care should be used in defining your list, as it's possible to hide text that can occur in the body of the message.

Message Flags

The Flags function controls whether twit messages are displayed and serve to remind you whether you've read the message, if it's been printed, exported or replied to, among other things. Message flags appear in the top right corner when reading a message, in the form of a series of characters. If there's no flag set, it appears as:

-- ------- --- or: PR ------- ---

The first two flags are set by the information in the MESSAGES.DAT file and show whether the message is Private (a "P" in the first field) or if it has been flagged as Read on the BBS (an "R" in the second field).

The remaining 10 flags are local flags produced by QWKRR, and are stored in the Q.NDX file. They show the following information:

+------ --- You have read this message. This is set when the message is
	    displayed to the end. It will not be set if you use ESC to
	    skip a message. This flag is used by the <U>nread
	    option in the Selection Menu.
-M----- --- The message has been Marked using the M or * keys.
--R---- --- The message has been Replied to or Forwarded.
---G--- --- The message has been <G>rabbed.
----S-- --- The message has been <S>tored.
-----#- --- The message has been <#>printed.
------X --- The message has been e<X>ported.

------- P-- The message is To you.
------- p-- The message is From you.
------- -W- The message is To a person listed in the Twit list.
------- -w- The message is From someone listed in the Twit list.
------- --V The message is To a person listed in the VIP list.
------- --v The message is From a person listed in the VIP list.

Any combination of these flags can be set at any time. In most of the Selection modes the current mode can be identified by a colour change of the relevant flag.

Disposable Files

QPX (or QPE) and QWKRR treat some files as disposable, that is if they are found on a disk at the time a new file is being created the old file will be erased WITHOUT WARNING. These files are: CONTROL.DAT and MESSAGES.DAT (overwritten by QPX or QPE), and the <bbs-id>.MSG & <bbs-id>.REP reply files.

The Q.NDX index file is checked on start up by QWKRR. If the <bbs-id> (and other checks) are different to that held in the current file, Q.NDX is ignored and overwritten.

CONTROL.DAT and REP Packet Life Span

Never attempt to use the control.dat file from one BBS to create a reply packet for another system.

Never use an "old" control.dat file with a newer mail packet.

Avoid uploading any reply packet that was created with a control.dat file more than a few days old.

Try to upload your replies preferably the same day but no later than the day after downloading your mail.

Compatibility With Previous QWKRR Versions

If you've been using an earlier version of QWKRR, you should treat QWKRR v5.0 as a complete new program because *none* of the previous support files are compatible with this version, and attempting to use them is certain to cause unpredictable results.

The support files include the character sets, twit lists, address book, defaults file, macro files, taglines, etc.

You will find a utility program (TAGCONVERT) included in the archive files to convert your existing tagline files to the new format. Jeff Sadler wrote this utility (thanks, Jeff). For further information, see the separate documentation.

As this version of QWKRR uses ASCII exclusively, your QWKM.* macro files are not compatible. However, you can still make use of the macros you've been using by saving the file as ASCII with a filename prefix of "QM.".

Mail Packet Size

When setting up the mail door to configure how your QWK packets will be handled, you can usually adjust how many messages are included per packet. You'll need to take into consideration the capacity of your particular disk drive capacity.

On average, one message equals approximately 1.6 blocks of .QWK (.ARC) file and 3.5 blocks of MESSAGES.DAT file when unpacked.

This means a 300 message packet will give an .ARC file of 498 blocks which will unpack over 1000 blocks(!) of MESSAGE.DAT plus something like 10 blocks of other files.

A 1541 should handle roughly 150 message packets and a 1571 330 message packets but this will leave very little overhead if by some chance they are all large messages. Also if you only have a single drive take into account that you will need room on the disk to de-arc the packet and remain within the maximum size of the disk. QWKRR128 requires several blocks free to write its .NDX files.

Use of high capacity disk drives such as a 1581 or FD drive will allow you to download larger mail packets, and of course, using a RAMLink or Hard Drive will also have this advantage and greatly enhance your use of this program.

Number of Conferences

QWKRR128 will handle almost all conference numbers up to 65536, with the exception of conferences numbered 8192 through to 8447. This is due to a quirk in the QWK format and almost all other QWK readers will have the same problem.

It's suggested that if you have the option, avoid downloading the full conference list with your mail packet as this adds to the size of your download and usually isn't necessary. It also decreases the amount of available disk space, which can be at a premium for smaller capacity disk drives. This is often an option in the QWK mail door on the
BBS.

Using An Alias or Handle

QWKRR allows registered users to use the SHIFT E, R, F and C keys when replying to mail to use an Alias (or nickname) in the FROM field of messages. This allows you to Enter, Reply, Forward or Copy mail using another name than what QWKRR defaults to using.

Please be aware of the following if you decide to use aliases:

Even though you have changed the name the BBS may change it back on upload to your 'real' name or perhaps reject the message.

Aliases are not generally permitted in Fido echoes.

There are exceptions to this, but check with either your SYSOP or the area's Moderator.

QWKRR128 Distribution and Registration

Please refer to the QWKRR GNU License page for further information on this topic.

Updating QWKRR128 to Registered Status

NOTE: Even though QWKRR has been released under the GNU License, the released version still requires that you use registration codes to fully use QWKRR.

The program to generate registration codes is listed on the QWKRR GNU License page.

The documentation include below is still relevant and has not been updated.

Included in the distribution package, you will find a program named REGQWKRR. When used with information supplied when you register, REGQWKRR will convert the distributed QWKRR128 program to a personally registered one. As with previous versions, it will only behave as registered if the correct name is found in the CONTROL.DAT file.

NOTE WELL: ENSURE you read the instructions before attempting this operation! If you attempt to register it incorrectly disk data can be lost.

CMD owners: REGQWKRR will only work if the "QWKRR128 V" file is in a ROOT DIRECTORY. Once registered, the program file can be moved to a sub-directory.

The registration module works by modifying the actual QWKRR128 program. It will modify the first program on disk starting with "qwkrr128 v". The program will abort if a QWKRR128 program isn't found. It will quite happily attempt to modify earlier versions of QWKRR128 or any other file starting with the same string, causing corruption. Only use this program on QWKRR128 v3.1 or later. This release is v5.10.

When you register, you are supplied with both a registration and confirmation code. The registration module (REGQWKRR) will ask you for the registration code. Once this is entered, the confirmation code is shown. This must be compared with the confirmation code supplied to you. If this is correct press <Y>es. Any other key will abort. If it is incorrect then double-check your registration number before contacting the author for help.

IMPORTANT: never press 'Y' if the confirmation is not correct. This program does direct disk writes. The author will not be held responsible for any disk corruption if the confirmation code is incorrect or if the program is in a sub-directory when being registered.

A registered copy of QWKRR128 can be identified if you load and list it. If the program is unregistered all you will see is a single line in reverse text reading "QWKRR128 V5.10 (C) R.GASSON 1992-7". A registered copy will display the same line, but underneath (in normal text) the confirmation code applicable to the person who registered it is displayed.

Credits and Contact Information

Program / Original Documentation: Rod Gasson
90 Hilliers Road
REYNELLA SA 5161
Australia
Telephone +61 8 8322 2716
Fidonet 3:800/409.128
Internet rgasson@videocam.net.au
QWKRR Support, Updated Docs: Gaelyne Gasson
Fidonet 3:800/409.64
Internet gaelyne@videocam.net.au
WWW
http://cbm.videocam.net.au/qwkrr/index.html
Public Documentation: Mark Dowsett
P.O. Box 227
RANDWICK NSW 2031
Australia
Telephone +61 2 2399 6549
Fidonet 3:713/888
Internet dowsett@ibm.net
TAGTHIEF & QPX: Russell Prater
(Moderator CBM Fido Conference)
Fidonet 1:3608/1
TAGCONVERT: Jeff Sadler
Internet cspx@horizon.mp.com
QWKRR Help Files: Robert Saltiel
Internet robert.saltiel@moondog.com
German QWKRR Documentation, German Keyboard tables and help files: Michael Nausch
Internet big_chief@juice.muc.nacmar.de

QWKRR Support

If you need assistance with using QWKRR, or want information on the latest updates, the author (Rod Gasson) can be found in the Fidonet CBM and CBM128 echoes. He can also be reached via Fidonet Netmail and Email (addresses are given above). Additionally, if you have access to the Internet, the QWKRR Support Site on the World Wide Web can be found at:
http://cbm.videocam.net.au/qwkrr-index.php

COPYRIGHT STATEMENT

The programs QPX and TAGTHIEF are the original work of Russell Prater. TAGCONVERT is the original work of Jeff Sadler. They may be distributed freely so long as they are unaltered and no charge is made.

No part of CSX01.SDA, NZP12819.SFX or UNZP6420.PRG should be distributed in any but their original form without the expressed consent of the current copyright holders. UNZIPv2, QPE, UNZIP128, CSX01, CS-DOS, Fontigus and Desterm are copyright by their respective owners.

--Forty-two--