Using control words

Control words are macros that perform a specialized function.

Introduction-to-the-BMC-AMI-Ops-tag-language

Unlike tags, they do not control the format of text. Control words:

Must begin in the first column of an input line
Begin with a . (period)
Do not require a terminating character

The valid control words for BMC AMI Ops are shown in following figure.

Control word	Description
.*	Indicates that the text that follows is a comment Comments do not appear in the Help text pop-up windows. In the example of a Help text member shown in the Example Help tags and text figure in Using-the-tag-language, the comment 'This is a comment' is shown, but it does not appear in the formatted Help text shown in the Formatted Help text figure in Using-the-tag-language. If your comment exceeds one line, you must use the .* control word at the beginning of each line.
.im	Imbeds the text contained in the member name on the same line Using the .im control word, you can imbed the same Help text in more than one Help member. For example, if you add .im ASGDMN to a new Help text member, the text shown in the Formatted Help text figure in Using-the-tag-language will appear at the exact location where you placed the .im tag. The imbed tag is especially useful when you want to add your own note to a Help topic that was distributed with your BMC AMI Ops product. To add a note: Create a member with an appropriate name. Add your own text to the member. Add an .im tag followed by the same id= value that you specified on your :h1 tag. The distributed BMC AMI Ops Help text is inserted wherever you placed the .im tag. (When you imbed a member into a member by the same name, BMC AMI Ops assumes that you mean to imbed the distributed Help text, not your own member. This process prevents recursive loops from occurring.)

Control word

Description

Indicates that the text that follows is a comment

Comments do not appear in the Help text pop-up windows.

In the example of a Help text member shown in the Example Help tags and text figure in Using-the-tag-language, the comment 'This is a comment' is shown, but it does not appear in the formatted Help text shown in the Formatted Help text figure in Using-the-tag-language.

If your comment exceeds one line, you must use the .* control word at the beginning of each line.

.im

Imbeds the text contained in the member name on the same line

Using the .im control word, you can imbed the same Help text in more than one Help member. For example, if you add .im ASGDMN to a new Help text member, the text shown in the Formatted Help text figure in Using-the-tag-language will appear at the exact location where you placed the .im tag.

The imbed tag is especially useful when you want to add your own note to a Help topic that was distributed with your BMC AMI Ops product. To add a note:

Create a member with an appropriate name.
Add your own text to the member.
Add an .im tag followed by the same id= value that you specified on your :h1 tag.

The distributed BMC AMI Ops Help text is inserted wherever you placed the .im tag. (When you imbed a member into a member by the same name, BMC AMI Ops assumes that you mean to imbed the distributed Help text, not your own member. This process prevents recursive loops from occurring.)

Using control words

On this page