Skip to content

Commit c265956

Browse files
Merge pull request #561 from SuffolkLITLab/copilot/fix-192
Document how to disable screen reader functionality using speak_text variable
2 parents 9dece72 + 2a28b1a commit c265956

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/components/AssemblyLine/magic_variables.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,20 @@ argument and calls Docassemble's `set_language()` function.
448448
This event is used internally by the language switching functions like
449449
`get_language_list_dropdown()` and `get_language_list()`.
450450

451+
### Screen reader control
452+
453+
#### `speak_text`
454+
455+
Controls whether the screen reader functionality is enabled.
456+
The screen reader feature was added not primarily for blind users, but for people with
457+
low literacy and users on shared workstations or when borrowing mobile devices.
458+
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.
460+
461+
```yaml
462+
mandatory: True
463+
code: |
464+
speak_text = False
451465
## Run-time options
452466
453467
These options are ones that you can sometimes configure when you author the

0 commit comments

Comments
 (0)