Prenez en main les applications structurées et découvrez l’importance du formatage dans une application structurée.
Dans FrameMaker non structuré, la configuration d’un environnement de création de documents nécessite un seul fichier modèle. Le fichier modèle définit les formats et les styles, tandis qu’un guide de style définit l’utilisation correcte du modèle. Dans FrameMaker structuré, un modèle structuré ne suffit pas.
Pour établir un environnement de création de documents structurés de base dans FrameMaker, une EDD ou une DTD sont nécessaires. Vous pouvez créer vos propres EDD et DTD ou utiliser des EDD et des DTD prêts à l’emploi. En outre, vous devez associer les définitions d’éléments aux informations de formatage. Vous pouvez lier au formatage des éléments dans le document EDD de trois manières différentes :
Vous pouvez assigner le formatage en fonction des diverses balises (styles de paragraphes, de caractères, etc.) d’un modèle. Si vous disposez déjà d’un modèle de formatage, vous pouvez réutiliser les informations qu’il contient.
Vous pouvez créer des définitions de formatage nommées dans l’EDD. Les listes de modifications du formatage vous permettent de fournir des spécifications de formatage partielles, et d’hériter du reste à partir de quelques styles de paragraphes de base. Vous pouvez réutiliser les listes de modifications du formatage pour les éléments associés.
Vous pouvez préciser le formatage en l’incorporant dans chaque définition d’élément.
Une fois l’EDD et le formatage créés, vous pouvez associer les deux composants pour créer un modèle structuré unique. Pour créer ce modèle structuré, vous devez ouvrir le modèle de formatage et importer les définitions d’éléments () à partir de l’EDD. Le fichier créé correspond à votre modèle structuré.
En plus de l’EDD et du modèle structuré, les éléments suivant sont nécessaires :
Les règles de lecture/écriture contrôlent la conversion de la structure FrameMaker en XML et inversement. Plus particulièrement, ces règles contribuent à la gestion des conversions de tableaux et autres formatages complexes.
L’application structurée répertorie tous les fichiers de composants de votre mise en œuvre de structure et fournit des informations de configuration. Par exemple, vous pouvez utiliser l’application structurée pour indiquer s’il est nécessaire ou non d’exporter le balisage de texte conditionnel et de quelle manière.
Toutes les applications structurées FrameMaker doivent disposer de modèles structurés. Les modèles structurés FrameMaker contiennent les définitions de tous les éléments qui peuvent être utilisés dans le document, ainsi que leurs options de mise en page et de formatage.
Les modèles structurés sont similaires aux modèles non structurés, mais ils diffèrent principalement au niveau du catalogue Eléments.
Le catalogue Eléments contient les définitions d’éléments définies dans l’EDD. La première étape de création d’un document structuré consiste à importer les définitions à partir d’une EDD ou d’une DTD. Les définitions d’éléments dans une EDD ou une DTD sont renseignées dans leCatalogue d’éléments. La catalogue Eléments vous permet d’insérer des éléments valides dans votre document et de créer une structure conforme aux règles définies dans l’EDD.
Le terme analyse du contenu décrit une procédure d’examen des documents existants afin de comprendre leur conception et leur structure explicite. Commencez votre analyse en dressant une liste des documents produits par votre entreprise. Votre liste peut comprendre des guides d’utilisateur, des guides de référence, des livres blancs, des tutoriels, des manuels de formation et de l’aide en ligne. Dressez la liste des principaux composants pour chaque type de document. Pour chaque composant, indiquez si l’élément est obligatoire ou facultatif et sa fréquence dans le document. Le tableau suivant présente une analyse de haut niveau pour un livre.
Composant |
Exigence |
Occurrence |
|---|---|---|
Garde |
Obligatoire |
1 |
Table des matières |
Obligatoire |
1 |
Préface |
Facultatif |
0 ou 1 |
Chapitre |
Obligatoire |
2 ou plus |
Annexe |
Facultatif |
0 ou plus |
Glossaire |
Facultatif |
0 ou 1 |
Index |
Obligatoire |
1 |
Pour les principaux composants, tels que les leçons (des manuels de formation) ou les chapitres (des livres), divisez la hiérarchie en catégories toujours plus restreintes jusqu’à accéder au niveau le plus bas de la hiérarchie.
Vous devez procéder à une analyse du contenu pour chaque type de document que vous souhaitez créer dans votre environnement structuré. Lorsque vous avez développé un modèle de contenu pour chaque document, vous pouvez rechercher les possibilités d’affiner le modèle et de réutiliser des noms. Admettons par exemple qu’un document à publier intitulé Aide se compose de rubriques et que les chapitres d’un livre le soient également. En créant un élément Rubrique pouvant être utilisé à la fois pour les documents imprimés et en ligne, vous réduisez d’autant le nombre d’éléments de votre définition de structure et pourrez éventuellement réutiliser les informations pour les deux formats de sortie.
Rubrique imprimée |
Rubrique en ligne |
Rubrique associée |
|---|---|---|
Rubrique |
Rubrique |
Rubrique |
Titre |
Titre |
Titre |
Para |
Para |
Para |
Etapes |
Etapes |
Etapes |
Peut contenir les éléments Para, Liste, Tableau, Graphique, Note |
Peut contenir les éléments Para, Liste, Tableau |
Peut contenir les éléments Para, Liste, Tableau, Graphique, Note |
RubriquesConnexes |
RubriquesConnexes |
Il est peu probable que tous vos documents soient parfaitement cohérents. Vous devez décider de créer une structure souple (permettant de nombreuses variations) ou stricte (permettant très peu de variations). Vous rencontrerez certaines difficultés, quelle que soit l’option retenue :
Une structure très souple est plutôt complexe et peut être difficile à gérer en raison du nombre très important de variations autorisées.
Une structure très stricte peut interdire certaines associations d’éléments pourtant nécessaires.
Il est très difficile de trouver le juste équilibre entre ces deux extrêmes. Une approche consiste à autoriser les variations uniquement lorsqu’elles ajoutent de la valeur.
Une fois l’analyse terminée, vous pouvez choisir entre utiliser une structure existante ou concevoir la vôtre. De nombreuses mises en oeuvre XML sont disponibles ; DocBook et Darwin Information Typing Architecture (DITA) sont les spécifications utilisées pour la documentation technique. Des structures standard sont également définies pour les documents militaires (mil-specs ou mil-standards), les documents de maintenance aérienne et bien d’autres encore. Le tableau suivant décrit certains des facteurs qui peuvent influencer votre décision quant à l’utilisation d’une spécification standard ou à la création de votre propre structure.
Utilisation d’une structure standard |
Création de votre structure |
|---|---|
Vous devez fournir du contenu respectant la norme. Par exemple, de nombreux fournisseurs de l’armée américaine doivent fournir de la documentation conforme à une norme publiée. |
Vous souhaitez créer une structure correspondant précisément à votre analyse du contenu. |
Vos exigences en matière de contenu correspondent exactement à une structure existante. Vous devez uniquement apporter quelques modifications mineures à la structure standard. |
Votre analyse du contenu indique que vos informations ne correspondent pas vraiment aux structures existantes. |
Vous ne voulez pas passer trop de temps à créer une structure et souhaitez modifier l’organisation de votre contenu pour l’adapter à une structure existante. |
La structure doit correspondre précisément au contenu. Une période de mise en œuvre plus longue représente un coût acceptable pour vous assurer de développer précisément ce dont vous avez besoin. |
Vous ne disposez pas du savoir-faire technique ou des ressources nécessaires pour développer votre propre structure. |
Vous disposez de ressources (internes ou consultants) qui peuvent concevoir la structure. |
Les composantes de base des documents structurés sont les éléments. Ils représentent les parties du contenu d’un document (son texte, ses graphiques, etc.). L’ensemble de ces éléments constitue la structure du document. Les éléments peuvent être simples ou complexes.
Un élément simple en langage XML contient uniquement du texte. Un élément complexe peut avoir des attributs et peut :
être vide ;
contenir d’autres éléments ;
ne contenir que du texte ;
contenir des éléments et du texte.
Les éléments peuvent disposer de valeurs comprises dans une plage de valeurs valides.
Tous les documents structurés de FrameMaker utilisent des éléments. Chaque élément possède un nim, tel que <section>, <title> ou <p>. Ce sont les définitions d’éléments du document qui vont déterminer les éléments disponibles.
Les attributs fournissent des informations supplémentaires sur un élément. Par exemple, le concepteur de DTD d’un manuel peut utiliser un attribut nommé version pour son élément de livre afin d’autoriser l’utilisateur à spécifier de statut de révision d’un livre. Dans FrameMaker, les attributs d’un élément font partie de la définition de l’élément même. Dans XML ou SGML, les attributs d’un élément existent séparément dans la DTD, dans une déclaration de liste de définition d’attributs (ATTLIST).
La valeur des attributs peut être par défaut ou fixe. Les attributs peuvent être obligatoires ou optionnels. Par exemple, si vous avez un élément de rubrique, l’ID de la rubrique peut être un attribut obligatoire afin de permettre les références croisées dans les rubriques. Il est également possible d’avoir des plages de valeurs pour les attributs ou d’énumérer les valeurs autorisées d’un attribut.
Les sept règles suivantes contrôlent l’utilisation des éléments selon leur séquence, leur nombre d’occurrences et leur groupe.
Indique que les éléments enfants peuvent se trouver dans toutes les séquences à condition qu’ils apparaissent au moins une fois.
Indique que l’occurrence d’un élément enfant est possible.
Indique l’ordre d’affichage des éléments enfants.
Indique le nombre d’occurrences minimum d’un élément enfant.
Indique le nombre d’occurrences maximal d’un élément enfant.
Les éléments peuvent être regroupés sous une déclaration de groupe.
Les attributs peuvent être regroupés sous une déclaration attributeGroup.
Un schéma XML définit les composantes autorisées d’un document XML. A la différence de l’EDD, les fichiers DTD et de schéma ne fournissent pas d’informations de formatage.
Les schémas XML définissent :
la liste des éléments qui peuvent figurer dans un document ;
les attributs qui peuvent figurer dans un document pour un élément ;
La hiérarchie des éléments, c’est-à-dire les éléments pouvant s’afficher en tant qu’éléments enfants ;
la séquence des éléments enfants ;
le nombre d’éléments enfants ;
les types de données des éléments et les attributs ;
les valeurs fixes et par défaut des éléments et des attributs.
Les espaces de noms XML permettent à un document de contenir des éléments XML et des attributs provenant de langages différents sans que cela entraîne des collisions de noms.
Vous pouvez importer un document XML faisant référence à un fichier de schéma, et vous pouvez indiquer un fichier de schéma dans votre application structurée afin de l’utiliser pour valider un document lors de son exportation au format XML.
Pour indiquer le fichier de schéma à utiliser lors de l’exportation vers XML, modifiez le fichier structapps.fm. L’élément Schema, un enfant de l’élément <XMLApplication>, spécifie le chemin d’accès à un fichier de schéma pour l’exportation.