User Interface Macros

On this page, you’ll learn:

  • How to mark up a button (press Submit) with AsciiDoc.

  • How to mark up a keybindings (Ctrl+Shift+N) with AsciiDoc.

  • How to mark up a menu (View  Zoom  Reset) with AsciiDoc.

Set the experimental attribute

The attribute experimental must be set in the page header or globally to enable the UI macros styles in HTML.

Button syntax

Communicate that a user should press a button with the button macro.

Button UI macro
Press the btn:[Submit] button when you are finished the survey.

Select a file in the file navigator and click btn:[Open].
Result

Press the Submit button when you are finished the survey.

Select a file in the file navigator and click Open.

Asciidoctor resources

Keybinding syntax

Create keyboard shortcuts with the keybinding macro.

Keybinding UI macro
Press kbd:[esc] to exit insert mode.

Use the shortcut kbd:[Ctrl+T] to open a new tab in your browser.

kbd:[Ctrl+Shift+N] will open a new incognito window.
Result

Press esc to exit insert mode.

Use the shortcut Ctrl+T to open a new tab in your browser.

Ctrl+Shift+N will open a new incognito window.

Asciidoctor resources

Show readers how to select a menu item with the menu macro.

Menu UI macro
To save the file, select menu:File[Save].

Select menu:View[Zoom > Reset] to reset the zoom level to the default setting.
Result

To save the file, select File  Save.

Select View  Zoom  Reset to reset the zoom level to the default setting.

Asciidoctor resources