Skip to content

Commit 252120a

Browse files
Add documentation for speak_text variable to disable screen reader
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
1 parent 23b6d3b commit 252120a

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/components/AssemblyLine/magic_variables.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,48 @@ 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 Assembly Line's built-in 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+
Defaults to `True` (screen reader enabled). Set to `False` to disable the text-to-speech
460+
functionality for the interview.
461+
462+
```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+
mandatory: True
475+
code: |
476+
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
491+
[Docassemble documentation](https://docassemble.org/docs/special.html#speak_text).
492+
451493
## Run-time options
452494

453495
These options are ones that you can sometimes configure when you author the

0 commit comments

Comments
 (0)