Productos » WIRIS Plugins » Documentación

WIRIS plugin para editor HTML genérico

 

Introducción

 

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

  • La integración de los componentes de WIRIS en un editor de HTML. Consulta la demo activa.
  • La integración de los componentes de WIRIS 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 WIRIS editor y WIRIS cas.
 

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.

2 Inicio

2.1 Para servidores PHP

  1. Copia el directorio pluginwiris (junto a este archivo readme) 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. Otorga derechos de ejecución al usuario del servidor web sobre los archivos PHP contenidos en pluginwiris/integration.

2.2 Para servidores ASP.NET

Copia el directorio pluginwiris (junto a este archivo readme) 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 ./<plugin directory>/integration/.

A continuación, abre pluginwiris/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 (junto a este archivo readme) 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 (junto a este archivo readme) en tu servidor de aplicaciones web Java (tomcat).
  2. Por defecto, el código javascript carga pluginwiris_engine de la raíz del servidor de aplicaciones web (/pluginwiris_engine/app). Sin embargo, si quieres almacenar pluginwiris_engine en otra ruta, debes editar estos códigos javascript.
    1. Abre pluginwiris/integration/integration.js.
    2. Cambia las variables _wrs_conf_editorPath, _wrs_conf_CASPath, _wrs_conf_createimagePath y _wrs_conf_createcasimagePath por los valores que prefieras.
    3. Guarda los cambios.
  3. Copia el directorio pluginwiris (junto a este archivo readme) 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. Debes establecer al menos el valor de los parámetros "wiriscachedirectory" y "wirisformuladirectory".

3 Normas

Existen algunas normas para el desarrollo de plugins:

  • No edites los archivos pluginwiris/core. Estos archivos forman el kernel del plugin. Actualizaremos únicamente esos archivos en las futuras versiones.
  • Edita tu archivo pluginwiris/integration/integration.js para integrar el plugin. El archivo contiene instrucciones sobre cómo hacerlo.

4 Información complementaria importante

WIRIS Plugin se rige por el criterio siguiente:

  • Utiliza el directorio pluginwiris/formulas (en la integración del servlet de Java tú especificas este directorio) 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 pluginwiris/cache (en la integración del servlet de Java tú especificas este directorio) 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="./pluginwiris/core/core.js"></script>
    <script type="text/javascript" src="./pluginwiris/integration/integration.js"></script>

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

wrs_int_init(<your wrs_int_params, see integration.js>);

5 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 pluginwiris/core/core.js .

7 Ejemplos sencillos

Dispones de ejemplos sencillos de integraciones de WIRIS Plugin que puedes descargar. Consulta también las demos activas.