Button and Menu UI Macros
In order to use the UI macros, you must set the
It can be difficult to communicate to the reader that they need to press a button.
They can’t tell if you are saying “OK” or they are supposed to look for a button labeled OK.
It’s all about getting the semantics right.
btn macro to the rescue!
Press the btn:[OK] button when you are finished. Select a file in the file navigator and click btn:[Open].
The result of Example 1 is displayed below.
Press the OK button when you are finished.
Select a file in the file navigator and click Open.
Trying to explain how to select a menu item can be a pain.
menu macro, the symbols do the work.
The instructions in Example 2 appear below.
To save the file, select.
Selectto reset the zoom level to the default setting.
If the menu has more than one item, it can be expressed using a shorthand.
|The shorthand syntax for menu is not on a standards track. You can use it for transient documents, but do not rely on it long term.|
In the shorthand syntax:
each item is separated by a greater than sign (
>) with spaces on either side
the whole expression must be enclosed in double quotes (
The text of the item itself may contain spaces.
The shorthand syntax can be escaped by preceding the opening double quote with a backslash character.
Both the menu macro and menu shorthand require the first menu item start with a word character (alphanumeric character or underscore) or ampersand (to accommodate a character reference).
If you need the first menu item to start with a non-word character, you will need to substitute it with the equivalent character reference.
For example, to make a menu item that starts with vertical ellipsis, you must use
Subsequent menu items don’t have this requirement and thus can start with any character.