Tutoriales

Cómo crear su propio complemento para ONLYOFFICE Docs

Resumen: en este artículo, aprenderá cómo crear su propio complemento para ONLYOFFICE Docs y cómo publicarlo en el mercado oficial de complementos disponible a partir de la versión 7.2.

Documentación de ONLYOFFICE No es la suite ofimática promedio en el sentido tradicional. Por supuesto, le permite hacer cosas que puede hacer con otros paquetes de oficina: crear y editar documentos, hojas de cálculo y presentaciones, compartirlos y editarlos en línea, crear formularios que se pueden completar, explorar y convertir archivos PDF, y más.

Sin embargo, hay una manera de hacer SOLO OFICINA Mas poderoso. Esto se refiere a complementos de terceros, que son herramientas de software adicionales que mejoran la funcionalidad estándar de la suite. Por ejemplo, los complementos pueden conectarse a servicios de terceros o agregar nuevos elementos de interfaz de usuario.

Cómo crear un complemento para ONLYOFFICE Docs

Antes de comenzar a crear su propio complemento Documentación de ONLYOFFICEnecesitas asegurarte de tener un cuenta de GitHub Y aprenda los conceptos básicos de cómo usar la plataforma. Esto es muy importante.Si eres nuevo en GitHub, puedes echar un vistazo a la oficial Documentación de GitHub.

El proceso de creación del complemento se puede dividir en siete pasos que debe seguir cuidadosamente:

  • actividades anteriores.
  • codificación.
  • Ajustes de estilo de complemento.
  • Localización (opcional).
  • Preparar.
  • prueba.
  • Publicado en el mercado de complementos.

Echemos un vistazo más profundo al desarrollo de complementos.

Paso 1. Bifurque el repositorio del mercado de complementos

Primero, debe iniciar sesión en su cuenta de GitHub, si no tiene una, cree una. Después de eso, debe bifurcar el repositorio del mercado de complementos de ONLYOFFICE, que está disponible en la siguiente URL:


Como resultado, tendrá otro repositorio cuya dirección URL se verá así:


Después de bifurcar con éxito el repositorio del mercado de complementos, es necesario crear un página de GitHub Los sitios de este repositorio se utilizan con fines de prueba.Si no sabes cómo, mira Guía oficial de GitHub.

Ahora tienes el tuyo página de GitHub sitio, es hora de clonar la bifurcación en su computadora.

Finalmente, debe crear una carpeta para sus futuros complementos en:

onlyoffice.github.io/sdkjs-plugins/content/.

Eso es todo. Acaba de completar todas las actividades preliminares requeridas y puede continuar con el siguiente paso.

Paso 2. Codifique su complemento

No tiene que ser muy bueno codificando, pero definitivamente necesita algunos conocimientos básicos de codificación para crear sus propios complementos. Documentación de ONLYOFFICE.

En resumen, un SOLO OFICINA plugin es una carpeta que contiene varios archivos. Debe crear tres archivos para que el complemento funcione:

  • archivo de configuración – Este es un archivo de configuración de complemento que contiene información sobre todos los datos importantes. En este archivo, hay algunos parámetros que necesitan registrar el complemento en el editor ONLYOFFICE.mirar esta página Lea la descripción completa de cada parámetro en la documentación oficial de la API.
  • Código del complemento (archivo .js) – Este es el propio archivo del complemento que contiene el código JavaScript del complemento. Este archivo describe qué hacen los complementos y cómo lo hacen.leer Esta guía de API saber cómo funciona.
  • índice.html – Este es el punto de entrada para conectar complementos. archivo de configuración y plugin.js documento.echar un vistazo este ejemplo Aprende cómo debería verse.

Además de estos archivos obligatorios, la carpeta del complemento puede contener otros archivos. Por ejemplo, íconos, estilos de complementos, archivos Léame, servicios de terceros, etc. A continuación encontrará más información sobre dichos archivos.

Para escribir un buen código de trabajo para su complemento, necesita saber lo que necesita método y evento.

Paso 3. Ajusta el estilo del complemento

Escribir código para su complemento no es suficiente. También deberá diseñarlo para que parezca una parte integral del editor ONLYOFFICE.Para hacer esto, simplemente agregue la hoja de estilo ONLYOFFICE a índice.html El archivo anterior:


Puede agregar botones, controles de entrada, controles de etiquetas, cargadores y otros elementos.

Por ejemplo, para agregar un cuadro combinado a un complemento, puede usar opcion 2 Función:

 
$('#select_example').select2({     
data : [{id:0, text:'Item 1'}, {id:1, text:'Item 2'}, {id:2, text:'Item 3'}],     
minimumResultsForSearch: Infinity,     
width : '120px' 
});

El cuadro combinado insertado se verá así:

Elementos de estilo de complemento

Para obtener más información sobre los elementos de estilo ONLYOFFICE, consulte aquí.

Paso 4: localice su complemento (opcional)

Puede omitir este paso si planea crear el complemento solo para usuarios de habla inglesa.Sin embargo, si desea que sus complementos estén disponibles en otros idiomas, puede crear carpetas de traducción en el directorio de complementos y colocar su .json archivos en todos los idiomas que desee utilizar.

leer Documentación oficial de la API Aprenda cómo localizar correctamente su complemento aquí.

Paso 5. Prepare el complemento para su publicación en ONLYOFFICE Marketplace

Para pulir el aspecto de su complemento antes de que esté disponible en el mercado de ONLYOFFICE, debe agregar un sobre ventana con una breve descripción de su complemento, su versión, nombre del desarrollador y más.

Por ejemplo, esto es sobre ventana editor de fotos insertar:

Crear una ventana Acerca de
Crear una ventana Acerca de

Para poder crear una ventana de este tipo para su complemento, siga estas instrucciones.

Además, debe crear íconos para su complemento y colocarlos en la carpeta de recursos. Por lo general, necesita 8 íconos para que su complemento se muestre correctamente en el mercado de complementos de ONLYOFFICE: 4 íconos (125 %, 150 %, 175 % y 200 % de zoom) para temas de interfaz Claro y Oscuro.

Además, puede crear un README y colocarlo en la carpeta principal del complemento. Este archivo puede contener cualquier información que desee que otros usuarios conozcan: una descripción de las funciones principales del complemento, instrucciones de instalación, problemas y errores conocidos, etc.

Ahora que su complemento está listo, puede probarlo correctamente antes de lanzarlo al mercado.

Paso 6. Pruebe su complemento ONLYOFFICE Docs

Ahora es el momento de colocar todos los archivos creados de acuerdo con las instrucciones anteriores en la carpeta de complementos. Luego, envíe la carpeta del complemento al repositorio remoto y pruebe el complemento en el editor de escritorio de ONLYOFFICE. Para hacer esto, puede ejecutar la aplicación de escritorio en modo de depuración.

En Linux, puede abrir una terminal con el siguiente comando CTRL+ALT+TDespués de eso, ingrese la ruta Editor de escritorio ONLYOFFICEagregue un espacio, luego especifique --ascdesktop-support-debug-info:

"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info

Pruebe su complemento y su funcionalidad.

Si todo va bien, también puede probar su complemento en ONLYOFFICE Docs, la versión web de la suite ONLYOFFICE. En otras palabras, su complemento se puede agregar como una nueva extensión.

Para crear la extensión correspondiente, debe abrir onlyoffice.github.io/store/plugin-dev/extension/inject.js archivo y especifique la ruta al complemento en el sitio de Páginas de GitHub URL_TO_PLUGIN Cambiando:

var URL_TO_PLUGIN = "

Este onlyoffice.github.io/store/plugin-dev/extension carpeta es la extensión que necesita.Simplemente cárguelo en su navegador web, ejecute su ONLYOFFICE Docs y Plugin Manager existir Pestaña de complementos en la barra de herramientas superior.Guía detallada aquí Cómo agregar complementos a un navegador web.

Administrador de complementos de ONLYOFFICE
Administrador de complementos de ONLYOFFICE

Si su complemento funciona como se esperaba, puede continuar con el último paso.

Paso 7. Envíe el complemento al mercado de ONLYOFFICE

¡Felicidades! Ha completado el proceso de creación del complemento y ahora puede hacer que su complemento esté disponible para otros usuarios. Para hacer esto, puede crear una solicitud de extracción desde su bifurcación a este repositorio de ONLYOFFICE:


Si su complemento funciona bien, entonces SOLO OFICINA El desarrollador aprobará su solicitud de extracción y su complemento aparecerá en SOLO OFICINA mercado de complementos. En este caso, otros pueden instalarlo desde el mercado con solo unos pocos clics.

Esperamos que este artículo le haya resultado útil. No olvides compartir tus pensamientos en los comentarios a continuación.

LEER  Comprender el archivo /etc/shells

Publicaciones relacionadas

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Botón volver arriba