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

docs: fix rawparams example by truncating comments

Browse Source 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
This commit is contained in:
Pedro Lamas
2022-07-04 09:37:24 +01:00
committed by KevinOConnor
parent 50b4d4c43c
commit 6be114d728
2 changed files with 28 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/Command_Templates.md
View File

@@ -130,22 +130,13 @@ gcode:
### The "rawparams" variable
The full unparsed parameters for the running macro can be access via the `rawparams` pseudo-variable.
The full unparsed parameters for the running macro can be access via the
`rawparams` pseudo-variable.
This is quite useful if you want to change the behavior of certain commands like the `M117`. For example:
Note that this will include any comments that were part of the original command.
```
[gcode_macro M117]
rename_existing: M117.1
gcode:
{% if rawparams %}
{% set escaped_msg = rawparams|replace('"', '\\"') %}
SET_DISPLAY_TEXT MSG="{escaped_msg}"
RESPOND TYPE=command MSG="{escaped_msg}"
{% else %}
SET_DISPLAY_TEXT
{% endif %}
```
See the [sample-macros.cfg](../config/sample-macros.cfg) file for an example
showing how to override the `M117` command using `rawparams`.
### The "printer" Variable