Cas concrets d’utilisation de DITA XML
Solutions et astuces DITA XML développées au quotidien sur des projets multilingues : réutilisation de topics, texte conditionnel, traduction et publication multicanal.
L’utilisation quotidienne du format de Rédaction structuréeRédiger un contenu dont le balisage encode le sens (ceci est un avertissement, ceci est une étape) plutôt que la seule apparence visuelle — permettant un traitement automatisé, une réutilisation et des contrôles de cohérence que les formats non structurés ne permettent pas.Voir dans le glossaire → DITA XMLUne architecture de rédaction structurée et modulaire, construite autour de la typologie concept/tâche/référence et de la réutilisation de contenu via conrefs et ditamaps.Voir dans le glossaire → sur des projets multilingues en tant que rédacteur technique m’a amené à développer certaines solutions et astuces que je vous livre ici. Tout retour d’expérience est le bienvenu !
La documentation de NuFirewall
Section intitulée « La documentation de NuFirewall »Pour un exemple détaillé en situation réelle, voir le cas concret : documentation de NuFirewall, qui présente la réutilisation par ConrefUn mécanisme DITA XML de réutilisation d'un bloc de contenu par référence : le contenu d'un nœud cible est remplacé par le contenu d'un nœud source à la compilation.Voir dans le glossaire → et le Texte conditionnelContenu marqué comme ne s'appliquant qu'à un public, une version de produit ou un livrable donnés, afin qu'une même source puisse être filtrée à la compilation pour produire des documents différents. DITA XML le met en œuvre avec les fichiers ditaval ; des moteurs de modèles comme Jinja font de même pour les formats texte.Voir dans le glossaire → DitavalUn fichier de filtre DITA XML qui inclut ou exclut du contenu marqué avec des attributs correspondants au moment de la compilation — le mécanisme derrière le texte conditionnel de DITA.Voir dans le glossaire →.
- Documentation
- NuFirewall, un produit logiciel. Sa documentation, réalisée sous DITA XML, a été perçue par la presse comme un point fort du produit.
- Techniques illustrées
- Le partage de blocs d’information avec les conref : les centraliser dans un fichier unique, utiliser le nœud XML de plus bas niveau, prendre en compte les contraintes de traduction, limiter leur imbrication et protéger les informations confidentielles. La fourniture d’une information ciblée avec le texte conditionnel ditaval.
- À lire pour
- Voir comment ces choix de réutilisation et de filtrage ont été faits sur la documentation d’un produit réel.
Solutions et astuces issues de projets multilingues
Section intitulée « Solutions et astuces issues de projets multilingues »Les didacticiels DITA XML et XSL-FOUn langage de feuilles de style pour transformer et mettre en page du contenu XML pour une sortie impression/PDF, couramment associé aux pipelines de publication DITA XML.Voir dans le glossaire → rassemblent les procédures nées de cet usage quotidien, par exemple :
- Gérer les projets multilingues. Une méthodologie et un script Bash qui génèrent chaque version linguistique à partir d’un fichier DitamapUn fichier externe de table des matières qui assemble des topics DITA XML en document, sans que les topics eux-mêmes aient besoin de connaître leur position dans ce document.Voir dans le glossaire → unique.
- Texte conditionnel. Des documents différents à partir des mêmes sources DITA XML, filtrés par des fichiers ditaval.
- Sortie PDF. Des réglages de DITA-OT (DITA Open Toolkit)Moteur de publication open source qui transforme des sources DITA XML, assemblées par un ditamap, en formats cibles comme le PDF (via XSL-FO) ou le HTML.Voir dans le glossaire → et des feuilles de style XSL-FO, comme l’affichage des références croisées.