Syntax


NOTE[n]  or

xNOTE[n]



Operands


n

The number of new, blank =NOTE> or xNOTE> lines to be created. If n is omitted or specified as zero, one line is created.


Up to 99 such lines can be directly created with a single NOTE line command, or up to 9 for xNOTE, unless the sequence number field has been made wider than 6 columns. If the sequence field has a width of 5, up to 9 =NOTE> lines can be created, and only a single xNOTE> line. See note below.


See Width of Line Numbers in Options - Screen for information about adjusting the width of the sequence number area.


Description


The NOTE or xNOTE line command provides a quick way to create a number of blank =NOTE> lines. These lines can then be typed-over with any desired information.


You can create either simple NOTE lines or use an alphabetic prefix character from A to Y to create different types of notes, such as CNOTE, MNOTE, etc.


xNOTE lines are most likely be used by some macro command, such as one used in conjunction with a compiler, to insert diagnostic message lines into the text based on the compiler output, perhaps using different xNOTE types for various error severity levels. SPFLite does not provide such macros; you would have to write them yourself.


The keyword ZNOTE is reserved for use on the primary command line; you cannot enter ZNOTE into the sequence area as a line command.


Inserting additional NOTE lines


Because of the length of the NOTE or xNOTE line commands, there is limited room for specifying the n value if you need to insert many blank note lines. There are two methods for creating more note lines than can be specified by the n value:


    • If more note lines are needed, a single =NOTE> or xNOTE> line can be made first, then the R line command can be used to repeat the note line as many times as desired.


    • Say you need 25 new XNOTE lines, but the n value only allows up to 9 (or, perhaps there is no room for the n at all). If these lines were to appear after line 100 in your file, you could create them from the primary command line using a LINE primary command. This works because, internally, SPFLite treats the sequence number field as if it were 8 columns wide, even if not all 8 columns are displayed):


LINE XNOTE25 .100


See Working with NOTE and xNOTE Lines for more information.



Created with the Personal Edition of HelpNDoc: What is a Help Authoring tool?