Añadir un elemento de código JavaScript

Utilice un elemento de código JavaScript para cada bloque de código que esté utilizando en una plantilla.
Restricción: Icono Nueva característica El elemento de código JavaScript solo está disponible en plantillas de la versión 2.

Acerca de esta tarea

JavaScript puede ir desde argumento simples hasta scripts complejos.
  • Para argumentos simples, puede aplicar script al contenido de un elemento, como un elemento de texto. Efectúe una doble pulsación en el elemento de texto, seleccione el separador Expresión de script y especifique un script.
  • Para scripts complejos, puede utilizar esta tarea para aplicar el script utilizando el elemento de código JavaScript.
Lo que aparece a continuación son ventajas para utilizar el elemento de código JavaScript sobre el separador Expresión de script de un elemento:
  • Puede reutilizar scripts de otros usuarios.
  • Puede agrupar cálculos sin preocuparse por el orden de su ejecución.
  • Puede crear estructuras de datos normales y complejas, como colecciones y añadirlas continuamente.
    Consejo: A partir de Rational Publishing Engine V2.1 release, puede llamar a la función que está definida en un elemento de código JavaScript en otro código JavaScript u otra Expresión de script estableciendo una propiedad Script de biblioteca en el código de script. Para establecer la propiedad Script de biblioteca, vaya a la vista Propiedades del elemento JavaScript Code y seleccione el separador Específica, habilite el recuadro Script de biblioteca. Si desea más información sobre la propiedad de script de biblioteca, consulte Propiedades de elemento de código JavaScript.

El archivo JavaScript utils.js está incluido en los archivos de instalación y en los archivos del componente Creador de documentos predefinidos para que los utilice para el JavaScript simple, como incluir la fecha actual en la salida del informe.

Para ver una lista del código JavaScript existente en la plantilla, pulse Plantilla > Revisar JavaScript. La vista Búsqueda se abre y se muestra una lista de elementos que utilizan JavaScript. Los filtros nativos no se consideran JavaScript en este contexto. Los filtros nativos no se listan en los resultados de búsqueda.

Procedimiento

  1. Guarde la plantilla antes de empezar a trabajar con JavaScript.
  2. En la vista Paleta, seleccione el elemento de Icono Código JavaScript código JavaScript y arrástrelo hasta el editor de contenidos de plantilla.
  3. Efectúe una doble pulsación en el elemento de código JavaScript.
  4. En el separador Expresión de script, seleccione una variable en el árbol para aplicarle el código JavaScript.
  5. Especifique el código JavaScript utilizando una de estas opciones:
    • Escriba un script manualmente en esta ventana
    • Copie y pegue un script de un editor externo a una ventana
    • Pulse Incluir script y seleccionando un archivo desde su sistema, un servidor remoto o desde el componente Creador de documentos
  6. Opcional: Si ha copiado el script de XHTML, puede:
    • Seleccionar la opción Entrada XHTML para permitir que se editen las etiquetas XHTML que están incluidas en el script.
    • Borar la opción Entrada XHTML para eliminar todas las etiquetas XHTML del script.
    Si está copiando texto enriquecido o está utilizando texto enriquecido en condiciones, debe seleccionar la opción Entrada XHTML.
    Importante: XHTML no válido hace que la generación del documento falle. Compruebe que el XHTML sea válido antes de guardar los cambios.
  7. Opcional: Si está generando la plantilla en una salida XHTML, puede:
    • Seleccionar la opción Salida XHTML para analizar el script y representar el script como texto enriquecido.
    • Borrar la opción Salida XHTML para tratar el script como texto plano.
    Esta selección se aplica a todos los atributos de origen de datos en la expresión. No puede mezclar texto plano y XHTML en el script.

    Si está copiando texto enriquecido o creando texto enriquecido con una base ad hoc, debe seleccionar la opción Salida XHTML.

  8. Tras especificar el script, pulse Script de prueba para validar el código. Si existen errores en JavaScript, la generación de documentos podría no completarse correctamente.
  9. Pulse Aceptar para guardar los cambios. El bloque de código se contrae en el elemento. Puede ampliar el código para verlo en el editor de contenidos de plantilla.

Trabajar en el editor JavaScript

Utilice el editor JavaScript para trabajar en el script con el coloreado de sintaxis y la asistencia de contenido.

Acerca de esta tarea

El coloreado de sintaxis especifica cómo se representa el código fuente JavaScript con su propio color y estilo. Para cambiar la preferencias de color de sintaxis predeterminadas, en Document Studio seleccione Windows > Preferencias > JavaScript > Editor > Coloreado de sintaxis.

La asistencia de contenido muestra en una ventana emergente una lista de alternativas válidas para completar la línea de código actual. Para activar la asistencia de contenido, pulse Ctrl + Espacio.

Esta es una captura de pantalla del editor JavaScript.

Procedimiento

  1. Efectúe una doble pulsación en el elemento de código JavaScript. Se abre la ventana Código de entrada para elemento de código JavaScript.
  2. Opcional: Si está incluyendo un nuevo script de otro archivo, pulse Incluir script y seleccione un archivo del sistema, un servidor remoto o del componente Creador de documentos. Pulse Aceptar.

    Para los archivos seleccionados en el sistema o un servidor remoto, se abre una copia del código JavaScript del archivo seleccionado en el editor JavaScript.

    Para los archivos seleccionados desde Creador de documentos, se abre la ventana Utilizar referencia de script. Debe elegir si desea incluir JavaScript como un enlace de referencia en la plantilla:
    • Si selecciona , el enlace al archivo JavaScript (.js) se incorpora dentro de una etiqueta <Script>. Por ejemplo, se añade el enlace de referencia siguiente en el editor JavaScript que no debe modificar:
      <Script src= "library://api/scripts/51"></Script>
      Recuerde: Cuando se ejecuta la generación de documentos desde la plantilla, y tiene un JavaScript como un enlace de referencia en la plantilla, el Creador de documentos debe estar activo y conectado a Document Studio. Si desea más detalles, consulte el tema Conexión al componente Creador de documentos.
    • Si selecciona No, se abre una copia del código JavaScript del archivo seleccionado en el editor JavaScript.
  3. Opcional: Pulse Abrir en el editor para especificar el script en un editor de Eclipse JavaScript. El script se abre en un nuevo separador de editor como un archivo .js temporal como, por ejemplo, puede editar el JavaScript y gestionar el script a través de las opciones en la vista Esquema. Tras editar el script, guarde los cambios y cierre el separador temporal del editor JavaScript para volver a la ventana Código de entrada para un elemento de código JavaScript.
  4. Pulse Script de prueba para validar el código.
  5. Pulse Aceptar para guardar los cambios y salir de la ventana.