Manuel Utilisateur > Objets > Liste alphabétique > Onglets de la documentation

Onglets Documentation

Les onglets pour la documentation sont définis par l'utilisateur et sont spécifiques au client; ils peuvent être attribués à tous les types d'objet.

Tous les onglets de documentation qui ont été définis par l'administrateur dans la variable UC_OBJECT_DOCU sont affichés. Notez que les objets importés disposent en plus de leurs propres onglets de documentation.

L'onglet Gestion des versions affiche, s'il a été activé, les versions enregistrées de l'objet.

Documentation structurée

On peut aussi afficher chaque onglet dans une forme structurée. Vous pouvez, grâce à la Documentation structurée, éclater la grande quantité d'informations d'un objet en parties clairement organisées. Chaque élément de documentation peut être utilisé pour enregistrer du texte, mais également pour définir des attributs.

Ce sont par exemple des liaisons avec des fichiers ou des dossiers, mais aussi des liens vers des documents de l'intranet ou d'Internet. Les fichiers sont ainsi affichés avec leur programme associé, les dossiers sont ouverts, les URL ouvertes dans le navigateur, etc. Les actions dépendent des programmes installés et de la configuration du PC de l'Utilisateur.

Dans le cas d'un nouvel onglet de Documentation, vous ne voyez qu'un dossier "Content" au début. C'est le point de départ à partir duquel vous construisez la structure. Pour créer et modifier cette structure, vous pouvez utiliser les commandes du menu contextuel suivantes :

Commande	Description
Ajoute un attribut	Crée un nouvel attribut dans l'élément sélectionné.
Ajoute un élément après	Un nouvel élément est ajouté après l'élément sélectionné.
Ajoute un élément avant	Un nouvel élément est ajouté avant l'élément sélectionné.
Ajouter élément enfant	Crée un nouvel élément au niveau inférieur à celui de l'élément sélectionné.
Dupliquer un élément	L'élément sélectionné est dupliqué avec ses attributs et son contenu.
Supprimer un élément	L'élément sélectionné est supprimé définitivement.

Un ou plusieurs attributs peuvent être créés pour chaque élément individuel. Il existe deux types d'attributs : Texte et liste Vous pouvez ajouter un ou plusieurs de ces attributs à un élément. Définissez à cet effet le nom de l'attribut et spécifiez ensuite s'il s'agit d'un texte ou d'une liste. Dans le second cas, vous pouvez définir les entrées qu'elles contiendront.

Lors de la dénomination d'éléments et d'attributs, la convention d'affectation des noms XML doit être prise en compte. Les lettres, chiffres et caractères "-", ".", "_" peuvent être utilisés. Les règles suivantes doivent être respectées :

La première lettre du nom ne doit pas être un chiffre et ne doit être ni "." ni "-".
Le nom ne doit contenir aucun espace.
Les deux-points sont des caractères réservés et ne doivent pas être utilisés.
Un nom ne doit commencer ni par "XML", ni par "xml".

Vous pouvez lire la documentation structurée avec des éléments de script (XML_*) spécifiques.