Exigences pour la soumission d'extensions

Pour soumettre une nouvelle extension ou une nouvelle version d'une extension incluse sur le site Web :

  • Host it (ideally on GitHub, the add-on template makes this easy), and create a pull request against addonFiles. Anyone can submit a pull request, with requests from authors preferred.
  • Modifiez le fichier get.php. Vous devez vous assurer d'avoir une clé unique (ID d'extension) dans get.php pour votre extension.
  • Vérifiez que l'URL de l'extension est correcte.
  • Assurez-vous que le manifeste est correct. Y compris les versions de l'API : ce n'est qu'une fois la première version beta de NVDA publiée que l'API sera considérée comme gelée, par conséquent, "lastTested" ne doit être défini sur cette version qu'après la beta.

NV Access prévoit de mettre à disposition un magasin d'extensions, où l'examen des métadonnées sera automatisé. En attendant, les pull request mentionnées seront examinées, approuvées et fusionnées manuellement, l'inclusion de votre extension peut donc prendre un certain temps.

Pour ajouter ou mettre à jour la page Web de votre extension :

  • Demandez une invitation sur la liste de diffusion pour la traduction. Vous devez le faire même si l'extension n'a pas besoin de traductions à ce stade.
  • Suivez les instructions pour télécharger le dépôt. Vous pouvez faire seulement un checkout du site Web en ajoutant "/ site Web" à l'URL pour modifier la documentation des extensions.
  • Sous le sous-dossier addons, ajoutez un fichier nomDuDepotDeLExtension.mdwn. Assurez-vous qu'il contient un titre et des balises telles que dev, stable ou legacy, afin que la page Web puisse être affichée dans les sections correspondantes du site Web. Les exemples suivants peuvent être utiles :

    • access8math.mdwn, avec les balises dev et stable.
    • AudioThemes.mdwn, avec la balise dev.
    • teamViewer.mdwn, avec la balise legacy.
  • Soyez attentifs à la syntaxe markdown :

    • Utilisez des astérisques suivis d'un espace, et non des tirets, pour les listes. Les tirets sont autorisés sur Github et sur le site Web, mais uniquement en anglais. Lorsque la documentation est convertie en fichiers .po, l'utilisation de tirets ne divise pas la liste en éléments souhaités.
    • Si les URL ne sont pas trop longues, utilisez le style "référence" pour les liens, c'est-à-dire incluez les URL correspondantes au bas du fichier, avec une ligne vide entre les URL et une ligne vide à la fin du fichier.
    • Essayez d'utiliser des paragraphes courts, des listes et des titres de niveau 2 ou 3, pour obtenir une bonne structure et une documentation compréhensible.
    • Pour les listes imbriquées, placez une ligne vide avant le premier sous-élément et après le dernier, et utilisez quatre espaces pour l'indentation.
  • If you want to manage translations for your add-on via the NVDA's translation system, request it on the add-ons mailing list.