Accueil > DITAVAL

DITAVAL

Familiarisez-vous avec les fichiers DITAVAL et apprenez à les utiliser pour générer une sortie conditionnelle dans FrameMaker.

Dans FrameMaker, un fichier DITAVAL permet de générer une sortie conditionnelle. Écrivez un document unique avec du contenu conditionnel (en utilisant des attributs d’élément).

Créez ensuite un fichier DITAVAL dans lequel vous spécifiez le contenu afin de créer plusieurs versions de sorties du document selon les attributs appliqués.

Configuration de rubriques DITA pour utiliser DITAVAL

Apprenez à configurer des rubriques DITA pour utiliser les fichiers DITAVAL et à appliquer des attributs conditionnels à des éléments.

Vous pouvez rendre des éléments d’un document DITA conditionnels en appliquant des attributs de condition aux éléments. Définissez ensuite dans un fichier DITAVAL les éléments à exclure ou inclure de la sortie en fonction des attributs de condition.

Avant de créer des documents avec un contenu conditionnel, vous devez d’abord prévoir les critères pour la sortie. Par exemple, supposons qu’un document possède un contenu destiné conditionnellement à des administrateurs et à des utilisateurs finaux. Dans le document, appliquez les attributs de condition selon le public cible du contenu (voir Application d’attributs de condition à des éléments). Ensuite, créez un fichier DITAVAL dans lequel vous spécifiez les éléments à inclure et à exclure selon la valeur d’attribut définie dans le document. Voir Création d’un fichier DITAVAL pour créer une sortie conditionnelle.

Application d’attributs de condition à des éléments

Pour autoriser FrameMaker à traiter conditionnellement des éléments dans un document DITA, vous devez spécifier les éléments à inclure ou exclure pour la sortie. Dans le document, appliquez un ou plusieurs des attributs conditionnels suivants aux éléments que vous devez traiter conditionnellement :

audience :

Exemple : administrateurs, auteurs ou utilisateurs finaux.

platform :

Exemple : Windows, Mac ou Linux

product :

Exemple : FrameMaker, RoboHelp ou Captivate.

otherprops :

Utilisez cet attribut pour définir toute autre propriété que vous devez utiliser pour activer un traitement conditionnel pour le document, par exemple :

sortie

Exemple : Impression, PDF ou Web

modèle

Exemple : coupé, berline ou break

Vous pouvez appliquer plusieurs attributs à un élément. Par exemple, vous pouvez appliquer les attributs @audience="administrateur" et @platform="windows" à un élément. Vous pouvez également ajouter plusieurs valeurs (chacune séparée par un espace) à un attribut unique. Par exemple, vous pouvez définir@platform="windows linux" pour le contenu ciblé pour Windows et Linux.

Important: Les attributs énumérés ci-dessus sont recommandés lors de l’utilisation de DITAVAL avec un contenu de source unique. Cependant, vous n’êtes pas uniquement limité à ces attributs. Vous pouvez utiliser tout attribut défini pour l’élément sélectionné dans un document.

Pour appliquer des attributs de condition à un élément

  1. Sélectionnez un élément dans la Vue de la structure du document.

  2. Ouvrez le panneau Attributs (Elément > Modifier les attributs).

    Mise à jour d’un ou plusieurs des attributs suivants :

    • audience

    • platform

    • product

    • otherprops

  3. Spécifiez la condition ci-dessus pour chaque élément du document qui doit être traité conditionnellement.

Après avoir appliqué les attributs aux éléments spécifiques du document, sortez conditionnellement le contenu dans votre document selon le mode de configuration de votre fichier DITAVAL.

Création d’un fichier DITAVAL pour créer une sortie conditionnelle

Après avoir configuré votre contenu à l’aide des attributs de condition (audience, platform, product et otherprops) pour définir les éléments que FrameMaker traite de manière conditionnelle pour la sortie, vous devez créer un fichier DITAVAL. Dans un fichier DITAVAL, définissez selon une paire <nom d’attribut> – <valeur> le traitement conditionnel de votre document. Par exemple, vous pouvez spécifier que le contenu destiné aux administrateurs doit être exclu du contenu de sortie destiné aux utilisateurs finaux ou aux auteurs.

Pour créer un fichier DITAVAL :

  1. Ouvrez la boîte de dialogue Nouveau XML (Fichier > Nouveau > XML).

  2. Dans la section Applications structurées, sélectionnez DITA_<version>_DITAVAL, puis cliquez sur OK.

    L’élément supérieur d’un fichier DITAVAL est l’élément <val>.

    Pour définir des conditions, vous devez créer des éléments <prop>.

  3. Ajoutez un ou plusieurs éléments <prop> :

    cliquez deux fois sur l’élément <propo> dans le panneau Elément (Affichage > Panneaux > Catalogue d’éléments).

    Ou appuyez sur Ctrl+1 pour afficher le Catalogue dynamique , sélectionnez prop puis appuyez sur Entrée.

    La boîte de dialogue Attributs du nouvel élément s’affiche.
    Boîte de dialogue Attributs du nouvel élément
    Boîte de dialogue Attributs du nouvel élément dans le panneau Catalogue d’éléments

  4. Dans la boîte de dialogue Attributs du nouvel élément, spécifiez les attributs suivants :

    @action

    Choisissez d’inclure ou d’exclure l’attribut spécifié (@att, ci-dessous) de la sortie.

    @att

    Le nom de l’attribut de condition a été appliqué à l’élément dans votre document.

    Entrez le nom d’attribut exactement tel qu’il est défini dans l’élément du document.

    @val

    La valeur de l’attribut de condition (@att) telle que définie dans l’élément.

    Entrez la valeur exactement comme vous la spécifiez pour l’attribut dans l’élément.

    Par exemple, imaginons que vous appliquiez l’attribut @audience à un élément pour une sortie conditionnelle et que vous définissiez la valeur sur admin. Vous devez saisir audience dans le champ @attr pour l’élément prop dans le fichier DITAVAL. En outre, vous devez entrer admin dans le champ @val. Pour exclure l’élément avec l’attribut audience défini sur admin@, spécifiez l’action sur exclude.

  5. Cliquez sur Insérer un élément, puis enregistrez le fichier DITAVAL.

  6. Enregistrez le document avec l’extension .ditaval.

Génération d’une sortie conditionnelle

Apprenez à générer une sortie conditionnelle pour des rubriques DITA dans FrameMaker.

Cette section décrit, avec un exemple de cas d’utilisation, les étapes permettant de générer une sortie PDF contenant un contenu conditionnel.

Remarque : L’exemple utilisé dans cette section inclut un contenu uniquement dans des balises de paragraphe (p). Vous pouvez cependant créer une sortie conditionnelle à partir de n’importe quel élément DITA d’un document.
  1. Créez une rubrique DITA avec quatre éléments de paragraphe (<p>) :

    1. Contenu destiné UNIQUEMENT à des administrateurs.

      @Définissez l’attribut audience à admin.

    2. Contenu destiné UNIQUEMENT aux auteurs.

      @Définissez l’attribut audience à author.

    3. Contenu pour les administrateurs et les auteurs

      Définissez l’attribut @audience sur admin author.

    4. Contenu destiné aux utilisateurs finaux et aux auteurs.

      @Définissez l’attribut audience à end_user author.

  2. Enregistrez le document.

  3. Créez un fichier DITAVAL avec quatre éléments prop :

    1. @attr: audience

      @val: admin

      @action: include

    2. @attr:audience

      @val:author

      @action: exclude

    3. @attr:audience

      @val:end_user

      @action: exclude

    Le fichier DITAVAL ci-dessus fournira une sortie reprenant tous les contenus destinés aux administrateurs.

  4. Créez un mappage DITA et incluez le document ci-dessus, puis enregistrez le mappage DITA en tant que PDF (Fichier > Enregistrer en tant que PDF).

  5. Dans la boîte de dialogue Enregistrer le document, sélectionnez l’option Demander le fichier DitaVal et cliquez sur Enregistrer.

    La boîte de dialogue Choisir le fichier DitaVal s’affiche.

  6. Sélectionnez le fichier DITAVAL créé à l’étape 4, puis cliquez sur Sélectionner.

    L’option Appliquer comme condition génère l’intégralité du contenu. Cependant, le contenu marqué comme exclu dans le fichier DITAVAL sort barré. Sélectionnez cette option pour la révision du document. Par exemple, cette option permet d’indiquer à un réviseur le contenu étant marqué comme exclu.

  7. Dans la boîte de dialogue Configuration PDF, cliquez sur Définir.

Le fichier PDF de sortie inclut et exclut un contenu selon les attributs configurés dans le document et le fichier DITAVAL correspondant.