Skip to content

Commit

Permalink
Dev guide: mention field types for manifest, along with examples edit…
Browse files Browse the repository at this point in the history
…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.
  • Loading branch information
josephsl authored and feerrenrut committed Apr 8, 2019
1 parent f3b9c3c commit 97a70f1
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions developerGuide.t2t
Expand Up @@ -661,40 +661,43 @@ This manifest file contains key = value pairs declaring info such as the add-on'
Although it is highly suggested that manifests contain all fields, the fields marked as mandatory must be included. Although it is highly suggested that manifests contain all fields, the fields marked as mandatory must be included.
Otherwise, the add-on will not install. Otherwise, the add-on will not install.


- name: A short unique name for the add-on. This is used to differentiate add-ons internally and is not shown to the user. (Mandatory) - name (string): A short unique name for the add-on. This is used to differentiate add-ons internally and is not shown to the user. (Mandatory)
- summary: The name of the add-on as shown to the user. (Mandatory) - summary (string): The name of the add-on as shown to the user. (Mandatory)
- version: The version of this add-on; e.g. 2.0. (Mandatory) - version (string): The version of this add-on; e.g. 2.0. (Mandatory)
- author: The author of this add-on, preferably in the form Full Name <email address>; e.g. Michael Curran <mick@kulgan.net>. (Mandatory) - author (string): The author of this add-on, preferably in the form Full Name <email address>; e.g. Michael Curran <mick@kulgan.net>. (Mandatory)
- description: A sentence or two describing what the add-on does. - description (string): A sentence or two describing what the add-on does.
- url: A URL where this add-on, further info and upgrades can be found. - url (string): A URL where this add-on, further info and upgrades can be found.
- docFileName: The name of the main documentation file for this add-on; e.g. readme.html. See the [Add-on Documentation #AddonDoc] section for more details. - docFileName (string): The name of the main documentation file for this add-on; e.g. readme.html. See the [Add-on Documentation #AddonDoc] section for more details.
- minimumNVDAVersion: The minimum required version of NVDA for this add-on to be installed or enabled. - minimumNVDAVersion (string): The minimum required version of NVDA for this add-on to be installed or enabled.
- e.g "2019.1.1" - e.g "2019.1.1"
- Must be a three part version string I.E. Year.Major.Minor, or a two part version string of Year.Major. In the second case, Minor defaults to 0. - Must be a three part version string I.E. Year.Major.Minor, or a two part version string of Year.Major. In the second case, Minor defaults to 0.
- Defaults to "0.0.0" - Defaults to "0.0.0"
- Must be less than or equal to `lastTestedNVDAVersion` - Must be less than or equal to `lastTestedNVDAVersion`
- lastTestedNVDAVersion: The last version of NVDA this add-on has been tested with. - lastTestedNVDAVersion (string): The last version of NVDA this add-on has been tested with.
- e.g "2019.1.0" - e.g "2019.1.0"
- Must be a three part version string I.E. Year.Major.Minor, or a two part version string of Year.Major. In the second case, Minor defaults to 0. - Must be a three part version string I.E. Year.Major.Minor, or a two part version string of Year.Major. In the second case, Minor defaults to 0.
- Defaults to "0.0.0" - Defaults to "0.0.0"
- Must be greater than or equal to `minimumNVDAVersion` - Must be greater than or equal to `minimumNVDAVersion`
- -


All string values must be enclosed in quotes as shown in the example below.

The lastTestedNVDAVersion field in particular is used to ensure that users can be confident about installing an add-on. The lastTestedNVDAVersion field in particular is used to ensure that users can be confident about installing an add-on.
It allows the add-on author to make an assurance that the add-on will not cause instability, or break the users system. It allows the add-on author to make an assurance that the add-on will not cause instability, or break the users system.
When this is not provided, or is less than the current version of NVDA (ignoring minor point updates EG 2018.3.1) then the user will be warned not to install the add-on. When this is not provided, or is less than the current version of NVDA (ignoring minor point updates EG 2018.3.1) then the user will be warned not to install the add-on.


+++ An Example Manifest File +++ +++ An Example Manifest File +++
``` ```
--- start --- --- start ---
name = MyTestAddon name = "myTestAddon"
summary = Cool Test Add-on summary = "Cool Test Add-on"
version = 1.0 version = "1.0"
description = An example add-on showing how to create add-ons! description = "An example add-on showing how to create add-ons!"
author = Michael Curran <mick@kulgan.net> author = "Michael Curran <mick@kulgan.net>"
url = http://www.nvda-project.org/wiki/Development url = "http://www.nvda-project.org/wiki/Development"
minimumNVDAVersion = 2018.1.0 docFileName = "readme.html"
lastTestedNVDAVersion = 2019.1.0 minimumNVDAVersion = "2018.1.0"
lastTestedNVDAVersion = "2019.1.0"
--- end --- --- end ---
``` ```


Expand Down

0 comments on commit 97a70f1

Please sign in to comment.