Definir configurações de geração de saída id181AI0B0E30

O AEM Guides vem com muitas opções de configuração para você personalizar o processo de geração de saída. Este tópico aborda todas as configurações e personalizações que ajudariam você a configurar o processo de geração de saída.

Configure a guia Linha de base no painel de mapa DITA id223MD0D0YRM

Para ocultar a guia Linha de base no painel do mapa DITA, execute as seguintes etapas:

Configurar a publicação combinada em um site AEM existente id1691I0V0MGR

Se você tiver um site AEM com conteúdo DITA, poderá configurar sua saída de site AEM para publicar conteúdo DITA em um local predefinido no seu site. Por exemplo, na captura de tela a seguir de uma página do site AEM, o nó ditacontent é reservado para armazenar conteúdo DITA:

Os nós restantes na página são criados diretamente do editor do site AEM. Definir a configuração de publicação para publicar conteúdo DITA em um local predefinido garante que nenhum conteúdo não DITA existente seja modificado pelo processo de publicação do AEM Guides.

É necessário executar as seguintes configurações no site existente para permitir a publicação de conteúdo DITA em um nó predefinido:

Execute as seguintes etapas para configurar as propriedades do modelo do site existente:

Na próxima vez que você publicar qualquer conteúdo DITA usando as configurações de modelo do seu site, o conteúdo será publicado nos nós especificados nas propriedades topicContentNode e topicHeadNode.

Personalizar saída do site AEM id166TG0B30WR

O AEM Guides oferece suporte à criação de saídas nos seguintes formatos:

Para a saída do site AEM, é possível atribuir modelos de design diferentes com tarefas de saída diferentes. Esses modelos de design podem renderizar o conteúdo DITA em diferentes layouts. Por exemplo, você pode especificar diferentes modelos de design para públicos-alvo internos e externos.

Você também pode usar os plug-ins DITA Open Toolkit (DITA-OT) personalizados com a AEM Guides. Você pode fazer upload desses plug-ins DITA-OT personalizados para gerar saída de PDF de uma maneira específica.

Personalizar modelo de design para gerar saída customize_xml-add-on

O AEM Guides usa um conjunto de modelos de design predefinidos para gerar a saída do site AEM. Você pode personalizar os modelos de design do AEM Guides para gerar a saída que esteja em conformidade com a marca corporativa. Um modelo de design é uma coleção de vários estilos (CSS), scripts (do lado do servidor e do lado do cliente), recursos (imagens, logotipos e outros ativos) e nós JCR que unem todos esses recursos. Um modelo de design pode ser tão simples quanto um único script do lado do servidor com apenas alguns nós JCR, ou uma combinação complexa de estilos, recursos e nós JCR. Os modelos de design são usados pelo subsistema de publicação do AEM Guides ao gerar a saída do site AEM e controlam a estrutura, a aparência e a funcionalidade da saída gerada.

Não há restrição quanto ao local onde os recursos do modelo de design devem estar localizados no servidor, mas geralmente são organizados logicamente de acordo com sua função. Por exemplo, o modelo padrão tem todos os seus arquivos JavaScript e CSS armazenados na pasta /etc/designs/fmdita/clientlibs/siteoutput/default. Sempre que esses arquivos estiverem localizados, eles serão vinculados por uma coleção de nós JCR. Juntos, esses nós JCR e os arquivos constituem todo o modelo de design.

O modelo de design padrão fornecido com o AEM Guides permite personalizar os componentes de página de aterrissagem, tópico e pesquisa. Você pode fazer uma cópia do design padrão e dos modelos de referência correspondentes e especificar componentes diferentes para gerar a saída desejada.

Execute as seguintes etapas para especificar seu próprio modelo de design a ser usado para a geração de saída do site AEM:

Para obter mais informações, consulte Criar o primeiro site do Adobe Experience Manager e Noções básicas sobre o desenvolvimento de seu próprio site no AEM.

Usar o título do documento para gerar a saída do site AEM

Ao gerar a saída do site AEM, a forma como os URLs são gerados desempenha um papel importante na descoberta do seu conteúdo. Caso esteja usando nomes de arquivo baseados em UUID, gerar URLs com base na UUID de seus arquivos não será amigável para pesquisa. Como Administrador ou Editor, você tem o controle sobre como gerar os URLs para a saída do AEM Site. O AEM Guides fornece uma configuração por meio da qual você pode optar por gerar os URLs de saída do site AEM usando o título do arquivo, em vez dos nomes de arquivo baseados em UUID. Por padrão, para sistemas de arquivos baseados em UUID, essa opção está ativada. Isso implicava que, quando você gera a saída do site AEM para sistemas de arquivos baseados em UUID, os títulos do arquivo são usados para gerar os URLs e não os UUIDs dos arquivos.

Use as instruções fornecidas em Substituições de configuração para criar o arquivo de configuração. No arquivo de configuração, forneça os seguintes detalhes (property) para configurar a geração de URLs na saída do site AEM:

Configure o URL da saída do site AEM para usar o título do documento

Você pode usar os títulos dos documentos no URL da saída do site AEM. Se o nome do arquivo não existir ou contiver todos os caracteres especiais, você poderá configurar o sistema para substituir os caracteres especiais por um separador no URL da saída do site AEM. Você também pode configurá-lo para substituí-los pelo nome do primeiro tópico filho.

Para configurar os nomes de página, execute as seguintes etapas:

Por exemplo, se @navtitle em <topichead> tiver todos os caracteres especiais e você definir a propriedade aemsite.pagetitle como verdadeira, ela usará um separador por padrão. Se você definir a propriedade nodename.systemDefinedPageName como true, ela mostrará o nome do primeiro tópico filho.

Configurar regras de limpeza de nome de arquivo para criar tópicos e publicar a saída do site AEM id2164D0KD0XA

Como administrador, você pode definir uma lista de caracteres especiais válidos permitidos em nomes de arquivo, que eventualmente formam o URL de uma saída de site AEM. Em versões anteriores, os usuários podiam definir nomes de arquivo contendo caracteres especiais como @, $, > e muito mais. Esses caracteres especiais resultavam em URL codificado na geração de páginas do site AEM.

A partir da versão 3.8, foram adicionadas configurações para definir uma lista de caracteres especiais permitidos nos nomes de arquivo. Por padrão, a configuração de nome de arquivo válido contém "a-z A-Z 0-9 - _". Isto implica que, ao criar um arquivo, você pode ter qualquer caractere especial no título do arquivo, mas internamente ele será substituído por um hífen (-) no nome do arquivo. Por exemplo, você pode ter o título do arquivo como Introdução 1 ou Introduction@1, o nome do arquivo correspondente gerado para ambos os casos seria Introdução-1.

Ao definir uma lista de caracteres válidos, lembre-se de que esses caracteres "*/:[\]|#%{}?&<>"/+" e a space sempre serão substituídos por um hífen (-).

Use as instruções fornecidas em Substituições de configuração para criar o arquivo de configuração. No arquivo de configuração, forneça os seguintes detalhes (propriedade) para configurar os caracteres especiais válidos nos nomes de arquivo e na saída do site AEM:

Você também pode configurar as outras propriedades, como usar letras minúsculas nos nomes de arquivo, separador para lidar com caracteres inválidos e o número máximo de caracteres permitidos nos nomes de arquivo. Para configurar essas propriedades, adicione os seguintes pares de valores principais no arquivo de configuração:

Configurar nivelamento da estrutura do nó do site AEM

Quando você gera a saída do site AEM, um nó para cada elemento nos tópicos é criado internamente. Para um mapa DITA com milhares de tópicos, essa estrutura de nó pode se tornar muito profunda. Esse tipo de estrutura de nó profundamente aninhada pode ter problemas de desempenho em sites maiores. O instantâneo a seguir exibe a estrutura de nó aninhada para uma saída do site AEM:

No instantâneo acima, observe que há um nó criado para cada elemento p e seus subelementos subsequentes, e uma estrutura semelhante é criada para todos os outros elementos usados no tópico.

O AEM Guides permite configurar como a estrutura de nó da saída do site AEM é criada internamente. É possível nivelar a estrutura do nó em elementos especificados, o que significa que você pode definir um elemento que será considerado como o elemento principal e todos os subelementos dentro dele serão mesclados com o elemento principal. Por exemplo, se você decidir nivelar o elemento p, qualquer elemento que apareça dentro do elemento p será mesclado com o elemento p principal. Uma nota separada não seria criada para nenhum subelemento dentro do elemento p. O instantâneo a seguir exibe a estrutura do nó nivelada no elemento p:

Para nivelar a estrutura do nó do site AEM, execute as seguintes etapas:

Agora, ao gerar a saída do Site AEM, os nós dentro do elemento p são nivelados e armazenados dentro do próprio elemento p. Você pode encontrar as novas propriedades de nivelamento para o elemento p no CRXDE.

Pesquisar uma cadeia de caracteres no conteúdo na saída do site AEM

Por padrão, você pode pesquisar por uma string nos títulos somente na saída do site AEM. Você pode configurar o sistema para procurar uma string nos títulos e também no conteúdo ou no corpo da saída do site do AEM.

Para habilitar a pesquisa, você deve configurar o nivelamento da estrutura do nó do site AEM.

CUIDADO:

Você pode pesquisar até 1 MB de conteúdo nivelado. Por exemplo, na captura de tela anterior, você pode pesquisar se o conteúdo na tag <p> é <= 1Mb.

Impedir nivelamento da estrutura do nó do site AEM

Semelhante à especificação do nó a ser nivelado na saída do site AEM, você também pode especificar um elemento que deseja excluir dessa configuração. Por exemplo, se você deseja nivelar nós no elemento body, mas não deseja nivelar nenhum elemento table em body, é possível adicionar a propriedade exclude na definição do elemento table.

Para excluir o elemento table do nivelamento, adicione a seguinte propriedade à definição do elemento table:

<preventancestorflattening>true|false</preventancestorflattening>

Configurar o controle de versão para páginas excluídas na saída do site AEM

Ao gerar uma saída de Site AEM com as opções Excluir e Criar ​ ​selecionadas para a configuração Páginas de Saída Existentes, uma versão é criada para a página(s) que está sendo excluída. Você pode configurar o sistema para interromper a criação de uma versão antes da exclusão.

Execute as seguintes etapas para interromper a criação de uma versão para a página(s) que está sendo excluída:

Configurar reescrita personalizada com o Experience Manager Guides custom-rewriter

O Experience Manager Guides tem um módulo sling rewriter personalizado para manipular os links gerados no caso de mapas cruzados (links entre os tópicos de dois mapas diferentes). Esta configuração de reescrita está instalada no seguinte caminho:
/apps/fmdita/config/rewriter/fmdita-crossmap-link-patcher.

Se você tiver outro reescritor sling personalizado em sua base de código, use um valor de 'order' maior que 50, pois o reescritor Experience Manager Guides sling usa 'order' 50. Para substituir isso, é necessário um valor >50. Para obter mais detalhes, consulte Pipelines de regravação de saída.

Usar metadados na saída de publicação por meio do DITA-OT id191LF0U0TY4

O AEM Guides fornece uma maneira de transmitir metadados personalizados ao publicar saída usando DITA-OT. Como administrador e Editor, seria necessário executar as seguintes tarefas para configurar e usar metadados personalizados na saída publicada:

Para adicionar os metadados necessários no sistema, execute as seguintes etapas:

O novo parâmetro agora é exibido na página Propriedades para todos os mapas DITA.

Em seguida, você precisa disponibilizar os metadados personalizados no console de mapas DITA. Execute as seguintes etapas para disponibilizar os metadados personalizados no painel do mapa DITA:

Agora, os metadados personalizados serão exibidos na lista suspensa Propriedades do console de mapa DITA.

Por fim, como Editor, é necessário incluir os metadados personalizados na saída publicada. Para processar os metadados personalizados ao gerar a saída, execute as seguintes etapas:

As propriedades/metadados selecionados são passados para o processo de publicação e disponibilizados na saída final.

Validar a transmissão de metadados ao DITA-OT para processamento

Para validar os valores de metadados transmitidos para o DITA-OT, é possível usar o ambiente local usando um jar pronto para nuvem. Como não é possível acessar o sistema de arquivos local na nuvem, a única maneira de validar o arquivo de metadados é por meio do jar pronto para nuvem.

Personalizar o mapeamento de elemento DITA com componentes AEM id1679J600HEL

Os elementos DITA no AEM Guides são mapeados para os componentes AEM correspondentes. O AEM Guides usa esse mapeamento em workflows como publicação e revisão para converter o elemento DITA em um componente AEM correspondente. O mapeamento é definido no arquivo elementmapping.xml, que pode ser acessado usando o gerenciador de pacotes.

Você pode usar os mapeamentos predefinidos de elementos DITA ou mapear elementos DITA para os componentes personalizados do AEM. Para usar os componentes personalizados do AEM, é necessário compreender a estrutura do arquivo elementmapping.xml.

estrutura elementmapping.xml

Uma visão geral de alto nível da estrutura elementmapping.xml é explicada abaixo:

Esquema de elemento DITA

Veja a seguir um exemplo do esquema do elemento DITA no arquivo elementmapping.xml:

<ditaelement>
    <name>element_name</name>
    <class>element_class</class>
    <componentpath>fmdita/components/dita/component_name</componentpath>
    <type>COMPOSITE|STANDALONE</type>
    <attributeprop>propname_a</attributeprop>
    <textprop>propname_t</textprop>
    <xmlprop>propname_x</xmlprop>
    <xpath>xpath expression string</xpath>
    <target>head|para</target>
    <wrapelement>div</wrapelement>
    <wrapclass>class_name</wrapclass>
    <attributemap>
        <attribute from="attrname"         to="propname"         ispath="true|false"         rel="source|target" />
    </attributemap>
    <skip>true|false</skip>
</ditaelement>

A tabela a seguir descreve os elementos do esquema de elemento DITA:

Observações adicionais

Personalizar o console de mapa DITA id188HC08M0CZ

O AEM Guides oferece a flexibilidade de estender os recursos do console de mapas DITA. Por exemplo, se você tiver um conjunto de relatórios diferente do que está disponível no AEM Guides, poderá adicioná-los ao console de mapa. Para personalizar o console de mapas, é necessário criar uma Biblioteca de clientes AEM (ou ClientLib) que conterá o código para executar a funcionalidade necessária.

A AEM Guides fornece a categoria apps.fmdita.dashboard-extn para personalizar o console de mapas. Sempre que o console de mapa é carregado, a funcionalidade criada na categoria apps.fmdita.dashboard-extn é executada e carregada.

Manipular a representação da imagem durante a geração da saída id177BF0G0VY4

O AEM vem com um conjunto de workflows e manipuladores de mídia padrão para processar ativos. No AEM, há fluxos de trabalho predefinidos para lidar com o processamento de ativos para os tipos MIME mais comuns. Normalmente, para cada imagem que você carrega, o AEM cria várias representações da mesma em formato binário. Essas representações podem ser de tamanhos diferentes, com uma resolução diferente, com uma marca d'água adicionada ou alguma outra característica alterada. Para obter mais informações sobre como o AEM trata ativos, consulte Processando o Assets usando Manipuladores de mídia e fluxos de trabalho na documentação do AEM.

O AEM Guides permite configurar qual representação de imagem usar no momento da geração de saída para seus documentos. Por exemplo, você pode escolher uma das representações de imagem padrão ou criar uma e usar a mesma para publicar seus documentos. O mapeamento de representação de imagem para publicação de seus documentos está armazenado no arquivo /libs/fmdita/config/ **renditionmap.xml**. Um trecho do arquivo renditionmap.xml é o seguinte:

<renditionmap>
   <mapelement>
      <mimetype>image/png</mimetype>
      <rendition output="AEMSITE">cq5dam.web.1280.1280.jpeg</rendition>
      <rendition output="PDF">original</rendition>
      <rendition output="HTML5">cq5dam.web.1280.1280.jpeg</rendition>
      <rendition output="EPUB">cq5dam.web.1280.1280.jpeg</rendition>
      <rendition output="CUSTOM">cq5dam.web.1280.1280.jpeg</rendition>
   </mapelement>
...
</renditionmap>

O elemento mimetype especifica o tipo MIME do formato de arquivo. O elemento rendition output especifica o tipo de formato de saída e o nome da representação (por exemplo, cq5dam.web.1280.1280.jpeg) que deve ser usada para publicar a saída especificada. Você pode especificar as representações de imagem a serem usadas para todos os formatos de saída compatíveis: AEMSITE, PDF, HTML5, EPUB e CUSTOM.

Se a representação especificada não estiver presente, o processo de publicação do AEM Guides primeiro procurará a representação da Web da imagem fornecida. Se nem mesmo a representação da Web for encontrada, a representação original da imagem será usada.

Configurar período de limpeza automática para histórico de saída id19AAI070V8Q

Quando você gera uma saída, ela é criada junto com os logs de saída. Para mapas DITA grandes, esses registros podem ocupar uma grande quantidade de espaço no repositório. Por padrão, os registros são armazenados no seguinte local do repositório:

/var/dxml/metadata/outputHistory

Durante um período de tempo, o tamanho coletivo de todos os arquivos de log poderia ficar em GB. O AEM Guides permite configurar um período para manter esses arquivos de log no repositório. Após o período especificado, os registros, juntamente com o histórico de geração de saída, são excluídos do repositório.

A configuração do recurso de limpeza de histórico afeta a geração de saída para todos os mapas DITA no repositório. Na guia Saídas de um mapa DITA, o histórico é removido após o número especificado de dias e na hora especificada na configuração.

Use as instruções fornecidas em Substituições de configuração para criar o arquivo de configuração. No arquivo de configuração, forneça os seguintes detalhes (propriedade) para definir um dia e hora para limpar o histórico e os logs de saída:

Alterar o limite da lista de saídas recém-geradas id1679JH0H0O2

É possível alterar o número máximo de saídas geradas exibidas na guia Saídas de um mapa DITA.

Use as instruções fornecidas em Substituições de configuração para criar o arquivo de configuração. No arquivo de configuração, forneça os seguintes detalhes (property) para alterar o número de saídas a serem exibidas na lista: