Updated user guide with missing key commands and details to log file and app modules

[Adriani90]

Link to issue number:

fixes #14410
fixes #1506
fixes #5261

Summary of the issue:

Some commands wore not documented in the user guide although they are useful for users as well.

Description of user facing changes

Added documentation for ctrl+nvda+f1 and ctrl+nvda+shift+f1 in the coresponding sections.

Testing strategy:

Checked that key commands reference is updated as well.

Known issues with pull request:

None

Change log entries:

Updates to the user guide (#14410, #1506)

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/rl6hxawmlrhfwl3a/artifacts/output/nvda_snapshot_pr15460-29212,df7eadaf.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.8,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 23.0,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 19.1,
  FINISH_END 0.1

See test results for failed build of commit df7eadaf10

[Adriani90]

I see some failed tests related to symbol pronounciation which aparently led to failed system tests. I didn't touch those files actually. What should I do?

[CyrilleB79]

Thanks for the changes.

Actually, there are still things to polish. And to make the "Log viewer" paragraph more understandable, it should be reorganized and rephrased. I need to think at it and I will make a full proposal later.

Also one difference to keep in mind: the menu command NVDA -> Tools -> Log viewer only shows the log, whereas NVDA+control+F1 show the log and the nav object's properties.

[Adriani90]

Thanks @CyrilleB79 that's very appreciated. We have a lot of educated users who are interested in more detail about this, but on the other hand they are not as skilled as a developer to go through the developers guide. So my motivation for this PR was giving some details to such users via the user guide.

Hmm it seems a ghost made the checks to pass :-) creepy github.

[seanbudd]

For reference, the user guide standards document may be helpful: https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/userGuideStandards.md

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/6u4jsdaqpkhcbqm3/artifacts/output/nvda_snapshot_pr15460-29254,e51716c8.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.9,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 23.8,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 21.5,
  FINISH_END 0.1

See test results for failed build of commit e51716c8d7

[Adriani90]

@seanbudd thanks for the review, very appreciated.
By the way the link for the documentation system guidelines for reference materials (https://documentation.divio.com/reference/) gives a 404 error on my end.
This link is referenced in the user guide standards document.

[CyrilleB79]

This paragraph is very clear and well phrased. Thanks @Adriani90 and @seanbudd. Do not modify anymore!

[seanbudd]

Ah, the link should be https://documentation.divio.com/reference.html. I'll fix this later

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/wu3oe81p1ghfc0i8/artifacts/output/nvda_snapshot_pr15460-29306,7f257f4b.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.8,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 24.1,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 13.5,
  FINISH_END 0.1

See test results for failed build of commit 7f257f4b90

[XLTechie]

Better, but a few more comments for your consideration.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/ml0d3l415pug4tat/artifacts/output/nvda_snapshot_pr15460-29312,2cbbf064.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.9,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 24.1,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 22.4,
  FINISH_END 0.1

See test results for failed build of commit 2cbbf06473

[Adriani90]

some may be confused, and expect it as a submenu under NVDA Menu, tools, logs, ?

I'd say this might happen but not because of the sentence as it stands. Actually we say already this is the log sub menu in the log viewer so it should be clear enough that the log viewer should be opened first and then you can access the log sub menu.
Alternatively we could rename that sub menu to "file" instead of "log". Is this something which should be considered?

[CyrilleB79]

Alternatively we could rename that sub menu to "file" instead of "log". Is this something which should be considered?

No "Log" is fine. "Refresh" applies to the log visible in the log viewer, but the log file is not refreshed.

[cary-rowen]

Please take @seanbudd's advice and @CyrilleB79's clear and precise explanation, I think it's pretty clear.

[Adriani90]

After giving it a thought I agree with menu instead of submenu since this is more common in the day to day language when talking about such areas of menu toolbars. So I agree with Sean and Cyrille.

[seanbudd]

Thanks @Adriani90

[Qchristensen]

All looks good. My only comment before approving is:

As these are the only mentions of "reloading plugins" and "app modules", is it worth a sentence explaining what they are?

[CyrilleB79]

@Adriani90, seems that this PR also fixes #5261. Is it correct?

[Adriani90]

seems that this PR also fixes #5261. Is it correct?

that issue talks also about.a command for the developer info, so this should be the info of the focused element which is displayed below the carret when opening the log file.
I am not aware for a coresponding command for reporting or displaying the developer info only.
If there is a hidden command, I am more than happy to add it to the user guide.

[CyrilleB79]

seems that this PR also fixes #5261. Is it correct?

that issue talks also about.a command for the developer info, so this should be the info of the focused element which is displayed below the carret when opening the log file. I am not aware for a coresponding command for reporting or displaying the developer info only. If there is a hidden command, I am more than happy to add it to the user guide.

No, there is only one command that reports Developers info, it's NVDA+F1. And it operates on the nav object, not the focus.

#5261 is not very precise about this command but it can be no other command than NVDA+F1. Thus, it's fixed with the current PR.

[Qchristensen]

Userguide looks good