DITA topic example
| Introduction à DITA / Rédiger avec DITA | |
Comprendre la structure d'un topic de base et ses contenus.
Bloc d’information autonome
Traitant d’un seul sujet
D’un point de vue privilégié (notion de type d’information)
La structure va refléter le type d’information que le topic contient
Les topics de la norme sont :
Topic
Concept, Task , Reference et Glossentry
Un topic est toujours titré
Utile pour les liens
Dans DITA, tout ce qui peut être cible d’un lien est titré
Utile pour les tables d’accès et autre outil de recherche
Sa structure est avant tout rédactionnelle
Structures textes et images, organisées en sections au besoin
Mais possibilité de structures de données plus complexes (< foreign >)
Sa granularité doit permettre sa réutilisation
Plus petit, la réutilisation et le suivi des évolutions seront plus difficiles à mettre en œuvre
Plus grand, sa taille empêchera de le réutiliser dans tous les contextes
Sans conséquence pour l’efficacité du rédacteur
<!ELEMENT topic (title, titlealts?, shortdesc?, prolog?,
body, related-links?, (%info-types;)*)>
Identification
ID, title, shortdesc
Propriétés et Métadonnées
Gestion et publication
Contenu
Liens
Topics imbriqués
Le « topic de base » est une structure abstraite à ne jamais utiliser
Prévu comme « ressource de base » pour la spécialisation
Le contenu réel d’un topic
paragraphes, listes, tableaux, etc.
organisé de manière facultative en sections
Pas de hiérarchisation dans le contenu
<section> est titré
N’a de sens que pour être spécialisé (<note>, <exemple>, etc.)
Si on utilise <section> tel quel, complexité de la maintenance du fonds : pas de sous-section possible si par la suite cela devient nécessaire
Il vaut mieux imbriquer des topics
Hiérarchisation des < sectionDiv > et < bodyDiv >
Non titrés
Existent pour des besoins de spécialisation
Ex. Deux éléments qui s’imbriquent et qui sont tous deux une spécialisation du même élément < sectionDiv >
Divisions d’organisation
Section (<section>) et exemple (< example >)
Titres facultatifs
Tableau
Utilisation du modèle CALS pour les tableaux complexes (<table>)
Modèle de tableau simple : pas de titre, ni de pied de tableau (< simpletable >)
Liste
Définition (<dl>), ordonnée (<ol>), non ordonnée (<ul>), simple (<sl>)
Bloc
Figure (<fig>) , bloc de ligne (<lines>), citation (<lq>), paragraphe (<p>), élément pré-formaté (<pre>)
Multimedia
Image (<image>), objet (<object>)
Autres contenus
Contenus dont le modèle de contenu n’est pas DITA (<foreign>)
Phrase
Référence bibliographique (<cite>), mot-clé (<keyword>), phrase (<ph>), contenu cité d’une autre source (<q>), termes (<term>)
Et beaucoup d’autres éléments ici via les vocabulaires « domaine »
Liaisons
Note de bas de page (<fn>), entrée d’index (<indexterm> ), marque commerciale (<tm>), référence croisée (<xref>)
Gestion processus de rédaction
Commentaire inline (<draft -comment>)
Placeholder pour indiquer qu’une intervention manuelle doit être faite, en cas d’import automatisé par exemple (<required-cleanup>)
Utilisation d’entités pour définir des jeux d’attributs
%univ-atts; recense l’ensemble des attributs potentiels de chacun des éléments de base
Regroupe les attributs suivants :
Gestion de la réutilisation et des liens : id, conref (%id- atts;)
Réutilisation au niveau de l’élément
Caractérisation des rédactionnels : @platform, @product, @audience, @importance, @props (%select- atts;)
Utilisé pour les processus conditionnels (filtrage des informations)
Support de valeurs multiples pour les attributs
Gestion de contenus : @rev, @status (%select- atts;), @xml:lang, @translate
Gestion du statut, de la langue et de la traduction du topic
Permet de gérer le cycle de vie du topic
Après le <body> :
Des liens d’association de topics ( related -links)
<related-links> <linkpool collection-type="family" type="task"> <link href="generalfaq.html#installing" role="parent"> <linktext>Installing the eReview client</linktext> </link> <link href="register.html#newuser" role="sibling"> <linktext>Register as new eReview user</linktext> </link> </linkpool> </related-links>
Des topics imbriquées
Ne font pas partie du <body>, car peuvent être également insérés dans des maps
en général recommandées pour la gestion des liens
XML Author