Conditions ou transclusions ?

Les transclusions, ou référencement de contenu, peuvent parfois atteindre les mêmes objectifs de publication que le traitement conditionnel. Chaque méthode possède ses avantages et ses inconvénients.

Vous pouvez rencontrer des scénarios de publication, créés à partir d'une source unique et dont le résultat souhaité peut être obtenu soit au moyen du traitement conditionnel, soit au moyen d'une transclusion (mécanisme de conref).

Par exemple, si le nom d'un produit varie entre deux appellations d'une publication à une autre, le traitement conditionnel complété par un attribut product permet d'exclure le nom de produit qui ne correspond pas (et de conserver le bon nom de produit). Le code apparaîtra comme suit : <ph product="Liberty">Liberté><ph product="Legend">Légende</ph>. Avec une règle ditaval excluant les éléments composés d'un attribut product="Liberty", le code final sera le suivant : <ph product="Legend">Légende</ph>.

Pour obtenir le même résultat, il est également possible d'utiliser la transclusion, par exemple dans une référence de contenu (conref). Avec cette méthode, le nom du produit n'est pas inclus directement dans le texte ; à la place, un élément conref est utilisé pour reconstruire la phrase à partir d'un fichier conref distinct. Le code apparaîtra comme suit : <ph conref="source_conref/nom_produit" />. Lorsqu'une publication doit contenir le nom de produit Légende, le fichier source conref peut être modifié de façon à ce que le code source conref soit : <ph id="nom_produit">Légende</ph>.

Grâce à la fonction keyref introduite par DITA 1.2, la seconde méthode de transclusion est beaucoup plus simple et soignée que la première méthode.

Chaque approche possède ses avantages et ses inconvénients.

Les principaux avantages de la méthode par traitement conditionnel sont les suivants :
  • Le rédacteur peut voir tous les changements.
  • Une version révisée du document peut être créée pour visualiser tous les changements.
Les principaux avantages de la méthode par transclusion sont les suivants :
  • Les rubriques sont plus lisibles pour le rédacteur.
  • La méthode ne repose pas sur des métadonnées.
  • Le document peut être modifié plus facilement si de nouveaux changements sont introduits (seul le fichier source conref doit être mis à jour).
  • Cette méthode convient mieux lorsque les conditions sont nombreuses.