Manuel Utilisateur ChainEdit

Transcription

1 1 Manuel Utilisateur ChainEdit Auteur(s) Lorthioir Romuald Henry Nadia Date de création du document 10/09/2007

2 2 Table des matières I ENTRER DANS L'APPLICATION...3 I.1 ENTRER PAR SSO...5 I.2 ENTRER PAR UNE AUTHENTIFICATION INTERNE...6 I.3 ECRAN D'ACCUEIL APRÈS L'AUTHENTIFICATION...7 II ADMINISTRATION...7 II.1 GESTION DES UTILISATEURS...9 II.1.1 Ajouter un utilisateur...10 II.1.2 Modifier un utilisateur...11 II.1.3 Supprimer un utilisateur...12 II.2 GESTION DES CONFIGURATIONS...13 II.3 GESTION DES CHARTES...14 II.3.1 Ajouter une charte...15 II.3.2 Modifier une charte...16 II Gestion des traitements...17 II.3.3 Supprimer une charte...19 II.4 GESTION DES PROJETS...20 II.4.1 Ajouter un projet...21 II.4.2 Modifier un projet...22 II.4.3 Supprimer un projet...24 III UTILISATION...24 III.1 TRAVAILLER SUR UN PROJET...25 III.1.1 Editer un projet...26 III.1.2 Générer le résultat...28 III.2 GESTION DU PROFIL UTILISATEUR...30 IV ANNEXES...31 IV.1 ANNEXE ICÔNES DE L'INTERFACE...31

3 3 Présentation Les caractéristiques du module Ce cours est en fait le manuel utilisateur de ChainEdit qui sert également d'exemple de réalisation d'un module de formation. Pour fonctionner, l'application doit avoir été préalablement installée. Pour cela, une documentation est disponible. Les finalités et objectifs La finalité de ce module est d'expliquer comment fonctionne ChainEdit et de montrer un exemple de réalisation. Les crédits Ce module a été réalisé par l'équipe projet de ChainEdit. N'hésitez pas à faire remonter vos remarques à l'équipe projet sur le site de. Logo de ChainEdit I ENTRER DANS L'APPLICATION INTRODUCTION ChainEdit est une application protégée. Pour pouvoir modifier des contenus, il est nécessaire d'être authentifié par l'application. Il existe deux moyens de se connecter à l'application en fonction du choix fait à l'installation : - Le premier s'appuie sur un système d'authentification unique. - Le second sur un système interne à ChainEdit qui permet de mettre en place l'application même si l'on ne dispose pas d'annuaire LDAP. Le mécanisme de paramétrage ne va pas être expliqué ici, pour cela reportez-vous à la

4 4 documentation d'installation. Par contre, les deux modes de connexion permettant à un utilisateur de se connecter vont être expliqués. Connexion Pour vous connecter à l'application, il faut cliquer sur le bouton connexion en haut de l'écran.

5 5 I.1 ENTRER PAR SSO EXPLICATION Quand ce mode d'authentification a été paramétré, un écran de saisie de login et de mot de passe est affiché. Cet écran n'est pas dans ChainEdit, il est fournit par votre établissement. Lorsque vous aurez validé cet écran avec les bons login et mot de passe, vous retournerez sur l'écran d'accueil de l'application qui vous affichera votre identité. Si vous ne connaissez pas vos identifiant, adressez-vous au service du personnel de votre établissement. SSO Exemple d'écran d'authentification. Ici, celui de l'université de Rennes 1.

6 6 I.2 ENTRER PAR UNE AUTHENTIFICATION INTERNE EXPLICATION Quand ce mode d'authentification a été paramétré, un écran de saisie de login et de mot de passe est affiché. Cet écran n'est pas dans ChainEdit, il est fournit par votre établissement. Lorsque vous aurez validé cet écran avec les bons login et mot de passe, vous retournerez sur l'écran d'accueil de l'application qui vous affichera votre identité. Si vous ne connaissez pas vos identifiant, adressez-vous au service du personnel de votre établissement. Identification Pour vous identifier, entrez votre login et votre mot de passe.

7 7 I.3 ECRAN D'ACCUEIL APRÈS L'AUTHENTIFICATION CONCLUSION Après vous être identifié, vous devez arriver sur l'écran d'accueil de l'application avec votre nom d'utilisateur affiché. Si cela n'est pas le cas, il doit y avoir un problème de paramétrage de l'application. Adressez-vous à votre administrateur. En fonction de votre rôle dans l'application, les options de menu en haut de l'écran peuvent varier. Accueil II ADMINISTRATION INTRODUCTION Seuls les administrateurs de l'application ont accès à cette interface. Les responsables de projets peuvent également accéder à la gestion de leur projet. L'ensemble des fonctions d'administration permettent de paramétrer l'application, d'importer les différentes chartes graphiques et de paramétrer les projets. Aucun utilisateur ne pourra accéder au contenu sans avoir été déclaré et associé à un projet au préalable. Interface d'administration

8 Les options de menu de l'interface d'administration dépendent du rôle de l'utilisateur. 8

9 9 II.1 GESTION DES UTILISATEURS Le premier écran de gestion des utilisateurs affiche la liste des utilisateurs déjà inscrits dans ChainEdit. A partir de cet écran vous pouvez ajouter, modifier ou supprimer un utilisateur. Pour pouvoir modifier ou supprimer un utilisateur vous devez au préalable en sélectionner un dans la liste puis cliquer sur le bouton associé à l'opération que vous souhaitez effectuer. Liste des utilisateurs

10 10 II.1.1 Ajouter un utilisateur Pour ajouter un utilisateur vous devez saisir l'ensemble des informations obligatoires : le login, le nom et le prénom. Si vous disposez d'un annuaire LDAP et que l'application est correctement paramétrée, vous pouvez également aller rechercher les données directement dans cet annuaire. L'ensemble des informations obligatoires sera renseigné (sauf la mot de passe par sécurité). Ajouter un utilisateur

11 11 II.1.2 Modifier un utilisateur Pour modifier un utilisateur, vous devez au préalable l'avoir sélectionner dans la liste. Vous ne pouvez pas changer le login. Modifier un utilisateur

12 12 II.1.3 Supprimer un utilisateur Pour supprimer un utilisateur, vous devez au préalable l'avoir sélectionner dans la liste. Vous devrez alors confirmer la suppression. En cas d'utilisation d'un annuaire LDAP, l'utilisateur ne sera pas supprimé de cet annuaire. Supprimer un utilisateur

13 13 II.2 GESTION DES CONFIGURATIONS La gestion des fichiers de configuration se fait directement par la gestion des répertoires et des fichiers de configuration. Un configuration est généralement constituée : - d'un fichier XSL permettant de transformer les éléments avant de les donner à Fck qui est l'éditeur de texte utilisé dans ChainEdit (Par défaut utilisez ceux donnés en exemple). - d'un fichier XSL permettant de transformer les éléments après la validation des données Fck - du schéma XSD permettant de valider la conformité du XML. - d'un fichier de configuration pour ChainEdit qui permet de sélectionner les champs du schéma qui devront être saisis, le bon outil pour le faire (Fck ou champs simple), l'aide contextuelle à afficher, et le libellé en français qui sera affiché. La création de ce fichier de configuration fait l'objet d'une autre documentation. Interface de configuration

14 14 II.3 GESTION DES CHARTES Le premier écran de gestion des chartes affiche la liste des chartes disponibles dans ChainEdit. A partir de cet écran vous pouvez ajouter, modifier ou supprimer une charte. Pour pouvoir modifier ou supprimer une charte vous devez au préalable en sélectionner une dans la liste puis cliquer sur le bouton associé à l'opération que vous souhaitez effectuer. Une charte pour ChainEdit est un ensemble de traitements qui peuvent être exécutés dans l'objectif de produire un résultat (Html, OpenOffice, Flash,..). Liste des chartes

15 15 II.3.1 Ajouter une charte Ajouter une charte consiste à lui attribuer un identifiant unique et un libellé d'affichage. Il faut ensuite indiquer un fichier zip qui contient généralement : - un fichier XSD contenant le schéma XML qui permettra valider la conformité du fichier XML. - un fichier de configuration XML spécifique à ChainEdit qui permet de sélectionner les éléments du schéma qui seront traités, l'aide contextuelle associée et un nom en français pour ces éléments. Après le validation de la charte, un répertoire sera créé et le fichier zip sera décompressé dans ce répertoire (éviter de mettre un répertoire racine dans ce fichier). Il faut ensuite aller modifier la charte pour pouvoir définir les traitements qui seront exécutés. Ajouter une charte

16 16 II.3.2 Modifier une charte Après avoir ajouté une charte, il faut la modifier pour préciser les traitements qui seront associés à la charte. Modifier une charte consiste donc à ajouter, modifier ou supprimer des traitements. Il est également possible de gérer les répertoires associés à la charte pour la mettre à jour ou la modifier. Modifier une charte

17 17 II Gestion des traitements Un traitement est défini par un identifiant unique pour la charte. Par un type de traitement : - Autre pour indiquer un traitement html par exemple. - OpenOffice pour indiquer que ChainEdit devra créer un fichier Odt. Il est ensuite possible d'indiquer jusqu'à 10 traitements XSL qui seront enchaînés pour obtenir le résultat (il est conseillé de créer un fichier XSL qui appel tous les autres plutôt que d'enchaîner les appels dans ChainEdit). Il faut ensuite sélectionner les répertoires qui constituent la charte graphique. C'est à dire les répertoires contenant les scripts, les styles et les images de l'interface (dans le cas d'une génération html, il est conseillé de tout regrouper dans un seul répertoire). Enfin, il faut préciser les répertoires à créer, par exemple le répertoire qui contiendra le site (/site) et celui contenant les pages (/html). Pour chaque répertoire, il faut préciser : - si c'est un répertoire qui doit contenir la charte graphique. - si c'est un répertoire qui doit contenir les fichiers ressource du module (images, animations, vidéos,..). - si le répertoire est le répertoire par défaut qui contiendra le fichier index.html par exemple. Dans le cas d'un traitement OpenOffice, seules les ressources images seront traitées, il n'est pas nécessaire de préciser de répertoire dans lequel copier les ressources. Elles sont copiées à partir du fichier XML. La charte doit contenir l'ensemble des éléments OpenDocument (style.xml, /Pictures,..). Modifier un traitement

18 18

19 19 II.3.3 Supprimer une charte Pour supprimer une charte, vous devez au préalable l'avoir sélectionner dans la liste. Vous devrez alors confirmer la suppression. Attention, certaines générations pourraient ne plus fonctionner dans le cas d'une suppression de charte graphique! Supprimer une charte

20 20 II.4 GESTION DES PROJETS La gestion des projets permet de créer un projet en sélectionnant un schéma XML et en y associant les chartes qui pourront être exécutées sur les données qui seront saisies. Il est également possible d'associer les utilisateurs qui seront autorisés à intervenir sur le projet. L'interface de gestion des projets permet d'ajouter, modifier ou supprimer des projets. Gestion des projets

21 21 II.4.1 Ajouter un projet Pour ajouter un projet, il faut saisir un identifiant et un libellé. Il faut ensuite sélectionner un fichier de configuration ChainEdit. Il faut ensuite préciser la liste des chartes qui pourront être utilisées sur ce projet. Enfin, il faut définir les différents intervenants du projet : - Les responsables du projet qui pourront modifier les paramètres du projet ou le supprimer. - Les auteurs qui pourront saisir le module. - Les visiteurs qui pourront voir le module et le générer mais pas le modifier. Ajouter un projet

22 22 II.4.2 Modifier un projet Pour modifier un projet, il faut sélectionner un projet dans la liste. Il n'est pas possible de modifier le fichier de configuration associé, ni l'identifiant du projet. Il est ensuite possible de préciser la liste des chartes qui pourront être utilisées sur ce projet. Il est également possible de définir les différents intervenants du projet : - Les responsables du projet qui pourront modifier les paramètres du projet ou le supprimer. - Les auteurs qui pourront saisir le module. - Les visiteurs qui pourront voir le module et le générer mais pas le modifier. Il est enfin possible de gérer l'ensemble des fichiers et répertoires du projet (ajouter un répertoire ou un fichier image par exemple). Modifier un projet

23 23 Gérer les répertoires Cette interface permet de gérer directement l'ensemble des ressources associées à un projet.

24 24 II.4.3 Supprimer un projet Supprimer un projet va supprimer l'ensemble des données associées au projet. Attention! toutes les données seront perdues (il est judicieux de s'assurer auprès de l'administrateur que les données du serveur sont régulièrement sauvegardées). Supprimer un projet III UTILISATION INTRODUCTION Un utilisateur peut modifier le contenu d'un projet ou générer un résultat en fonction des chartes associées. Un utilisateur peut également modifier son profil pour changer ses information personnelles ou son mot de passe.

25 25 III.1 TRAVAILLER SUR UN PROJET Un utilisateur peut modifier le contenu d'un projet en fonction du schéma associé au projet. Il peut également générer un résultat en fonction des chartes associées au projet. Ainsi, il est possible, pour un même projet de générer plusieurs chartes graphique. Par exemple, ce manuel peut donner lieu à un résultat aux couleurs de Rennes 1, du campus Envam ou en OpenOffice au couleur de Rennes 1. Plusieurs utilisateurs peuvent travailler simultanément sur un même projet. Il est conseiller de partager la saisie des données de façon intelligente. Par exemple, un chapitre par personne qui doit faire la saisie. De même, la génération se faisant dans le même répertoire, si deux personnes génèrent le même projet dans deux chartes différentes, le dernier qui aura généré obtiendra le résultat souhaité. Il est donc nécessaire de coordonner le travail des différents intervenants. Pour éditer un projet il faut cliquer sur ouvrir. Pour générer un résultat, il faut cliquer sur générer. Liste des projets

26 26 III.1.1 Editer un projet L'écran d'édition d'un projet permet de : - visualiser sous la forme d'un arbre les différents éléments sémantiques qui composent le document. - monter, descendre, couper, copier et coller ces éléments. - ajouter, depuis une liste d'éléments triée en fonction de l'élément sélectionné dans l'arbre, un élément sémantique. - sur la partie droite, saisir les informations relatives à l'élément sélectionné. - vérifier la conformité de la saisie avec la description du schéma XML. - rechercher un mot dans l'ensemble des éléments sémantiques. C'est le coeur de l'application ChainEdit. Editer un projet REMARQUE

27 27 En fonction de la configuration du projet, vous pouvez également disposer d'une aide en ligne pour la saisie des informations.

28 28 III.1.2 Générer le résultat Pour pouvoir générer un réultat, il faut au préalable avoir sélectionner un projet dans la liste et avoir cliqué sur générer. Il apparaît alors un écran qui permet de sélectionner une charte et l'un des traitements associés à cette charte. Il est également possible de préciser si vous souhaiter obtenir le résultat sous forme d'une archive compressée (zip) que vous pourrez télécharger. Dans le cas d'un résultat OpenOffice, le contenu sera automatiquement compressé et un fichier OpenOffice (odt) sera proposé au téléchargement. Choix de la génération Génération Html

29 Génération OpenOffice 29

30 30 III.2 GESTION DU PROFIL UTILISATEUR Cet écran permet de saisir les éléments complémentaires du profil de l'utilisateur et de changer son mot de passe (ne fonctionne que si le mot de passe est géré par ChainEdit, en cas d'utilisation d'un annuaire LDAP, cette opération est inutile). Il est également possible de préciser la fonction de l'utilisateur. Profil utilisateur

31 31 IV ANNEXES IV.1 ANNEXE ICÔNES DE L'INTERFACE Ces icônes sont donnés à titre indicatif. Il est possible qu'ils soient modifiés lors de la personnalisation de l'application par un établissement. Icônes de l'interface Aide en ligne pour la saisie