Logo Docs
Logo Docs

@YES_NO_QUESTION

Specifies that a variable expects to receive a “Yes” or “No” (TRUE or FALSE) and customize how to ask for the value.

Before generating a document, DocuMold will display a “Yes” and a “No” to pick from.

Usage

<# @YES_NO_QUESTION(variable, **see parameters below**) #>

Parameters

variable

(Required) The variable this applies to. Do not use double quotes (") around it, just write it as a usage of the variable.
example_value:

(Named) The initial value in the form when preparing a template (via “Prepare a template”). Must be TRUE or FALSE. If not given, the value of initial_value is used.
help_text:

(Named) Displays a clickable (?) bubble beside the label. Clicking it will reveal this text. Useful to give directions to the user of the DocuMold template.
initial_value:

(Named) The initial value in the form when using a template (via “Use a template”). Must be TRUE or FALSE. This is also the default value of the example_value parameter.
label:

(Named) The text to display beside the radio buttons that asks for the value. Defaults to variable’s name.
optional:

(Named) Set this to TRUE to allow the user to not make a choice (value would then be NOTHING)

Parameters with “Named” mean that you must specify the name of the parameter and a colon before its value. Ex: example_value: "its value"

Examples

Example Result

<# @YES_NO_QUESTION(needs_review, label: “Must be reviewed”, help_text: “Whether the user needs to review the final documents”) #>

More information

The value in the variable will be one of the special TRUE or FALSE values, not a text. This means it’s possible to use logic-related functions with the variable, such as use it as a condition in a IF.

If no value is selected in the form for this question, the variable will be set to NOTHING.

This action does nothing to the document itself; it gets erased when generating a document.

All @..._QUESTION actions are normally placed at the end of the template to avoid overwhelming unfamiliar users.

The @IF action has no effect on the @...QUESTION actions. The @...QUESTION actions have an effect even when they is hidden.

See also