Aides
Il existe six types d’aide dans le framework SAINET ©. Certaines sont directement intégré dans les écrans, d’autres sont disponibles sous forme de ressources. L’aide sert à guider l’utilisateur dans son travail courant ainsi que de lui faire comprendre si il le souhaite les concepts plus globaux du systême.
Aides sur champs
Elle permet à l’utilisateur d’obtenir de l’aide contextuelle sur le champ qui a le focus. Elle permet de guider l’utilisateur dans le remplissage des données. Il est crucial de ne pas fournir de l’aide inutile à l’utilisateur. Les commentaires du type Inserez ici la date de fin dans un champ intitulé Date de fin polluent l’écran et l’experience utilisateur. Elle est déclarée dans la configuration xml
Aides sur groupes
Cette aide est visible en dessous des titres des groupes. Elle permet de donner un cadre général d’utilisation de l’écran à l’utilisateur. De même que pour les groupes, cette aide étant visuellement très présente à l’utilisateur, il faut qu’elle soit concise et utile. La répétition en phrase du titre du groupe est donc inutile.
Aides sur tâches
Cette aide est visible dans le manuel d’aide. Elle donne des explications globales sur les processus mis en jeu autour de la tâche ciblée.
Aides sur chaines
Cette aide est disponible dans la manuel d’aide. Elle explique le concept global d’une ligne d’un produit. Par exemple, le fonctionnement de la GTP. Elle est déclarée dans la configuration xml
Aides en workflows
Les workflows d’aide sont disponibles dans le manuel d’aide au niveau de la chaine. Ils decrivent des processus étape par étape. Ces processus sont bien souvent des processus attachés à des records (dossiers, évènements, etc…) et font partis du travail courant des utilisateurs.
Aides externe
Située au même endroit que les workflows, cette documentation supplémentaire sous forme de documents pdf ou autres permet d’approfondir un sujet sous forme de manuel complet formatté.
Format des fichiers XML
Les aides sont déclarées dans des fichiers xml dans la configuration du module. Il est possible d’ovverider des aides entre des modules suivant le systême standard de modularisation SAINET ©. Les fichiers sont déclarés par langue ce qui permet de facilement internationaliser l’aide d’un produit.
L'aide globale valable pour toutes les tâches dans toutes les chaines est déclaré dans le fichier GlobalHelp_
L'aide locale valable pour une chaine, une table, une tâche, un groupe, un field, un datafield particulier est déclarée
dans les fichiers
Le format d’un fichier d’aide est le suivant :
Le root node est forcément un node Chain
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain>
...
</Chain>
Dans le cas de l'aide global, l'ID de la chaine doit être `Global`. Sinon c'est l'ID de la chaine qui est le même que la chaine qui identifie le fichier. Par exemple, dans le fichier **STO_BasicHelp_FR.xml** le fichier commencera par
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
...
</Chain>
Pour déclarer l'aide sur la chaine, il suffit d'insérer une balise `Text` directement dans la chaine.
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
<Text><![CDATA[Ce texte est l'aide sur la chaine, il apparaitra dans le manuel d'aide]]></Text>
...
</Chain>
Il est possible de déclarer directement des datafields dans la chaine. Dans le cas de datafields déclarés dans **GlobalHelp_FR**, les IDs n'ont pas de format particuliers. Par exemple :
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="Global">
<DataField ID="PRINT_ALIM_GED"><![CDATA[Ceci est un texte d'aide global sur le datafield PRINT_ALIM_GED]]></DataField>
</Chain>
Dans le cas des fichiers spécifiques aux chaines, l'identifiant du datafield doit forcément commencer par la chaine.
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
<DataField ID="STO_PRINT_ALIM_GED"><![CDATA[Ceci est un texte d'aide spécifique au datafield STO_PRINT_ALIM_GED]]></DataField>
</Chain>
Dans les fichiers d'aide spécifiques aux chaines (**STO_BasicHelp_FR**) il est possible déclarer des aides spécifiques aux tâches et aux tables. Cette aide est déclarée dans un balise `
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
<Table ID="STOART">
<Text><![CDATA[Voici de l'aide pour la table STOART]]></Text>
</Table>
<Task ID="STO02">
<Text><![CDATA[Voici de l'aide pour la tâche STO02]]></Text>
</Task>
</Chain>
Une table peut déclarer de l'aide pour chacun de ses datafields.
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
<Table ID="STOART">
<DataField ID="STOART.NBTRAI"><![CDATA[A la place d'une période d'application, il est possible de donner le nombre de fois où cette constante sera employée.]]></DataField>
<DataField ID="STOART.DATJOU"><![CDATA[Date de dernière prise en compte, alimenté automatiquement par la génération automatique des factures (STO27)]]></DataField>
</Table>
</Chain>
Une tâche peut déclarer de l'aide pour les groupes et les fields. Cependant, ces fields sont localisés dans des panels ou des pages qui peuvent différer, tout en gardant le même identifiant de field/groupe. Il est donc nécéssaire de déclarer dans quel Panel (avec l'attribut `ID`) ou quelle Page (avec l'attribut `DataPageID`) l'aide doit être déclarée:
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
<Task ID="STO02">
<Panel ID="1">
</Panel>
<Page DataPageID="MISSION">
</Page>
</Task>
</Chain>
Il est ensuite possible de déclarer les champs et les groupes voulus, de la même façon qu'un datafield.
<?xml version="1.0" encoding="ISO-8859-1"?>
<Chain ID="STO">
<Task ID="STO85">
<Panel ID="1">
<Group ID="1"><![CDATA[Module optionnel permettant de gérer des périodiques statistiques différentes du mois]]></DataField>
<Field ID="BOUCLEMENT"><![CDATA[Validez le bouclement en cochant le champ. Si non-coché, le bouclement est abandonné.]]></DataField>
</Panel>
</Task>
</Chain>
Astuces
Pour faire des retours à la ligne dans l’aide, il est possible de les mettre directement dans le xml dans les CDATA. Pour garder la déclaration
monoligne de chacune des entrées, il est possible de mettre des <BR> qui seront remplacés à la volée au moment de l’affichage.