You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/components/AssemblyLine/magic_variables.md
+2-30Lines changed: 2 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -452,44 +452,16 @@ This event is used internally by the language switching functions like
452
452
453
453
#### `speak_text`
454
454
455
-
Controls whether the Assembly Line's built-in screen reader functionality is enabled.
455
+
Controls whether the screen reader functionality is enabled.
456
456
The screen reader feature was added not primarily for blind users, but for people with
457
457
low literacy and users on shared workstations or when borrowing mobile devices.
458
458
459
-
Defaults to `True` (screen reader enabled). Set to `False` to disable the text-to-speech
460
-
functionality for the interview.
459
+
Currently defaults to `True` (screen reader enabled). Set to `False` in a `mandatory` block to disable the text-to-speech functionality for the interview. This block must be before the `mandatory` block that runs your interview order.
461
460
462
461
```yaml
463
-
code: |
464
-
speak_text = False
465
-
```
466
-
467
-
This can be set on a per-interview basis in any mandatory code block or in the
468
-
interview order block. For organization-wide control, you can set this variable
469
-
in a shared YAML file that all your interviews include.
470
-
471
-
**Per-interview example:**
472
-
```yaml
473
-
---
474
462
mandatory: True
475
463
code: |
476
464
speak_text = False
477
-
# ... rest of your interview order
478
-
---
479
-
```
480
-
481
-
**Organization-wide example (in a shared file):**
482
-
```yaml
483
-
---
484
-
code: |
485
-
speak_text = False
486
-
---
487
-
```
488
-
489
-
Note: This setting controls the Assembly Line's screen reader feature. For more information
490
-
about Docassemble's built-in text-to-speech functionality, see the
0 commit comments