Abstracts

L'élément abstract ressemble à l'élément shortdesc dans la mesure où il contient un court résumé du contenu d'une rubrique. L'élément abstract ne doit être employé que dans des cas spécifiques, car il est très rarement avantageux par rapport à l'élément shortdesc. L'élément abstract peut contenir plusieurs éléments shortdesc, dont le traitement diffère en général légèrement des éléments shortdesc autonomes.

Les éléments abstract de DITA ressemblent aux éléments shortdesc, mais peuvent contenir des structures d'information plus complexes. Un abstract peut contenir toute une série d'éléments block, tels que des paragraphes et des remarques, tout comme un ou plusieurs éléments shortdesc.

Une rubrique peut contenir soit un élément abstract (qui peut comprendre un élément shortdesc imbriqué), soit un élément shortdesc autonome, mais pas les deux éléments réunis.

Généralement, il est conseillé d'utiliser un élément shortdesc plutôt qu'un élément abstract, selon le principe « l'approche la plus simple est souvent la meilleure » .

La structure de l'élément abstract doit être utilisée dans les cas suivants :

Pour des rubriques dans lesquelles plusieurs éléments shortdesc sont requis car la rubrique doit être publiée de manière conditionnelle.
Pour des rubriques re-use (réutilisables) dans lesquelles plusieurs éléments shortdesc seront stockés depuis d'autres rubriques.
Pour des rubriques complexes dans lesquelles l'élément shortdesc ne suffit pas à résumer convenablement le contenu de la rubrique.

Seul les éléments shortdesc contenus dans un élément abstract sont inclus dans l'aperçu de la rubrique et des liens.