3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Move description of menu templates to Command_Templates.md 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-05-28 20:30:28 -04:00
parent 4f939c18e9
commit 3a25db1247
2 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/Command_Templates.md
View File

@ -279,6 +279,30 @@ gcode:
UPDATE_DELAYED_GCODE ID=report_temp DURATION=0
```
### Menu templates
If a [display config section](Config_Reference.md#display) is enabled,
then it is possible to customize the menu with
[menu](Config_Reference.md#menu) config sections.
The following read-only attributes are available in menu templates:
* `menu.width` - element width (number of display columns)
* `menu.ns` - element namespace
* `menu.event` - name of the event that triggered the script
* `menu.input` - input value, only available in input script context
The following actions are available in menu templates:
* `menu.back(force, update)`: will execute menu back command, optional
boolean parameters `<force>` and `<update>`.
* When `<force>` is set True then it will also stop editing. Default
value is False.
* When `<update>` is set False then parent container items are not
updated. Default value is True.
* `menu.exit(force)` - will execute menu exit command, optional
boolean parameter `<force>` default value False.
* When `<force>` is set True then it will also stop editing. Default
value is False.
### Save Variables to disk
<!-- {% raw %} -->

22
docs/Config_Reference.md
View File

@ -3533,25 +3533,9 @@ A [default set of menus](../klippy/extras/display/menu.cfg) are
automatically created. One can replace or extend the menu by
overriding the defaults in the main printer.cfg config file.
Available options in menu Jinja2 template context:
Read-only attributes for menu element:
* menu.width - element width (number of display columns)
* menu.ns - element namespace
* menu.event - name of the event that triggered the script
* menu.input - input value, only available in input script context
List of actions for menu element:
* menu.back(force, update): will execute menu back command, optional
boolean parameters <force> and <update>.
* When <force> is set True then it will also stop editing. Default
value is False
* When <update> is set False then parent container items are not
updated. Default value is True
* menu.exit(force) - will execute menu exit command, optional boolean
parameter <force> default value False
* When <force> is set True then it will also stop editing. Default
value is False
See the [command template
document](Command_Templates.md#menu-templates) for information on menu
attributes available during template rendering.
```
# Common parameters available for all menu config sections.