Skip to content
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.

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

Add-ons Manager: add-ons with commas and other punctuations not surrounded by quotes in manifest/summary field shows Python-like text #8593

Closed
josephsl opened this issue Aug 5, 2018 · 1 comment · Fixed by #8594
Labels
Addon/management In NVDA management of addons by users. component/documentation
Milestone

Comments

@josephsl
Copy link
Collaborator

josephsl commented Aug 5, 2018

Hi,

Found while troubleshooting an issue with Add-on Updater add-on:

Steps to reproduce:

  1. Install Vocalizer Expressive English Compact add-on.
  2. Restart NvDA when prompted.
  3. Open Add-ons Manager and look for the new add-on.

Actual behavior:

The name shown resembles Python's list syntax.

Expected behavior:

Name is shown correctly - purely text.

System configuration:

NVDA Installed/portable/running from source:

Installed

NVDA version:

Alpha.15781

Windows version:

Windows 10 Version 1803

Name and version of other software in use when reproducing the issue:

None

Other information about your system:

None

Other questions:

Does the issue still occur after restarting your PC?

Yes

Have you tried any other versions of NVDA?

Yes (2018.2.1)

Technical:

This is caused by the fact that, in old add-ons (ones generated by hand), manifest summary wasn't surrounded by quotes. This is the case where the string contained commas and other punctuation that could be interpreted by Python as declaring a list or other data structures. Unfortunatley, this fact isn't communicated to developers via developer guide.

Thus I propose that we modify the developer guide to include a note regarding this case, and to perhaps encourage people to use the add-on template, which will format strings like this correctly in the manifest.

Thanks.

@josephsl josephsl changed the title Add-ons Manager: add-ons with no quotes around manifest/summary field shows Python-like text Add-ons Manager: add-ons with commas and other punctuations not surrounded by quotes in manifest/summary field shows Python-like text Aug 5, 2018
@josephsl josephsl added component/documentation Addon/management In NVDA management of addons by users. labels Aug 5, 2018
@josephsl
Copy link
Collaborator Author

josephsl commented Aug 5, 2018

Hi,

This is also the case for add-on description not surrounded by quotes, seen when looking at About dialog for an ad-on that contains this problem.

Thanks.

josephsl added a commit to josephsl/nvda that referenced this issue Aug 5, 2018
josephsl added a commit to josephsl/nvda that referenced this issue Aug 5, 2018
Reviewed by James Scholes: contrary to what the spec says, add-on author value in manifest is not quoted, so quote this.
josephsl added a commit to josephsl/nvda that referenced this issue Aug 6, 2018
Reviewed by Derek Riemer and James Scholes: when mentioning string type, also mention the fact that it must be enclosed in quotes. For the example manifest, quoted all striong values. In addition, docFileName now has an example.
@nvaccessAuto nvaccessAuto added this to the 2019.2 milestone Apr 8, 2019
feerrenrut pushed a commit that referenced this issue Apr 8, 2019
…ed to the new format (PR #8594)

Fixes #8593

Dev guide: mention field types for manifest, along with examples edited to show proper value format.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Addon/management In NVDA management of addons by users. component/documentation
Projects
None yet
2 participants