Documentation for WSFMT Version 2.0 WSFMT Version 2.0 Copyright (C) 1985 by John R. Hall (HALL Associates) Documentation for WSFMT Version 2.0 WSFMT is COPYRIGHT (C) 1985 by John R. Hall who reserves all rights to the sale and distribution of this program. You may give this program away, but you may not charge for it (except for the usual nominal copying fee a user's group may charge a member). If you do give away copies, please keep all original files together. The following files should be distributed intact. README.WSF READ this file, it's FUN!!! (But some of it may look familiar...). It'll give you some idea of what WSFMT is good for! WSFMT.DOC Documentation (which contains formatting commands) WSFMT.TXT Formatted (using WSFMT, of course!) version of .DOC file WSFMT.COM The WSFMT program itself WSFMTIN.COM The installation program (you probably won't need it, but just in case...) WSFMTIN.MSG Message file for the installation program WSFMTIN.DTA Data file for the installation program This is version 2.0 of WSFMT (Word Star Format), a text formatter which uses the Word Star (tm) convention for DOT (formatting) commands. Version 1.0 was called FORMATWS, but was renamed because someone pointed out to me the possibility of accidentally typing FORMAT.WS and reformatting a disk! (Thanks to David Douglas of Brooklyn, NY, for that input). I'm distributing WSFMT as freeware (or shareware, etc.) and would appreciate a donation of $5.00 from anyone using this program who feels it's worth it. David, you're exempt from this (I appreciate constructive criticism, it means someone cares), as are any SYSOPS on whose system this program appears. SYSOPS provide a valuable service, usually for free, and should get something back for it (my opinion only). I've spent a fair amount of time trying to make this program easy to use. Let me know if you think it is (or isn't). I think you'll like WSFMT and find it of use. If you do, I'd appreciate the five bucks. What the heck, it's one small cash outlay for you, maybe a million $$ for me!!! Anyway, Enjoy! (Now WHERE have I seen THIS before???) Send COMMENTS, BUG REPORTS, and $$$ to John Hall 9915 Nevada Ave. Chatsworth, CA. 91311 Documentation for WSFMT Version 2.0 Table of Contents ----------------- Section Topic Page ------- ------------------------------------ ---- I. Introduction 1 II. Invoking and Running WSFMT 2 III. DOT Commands 4 IV. NOTES 6 i Documentation for WSFMT Version 2.0 Section I - Introduction ------------------------ WSFMT reads a WordStar (tm) file or any TEXT file and FORMATS it, then writes the formatted version out to ANOTHER file (just like the print-to-file option in WordStar, only A LOT faster). Now you can print those WordStar files you've downloaded off the BBS's and even READ them - page numbers, proper pagination, and EVERYTHING!. WSFMT uses the same FORMAT DEFAULTS that WordStar does, and recognizes any DOT commands (described later) in the file. You can use your cheapo, non-WordStar editor (I use the SideKick (tm) editor), along with WSFMT to produce beautifully FORMATTED text including page numbers, headers, footers, top and bottom margins, and more! All WordStar DOT commands are supported with the exception of "printer specific" commands such as BIDIRECTIONAL PRINTING and MICROJUSTIFICATION. DOT commands which are not recognized are ignored. MailMerge and StarIndex DOT commands are NOT supported. WSFMT version 2.0 supports PATHS permits MODIFICATION of FORMAT DEFAULTS from within WSFMT. WSFMT is currently installed for "default display type", and will come up in whatever display mode your computer is currently in. Run WSFMTIN to install WSFMT for your screen type. If you have a color display, WSFMT will display in LIVING COLOR! Page 1 Documentation for WSFMT Version 2.0 Section II - Invoking and Running WSFMT --------------------------------------- To run WSFMT, simply type its name at the DOS prompt followed by any options (described below), then press RETURN. <> indicates optional information. A>WSFMT <\path1\> <\path2\> where d1 and d2 are drive letters from A thru Z, path1 and path2 are legal paths, INPUT FILE and OUTPUT FILE are legal file names, and Y indicates your desire to change the formatting defaults. If you just type WSFMT, the program will prompt you for all information. If you enter an INPUT FILE name only, you'll be prompted for the OUTPUT FILE name and whether you wish to change any of the DOT command defaults. If you enter both an INPUT FILE name and an OUTPUT FILE name, then you won't be asked about changing the DOT command defaults UNLESS you enter the 'Y' after the OUTPUT FILE name. Any MESSAGES, such as start up help or errors, are displayed at the bottom of the screen. The default FORMATTING values are displayed in the center of the screen. After you enter all filename information, WSFMT will ask if you wish to change any FORMATTING DEFAULTS. If you do, answer by typing 'Y'. Use the UpArrow and DownArrow keys (or just press RETURN) to move to the value you want to modify. Type in the new value followed by RETURN or another UpArrow or DownArrow keypress. If you're changing OMIT PAGES, just type a 'T' (for true) or an 'F' (for false). You may use the BACKSPACE or LeftArrow keys to delete mistakes before pressing RETURN. If you enter any illegal characters, WSFMT will play a few notes and display a MESSAGE reminding you of your error. When you're thru making changes, press the END key (on the numeric keypad) and WSFMT will begin FORMATTING your file. The FORMAT STATUS values are updated and highlighted as DOT commands are encountered in the INPUT FILE. You can quit WSFMT at any time by pressing . If you do, or when WSFMT is finished with the current file, you'll see a MESSAGE asking if you want to format another file (unless you specify both FILE NAMES on the command line; see below). Press 'Y' if you do, or press RETURN or to exit to DOS. If you answer 'Y', then WSFMT will ask if you wish to keep the same FORMAT values. Answer with a 'Y' if you do, otherwise just press RETURN to reset the FORMAT values to their startup defaults (or to exit). Page 2 Documentation for WSFMT Version 2.0 If you specify both FILE NAMES on the command line, WSFMT will exit to DOS after formatting the current file without asking if you want to format another file (useful if you're running WSFMT from a batch file and desire unattended operation). Page 3 Documentation for WSFMT Version 2.0 Section III - DOT Commands -------------------------- The DOT command defaults and their meanings are described below. To be effective, DOT commands must start at the left margin. Values for these first DOT commands appear in the FORMAT STATUS area of WSFMT. They can be modified by the user or by DOT commands entered in the text. .PL n Page Length. This is the number of lines that will fit on your paper. The default is 66 lines/page. .PN n Page Number. Sets the starting PAGE NUMBER for the current page. This number will be incremented and used for subsequent pages unless another '.PN n' or a '.OP' (omit page numbers) command is encountered. The default is 1. .OP Omit pages. This tells WSFMT NOT to NUMBER the pages. A '.OP' command in the text turns on omit pages (TRUE), while a '.PN n' command in the text turns off omit pages (FALSE). The default is FALSE (don't omit pages). .PO n Page Offset. Specifies the number of COLUMNS the text MARGIN should be from the left edge of the page. The default is 8 columns. .MT n Margin Top. The number of ROWS from the TOP of the paper to the start of text. The default is 3 rows. .MB n Margin Bottom. The number of ROWS from the last text line to the BOTTOM of the paper. The default is 8 rows. .HM n Heading Margin. Specifies the number of ROWS in the HEADING. Must be less than or equal to the Margin Top. The default is 2 rows. .FM n Footing Margin. Specifies the number of ROWS in the FOOTING. Must be less than or equal to the Margin Bottom. The default is 2 rows. .PC n Page number Column. Specifies the COLUMN the PAGE NUMBER should start at. The page number normally appears within the Footing Margin unless overridden by FOOTING TEXT (see '.FO' command below). The default is column 33. Page 4 Documentation for WSFMT Version 2.0 The remaining DOT command values are not displayed by WSFMT and can only be modified by DOT commands entered in the text. .CP n Conditional Page length. When encountered, it FORCES a NEW PAGE if fewer than n lines are left on the current page. The default is 0 lines. .PA PAge. Causes a PAGE BREAK to occur. A new page will start after a '.PA' is encountered. No default. A control-L entered in the text will do the same thing. .HE
HEader text. The text following the '.HE' command will appear in the HEADING MARGIN (see '.HM' command). If a '#' appears in the HEADER TEXT, it will be replaced by the current PAGE NUMBER even if OMIT PAGES is TRUE. The default for HEADER TEXT is no text. .FO