Skip to content

How to document GUIs and Menus

To describe (a sequence of) menu items or GUI elements, you can format them using the gui inline language, and separate them with >. For example, this describes a preferences sequence in Eclipse:

Open the `#!gui General > Startup and Shutdown` settings page.

It is rendered as:

Open the General ‣ Startup and Shutdown settings page.

Last update: May 17, 2023
Created: May 17, 2023