APIs baseadas em Java para trabalhar com rótulos e linhas de base id175UB30E05Z
As seguintes APIs baseadas em Java permitem criar uma linha de base e adicionar rótulos aos arquivos em uma linha de base. Essas APIs estão disponíveis no formato de um pacote. Você deve incluir esse pacote no código para usar essas APIs.
Detalhes do pacote:
-
ID do grupo: com.adobe.fmdita
-
ID do artefato: api
-
Versão: 3.5
-
Pacote: com.adobe.fmdita.api.baselines
-
Detalhes da classe:
code language-java public class BaselineUtils extends ObjectA classe BaselineUtils contém métodos para criar linhas de base e aplicar rótulos a arquivos em uma linha de base.
Criar uma linha de base
O método de criação de linha de base tem duas versões: uma para a solução do XML Documentation versão 3.5 e outra para versões anteriores à versão 3.5 (que inclui as versões 3.4, 3.3 e 3.2). A API versão 3.5 permite a criação de uma linha de base usando um rótulo, referências diretas e referências indiretas em um arquivo de mapa.
A outra versão da API usa data e hora para criar uma linha de base. Essa API é mantida para compatibilidade com versões anteriores com sistemas que usam a solução da XML Documentation 3.4, 3.3 ou 3.2.
Sintaxe (para a versão 3.5):
public static String createBaseline(Session session,
String sourcePath,
String baselineTitle,
String label,
LinkedHashMap directContext,
LinkedHashMap indirectContext)
throws GuidesApiException
Parâmetros:
sessionsourcePathbaselineTitlelabeldirectContextSe, após a iteração em todas as chaves do mapa, nenhuma versão for encontrada, o processo de criação da linha de base falhará.
Se HashMap estiver vazio (enviar mapa vazio e não nulo para o padrão), então, por padrão, será preenchido como:
directContext.put("label", label);directContext.put("latest", true);Se você quiser que a criação da linha de base só escolha a versão de um determinado rótulo e falhar se essa versão não existir, coloque a chave
label e o rótulo no qual você deseja criar a linha de base.indirectContextSe, após a iteração em todas as chaves do mapa, nenhuma versão for encontrada, o processo de criação da linha de base falhará.
Se o HashMap estiver vazio (enviar mapa vazio e não nulo para o padrão), então, por padrão, ele será preenchido como:
indirectContext.put("label", label);indirectContext.put "pickAutomatically", null);Se você quiser que seja a versão mais recente em vez de selecionar uma versão automaticamente, substitua:
indirectContext.put("pickAutomatically", null);com:
indirectContext.put("latest", true)Devoluções:
O nome da linha de base, que é o nome do nó da linha de base no repositório JCR. O título da linha de base recém-criada será mostrado ao usuário na página Linha de base do mapa DITA.
Exceção:
Lança ItemExistExceptiom se uma linha de base com o mesmo título já existir.
Sintaxe (para as versões 3.4, 3.3 e 3.2)
public static String createBaseline
(Session session,
String sourcePath,
String baselineTitle,
Date versionDate) throws GuidesApiException
Parâmetros:
sessionsourcePathbaselineTitleversionDated-MM-yyyy H:mm.Devoluções:
O nome da linha de base, que é o nome do nó da linha de base no repositório JCR. O título da linha de base recém-criada será mostrado ao usuário na página Linha de base do mapa DITA.
Exceção:
Lança RepositoryException.
Aplicar rótulos
O método applyLabel aplica um ou vários rótulos aos arquivos em uma linha de base.
Sintaxe:
public static void applyLabel(Session session,
String sourcePath,
String baselineName,
String label)
throws RepositoryException, WorkflowException, Exception
Parâmetros:
sessionsourcePathbaselineNameObservação: o rótulo é aplicado à versão dos arquivos referenciados diretamente do arquivo de mapa na linha de base.
labelCaso deseje definir vários rótulos, separe-os com uma vírgula; por exemplo, Rótulo1, Rótulo2.
Exceção:
Lança RepositoryException.
Excluir rótulos
O método deleteLabel exclui um ou vários rótulos dos arquivos em uma linha de base.
Sintaxe:
public static Map
<String, String> deleteLabel(Session session,
String sourcePath,
String baselineName,
String label) throws GuidesApiException
Parâmetros:
sessionsourcePathbaselineNameObservação: o rótulo foi excluído da versão dos arquivos que são referenciados diretamente do arquivo de mapa na linha de base.
labelCaso queira excluir vários rótulos, separe os rótulos com uma vírgula; por exemplo Rótulo1, Rótulo2.
Devoluções:
O mapa com o par key:value de path:deletedlabels para todos os arquivos na linha de base.
Exceção:
Lança RepositoryException`, `VersionException`, `Exception.