Gérer les fichiers réutilisables

Il existe deux façons de gérer des fichiers de réutilisation de contenu permettant d'enregistrer des éléments sources référencés par conref. Il est conseillé d'enregistrer les éléments dans une rubrique réutilisable.

DITA peut réutiliser un fragment de document existant (en résumé, n'importe quel élément) d'une autre rubrique grâce à la fonction conref. Par exemple, un avertissement courant n'aura besoin d'être écrit qu'une seule fois, et pourra par la suite être réutilisé dans tout un corpus de documents. L'élément source conref peut soit être laissé dans sa rubrique initiale, soit être déplacé vers une rubrique de contenu réutilisable propre, dont le seul but est de mettre en mémoire tous les fragments réutilisables.

Dans la majorité des cas, la meilleure approche consiste à enregistrer les éléments réutilisables dans une rubrique réservée à ces éléments, dans le même dossier. Cette méthode est appelée l'approche centralisée ; les fragments des éléments sources référencés par conref sont enregistrés dans le même dossier.

La stratégie centralisée consistant à utiliser un ou plusieurs fichiers pour conserver les éléments que l'on souhaite réutiliser, permet de réduire la dépendance. Si vous livrez à un autre rédacteur un ensemble de rubriques DITA, vous avez uniquement besoin de lui faire parvenir l'ensemble des rubriques et le fichier réutilisable. Vous n'avez donc pas besoin de partir à la recherche d'autres rubriques qui pourraient contenir des éléments à réutiliser. La stratégie centralisée simplifie également les associations (liens) entre les fichiers.

Il est conseillé de nommer les fichiers avec le préfixe conref_ pour toutes les rubriques qui sont utilisées uniquement pour enregistrer des éléments réutilisables.

Figure 1: Exemple de fichiers source conref à l'intérieur d'un dossier conref

Si vous utilisez une rubrique source référencée par conref pour tous vos éléments réutilisables, utilisez le type d'information ditabase. Ce type d'information peut contenir à la fois des éléments communs et des éléments spécifiques à différents types d'information. Pour des répertoires plus gros, il est conseillé d'organiser vos éléments réutilisables dans des fichiers séparés pour des utilisations différentes, par exemple : un fichier pour les avertissements, un fichier pour les variables, un fichier pour les étapes, et ainsi de suite.

Un bon réflexe à prendre serait d'inclure la ou les rubrique(s) consacrée(s) aux éléments réutilisables dans la carte DITA de la collection, avec l'attribut toc prenant la valeur no, l'attribut link la valeur none, et l'attribut print la valeur no. Inclure la rubrique réutilisable dans la carte permet de rappeler que la collection utilise cette même rubrique réutilisable et de l'inclure lors de l'envoi des fichiers source de la collection à un autre auteur. C'est particulièrement important pour les gros répertoires, ou lorsque votre SGC (Système de Gestion du Contenu) utilise une carte DITA comme base pour copier ou vérifier des fichiers. Si vous avez bien plus qu'une simple poignée de rubriques réutilisables, vous devriez utiliser une carte imbriquée pour les rassembler, puis référencer cette carte au sein de la carte DITA de la collection.

Remarque : Dans DITA 1.2, un attribut processing-role a été ajouté à l'élément topicref. Donner à cet attribut la valeur resource-only est la meilleure alternative pour configurer les attributs toc, linking et print requis par DITA 1.1. De plus, il identifie clairement la rubrique référencée comme étant une simple ressource, et non partie intégrante du contenu.

Dans l'idéal, les rubriques conref doivent être enregistrées dans leur propre dossier, à un niveau inférieur à celui de la carte DITA, ou plus généralement dans le même répertoire que la carte DITA.