REST APIs para fluxo de trabalho de conversão
Última atualização: 12 de setembro de 2024
Criado para:
- Experiente
- Desenvolvedor
As APIs REST a seguir permitem converter documentos do Word, HTML e InDesign para o formato DITA.
Converter documentos do Word
Um método GET que converte documentos do Word no formato DITA.
Solicitar URL:
http://<aem-guides-server>: <port-number>/bin/fmdita/conversion
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
operation | String | Sim | Nome da operação que está sendo chamada. O valor deste parâmetro é word2dita .Observação: o valor não diferencia maiúsculas de minúsculas. |
inputFile | String | Sim | Caminho absoluto dos arquivos de origem do Word no repositório AEM. |
destPath | String | Sim | Caminho absoluto do local de destino onde os arquivos DITA convertidos serão salvos. |
createRev | Booleano | Sim | Especifique se uma revisão dos arquivos foi criada ( true ) no destino especificado ou não ( false ). Isso é considerado somente quando o local de destino contém uma versão existente dos arquivos convertidos. |
style2tagMap | String | Sim | Caminho absoluto do arquivo de mapeamento de estilo que será usado para conversão. |
Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).
Converter documentos do HTML
Um método GET que converte documentos HTML no formato DITA.
Solicitar URL:
http://<aem-guides-server>: <port-number>/bin/fmdita/conversion
Parâmetros:
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
operation | String | Sim | Nome da operação que está sendo chamada. O valor deste parâmetro é html2dita .Observação: o valor não diferencia maiúsculas de minúsculas. |
inputFile | String | Sim | Caminho absoluto dos arquivos HTML de origem no repositório AEM. |
destPath | String | Sim | Caminho absoluto do local de destino onde os arquivos DITA convertidos serão salvos. |
createRev | Booleano | Sim | Especifique se uma revisão dos arquivos foi criada ( true ) no destino especificado ou não ( false ). Isso é considerado somente quando o local de destino contém uma versão existente dos arquivos convertidos. |
Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).
Converter documentos do InDesign
Um método GET que converte documentos do InDesign no formato DITA.
Solicitar URL:
http://<aem-guides-server>: <port-number>/bin/fmdita/conversion
Parâmetros:
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
operation | String | Sim | Nome da operação que está sendo chamada. O valor deste parâmetro é idml2dita .Observação: o valor não diferencia maiúsculas de minúsculas. |
inputFile | String | Sim | Caminho absoluto dos arquivos do InDesign de origem no repositório AEM. |
destPath | String | Sim | Caminho absoluto do local de destino onde os arquivos DITA convertidos serão salvos. |
createRev | Booleano | Sim | Especifique se uma revisão dos arquivos foi criada ( true ) no destino especificado ou não ( false ). Isso é considerado somente quando o local de destino contém uma versão existente dos arquivos convertidos. |
Valores de resposta:
Retorna uma resposta HTTP 200 (Successful).
Página anteriorAPI REST para trabalhar com atributos condicionais
Próxima páginaAPI REST para criar e ativar pacotes
Experience Manager
- Visão geral do AEM Guides
- Aviso
- Informações da versão
- Roteiro de versões do AEM Guides
- Notas de versão
- Cloud Services
- Instruções de implantação
- Versões de 2025
- Versões de 2024
- Versões de 2023
- Versões de 2022
- No local/Managed Services
- Cloud Services
- Guia do Usuário (Nova Interface do Usuário)
- Introdução
- Página inicial
- Conteúdo do autor
- Visão geral de criação
- Maneiras de criar conteúdo usando o AEM Guides
- Editor
- Introdução ao editor
- Iniciar o editor
- Editar tópicos no Editor
- Criação e visualização do tópico
- Conhecer os recursos do Editor
- Recursos adicionais no editor
- Atalhos de teclado no Editor
- Visualizações do editor
- Suporte para arquivos do Schematron
- Criação de documentos do Markdown a partir do editor
- Adicionar citações ao seu conteúdo
- Usar dados de suas fontes de dados
- Estado do documento
- Usar rótulos
- Editor de mapa
- Editor DITAVAL
- Ferramentas de área de trabalho para criação de conteúdo
- Revisar conteúdo
- Colaborar usando o Adobe Workfront
- Metadados e marcação
- Gerenciamento e publicação de mapas
- Visão geral do console de mapa
- Abrir arquivos no console de Mapa
- Relatórios
- Tradução de conteúdo
- Geração de saída
- Noções básicas de geração de saída
- Predefinições de saída no AEM Guides
- Editar, duplicar ou excluir uma predefinição de saída
- Condicionalizar conteúdo
- Usar Linha de Base
- Gerenciar predefinições de saída de perfil global e de pasta
- Use variáveis para definir as opções Caminho de destino, Nome do site ou Nome do arquivo
- Transmita os metadados para a saída usando DITA-OT
- Gerar saída
- Usar coleção de mapas para geração de saída
- Gerenciar processo de geração de saída
- Gerenciar tarefas de publicação usando o Painel de publicação
- Solução básica de problemas
- Ativação em massa do conteúdo
- Geração de saída de documentos do FrameMaker
- Assistente de IA no AEM Guides
- Apêndice
- Guia do Usuário (Interface Antiga)
- Instalação e configuração
- No local
- Noções básicas no local
- Baixar, instalar e atualizar
- Trabalhar com grupos de usuários e segurança
- Migração de conteúdo
- Trabalhar com DITA-OT personalizado e especialização
- Configurar pós-processamento para uma pasta
- Configurar nomes de arquivo
- Configurar nomes de arquivo automáticos com base no UUID
- Configurar Regx para caracteres válidos de nome de arquivo
- Configure nomes de arquivo válidos para a saída do site do AEM
- Trabalhar com tópico e modelos de mapa
- Trabalhar com estados de documento
- Trabalhar com as configurações do Editor da Web
- Personalizar editor da Web
- Personalizar barra de ferramentas
- Configurar valor padrão para a exibição de tags
- Configurar o título para os ícones Fazer check-in e Check-out
- Configurar a exibição de links baseados em UUID
- Abrir tópico DITA ou mapear arquivos na mesma guia
- Configurar um painel personalizado no painel esquerdo
- Configurar o salvamento automático de arquivos no Editor da Web
- Configurar filtros para a caixa de diálogo de procura de arquivos
- Configurar o prompt para salvar como uma nova versão ao fechar
- Configurar prompt para fazer check-in de um arquivo ao fechar
- Configurar caracteres especiais permitidos
- Gerar IDs de elemento automaticamente
- Personalizar o dicionário padrão do AEM
- Configurar filtros de texto
- Configurar o número de LimitReads para uma consulta
- Instalar pacotes para publicação baseada em artigo
- Configurar um conector de fonte de dados na interface do usuário
- Definir o Editor de mapa avançado como padrão
- Incluir atributo @navtitle por padrão
- Configurar a opção para editar no Oxygen
- Configurar caracteres especiais adicionais
- Trabalhar com perfis globais e de nível de pasta
- Configurar versões
- Trabalhar com editores de XML baseados em área de trabalho
- Trabalhar com configurações de geração de saída
- Definir configurações de geração de saída
- Baixe e instale modelos do aem sites
- Sobrepor tags do HTML na saída do AEM Sites
- Publicação PDF Nativa
- Modelo do PDF
- Componentes de um modelo do PDF
- Criar um layout de página
- Variáveis na saída do PDF
- Suporte para variáveis de idioma
- Adicionar um código de barras à saída do PDF
- Estilos de conteúdo comuns
- Trabalhar com os estilos de conteúdo comuns
- Trabalhar com estilos de barras de alteração personalizados
- Aplicar estilo personalizado em entradas de índice e conteúdo de tópico
- Adicionar um marcador personalizado na saída do PDF
- Usar o JavaScript para trabalhar com conteúdo ou estilo
- Aplicar estilos a notas de rodapé
- Configurar sinalizadores JVM para publicação nativa no PDF
- Configurar e personalizar workflows
- Trabalhar com configurações de tradução
- Trabalhar com pesquisa no AEM Assets
- Apêndice
- Cloud Services
- Sobre este guia
- Implantar e configurar o AEM Guides as Cloud Service
- Trabalhar com grupos de usuários e segurança
- Migração de conteúdo
- Trabalhar com DITA-OT personalizado e especialização
- Configurar UUID e nomes de arquivo não baseados em UUID
- Trabalhar com tópico e modelos de mapa
- Trabalhar com estados de documento
- Trabalhar com as configurações do Editor da Web
- Personalizar editor da Web
- Personalizar barra de ferramentas
- Configurar as sugestões inteligentes habilitadas por IA para criação
- Configure a Ajuda inteligente habilitada para IA para pesquisar conteúdo
- Configurar valor padrão para a exibição de tags
- Configurar a exibição de links baseados em UUID
- Configurar exibição de tabelas coladas
- Abrir tópico DITA ou mapear arquivos na mesma guia
- Configurar um painel personalizado no painel esquerdo
- Configurar o salvamento automático de arquivos no Editor da Web
- Configurar o prompt para salvar como uma nova versão ao fechar
- Configurar prompt para fazer check-in de um arquivo ao fechar
- Configurar caracteres especiais permitidos
- Gerar IDs de elemento automaticamente
- Personalizar o dicionário padrão do AEM
- Configurar filtros de texto
- Configurar filtros para a caixa de diálogo de procura de arquivos
- Instalar pacotes para publicação baseada em artigo
- Configurar a geração de PDF de um único tópico
- Configurar o recurso de tradução no editor da Web
- Configurar um conector de fonte de dados
- Configurar um conector de fonte de dados na interface do usuário
- Definir o Editor de mapa avançado como padrão
- Incluir atributo @navtitle por padrão
- Trabalhar com perfis globais e de nível de pasta
- Configurar versões
- Trabalhar com editores de XML baseados em área de trabalho
- Configurar o Workfront
- Trabalhar com configurações de geração de saída
- Trabalhar com fluxos de trabalho personalizados
- Trabalhar com configurações de tradução
- Trabalhar com pesquisa no AEM Assets
- Apêndice
- No local
- Referência da API
- Introdução
- REST APIs para gerenciamento de saída
- API REST para trabalhar com mapas DITA
- API REST para registrar um conector de fonte de dados
- API REST para trabalhar com atributos condicionais
- REST APIs para fluxo de trabalho de conversão
- API REST para criar e ativar pacotes
- API baseada em Java para trabalhar com a geração de saída
- APIs baseadas em Java para trabalhar com mapas DITA
- APIs baseadas em Java para fluxo de trabalho de conversão
- APIs baseadas em Java para trabalhar com rótulos e linhas de base
- API baseada em Java para trabalhar com perfis de pastas
- API baseada em Java para criar e ativar pacotes
- Manipulador de eventos de pós-processamento
- Manipulador de eventos de ativação em massa concluída
- Manipulador de eventos do processo de conversão
- Base de Dados de Conhecimento
- Sessão com especialista
- Visão geral da sessão com especialistas
- Traduzir conteúdo
- Gerenciar conteúdo usando linhas de base
- Criação de conteúdo baseado na Web
- Fundamentos de publicação nativos do PDF
- Relatórios no AEM Guides
- Configuração de conteúdo e modelo
- Aprendendo a publicar no PDF nativo - parte 1
- Aprendizado sobre publicação nativa do PDF - Práticas no laboratório - BYOS
- Estrutura de extensão do AEM Guides
- Integração com fonte de dados externa
- Traduzir conteúdo nas Guias - parte 2
- Definir, gerenciar e utilizar metadados
- Variações de saída do AEM Sites
- Opções de implantação e migração para a nuvem
- Migrar conteúdo de não-uuid para UUID
- Migração de conteúdo delta
- Artigos
- Criação
- Estrutura de extensão de guias
- Fonte de dados externa
- Publicação
- Fluxos de trabalho
- Tradução
- Casos de uso
- Sessão com especialista