API basadas en Java para trabajar con líneas de base y etiquetas id175UB30E05Z
Consulta
Las siguientes API basadas en Java le permiten crear líneas de base y agregar etiquetas a los archivos en una línea de base. Estas API están disponibles en forma de paquete. Debe incluir este paquete en su código para utilizar estas API.
Detalles del paquete:
-
Id. de grupo: com.adobe.fmdita
-
ID de artefacto: api
-
Versión: 3.5
-
Paquete: com.adobe.fmdita.api.baselines
-
Detalles de la clase:
code language-java public class BaselineUtils extends ObjectLa clase BaselineUtils contiene métodos para crear líneas de base y aplicar etiquetas a los archivos de una línea de base.
Crear una línea base
El método crear línea de base tiene dos versiones: una para la solución de XML Documentation versión 3.5 y otra para las versiones anteriores a la versión 3.5 (que incluye las versiones 3.4, 3.3 y 3.2). La API versión 3.5 permite crear líneas de base mediante una etiqueta, referencias directas y referencias indirectas en un archivo de mapa.
La otra versión de API utiliza la fecha y la hora para crear una línea de base. Esta API se conserva para garantizar la compatibilidad con versiones anteriores de los sistemas que utilizan las soluciones de XML Documentation 3.4, 3.3 o 3.2.
Sintaxis (para la versión 3.5):
public static String createBaseline(Session session,
String sourcePath,
String baselineTitle,
String label,
LinkedHashMap directContext,
LinkedHashMap indirectContext)
throws GuidesApiException
Parámetros:
sessionsourcePathbaselineTitlelabeldirectContextSi después de la iteración en todas las claves del mapa no se encuentra ninguna versión, el proceso de creación de la línea base falla.
Si el HashMap está vacío (enviar mapa vacío y no nulo de forma predeterminada), de forma predeterminada se rellena como:
directContext.put("label", label);directContext.put("latest", true);Si desea que la creación de la línea de base seleccione solamente la versión de una etiqueta determinada y falla si no existe dicha versión, coloque la clave
label y la etiqueta en la que desea crear la línea de base.indirectContextSi después de la iteración en todas las claves del mapa no se encuentra ninguna versión, el proceso de creación de la línea base falla.
Si HashMap está vacío (enviar mapa vacío y no nulo de forma predeterminada), de forma predeterminada, se rellena como:
indirectContext.put("label", label);indirectContext.put "pickAutomatically", null);Si desea que sea la última versión en lugar de recoger una versión automáticamente, reemplace:
indirectContext.put("pickAutomatically", null);con:
indirectContext.put("latest", true)Devuelve:
El nombre de la línea base, que es el nombre de nodo de la línea base en el repositorio JCR. El título de la línea base recién creada se mostrará al usuario en la página Línea base del mapa DITA.
Excepción:
Inicia ItemExistExceptiom si ya existe una línea de base con el mismo título.
Sintaxis (para las versiones 3.4, 3.3 y 3.2)
public static String createBaseline
(Session session,
String sourcePath,
String baselineTitle,
Date versionDate) throws GuidesApiException
Parámetros:
sessionsourcePathbaselineTitleversionDated-MM-yyyy H:mm.Devuelve:
El nombre de la línea base, que es el nombre de nodo de la línea base en el repositorio JCR. El título de la línea base recién creada se mostrará al usuario en la página Línea base del mapa DITA.
Excepción:
Lanzamientos RepositoryException.
Aplicar etiquetas
El método applyLabel aplica una o varias etiquetas a los archivos de una línea de base.
Sintaxis:
public static void applyLabel(Session session,
String sourcePath,
String baselineName,
String label)
throws RepositoryException, WorkflowException, Exception
Parámetros:
sessionsourcePathbaselineNameNota: La etiqueta se aplica a la versión de los archivos a los que se hace referencia directamente desde el archivo de asignación en la línea de base.
labelSi desea establecer varias etiquetas, sepárelas con una coma; por ejemplo, Label1, Label2.
Excepción:
Lanza RepositoryException.
Eliminar etiquetas
El método deleteLabel elimina una o varias etiquetas de los archivos de una línea de base.
Sintaxis:
public static Map
<String, String> deleteLabel(Session session,
String sourcePath,
String baselineName,
String label) throws GuidesApiException
Parámetros:
sessionsourcePathbaselineNameNota: Se ha eliminado la etiqueta de la versión de los archivos a los que se hace referencia directamente desde el archivo de asignación en la línea de base.
labelSi desea eliminar varias etiquetas, sepárelas con una coma; por ejemplo, Etiqueta1, Etiqueta2.
Devuelve:
Asignación con par key:value de path:deletedlabels para todos los archivos de la línea de base.
Excepción:
Lanza RepositoryException`, `VersionException`, `Exception.