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 WSDL > Générer documentation >

Options de documentation

La commande WSDL | Générer documentation ouvre le dialogue Documentation WSDL (capture d'écran ci-dessous), dans lequel vous pouvez choisir des options pour la documentation.

 

Dans le volet Design de 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é créé dans une SPS StyleVision. Sélectionner l'option de votre choix. Veuillez noter que la sortie PDF est disponible uniquement pour la documentation générée avec une SPS StyleVision, et non pas pour la documentation générée avec un design fixe. Vous trouverez une description du maniement d'un design défini par l'utilisateur dans la section Design défini par l'utilisateur.

WSDLDocGen

Les autres options dans le dialogue Documentation WSDL sont expliquées ci-dessous. Selon que le document actif est un WSDL 1.1 ou un WSDL 2.0, les items dans le volet Inclure et Détails du dialogue seront différents. La capture d'écran ci-dessus montre le dialogue de Documentation WSDL pour un document WSDL 1.1.

 

Le format requis est spécifié dans le volet Format de sortie : soit HTML, Microsoft Word, RTF ou PDF. (Le format de sortie PDF est uniquement disponible si vous utilisez une SPS de StyleVision pour générer la documentation.) En cliquant sur OK, vous serez invité à choisir le nom du fichier et l'emplacement où il devra être enregistré.
Les documents Microsoft Word sont créés avec l'extension de fichier .doc lorsqu'ils sont générés à l'aide d'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 soit entre plusieurs fichiers. Si plusieurs fichiers sont générés, chaque fichier correspond à un composant. Les composants inclus dans la sortie sont spécifiés à l'aide de cases à cocher dans le volet Inclure. Dans les designs fixes, les liens entre les documents multiples sont créés automatiquement.
Pour la sortie HTML, les définitions de style CSS peuvent soit être enregistrées dans un fichier CSS séparé, soit intégrées dans le fichier HTML (dans l'élément <head>). Si un fichier CSS séparé est créé, il recevra 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 les 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ésultats, soit dans un format PNG ou EMF. Sinon, les diagrammes sont créés sous la forme de fichiers PNG ou EMF qui sont affichés dans le fichier de résultats par le biais de liens d'objets.
Si la sortie est un HTML, tous les diagrammes sont créés en tant que fichiers PNG externes. Si la case 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 de 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.
Dans le volet Inclure, vous choisissez les items que vous souhaitez inclure dans la documentation. L'option Vue d'ensemble liste tous les composants en haut du fichier, organisés par type de composant. Si l'option Fichiers importés (WSDL 1.1) ou Fichiers importés/inclus (WSDL 2.0) est cochée, les composants dans les fichiers importés (ainsi que les fichiers inclus dans le cas de WSDL 2.0) sont inclus dans la documentation de schéma.
Dans le volet Schéma, vous pouvez sélectionner si des schémas dans le fichier sont rapportés ou pas. Si vous choisissez de rapporter les schémas, vous pouvez choisir si : (i) vous souhaitez rapporter la documentation de schéma dans un fichier séparé ou dans le fichier de documentation principal, et si (ii) le schéma entier doit être rapporté ou bien seulement les éléments globaux, les types simples et les types complexes.
Le volet Détails liste les détails qui peuvent être inclus pour chaque composant. Sélectionner les détails que vous souhaitez inclure dans la documentation. Les touches Tout cocher tout et Tout décocher vous permettent de sélectionner ou 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ètre, en cliquant sur OK, un dialogue s'ouvre et liste tous les paramètres définis dans la SPS. Vous pouvez saisir les 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