Skip to content

Add missing panel descriptions in the settings dialogs. #17701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Add missing panel descriptions in the settings dialogs. #17701

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
46381c2
Add missing panel descriptions in the settings dialogs.
Feb 14, 2025
bda588a
Pre-commit auto-fix
pre-commit-ci[bot] Feb 15, 2025
2484e46
Implementing the first reviews from the first comments.
Feb 17, 2025
78d2372
Making additional adjustments from reviws.
Feb 19, 2025
0802c56
Apply suggestions from code review
seanbudd Feb 20, 2025
4ec2bd6
Update source/gui/settingsDialogs.py
SaschaCowley Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions source/gui/settingsDialogs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ class SettingsPanel(

To use this panel:
* Set L{title} to the title of the category.
* Set :attr:`panelDescription` to describe the purpose of the category.
* Override L{makeSettings} to populate a given sizer with the settings controls.
* Optionally, extend L{onPanelActivated} to perform actions after the category has been selected in the list of categories, such as synthesizer or braille display list population.
* Optionally, extend L{onPanelDeactivated} to perform actions after the category has been deselected (i.e. another category is selected) in the list of categories.
Expand All @@ -360,6 +361,7 @@ class SettingsPanel(

@ivar title: The title of the settings panel, also listed in the list of settings categories.
@type title: str
:ivar panelDescription: The description shown in the settings dialog when the category is selected.
"""

title = ""
Expand Down Expand Up @@ -785,6 +787,12 @@ class GeneralSettingsPanel(SettingsPanel):
# Translators: This is the label for the general settings panel.
title = _("General")
helpId = "GeneralSettings"
panelDescription = _(
# Translators: This is a label appearing on the general settings panel.
"Configures general settings like the log level and options for starting and terminating NVDA. "
"You will also find the settings related to updating NVDA here. ",
)

LOG_LEVELS = (
# Translators: One of the log levels of NVDA (the disabled mode turns off logging completely).
(log.OFF, _("disabled")),
Expand Down Expand Up @@ -1169,6 +1177,11 @@ class SpeechSettingsPanel(SettingsPanel):
# Translators: This is the label for the speech panel
title = _("Speech")
helpId = "SpeechSettings"
panelDescription = _(
# Translators: This is a label appearing on the speech settings panel.
"Configures the synthesizer, the voice, variant and other aspects of speech output. "
"This includes settings for how NVDA reads symbols, capitals and text in other languages. ",
)

def makeSettings(self, settingsSizer):
settingsSizerHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -1644,6 +1657,10 @@ class VoiceSettingsPanel(AutoSettingsMixin, SettingsPanel):
# Translators: This is the label for the voice settings panel.
title = _("Voice")
helpId = "SpeechSettings"
panelDescription = _(
# Translators: This is a label appearing on the voice settings panel.
"Configures the voice settings for the selected speech synthesizer.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this information really show up somewhere? I cannot see it nor hear it.

)

@property
def driver(self):
Expand Down Expand Up @@ -1948,6 +1965,11 @@ class KeyboardSettingsPanel(SettingsPanel):
# Translators: This is the label for the keyboard settings panel.
title = _("Keyboard")
helpId = "KeyboardSettings"
panelDescription = _(
# Translators: This is a label appearing on the keyboard settings panel.
"Configures the various settings that influence keyboard behaviour. "
"These settings also control how speech output is treated when typing. ",
)

def makeSettings(self, settingsSizer):
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -2120,6 +2142,11 @@ class MouseSettingsPanel(SettingsPanel):
# Translators: This is the label for the mouse settings panel.
title = _("Mouse")
helpId = "MouseSettings"
panelDescription = _(
# Translators: This is a label appearing on the mouse settings panel.
"Configures settings for mouse tracking and feedback such as reading the object under the mouse. "
"Here you will also configure the audio feedback for the mouse position. ",
)

def makeSettings(self, settingsSizer):
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -2207,6 +2234,10 @@ class ReviewCursorPanel(SettingsPanel):
# Translators: This is the label for the review cursor settings panel.
title = _("Review Cursor")
helpId = "ReviewCursorSettings"
panelDescription = _(
# Translators: This is a label appearing on the review cursor settings panel.
"Configure the review cursor, which allows reading the contents of the screen, current document or current object without moving the caret",
)

def makeSettings(self, settingsSizer):
# Translators: This is the label for a checkbox in the
Expand Down Expand Up @@ -2245,6 +2276,11 @@ class InputCompositionPanel(SettingsPanel):
# Translators: This is the label for the Input Composition settings panel.
title = _("Input Composition")
helpId = "InputCompositionSettings"
panelDescription = _(
# Translators: This is a label appearing on the input composition settings panel.
"Configure how NVDA reports the input of Asian characters, "
"such as when using IME or Text Service input methods.",
)

def makeSettings(self, settingsSizer):
self.autoReportAllCandidatesCheckBox = wx.CheckBox(
Expand Down Expand Up @@ -2494,6 +2530,10 @@ class BrowseModePanel(SettingsPanel):
# Translators: This is the label for the browse mode settings panel.
title = _("Browse Mode")
helpId = "BrowseModeSettings"
panelDescription = _(
# Translators: This is a label appearing on the browse mode settings panel.
"Configure how NVDA behaves when reading complex documents, such as web pages and emails.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Configure how NVDA behaves when reading complex documents, such as web pages and emails.",
"Configure how NVDA behaves when reading complex documents, such as web pages and e-mails.",

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But actually, are e-mails in Thunderbird in browse mode?

)

def makeSettings(self, settingsSizer):
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -2995,6 +3035,10 @@ class DocumentNavigationPanel(SettingsPanel):
# Translators: This is the label for the document navigation settings panel.
title = _("Document Navigation")
helpId = "DocumentNavigation"
panelDescription = _(
# Translators: This is a label appearing on the document navigation settings panel.
"Configures options impacting how you navigate in a document with the cursor. ",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Configures options impacting how you navigate in a document with the cursor. ",
"Configures options controlling how you navigate in a document with the cursor. ",

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text does not seem to be visible (visually).

)

def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -3028,6 +3072,10 @@ class AudioPanel(SettingsPanel):
# Translators: This is the label for the audio settings panel.
title = _("Audio")
helpId = "AudioSettings"
panelDescription = _(
# Translators: This is a label appearing on the audio settings panel.
"Configures the audio settings like volume and sound splitting.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, this description is not needed. It only adds more verbosity for no more useful information.

)

def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -3240,6 +3288,10 @@ class AddonStorePanel(SettingsPanel):
# Translators: This is the label for the addon navigation settings panel.
title = _("Add-on Store")
helpId = "AddonStoreSettings"
panelDescription = _(
# Translators: This is a label appearing on the addon store settings panel.
"Configures the Add-on Store, including how to handle updates. ",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This information is not visually visible. Moreover, is it really useful? It only adds verbosity.

)

def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -3353,6 +3405,11 @@ class TouchInteractionPanel(SettingsPanel):
# Translators: This is the label for the touch interaction settings panel.
title = _("Touch Interaction")
helpId = "TouchInteraction"
panelDescription = _(
# Translators: This is a label appearing on the touch interaction settings panel.
"Configures touch interaction (where available). "
"Includes enabling touch interaction support and setting the touch typing mode. ",
)

def makeSettings(self, settingsSizer):
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand All @@ -3378,6 +3435,10 @@ class UwpOcrPanel(SettingsPanel):
# Translators: The title of the Windows OCR panel.
title = _("Windows OCR")
helpId = "Win10OcrSettings"
panelDescription = _(
# Translators: This is a label appearing on the windows OCR settings panel.
"Configures options for text recognition from images. ",
)

def makeSettings(self, settingsSizer):
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down Expand Up @@ -4131,6 +4192,11 @@ class BrailleSettingsPanel(SettingsPanel):
# Translators: This is the label for the braille panel
title = _("Braille")
helpId = "BrailleSettings"
panelDescription = _(
# Translators: This is a label appearing on the braille settings panel.
"Configures various settings for braille input and output. "
"You can set which braille table to be used and other options. ",
)

def makeSettings(self, settingsSizer):
settingsSizerHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
Expand Down