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

Onglets Documentation

Les onglets 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 Documentation qui ont été définis par l'administrateur dans la variable UC_OBJECT_DOCU sont affichés. Notez que les objets importés ont leurs propres onglets de documentation.

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

Documentation structurée

Chaque onglet peut également être affiché sous une forme structurée. La documentation structurée peut être utilisée pour éclater la grande quantité d'informations d'un objet en parties clairement organisées. Chaque élément de documentation peut être utilisé pour enregistrer des textes, mais aussi pour définir des attributs.

La définition de liens est également possible dans la documentation structurée (tels que des fichiers, des dossiers ou des documents de l'intranet ou d'internet). Les fichiers sont ainsi affichés avec leur programme associé, les dossiers sont ouverts, les URL appelées dans le navigateur standard, etc. Les actions particulières dépendent des programmes installés et de la configuration du PC de l'utilisateur.

Un nouvel onglet de documentation ne contient initialement qu'un dossier "Contenu". C'est le point de départ pour créer une autre structure. Pour créer et modifier cette structure, vous pouvez utiliser les commandes du menu contextuel suivantes :

Commande	Description
Ajouter un attribut	Créer un nouvel attribut dans l'élément sélectionné.
Ajouter un élément après	Un nouvel élément est ajouté après l'élément sélectionné.
Ajouter un élément avant	Un nouvel élément est ajouté avant l'élément sélectionné.
Ajouter un é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 différents : texte et liste. Vous pouvez ajouter un ou plusieurs de ces attributs à un élément. Définissez le nom de l'attribut puis spécifiez s'il s'agit d'un texte ou d'une liste. Pour les listes, 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 pas contenir d'espace.
Les deux-points sont des caractères réservés et ne doivent pas être utilisés.
Le 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.