Options de documentation

www.altova.com Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  Manuel de l'utilisateur et référence > Commandes de menu  > Menu Conception de schéma > Générer Documentation >

Options de documentation

La commande Conception de schéma | Générer documentation génère une documentation détaillée du schéma actif : Schéma XML ou schéma JSON. Cette section décrit la génération de la documentation de Schéma XML. La procédure de génération de la documentation de schéma JSON est semblable. Pour plus de détails concernant la génération d'une documentation de schéma JSON et une description des paramètre de génération de documentation, voir la section Générer une documentation de schéma JSON.

 

Générer une documentation de Schéma XML

Lorsqu'un document de Schéma XML est actif et que vous cliquez sur la commande Générer documentation, le dialogue Documentation de schéma (capture d'écran ci-dessous) s'affiche. Dans ce dialogue, vous pouvez sélectionner des options pour la documentation.

 

Dans le volet de Conception de la documentation du dialogue, vous pouvez sélectionner si vous souhaitez utiliser le design fixe XMLSpy pour la documentation générée ou si vous souhaitez utiliser un design personnalisé dans une SPS StyleVision. Choisir l'option que vous souhaitez. Veuillez noter que la sortie PDF est disponible uniquement pour la documentation générée avec une SPS StyleVision, et non pas pour une documentation générée avec un design fixe. Vous trouverez des informations vous expliquant comment travailler avec un design défini par l'utilisateur dans la section Design défini par l'utilisateur.

schema-doc-ge4ndbox

Les autres options dans le dialogue de Documentation de schéma sont expliquées ci-dessous :

 

Le format requis est spécifié dans le volet de Format de sortie : HTML, Microsoft Word, RTF ou PDF. (Le format de sortie de PDF est uniquement disponible si vous utilisez une SPS StyleVision pour générer la documentation.) En cliquant sur OK, vous serez invité à saisir le nom du fichier de sortie et l'emplacement où il doit être enregistré.
Les documents Microsoft Word sont créés avec l'extension de fichier .doc lorsqu'ils sont générés en utilisant un design fixe, et avec une extension de fichier .docx lorsqu'ils sont générés avec une SPS de StyleVision.
La documentation peut être générée soit en tant que fichier unique ou être répartit sur plusieurs fichiers. Lorsque plusieurs fichiers sont générés, chaque fichier correspond à un composant. Les composants à inclure dans la sortie sont ceux spécifiés en utilisant les cases à cocher dans le volet Include. Dans des designs fixes, les liens entre plusieurs documents, les liens entre les différents documents sont créés automatiquement.
Pour la sortie HTML, les définitions de style CSS peuvent être enregistrées soit dans un fichier CSS séparé ou intégré dans le fichier HTML (dans l'élément <head>). Si un fichier CSS séparé est créé, il sera nommé avec le même nom que le fichier HTML, mais aura une extension .css. Cocher ou décocher la case Intégrer CSS dans HTML pour définir l'option requise.
L'option Intégrer diagrammes est activée pour les options de sortie MS Word, RTF et PDF. Lorsque cette option est cochée, les diagrammes sont intégrés dans le fichier de résultat, soit dans le format PNG ou EMF. Sinon, les diagrammes sont créés en tant que fichiers PNG ou EMF, qui sont affichés dans le fichier de résultat par le biais de liens d'objet.
Lorsque la sortie est HTML, tous les diagrammes sont créés en tant que fichiers PNG externe au document. Si la case à cocher Créer dossier pour les diagrammes est cochée, un dossier sera créé dans le même dossier que le fichier HTML, et les fichiers PNG seront enregistrés à l'intérieur. Ce dossier aura un nom du format HTMLFilename_diagrams. Si la case à cocher Créer dossier pour les diagrammes est décochée, les fichiers PNG seront enregistrés dans le même dossier que le fichier HTML.
Les liens vers les fichiers locaux (comme les fichiers d'image de diagramme et le fichier externe CSS) peuvent être relatifs ou absolus. Dans le volet Générer liens vers des fichiers locaux, choisir le bouton radio approprié conformément à l'option que vous préférez.
Dans le volet Include, vous choisissez les types d'items que vous souhaitez inclure dans la documentation. Chaque item des types sélectionnés sera affiché dans la documentation générée. Par exemple, si Attributes locaux est coché, alors la description de chaque attribut local sera affichée en tant qu'entrée séparée. L'option Index liste tous les schémas liés en haut du fichier, et leurs composants globaux sont organisés par types de composant. Les touches Tout cocher et Tout décocher vous permettent de sélectionner et désélectionner rapidement toutes les options du volet. Veuillez noter que l'option Include n'affecte pas l'affichage d'un type d'item dans le cadre des définitions graphiques. Cet affichage est contrôlé par les paramètres que vous effectuez dans le dialogue Configuration d'affichage de schéma. Donc si vous souhaitez désactiver l'affichage des attributs dans le cadre de la représentation graphique d'un item de schéma, décocher l'option Attributs dans le dialogue Configuration d'affichage de schéma.
Le volet Détails liste les détails qui peuvent être inclus pour chaque composant. Choisir les détails que vous souhaitez inclure à la documentation. Les touches Tout cocher et Tout décocher vous permettent de sélectionner ou de désélectionner rapidement toutes les options dans le volet.
L'option Afficher le fichier de résultat est activée pour toutes les options de sortie. Lorsque cette option est cochée, les fichiers de résultat sont affichés dans le Mode Navigateur (sortie HTML), MS Word (sortie MS Word), et les applications par défaut pour les fichiers .rtf (sortie RTF) et les fichiers .pdf (sortie PDF).

 

Valeurs de paramètre

Si la SPS de StyleVision contient une ou plusieurs définitions de paramètres, en cliquant sur OK, un dialogue s'ouvre listant tous les paramètres définis dans la SPS. Vous pouvez soit saisir des valeurs de paramètres dans ce dialogue pour contourner les valeurs de paramètre par défaut qui ont été assignées dans la SPS.

 


© 2018 Altova GmbH