Manuel des Scripts Automation Engine > Organisation fonctionnelle > Lecture ou modification d'objets > XML_BEAUTIFY

XML_BEAUTIFY

Fonction de script : Préparation du style d'affichage d'un document XML.

Syntaxe

XML_BEAUTIFY (Reference)

Syntaxe

Description / format

Référence

Référence au document XML à la structure duquel vous souhaitez appliquer un style d'affichage
Format : littéral de script ou variable de script


Codes retour

"0" - Le contenu du document XML a été bien préparé.

Commentaires

La fonction de script prépare l'affichage d'un document XML avant que ce dernier ne soit écrit dans un fichier XML à l'aide de XML_PRINTINTOFILE.

Pour que la fonction de script accède à un élément, une référence doit lui être transmise. Cette référence est fournie par des éléments de script qui peuvent être placés dans le document XML, tel que XML_GET_FIRST_CHILD, XML_GET_NEXTSIBLING ou XML_SELECT_NODE. La fonction de script prépare l'élément, ses sous-éléments et les attributs correspondants.

Vous pouvez également utiliser la référence retournée par XML_OPEN pour préparer le style d'affichage de l'intégralité du document XML.

Si vous n'utilisez pas XML_BEAUTIFY, les informations du document XML sont écrites les unes à la suite des autres (sans retour à la ligne) dans un fichier. Ce fichier est par conséquent difficilement lisible si vous l'ouvrez avec un éditeur de texte tel que le Bloc-notes.

Exemples

L'intégralité de la structure de la documentation est tout d'abord préparée afin d'être plus lisible, puis affichée dans le fichier Docu.xml.

Pour que cet exemple fonctionne, un onglet de documentation avec le nom "@Details" doit être ajouté à l'objet qui est utilisé avec XML_OPEN.

:SET &XMLDOCU# = XML_OPEN(DOCU,"ON_CALL","@Details")

:
SET &RET1# = XML_BEAUTIFY(&XMLDOCU#)
:
SET &RET2# = XML_PRINTINTOFILE("C:\AUTOMIC\XML_Documentation\Docu.xml",&XMLDOCU#)

:
XML_CLOSE

Le second exemple affiche dans un fichier les éléments Description et Objets, ainsi que leurs attributs.

:SET &XMLDOCU# = XML_OPEN(DOCU,"ON_CALL","@Details")

:
SET &HND# = XML_GET_FIRST_CHILD(&XMLDOCU#)
:
SET &RET1# = XML_BEAUTIFY(&HND#)
:
SET &RET2# = XML_PRINTINTOFILE("C:\AUTOMIC\XML_Documentation\Docu.xml",&HND#)

:
XML_CLOSE

 

Rubriques connexes :

Elément de script Description

XML_PRINTINTOFILE

Affiche le document XML dans un fichier

Eléments de script - Lecture ou modification d'objets

Documentation structurée

www.w3c.org/TR/xmlbase

Généralités sur les scripts
Eléments de script - Liste alphabétique

Eléments de script - Répartition fonctionnelle