Introdução ao Editor universal no AEM getting-started
Saiba como obter acesso ao Editor universal e começar a instrumentar seu primeiro aplicativo do AEM para utilizá-lo.
Embora o Editor universal possa editar o conteúdo de qualquer fonte, este documento usará um aplicativo AEM como exemplo. Este documento o orientará por essas etapas.
Instrumentar a página instrument-page
O Editor universal exige uma biblioteca JavaScript para renderizar e editar a página no editor.
Além disso, o serviço do Editor Universal requer um nome de recurso uniforme (URN) para identificar e utilizar o sistema de back-end correto para o conteúdo no aplicativo que está sendo editado. Portanto, um esquema URN é necessário para mapear o conteúdo de volta para os recursos de conteúdo.
Incluir a biblioteca CORS do editor universal cors-library
Para que o Editor universal se conecte ao seu aplicativo, ele deve incluir a biblioteca CORS do Editor universal. Adicione o script a seguir ao aplicativo.
<script src="https://universal-editor-service.adobe.io/cors.js" async></script>
Criação de conexões connections
As conexões usadas no aplicativo são armazenadas como tags de <meta>
no <head>
da página.
<meta name="urn:adobe:aue:<category>:<referenceName>" content="<protocol>:<url>">
-
<category>
- Esta é uma classificação da conexão com duas opções.system
- Para pontos de extremidade de conexãoconfig
- Para definindo configurações opcionais
-
<referenceName>
: este é um nome curto que é reutilizado no documento para identificar a conexão. Por exemplo:aemconnection
-
<protocol>
: isso indica qual plug-in do serviço de persistência do Editor universal deve ser utilizado. Por exemplo:aem
-
<url>
: esta é a URL do sistema no qual as alterações devem ser mantidas. Por exemplo:http://localhost:4502
O identificador urn:adobe:aue:system
representa a conexão do Editor universal da Adobe.
data-aue-resource
s usarão o prefixo urn
para encurtar o identificador.
data-aue-resource="urn:<referenceName>:<resource>"
<referenceName>
: esta é a referência de nome mencionada na tag<meta>
. Por exemplo:aemconnection
<resource>
: este é um indicador do recurso no sistema de destino. Por exemplo: um caminho de conteúdo do AEM, como/content/page/jcr:content
Exemplo de conexão example
<meta name="urn:adobe:aue:system:<referenceName>" content="<protocol>:<url>">
<html>
<head>
<meta name="urn:adobe:aue:system:aemconnection" content="aem:https://localhost:4502">
<meta name="urn:adobe:aue:system:fcsconnection" content="fcs:https://example.franklin.adobe.com/345fcdd">
</head>
<body>
<aside>
<ul data-aue-resource="urn:aemconnection:/content/example/list" data-aue-type="container">
<li data-aue-resource="urn:aemconnection:/content/example/listitem" data-aue-type="component">
<p data-aue-prop="name" data-aue-type="text">Jane Doe</p>
<p data-aue-prop="title" data-aue-type="text">Journalist</p>
<img data-aue-prop="avatar" src="https://www.adobe.com/content/dam/cc/icons/Adobe_Corporate_Horizontal_Red_HEX.svg" data-aue-type="image" alt="avatar"/>
</li>
...
<li data-aue-resource="urn:fcsconnection:/documents/mytext" data-aue-type="component">
<p data-aue-prop="name" data-aue-type="text">John Smith</p>
<p data-aue-resource="urn:aemconnection:/content/example/another-source" data-aue-prop="title" data-aue-type="text">Photographer</p>
<img data-aue-prop="avatar" src="https://www.adobe.com/content/dam/cc/icons/Adobe_Corporate_Horizontal_Red_HEX.svg" data-aue-type="image" alt="avatar"/>
</li>
</ul>
</aside>
</body>
</html>
Definições de configuração configuration-settings
Você pode usar o prefixo config
no URN da conexão para definir pontos de extremidade de serviço e extensão, se necessário.
Se você não quiser usar o Universal Editor Service, que é hospedado pela Adobe, mas sua própria versão hospedada, poderá defini-lo em uma meta tag. Para substituir o ponto de extremidade de serviço padrão fornecido pelo Editor Universal, defina seu próprio ponto de extremidade de serviço:
- Meta name -
urn:adobe:aue:config:service
- Conteúdo meta -
content="https://adobe.com"
(exemplo)
<meta name="urn:adobe:aue:config:service" content="<url>">
Se você quiser que apenas determinadas extensões sejam ativadas para uma página, poderá definir isso em uma meta tag. Para buscar extensões, defina os pontos de extremidade da extensão:
- Nome meta:
urn:adobe:aue:config:extensions
- Conteúdo meta:
content="https://adobe.com,https://anotherone.com,https://onemore.com"
(exemplo)
<meta name="urn:adobe:aue:config:extensions" content="<url>,<url>,<url>">
Defina para quais caminhos de conteúdo ou sling:resourceType
s o Editor Universal deve ser aberto. (Opcional) content-paths
Se você tiver um projeto existente do AEM usando o editor de páginas, quando os autores de conteúdo editarem as páginas, as páginas serão abertas automaticamente com o editor de páginas. Você pode definir qual editor do AEM deve abrir com base nos caminhos de conteúdo ou no sling:resourceType
, tornando a experiência perfeita para seus autores, independentemente de qual editor é necessário para o conteúdo selecionado.
-
Para aproveitar esse recurso de configuração, entre em contato com o Atendimento ao cliente da Adobe para ativar o acesso ao Serviço de URL do editor universal para seu programa.
-
Depois que o Atendimento ao cliente ativar o acesso ao serviço de URL do Universal Editor, abra o Gerenciador de configurações.
http://<host>:<port>/system/console/configMgr
-
Localize o Serviço de URL do Editor Universal na lista e clique em Editar os valores de configuração.
-
Defina para quais caminhos de conteúdo ou
sling:resourceType
s o Editor Universal deve ser aberto.- No campo Mapeamento de Abertura do Editor Universal, forneça os caminhos para os quais o Editor Universal está aberto.
- No Sling:resourceTypes, que deve ser aberto pelo Editor Universal, forneça uma lista de recursos que são abertos diretamente pelo Editor Universal.
-
Clique em Salvar.
-
Verifique sua configuração do externalizador e certifique-se de que, no mínimo, você tenha os ambientes local, de autor e de publicação definidos como no exemplo a seguir.
code language-text "local $[env:AEM_EXTERNALIZER_LOCAL;default=http://localhost:4502]", "author $[env:AEM_EXTERNALIZER_AUTHOR;default=http://localhost:4502]", "publish $[env:AEM_EXTERNALIZER_PUBLISH;default=http://localhost:4503]"
Quando essas etapas de configuração forem concluídas, o AEM abrirá o Editor universal para páginas na seguinte ordem.
- O AEM verificará os mapeamentos em
Universal Editor Opening Mapping
e se o conteúdo estiver em qualquer caminho definido nele, o Editor Universal será aberto para ele. - Para conteúdo não nos caminhos definidos em
Universal Editor Opening Mapping
, o AEM verifica se oresourceType
do conteúdo corresponde aos definidos em Sling:resourceTypes, que devem ser abertos pelo Editor Universal, e se o conteúdo corresponder a um desses tipos, o Editor Universal será aberto para ele em${author}${path}.html
. - Caso contrário, o AEM abrirá o Editor de páginas.
As variáveis a seguir estão disponíveis para definir seus mapeamentos no campo Editor Universal Abrindo Mapeamento.
path
: Caminho de conteúdo do recurso a ser abertolocalhost
: Entrada do externalizador paralocalhost
sem esquema, ex.:localhost:4502
author
: Entrada externalizadora para autor sem esquema, ex.:localhost:4502
publish
: Entrada do externalizador para publicação sem esquema, ex.:localhost:4503
preview
: Entrada do externalizador para visualização sem esquema, ex.:localhost:4504
env
:prod
,stage
,dev
com base nos modos de execução do Sling definidostoken
: Token de consulta necessário paraQueryTokenAuthenticationHandler
Mapeamentos de Exemplo example-mappings
-
Abrir todas as páginas em
/content/foo
no Autor do AEM:/content/foo:${author}${path}.html?login-token=${token}
- Isto resulta na abertura de
https://localhost:4502/content/foo/x.html?login-token=<token>
-
Abra todas as páginas em
/content/bar
em um servidor NextJS remoto, fornecendo todas as variáveis como informações:/content/bar:nextjs.server${path}?env=${env}&author=https://${author}&publish=https://${publish}&login-token=${token}
- Isto resulta na abertura de
https://nextjs.server/content/bar/x?env=prod&author=https://localhost:4502&publish=https://localhost:4503&login-token=<token>
Você está pronto para usar o Editor universal youre-ready
Seu aplicativo agora está pronto para utilizar o Editor universal.
Consulte Criação de conteúdo com o Editor universal para ver como é fácil e intuitivo criar conteúdo utilizando o Editor universal.
Recursos adicionais additional-resources
Para saber mais sobre o Editor universal, consulte estes documentos.
- Introdução ao Editor universal: saiba como o Editor universal permite editar qualquer aspecto do conteúdo das implementações, a fim de entregar experiências excepcionais, aumentar a velocidade do conteúdo e fornecer uma experiência de desenvolvimento de última geração.
- Criação de conteúdo com o Editor universal: saiba como é fácil e intuitivo para os autores criarem conteúdo usando o Editor universal.
- Publicando Conteúdo com o Editor Universal - Saiba como o Editor Universal publica conteúdo e como seus aplicativos podem lidar com o conteúdo publicado.
- Arquitetura do Editor universal: saiba mais sobre a arquitetura do Editor universal e como os dados fluem entre seus serviços e camadas.
- Atributos e tipos: saiba mais sobre os atributos e tipos de dados exigidos pelo Editor universal.
- Autenticação do Editor universal: saiba como funciona a autenticação do Editor universal.