| Previous | Contents | Index |
Depicts a key from a keyboard or keypad graphically.
<KEY> (key label-1[\key label-2]
)
- [\BOX]
- [\TEXT]
key label-1
Labels the key.key label-2
This is an optional argument. It stacks a second key label under key label-1.BOX
This is an optional keyword argument. It draws a box around the key labels for devices that support this feature. BOX is the default key format.TEXT
This is an optional keyword argument. It encloses the key labels in angle brackets. This format is useful when you specify keys in a body of text.
- <GRAPHIC>
- <KEY_NAME>
- <KEY_PLUS>
- <KEY_SEQUENCE>
Only specify the argument key label-2 when using the <KEY> tag in a key sequence example. For more information, refer to the <KEY_SEQUENCE> tag in this section.Use the BOX keyword argument only for devices that support graphics (such as laser printers).
The <KEY> tag depicts a key from a keyboard or keypad graphically. If you are using the <KEY> tag with the <KEY_SEQUENCE> tag, you can specify a second label that this tag stacks under the first.The optional keyword arguments BOX and TEXT determine how the key labels appear in your document. If you specify BOX (the default), this tag draws a box around the labels. If you specify TEXT, this tag encloses the labels in angle brackets.
In the following example, note that in the context of the <KEY_SEQUENCE> tag, the <KEY> tag accepts two key label-n arguments. Outside the context of the <KEY_SEQUENCE> tag, it accepts only a single key label-n argument.Note also that the first <KEY> tag is specified with no keyword argument. This tag uses the default keyword argument BOX. The second <KEY> tag includes the BOX keyword argument to specify BOX formatting. The third <KEY> tag includes the TEXT keyword argument.
<P> You would use the following sequence of keys: <KEY_SEQUENCE> <KEY>(Next\Screen) <KEY_PLUS> <KEY>(PF3\BOX) <ENDKEY_SEQUENCE> <P> These keys are not associated with the <KEY>(WHITE\TEXT) keys. |
This example produces the following output:
You would use the following sequence of keys: NextScreen + [PF3]
These keys are not associated with the <WHITE> keys.
Specifies an individual keypad diagram and optionally supplies a title for that diagram.
<KEYPAD> [(
)]
- alternate heading[\DISPLAY]
- DISPLAY
alternate heading
Specifies the text of a heading for a keypad diagram.DISPLAY
This is an optional keyword argument that lets you specify individual key labels as arguments to the tags <KEYPAD_ROW> and <KEYPAD_ENDROW>.
- <KEYPAD_ENDROW>
- <KEYPAD_ROW>
- <KEYPAD_SECTION>
Valid only in the context of the <KEYPAD_SECTION> tag.
<ENDKEYPAD>
The <KEYPAD> tag specifies an individual keypad diagram and optionally supplies a title for that diagram. If you use the DISPLAY keyword argument, the <KEYPAD> tag lets you specify individual key labels as arguments to the <KEYPAD_ROW> and <KEYPAD_ENDROW> tags. For more information, see the <KEYPAD_ROW> and <KEYPAD_ENDROW> tag descriptions in this chapter.
The following examples show three keypads.The following example does not include the DISPLAY keyword argument.
| #1 |
|---|
<KEYPAD_SECTION> <KEYPAD>(Using the Command Keypad Function) <KEYPAD_ROW>(CLOSED\\\) <KEYPAD_ROW>(CLOSED\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ENDROW>(\\) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
This example produces the following output:
Using the Command Keypad Function
The following example includes the DISPLAY keyword argument.
| #2 |
|---|
<KEYPAD_SECTION> <KEYPAD>(The Editing Keypad with Key Labels\DISPLAY) <KEYPAD_ROW>(PF1\PF2\PF3\PF4) <KEYPAD_ROW>(7\8\9\-) <KEYPAD_ROW>(4\5\6\,) <KEYPAD_ROW>(1\2\3\ ) <KEYPAD_ENDROW>(0\.\ENTER) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
This example produces the following output:
The Editing Keypad with Key Labels
PF1 PF2 PF3 PF4 7 8 9 - 4 5 6 , 1 2 3 ENTER 0 . The following example includes the DISPLAY keyword argument, and shades two keys.
| #3 |
|---|
<KEYPAD_SECTION> <KEYPAD>(The Editing Keypad with Key Labels and Shaded Keys\DISPLAY) <KEYPAD_ROW>(CLOSED\PF2\PF3\PF4) <KEYPAD_ROW>(7\8\9\-) <KEYPAD_ROW>(CLOSED\5\6\,) <KEYPAD_ROW>(1\2\3\ ) <KEYPAD_ENDROW>(0\.\ENTER) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
This example produces the following output:
The Editing Keypad with Key Labels and Shaded Keys
PF2 PF3 PF4 7 8 9 - 5 6 , 1 2 3 ENTER 0 .
Displays the bottom row of an editing keypad that has up to three keys.
<KEYPAD_ENDROW> (col-1 arg\col-2 arg\col-3 arg)
col-1 arg
Represents one of the three keys that make up the bottom row in the editing keypad. By default, each column accepts one of the following three arguments:
col-2 arg col-3 arg
- CLOSED --- Shades the key in that column.
- NONE --- No key appears in that column.
- OPEN --- Creates an unshaded box. This is the default.
If you use the DISPLAY keyword argument to the <KEYPAD> tag, you can specify alphanumeric strings as individual key labels.
- <KEYPAD>
- <KEYPAD_ROW>
- <KEYPAD_SECTION>
Valid only in the context of a <KEYPAD_SECTION> tag.
The <KEYPAD_ENDROW> tag displays the bottom row of an editing keypad that has up to three keys. The first key is double in width, the second is standard size, and the third is connected with the last key in the previous keypad row. For more information, refer to the examples in the description of <KEYPAD_SECTION> in this section.
See the example in the <KEYPAD_SECTION> tag description.
Displays a row of an editing keypad that has up to four keys.
<KEYPAD_ROW> (col-1 arg\col-2 arg\col-3 arg\col-4 arg)
col-1 arg
Represents one of the four keys that make up a row in the editing keypad. By default, each column accepts one of the following three arguments:
col-2 arg col-3 arg col-4 arg
- CLOSED --- This tag shades the key in that column.
- NONE --- No key appears in that column.
- OPEN --- This tag creates an unshaded box. This is the default.
If you use the DISPLAY keyword argument in the <KEYPAD> tag, you can specify alphanumeric strings as individual key labels.
- <KEYPAD>
- <KEYPAD_ENDROW>
- <KEYPAD_SECTION>
Valid only in the context of a <KEYPAD_SECTION> tag.When this tag is used just before the <KEYPAD_ENDROW> tag, the col-4 arg is ignored to leave room for the large key created by the third argument to the <KEYPAD_ENDROW> tag. See the example in the discussion of the <KEYPAD_SECTION> tag for more information.
The <KEYPAD_ROW> tag displays a row of an editing keypad that has up to four keys. For more information, refer to the examples in the description of the <KEYPAD_SECTION> tag in this section.
See the example in the <KEYPAD_SECTION> tag description.
Begins a series of one or more keypad diagrams.
<KEYPAD_SECTION>
- <KEYPAD>
- <KEYPAD_ENDROW>
- <KEYPAD_ROW>
Only create files containing keypad diagrams for output on devices that support graphics (such as laser printers).
<ENDKEYPAD_SECTION>
The <KEYPAD_SECTION> tag begins a series of one or more keypad diagrams. This tag enables the <KEYPAD>, <KEYPAD_ENDROW>, and <KEYPAD_ROW> tags to graphically depict one or more terminal editing keypads. You must begin each of the keypads (or partial keypads) illustrated in a keypad section with the <KEYPAD> tag and terminate it with the <ENDKEYPAD> tag.
The following examples show several uses of the <KEYPAD_SECTION> tag. In the first example, notice how you use the <KEYPAD_ENDROW> tag to create the large-sized keys found on many calculator keypads.
| #1 |
|---|
<KEYPAD_SECTION> <KEYPAD>(The VT200 Series Editing Keypad) <KEYPAD_ROW>(\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ENDROW>(\\) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
This example produces the following output:
The VT200 Series Editing Keypad
The following example shows two keypads created in a single keypad section.
The first keypad shows a command keypad with two keys filled in.
| #2 |
|---|
<KEYPAD_SECTION> <KEYPAD>(Using the Command Keypad Function) <KEYPAD_ROW>(CLOSED\\\) <KEYPAD_ROW>(CLOSED\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ROW>(\\\) <KEYPAD_ENDROW>(\\) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
The second keypad is an irregularly shaped keypad.
| #3 |
|---|
<KEYPAD_SECTION> <KEYPAD>(Using the SELECT Key) <KEYPAD_ROW>(\\\NONE) <KEYPAD_ROW>(CLOSED\\\NONE) <KEYPAD_ROW>(NONE\\NONE\NONE) <KEYPAD_ROW>(\\\NONE) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
This example produces the following output:
Using the Command Keypad Function
Using the SELECT Key
The following example shows how to create a keypad with the key names placed on each keypad key. Note how the DISPLAY keyword argument is used with the <KEYPAD> tag.
| #4 |
|---|
<KEYPAD_SECTION> <KEYPAD>(The Editing Keypad with Key Labels\DISPLAY) <KEYPAD_ROW>(PF1\PF2\PF3\PF4) <KEYPAD_ROW>(7\8\9\-) <KEYPAD_ROW>(4\5\6\,) <KEYPAD_ROW>(1\2\3\ENTER) <KEYPAD_ENDROW>(0\.\ENTER) <ENDKEYPAD> <ENDKEYPAD_SECTION> |
This example produces the following output:
The Editing Keypad with Key Labels
PF1 PF2 PF3 PF4 7 8 9 - 4 5 6 , 1 2 3 ENTER 0 .
Emphasizes the name of a key in text.
<KEY_NAME> (key name)
key name
Specifies the name of the key. This often corresponds to the name on a key label.
- <CPOS>
- <GRAPHIC>
- <KEY>
- <KEY_SEQUENCE>
DESCRIPTION
The <KEY_NAME> tag emphasizes the name of a key in text. This tag alters the appearance of a key name in text using uppercase letters, boldface, or italics.
Example
In the following example, the <KEY_NAME> tag alters the appearance of the GOLD key.
<P> In EDT, the <KEY_NAME>(GOLD) key changes the function of the other keys on the keypad.This example produces the following output:
In EDT, the key changes the function of the other keys on the keypad.
<KEY_PLUS>
Creates a plus sign between keys in a key sequence example.
Syntax
<KEY_PLUS>
ARGUMENTS
None.
- <KEY>
- <KEY_SEQUENCE>
- <KEY_TYPE>
Valid only in the context of the <KEY_SEQUENCE> tag.
The <KEY_PLUS> tag creates a plus sign between keys in a key sequence example.
The following example shows how you use the <KEY_PLUS> tag to create a plus sign between the BREAK and F10 keys in the context of the <KEY_SEQUENCE> tag.
<KEY_SEQUENCE> <KEY>(BREAK) <KEY_PLUS> <KEY>(F10) = Exit from Function. <ENDKEY_SEQUENCE> |
This example produces the following output: [BREAK] + [F10] = Exit from Function.
Begins a section containing one or more key representations.
<KEY_SEQUENCE>
None.
- <CPOS>
- <GRAPHIC>
- <KEY>
- <KEY_PLUS>
- <KEY_TYPE>
Not available in the context of the example-producing tags (<CODE_EXAMPLE>, <DISPLAY>, <SYNTAX>, and so on) or the <MATH> tag.
<ENDKEY_SEQUENCE>
The <KEY_SEQUENCE> tag begins a section containing one or more key representations. This tag labels an informal example of keys and sequences of keys, and enables two tags that make it easier for you to combine keys and text in your document. The two enabled tags are <KEY_PLUS> and <KEY_TYPE>. For more information concerning these tags, refer to the program example in this section, or refer to the <KEY_PLUS> and <KEY_TYPE> tag descriptions in this section.
The following examples show how to create informal examples of keys and key sequences in your documentation.The following example shows how you use the <KEY_PLUS> and the <KEY> tags.
| #1 |
|---|
<KEY_SEQUENCE> <key>(HELP) = <key>(PF1) <KEY_PLUS> <KEY>(PF2) <ENDKEY_SEQUENCE> |
This example produces the following output: [HELP] = [PF1] + [PF2]
The following example shows how you use other tags in a <KEY_SEQUENCE> tag section and then gives a sample of that output.
| #2 |
|---|
<KEY_SEQUENCE> The <CPOS>(q)uick brown fox jumped over the lazy dog. <KEY>(ADV)<KEY>(WORD) The quick <CPOS>(b)rown fox jumped over the lazy dog. <KEY>(WORD) The quick brown <CPOS>(f)ox jumped over the lazy dog. <KEY>(DEL W) The quick brown <CPOS>( ) jumped over the lazy dog. <ENDKEY_SEQUENCE> |
This example produces the following output: The quick brown fox jumped over the lazy dog. [ADV][WORD] The quick brown fox jumped over the lazy dog. [WORD] The quick brown fox jumped over the lazy dog. [DEL W] The quick brown jumped over the lazy dog.
Provides a descriptive label for keys in a key sequence.
<KEY_TYPE> (labeling text string\key text string)
labeling text string
Labels the keys and text specified in the key text string argument.key text string
Specifies keys and related text.
- <GRAPHIC>
- <KEY_PLUS>
- <KEY_SEQUENCE>
Valid only in the context of a <KEY_SEQUENCE> tag.
The <KEY_TYPE> tag provides a descriptive label for keys in a key sequence. For instance, if you discuss keys from various keyboards (such as the VT125, VT240, and so forth), you may want to label the different types of keys as you describe them in a <KEY_SEQUENCE> tag example.The <KEY_TYPE> tag outputs the labeling text string argument in a bold face font and appends a colon (:) to it. The key text string argument outputs on the same line in the standard text font.
The following example shows how to use the <KEY_TYPE> tag to label a sequence of keys.
<KEY_SEQUENCE> <KEY_TYPE>(LK201\<KEY>(F10) = Exit from Function.) <ENDKEY_SEQUENCE> |
This example produces the following output: LK201:[F10] = Exit from Function.
Begins a section of error message descriptions.
<MESSAGE_SECTION>
None.
- <MESSAGE_TYPE>
- <MSG>
- <MSGS>
- <MSG_ACTION>
- <MSG_FACILITY>
- <MSG_SEVERITY>
- <MSG_TEXT>
<ENDMESSAGE_SECTION>
The <MESSAGE_SECTION> tag begins a section of error message descriptions. This tag enables the message tags listed as related tags in this tag description.Messages generally come in one of three forms:
- A message text string only; for example, System Resources Unavailable.
- A message text string preceded by a text string identification code; for example, %DIRECT-W-NOFILES, no files found.
- A message text string preceded by a numeric string identification code; for example, %1288374 file lookup failed.
Select the tags you need to use in the message description section based upon the following criteria:
- The format your messages most closely resemble
- The number of lines each message occupies on the terminal display
Specify the format for your message section by using the <MESSAGE_TYPE> tag. The <MESSAGE_TYPE> tag accepts one of three keywords:
- NOIDENT---Specifies that the message contains no message identification string and that only message text will be specified.
- TEXTIDENT---Specifies that the message contains a text message identification string as well as message text.
- NUMIDENT---Specifies that the message contains a numeric message identification string as well as message text.
Select one of two message labeling tags (<MSG> or<MSGS>) based upon the number of messages or message text lines you need to describe in a single tag.
- <MSG>
Describes a single message with one or two lines of message text.- <MSGS>
Describes either a single message with up to nine lines of message text, or up to four message identification string/message text pairs.Use the <MSG_TEXT> tag to describe the error messages. Each use of the <MSG_TEXT> tag creates a separate description section that you can label with a single word heading (such as Facility or Severity). If you do not specify a heading for this tag, it uses the heading, Explanation:. You can use the <MSG_TEXT> tag as many times as you find necessary in the error message description section.
To complete your error message section, repeat using the <MSG> (or <MSGS>) and <MSG_TEXT> tags until you describe all your messages. End the error message section by using the <ENDMESSAGE_SECTION> tag.
The following examples illustrate the two syntaxes available with the <MSG> tag and how they are specified. The second example also shows a sample use of the <MSGS> tag so you can compare the output of the <MSG> and <MSGS> tags.In the first example, the NOIDENT keyword argument is used with the <MESSAGE_TYPE> tag. Therefore, the <MSG> tag only accepts two arguments.
In the second example, the TEXTIDENT keyword is used with the <MESSAGE_TYPE> tag. Therefore, the <MSG> tags in this section will accept one message identifier and up to two message text arguments. Note also that the <MSGS> tag used in this example accepts two pairs of message identifier/message text arguments.
| #1 |
|---|
<MESSAGE_SECTION> <MESSAGE_TYPE>(NOIDENT) <MSG>(error initiating system\initialization file not found) <MSG_TEXT> The system could not begin operation because it could not find the system initialization file. <MSG_TEXT>(User Action) Check for the existence of the system initialization file. If it exists, check that it is in your current default directory. <ENDMESSAGE_SECTION> |
This example produces the following output:
error initiating system initialization file not found
Explanation: The system could not begin operation because it could not find the system initialization file.
User Action: Check for the existence of the system initialization file. If it exists, check that it is in your current default directory.
| #2 |
|---|
<MESSAGE_SECTION> <MESSAGE_TYPE>(TEXTIDENT) <MSG>(BCK-F-BADLNK\Incorrect directory back link\Directory not found) <MSG_TEXT>(Facility) VERIFY, Verify Utility <MSG_TEXT>(Severity) Fatal <MSG_TEXT> The Verify Utility could not process your command. Please check the syntax of your statement. <MSG_TEXT>(User Action) Check the syntax of the command, especially the directory specification, and reenter the command. <MSGS>(UAF-E-NAOFIL\unable to open file SYSUAF.DAT\-RMS-E-FNF\file not found) <MSG_TEXT> The AUTHORIZE Utility could not locate the file SYSUAF.DAT. <MSG_TEXT>(User Action) Check that your process is currently set to the system default directory, SYS$SYSTEM, and then reissue the command. <ENDMESSAGE_SECTION> |
Previous Next Contents Index