API basadas en Java para trabajar con mapas DITA id175UB30E05Z

NOTE

Puede utilizar las API basadas en Java disponibles en Experience Manager Guides para crear complementos personalizados y ampliar los flujos de trabajo predeterminados. Este artículo se archivará en noviembre de 2024.
Consulta para obtener la documentación más reciente y detallada sobre el uso de la API basada en Java.

Las siguientes API basadas en Java le permiten trabajar con mapas DITA en AEM Guides. Estas API están disponibles en forma de paquete. Debe incluir este paquete en su código para utilizar estas API.

Detalles del paquete:

Descargar mapa DITA con dependientes

El método zipMapWithDependents crea un archivo .zip que contiene un mapa DITA junto con todos sus dependientes, como temas a los que se hace referencia, submapas, imágenes y DTD. El fichero .zip para el mapa DITA se crea en función de una línea base determinada.

También permite mantener la misma estructura (carpetas principales y secundarias) o crear una estructura de archivos plana dentro de una sola carpeta para todos los archivos dependientes.

Sintaxis:

public static void zipMapWithDependents(Session session,
                     String sourcePath,
                     String baseline,
                     OutputStream outputStream,
                     boolean flatFS)
                     throws RepositoryException, IOException

Parámetros:

Devuelve:
El contenido del ZIP se escribe en outputStream.

Excepción:
Lanza javax.jcr.RepositoryException, java.io.IOException.

Descargar mapa DITA con dependientes (asincrónicamente)

Como alternativa, se puede descargar un mapa DITA con dependientes en modo asíncrono. Este enfoque es más útil para mapas DITA más grandes.

El método zipMapWithDependents crea un archivo .zip que contiene un mapa DITA junto con todos sus dependientes, como temas a los que se hace referencia, submapas, imágenes y DTD. El fichero .zip para el mapa DITA se crea en función de una línea base determinada.

También permite mantener la misma estructura (carpetas principales y secundarias) o crear una estructura de archivos plana dentro de una sola carpeta para todos los archivos dependientes.

Sintaxis:

public static CompletableFuture<Node> zipMapWithDependencies(Session session,
                     String sourcePath,
                     String baseline,
                     boolean flatFS)

Parámetros:

Devuelve:
El nodo del archivo zip está dentro de la clase CompletableFuture. El usuario puede seguir manejándolo asincrónicamente y puede usar el .get()método del futuro para bloquear el subproceso cuando se necesite el nodo. El valor devuelto también puede terminar con un error, y eso se puede controlar con el método .exceptionally().

Obtener una lista de líneas de base

El método getBaselineList recupera una lista de todas las líneas de base que existen para un mapa DITA determinado.

Sintaxis:

public static List<HashMap<String,String>> getBaselineList(
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

Parámetros:

Devuelve:
Lista de HashMap objetos. Cada objeto HashMap representa una línea de base y contiene el nombre y el título de la línea de base.

Excepción:
Lanza javax.jcr.RepositoryException.

Obtener una lista de ajustes preestablecidos condicionales

El método getConditionalPresetList recupera una lista de todos los ajustes preestablecidos condicionales que existen para un mapa DITA determinado.

Sintaxis:

public static List<HashMap<String,String>> getConditionalPresetList (
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

Parámetros:

Devuelve:
Lista de HashMap objetos. Cada objeto HashMap representa un ajuste preestablecido condicional y contiene el nombre y el título del ajuste preestablecido condicional.

Excepción:
Lanza javax.jcr.RepositoryException.

Obtenga la información del archivo DITAVAL para un ajuste preestablecido condicional

El método getDitavalFromConditionalPreset recupera la ruta del fichero DITAVAL correspondiente a un ajuste preestablecido condicional para un mapa DITA determinado.

Sintaxis:

public static String getDitavalFromConditionalPreset
    (Session session,
    String sourcePath,
    String cpName) throws RepositoryException

Parámetros:

Devuelve:
Ruta del fichero DITAVAL correspondiente al ajuste preestablecido condicional definido en el fichero de mapa DITA.

Obtener todas las dependencias de un nodo

El método getAllDependencies devuelve todas las dependencias de un nodo determinado.

Sintaxis:

public static List
<Node> getAllDependencies
(Node rootNode) throws GuidesApiException

Parámetros:

Devuelve:
Lista de nodos que contiene todas las dependencias del nodo raíz.