ONLYOFFICE Desktop Editors ne propose aucune option « Activer le développement de plugins ». La procédure recommandée consiste à installer votre propre plugin via le Gestionnaire de plugins, à le placer dans le dossier des plugins local et, éventuellement, à remplacer la copie installée par un lien symbolique vers votre dossier source. Pour examiner les erreurs et utiliser des points d'arrêt, lancez l'application de bureau avec l'option de débogage indiquée. Il s'agit de deux étapes distinctes : le mode débogage active les outils de développement, tandis que l'installation ou la liaison du plugin le rend disponible pour l'éditeur.
La documentation actuelle de l'API ONLYOFFICE décrit ce même flux de travail pour ordinateur et mentionne également une option permettant de maintenir le mode débogage activé lors des lancements successifs. Je n'ai trouvé aucune information officielle concernant une nouvelle option de mode développement modifiant ces étapes. Ce guide suit les instructions officielles disponibles le 6 octobre 2026. Les chemins d'accès peuvent varier selon le type d'installation ; vérifiez donc le chemin d'accès correspondant à votre plateforme avant de modifier les fichiers.
Choisissez un flux de travail de développement de plugins
| Approche | Idéal pour | Compromis |
Installer une .pluginarchive dans le gestionnaire de plugins | Première installation, tests rapides ou modifications occasionnelles | Simple et pris en charge, mais vous devez reconstruire et réinstaller l'archive après chaque modification du code source. |
| Liez le dossier du plugin installé à votre dossier source. | Modifications fréquentes pendant le développement | Supprime les emballages redondants, mais nécessite le chemin d'accès correct pour chaque utilisateur et un rechargement ou une réouverture pour que les modifications soient prises en compte. |
| Lancer avec l'option de débogage | Inspection de la sortie de la console, des cadres de plugin ou des points d'arrêt | Active les outils de développement ; n'installe aucun plugin et ne charge pas automatiquement de code non fiable. |
Pour la plupart des développeurs, utilisez l'archive une seule fois pour enregistrer l'extension, puis un lien symbolique pour les itérations. N'activez le mode débogage que pour le diagnostic du code. Laissez son activation persistante désactivée, sauf si vous avez besoin des outils de développement à chaque lancement.
Préparer les fichiers du plugin
Commencez par créer un répertoire local pour votre plugin contenant au moins les fichiers requis, y compris `<plugin-file>` config.jsonet ` index.html<plugin-config>`. Le fichier de configuration doit comporter un GUID de plugin valide et pointer vers la page d'entrée et les ressources du plugin en utilisant le schéma ONLYOFFICE. Consultez les exemples de plugins officiels ou la documentation de l'API pour obtenir le schéma complet ; un GUID incorrect, un chemin d'accès erroné ou une configuration invalide peuvent empêcher l'affichage du plugin.
Le GUID se config.jsonprésente généralement sous la forme ` asc.{YOUR-GUID}<GUID>`. Les éditeurs de bureau utilisent ce GUID comme nom de dossier du plugin, mais omettent le asc.préfixe. Conservez le même GUID dans le répertoire source, l'archive et le chemin d'installation. Ne réutilisez pas le GUID d'un plugin intégré ou d'un autre plugin installé.
Installez le plugin pour la première fois.
- Placez les fichiers et sous-dossiers du plugin dans une archive ZIP. Les fichiers doivent se trouver à la racine de l'archive, et non dans un dossier de projet supplémentaire.
- Modifiez l'extension de l'archive de
.zipà .plugin.
- Ouvrez ONLYOFFICE Desktop Editors, sélectionnez l' onglet Plugins , puis cliquez sur Gestionnaire de plugins .
- Ouvrez Mes plugins , choisissez Installer le plugin manuellement , sélectionnez le
.pluginfichier et confirmez.
Le plugin devrait alors apparaître dans l'onglet « Plugins » de l'éditeur ouvert et dans les éditeurs ouverts ultérieurement. L'installation manuelle via l'archive fonctionne même sans connexion Internet. L'installation depuis la Marketplace est destinée aux plugins prêts à l'emploi ; elle ne remplace pas le chargement de votre propre version de développement.
Utilisez un lien symbolique pour une itération plus rapide.
Après la première installation, Desktop Editors enregistre une copie dans un sdkjs-pluginsrépertoire. Remplacez cette copie par un lien symbolique vers votre dossier source afin de pouvoir modifier directement les fichiers de travail. Fermez Desktop Editors avant de modifier le dossier du plugin de test installé. Conservez une sauvegarde ou assurez-vous que votre dossier source est intact, puis supprimez uniquement le dossier correspondant au GUID de votre plugin de test.
| Système opérateur | Répertoire des plugins utilisateur |
| Windows | %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\ |
| macOS | ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/ |
| Linux | ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/ |
Dans le répertoire, le nom du lien est le GUID entre accolades, sans le asc.préfixe. Par exemple, si le GUID de configuration est asc.{91EAC419-EF8B-440C-A960-B451C7DF3A37}, le nom du dossier ou du lien est {91EAC419-EF8B-440C-A960-B451C7DF3A37}.
Windows
Ouvrez l'invite de commandes en tant qu'administrateur si votre compte Windows ou votre stratégie l'exige. Après avoir fermé les éditeurs et déplacé le dossier test-plugin installé, créez le lien symbolique :
mklink /D "%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\{YOUR-GUID}" "C:\path\to\your\plugin"
Remplacez les deux espaces réservés par le GUID et le chemin complet vers votre répertoire source. Le lien cible ne doit pas déjà exister.
macOS
ln -s "/path/to/your/plugin" "$HOME/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/{YOUR-GUID}"
Linux
ln -s "/path/to/your/plugin" "$HOME/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/{YOUR-GUID}"
Utilisez les chemins d'accès correspondant à votre édition installée ; les versions packagées ou exécutées en mode sandbox peuvent stocker les données utilisateur ailleurs. Après avoir modifié le code source, rouvrez le document ou rechargez l'extension selon le cas. Le lien symbolique évite de reconstruire l'archive, mais les modifications ne seront pas nécessairement prises en compte tant que l'éditeur n'aura pas rechargé l'extension.
Lancer les éditeurs de bureau avec les outils de développement
Pour déboguer un plugin, quittez complètement Desktop Editors et relancez-le --ascdesktop-support-debug-info. Utilisez la commande correspondant à votre système d'exploitation ; si vous avez installé l'application dans un emplacement personnalisé, modifiez le chemin d'accès à l'exécutable.
Windows
Exécutez ceci dans l'invite de commandes :
"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
Vous pouvez également modifier le champ Cible d'un raccourci en ajoutant un espace et l'indicateur après le chemin d'accès à l'exécutable. Cela affectera les lancements effectués via ce raccourci.
Linux
"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
macOS
"/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info
Une fois l'application lancée, cliquez dans un document et appuyez sur Entrée F1, ou cliquez avec le bouton droit sur un champ modifiable de la barre d'outils et choisissez « Inspecter l'élément » . Dans les outils de développement, sélectionnez l'iframe du plugin pour inspecter son code JavaScript et ses journaux. Le code transmis callCommands'exécute dans la fenêtre de l'éditeur, nommée « inspecter » frameEditor, ses erreurs et points d'arrêt peuvent donc apparaître dans un contexte différent de celui de l'interface utilisateur du plugin.
L'option --ascdesktop-support-debug-info-keep=1permettant de maintenir le mode débogage activé lors des lancements successifs est facultative. Pour désactiver cet état persistant, lancez le programme avec l'option correspondante--ascdesktop-support-debug-info-keep=0 ; utilisez l'option --ascdesktop-support-debug-info-keep=defaultpour revenir à l'état par défaut. Les outils de développement persistants sont pratiques sur une machine de test dédiée, mais les laisser activés sur un poste de travail partagé encombre le système et maintient les outils d'inspection disponibles même lorsqu'ils ne sont pas nécessaires.
Vérifiez que la configuration de développement fonctionne
- Le plugin apparaît sous son nom configuré dans l'onglet Plugins.
- Après une modification du code source, la réouverture du document ou le rechargement du plugin permet d'afficher le comportement mis à jour.
- Les outils de développement s'ouvrent avec
F1ou via Inspect Element après avoir été lancés avec l'indicateur de débogage.
- Les journaux du code d'interface utilisateur du plugin apparaissent lorsque l'iframe du plugin est sélectionné ; les commandes du document sont inspectées dans
frameEditor.
Si le plugin est manquant, vérifiez qu'il config.jsonse index.htmltrouve bien à la racine de l'archive, que le GUID est valide et que le dossier utilise le GUID sans le asc.préfixe. Assurez-vous que le lien pointe vers le répertoire source et non vers un répertoire parent qui le contient. Si le plugin apparaît mais se comporte comme une version antérieure, fermez puis rouvrez le document afin que l'éditeur recharge les fichiers liés.
Ce que cette configuration ne permet pas
L'option de débogage pour ordinateur n'est pas un paramètre d'autorisation global pour le développement de plugins. Installer une archive ou placer un dossier dans le répertoire des plugins compatibles rend ce plugin disponible ; l'option de débogage permet d'accéder aux outils d'inspection. De même, les instructions pour charger un plugin par URL dans un éditeur web ne s'appliquent pas automatiquement aux éditeurs de bureau. Suivez la procédure d'installation et de débogage spécifique aux éditeurs de bureau décrite ci-dessus.
Ces instructions concernent les modules d'extension pour ONLYOFFICE Desktop Editors. Elles n'expliquent pas comment activer les modules d'extension dans DocSpace, comment configurer les modules d'extension côté serveur dans ONLYOFFICE Docs, ni comment publier un module d'extension sur la Marketplace. Pour ces procédures, veuillez consulter la documentation produit officielle correspondante.
Références officielles