Génération de documentation HTML à partir d'un fichier de schéma XML

La documentation HTML générée à partir d'un schéma XML contient différentes informations sur le schéma comme son nom, son emplacement et son espace de nom, ainsi que des détails sur différents composants (comme des éléments ou des types complexes) contenus dans le schéma. Cela peut être utile pour fournir un récapitulatif du contenu de votre schéma.
Avant de commencer
A propos de cette tâche

Les instructions suivantes ont été écrites dans la perspective Ressource, mais elles fonctionneront également dans de nombreuses autres perspectives.

Pour générer une documentation HTML basée sur un fichier de schéma XML :

  1. Dans l'Explorateur de projets, cliquez avec le bouton droit sur le schéma XML.
  2. Cliquez sur Générer > HTML. La boîte de dialogue Générer une documentation de schéma XML s'ouvre.
  3. Sélectionnez le style de la documentation HTML que vous voulez :
    1. Si vous voulez un seul fichier HTML par schéma, sélectionnez Générer la documentation XSD sans cadres.
    2. Sinon, sélectionnez Générer la documentation XSD avec des cadres. Si vous sélectionnez cette option, plusieurs fichiers HTML sont générés. Ils seront configurés de la même manière que les fichiers Javadoc.
  4. Cliquez sur Suivant pour spécifier le dossier cible pour vos fichiers HTML.
  5. Cliquez sur Terminer. Les fichiers HTML sont créés à l'emplacement spécifié.
Résultats

Les fichiers HTML générés peuvent contenir une ou plusieurs des informations détaillées suivantes :

Informations détaillées Description
Schéma Le nom, l'emplacement et l'espace de nom cible du schéma XML.
Espace de nom L'espace de nom cible du composant du schéma XML.
Diagramme Un modèle visuel des composants du schéma XML (tels que des éléments ou des types complexes). Vous pouvez cliquer sur l'en-tête d'un composant parent pour accéder aux détails de la documentation pour ce composant. Pour les types complexes, vous pouvez cliquer sur le nom du type d'élément pour accéder aux détails de la documentation de ce type.
Type Le type d'un composant (par exemple un type complexe).
Hiérarchie d'héritage La hiérarchie des types hérités d'un composant. Vous pouvez cliquer sur un type hérité pour accéder aux détails de la documentation pour ce type.
Détails du contenu La liste des éléments d'un type complexe et toute documentation associée à ces éléments tel que cela est défini dans le fichier du schéma XML.
Valeurs autorisées La liste des valeurs autorisées (ou énumérations) pour un type simple et la documentation qui y est associée.
Source Le code source XML pour le composant du schéma XML.

Lorsque l'encodage logique hébreu (ISO-8859-8-I) est sélectionné comme préférence pour l'encodage des fichiers HTML (Fenêtre > Préférences > Fichiers Web et XML > Fichiers HTML dans la section "Lors de la création de fichiers"), les fichiers de documentation HTML générés à partir d'un fichier de schéma XML auront toujours un encodage UTF-8. Il s'agit là d'un incident recensé.

Que faire ensuite

Vos commentaires