error
Sample Usage
Count: {formtext: name=count; default=0} (count must be greater than 0)
{if: catch(count <= 0, yes)}{error: The count is not greater than 0!; block=yes}{endif}
{if: catch(count <= 0, yes)}{error: The count is not greater than 0!; block=yes}{endif}
_
Attributes
| Attribute Name | Type | Description |
|---|---|---|
| Positional | text | The error message to show to the user. |
| block | yes/no | If yes, blocks insertion while the error is shown. |
| trim | yes/no/left/right | If yes whitespace is removed before and after the command. If left, only whitespace to the left is removed. If right, only whitespace to the right is removed. |
The error command can be used for form validation and for preventing a form from being inserted until certain conditions are satisfied.
If block is no the message will be displayed to the user. If block is yes, the message will be displayed and the user will not be able to insert the snippet as long as the error is shown.
As shown in the example above, you can combine the error command with an {if} command to conditionally show an error and block form insertion.