Instance Example1

De Trustedbird Client Wiki

Instance Example1

Cette instance comporte un unique champ permettant de sélectionner un type de correspondance parmi trois possibilités.

Voici l'affichage final de l'instance dans le client mail. Affichage final de l'instance.

Voici les fichiers qui la définissent.

TODO : Mettre à jour les schemaLocation décrivant les fichiers.


Fichier ximfmail-profile

Le fichier ximfmail-profile.xml devra contenir les renseignements sur les chemins vers les fichiers associés à l'instance.

<?xml version="1.0" encoding="utf-8"?>
<profile>
  <theme  name="Example Def" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation="D:\DOC\DOC_THUN_INTRACED\ximf_profile.xsd">
      <instance id="idExampleDefinition" 
        ximfVersion="2.0"
        version="1.0"
        name="Example1"
        directory="/chemin/vers/instance/Example1/" author="Ximfmail">
          <schema  name="Example1">headers-example1.xml</schema>
          <dictionary>dictionary-example1.xml</dictionary>
          <ihm>ihm-example1.xml</ihm>
          <rule>rules-example1.xml</rule>    	
      </instance> 
  </theme>
</profile>


Fichier dictionary-example1

Le fichier dictionary-example1.xml contient des renseignement de cinq données d'internationalisation pour les langues : fr-FR et en-US.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance
  name="Example1"
  version="1.0" 
  ximfVersion="2.0" 
  xmlns:ximf="http://eads.org/ximf/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
    <ximf:dictionary id="OneDico">
      <ximf:locale lang="fr-FR">
        <ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
        <ximf:ilk entity="ilk-security-panel">Securité</ximf:ilk>
        <ximf:ilk entity="ilk-general">Général</ximf:ilk>
        <ximf:ilk entity="ilk-confidential">Confidentiel</ximf:ilk>			
        <ximf:ilk entity="ilk-highly-confidential">Très confidentiel</ximf:ilk>
      </ximf:locale>
      <ximf:locale lang="en-US">
        <ximf:ilk entity="ilk-classification-panel">Classification</ximf:ilk>
        <ximf:ilk entity="ilk-security-panel">Security</ximf:ilk>
        <ximf:ilk entity="ilk-classification">Security classification</ximf:ilk>
        <ximf:ilk entity="ilk-general">General</ximf:ilk>
        <ximf:ilk entity="ilk-confidential">Confidential</ximf:ilk>			
        <ximf:ilk entity="ilk-highly-confidential">Highly Confidential</ximf:ilk>	
      </ximf:locale>
    </ximf:dictionary>
</ximf:instance>


Fichier ihm-example1

Le fichier ihm-example1.xml contient des renseignements sur l'agencement du formulaire : un onglet "pane_security" contient une sous-catégorie "group-classification". Cette sous-catégorie contient le champ "header-classification" décrit dans le fichier headers-example1.xml. De plus, le champ "header-classification" pourra être ajouté dans l'affichage des e-mails dans le client associé.

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance name="Example1" 
  version="1.0" 
  ximfVersion="2.0" 
  xmlns:ximf="http://eads.org/ximf/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
    <ximf:ihm 
      xmlns:ximf="http://eads.org/ximf/" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <ximf:panel id="pane_security" ilk="ilk-classification-panel">
          <ximf:groupbox id="group-classification" ilk="ilk-security-panel">
            <ximf:headerRef>header-classification</ximf:headerRef>
          </ximf:groupbox>			
        </ximf:panel>	
          <ximf:treeRcv>
            <ximf:headerRef>header-classification</ximf:headerRef>	
          </ximf:treeRcv>
       </ximf:ihm>
</ximf:instance>


Fichier headers-example1

Le fichier ihm-example1.xml contient des renseignements sur les types de champs de l'instance XIMF et la façon dont les entêtes envoyées devront être formatées.

Il est ici question d'un champ devant être obligatoirement renseigné (attribut isMandatory="true"), qui est sous forme de chaîne de caractère (attribut type="string"). La valeur du champ peut être sélectionnée parmis trois valeurs : "example-general", "example-confidential" et "example-highly-confidential". Les références des données d'internationalisation qui seront affichées pour chaque élément sont renseignées dans l'attribut "ilk".

<?xml version="1.0" encoding="UTF-8"?>
<ximf:instance name="Example1"
  version="1.0"
  ximfVersion="2.0"
  xmlns:ximf="http://eads.org/ximf/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://eads.org/ximf/ ximf.xsd">
    <ximf:header id="header-classification" 
      headerName="X-XIMF-Security-Classification"
      type="string"
      ilk="ilk-classification"
      isMandatory="true">
        <ximf:set id="value-example-classification" separator=";">
          <ximf:string 
            ilk="ilk-general"
            content="example-general" />			
          <ximf:string 
            ilk="ilk-confidential"
            content="example-confidential" />
          <ximf:string 
            ilk="ilk-highly-confidential"
            content="example-highly-confidential" />				
        </ximf:set>
    </ximf:header>
</ximf:instance>

Fichier rules-example1

Aucune règle particulière n'est associée à l'unique champ, le fichier rules-example1.xml est donc vide.