Skip to content

Commit c9b1111

Browse files
seanbuddseanbudd
authored
Merge dad7f83 into 57f468f 
2 parents 57f468f + dad7f83 commit c9b1111

1 file changed

Lines changed: 35 additions & 15 deletions

File tree

‎projectDocs/dev/developerGuide/developerGuide.t2t‎

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -781,24 +781,44 @@ This manifest file contains key = value pairs declaring info such as the add-on'
781781
Although it is highly suggested that manifests contain all fields, the fields marked as mandatory must be included.
782782
Otherwise, the add-on will not install.
783783

784-
- 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)
785-
- summary (string): The name of the add-on as shown to the user. (Mandatory)
786-
- version (string): The version of this add-on; e.g. 2.0. (Mandatory)
787-
- author (string): The author of this add-on, preferably in the form Full Name <email address>; e.g. Michael Curran <mick@kulgan.net>. (Mandatory)
784+
- name (string, required): A short unique name for the add-on.
785+
- The recommended convention is lowerCamelCase.
786+
- This is used to differentiate add-ons internally, and is also used as the name of the add-on's directory in the user configuration directory.
787+
- Special characters should be avoided as the add-on name will be used as a folder name.
788+
Expected characters are alphanumeric, space, underscore and hyphen.
789+
-
790+
- summary (string, required): The name of the add-on as shown to the user.
791+
- version (string, required): The version of this add-on; e.g. 2.0.1.
792+
When uploading to the Add-on Store certain requirements apply:
793+
- Using ``<major>.<minor>`` or ``<major>.<minor>.<patch>`` format.
794+
- For a user to be able to update to this add-on, the version must be greater than the last version uploaded.
795+
- Add-on versions are expected to be unique for the addon name and channel, meaning that a beta, stable and dev version of the same add-on cannot share a version number.
796+
This is so there can be a unique ordering of newest to oldest.
797+
- The suggested convention is to increment the patch version number for dev versions, increment the minor version number for beta versions, and increment the major version number for stable versions.
798+
-
799+
- author (string, required): The author of this add-on, preferably in the form Full Name <email address>; e.g. Michael Curran <mick@example.com>.
788800
- description (string): A sentence or two describing what the add-on does.
789801
- url (string): A URL where this add-on, further info and upgrades can be found.
802+
- Starting the URL with ``https://`` is required for submitting to the Add-on Store.
803+
-
790804
- 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.
791-
- minimumNVDAVersion (string): The minimum required version of NVDA for this add-on to be installed or enabled.
792-
- e.g "2019.1.1"
793-
- 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.
805+
- minimumNVDAVersion (string, required): The minimum required version of NVDA for this add-on to be installed or enabled.
806+
- e.g "2021.1"
807+
- Must be a three part version string i.e. Year.Major.Minor, or a two part version string of Year.Major.
808+
In the second case, Minor defaults to 0.
794809
- Defaults to "0.0.0"
795810
- Must be less than or equal to ``lastTestedNVDAVersion``
811+
- This must match a valid API version to be submitted to the Add-on Store.
812+
Valid API versions are found [on GitHub https://github.com/nvaccess/addon-datastore-transform/blob/main/nvdaAPIVersions.json].
796813
-
797-
- lastTestedNVDAVersion (string): The last version of NVDA this add-on has been tested with.
798-
- e.g "2019.1.0"
799-
- 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.
814+
- lastTestedNVDAVersion (string, required): The last version of NVDA this add-on has been tested with.
815+
- e.g "2022.3.3"
816+
- Must be a three part version string i.e. Year.Major.Minor, or a two part version string of Year.Major.
817+
In the second case, Minor defaults to 0.
800818
- Defaults to "0.0.0"
801819
- Must be greater than or equal to ``minimumNVDAVersion``
820+
- This must match a valid API version to be submitted to the Add-on Store.
821+
Valid API versions are found [on GitHub https://github.com/nvaccess/addon-datastore-transform/blob/main/nvdaAPIVersions.json].
802822
-
803823
-
804824

@@ -813,13 +833,13 @@ When this is not provided, or is less than the current version of NVDA (ignoring
813833
--- start ---
814834
name = "myTestAddon"
815835
summary = "Cool Test Add-on"
816-
version = "1.0"
836+
version = "1.0.0"
817837
description = "An example add-on showing how to create add-ons!"
818-
author = "Michael Curran <mick@kulgan.net>"
819-
url = "http://www.nvda-project.org/wiki/Development"
838+
author = "Michael Curran <mick@example.com>"
839+
url = "https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/addons.md"
820840
docFileName = "readme.html"
821-
minimumNVDAVersion = "2018.1.0"
822-
lastTestedNVDAVersion = "2019.1.0"
841+
minimumNVDAVersion = "2021.1"
842+
lastTestedNVDAVersion = "2022.3.3"
823843
--- end ---
824844
```
825845

0 commit comments

Comments
 (0)