Documentação AEM Guides Documentação do AEM Guides

Personalizar barra de ferramentas id172FB00L0V6

Last update: Fri Jul 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

undefined
undefined

Por padrão, o Editor da Web é fornecido com os recursos editoriais mais comuns exigidos por qualquer editor DITA. Recursos como inserir elementos da lista de tipos (numerada ou com marcadores), referência cruzada, referência de conteúdo, tabela, parágrafo e formatação de caracteres estão disponíveis no editor. Além desses elementos básicos, você pode personalizar o Editor da Web para inserir elementos usados no seu ambiente de criação.

Há duas maneiras de personalizar a barra de ferramentas do Editor da Web:

Adicionar uma nova funcionalidade à barra de ferramentas
Remover qualquer funcionalidade existente da barra de ferramentas

Adicionar um recurso na barra de ferramentas

Adicionar uma funcionalidade ao Editor da Web envolve duas tarefas principais: adicionar um ícone para o recurso no arquivo ui_config.json e adicionar a funcionalidade em segundo plano no JavaScript.

Adicionar um ícone na barra de ferramentas

Execute as seguintes etapas para adicionar um recurso à barra de ferramentas do Editor da Web:

Faça logon no AEM e abra o modo CRXDE Lite.
Navegue até o arquivo de configuração padrão disponível no seguinte local:

/libs/fmdita/clientlibs/clientlibs/xmleditor/ui_config.json
Crie uma cópia do arquivo de configuração padrão no seguinte local:

/apps/fmdita/xmleditor/ui_config.json
Navegue e abra o arquivo ui_config.json no nó apps para edição.

No arquivo ui_config.json, adicione a definição do novo recurso na seção de barras de ferramentas. Normalmente, você pode criar um novo grupo de botões da barra de ferramentas e adicionar um ou mais botões da barra de ferramentas a ele. Ou você pode adicionar um novo botão de barra de ferramentas em um grupo existente. Os detalhes a seguir são necessários para criar um novo grupo de barras de ferramentas:

tipo: especifique blockGroup como o valor type. Esse valor indica que você está criando um grupo de blocos que conteria um ou mais grupos da barra de ferramentas.
classe(s) de extração: Nome da(s) classe(s) separada(s) por espaço.

itens: especifique a definição de todos os grupos na barra de ferramentas. Cada grupo pode conter um ou vários ícones da barra de ferramentas. Para definir ícones em um grupo de barras de ferramentas, você precisa definir novamente o atributo type em items e definir seu valor como buttonGroup. Especifique um ou mais nomes de classe na propriedade extraclass. Especifique o nome do recurso na propriedade label. O trecho a seguir do arquivo ui_config.json mostra a definição do bloco da barra de ferramentas principal, seguida pela definição buttonGroup:

code language-json
`"toolbar": { "type": "blockGroup", "extraclass": "toolbar operations", "items": [ { "type": "buttonGroup", "extraclass": "left-controls", "label": "Left Controls", "items": [`

Na coleção items, é necessário especificar a definição de um ou mais ícones da barra de ferramentas.
É necessário definir as seguintes propriedades para adicionar um ícone da barra de ferramentas:

tipo: especifique button como o valor type. Esse valor indica que você está adicionando um botão da barra de ferramentas.
ícone: especifique o nome do ícone Coral que você deseja usar na barra de ferramentas.
variante: especifique quiet como o valor variant.
título: especifique a dica de ferramenta para o ícone.

ao clicar: especifique o nome do comando definido para o recurso no arquivo JavaScript. Se o comando exigir parâmetros de entrada, especifique o nome do comando como:

code language-javascript
`"on-click": {"name": "AUTHOR_INSERT_ELEMENT", "args": "simpletable"}`

mostrar ou ocultar: Se estiver definindo a propriedade show, especifique os modos nos quais o ícone será exibido. Os valores possíveis são - @isAuthorMode, @isSourceMode, @isPreviewMode, true (exibir em todos os modos), ou false (ocultar em todos os modos).

No lugar de show, você também pode definir a propriedade hide. Os valores possíveis são os mesmos da propriedade show com a única diferença de que o ícone não é exibido para o modo especificado.

Crie uma pasta clientlib e adicione seu JavaScript a essa pasta.
Atualize a propriedade categories da pasta clientlib atribuindo o valor de apps.fmdita.xml_editor.page_overrides.
Salve o arquivo ui_config.json e recarregue o Editor da Web.

Amostras de código do JavaScript

Esta seção fornece dois exemplos de código JavaScript que ajudariam você a começar a adicionar funcionalidades personalizadas. O exemplo a seguir mostra o número da versão do AEM Guides quando um usuário clica no ícone Mostrar versão na barra de ferramentas.

Adicione o seguinte código a um arquivo do JavaScript:

/**
* This file contains an example to show AEM Guides version
* number when a user clicks on the Show Version icon in the toolbar.
* Step 1. Create a clientlib folder and add save a file with your *JavaScript code into this folder. A code sample is shared below.
* Step 2: Update the categories property of the clientlib folder by *assigning it the value of
* "apps.fmdita.xml_editor.page_overrides".
* Step 3: Add the feature in the ui_config.json file as shown after the *sample code. Save the ui_config.json file and reload the Web Editor
 */

(function (window) {
  "use strict";

  window.addEventListener('DOMContentLoaded', function () {
    fmxml.ready(function () {
      fmxml.eventHandler.subscribe({
        key: 'user.alert',
        next: function next() {
          alert("AEM Guides version x.x");
        }
      });
    });
  });
})(window);

Adicione o recurso no arquivo ui_config.json como:

 {
      "type": "button",
      "icon": "alert",
      "title": "About AEM Guides",
      "variant": "quiet",

  "show": "true",
      "on-click": "user.alert"
  }

O exemplo a seguir mostra como alterar o estado de um documento de um arquivo ativo para "Em revisão".

/**
* This file contains an example to set the document state of an active *open documen to "In-Review".
* Step 1. Create a clientlib folder and add save a file with your *JavaScript code into this folder. A code sample is shared below.
* Step 2: Update the categories property of the clientlib folder by *assigning it the value of
* "apps.fmdita.xml_editor.page_overrides".
* Step 3: Add the feature in the ui_config.json file as shown after the *sample code. Save the ui_config.json file and reload the Web Editor
 */

(function (window) {
  "use strict";

  //Wait for the page has been completely loaded

  window.addEventListener('DOMContentLoaded', function () {

    //Wait for the xml editor to start
    fmxml.ready(function () {

      //Subscribe to 'user.docstate.to.in-review' event
      fmxml.eventHandler.subscribe({
        key: 'user.docstate.to.in-review',
        next: function next() {
          var docstate = "In-Review"; // New docstate name
          var filePath = fmxml.curEditor.filePath;
// Get the file path of active open file
          if (filePath) {
            //Call API to change the doc state
            $.ajax({
              type: 'POST',
              url: '/bin/fmdita/states',
              data: {
                paths: filePath,
                operation: "setdocstates",
                docstate: docstate
              }
            }).fail(function (xhr, textStatus, errorThrown) {
              console.error("Cannot update docstate to " + docstate);
            }).success(function (data) {
              console.log('docstate updated to ' + docstate);
            });
          }
        }
      });
    });
  });
})(window);

Adicione o recurso no arquivo ui_config.json como:

 {
      "type": "button",
      "icon": "actions",
      "title": "Change document state to In-Review",
      "variant": "quiet",
      "show": "true",
      "on-click": "user.docstate.to.in-review"
    }

Remover um recurso da barra de ferramentas

Às vezes, você pode não querer fornecer todos os recursos atualmente disponíveis no Editor da Web. Nesse caso, você pode remover o recurso indesejado da barra de ferramentas do Editor da Web.

Execute as seguintes etapas para remover qualquer recurso indesejado da barra de ferramentas:

Faça logon no AEM e abra o modo CRXDE Lite.
Navegue até o arquivo de configuração padrão disponível no seguinte local:.

/libs/fmdita/clientlibs/clientlibs/xmleditor/ui_config.json
Crie uma cópia do arquivo de configuração padrão no seguinte local:

/apps/fmdita/xmleditor/ui_config.json
Navegue e abra o arquivo ui_config.json no nó apps para edição.
O arquivo ui_config.json tem três seções:

barras de ferramentas: Esta seção contém a definição de todos os recursos disponíveis na barra de ferramentas do editor, como Inserir/Remover lista numerada, (arquivo) Fechar, Salvar, Comentários e muito mais.
atalhos: Esta seção contém a definição de atalhos de teclado atribuídos a um recurso específico no editor.
modelos: Esta seção contém a estrutura predefinida de elementos DITA que você pode usar no documento. Por padrão, a seção de modelos contém definições de modelo para um parágrafo, tabela simples, tabela e elementos de corpo. É possível criar uma definição de modelo para qualquer elemento adicionando uma estrutura XML válida para o elemento desejado. Por exemplo, se você deseja adicionar um elemento p a cada novo elemento li em uma lista, é possível adicionar o seguinte código no final da seção de modelos para fazer isso:

"li": "<li><p></p></li>"

Na seção de barras de ferramentas, remova a entrada do recurso que você não deseja expor aos usuários.
Salve o arquivo ui_config.json e recarregue o Editor da Web.

Tópico pai: Personalizar editor da Web

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178