From 23b6d3b589062ebe72652c41e168613da74851ca Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 18 Sep 2025 17:38:57 +0000 Subject: [PATCH 1/3] Initial plan From 252120a52c39f63c9c84115e6cd2edbe1f14d5a5 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 18 Sep 2025 17:45:34 +0000 Subject: [PATCH 2/3] Add documentation for speak_text variable to disable screen reader Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com> --- .../AssemblyLine/magic_variables.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/docs/components/AssemblyLine/magic_variables.md b/docs/components/AssemblyLine/magic_variables.md index 03cf20337..dad633e5e 100644 --- a/docs/components/AssemblyLine/magic_variables.md +++ b/docs/components/AssemblyLine/magic_variables.md @@ -448,6 +448,48 @@ argument and calls Docassemble's `set_language()` function. This event is used internally by the language switching functions like `get_language_list_dropdown()` and `get_language_list()`. +### Screen reader control + +#### `speak_text` + +Controls whether the Assembly Line's built-in screen reader functionality is enabled. +The screen reader feature was added not primarily for blind users, but for people with +low literacy and users on shared workstations or when borrowing mobile devices. + +Defaults to `True` (screen reader enabled). Set to `False` to disable the text-to-speech +functionality for the interview. + +```yaml +code: | + speak_text = False +``` + +This can be set on a per-interview basis in any mandatory code block or in the +interview order block. For organization-wide control, you can set this variable +in a shared YAML file that all your interviews include. + +**Per-interview example:** +```yaml +--- +mandatory: True +code: | + speak_text = False + # ... rest of your interview order +--- +``` + +**Organization-wide example (in a shared file):** +```yaml +--- +code: | + speak_text = False +--- +``` + +Note: This setting controls the Assembly Line's screen reader feature. For more information +about Docassemble's built-in text-to-speech functionality, see the +[Docassemble documentation](https://docassemble.org/docs/special.html#speak_text). + ## Run-time options These options are ones that you can sometimes configure when you author the From 2a28b1a9c93ae50c8533da889fd7b121d18a4fbf Mon Sep 17 00:00:00 2001 From: Quinten Steenhuis Date: Thu, 18 Sep 2025 14:58:26 -0400 Subject: [PATCH 3/3] Update docs/components/AssemblyLine/magic_variables.md --- .../AssemblyLine/magic_variables.md | 32 ++----------------- 1 file changed, 2 insertions(+), 30 deletions(-) diff --git a/docs/components/AssemblyLine/magic_variables.md b/docs/components/AssemblyLine/magic_variables.md index dad633e5e..671d068ba 100644 --- a/docs/components/AssemblyLine/magic_variables.md +++ b/docs/components/AssemblyLine/magic_variables.md @@ -452,44 +452,16 @@ This event is used internally by the language switching functions like #### `speak_text` -Controls whether the Assembly Line's built-in screen reader functionality is enabled. +Controls whether the screen reader functionality is enabled. The screen reader feature was added not primarily for blind users, but for people with low literacy and users on shared workstations or when borrowing mobile devices. -Defaults to `True` (screen reader enabled). Set to `False` to disable the text-to-speech -functionality for the interview. +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. ```yaml -code: | - speak_text = False -``` - -This can be set on a per-interview basis in any mandatory code block or in the -interview order block. For organization-wide control, you can set this variable -in a shared YAML file that all your interviews include. - -**Per-interview example:** -```yaml ---- mandatory: True code: | speak_text = False - # ... rest of your interview order ---- -``` - -**Organization-wide example (in a shared file):** -```yaml ---- -code: | - speak_text = False ---- -``` - -Note: This setting controls the Assembly Line's screen reader feature. For more information -about Docassemble's built-in text-to-speech functionality, see the -[Docassemble documentation](https://docassemble.org/docs/special.html#speak_text). - ## Run-time options These options are ones that you can sometimes configure when you author the