RNOTHESIS 1 Revised April 1987 I. THESIS FORMATTING WITH RUNOFF/RNOTHESIS A. Preface In 1980, the Iowa State University Computation Center (ISUCC) purchased a text formatting program called SCRIPT. But SCRIPT was more than a text formatter; it also served as a high-level programming language, and so the ISUTHESIS program macros (SCRIPT subroutines) were born. Now the public-domain program, Bonner Lab RUNOFF, also supports macro definitions; therefore, a set of macros similar to those in ISUTHESIS have been developed. They are collectively known as RNOTHESIS. Although there are several differences between the two macro libraries, many of the examples here come directly out of the ISUTHESIS manual, which is _________ credited to Mark Rupert of the ISUCC. This document is intended as a brief guide to RNOTHESIS; it is not a substitute for the Bonner Lab RUNOFF manual. It merely illustrates some ______ ___ ______ examples using the RNOTHESIS command macros and does not address every possible situation. Before using either RUNOFF or RNOTHESIS, you should skim through Chapters I thru IV of the Bonner Lab RUNOFF manual (detailed version) ______ ___ ______ paying particular attention to the first two pages of Chapters II, III, IV, and V included. It is the initial material within each of these chapters that contains the absolute necessities. You should also be familiar with the RUNOFF commands listed at the beginning of Chapter IV; Chapter V discusses these commands in detail. If you have suggestions to offer concerning RUNOFF, RNOTHESIS, or | these examples, please let us know. Users not affiliated with Iowa State | University (ISU) should direct their ideas and comments to Dennis Jensen, | ISU DECUS contact; ISU users may direct their comments to me. | Dennis Jensen Mark M Mehl | Ames Laboratory Dept. of Biomedical Eng. | 258H Metals Development IOWA STATE UNIVERSITY | IOWA STATE UNIVERSITY April 1987 | Ames, IA 50011 | (515) 294-7909 ________________________ This document and software is in the public domain and may be distributed provided Iowa State University, Dept of Biomedical Eng, and its author are credited for its development. -- Mark M Mehl (April 1987) RNOTHESIS 2 Revised April 1987 B. Invoking RUNOFF/RNOTHESIS There are 3 possible methods to invoke a program on a RT-11/TSX sys- tem. The method which omits the equal sign in the file specification is commonly used for RUNOFF. .RUNOFF input-spec output-spec If the equal sign is used, the order of the input and output specifica- tions must be reversed. This alternative method is illustrated in the example below where the LP: printer is the output device and SY:LP,DK:MYTEXT are two concatenated input files. | .RUNOFF LP:=SY:LP,DK:MYTEXT | Notice that "LP" is specified twice; more about this will be discussed _____ | later. 1. The input file specification __ ___ _____ ____ _____________ The input-spec consists of a list of 1 to 6 file names to be con- catenated as the input. In this list, the device control file always comes first, of which there are two: SY:TT and SY:LP.1 There is not a device control file for the letter-quality printer, LQ:, since its escape control codes are internally stored in RUNOFF. | The second file name on the input-spec is your own format control | file--DK:MYCTRL.RNO--which allows you to customize the output file to fit | your needs. An example control file for RNOTHESIS is given below. | .! <----- The optional VARIANT command line would go here | .REQUIRE "SY:THES2" | .! ---------- Beginning of user's customizations | .AUTOPARAGRAPH .!Enable autoparagraphing if desired | ----Other user customizations go here such as . . . | 1) redefining layout or format, | 2) defining and/or enabling FLAG characters or functions, | 3) command definitions or redefinitions, | 4) variable substitution definitions, | 5) or any other global operation. | .! ---------- Ending of user's customizations | .REQUIRE "SY:THEEND" ________________________ 1 The system device, SY:, is that area on the main disk where the operating system--and other supporting programs which control the computer--reside. Major program utilities (such as RUNOFF, FORTRAN, and HGRAPH) also reside on the SY: device. RNOTHESIS 3 Revised April 1987 | (Please note that Bonner Lab RUNOFF regards command lines as comments if | an exclamation mark or semicolon immediately follows the "control flag" | character--which is normally a period--as shown in the example above.) | A more complete example of a DK:MYCTRL.RNO control file is given on | the system disk as SY:THECTL.RNO. Copy this file into your own DK: default directory, then modify it to conform to your particular needs. This is the place to define your own command macros, define simple vari- able names for complex escape sequences like VO2 or VO2max, set hyphenation, define flags and flag functions, tabs, or even override the RNOTHESIS format to fit special needs. You should begin your control | file with the RUNOFF ".VARIANT" command to optionally select special | thesis-formatting attributes (discussed later in the "RNOTHESIS format- | ting options" section) followed by the ".REQUIRE SY:THES2" command to call the main RNOTHESIS control file. You must end your control file with either ".REQUIRE SY:THEEND" or--faster yet--copy in the contents of | SY:THEEND.RNO into the bottom of your own control file; there are only 7 | lines. This will save the computer time looking for SY:THEEND.RNO on disk. After your control file spec comes the list of text files which are to be formatted. Since the input file specification cannot have over 6 file names, when the input includes both a device and personal control file (SY:TT and DK:MYCTRL), only 4 more text files can follow. If this is inadequate, create a concatenation control file (IMR1A.RNO) using the RUNOFF ".REQUIRED" command, then include this control file as part of the input specification. .! This is IMR1A.RNO, a RUNOFF control file which .! combines INTR1A.RNO, METH1A.RNO, and RSLT1A.RNO .REQUIRE "INTR1A" .REQUIRE "METH1A" .REQUIRE "RSLT1A" When concatenating--regardless of method--each file must end with a "return" character; otherwise, the last line of one file will be con- tinued on to the first line of the next. A "return" character is in- serted whenever the RETURN key is depressed. Here are 3 input file spec's all specifying the same file names. Note that all input file names end with the default ".RNO" extension type. 1. To format output for the video terminal, TT: SY:TT,DK:MYCTRL,INTR1A,METH1A,RSLT1A,BIB2B 2. To format output for the dot-matrix "line printer", LP: SY:LP,DK:MYCTRL,(INTR,METH,RSLT)1A,BIB2B/P:12.:17. RNOTHESIS 4 Revised April 1987 3. To format output for the letter-quality printer, LQ: MYCTRL.RNO,INTR1A.RNO,METH1A.RNO,RSLT1A.RNO,BIB2B.RNO The Command String Interpreter (CSI) automatically assumes the most re- cent disk-device spec defines the device for the following file names without a device spec. For example, in the first 2 lines above, the CSI assumes INTR1A,METH1A, etc. must be associated with the DK: default area (your directory) since DK: is the last device spec given in the command string; see DK:MYCTRL. In the last line, no device name is ever given; therefore, it assumes the DK: default device. The second line uses a technique called "factoring" (with the parentheses) to abbreviate the list. Look under the "Factoring File Specifications" section in the Keyboard Command chapter of the RT-11 Sys- ________ _______ _____ ____ tem User's Guide for more information if you're not already familiar with ___ ______ _____ this technique. The second line also uses the /P command switch option to print pages 12 (decimal) thru 17 (decimal). As with any CSI command string, a decimal number must be followed by a decimal point; otherwise, its octal value is used instead. Refer to the CSI chapter of the RT-11 ___ _____ System Utilities Manual for more information about CSI syntax and the ______ _________ ______ Operating Procedures chapter of the Bonner Lab RUNOFF manual for a com- _________ __________ ______ ___ ______ plete listing of the RUNOFF switch options. 2. The output specification __ ___ ______ _____________ The output specification begins with the device name or device:file name to receive the formatted, printer-ready output. The second name in the output specification is a disk file to store the RUNOFF source for generating the table of contents for the document. To explain further, when RUNOFF first formats a document, it cannot tell what the document headings (and corresponding page numbers) are so it cannot generate a table of contents on the initial printout. Instead, it generates an "in- formation source file" that the user can customize (by editing after- wards) then process through RUNOFF to generate the table of contents as a separate output. If the user wants a list of figures and tables along with the table of contents, then the SY:THETOC.RNO control file can be used to implement the final operation. NOTE One may choose to copy SY:THETOC.RNO into their own DK: area so they can modify it to fit their own special needs. Examples using RUNOFF with both input and output spec's follow: ___ 1. Uses the video terminal, TT:, for the output | .RUNOFF SY:TT,DK:MYCTRL,METH1A,RSLT1A TT: _____ __ RNOTHESIS 5 Revised April 1987 | NOTE | Notice that the TT spec is specified twice. The first _____ | specification, SY:TT, calls the device control file | that defines device-specific control sequences for un- | derscoring, bolding, etc. particular to the video | terminal; this is part of the input spec. The second _____ | TT is part of the output spec and directs the output ______ | of RUNOFF to the TT: device. (Moreover, recall there | is no SY:LQ device control file for the letter-quality | printer, as shown in example #4, since it is contained | within the RUNOFF program itself.) Also note, when formatting the output for the video terminal (via SY:TT), RNOTHESIS will omit the left margin indent. This prevents the output lines from wrapping around on the terminal screen. 2. This example uses the dot-matrix "line printer", LP:, for the | output. In addition, the /P switch option is included so that | RUNOFF prints only pages 8 thru 12 (decimal). | .RUNOFF SY:LP,DK:MYCTRL,METH1A,RSLT1A/P:8.:12. LP: 3. Same as above, but places the output in DK:OUTPUT.DOC for later printing on the LP: printer. Note that ".DOC" is the default file extension type for the output file specification. .RUNOFF SY:LP,DK:MYCTRL,METH1A,RSLT1A OUTPUT 4. Formats and prints output on the letter-quality printer, LQ:, and saves the table of contents information in DK:TBINFO.RNT, which is later formatted and printed on the LQ: printer. .RUNOFF MYCTRL,(IMR,DIS)1A,BIB2B,APEN3C LQ:,TBINFO .RUNOFF MYCTRL,TBINFO.RNT LQ: NOTE For the first command line, recall that IMR1A.RNO is ___ the control file from above that concatenates INTR1A, _ METH1A, and RSLT1A. _ _ Also concerning the first command line, the default file extension type for a table of contents informa- tion file (such as TBINFO) is ".RNT". RNOTHESIS 6 Revised April 1987 5. Alternately, this example stores the formatted table in DK:TABLE.DOC for later editing and printing on the LQ: printer. Moreover, this example uses the SY:THETOC.RNO control file to produce a list of figures and tables as well. .RUNOFF MYCTRL,SY:THETOC TABLE .EDIT TABLE.DOC NOTE Although editing the formatted TABLE.DOC output--as illustrated above--may be the simplest method for the first-time RUNOFF user, editing the unformatted TBINFO.RNT file (prior to formatting) is more powerful and the method of choice. The unformatted table-of-contents information file must be named "TBINFO.RNT" when using SY:THETOC.RNO for formatting. This is because SY:THETOC.RNO calls this information file by name during formatting. 3. User-defined command language for RUNOFF/RNOTHESIS __ ____________ _______ ________ ___ ________________ In practice, the command specifications given above are rarely used. Instead, they are "abbreviated" via several techniques: 1. The use of "defined keys" under TSX-Plus allows any program to be invoked (or file name specified) by pressing a single key. Refer to the "Single-line Editor" section in the Basic Operation _____ _________ chapter of the TSX-Plus Reference Manual (must be version 6.0 or ________ _________ ______ later) for more information concerning the DEFINE KEY command. Further information on the DEFINE KEY command may be found in the Keyboard Commands chapter as well. ________ ________ 2. The use of command files under TSX-Plus to define frequently used command operations where up to 7 parameters may be passed into the command-procedure definition. Refer to the Command _______ Files chapter of the TSX-Plus Reference Manual for more informa- _____ ________ _________ ______ tion. 3. The use of the User Command Linkage (UCL) to customize your own command language for frequently used command operations where 1 parameter may be passed into the command definition. This is described below. RNOTHESIS 7 Revised April 1987 In addition to its efficiency, the last technique is the easiest to learn, define, and use. When using UCL, it is useful to create a LOGON.COM command file that is automatically invoked each time you logon. This file should contain all the UCL commands you commonly define. An example LOGON.COM command file for defining RUNOFF operations is given below. Please take note--for the purpose of this example--the personal control file MYCTRL.RNO has been renamed to THECTL.RNO to prevent con- _______ fliction between personal format-control files used for letters and pa- pers. R TSXUCL .!This line runs the TSXUCL program TTLET*TER :== _R RUNOFF SY:TT,DK:LETCTL,^ TT: TTPAP*PER :== _R RUNOFF SY:TT,DK:PAPCTL,^ TT: TTT*HESIS :== _R RUNOFF SY:TT,DK:THECTL,^ TT: LPT*HESIS :== _R RUNOFF SY:LP,DK:THECTL,^ LP: LQT*HESIS :== _R RUNOFF THECTL,^ LQ: MOD*IFY :== _SET PRIORITY 56\_EDIT ^\_SET PRIORITY 50 FX*THESIS :== MODIFY ^.RNO\TTTHESIS ^ !This is a comment line that terminates the TSXUCL program The first and last line in the above command definitions are optional, but they will significantly speed up execution of the LOGON.COM file if included. This is because the TSXUCL program is invoked only once rather than repetitively for each new command definition. The "_R " is also op- tional for speeding up command processing. The defined commands may be abbreviated anywhere after the "*". NOTE: Using command files Please note, you execute command files with an "@" (no inter- vening space), rather than a "RUN " keyboard command, where ".COM" is the assumed file extension type. If you requested LOGON file processing when your TSX account was created, then the system will automatically issue a "@LOGON" to execute your LOGON.COM file at the beginning of each logon session; however, you will need to execute it again to establish any changes you made to LOGON.COM during a given logon session. Once again, refer to the Command Files chapter of the TSX-Plus _______ _____ ________ Reference Manual for complete information. _________ ______ The UCL commands defined in the above command file can now be used as follows: 1. This example formats and outputs METH1A.RNO and RSLT1A.RNO to the video terminal as in example #1 of the "Output Specifica- tion" section given above. .TTTHE (METH,RSLT)1A RNOTHESIS 8 Revised April 1987 2. This example performs the same operation but outputs to the dot-matrix printer as in example #2 of the "Output Specifica- | tion" section given above. Once again, the /P switch option in- | structs RUNOFF to only print pages 8 thru 12. | .LPT (METH,RSLT)1A/P:8.:12. 3. This last example is a two step process using the "fix thesis" UCL command to invoke the editor at high priority via the UCL command "MODIFY" then--upon exiting the editor--invoke the UCL command TTTHESIS to process the just-edited material directly out on the terminal for evaluation. .FXTHES METH1A There are two things to recognize in this last example: 1. UCL commands such as MODIFY and TTTHESIS can be nested within other UCL command definitions such as FXTHESIS. 2. Several command operations--separated by a backslash--can be combined on a single UCL command definition like that of FXTHESIS. All UCL commands currently defined can be listed using the TSX key- board command "SHOW COMMANDS". If you plan to use UCL, spend 20 minutes reading the 4 page section, "User Defined Commands", in the Keyboard Commands chapter of the TSX-Plus ________ ________ ________ Reference Manual. This will fully describe UCL and save you a great deal _________ ______ of time in the long run. | C. RUNOFF/RNOTHESIS Text Formatting Considerations | 1. RNOTHESIS formatting options __ _________ __________ _______ | RNOTHESIS supports several thesis layouts, all of which are accept- | able to the thesis office. You select a given layout by defining the | appropriate RNOTHESIS options (or RUNOFF variants) with a RUNOFF ".VARI- | ANT" command line. This command line must be placed just before the | ".REQUIRE 'SY:THES2'" command line in your thesis control file, | MYCTRL.RNO, as illustrated in the following example. | .VARIANT NUM_HEAD ROMAN .!VARIANT cmd line precedes REQUIRE cmd ln | .REQUIRE "SY:THES2" | ----User customizations go here | .REQUIRE "SY:THEEND" RNOTHESIS 9 Revised April 1987 | There are several RNOTHESIS options available, which are discussed | below. You may specify all, one, or none of them on the RUNOFF ".VARI- | ANT" command line to define your particular layout. | a. The NUM_CHAP option - The NUM_CHAP variant enables __ ___ ______ | chapter-number prefixing of table, figure, and equation numbers so that | "Figure 3.2" depicts the second figure in chapter three. This variant | also enables numbering of the chapters themselves without enabling the _______ | numbering of lower section levels. | If you are going to be using chapter-number prefixing, you will also | need to peruse the appendix section at the back which discusses the usage _____ | of this feature. | b. The NUM_HEAD option - The NUM_HEAD variant enables the __ ___ ______ | numbering of all heading levels, chapter headings included. The number- ___ | ing at all levels is Arabic unless the ROMAN variant is also specified. | The NUM_CHAP and the NUM_HEAD may be specified together to obtain both | chapter-number prefixing and heading numbering simultaneously. If nei- | ther the NUM_CHAP nor NUM_HEAD variants are specified, then no heading | numeration is performed in the document; that is, "no numeration" is the | default setting. | c. The ROMAN option - The ROMAN variant causes RNOTHESIS to __ ___ ______ | employ upper-case Roman numeration for chapters, upper-case letters for | major sections, Arabic numeration for sections, lower-case letters for | subsections, and lower-case Roman numeration for subsubsections. If the | ROMAN variant is not specified, then Arabic numeration is used for all ___ | heading levels. | ARABIC NUMERATION ROMAN NUMERATION | 3. Chapter III. Chapter | 3.4. Major Section D. Major Section | 3.4.2. Section 2. Section | 3.4.2.3. Subsection c. Subsection | 3.4.2.3.4. Subsubsection iv. Subsubsection | 2. Special formatting with RUNOFF flag functions __ _______ __________ ____ ______ ____ _________ | RUNOFF recognizes a few special characters for "flagging" (or | depicting) special text-formatting operations such as underlining, | super/subscripting, bolding, Greek lettering, or overstriking. Since | these special characters only serve to flag text-formatting operations, | they are never printed in the output. For example, the ampersand (&) | flag character is used with the uparrow (^) "begin operation" and | backslash (\) "end operation" escape-flag characters to embrace text to | be underlined. Likewise, the asterisk (*) flag character is used to | designate text to be bolded. RNOTHESIS 10 Revised April 1987 | EXAMPLES: Using underlining, bolding, and escape flags | TEXT INPUT (SOURCE): | This is some ^&text to be underlined\&, and this is some ^*text | to be bolded\*. | TEXT OUTPUT (PRINTOUT): | This is some text to be underlined, and this is some text to be ____ __ __ __________ | bolded. | In the above output, the underlining and bolding operations are performed | where flag characters were encountered. | Often times, you will want RUNOFF to regard (what is otherwise de- | fined as) a flag character as ordinary "printable" character. This can | be done in three ways: | 1. By preceding the flag character by an accept-flag character; the | _ underscore is the default accept-flag character. For example, | _& will cause the ampersand to print. | 2. By disengaging total recognition of the flag character (by RUN- | OFF) using the RUNOFF ".DISABLE FLAGS XXXXX" command. For exam- | ple, the command ".DISABLE FLAGS UNDERLINE" will allow the am- | persand to print as a normal character until an ".ENABLE FLAGS | UNDERLINE" command is encountered in the input. | The ".DISABLE FLAGS ALL" command is used, in conjunction | with the ".ENABLE FLAGS ALL" command, to temporarily allow | nearly all flag characters to print (say for a figure or table). | Consult the discussion on the ".ENABLE FLAGS" command in the | Bonner Lab RUNOFF manual for details. ______ ___ ______ | Special care should be exercised when disabling flags used | by RNOTHESIS for any length of time. Although RNOTHESIS per- | forms a ".SAVE STATUS" of the flag states and a ".RESTORE | STATUS" as needed, unwanted results can still occur. Use the | accept-flag method, discussed above, when in doubt. | 3. By defining the flag-depicted operation to be associated with an | alternate character--otherwise rarely used in the text--using | the RUNOFF ".FLAGS XXXXX" command. For example, ".FLAGS UNDER- | LINE ~" defines the tilde sign--rather than the ampersand | sign--as the underline flag; therefore, the ampersand will now | be regarded (and printed) as a normal character. RNOTHESIS 11 Revised April 1987 | IMPORTANT | This third method is intended for the experienced RUN- ___________ | OFF user who is thoroughly familiar with the internal | usage of flags in RNOTHESIS and the device-driver | flag-escape characters used for his printer(s). Be | cautious of what flags are redefined! | The first method discussed is preferred when there is only an oc- | casional problem requiring a flag character to print. In contrast, if a | table (or figure) requires the printing of many dollar signs, which is | the substitution-flag character, then the second method--using ".DISABLE | FLAGS SUBSTITUTE" in the body of the table--should be employed. __ ___ ____ | RNOTHESIS will automatically perform a ".RESTORE STATUS" upon completion | of the table to restore flag states as they were before. | Along with the normal flag characters recognized by RUNOFF: &#_ | RNOTHESIS also defines/enables: ^\|+${} | One of the above methods will have to be employed in order to print these | characters, with one exception: the + period flag will print | normally--as a plus sign--in an ".equ(list) begin" and ".equ(list) end" | definition block because RNOTHESIS disables period-flag recognition | (.DISABLE FLAGS PERIOD) here. | a. Imbedded horizontal space processing - RUNOFF has two __ ________ __________ _____ __________ | modes of text justification. With line filling turned off (via ".NO | FILL"), RUNOFF produces output lines that closely follow the input lines | without shuffling words between lines to give a more right-justified ap- | pearance. This mode is often used in tables or figures where the typist | has manually arranged the text. | In contrast, with line filling turned on (via ".FILL"), RUNOFF as- | sembles each output line--removing any excess spaces--to produce a rela- | tively justified right margin (".NO JUSTIFY" mode) or a flush right | margin (".JUSTIFY" mode). RNOTHESIS principally operates in the fill, | no-justify mode. | The filling process normally places one space between each word un- | less it ends with "terminal punctuation" (such as a period), then the | filling process places two. This filling technique can present oc- | casional problems when text must stay together, or when special spacing ____ | is required at the end of a sentence or after an abbreviation. RUNOFF | flag functions are then employed to achieve the desired spacing as dis- | cussed below. | i. End-of-sentence double spacing - If a word ends with __ _______________ ______ _______ | a terminal-punctuation mark (as defined by the RUNOFF ".PERIOD" command) | such as a period, colon, or question mark; then that punctuation is fol- | lowed by double spaces. If double spacing is required after a character RNOTHESIS 12 Revised April 1987 | that is not a terminal-punctuation mark (such as a parenthesis or foot- | note number), then it must be followed with a + period flag. | EXAMPLES: Using the period flag | such as after a parenthesis.)+ Insert a period flag. | after a footnote superscript.^>3^<+ Insert a period flag. | ii. Obtaining a single space after a period ___ _________ _ ______ _____ _____ _ ______ | Occasionally, a single space is required after a terminal-punctuation | mark such as a period. This single space is achieved--on a case by case | bases--by preceding the punctuation mark with an accept-flag (or quote) | character. | EXAMPLES: Using the accept flag | These are some examples of using the accept (_) flag to get a | single space following a period such as in the abbreviations | e.g_. i.e_. etc_. or in a name like Dept_. of Engineering. | iii. Unseparable spacing - Occasionally, text must be ____ ___________ _______ | kept together within the same line such as in a name, heading, or for- | mula. This effect is achieved with the required-space (#) flag | character. This can occur in titles or words such as W#A#R#N#I#N#G or in | names like Mr.#Johnson and U.S.#Marines. With the name examples, the | required-space flag serves both to prevent the name from being split | across lines as well as to force a single space after a period. | The required-space flag is also used to reserve a position for a | Greek letter in an equation (See the "Output device considerations" sec- | tion of this document for details.) or to define a group of items to be | centered by tabulation (e.g. when centering "item groups" within a | table). | EXAMPLE: Tab centering with the required-space flag | EXAMPLE INPUT: | .FLAGS TAB ~ .!Define the tilde to be a tab operation | .!Below, setup 3 columns, and center on . . . | .TABS PROPORTIONAL 3,C,C,C .!the column partitions | ~^&COLUMN#HEADING#1 ~COLUMN#HEADING#2\& | .BLANK | ~line#1,#column#1 ~line#1,#column#2 | ~ln#2,#col#1 ~ln#2,#col#2 RNOTHESIS 13 Revised April 1987 | EXAMPLE OUTPUT: | COLUMN HEADING 1 COLUMN HEADING 2 ______ _______ _ ______ _______ _ | line 1, column 1 line 1, column 2 | ln 2, col 1 ln 2, col 2 | iv. Separable spacing - One or more horizontal spaces, ___ _________ _______ | which can be broken across output lines, may be generated by placing an ___ | accept-flag character in front of each space; this produces a "quoted | space" (_ ). In the example below, a series of asterisks are separated | by 3 spaces. The series may be split between output lines at the middle | where there are quoted spaces (_ ) but not at the ends where there are | required spaces (#). | EXAMPLE: *###*###*_ _ _ *###*###* | D. Output Processing and Operational Considerations | 1. Output device considerations __ ______ ______ ______________ | This section discusses possible problems (and solutions) of using | "special output features" on different types of terminals and printers. | These "special features" include superscripting, subscripting, equation | formatting, multiple character pitches, and multiple fonts (including | Greek letters). RUNOFF/RNOTHESIS generates appropriate control codes for | many kinds of output devices; however, not all devices can support all | features. | a. Video terminals - The more advanced graphics terminals __ _____ _________ | should support all special features with the possible exception of multi- | ple fonts (including Greek letters). Graphics terminals would be the | GIGI, VT125, and VT200 series terminals. The older terminals--such as | the VT100--support some superscripting and subscripting when doubling | spacing; however, none of the other special features (including under- | scoring) are well supported. | b. Dot-matrix printers - Like the video terminals discussed __ __________ ________ | above, the newer matrix printers (both impact and ink-jet) will support | all the special features (including multiple fonts). Older matrix | printers (like the LA120) may only support multiple horizontal pitches, | but none of the other features. In these instances, RUNOFF will try its | best to perform whatever formatting the printer can support. The example | thesis control file, SY:THECTL.RNO, illustrates alternative formatting of | some variable names (for the older matrix printer) that would otherwise | require the super/subscripting feature. This example--reproduced | below--allows these subscripted variables to still appear nicely on the RNOTHESIS 14 Revised April 1987 | older matrix printer. | .IF LP .!Don't define super/subscripting variables for the LP: ptr | .DEFINE SUBSTITUTE /V/V | .DEFINE SUBSTITUTE /CO2V/$VCO2 | .DEFINE SUBSTITUTE /O2V/$VO2 | .DEFINE SUBSTITUTE /MO2V/$O2Vmax | .ELSE LP .!Define V-dot CO2, etc. for all other output devices | .FLAGS OVERSTRIKE | .DEFINE SUBSTITUTE /V/^(.^)%V | .DEFINE SUBSTITUTE /CO2V/$V^^> | .DEFINE SUBSTITUTE /O2V/$V^^> | .DEFINE SUBSTITUTE /MO2V/$O2V^ | .ENDIF LP | c. Daisywheel printers - Daisywheel printers (such as the __ __________ ________ | Diablo 630) will support most of the special features. When performing | super/subscripting or equation formatting, however, it may be necessary | to set the paper release so that the paper-feed rollers engage the paper. | This is because the tractor feed alone will not accurately shift paper | direction for these operations. When your special requirements are com- | plete, return the paper release to its normal "disengaged" position for | tractor-feed operation. If you do not, the roller drive will fight the | tractor-feed mechanism causing the paper to eventually tear or bind in | the printer. | Although bolding and shadow printing are available (but not allowed | in a thesis), the standard 88/96 character daisywheel printer will not | support multiple fonts. If you still must have Greek letters, this can | be achieved by placing a RUNOFF required-space flag character (normally a | # sign) where a Greek letter should be. Later, after printing, the | desired Greek letters may be typed in (or rubbed on) over the | required-space positions. 2. Printing draft copies __ ________ _____ ______ Although automatic hyphenation may be desirable in the final copy, using the RUNOFF ".DISABLE HYPHENATION" command will significantly speed | up RUNOFF processing for draft copies. There is also a RUNOFF switch op- | tion, /H:N, that will request "no hyphenation". Refer to the Operating _________ | Procedures chapter of the Bonner Lab RUNOFF manual for a complete listing __________ ______ ___ ______ | and discussion of RUNOFF switch options. When printing draft copies, always use the dot-matrix printer, LP:. Not only is this printer 3 times cheaper to use (2 cents/page) than the letter-quality printer (6 cents/page), but it's 3 times faster as well. RNOTHESIS 15 Revised April 1987 | NOTE | Please note, however, that not all dot-matrix printers will ___ | support all RUNOFF special features (such as equation format- | ting or Greek lettering). See the "Output device considera- | tions" section for more discussion. Paper may also be saved by asking RUNOFF/RNOTHESIS to single space material within a paragraph--as was done in this document--by adding the following control lines to your thesis control file, MYCTRL.RNO: .SPACING 1 .!Use single spacing .SET PARAGRAPH ,1 .!Place 1 blank line between paragraphs RNOTHESIS 16 Revised April 1987 II. THIS IS A CHAPTER TITLE This is text following ".qchapter" and ".P" commands. The heading is called a Main heading. This chapter illustrates the RNOTHESIS com- mands used for subdividing text. The ".P" is the RUNOFF paragraph command that identifies the begin- ning of each new paragraph including those that begin a new section. An exception is made when beginning a subsection with either the ".subsec- tion" or ".subsub" RNOTHESIS commands; the paragraph command should be omitted at the beginning of these sections. A. This is a Major Section This is text following ".majsect" and ".P" commands. The heading is called a Major subheading. 1. This is a section __ ____ __ _ _______ This is text following ".section" and ".P" commands. The heading is called a Minor subdivision heading. a. This is a subsection - This is text following a ".subsec- __ ____ __ _ __________ tion" command. The heading is called a Paragraph heading. i. This is a subsubsection - This is text following a __ ____ __ _ _____________ ".subsub" command. The heading is called a Subparagraph heading. RNOTHESIS 17 Revised April 1987 2. Immediate sectional headings __ _________ _________ ________ Sometimes one sectional heading must immediately follow another and this condition must be indicated to RNOTHESIS to insure correct vertical spacing. As shown in Table 2.1, this is done with the leading ".qchapter" and ".majsect" commands by following them with an "I". It is unnecessary to do this with the other sectional heading commands. TABLE 2.1. Illustration of immediate headings .qchapter I HEADING .majsect I HEADING .qchapter I HEADING .majsect HEADING .section HEADING .majsect I HEADING .section HEADING RNOTHESIS 18 Revised April 1987 III. OTHER RNOTHESIS FEATURES This chapter illustrates the RNOTHESIS commands for different text features such as footnotes and tables. A. Footnotes and Quotations This major section illustrates the commands for footnotes and quota- tions. 1. Footnotes __ _________ a. Footnote commands - This section illustrates the RNOTHESIS __ ________ ________ | commands for creating footnotes. This text precedes the footnote refer- | ence variable, $FN$, which writes the footnote superscript.2 This is one | line of text following the footnote reference variable, and this is the | text after the first footnote. It follows the ".footbegin" and ".foo- | tend" commands, which delimit the footnote itself, as shown in Figure | 3.1. | b. Punctuation after the $FN$ reference number - Notice how __ ___________ _____ ___ ____ _________ ______ | the period-flag character (+ is the default) is used in Figure 3.1 to ob- | tain two horizontal spaces after the footnote reference number (which | follows "terminal punctuation") at the end of the sentence (e.g. | endword.$FN$+). Because the period-flag character is enabled in | RNOTHESIS, the user will need to precede any + signs to be printed, which | are not period flags, in the body of the paper with an accept-flag ___ ________________________ | 2 This is the text of the first footnote, which is sandwiched | between the ".footbegin" and ".footend" commands. RNOTHESIS 19 Revised April 1987 | .!In the line below, the variable name $FN$ is printed using the | .!"accept flag" character (_) to inhibit variable name substitution | .! | This text precedes the footnote reference variable, _$FN_$, | which writes the footnote | .IMMEDIATE TEST TEXT .!Omit this command unless required; see text | superscript.$FN$+ This is one line of text following the | footnote reference variable, | .footbegin | This is the text of the first footnote, which is sandwiched | between the ".footbegin" and ".footend" commands. | .footend | and this is the text after the first footnote. It follows the | ".footbegin" and ".footend" commands, which delimit the footnote itself. | FIGURE 3.1. Defining a footnote in the text | character (e.g. _+). Consult the "Special formatting with RUNOFF flag | functions" section in the RUNOFF/RNOTHESIS Text Formatting Considerations ________________ ____ __________ ______________ | area of this document for further details. | This last footnote example shows how the footnote reference number | can be placed before (rather than after) the punctuation to footnote Sar- ______ ____ | cocystis muris3; notice the position of the reference number before the ________ _____ | semicolon. | c. Potential problems and fixes - If a footnote occurs near __ _________ ________ ___ _____ | the bottom of the output page, RUNOFF may not be able to fit both foot- | note and footnote reference on the remaining page. This is particularly | a problem where there are numerious, long footnotes all bunched together __________ ____ | within one long paragraph. In these instances, RUNOFF will either split | a footnote across pages or terminate with an error message. ________________________ | 3 Here the name of the parasite is footnoted by placing the footnot- | ing number before the punctuation. ______ RNOTHESIS 20 Revised April 1987 | To circumvent this problem, a RUNOFF ".IMMEDIATE TEST TEXT" command | should be include just before the footnote reference variable, $FN$, fol- | lowed by one (or two) text line(s), then the footnote itself. This | technique is illustrated in Figure 3.1. For more discussion, see the ap- | pendix section entitled "RUNOFF Limitations" in the Bonner Lab RUNOFF ______ ___ ______ | manual. 2. Quotations __ __________ This section illustrates a quotation. This text precedes the ".quote begin" command. This is the quoted material. Note that it is automatically in- dented five spaces on both the right and left, and it is single-spaced. This text follows the ".quote end" command. B. Points and Bullets If you require portability between RUNOFF/RNOTHESIS and SCRIPT/ISUTHESIS then you should use the "point" and "bullet" commands as they are defined below. On the other hand, if you are doing your entire thesis with RUNOFF/RNOTHESIS, then you may find the native RUNOFF "LIST" commands in RUNOFF more powerful and just as easy to use. Consult the Bonner Lab RUNOFF manual concerning the "LIST" commands. ______ ___ ______ 1. Points __ ______ This section illustrates how to create lists of numbered points. This text precedes the ".point begin" command. RNOTHESIS 21 Revised April 1987 1. This is the text of the first point. It follows the ".point begin" command. 2. This is the text of the second point. It follows a ".point" command. | 3. This is the text of the third and last point. It also follows a | ".point" command. This is the text following the ".point end" command. 2. Bullets __ _______ This section illustrates bulleted lists. This text precedes the ".bullet begin" command. * This is the text of the first bullet. It follows the ".bullet begin" command. * This is the text of the second bullet. It follows a ".bullet" command. | * This is the text of the third and last bullet. It also follows | a ".bullet" command. This is the text following the ".bullet end" command. C. Equation Formatting 1. Commands and syntax for equation formatting __ ________ ___ ______ ___ ________ __________ The RNOTHESIS commands ".equlist begin", ".equ", and ".equlist end" work in exactly the same fashion as the .point and .bullet commands dis- cussed above. In addition, a tab character must be in front of each equation and equation number reference, $EQUNO$, as shown below: | [tab chr]P(x) = ax>2< + bx + c[tab chr]($EQUNO$) RNOTHESIS 22 Revised April 1987 | As with all RNOTHESIS reference variables, the first letter of the vari- | able name (e.g., the "E" in $EQUNO$) must be capitalized. Notice that the escape flag (^) may be left off of the super/sub- script flags, ^> and ^<, during the equation definition block. This is because RNOTHESIS uses a ".FLAGS SPECIAL" command to temporarily define them as single-character flag functions. | Also notice that the accept flag (_) may be left off the period flag | (+), _+ normally depicting the plus sign in the text, during the equation | definition block. This is because RNOTHESIS uses a ".DISABLE FLAGS | PERIOD" command so the plus sign is temporarily regarded as a printable | character instead of the period-flag function. The ".equlist" commands align the equations by their equal signs in column 15 or so. Although a good idea in principle, this occasionally fails in practice. In these cases, the ".equbegin" and ".equend" com- mands may be substituted for the ".equlist begin" and ".equlist end" com- mands. These alternate commands do nothing to position the equation; this is left up to you. Be sure to omit the first tab character in front of each equation when using ".equbegin" and ".equend" unless you have de- fined your own tab stops. | W = (E2)/(R) = I2R (3.1) P(x) = ax2 + bx + c (3.2) vi = VT.ln[(IQ + (vO)/(RL))/(IS)] + vO (3.3) vOmax = -VCC + VCE3sat (3.4) RNOTHESIS 23 Revised April 1987 | In Equation #3.1, notice how both equal signs are formatted in the | RUNOFF input file (reproduced in Figure 3.2a). The first equal sign is | preceded by a tab character flag (~) at the beginning of the equation so | that this equal sign is considered a tab alignment point. In contrast, | the second equal sign is not preceded by a tab character; therefore, it | is not used as a tab alignment point; rather it is printed as any other | character. | .!Note that ~ is defined as the tab flag character | .!in the control file with the ".FLAGS TAB ~" command | .! | .equlist begin | ~W = {E>2<}/{R} = I>22< + bx + c ~($EQUNO$) | .equ | .!Below, associate the equation counter, EQU_CNT$, . . . | .!with the user reference variable EQU_DEMO$ | .DEFINE NUMBER ITEM /EQU_CNT$/'EQU_DEMO$' | .!The next command line is optional; see appendix on back referencing | .DEFINE NUMBER ITEM /CHP_CNT$/'CHP_EQU_DEMO$' | ~v = V>. + {v}/{R}}/{I}] + v ~($EQUNO$) | .equ | ~v> = -V + V> ~($EQUNO$) | .equlist end | FIGURE 3.2a. Defining variable references for equations | Back referencing is demonstrated here for Equation _#$N$$EQU_DEMO$. | Refer to the RUNOFF input file . . . | FIGURE 3.2b. Back referencing above equation definition | FIGURE 3.2. Defining user-defined variables for equations The equation formatting functions are the most powerful and best ____ feature in Bonner Lab RUNOFF; however, they do not always work well with the tab functions and therefore may produce strange results when used RNOTHESIS 24 Revised April 1987 with the ".equlist" commands. Equation formatting is demonstrated in | Equations #3.1 and #3.3. See the "Equation formatting" section of the | RUNOFF Commands chapter in the Bonner Lab RUNOFF manual for further ______ ________ ______ ___ ______ | description. | 2. Back referencing equations __ ____ ___________ _________ | Back referencing is demonstrated here for Equation #3.3. Refer to | the RUNOFF input file (reproduced in Figure 3.2) and notice how Equation | #3.3 is "back referenced" in the above sentence (Figure 3.2b) via a | user-reference name established with the RUNOFF ".DEFINE NUMBER ITEM" | command (Figure 3.2a). In this example, the ".DEFINE NUMBER ITEM" com- | mand is first used to equate the equation counter, EQU_CNT$, with the | "user-defined" variable name EQU_DEMO$ then that user name is used in the | following text as $N$$EQU_DEMO$ to back reference the equation it was in- | itially defined for. | 3. Mixing equations with text lines __ ______ _________ ____ ____ _____ | Although it is possible to mix text between the ".equlist begin" and | ".equlist end" commands, which delimit the equation-definition block, | this practice is not recommended since RUNOFF flag characters, line | separation, and text justification are handled differently within such | blocks. Instead, the equation block should be terminated upon encounter- | ing each text line, then restarted as necessary to begin the next equa- | tion definition as shown in Figure 3.3. RNOTHESIS 25 Revised April 1987 | .equlist begin | ~W = {E>2<}/{R} = I>22< + bx + c ~($EQUNO$) | .equlist end | This is the text that is to follow the | second equation and precede the third. | .equlist begin | ~V = -IR ~($EQUNO$) | .equlist end | FIGURE 3.3. Proper form for mixing equations and text lines D. Tables and Figures This major section illustrates RUNOFF/RNOTHESIS commands for tables and figures. 1. Tables __ ______ This section illustrates the commands for creating tables. The | ".tabnum" command is used to first increment the table counter, then | equate a user-reference name (in this case, "TZONE_TBL") to the new coun- | ter value. In this way, RNOTHESIS can use the user-reference name to | keep track of the table number automatically so you don't have to | renumber your tables if you rearrange them within your paper. Each | ".tabnum" command only needs to precede each table definition block it RNOTHESIS 26 Revised April 1987 | references. | Please note, as with all RUNOFF substitution names, the | user-reference name cannot exceed 20 characters in length. The usage of | this command for both table and figure definitions is given below. | .tabnum 'TAB_REF_NAME' | .fignum 'FIG_REF_NAME' | This is the text that follows the ".tabnum" command and precedes the | ".tabtitle", ".tabbegin", and ".tabtitle point" commands, which begins | the table definition block for Table 3.2. The ".tabtitle" command is used to define the title of the table (which must all be on one line and less than 200 characters); whereas, the ".tabbegin" command marks the beginning of the table. Both of these commands must be together so that ____ ".tabtitle" defines the table title on one line and ".tabbegin" begins the table on the next. If you look closely at the input, you will notice that the table was formatted using tabs. This is usually faster and easier than manually | spacing the input. Also note that the user's control file has used the | RUNOFF ".FLAGS TAB ~" command to define the ~ character as a "tab | character". You may choose to use the "native tab character" (generated by the TAB key) as the normal tab flag, which is the default setting. Consult the Bonner Lab RUNOFF manual for more detail concerning the use ______ ___ ______ of tabs. This is the text following the ".tabend" command. If there is room on the current output page, a table (or figure) is printed at the posi- tion where it was defined; otherwise, it will be printed at the top of the next page. RNOTHESIS 27 Revised April 1987 TABLE 3.2. Some states and their time zones ---------------------------------------- STATE TIME ZONE ---------------------------------------- Washington Pacifica Wyoming Mountain Utah Mountain Texas Central Arkansas Central Iowa Centralb Mississippi Central Florida Eastern Maine Eastern ---------------------------------------- a This is a footnote used within a table. Notice the spacing and placement of the footnote. b This is the second footnote. Footnotes within tables must be formatted by "paragraphing" within ____ the table definition itself; the RUNOFF/RNOTHESIS footnote commands can- not be used within a table definition block. Lower case letters depict footnotes within a table, except for statistical significance which is designated by asterisks. 2. Figures __ _______ | This section illustrates the commands for creating figures. This is | the text following the ".fignum" command and preceding the ".figtitle" and ".figbegin" commands for Figure 3.4. This is the paragraph that follows the ".figtitle point" and ".figend" commands that defines Figure 3.4. RNOTHESIS 28 Revised April 1987 this is the first line in the figure _____ Note that the fill mode (.FILL) is normally on during a figure de- finition unless otherwise shut off (.NO FILL); whereas, the fill mode is not on during a table definition. The RUNOFF ".FIGURE n" command may be used here to reserve n ab- _ | solute blank lines for a paste-in figure. Moreover, the RUNOFF | ".FIGURE n" and ".FIGURE DEFERRED n" commands can reserve n contigu- _ | ous blank lines anywhere in the document--including the top of a ________ | page; whereas, the RUNOFF ".SKIP n" and ".BLANK n" commands will | discard blank lines across page boundaries. this is the last line in the figure ____ FIGURE 3.4. This is the figure title of the "figure definition" example | a. Reserving a whole page for a figure - To reserve an entire __ _________ _ _____ ____ ___ _ ______ | page for a figure, use a ".FIGURE 46" command within the figure defini- ______ | tion block, shown in Table 3.3, where the block is terminated with | ".figend page" rather than ".figend" as noted in the table. | Moreover, to reserve a completely blank page with only a page number | but no figure title or description, use the RUNOFF ".FIGURE DEFERRED n" __ | command where n is 47. See the Bonner Lab RUNOFF manual for details. _ ______ ___ ______ RNOTHESIS 29 Revised April 1987 TABLE 3.3. Comparison of figure, table, biblio, and equation commands text prior to text prior to figure reference table reference .fignum 'FIGNAME' .tabnum 'TABNAME' text with text with $N$$FIGNAME ref $N$$TABNAME ref .figtitle TITLE .tabtitle TITLE .bibtitle .figbegin .tabbegin .bibbegin .equlistbegin .tabtitle point reference equation ($EQUNO$) .FIGURE 20 table description .bib* .equ reference equation ($EQUNO$) figure description body of table .bib .equ .figtitle point reference equation ($EQUNO$) .figend** .tabend** .bibend .equlistend *The ".bib" may be replaced with a blank line if autoparagraphing is used. **If the figure or table requires a whole page, use the ".figend page" or ".tabend page" commands instead. | 3. General guidelines for defining tables and figures __ _______ __________ ___ ________ ______ ___ _______ | 1. Place the table and figure definition blocks between paragraphs _______ | rather than in the middle of a paragraph. The definition block | begins with ".figbegin" (or ".tabbegin") and ends with ".figend" | (or ".tabend"). Notice that the ".fignum" (or ".tabnum") com- | mand is not a part of the block and can be placed anywhere in ___ | front of the block definition. | Defining blocks between paragraphs should reduce the | chances of having widow or orphan lines around tables and fig- | ures. | 2. For table or figure definitions that require a whole page (or | nearly a whole page), end these definitions with the ".tabend | page" or ".figend page" command instead of ".tabend" or RNOTHESIS 30 Revised April 1987 | ".figend". This will prevent orphan lines from following these | tables and figures in the remaining space left on the page. 3. Tables and figures are defined similarly except that the ".tab- title point" command normally follows ".tabbegin"; whereas, the ".figtitle point" normally precedes ".figend". Table 3.3 il- lustrates these differences. E. Bibliography Table 3.3 also illustrates the ".bib" commands which works similar to the ".equlist" commands as shown. In addition, there is a ".bibtitle" command which must immediately precede the ".bibbegin" command similar to the figure and table definition blocks. Within the bib-definition block, only one horizontal space follows periods and colons. A "period flag" character (+) must follow each of these punctuation marks where double spacing is required. The bibliographical style given below is copied from the new fifth _____ edition CBE Style Manual (1983); whereas, the examples in the Graduate ___ _____ ______ ________ College Thesis Manual [ISU] use the older third edition CBE Style Manual _______ ______ ______ _____ ___ _____ ______ (1972). You and your major professor must select one of the formats; the thesis office will accept either but not both. RNOTHESIS 31 Revised April 1987 IV. BIBLIOGRAPHY Steele, R. D. Role of 3-ethylthiopropionate in ethionine metabolism and toxicity in rats. J. Nutr. 112:118-125; 1982. White, H. B., III. Coenzymes as fossils of an earlier molecular state. J. Mol. Evol. 7:101-104; 1976. Livanou, Th.; Nikas, A. A quick test of protein bound iodine based on the dry ash method. Folia Biochim. Biol. Graeca. 9:116-123; 1972. Norton, E. M.; Boe, A. A. (Dept. of Plant and Soil Sciences, Univ. of Idaho, Moscow). In vitro propagation of ornamental rosaceous __ _____ plants. HortScience 17:190-191; 1982. Osler, A. G. Complement: mechanisms and functions. Englewood Cliffs, NJ: Prentice-Hall, Inc.; 1976. Altschul, S. von R. Drugs and foods from little-known plants; notes in Harvard University herbaria. Cambridge, MA: Harvard Univ. Press; 1973. Eason, G.; Coles, C. W.; Gettingby, G. Mathematics and statistics for the bio-sciences. West Sussex, England: Ellis Horwood Limited; 1980. RNOTHESIS 32 Revised April 1987 V. APPENDIX A: THIS IS THE TITLE OF THE FIRST APPENDIX The RNOTHESIS ".qappendix" command is used to begin each appendix section. This command is followed with the title of the appendix sec- tion. For example: .qappendix Definition of Symbols | The appendix sections normally appear last in a thesis so that they fol- | low the bibliography and acknowledgements sections. RNOTHESIS 33 Revised April 1987 | VI. APPENDIX B: USING "OPTIONAL" CHAPTER-NUMBER PREFIXES ON | TABLES, FIGURES, AND EQUATION NUMBERS | RNOTHESIS supports several optional formats, which were formally | discussed in detail in the RNOTHESIS formatting options section of this _________ __________ _______ | guide. Among these, the NUM_CHAP option (or RUNOFF variant) enables | chapter numeration of chapter headings, tables, figures, and equations | automatically. The reference names used to cite these items in the text | may be handled in two ways; the second approach is the simplest and pre- ______ | ferred method when applicable.4 | 1. Although more involved, the first method works in all possible ___ | situations. It uses the optional ".chpnum" command, which im- ________ | mediately follows the appropriate RNOTHESIS command as shown: | 1. To later reference a chapter number from anywhere in the | thesis-- | .qchapter CHAPTER HEADING FOR THE INTRODUCTION | .chpnum 'CHP_REF_NAME' | 2. To later reference a table, figure, or equation from any- | where in the thesis-- | .tabnum 'TAB_REF_NAME' .chpnum 'CHP_REF_NAME' | .fignum 'FIG_REF_NAME' .chpnum 'CHP_REF_NAME' | .equlist begin .chpnum 'CHP_REF_NAME' | --OR-- .equbegin .chpnum 'CHP_REF_NAME' | --OR-- .equ .chpnum 'CHP_REF_NAME' ________________________ | 4 Keep in mind that prefixing table, figure, and equation numbers | with the chapter number is completely optional in your thesis. If you __________ ________ | are not doing this, disregard this entire appendix section. ___ RNOTHESIS 34 Revised April 1987 | In all above cases, the ".chpnum" command simply equates | the current chapter number to the user-defined variable that im- | mediately follows the ".chpnum" command. The author can now | reference items (tables, equations, etc.) with a | "$chapter.$item" reference-name combination. For example, | "Figure $CHP_REF_NAME.$FIG_REF_NAME" would print as | "Figure 3.2". | This method, which uses the ".chpnum" command, is only re- ___ | quired if the referenced item was defined in a different chapter ______ | than what it is being referenced from; that is, Figure 3.2 was | defined in chapter 3 but is referenced in the text--once | again--in chapter(s) 4 and/or 5. Since referencing across | chapters hardly occurs, the ".chpnum" method is rarely neces- | sary. The second method is much more convenient to use. | 2. This second method simply prefixes the current chapter (or ap- _______ | pendix) number--followed by a period--to the user-defined refer- | ence name given in the text. This substitution only occurs, | however, if the reference name--given in the text--is preceded __ ____ | with a $N$$ character-string combination. | WARNING | The $N$$ string is generally not accepted by RNOTHESIS ___ ________ | commands. It is intended to be used within the text | of the document, not in command lines. | .tabnum 'MY_DOG_SPOT' | . . . and, as shown in Figure $N$$MY_DOG_SPOT, | the subject has recovered . . . | .tabtitle Recovery from prosthetic implant | .tabbegin RNOTHESIS 35 Revised April 1987 | We strongly recommend prefixing every item reference name (for | tables, figures, and equations) in the text with the $N$$ string whether | or not you're using the NUM_CHAP formatting option. The only time the | $N$$ string should be omitted is in RNOTHESIS command lines and whenever | the first method discussed above--using $CHP_REF.$ITEM_REF--is employed | to alternately generate the item reference numbers. * * * * * * *