Documentation Comments
Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.
RealityV15.1Online Documentation (MoTW) Revision 7
Conventions (RealWeb) (conventions.htm)
The following conventions are used in this help system:
|
|
Bold text shown in this typeface is used to indicate input which must be typed on the keyboard. |
|
|
Text shown in this typeface is used to show text that is output to the screen. |
|
Bold text |
Bold text in syntax descriptions represents characters typed exactly as shown. For example: RWS_HEADING(vString, Level, aClass) |
|
Text |
Characters or words in italics indicate parameters which must be supplied by the user. For example, in RWS_HEADING(vString, Level, aClass) the parameters vString, Level and aClass are italicized to indicate that this is the general form of the RWS_HEADING subroutine. In an actual program, the user supplies particular arguments for the place-holders vString, Level and aClass. Italic text is also used for titles of documents referred to by this document, where these are not available on-line.. |
| Document | Blue italic text is used for links to other on-line documents. |
|
vText |
A lower case v prefixing a parameter name indicates that a variable must be supplied so that a value can be returned. In the above example, for instance, the 'v' prefix to the parameter name vChild indicates that, in an actual program, the user must supply the name of a variable in which to return the handle of the child which currently has the focus. |
|
aText |
A lower case a prefixing a parameter name indicates that the programmer must supply a dynamic array. |
...
|
In the DATA/BASIC program examples, ellipses are used to split lines of code for clarity. Since in DATA/BASIC an ellipsis indicates that a line of code continues on the next line, this does not prevent compilation of the examples. Vertical ellipses are used in program examples to indicate that a portion of the program is omitted. |
In general, the RealWeb subroutines have been given names that indicate the type of operation they perform: