Skip to content

Commit

Permalink
Update userGuide.t2t
Browse files Browse the repository at this point in the history
Add section on add-on store to the Quick Start Guide.
  • Loading branch information
Qchristensen committed May 6, 2024
1 parent bf96860 commit b9b3dce
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions user_docs/en/userGuide.t2t
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,64 @@ To open NVDA's menu, press ``NVDA+n``.
To open NVDA's general settings dialog directly, press ``NVDA+control+g``.
Many settings screens have keystrokes to open them directly, such as ``NVDA+control+s`` for synthesizer, or ``NVDA+control+v`` for other voice options.

++ Add-ons ++[Addons]
Add-ons are like small programs which provide new or changed functionality for NVDA.
Add-ons are developed by the NVDA community, or external companies.
As with any software, it is important to be confident in the developer of an add-on before using it.
The "Add-ons and the Add-on Store" section of the user guide contains information about every feature of the add-on store.

The add-on store is available from the Tools menu.
Press ``NVDA+n`` to open the NVDA menu, then ``t`` for tools, then ``a`` for add-on store.
When the add-on store opens, it shows "Available add-ons" if no add-ons are installed.
When add-ons are installed, the focus starts in the "Installed add-ons" tab when the add-on store opens.

+++ Available add-ons +++[AvailableAddons]
When the window first opens, add-ons may take a few seconds to load.
NVDA will read the name of the first add-on once the list of add-ons finishes loading.
Available add-ons are listed alphabetically in a grid.
Use the ``arrow keys`` or press the first letter of an add-on name to move around the list.
Press ``tab`` once to move to a description of the currently selected add-on.
Use the reading or ``arrow keys`` to read the full description.
Press ``tab`` to the "Actions" button, which can be used to install the add-on, among other actions.
Press ``tab`` to "Other Details", which lists details such as the publisher, version and homepage.
To return to the list of add-ons, press ``alt+a``, or ``shift+tab`` back to the "Available add-ons" list.

+++ Searching for add-ons +++[SearchingForAddons]
As well as browsing all available add-ons, it is possible to filter the add-ons shown.
To search, press ``alt+s`` to jump to the "search" field and type the text to search for.
The list changes while typing the search, once done, press ``tab`` to go to the filtered list of add-ons.

+++ Installing add-ons +++[InstallingAddons]
With the focus on an add-on you would like to install, press ``enter``.
The actions menu opens with a list of options.
These actions include: "Install", "Home page", "License", "Source code", "Community reviews".
To install the add-on, press ``i`` or ``down arrow`` to "install" and press ``enter``.
The focus returns to the add-on in the list and NVDA will read the details about the add-on.
The "Status" information reported by NVDA changes from "Available" to "Downloading".
Once the add-on has finished downloading, it will change to "Downloaded. Pending install".
Repeat with any other add-ons you would like to install at the same time.
Once finished, press ``tab`` until the focus is on the "Close" button, then press ``enter``.
A dialog appears advising that changes were made, and you must restart NVDA.
Press ``enter`` to restart NVDA.

+++ Browsing installed add-ons +++[BrowsingInstalledAddons]
Press ``alt+tab`` to move between the tabs or sections of the add-on store.
The tabs include: "Installed add-ons", "Updatable add-ons", "Available add-ons" and "Installed incompatible add-ons".
Each of the tabs is set out the same as the "Available add-ons" tab.
The actions menu of installed add-ons includes "Disable", and "Remove" rather than "Install".
Disabling an add-on stops NVDA from loading it, but leaves it installed.
To re-enable a disabled add-on, activate "Enable" from the actions menu.
After enabling, disabling, or removing add-ons, NVDA will prompt to restart when closing the add-on store.
Note that in this dialog ``escape`` works the same as the close button.
Any changes you had made in the dialog have already happened, but they don't take effect until NVDA restarts.

+++ Updating add-ons +++[UpdatingAddons]
When there is an update to an add-on you have installed, it will be listed in the "Updatable add-ons" tab.
Press ``control+tab`` to get to this tab from anywhere in the add-on store.
The status of the add-on will be listed as "Update available".
The table will list the currently installed version and the available version.
Press ``enter`` on the add-on to open the actions list; choose "Update"

++ Community ++[Community]

NVDA has a vibrant user community.
Expand Down

0 comments on commit b9b3dce

Please sign in to comment.