Inicio
» Consejos PC
»
Habilitar el desarrollo y la depuración del complemento de escritorio de ONLYOFFICE
Habilitar el desarrollo y la depuración del complemento de escritorio de ONLYOFFICE
No es necesario activar un interruptor independiente para el desarrollo de complementos en los editores de escritorio de ONLYOFFICE. Cree un complemento, instale su .pluginpaquete a través del Administrador de complementos e inicie la aplicación de escritorio --ascdesktop-support-debug-infocuando necesite herramientas de depuración. Los editores de escritorio y web utilizan procedimientos de carga diferentes, así que comience con el flujo de trabajo específico para escritorio que se describe a continuación.
Prepara un pequeño proyecto de complemento
Estas instrucciones se aplican a los editores de escritorio de ONLYOFFICE en Windows, macOS y Linux. Utilice una instalación de escritorio actualizada y un editor de código para archivos de texto plano. La documentación oficial trata la instalación manual de complementos y la depuración por parte del desarrollador como funciones independientes; no es necesario el Plugin Marketplace para desarrollar y probar un complemento local. Un ejemplo de "Hola mundo" es una buena primera comprobación, ya que aísla la carga de complementos de servicios más complejos.
1. Crea la carpeta de origen
Crea una carpeta llamada hello-world-plugin. Añade un config.jsonmanifiesto y un index.htmlpunto de entrada. Opcionalmente, añade una icon.pngimagen si tu manifiesto la requiere. Mantén la carpeta fuera del directorio de la aplicación instalada para que las actualizaciones de software no sobrescriban tus archivos de trabajo.
Mantén el manifiesto del plugin y su archivo HTML de punto de entrada juntos en una carpeta de desarrollo; un icono local es opcional.
2. Define el manifiesto y genera tu propio GUID.
El manifiesto le indica a ONLYOFFICE qué archivo HTML cargar y qué editores pueden ejecutar el complemento. El siguiente ejemplo admite el editor de documentos. Reemplace el GUID de ejemplo con un UUID recién generado antes de la instalación: ejecute New-Guiden Windows PowerShell o uuidgenen macOS o Linux, luego formatee el valor como asc.{YOUR-UUID}. Cada complemento distinto necesita su propio identificador.
Utilice JSON válido: sin comas al final, llaves coincidentes y un archivo real para cada punto de entrada o icono referenciado. Para un complemento de hoja de cálculo o presentación, utilice los valores apropiados en lugar de asumir que un complemento solo para documentos aparece en todas partes. Compare la estructura con el inicio rápidoEditorsSupport oficial de Hello World .
El archivo config.json identifica el complemento y lo restringe a los editores que admite.
3. Implementar el punto de entrada
En index.html, carga la biblioteca API del plugin ONLYOFFICE, agrega un botón y haz que el botón llame a . El ejemplo de inicio rápidowindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"]) del fabricante proporciona el HTML completo y la URL de la biblioteca; copiar ese ejemplo es más seguro que adivinar la inicialización o la sintaxis de la API. Guarda el archivo como UTF-8. Si planeas trabajar sin conexión, recuerda que una página que importa su biblioteca de plugin u otros recursos desde una URL en línea aún necesita esos recursos para cargarse.
El archivo de punto de entrada contiene la interfaz y la llamada a JavaScript que utiliza el editor cuando se ejecuta el complemento.
Instala y ejecuta tu plugin de desarrollo
4. Crea el archivo .plugin
Seleccione los archivos dentro de la carpeta de origen, comprímalos en un archivo ZIP y cambie la extensión ZIP de .zipa .plugin. La raíz del archivo debe contener config.jsony index.html, no un segundo hello-world-plugindirectorio contenedor. En Windows, habilite las extensiones de nombre de archivo en el Explorador de archivos para evitar crear accidentalmente hello-world.plugin.zip. Las instrucciones de instalación oficiales de Desktop Editors admiten explícitamente la instalación manual sin conexión a Marketplace.
Antes de cambiar el nombre del archivo ZIP y añadirle la extensión .plugin, archive el contenido de la carpeta del plugin, no de la carpeta contenedora.
5. Importa el paquete desde el Administrador de plugins.
Abra un documento editable en ONLYOFFICE Desktop Editors. Seleccione Plugins > Administrador de plugins > Mis plugins > Instalar plugin manualmente . La apariencia del administrador puede variar según la versión, pero esta es la ruta de instalación manual documentada. No se trata de la configuración de URL de desarrollador independiente del Marketplace.
En un documento, abre Plugins, luego Plugin Manager y cambia a Mis plugins para acceder a la instalación manual.
6. Seleccione el archivo y compruebe su entrada en el menú.
Seleccione el hello-world.pluginarchivo en el cuadro de diálogo y ábralo. El complemento instalado debería aparecer en la pestaña Complementos. Si no aparece, revise el manifiesto, el GUID, el tipo de editor compatible y la ruta del archivo antes de modificar la configuración de la aplicación. Si el menú no se actualiza inmediatamente después de la instalación, intente volver a abrir un documento.
Seleccione el archivo .plugin en el cuadro de diálogo de selección de archivos; no seleccione la carpeta de origen original.
7. Pruebe el complemento en un documento desechable.
Abra un documento de prueba en blanco, inicie Hello World desde la pestaña Plugins y use su botón. Confirme que las palabras Hello World! aparecen en el documento. Esto no solo verifica la instalación, sino que también confirma que la interfaz del plugin se cargó y que la llamada a la API del editor llegó al documento. No pruebe plugins que modifiquen el contenido en un archivo irremplazable.
Ejecute el complemento instalado dentro de un documento desechable y compruebe el contenido resultante del documento.
Habilitar la depuración para el desarrollo de complementos
8. Reinicie los editores de escritorio con la bandera de depuración.
Cierre completamente ONLYOFFICE Desktop Editors y, a continuación, inicie la aplicación desde una terminal con la opción de depuración oficial. Utilice el comando correspondiente a su sistema operativo y ubicación de instalación:
Símbolo del sistema de Windows:"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
Linux (ubicación estándar del paquete):"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
El comando de Windows anterior utiliza la expansión de variables del Símbolo del sistema, no la sintaxis de PowerShell; en PowerShell, llame al ejecutable con su ruta completa resuelta. Si su aplicación se instaló en una ubicación no estándar, sustituya la ruta real del ejecutable. También puede agregar el indicador al campo Destino de un acceso directo de escritorio de Windows. Consulte los comandos del modo de depuración de escritorio de ONLYOFFICE para obtener detalles sobre la plataforma.
Una vez abierto el documento, haga clic en su área de edición y pulse F1 , o haga clic con el botón derecho en un campo editable de la barra de herramientas y seleccione Inspeccionar elemento . En DevTools, seleccione el iframe del complemento para inspeccionar el código y los registros de la interfaz del complemento. El código que se pasa se callCommandejecuta en el frameEditorcontexto, así que cambie de marco cuando sea necesario. La referencia de depuración del complemento explica esta distinción y cómo usar los puntos de interrupción. La depuración puede exponer el contenido del documento y los detalles de tiempo de ejecución; no comparta los registros sin revisarlos.
Tras habilitar la depuración, inspeccione el iframe del complemento correspondiente en las herramientas para desarrolladores; los mensajes de la consola que se muestran aquí son ilustrativos.
Acorta el ciclo de edición y prueba sin modificar los complementos integrados.
Tras la instalación manual, ONLYOFFICE copia un complemento en un directorio con nombre GUID dentro de su perfil de usuario. Las ubicaciones documentadas son %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\para Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/macOS y ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/Linux. La carpeta con nombre GUID omite el prefijo asc.utilizado en el manifiesto.
Para evitar crear un nuevo archivo para cada cambio, los desarrolladores pueden cerrar la aplicación, reemplazar su propia carpeta de complementos instalada con un enlace simbólico a la carpeta de código fuente de trabajo y volver a abrir el documento después de editarlo. Esto es opcional y los comandos exactos para crear el enlace varían según el sistema operativo. Siga las instrucciones oficiales de desarrollo para escritorio antes de hacerlo. No reemplace las carpetas de complementos incluidas o predeterminadas ni modifique el paquete de la aplicación para macOS: el proveedor advierte que eliminar los complementos predeterminados puede dañar la integridad del paquete y provocar fallos.
Verificar la configuración de desarrollo
Tres comprobaciones indican que el flujo de trabajo está listo: el complemento personalizado aparece en Complementos , la prueba Hello World inserta texto en un nuevo documento y DevTools se abre después de ejecutarse con la bandera de depuración. Si la interfaz está en blanco o la instalación falla, confirme que el manifiesto se analiza como JSON, que el GUID comienza con asc., index.htmlexiste en la ruta relativa declarada y que todos los recursos necesarios están presentes. La guía oficial de errores de complementos cubre estos fallos comunes. Un complemento instalado no es prueba de que todas las funciones que implementa funcionen; repita la misma comprobación después de cada cambio de código.