diff --git a/docs/configuration/menu-hjson.md b/docs/configuration/menu-hjson.md index 87cee85e..1956252c 100644 --- a/docs/configuration/menu-hjson.md +++ b/docs/configuration/menu-hjson.md @@ -37,7 +37,16 @@ The `config` block for a menu entry can contain common members as well as a per- | `nextTimeout` | Sets the number of **milliseconds** before the system will automatically advanced to the `next` menu. | | `baudRate` | See baud rate information in [General Art Information](/docs/art/general.md). | | `font` | Sets a SyncTERM style font to use when displaying this menus `art`. See font listing in [General Art Information](/docs/art/general.md). | +| `menuFlags` | An array of menu flag(s) controlling menu behavior. See **Menu Flags** below. +#### Menu Flags +The `menuFlags` field of a `config` block can change default behavior of a particular menu. + +| Flag | Description | +|------|-------------| +| `noHistory` | Prevents the menu from remaining in the menu stack / history. When this flag is set, when the **next** menu falls back, this menu will be skipped and the previous menu again displayed instead. Example: menuA -> menuB(noHistory) -> menuC: Exiting menuC returns the user to menuA. | +| `popParent` | When *this* menu is exited, fall back beyond the parent as well. Often used in combination with `noHistory`. | +| `forwardArgs` | If set, when the next menu is entered, forward any `extraArgs` arguments to *this* menu on to it. | ## Forms