Configuración del Editor de texto enriquecido

El Editor de texto enriquecido (RTE) proporciona a los autores una amplia gama de funciones para editar contenido de texto. Se proporcionan iconos, cuadros de selección, barras de herramientas y menús para una experiencia de edición de texto WYSIWYG. Los administradores configuran RTE para habilitar, deshabilitar y ampliar las funciones disponibles en los componentes de creación. Consulte cómo los autores utilizan RTE para crear contenido web.

A continuación se enumeran los conceptos y pasos de RTE necesarios para configurarlo.

Comprender la interfaz de usuario disponible para los autores

La interfaz RTE ofrece un diseño interactivo para el entorno de creación. La interfaz está diseñada para utilizarse en dispositivos táctiles y de escritorio.

Figura: Barra de herramientas del Editor de texto enriquecido con todas las opciones disponibles activadas.

La barra de herramientas proporciona las opciones para la experiencia de creación WYSIWYG. Experience Manager los administradores pueden configurar las opciones disponibles en la barra de herramientas de la interfaz. De forma predeterminada, hay disponible un conjunto completo de opciones de edición en Experience Manager. Los desarrolladores pueden personalizar Experience Manager para agregar más opciones de edición.

Varios modos de edición

Los autores pueden crear y editar contenido textual en Experience Manager utilizando los distintos modos de componentes. Las opciones de la barra de herramientas para crear y dar formato al contenido y la experiencia del usuario de los componentes habilitados para RTE en diferentes modos de edición varían según las configuraciones de RTE.

Edición en línea

Para editar el contenido dentro de una página, abra el contenido con un doble clic lento . Se presenta una barra de herramientas compacta con opciones básicas.

Figura: Edición en línea con opciones básicas en la barra de herramientas.

Edición en pantalla completa

Experience Manager los componentes se pueden abrir en la vista de pantalla completa que oculta el contenido de la página y ocupa la pantalla disponible. Considere la posibilidad de editar en pantalla completa una versión detallada de la edición en línea, ya que ofrece las opciones de edición más interesantes. Se puede abrir haciendo clic en , desde la barra de herramientas compacta cuando se utiliza el modo de edición en línea.

En el modo de pantalla completa del cuadro de diálogo, junto con una barra de herramientas RTE detallada, también están disponibles las opciones y los componentes disponibles en un cuadro de diálogo. Solo es aplicable a un cuadro de diálogo que contenga RTE junto con otros componentes.

Figura: La barra de herramientas detallada de RTE al editar en modo de pantalla completa.

Edición del cuadro de diálogo

Cuando se hace doble clic en un componente, se abre un cuadro de diálogo para editar el contenido. El cuadro de diálogo se abre sobre la página existente. En algunos casos específicos, el cuadro de diálogo se abre como una ventana emergente. Por ejemplo, cuando un componente Texto forma parte de una columna en un diseño de página de varias columnas y el área disponible para el cuadro de diálogo es menor.

Figura: Modo de edición del cuadro de diálogo.

Acerca de los complementos RTE y las funciones asociadas

La funcionalidad está disponible a través de una serie de complementos, cada uno con:

• Una propiedad features que es,

  • Se utiliza para activar o desactivar la funcionalidad básica de ese complemento.
  • Configurado mediante un procedimiento estandarizado.

• Cuando proceda, más propiedades y opciones que requieran una configuración especializada.

Las funciones básicas de RTE se activan o desactivan según el valor de la propiedad features en un nodo específico del complemento apropiado.

La tabla siguiente muestra los complementos actuales:

• ID de complemento con un vínculo a la documentación de la API. El ID se utiliza como nombre de nodo cuando se activa un complemento.
• Valores permitidos para la propiedad features.
• Descripción de la funcionalidad proporcionada por el complemento.

Comprender las rutas y ubicaciones de configuración

El modo de edición de RTE y la interfaz que proporcione a sus autores deciden la ubicación de los detalles de configuración cuando está activando los complementos de RTE. Las ubicaciones son:

• Modo en línea: cq:editConfig/cq:inplaceEditing.
• Modo de pantalla completa: cq:editConfig/cq:inplaceEditing.
• Modo de cuadro de diálogo: cq:dialog.
• Modo de diálogo de pantalla completa: cq:dialog.

Configure las siguientes propiedades que se aplican en el modo de edición de cuadro de diálogo:

• useFixedInlineToolbar: Puede hacer que la barra de herramientas RTE sea fija en lugar de flotante. Establezca esta propiedad booleana definida en el nodo RTE con sling:resourceType= cq/gui/components/authoring/dialog/richtext en True. Cuando esta propiedad se establece en True, la edición del texto enriquecido se inicia en el evento foundation-contentloaded. Para evitarlo, establezca la propiedad customStart en True y déclencheur el evento rte-start para iniciar la edición de RTE. Cuando esta propiedad es true, RTE no comienza al hacer clic y este es el comportamiento predeterminado.

• customStart: Establezca esta propiedad booleana definida en el nodo RTE en True, para controlar cuándo iniciar RTE activando el evento rte-start.

• rte-start: Déclencheur este evento en el contenteditable-div de RTE, cuándo iniciar la edición de RTE. Solo funciona si customStart se ha establecido en true.

Cuando se utiliza RTE en el cuadro de diálogo táctil, establezca la propiedad useFixedInlineToolbar en true para evitar problemas.

Habilitar las funcionalidades RTE activando los complementos

Las funcionalidades de RTE están disponibles a través de una serie de complementos, cada uno con propiedad de características. Puede configurar la propiedad features para habilitar o deshabilitar las distintas funciones de cada complemento.

Para obtener configuraciones detalladas de los complementos RTE, consulte cómo activar y configurar los complementos RTE.

El componente de texto Componentes principales permite a los editores de plantillas configurar muchos complementos RTE utilizando la interfaz de usuario como políticas de contenido, lo que elimina la necesidad de una configuración técnica. Las políticas de contenido pueden funcionar con las configuraciones de la interfaz de usuario de RTE como se describe en este documento. Para obtener más información, consulte crear plantillas de página y la documentación para desarrolladores de componentes principales.

Para fines de referencia, los componentes de texto predeterminados (entregados como parte de una instalación estándar) se pueden encontrar en:

• /libs/wcm/foundation/components/text
• /libs/foundation/components/text

Para crear su propio componente de texto, copie el componente anterior en lugar de editar estos componentes.

Configurar la barra de herramientas RTE

Experience Manager permite configurar la interfaz del Editor de texto enriquecido de forma diferente para los distintos modos de edición. A continuación se proporciona la configuración predeterminada. Puede anular estos valores predeterminados según sus necesidades. Personalice solo las funciones de la barra de herramientas que desea proporcionar a los autores. No es necesario especificar todas las configuraciones de la barra de herramientas.

Para configurar la barra de herramientas para dialogFullScreen, utilice la siguiente configuración de ejemplo.

<uiSettings jcr:primaryType="nt:unstructured">
  <cui jcr:primaryType="nt:unstructured">
    <inline
      jcr:primaryType="nt:unstructured"
      toolbar="[format#bold,format#italic,format#underline,#justify,#lists,links#modifylink,links#unlink,#paraformat]">
      <popovers jcr:primaryType="nt:unstructured">
        <justify
          jcr:primaryType="nt:unstructured"
          items="[justify#justifyleft,justify#justifycenter,justify#justifyright,justify#justifyjustify]"
          ref="justify"/>
        <lists
          jcr:primaryType="nt:unstructured"
          items="[lists#unordered,lists#ordered,lists#outdent,lists#indent]"
          ref="lists"/>
        <paraformat
          jcr:primaryType="nt:unstructured"
          items="paraformat:getFormats:paraformat-pulldown"
          ref="paraformat"/>
      </popovers>
    </inline>
    <dialogFullScreen
      jcr:primaryType="nt:unstructured"
      toolbar="[format#bold,format#italic,format#underline,justify#justifyleft,justify#justifycenter,justify#justifyright,justify#justifyjustify,lists#unordered,lists#ordered,lists#outdent,lists#indent,links#modifylink,links#unlink,table#createoredit,#paraformat,image#imageProps]">
      <popovers jcr:primaryType="nt:unstructured">
        <paraformat
          jcr:primaryType="nt:unstructured"
          items="paraformat:getFormats:paraformat-pulldown"
          ref="paraformat"/>
      </popovers>
    </dialogFullScreen>
    <tableEditOptions
      jcr:primaryType="nt:unstructured"
      toolbar="[table#insertcolumn-before,table#insertcolumn-after,table#removecolumn,-,table#insertrow-before,table#insertrow-after,table#removerow,-,table#mergecells-right,table#mergecells-down,table#mergecells,table#splitcell-horizontal,table#splitcell-vertical,-,table#selectrow,table#selectcolumn,-,table#ensureparagraph,-,table#modifytableandcell,table#removetable,-,undo#undo,undo#redo,-,table#exitTableEditing,-]">
    </tableEditOptions>
  </cui>
</uiSettings>

Para el modo en línea y el modo de pantalla completa se usan diferentes configuraciones de interfaz de usuario. La propiedad toolbar especifica la opción de la barra de herramientas.

Por ejemplo, si la opción es en sí misma una función (por ejemplo, Bold), se especifica como PluginName#FeatureName (por ejemplo, links#modifylink).

Si la opción es una ventana emergente (que contiene algunas características de un complemento), se especifica como #PluginName (por ejemplo, #format).

Los separadores (|) entre un grupo de opciones se pueden especificar con -.

El nodo emergente en modo en línea o pantalla completa contiene una lista de las ventanas emergentes que se están utilizando. Cada nodo secundario del nodo popovers recibe el nombre del complemento (por ejemplo, formato). Tiene una propiedad "items" que contiene una lista de características del complemento (por ejemplo, format#bold).

Configuración de la interfaz de usuario RTE y políticas de contenido

Los administradores pueden controlar las opciones de RTE mediante políticas de contenido, por ejemplo, en lugar de realizar la configuración como se ha descrito anteriormente. Las políticas de contenido definen las propiedades de diseño de un componente cuando se utilizan como parte de una plantilla editable. Por ejemplo, si se utiliza un componente de texto que utilice el editor de texto enriquecido con una plantilla editable, la política de contenido puede definir que la opción en negrita esté disponible y que haya algunas opciones de formato de párrafo disponibles. Las políticas de contenido se pueden reutilizar y se pueden aplicar en varias plantillas.

Las opciones disponibles en el flujo RTE descenden desde las configuraciones de la interfaz de usuario hasta las políticas de contenido.

• Los ajustes de configuración de la interfaz de usuario definen qué opciones están disponibles para las políticas de contenido.
• Si la configuración de la interfaz de usuario del RTE se ha eliminado o no permite un elemento, la directiva de contenido no puede configurarlo.
• Un autor solo tiene acceso a las funciones que están disponibles en las configuraciones de interfaz de usuario y en las políticas de contenido.

A modo de ejemplo, puede ver la documentación de los componentes principales de texto.

Personalización de la asignación entre iconos y comandos de la barra de herramientas

Puede personalizar la asignación entre los iconos de Coral que se muestran en la barra de herramientas de RTE y los comandos disponibles. No puede utilizar ningún otro icono aparte de los iconos de Coral.

1. Cree un nodo denominado icons en uiSettings/cui.

2. Cree nodos para iconos individuales debajo de él.

3. En cada uno de los nodos de icono individuales, especifique un icono de Coral y un comando para asignarlo al icono.

A continuación se muestra un fragmento de ejemplo para asignar el comando Bold al icono Coral llamado textItalic.

<text jcr:primaryType="nt:unstructured" sling:resourceType="cq/gui/components/authoring/dialog/richtext" name="./text" useFixedInlineToolbar="{Boolean}true">
    <rtePlugins jcr:primaryType="nt:unstructured">
        <format jcr:primaryType="nt:unstructured" features="bold,italic"/>
    </rtePlugins>
    <uiSettings jcr:primaryType="nt:unstructured">
        <cui jcr:primaryType="nt:unstructured">
            <inline jcr:primaryType="nt:unstructured"
                toolbar="[format#bold,format#italic,format#underline,links#modifylink,links#unlink]">
            </inline>
            <icons jcr:primaryType="nt:unstructured">
                <bold jcr:primaryType="nt:unstructured"
                    command="format#bold"
                    icon="textItalic"/>
            </icons>
        </cui>
    </uiSettings>
</text>

Limitaciones conocidas

Experience Manager La capacidad RTE tiene las siguientes limitaciones:

• Las capacidades de RTE solo se admiten en los cuadros de diálogo de componentes Experience Manager. RTE no es compatible con asistentes o formularios base.

• Experience Manager no funciona en dispositivos híbridos.

• No asigne un nombre al nodo de configuración RTE config. De lo contrario, la configuración de RTE surte efecto solo para los administradores y no para los usuarios del grupo content-author.

• RTE no admite la incrustación de contenido en un marco en línea o en un iframe.

Prácticas recomendadas y sugerencias

• Para un cuadro de diálogo flotante, habilite solo los complementos sin un cuadro de diálogo emergente. Los complementos sin ventanas emergentes tienen un tamaño menor y son más adecuados para un diálogo flotante.
• Habilite los complementos con ventanas emergentes de mayor tamaño, como el complemento Paste, solo en el modo de diálogo de pantalla completa o en modo de pantalla completa. Los complementos con ventanas emergentes de gran tamaño necesitan más espacio de pantalla para ofrecer una buena experiencia de creación.
• Si está utilizando complementos personalizados para CoralUI3 RTE, utilice la biblioteca rte.coralui3.