Comment publier votre propre module complémentaire sur la marketplace ONLYOFFICE

5 octobre 2022By Dasha

Dans la version 7.2 de ONLYOFFICE Docs, nous avons ajouté le tout nouveau gestionnaire de plugins qui vous permet d’explorer tous les plugins appelés aussi modules complémentaires et de les installer ou supprimer en un seul clic directement dans les éditeurs. Si vous souhaitez créer et ajouter votre propre module complémentaire à notre marketplace, suivez les étapes ci-dessous.

How to publish your own plugin in ONLYOFFICE marketplace

Embrancher le répertoire

Veuillez noter que vous aurez besoin d’un compte GitHub et de connaissances de base pour travailler sur GitHub.

  • Embranchez le répertoire de la marketplace : https://github.com/ONLYOFFICE/onlyoffice.github.io. Vous obtiendrez un répertoire (repo) avec l’adresse suivante : https://github.com/YOUR-USERNAME/ONLYOFFICE/onlyoffice.github.io.
  • Pour poursuivre les tests dans la version web, vous devez activer GitHub Pages.
  • Clonez le fork dans votre dossier (par exemple, travail).
  • Ajoutez le dossier du module complémentaire au dossier work/sdkjs-plugins/content.

Créer votre module complémentaire

Créez votre module complémentaire comme décrit dans notre documentation API.

Ainsi, le dossier de votre module complémentaire doit contenir trois fichiers principaux : config.json, index.html et pluginCode.js. Vous devez également ajuster son style, le localiser, ajouter des descriptions et des icônes.

Tester votre module complémentaire dans l’application de bureau

Téléchargez ONLYOFFICE Desktop Editors et installez votre module complémentaire comme décrit ici.

En bref, vous devez packager tous les fichiers de module complémentaire dans le dossier des modules dans une archive zip, changer son extension en .plugin et ajouter votre module complémentaire via le gestionnaire de plugins.

Après le test, vous pouvez poursuivre la construction de votre module ou corriger les problèmes identifiés. Pour obtenir la console de développement, exécutez l’application de bureau avec la clé --ascdesktop-support-debug-info. Pour ce faire, suivez les instructions ici en fonction du système d’exploitation que vous utilisez.

Tester votre module complémentaire sur le web

Pour créer une extension, ouvrez le fichier onlyoffice.github.io/store/plugin-dev/extension/inject.js et attribuez le chemin d’accès à votre module complémentaire sur le site GitHub Pages à la variable URL_TO_PLUGIN :

var URL_TO_PLUGIN = "https://YOUR-USERNAME.github.io/onlyoffice.github.io/sdkjs-plugins/content/helloworld/"

Le dossier onlyoffice.github.io/store/plugin-dev/extension est une nouvelle extension. Chargez-la dans le navigateur, exécutez votre ONLYOFFICE Docs (Document Server) et trouvez le module complémentaire dans le gestionnaire de plugins.

Remarque : lorsque vous travaillez sur votre module complémentaire, il est important d’ouvrir le gestionnaire de plugins pour vérifier et, si nécessaire, améliorer l’aspect de votre plugin. Vous devez également prendre en compte l’aspect lorsque vous passez au thème Sombre.

Soumettre votre module complémentaire

Lorsque vous êtes prêt à créer le module d’extension, faites une demande d’extraction de votre fork vers le dépôt https://github.com/ONLYOFFICE/onlyoffice.github.io.

Si tout est OK et qu’il fonctionne correctement, nous approuverons le PR et le module apparaîtra sur la marketplace.

How to publish your own plugin in ONLYOFFICE marketplace