×

Descubre

WIRIS plugin para editor HTML genérico

Introducción

En este documento se facilita asistencia a aquellos desarrolladores que quieran integrar WIRIS EDITOR en sus plataformas cuando no exista un plugin específico ya disponible. Más concretamente, este documento abarca dos situaciones:

  • La integración de WIRIS EDITOR en un editor de HTML. Consulta la demo activa.
  • La integración de WIRIS EDITOR en un sencillo Textarea. Por ejemplo en wikis, blogs y otras aplicaciones web que utilicen textarea para editar texto HTML enriquecido. Consulta la demo activa.

Antes de empezar cualquier desarrollo, asegúrate de que no existe ningún plugin acorde a tus necesidades. Consulta los plugins de WIRIS EDITOR.
 

DESCARGAR - Plugin editor de HTML                DESCARGAR - Plugin Textarea


1 Requisitos

  • Un servidor web compatible con PHP, ASP.NET, ASP o servlets Java (u otro lenguaje, pero nuestro motor interno solo se distribuye en PHP, ASP.NET y como servlet de Java).
  • Un servidor web compatible con la codificación UTF-8.
  • Dominio del lenguaje Javascript.
     
  • Una licencia válida para instalar el plugin en un entorno de producción; de lo contrario, puedes utilizar el archivo descargado solo como demo.

Nota importante: En versiones anteriores a la 3.50.0 el nombre del directorio del plugin era  pluginwiris en lugar de generic_wiris.

2 Inicio

2.1 Para servidores PHP

  1. Copia el directorio generic_wiris en la ruta raíz del sistema web. A continuación, edita generic_wiris/configuration.ini y define tus propios valores. En esta tabla se especifican todos los parámetros posibles.
  2. Otorga derechos de ejecución al usuario del servidor web sobre los archivos PHP contenidos en generic_wiris/integration.

2.2 Para servidores ASP.NET

Copia el directorio generic_wiris en la ruta raíz del sistema web.

Crea una aplicación en tu IIS a través del panel de control. El directorio raíz de la aplicación depende del paquete de WIRIS Plugin que hayas descargado.

  • Para el paquete demo: crea una aplicación con directorio raíz en la carpeta extraída.
  • Para el paquete de integración: crea una aplicación con directorio raíz en generic_wiris. En versiones anteriores a la 3.50.0 necesitas crear la aplicación en /pluginwiris/integration. Si, dados los requisitos o arquitectura de tu proyecto, necesitas tener únicamente una aplicación mueve el contenido de /generic_wiris/bin al directorio /bin de tu proyecto y copia la configuración de Web.config en el fichero Web.config de tu proyecto. Si utilizas .NET 4.0 o superior utilizas los valores de Web.config4.0.

A continuación, abre generic_wiris/configuration.ini y define tus propios valores. En esta tabla se especifican todos los parámetros posibles.

2.3 Para servidores ASP

Copia el directorio pluginwiris en la ruta raíz del sistema web. A continuación, edita pluginwiris/configuration.ini y define tus propios valores. En esta tabla se especifican todos los parámetros posibles.

2.4 Como servlet Java

  1. Instala pluginwiris_engine.war en tu servidor de aplicaciones web Java (tomcat).
  2. Copia el directorio generic_wiris en la ruta raíz del sistema web. A continuación, edita pluginwiris_engine/WEB-INF/pluginwiris/configuration.ini y define tus propios valores. En esta tabla se especifican todos los parámetros posibles. En versiones anteriores a la 3.50.0 la configuración de wiriscachedirectory y wirisformuladirectory es esencial para los plugins de Java.

2.5 Para Ruby on Rails

  1. Instala  la gema wirispluginengine manualmente
  2. Especifica la gema wirispluginengine en el Gemfile de tu aplicación.
  3. Monta el engine Wirispluginengine en tu el archivo config/routes.rb de tu servidor, añadiendo la sigueinte línea: mount Wirispluginengine::Engine => 'wirispluginengine'
  4. Copia el directorio generic_wiris en la ruta /vendor/assets/javascripts de tu aplicación.

3 Normas

Existen algunas normas para el desarrollo de plugins:

  • No edites los archivos generic_wiris/core. Estos archivos forman el kernel del plugin. Actualizaremos únicamente esos archivos en las futuras versiones.

Información complementaria importante

WIRIS Plugin se rige por el criterio siguiente:

  • Utiliza el directorio generic_wiris/formulas para guardar el MathML de las fórmulas (origen de las fórmulas). Estos archivos son muy importantes. Si quieres migrar tu servidor web, recuerda que debes copiar ese directorio; de lo contrario, las fórmulas que has creado (por ejemplo, en mensajes en los foros) se perderán.
  • Utiliza el directorio generic_wiris/cache para guardar los archivos de imagen. Estos archivos no son demasiado importantes. Puedes suprimirlos cuando quieras; se crearán de nuevo automáticamente cuando los navegadores soliciten las imágenes de las fórmulas.

Puedes utilizar este código de ejemplo para cargar tu implementación:

    <script type="text/javascript" src="./generic_wiris/core/core.js"></script>
    <script type="text/javascript" src="./generic_wiris/wirisplugin-generic.js"></script>
  

A continuación, puedes utilizar este código de ejemplo para iniciar WIRIS plugin cuando se cargue tu editor:

Variables de entorno

El core de WIRIS Plugin utiliza tres variables globales que debes utilizar/modificar:

  • _wrs_currentPath: contiene la dirección URL actual (para correcciones de Safari).
  • _wrs_isNewElement: debes definir esta variable booleana en true o false cuando abras una nueva ventana del editor, en función de si vas a crear una nueva fórmula o si vas a editarla.
  • _wrs_temporalImage: debes definir esta variable de objeto cuando abras una nueva ventana del editor. Debe contener la imagen que estás editando. Consulta integration.js para obtener más información.

6 Funciones

Existen funciones del core que puedes utilizar pero no modificar. Estas funciones se hallan en generic_wiris/core/core.js .

7 Ejemplos sencillos

Dispones de ejemplos sencillos de integraciones de WIRIS Plugin que puedes descargar.