API Java pour travailler avec des mappages DITA id175UB30E05Z

NOTE

Vous pouvez utiliser des API Java disponibles dans Experience Manager Guides pour créer des modules externes personnalisés et étendre les processus prêts à l’emploi. Cet article sera archivé en novembre 2024.
Affichez pour obtenir la documentation la plus récente et détaillée sur l’utilisation de l’API Java.

Les API Java suivantes vous permettent d’utiliser des mappages DITA dans AEM Guides. Ces API sont disponibles sous la forme d’un lot. Vous devez inclure ce lot dans votre code pour utiliser ces API.

Détails du lot :

Téléchargement du mappage DITA avec des dépendances

La méthode zipMapWithDependents crée un fichier .zip contenant un mappage DITA avec toutes ses dépendances telles que les rubriques référencées, les sous-cartes, les images et les DTD. Le fichier .zip pour le mappage DITA est créé en fonction d’une ligne de base donnée.

Il vous permet également de conserver la même structure (dossiers parents et enfants) ou de créer une structure de fichiers plate dans un seul dossier pour tous les fichiers dépendants.

Syntaxe:

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

Paramètres :

Renvoie :
Le contenu du fichier ZIP est écrit sur le outputStream.

Exception :
Lance javax.jcr.RepositoryException, java.io.IOException.

Télécharger le mappage DITA avec les dépendances (Asynchrone)

Vous pouvez également télécharger le mappage DITA avec les dépendances en mode asynchrone. Cette approche est plus utile pour les mappages DITA plus volumineux.

La méthode zipMapWithDependents crée un fichier .zip contenant un mappage DITA avec toutes ses dépendances telles que les rubriques référencées, les sous-cartes, les images et les DTD. Le fichier .zip pour le mappage DITA est créé en fonction d’une ligne de base donnée.

Il vous permet également de conserver la même structure (dossiers parents et enfants) ou de créer une structure de fichiers plate dans un seul dossier pour tous les fichiers dépendants.

Syntaxe:

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

Paramètres :

Renvoie :
Le noeud du fichier zip est encapsulé dans la classe CompletableFuture. L’utilisateur peut continuer à le gérer de manière asynchrone et utiliser la méthode .get()future pour bloquer le thread lorsque le noeud est nécessaire. La valeur renvoyée peut également se terminer par une erreur et elle peut être traitée avec la méthode .exceptionally().

Obtention d’une liste des lignes de base

La méthode getBaselineList récupère une liste de toutes les lignes de base qui existent pour un mappage DITA donné.

Syntaxe:

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

Paramètres :

Renvoie :
Liste d’objets HashMap. Chaque objet HashMap représente une ligne de base et contient le nom et le titre de la ligne de base.

Exception :
Lance javax.jcr.RepositoryException.

Obtenir la liste des paramètres prédéfinis conditionnels

La méthode getConditionalPresetList récupère une liste de tous les paramètres prédéfinis conditionnels qui existent pour un mappage DITA donné.

Syntaxe:

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

Paramètres :

Renvoie :
Liste d’objets HashMap. Chaque objet HashMap représente un paramètre prédéfini conditionnel et contient le nom et le titre du paramètre prédéfini conditionnel.

Exception :
Lance javax.jcr.RepositoryException.

Obtention des informations du fichier DITAVAL pour un paramètre prédéfini conditionnel

La méthode getDitavalFromConditionalPreset récupère le chemin d’accès du fichier DITAVAL correspondant à un paramètre prédéfini conditionnel pour un mappage DITA donné.

Syntaxe:

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

Paramètres :

Renvoie :
Chemin d’accès du fichier DITAVAL correspondant au paramètre prédéfini conditionnel défini dans le fichier de mappage DITA.

Obtention de toutes les dépendances d’un noeud

La méthode getAllDependencies renvoie toutes les dépendances d’un noeud donné.

Syntaxe:

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

Paramètres :

Renvoie :
Liste de noeuds contenant toutes les dépendances du noeud racine.