Configurar o Editor de Rich Text

O Editor de Rich Text (RTE) fornece aos autores uma ampla variedade de funcionalidades para editar conteúdo de texto. Os ícones, caixas de seleção, barra de ferramentas e menus são fornecidos para uma experiência de edição de texto WYSIWYG. Os administradores configuram o RTE para habilitar, desabilitar e estender os recursos disponíveis nos componentes de criação. Veja como os autores usam o RTE para criação de conteúdo da Web.

Os conceitos e etapas do RTE necessários para configurá-lo estão listados abaixo.

Entender os conceitos do RTE Habilitar recursos necessários Configurar funcionalidades individuais
Entender a interface Entender e definir locais de configuração Configurar plug-ins
Tipos de modos de edição Ativar plug-ins Definir propriedades de recursos
Sobre plug-ins Configurar barras de ferramentas do RTE Configurar os modos de colagem

Entender a interface do usuário disponível para os autores

A interface RTE oferece um design responsivo para o ambiente de criação. A interface foi projetada para uso em dispositivos de toque e desktop.

Barra de ferramentas do Editor de Rich Text

Figura: Barra de ferramentas do Editor de Rich Text com todas as opções disponíveis ativadas.

A barra de ferramentas fornece as opções para a experiência de criação WYSIWYG. Experience Manager os administradores podem configurar as opções disponíveis na barra de ferramentas na interface do . Um conjunto abrangente de opções de edição está disponível por padrão em Experience Manager. Os desenvolvedores podem personalizar Experience Manager para adicionar mais opções de edição.

Vários modos de edição

Os autores podem criar e editar conteúdo textual em Experience Manager usando os diferentes modos de componentes. As opções da barra de ferramentas para criação e formatação de conteúdo e a experiência do usuário de componentes habilitados para RTE em diferentes modos de edição variam com base nas configurações de RTE.

Modo de edição Área de edição Recursos recomendados a serem ativados
Inline Edição no local para edições rápidas e secundárias; Formatar sem abrir uma caixa de diálogo. Recursos mínimos do RTE.
Tela cheia do RTE Abrange a página inteira. Todos os recursos RTE necessários.
Caixa de diálogo Caixa de diálogo na parte superior do conteúdo da página, mas não abrange a página inteira. Ativar recursos de forma judicial.
Tela cheia da caixa de diálogo Igual ao modo de tela cheia; contém campos da caixa de diálogo ao lado do RTE. Todos os recursos RTE necessários.
OBSERVAÇÃO

O recurso de edição de origem não está disponível no modo de edição em linha. Não é possível arrastar as imagens no modo de tela cheia. Todos os outros recursos funcionam em todos os modos.

Edição em linha

Para editar o conteúdo em uma página, abra-o com um clique duplo lento. Uma barra de ferramentas compacta com opções básicas é apresentada.

Edição em linha com opções básicas na barra de ferramentas

Figura: Edição em linha com opções básicas na barra de ferramentas.

Edição em tela cheia

Experience Manager os componentes podem ser abertos na visualização em tela cheia, que oculta o conteúdo da página e ocupa a tela disponível. Considere a edição em tela cheia de uma versão detalhada da edição em linha, pois oferece as opções de edição mais abrangentes. Ele pode ser aberto clicando em Ícone para abrir o RTE em tela cheia, na barra de ferramentas compacta, ao usar o modo de edição em linha.

No modo de tela cheia da caixa de diálogo, juntamente com uma barra de ferramentas RTE detalhada, as opções e os componentes disponíveis em uma caixa de diálogo também estão disponíveis. É aplicável somente para uma caixa de diálogo que contém o RTE juntamente com outros componentes.

A barra de ferramentas do RTE detalhada ao editar no modo de tela cheia

Figura: A barra de ferramentas detalhada do RTE ao editar no modo de tela cheia.

Edição de caixa de diálogo

Quando um componente é clicado duas vezes, uma caixa de diálogo é aberta para edição do conteúdo. A caixa de diálogo é aberta na parte superior da página existente. Em alguns cenários específicos, a caixa de diálogo é aberta como uma janela pop-up. Por exemplo, quando um componente de Texto faz parte de uma coluna em um layout de página de várias colunas e a área disponível para a caixa de diálogo é menor.

Modo de edição de diálogo

Figura: Modo de edição da caixa de diálogo.

Sobre plug-ins do RTE e os recursos associados

A funcionalidade é disponibilizada por meio de uma série de plug-ins, cada um com:

  • Uma propriedade features que é,

    • Usado para ativar ou desativar a funcionalidade básica desse plug-in.
    • Configurado usando um procedimento padrão.
  • Quando apropriado, mais propriedades e opções que exigem configuração especializada.

Os recursos básicos do RTE são ativados ou desativados pelo valor da propriedade features em um nó específico ao plug-in apropriado.

A tabela a seguir lista os plug-ins atuais, mostrando:

  • IDs de plug-in com um link para a documentação da API. A ID é usada como o nome do nó quando ativar um plug-in.
  • Valores permitidos para a propriedade features.
  • Uma descrição da funcionalidade fornecida pelo plug-in.
ID do plug-in recursos Descrição
editar cut, copy, paste-default, paste-plaintext, paste-wordhtml Corte, copie e, os três modos de colagem.
findreplace find, replace Localize e substitua.
format bold, italic, underline Formatação básica de texto.
imagem image Suporte básico a imagens (arraste do conteúdo ou do Localizador de conteúdo). Dependendo do navegador, o suporte tem comportamentos diferentes para autores
teclas - Para definir esse valor, consulte tamanho da guia.
justify justifyleft, justifycenter, justifyright Alinhamento de parágrafo.
links modifylink, unlink, anchor Hiperlinks e âncoras.
listas ordered, unordered, indent, outdent Este plug-in controla o recuo e lista; incluindo listas aninhadas.
miscelânea specialchars, sourceedit Ferramentas diversas permitem que os autores insiram caracteres especiais ou editem a fonte HTML. Além disso, você pode adicionar um intervalo de caracteres especiais se desejar definir sua própria lista.
Paraformat paraformat Os formatos de parágrafo padrão são Parágrafo, Cabeçalho 1, Cabeçalho 2 e Cabeçalho 3 (<p>, <h1>, <h2> e <h3>). Você pode adicionar mais formatos de parágrafo ou estender a lista.
verificação ortográfica checktext Verificador ortográfico com reconhecimento de idioma.
estilos styles Suporte para estilo usando uma classe CSS. Adicione novos estilos de texto se quiser adicionar (ou estender) seu próprio intervalo de estilos para uso com texto.
subsobrescrito subscript, superscript Extensões para os formatos básicos, adicionando sub-script e super-script.
tabela table, removetable, insertrow, removerow, insertcolumn, removecolumn, cellprops, mergecells, splitcell, selectrow, selectcolumns Consulte configurar estilos de tabela para adicionar seus próprios estilos para tabelas inteiras ou células individuais.
desfazer undo, redo Tamanho do histórico das operações desfazer e refazer.
OBSERVAÇÃO

O plug-in de tela cheia não é compatível com o modo de diálogo. Use a configuração dialogFullScreen para configurar a barra de ferramentas para o modo de tela cheia.

Entenda os caminhos e locais de configuração

O modo de edição do RTE e a interface que você fornece para seus autores decidem o local para os detalhes de configuração quando você está ativando os plug-ins do RTE. As localizações são:

  • Modo em linha: cq:editConfig/cq:inplaceEditing.
  • Modo de tela cheia: cq:editConfig/cq:inplaceEditing.
  • Modo de diálogo: cq:dialog.
  • Modo de diálogo de tela cheia: cq:dialog.
OBSERVAÇÃO

Não nomeie o nó em cq:inplaceEditing como config. No nó cq:inplaceEditing, defina as seguintes propriedades:

  • Nome: configPath
  • Tipo: String
  • Valor: caminho do nó que contém a configuração real

Não nomeie o nó de configuração do RTE como config. Caso contrário, as configurações do RTE entrarão em vigor apenas para os administradores e não para os usuários no grupo content-author.

Configure as seguintes propriedades que se aplicam ao modo de edição da caixa de diálogo:

  • useFixedInlineToolbar: É possível corrigir a barra de ferramentas do RTE em vez de flutuar. Defina essa propriedade booleana definida no nó RTE com sling:resourceType= cq/gui/components/authoring/dialog/richtext para True. Quando essa propriedade é definida como True, a edição de rich text é iniciada no evento foundation-contentloaded. Para evitar isso, defina a propriedade customStart como True e acione o evento rte-start para iniciar a edição do RTE. Quando essa propriedade é true, o RTE não começa a clicar e esse é o comportamento padrão.

  • customStart: Defina essa propriedade booleana definida no nó RTE como True, para controlar quando iniciar o RTE acionando o evento rte-start.

  • rte-start: Acione esse evento no contenteditable-div do RTE, quando começar a editar o RTE. Funciona somente se customStart tiver sido definido como true.

Quando o RTE for usado na caixa de diálogo habilitada para toque, defina a propriedade useFixedInlineToolbar como true para evitar problemas.

Ative as funcionalidades do RTE ativando plug-ins

As funcionalidades do RTE são disponibilizadas por meio de uma série de plug-ins, cada um com a propriedade features . Você pode configurar a propriedade features para ativar ou desativar os vários recursos de cada plug-in.

Para obter configurações detalhadas dos plug-ins do RTE, consulte como ativar e configurar os plug-ins do RTE.

O Componente de texto dos Componentes principais permite que os editores de modelo configurem muitos plug-ins do RTE usando a interface do usuário como políticas de conteúdo, eliminando a necessidade de configuração técnica. As políticas de conteúdo podem funcionar com as configurações da interface do usuário do RTE conforme descrito neste documento. Para obter mais informações, consulte criar modelos de página e a documentação do desenvolvedor dos Componentes principais.

Para fins de referência, os componentes de Texto padrão (fornecidos como parte de uma instalação padrão) podem ser encontrados em:

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

Para criar seu próprio componente de texto, copie o componente acima em vez de editar esses componentes.

Configurar a barra de ferramentas do RTE

Experience Manager permite configurar a interface do Editor de Rich Text de forma diferente para os diferentes modos de edição. As configurações padrão são fornecidas abaixo. Você pode substituir esses padrões com base em seus requisitos. Personalize somente os recursos da barra de ferramentas que deseja fornecer aos autores. Não é necessário especificar todas as configurações da barra de ferramentas.

Para configurar a barra de ferramentas para dialogFullScreen, use a seguinte configuração de amostra.

<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>

Diferentes configurações da interface do usuário são usadas para o modo em linha e o modo de tela cheia. A propriedade toolbar especifica a opção da barra de ferramentas.

Por exemplo, se a opção for em si um recurso (por exemplo, Bold), ela será especificada como PluginName#FeatureName (por exemplo, links#modifylink).

Se a opção for um pop-up (contendo alguns recursos de um plug-in), ela será especificada como #PluginName (por exemplo, #format).

Os separadores (|) entre um grupo de opções podem ser especificados com -.

O nó pop-up no modo em linha ou em tela cheia contém uma lista dos pop-ups usados. Cada nó filho no nó popovers é nomeado após o plug-in (por exemplo, formato). Ela tem um "itens" de propriedade contendo uma lista de recursos do plug-in (por exemplo, format#bold).

Configurações da interface do usuário do RTE e políticas de conteúdo

Os administradores podem controlar as opções de RTE usando políticas de conteúdo, em vez de fazer a configuração conforme descrito acima. As políticas de conteúdo definem as propriedades de design de um componente quando usadas como parte de um modelo editável. Por exemplo, se um componente de texto que usa o RTE for usado com um modelo editável, a política de conteúdo poderá definir que a opção em negrito esteja disponível e algumas opções de formatação de parágrafo estarão disponíveis. As políticas de conteúdo são reutilizáveis e podem ser aplicadas em vários modelos.

As opções disponíveis no RTE fluem downstream das configurações da interface do usuário para as políticas de conteúdo.

  • As configurações da interface do usuário definem quais opções estão disponíveis para as políticas de conteúdo.
  • Se a configuração da interface do usuário do RTE tiver sido removida ou não ativar um item, a política de conteúdo não poderá configurá-la.
  • Um autor tem acesso somente à funcionalidade disponibilizada pelas configurações da interface do usuário e pelas políticas de conteúdo.

Como exemplo, você pode ver a documentação do Componente principal de texto.

Personalizar mapeamento entre ícones e comandos da barra de ferramentas

Você pode personalizar o mapeamento entre os ícones Corais exibidos na barra de ferramentas do RTE e os comandos disponíveis. Não é possível usar outros ícones além dos ícones Coral.

  1. Crie um nó chamado icons em uiSettings/cui.

  2. Crie nós para ícones individuais abaixo dele.

  3. Em cada um dos nós de ícone individuais, especifique um ícone Coral e um comando para mapear para o ícone.

Abaixo está um trecho de amostra para mapear o comando Bold para o ícone Coral chamado 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>

Limitações conhecidas

Experience Manager O recurso RTE tem as seguintes limitações:

  • Os recursos de RTE são compatíveis apenas nas caixas de diálogo de componentes Experience Manager. O RTE não é compatível com assistentes ou formulários básicos.

  • Experience Manager não funciona em dispositivos híbridos.

  • Não nomeie o nó de configuração do RTE config. Caso contrário, a configuração do RTE entrará em vigor apenas para os administradores e não para os usuários no grupo content-author.

  • O RTE não suporta a incorporação de conteúdo em um quadro em linha ou em um iframe.

Práticas recomendadas e dicas

  • Para uma caixa de diálogo flutuante, ative apenas os plug-ins sem uma caixa de diálogo pop-up. Plug-ins sem pop-up são menores e mais adequados para uma caixa de diálogo flutuante.
  • Ative os plug-ins com um pop-up maior, como o Paste plug-in, somente no modo de diálogo de tela cheia ou no modo de tela cheia. Plug-ins com pop-up grande precisam de mais espaço para tela para proporcionar uma boa experiência de criação.
  • Se você estiver usando plug-ins personalizados para o RTE CoralUI3, use a biblioteca rte.coralui3.

Nesta página