Documentation for Footnote Processor This program is designed to format WordStar files for footnoting. It takes an unformatted file prepared with Wordstar, and removes the footnotes from the body of the text, placing them either at the bottom of each page or as a separate file, and numbers each footnote consecutively. This formatted file can then be printed with WordStar as you would any other file. To format a document with footnotes in it, you should type in your text as you normally do. When you want to include a footnote, type it right into the body of the text, but mark the beginning and ending of the footnote text with the charac- ter @. This program will create a new file, and place the text enclosed by these marks at the bottom of the page, (or in a separate file), and will number each footnote successively. The program inserts the footnote numbers. Please do not add them yourself! Footnotes will always be printed in single spacing, with an extra space between footnotes. The text itself can be print- ed with any line spacing, but defaults to double spacing for the body of the text. Footnotes can be any length up to 55 single-spaced lines. If they will not fit on one page, the program will automatically split the note onto two pages in accordance with the standard in Turabian's Manual. Example: This is your regular body of text. At the end of this sentence, you want your first footnote to appear.@This is the text that will appear in the footnote.@ This sentence will immediately follow the word "appear" above, which will also be marked by the footnote number 1. It is important to remember that this program will alter the final ap- pearance of the text, since it closes up the text where footnotes were in- cluded. It will, however, keep paragraphs intact, and will always include any "hard" carriage returns which you enter in Wordstar. (A hard carriage return is one entered by pressing the carriage return key, rather than a new line which is started automatically by Wordstar when you type to the end of a line.) The ability of this program to reform lines also enables you to change from one line length to another, without reforming paragraphs in WordStar. Simply entering a new value using dot command .RM does the trick. Because this program closes up the text where footnotes were previously included, you can not expect that "what you see" on the screen in the unformatted Wordstar file is exactly "what you get" when the document is formatted. Instead, you need to control the output of the text using dot commands, rather than by shaping the text in Wordstar itself. For instance, if you want to indent a paragraph in Wordstar, you simply type ^O^G. With the footnote processor, however, you need to use dot commands to make the indenta- tion. In fact, if you try to indent a paragraph with ^O^G and then print it with this program, the indentation simply will not appear. (This documenta- tion will show you the dot commands to make indented paragraphs.) Another example is line spacing. Control it with dot commands, rather than with the ^O^S of Wordstar. In these respects, this program functions very similarly to Mail-Merge. After you have formatted the file, you can, of course, examine the formatted file within WordStar, to make sure that everything is as you want it, before you print it out. 1 The dot commands function, as nearly as I can tell, just as in WordStar, so I will not go into great detail explaining them here. Consult your Word- Star manual for this information. The only peculiarities needing to be men- tioned are the following: 1. Be sure to include one and only one space between the dot command and any value which is to be included in the command. (Ex: .cp 5) If you use more or less than one space, the program will not read the command correctly. 2. In addition to standard WordStar dot commands, I have added a .FN command to set the number of the first footnote, and a .LS command to set the line spacing for 1, 2, or more line feeds per line. A few other new dot commands will be introduced below. These non-WordStar dot commands are used in the formatting process, and will not appear in the formatted file. 3. When these non-WordStar dot commands are used, a question mark will appear in the right-most column of your screen. Don't let this worry you -- WordStar is simply telling you that it doesn't recognize these commands. But the footnote processor will handle them just fine. However, you should remove them if you want to try to print the unformatted file using WordStar's print command. 4. Most of the major supported dot commands, with their default settings (when they are not standard WordStar dot commands), are listed here. (Default settings are the values which the program will give if no dot command is given.) For details, and a few others, see your WordStar manual. .PA Starts a new page with the next line. .CP (n) Starts a new page if (n) lines are not left on this page. .PO Sets the page offset, or the column where printing begins. .MB Sets the margin at the bottom of the page. .MT Sets the margin at the top of the page. .PN Sets the number of the next page. .PC Sets the column in which the bottom page number will print. .OP Turns off the pagination at the bottom of the page. .LS Sets the number of carriage returns per line. (DEFAULT = 2) .PL Sets the number of lines per form. .CW (n) Sets the character width to n/120 inches. .FN Sets the number of the next footnote. (DEFAULT = 1) .FO Include a line of text as a footing to appear on each page. If a '#' is included in the footing, the page number will be printed at that spot. .HE Includes a heading at the top of every page. Functions similarly to .FO .FM Sets the # of lines below the last regular line on the page that the footer or page number will appear on, if used. .HM Sets the # of blank lines between the header and the body of text, if a header is used. (Note that if you want to use the .HE or .FO command, you must make sure that there is a large enough top or bottom margin to print the footing or heading. If there is less than a margin of two at the top or three at the bottom, the heading or footing will not print. Make adjustments with either the .MT and .MB commands, or the .HM and .FM commands.) .RM (DEFAULT = 65 If you want a different length of line, you MUST specify it using this command. Other lengths of line will be re-formatted to a 65 character line if no new right margin is given. 2 .IN Will indent what follows and make it single-spaced. A subsequent .IN command will return to normal margins and line-spacing. It is important that you precede the .IN command with a "hard" carriage return (That is, make sure that it is placed after a completed paragraph.) If this is not done, the program will not read it properly. .FS Changes the footnote marker to whatever you wish. Use this dot command if you want to use the '@' character in the file itself. Pick another character (e.g. '~') which you won't be using in the text. The syntax of the dot command is .FS ~ (or whatever character you wish to use.) In addition to supporting dot commands, the program will also process ^S(Underscore) commands, and ^B(Boldface) commands, as well as ^O for non- break spaces. Type ^P^O when you want a space which will not be divided between lines. Example: ".^O.^O." for an ellipsis. Also, take care not to use underlining or boldface across footnote markers. (e.g. this ^Sis a test.@footnote^S begins here.@) That will also do strange things! The foot- note processor will leave any other control characters in the file where you place them in the original file. Special Dot Commands To print in elite type, use the following dot commands at the beginning of the file: .cw 10 .rm 78 .po 10 To insert a paragraph in single spacing (as in an extended quote), place this dot command immediately before the paragraph: .IN Then type the paragraph without changing anything in WordStar itself. After you have finished the paragraph, insert another .IN on the next line. Continue on the line following that with your text. Example: This is your regular body of text. Now suppose that you want to insert a paragraph which is indented and single spaced as an extended quotation at this point. The following is what you do: .IN This paragraph will appear in the text indented and printed with single spacing, no matter what the line spacing is for the rest of the paper. .IN This paragraph will now be at the original left margin, and will be spaced as the rest of the paper. 3 Run-Time Printing Options When you run the footnote processor, you will be presented with a number of options for the way you want your document to be formatted. You will first be asked if you want to format the entire document. You can select out any range of pages from the document to be formatted, rather than the entire document, if you wish. Simply press 'R' for anything less than the entire document. You will then be asked for the starting and ending page. If you select a range of pages that begins well into the document, it may take the program a little while to get to the place where it is to begin formatting. Second, you will be asked the name of the file which will contain the formatted output of the program. Make sure that you give a different name from the name of the document you are formatting, or the program won't work. Finally, you will be asked if you want footnotes or endnotes. If you select endnotes, you will be asked for a name for the file in which the endnotes will be kept. The endnotes will be stored separately from the main file in the file that you name at this time. Before you print the endnote file, you may wish to edit it first and include whatever kind of title or header you desire. The CHECKER program One of the great frustrations of WordStar is the occasional time when you forget to put in your second ^S character to stop the underlining, and your printer merrily underlines the entire document from that point on. This does not need to happen to you very often before you become very wary of forgetting to balance your underline markers. For better or for worse, the need to balance markers is even more important in using the footnote program. Not only are there boldface and underline markers which need to be balanced, but there are also footnote markers and .IN markers which must be balanced. If any of these are not present in the file in pairs, the printing of the document will go haywire, and the footnote processing program may not work properly. Either of these incidents can cause a great deal of frustration. The CHECKER program is an attempt to reduce your frustration. It will go through your unformatted file, merrily counting your footnote markers, your underline and boldface markers, and your .IN commands. If there is an even number, the odds are that you are OK (unless you have forgotten two of some- thing.) When the program checks your .IN commands, it will also make sure that each one is preceded and followed by a "hard" carriage return. This is necessary for proper operation of the footnote processor. If the checker program tells you that your .IN commands are not balanced, and it seems to you that they all are, check to see that the '<' character is at the far side of the screen both before and after the .IN command each time. To use the program, simply call it up by the name 'CHECKER'. It will ask you for the name of the file you want to check, and will then check it for you, and tell you how many of each kind of marker are in the file, and whether thay are balanced. Remember that if two markers are missing, the checker will think that all is well, but you still may have problems. 4 y2ä4¢y¡yH—W¡yH—Š…Wy2ä4_ˆ…Wy‹^þ6ÄW‹FôP¸è8Ö‹FôP‹^þ6Äè