XML "Page d'accueil"

De ISPWiki.

Introduction

Pour présenter une "Page d'accueil" vous devez utiliser le fichier billmgr_dashboard_5.xml situé dans le répertoire /usr/local/ispmgr/etc. Le digit dans le nom du fichier signifie un "niveau d'accès" d'un utilisateur qui utilisera ce fichier. Par exemple, "5" est un niveau d'un consommateur du système de billing.

Quand un utilisateur entre sur la page d'accueil pour la première fois, le contenu du fichier est copié dans le fichier /usr/local/ispmgr/var/userconf/billmgr.USERNAME.dashboard.xml, où USERNAME est un login. Toutes les modifications suivantes réalisées par un utilisateur sont sauvegardées dans ce fichier.

Élément root XML (doc)

 <xs:element name="doc"/>

L'élément root contient des éléments block de la page d'accueil.

Bloc (block)

 <xs:element name="block">
   <xs:complexType>
     <xs:sequence>
       <xs:element minOccurs="0" ref="toolbtn"/>
       <xs:element minOccurs="0" ref="col"/>
     </xs:sequence>
     <xs:attribute name="name" use="required" type="xs:NCName"/>
     <xs:attribute name="position" use="required" type="xs:NCName"/>
     <xs:attribute name="type" use="required" type="xs:NCName"/>  
     <xs:attribute name="func" type="xs:NCName"/>  
     <xs:attribute name="rows" type="xs:integer"/>  
   </xs:complexType>
 </xs:element>

Chaque bloc de la page d'accueil est décrit par un élément block séparé.

attribut name

Nom unique de bloc.

attribut position

La position du bloc sur la page d'accueil. top (le bloc est situé en haut de la page), left (le bloc est situé sur la colonne de gauche) ouright (le bloc est situé sur la colonne de droite).

attribut type

Type de bloc. Les deux valeurs suivantes sont possibles toolbar (le bloc contient les boutons) ou list (le bloc contient les données tabulaires).

attribut func

cela existe si type="list". Le nom de la fonction de laquelle les données sont prises.

attribut rows

cela existe si type="list". Le nombre de lignes tabulaires à afficher.

élément toolbtn

décrit le bouton si le bloc a type="toolbar".En cas de type="list", cela indique vers l'élément toolbtn du fichier XML principal; les boutons listés seront utilisés afin de réaliser les opérations sur les éléments tabulaires.

élément col

indique vers l'élément col du fichier XMLprincipal. Les colonnes listées seront affichées dans le bloc décrit.

Bouton (toolbtn)

 <xs:element name="toolbtn">
   <xs:complexType>
     <xs:attribute name="name" use="required" type="xs:NCName"/>
     <xs:attribute name="img" use="required" type="xs:NCName"/>
     <xs:attribute name="func" use="required" type="xs:NCName"/>  
     <xs:attribute name="list" type="xs:NCName"/>  
     <xs:attribute name="action" type="xs:NCName"/>  
   </xs:complexType>
 </xs:element>

Décrit le bouton si le bloc a type="toolbar". En cas de type="list", cela indique vers l'élément toolbtn du fichier XML principal; les boutons listés seront utilisés afin de réaliser les opérations sur les éléments tabulaires.

attribut name

nom unique de bloc. S'il est utilisé avec type="list" dans le bloc, il doit être avoir le nom identique à celui du fichier XML principal.

attribut img

nom d'image affiché sur le bouton. Ne spécifiez pas ses extensions.

attribut func

contient le nom de la fonction qui sera affichée dans le formulaire lorsque vous cliquez sur ce bouton. Cela peut être utilisé avec l'attribut list.

attribut list

contient le nom de la fonction qui sera affichée dans la liste lorsque vous cliquez sur le bouton. Cela peut être utilisé avec l'attribut func.

attribut action

contient le code Javascript qui sera réalisé lorsque vous cliquez sur le bouton.

Colonne tabulaire (col)

 <xs:element name="col">
   <xs:complexType>
     <xs:attribute name="name" use="required" type="xs:NCName"/>
     <xs:attribute name="sort" use="required" type="xs:NCName"/>
     <xs:attribute name="sorted" use="required" type="xs:NCName"/>  
   </xs:complexType>
 </xs:element>

Indique vers l'élément col du fichier XML principal. Les colonnes listées seront affichées dans le bloc décrit.

attribut name

nom de colonne. Il doit être identique à celui de colonne du fichier XML principal

attribut sort

spécifie comment trier les données situées dans la colonne. Les valeurs suivantes alpha (tri alphabétique; utilisé par défaut), digit (tri numéral par ordre croissant ), file (tri alphabétique, les répertoires s'affichent les premiers), indicator (trié par "valeur utilisée" d'un indicateur; uniquement pour les colonnes avec les indicateurs), ip (tri d'adresses IP), prop (trié par propriétés; uniquement pour les colonnes qu'affichent les icônes de ces propriétés) sont possibles.

attribut sorted

si sorted="yes", le tableau sera trié par cette colonne par défaut. En cas de sorted="desc", il sera trié en ordre inverse.