Replace Welcome Dialog with a 6 steps Welcome Wizard

[DrSooom]

Steps to reproduce:

Very first start of NVDA (no configuration files exist)

Actual behaviour:

Two windows are shown.

Welcome Dialog

• [Text] Introducing text with the explanation for the NVDA key.
• [Combobox] Keyboard layout
• [Checkbox] Use capslock as an NVDA modifier key
• [Checkbox] Automatically start NVDA after I log on to Windows
• [Checkbox] Show Welcome Dialog after NVDA startup
• [Button] OK

Allow the NVDA project to gather NVDA usage statistics

• [Text] Information about collecting additional statistics metadata during the update check.
• [Buttons] Later, Yes, NO

Expected behaviour:

Reasons:

• As descripted earlier (issue numbers are mentioned at the end) a Welcome Wizard, in which the user can set up a few very basic options, would be helpful for all NVDA beginners and for all normal/casual users.
• Therefore there are also a little tutorial in a text field on the very first page of the Welcome Wizard as a button to close this Wizard and open directly the NVDA Settings window (for advanced users/testers/devs).
• The title of the following headlines regarding those 6 steps doesn't appear in the title bar of this wizard window because it wouldn't be read automatically by NVDA after switching the steps. So they all appear on the very first line in the text label [marked as "[Text]").
• The appearance of the dialog about the additional statistics isn't changes by this wizard. If someone is updating NVDA it will appear as in NVDA 2018.3, even if he has disabled the Welcome Wizard. But after finishing the Welcome Wizard the value for the additional statistics is already stored, so this dialog won't be shown after finishing this Welcome Wizard.
• The parameter "showWelcomeDialogAtStartup" is replaced with "showWelcomeWizardAtStartup" in the "nvda.ini". The value of this parameter isn't changed during an update.
• The configuration is saved automatically after pressing "finish". If this wizard was closed via the "Cancel" button, only the value for the "showWelcomeWizardAtStartup" is automatically stored in the "nvda.ini". And if the user closed this wizard via the "Skip …" button on the first page, the parameter "showWelcomeWizardAtStartup" is automatically stored with the value "false".
• Well, and all the texts below are just drafts as my mother tongue is German. I guess some sentences could be written in a much more better way. But the text in the little tutorial text field was written intentionally this short way to keep it as simple for beginners as possible.

Buttons at the bottom:

• There are four buttons on all 6 pages: Previous, Next, Cancel and Help.
• The "Help" button on each page will open the NVDA User Guide with an anchor parameter.
  Note: Maybe it could be helpful for beginners to provide them a Quick Guide HTML file which isn't so huge. But this would be another ticket.
• The "Next" button is called "Finish" on the last page.
• When pressing "Cancel" the following question dialog should appear:
  • [Text] You're going to close the Welcome Wizard without saving any changes you might have been done. You can start this Welcome Wizard later with its menu entry in the NVDA help submenu. Press NVDA+N to open the NVDA menu and go to the "Help" submenu to find this entry.
    Do you want that this Welcome Wizard will be shown after the next start of NVDA?
  • [Buttons] Yes, No, Cancel

Step 1 of 6 – Welcome to NVDA

• [Text] This wizard will guide you through a few basic keyboard, speech, braille and general settings. Note that every settings in this wizard can be changed later in the NVDA Settings too. If you are already familiar with NVDA, you can directly open the NVDA Settings by pressing the "Skip" button below. Otherwise please read the text below line by line to learn how to navigate and then press the "Next" button to go forward to the keyboard settings.
• [Protected text field] How to navigate? Press the arrow key down to read the next line.
  Well done. To read the previous line in this protected text field press the arrow key up.
  Press the space bar to press a button and to enable or disable checkboxes.
  Use the arrow keys up and down to change values in comboboxes.
  And to move between the elements in this wizard press TAB or Shift+TAB.
  If you need additional help during the wizard, the "Help" button is your friend.
  After pressing the "Help" button a local stored website will open in the default web browser.
  Please press ALT+ESC to switch back to this wizard.
  Depending on how many windows are opened at the moment you have to press ALT+ESC multiple times.
  One more thing: NVDA+N will open the NVDA menu where you can configure even more.
  But what is the NVDA key and where is it located on the keyboard?
  Now find the "Next" button with the TAB key and press the Space bar to find this out.
• [Button] Skip Welcome Wizard and open directly the NVDA Settings

Step 2 of 6 – Keyboard Settings

• [Text] Most shortcuts in NVDA are using the so called "NVDA" key. By default both insert keys on the keyboard are allocated as the NVDA modifier key. If you are using NVDA on a laptop, please – if desired – change the keyboard layout below. Using the caps lock key as an NVDA modifier key could be also helpful on desktop keyboards as well. And if you are already familiar with the keyboard layout, you can disable speaking taped characters and words here too.
• [Combobox] Keyboard layout
• [Checkbox, disabled by default] Use caps lock as an NVDA modifier key
• [Checkbox, enabled by default] Speak Typed Characters
• [Checkbox, enabled by default] Speak Typed Words

Step 3 of 6 – Speech Settings

• [Text] Depending on your operating system as well as on other assistive technologies several synthesizers could be already installed on your system. After pressing the "change..." button a new window will appear in which all installed synthesizers are listed. Depending on the chosen synthesizer you can change its voice, its variant and its rate below.
• [Protected text field] Select synthesizer
• [Button] Change...
• [Combobox] Voice
• [Combobox] Variant
• [Combobox] Rate
• [Checkbox, disabled by default] Increase rate

Step 4 of 6 – Braille Settings

• [Text] If you don't own a braille display, you have nothing to change here. Otherwise please connect your braille display now to your computer and turn it on. If you are doing this for the very first time, please wait up to two minutes until all drivers are installed correctly. Depending on your braille display it is required to install drivers manually. Please read the manual of your braille display for more information. After your braille display was automatically detected by NVDA or after you have chosen it by using the "Change..." button, you should now set up your preferred braille output and input table.
• [Protected text field] Select braille display
• [Button] Change...
• [Combobox] Output Table
• [Combobox] Input Table
• [Checkbox, enabled by default] Expand to computer braille for the word at the cursor

Step 5 of 6 – General Settings

• [Text] Below you can choose if NVDA should look for available updates automatically and if you want to send additional NVDA usage statistics during the update checks. Press the button "Show to be transferred data" below to see what data is transferred to NV Access.
• [Additional text, installed version only] If you don't want that NVDA starts automatically after you have logged on on Windows, please disable this option. And if you already know, that you current using account on Windows has no administrator permissions, please disable the last two checkboxes as well, otherwise those operations will fail.
• [Button] Show to be transferred data
• [Checkbox, enabled by default] Automatically check for updates to NVDA
• [Checkbox, disabled by default] Allow the NVDA project to gather NVDA usage statistics
• [Checkbox, installed version only, enabled by default] Automatically start NVDA after I log on to Windows
• [Checkbox, installed version only, enabled by default] Use NVDA on the Windows Logon screen (requires administrator privileges)
• [Checkbox, installed version only, enabled by default] Use currently saved settings on the logon and other secure screens (requires administrator privileges)

Step 6 of 6 – Finishing Welcome Wizard

• [Text] Congratulations! You have successfully set up NVDA. Please press the "Finish" button to save your settings and to close this wizard. If you want to change something, use the "Back" button to go to the previous steps. And if you don't want to save that any changes you have made, please press the "Cancel" button.
  NVDA is an open source software and is developed by NV Access and hundreds of free software engineers around the world. Every donation to NV Access for this project would be appreciated. Please press the button below to open the donation website where you can find more information about this.
• [Button] Open donation website
• [Text] You will find more information about navigating with NVDA as well as about the NVDA Settings, the supported synthesizers and braille displays and of course tables of all keyboard, touch gestures and braille shortcuts in the User Guide of NVDA, which you can open directly here using the following button. Otherwise you can open the User Guide via the NVDA "Help" submenu later on as well. To open the NVDA menu, just press NVDA+N.
• [Button] Open NVDA's User Guide

UAC Dialog after the Welcome Wizard

If NVDA is installed and the options "Use NVDA on the Windows Logon screen (requires administrator privileges)" and/or "Use currently saved settings on the logon and other secure screens (requires administrator privileges)" is enable, the following hint should appear:

• [Text] The configurations you made through the Welcome Wizard was successfully saved. To enable NVDA to be started on the logon screen and to use your currently saved configuration on the logon screen, you now need administrator privileges. The Windows User Account Control window will now appear after pressing OK. Please press ALT+Y in this window to proceed (if your account has already administrator permission) or the ESC key to cancel the UAC window.
• [Button] OK

After the UAC was confirmed the following hint should appear:

• [Text] Operation succeeded. NVDA is now ready to use.
• [Button] OK

And if the UAC was cancelled the following hint should appear:

• [Text] Operation failed. Do you want to ´try it again? You can do the same later on in the General NVDA Settings as well.
• [Buttons] Yes, No

System configuration:

NVDA installed/portable:

Effects both, but with a few differences.

NVDA version:

2018.2.1 and alpha-15554,66186bfb (and the upcoming 2018.3)

Windows version:

Win7 to Win10-1803 (and higher)

Related issues:

Bug #258, #1690, #7242, #7249, #8217 and #8510

[josephsl]

CC @derekriemer

[DrSooom]

I added three more sentences above "One more thing: […]" in the protected text field on step 1 regarding switching between windows via ALT+ESC. ALT+ESC might be better for beginners instead of ALT+TAB or WIN+TAB, because the order of windows is firm.

@josephsl: Could you please log in into GitHub and delete everything below the first line in your comment for a better overview. (I have no idea why GitHub handles e-mail replies in this stupid way.) Thanks.