Author: jcouteau Date: 2010-04-14 14:35:27 +0000 (Wed, 14 Apr 2010) New Revision: 447 Log: Update doc Added: trunk/src/site/resources/admin/general_actions.png trunk/src/site/resources/coordinator/ trunk/src/site/resources/coordinator/comment_sampling_plan.png trunk/src/site/resources/user/actions.png trunk/src/site/rst/coordinator.rst trunk/src/site/rst/coordinator/ trunk/src/site/rst/coordinator/boats.rst trunk/src/site/rst/coordinator/contacts.rst trunk/src/site/rst/coordinator/echantillonage.rst trunk/src/site/rst/coordinator/syntheses.rst trunk/src/site/rst/observer.rst trunk/src/site/rst/user.rst Modified: trunk/src/site/resources/admin/users.png trunk/src/site/resources/user/syntheses.png trunk/src/site/rst/admin/contacts.rst trunk/src/site/rst/admin/echantillonage.rst trunk/src/site/rst/admin/syntheses.rst trunk/src/site/rst/admin/users.rst trunk/src/site/rst/user/contacts.rst trunk/src/site/rst/user/echantillonage.rst trunk/src/site/rst/user/syntheses.rst trunk/src/site/site_fr.xml Added: trunk/src/site/resources/admin/general_actions.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/admin/general_actions.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/src/site/resources/admin/users.png =================================================================== (Binary files differ) Added: trunk/src/site/resources/coordinator/comment_sampling_plan.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/coordinator/comment_sampling_plan.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/user/actions.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/user/actions.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/src/site/resources/user/syntheses.png =================================================================== (Binary files differ) Modified: trunk/src/site/rst/admin/contacts.rst =================================================================== --- trunk/src/site/rst/admin/contacts.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/admin/contacts.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -41,4 +41,10 @@ .. image:: validate_contacts.png :width: 800px - \ No newline at end of file + +Réduire la vue +============== + +Pour réduire la vue (n'afficher que les informations les plus pertinentes), +cliquez sur le lien correspondant. Vous pouvez revenir à la vue normale en +recliquant sur ce même lien. Modified: trunk/src/site/rst/admin/echantillonage.rst =================================================================== --- trunk/src/site/rst/admin/echantillonage.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/admin/echantillonage.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -24,7 +24,8 @@ ============================== Vous pouvez afficher le plan d'échantillonage sur une période de temps donnée -grace aux filtres situés au dessus du plan. +grace aux filtres situés au dessus du plan. Vous pouvez accéder aux filtres +avancés en cliquant sur le lien 'Recherche avancée'. Pour chaque ligne du plan, vous avez 4 actions disponibles : @@ -37,6 +38,15 @@ Ces actions peuvent être non disponible suivant le statut de la ligne. +Vous avez aussi 4 actions disponibles pour le plan : + +* Exporter le plan d'échantillonage +* Changer l'affichage de l'effort d'observation +* Réduire le plan d'échantillonage +* ajouter une nouvelle ligne + +.. image:: general_actions.png + Voir les navires elligibles pour la ligne ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, @@ -66,9 +76,30 @@ Cette action supprime la ligne du plan. -Ajouter une ligne du plan -,,,,,,,,,,,,,,,,,,,,,,,,, +Exporter le plan d'échantillonage +,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, +Cette action exporte le plan d'échantillonage affiché (pour les mêmes dates) au +format CSV + +Changer l'affichage de l'effort d'observation +,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, + +Cette action change l'affichage de l'effort d'observation. Les deux modes +d'affichage disponible sont : + +* planifié (réalisé) +* planifié (réalisé + estimé) + +Réduire le plan d'échantillonage +,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, + +Cette action supprime de l'affichage certaines colonnes afin de ne garder à +l'écran que les informations principales + +Ajouter une nouvelle ligne +,,,,,,,,,,,,,,,,,,,,,,,,,, + Cette cinquième action est disponible à l'aide de l'icone 'plus' situé au-dessus, à droite du plan d'échantillonage. Modified: trunk/src/site/rst/admin/syntheses.rst =================================================================== --- trunk/src/site/rst/admin/syntheses.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/admin/syntheses.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -1,9 +1,14 @@ Les synthèses ------------- -L'écran de synthèse permet de visualiser graphiquement la réalisation du plan -d'échantillonage. Vous pouvez filtrer par société, par façade, date, ... +L'écran de synthèse permet de visualiser graphiquement plusieurs indicateurs +tels que : -.. image:: synthese.png +- la réalisation du plan d'échantillonage. Vous pouvez filtrer par façade, date, ... +- la sollicitation des navires +- le non-respect du nombre d'observateurs embarqués +- l'état des contacts +- la réactivité de la saisie dans Allegro + +.. image:: ../user/syntheses.png :width: 800px - \ No newline at end of file Modified: trunk/src/site/rst/admin/users.rst =================================================================== --- trunk/src/site/rst/admin/users.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/admin/users.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -36,9 +36,9 @@ navigation, le nouvel ne sera pas sauvegardé à moins que vous ne cliquiez sur la disquette. -On peut rendre un utilisateur administrateur de l'application. Attention, il -est conseillé de réserver les droits d'administration à un très petit nombre de -personnes. +On peut choisir le rôle de l'utilisateur ainsi que sa visibilité (lecture seule +ou non). Un utilisateur en lecture seule ne pourra que consulter l'application, +il ne pourra y effectuer aucunne modification. Comme pour les sociétés, il est possible de rendre un utilisateur inactif. Un utilisateur inactif ne peut se connecter à l'application. @@ -56,4 +56,15 @@ le mot de passe est envoyé par e-mail à l'utilisateur (grace à son identifiant de connection). Si l'identifiant de connection n'est pas un e-mail, il est préférable de rentrer le mot de passe à la main et de le transmettre oralement à -l'utilsiateur. \ No newline at end of file +l'utilsiateur. + +Les roles +$$$$$$$$$ + +Il y a trois rôles disponibles : observateur, coordinateur et administrateur. Un +administrateur a accès a toutes les données de l'application, un observateur +peut créer des contacts, un coordinateur peut valider les données de sa société +et réaliser des imports/exports. + +Attention, il est conseillé de réserver les droits d'administration à un très +petit nombre de personnes. Added: trunk/src/site/rst/coordinator/boats.rst =================================================================== --- trunk/src/site/rst/coordinator/boats.rst (rev 0) +++ trunk/src/site/rst/coordinator/boats.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,7 @@ +Les navires +=========== + +L'écran des navires est le même pour un observateur et un coordinateur. Veuillez +vous référer à la `documentation observateur`_ pour plus d'informations. + +.. _documentation observateur: ../user/boats.html Added: trunk/src/site/rst/coordinator/contacts.rst =================================================================== --- trunk/src/site/rst/coordinator/contacts.rst (rev 0) +++ trunk/src/site/rst/coordinator/contacts.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,72 @@ +Gérer les contacts +================== + +La page des contacts reprends tous les contacts de la société. Il est possible +de modifier un contact pour mettre à jour son statut et les informations qui +lui sont associées et valider un embarquement. + +Modifier/mettre à jour un contact +--------------------------------- + +Pour modifier un contact, il faut cliquer sur l'icone 'modification'. Cela ouvre +la ligne du tableau en édition. Vous pouvez modifier le contact et enregistrer. + +.. image:: contacts_modification.png + :width: 800px + +Suivant le statut du contact, certaines informations sont nécessaires. Ces +informations sont vérifiées à l'enregistrement et un message vous indique les +informations manquantes si besoin. + +.. image:: contacts_verification.png + :width: 800px + +Supprimer un contact +-------------------- + +Il est possible de supprimer un contact non validé en cliquant sur l'icone +'poubelle' correspondant. + +Valider un embarquement +----------------------- + +Quand un contact est passé au statut 'Embarquement réalisé', il est possible de +le valider afin que l'embarquement soit comptabilisé comme réalisé. Pour ce +faire, il faut valider en cliquant sur l'icone de validation. Il est aussi +possible de refuser un embarquement réaliser en cliquant sur l'icone de refus. + +.. image:: contacts_validation.png + :width: 800px + +Il y a 2 validations : une validation venant de la société et une validation +venant des administrateurs. L'embarquement n'est compté comme réalisé qu'une +fois qu'il est complètement validé. + +Note : il est possible de changer sa validation tant qu'un embarquement n'est +pas validé par les deux parties en cliquant sur l'icone point d'interrogation. +Les lignes sur fond vert ne peuvent être modifiées. + +Importer les contacts +--------------------- + +Cliquez sur le lien import/export pour +afficher le formulaire approprié. Sélectionnez le fichier à importer et +validez (flèche vers le bas). + +Fichier d' import_ . + +.. _import: ../import/contacts.html + +Un message vous annonce le résultat de l'import. + +.. image:: ../admin/import_contacts_success.png + :width: 800px + +Exporter les contacts +--------------------- + +Cliquez sur le lien import/export pour +afficher le formulaire approprié. Cliquez sur la flèche vers le haut pour +télécharger un fichier csv contenant les contacts effectués. + +.. image:: ../admin/export_contacts.png Added: trunk/src/site/rst/coordinator/echantillonage.rst =================================================================== --- trunk/src/site/rst/coordinator/echantillonage.rst (rev 0) +++ trunk/src/site/rst/coordinator/echantillonage.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,23 @@ +Le plan d'échantillonage +======================== + +L'écran du plan d'échantillonage vous permet de visualiser rapidement le plan +d'échantillonage, son avancement et les embarquements à réaliser. + +Le mois en cours est représenté en jaune dans le tableau. Dans chaque case du +plan d'échantillonage, sont indiqué le planifié et le réalisé entre parenthèses. +La couleur du nombre entre parenthèses indique si un déficit ou non +d'embarquement. + +A partir du plan d'échantillonage, il est possible de visionner les bateaux +susceptibles d'accueillir un observateur en cliqaunt sur l'icone 'bateau' à +droite du plan, pour la ligne concernée. + +.. image::../user/sampling_plan.png + :width: 800px + +Il est aussi possible d'envoyer un message aux administrateur à propos d'une +ligne du plan. Ce message est intégré à l'historique de le ligne du plan. + +.. image::comment_sampling_plan.png + :width: 800px Added: trunk/src/site/rst/coordinator/syntheses.rst =================================================================== --- trunk/src/site/rst/coordinator/syntheses.rst (rev 0) +++ trunk/src/site/rst/coordinator/syntheses.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,15 @@ +Les synthèses +------------- + +L'écran de synthèse permet de visualiser graphiquement plusieurs indicateurs +tels que : + +- la réalisation du plan d'échantillonage. Vous pouvez filtrer par façade, date, ... +- la sollicitation des navires +- le non-respect du nombre d'observateurs embarqués +- l'état des contacts +- la réactivité de la saisie dans Allegro + +.. image:: ../user/syntheses.png + :width: 800px + Added: trunk/src/site/rst/coordinator.rst =================================================================== --- trunk/src/site/rst/coordinator.rst (rev 0) +++ trunk/src/site/rst/coordinator.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,18 @@ +Coordinateurs +------------- + +Cette documentation regroupe les actions disponibles pour les utilisateurs ayant +le rôle 'coordinateur' : + +* `Le plan dechantillonage`_ +* `La base des navires`_ +* `Les contacts`_ +* `Les syntheses`_ + +.. _Le plan dechantillonage:: coordinator/echantillonage.html + +.. _La base des navires:: coordinator/boats.html + +.. _Les contacts:: coordinator/contacts.html + +.. _Les syntheses:: coordinator/syntheses.html Added: trunk/src/site/rst/observer.rst =================================================================== --- trunk/src/site/rst/observer.rst (rev 0) +++ trunk/src/site/rst/observer.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,17 @@ +Observateurs +------------ + +Cette documentation regroupe les actions disponibles pour les utilisateurs ayant +le rôle 'observateur' : + +* `Le plan dechantillonage`_ +* `La base des navires`_ +* `Les contacts`_ +* `Les syntheses`_ +* `Creer un contact`_ + +.. _Le plan dechantillonage:: user/echantillonage.html +.. _La base des navires:: user/boats.html +.. _Les contacts:: user/contacts.html +.. _Les syntheses:: user/syntheses.html +.. _Creer un contact:: user/createAContact.html Modified: trunk/src/site/rst/user/contacts.rst =================================================================== --- trunk/src/site/rst/user/contacts.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/user/contacts.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -3,7 +3,7 @@ La page des contacts reprends tous les contacts de la société. Il est possible de modifier un contact pour mettre à jour son statut et les informations qui -lui sont associées et valider un embarquement. +lui sont associées. Modifier/mettre à jour un contact --------------------------------- @@ -26,22 +26,3 @@ Il est possible de supprimer un contact non validé en cliquant sur l'icone 'poubelle' correspondant. - -Valider un embarquement (coordinateur) --------------------------------------- - -Quand un contact est passé au statut 'Embarquement réalisé', il est possible de -le valider afin que l'embarquement soit comptabilisé comme réalisé. Pour ce -faire, il faut valider en cliquant sur l'icone de validation. Il est aussi -possible de refuser un embarquement réaliser en cliquant sur l'icone de refus. - -.. image:: contacts_validation.png - :width: 800px - -Il y a 2 validations : une validation venant de la société et une validation -venant des administrateurs. L'embarquement n'est compté comme réalisé qu'une -fois qu'il est complètement validé. - -Note : il est possible de changer sa validation tant qu'un embarquement n'est -pas validé par les deux parties en cliquant sur l'icone point d'interrogation. -Les lignes sur fond vert ne peuvent être modifiées. \ No newline at end of file Modified: trunk/src/site/rst/user/echantillonage.rst =================================================================== --- trunk/src/site/rst/user/echantillonage.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/user/echantillonage.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -6,14 +6,30 @@ Le mois en cours est représenté en jaune dans le tableau. Dans chaque case du plan d'échantillonage, sont indiqué le planifié et le réalisé entre parenthèses. -La couleur du nombre entre parenthèses indique si un déficit ou non +La couleur du nombre entre parenthèses indique si il y a un déficit ou non d'embarquement. +Vous pouvez filtrer l'affichage du plan d'échantillonage à l'aide des filtres +situés au dessus du plan d'échantillonage. Pour accéder aux filtres avancées, +cliquez sur le lien 'Recherche avancée'. + A partir du plan d'échantillonage, il est possible de visionner les bateaux -susceptibles d'accueillir un observateur en cliqaunt sur l'icone 'bateau' à +susceptibles d'accueillir un observateur en cliquant sur l'icone 'bateau' à droite du plan, pour la ligne concernée. .. image::sampling_plan.png :width: 800px +Actions disponibles +,,,,,,,,,,,,,,,,,,, +Plusieurs actions sont disponibles sur le plan d'échantillonage. Vous pouvez y +accéder grace aux icones situés à côté du titre de la page. + +.. image::actions.png + +* Exporter le plan d'échantillonage en CSV (non accessible en lecture seule) +* Changer l'affichage de l'effort d'observation + + + Modified: trunk/src/site/rst/user/syntheses.rst =================================================================== --- trunk/src/site/rst/user/syntheses.rst 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/rst/user/syntheses.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -1,10 +1,15 @@ Les synthèses ------------- -L'écran de synthèse permet de visualiser graphiquement la réalisation du plan -d'échantillonage. Vous pouvez filtrer par façade, date, ... +L'écran de synthèse permet de visualiser graphiquement plusieurs indicateurs +tels que : +- la réalisation du plan d'échantillonage. Vous pouvez filtrer par façade, date, ... +- la sollicitation des navires +- le non-respect du nombre d'observateurs embarqués +- l'état des contacts +- la réactivité de la saisie dans Allegro + .. image:: syntheses.png :width: 800px - \ No newline at end of file Added: trunk/src/site/rst/user.rst =================================================================== --- trunk/src/site/rst/user.rst (rev 0) +++ trunk/src/site/rst/user.rst 2010-04-14 14:35:27 UTC (rev 447) @@ -0,0 +1,13 @@ +Utilisateurs +------------ + +Cette documentation regroupe toutes les actions communes à tous les +utilisateurs : + +* `Se connecter`_ +* `Compte utilisateur`_ +* `La page d'accueil`_ + +.. _Se connecter:: user/authentication.html +.. _Compte utilisateur:: user/account.html +.. _La page daccueil:: user/news.html Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2010-04-14 10:23:08 UTC (rev 446) +++ trunk/src/site/site_fr.xml 2010-04-14 14:35:27 UTC (rev 447) @@ -41,10 +41,14 @@ <item name="Gérer la page d'accueil" href="admin/news.html"/> </item> - <item name="Utilisateur" href="#"> + <item name="Utilisateur" href="user.html"> <item name="Se connecter" href="user/authentication.html"/> <item name="Mon compte utilisateur" href="user/account.html"/> <item name="La page d'accueil" href="user/news.html"/> + + </item> + + <item name="Observateur" href="observer.html"> <item name="Le plan d'échantillonage" href="user/echantillonage.html"/> <item name="La base des navires" href="user/boats.html"/> <item name="Les contacts" href="user/contacts.html"/> @@ -52,12 +56,20 @@ <item name="Créer un contact" href="user/createAContact.html"/> </item> + <item name="Coordinateur" href="coordinator.html"> + <item name="Le plan d'échantillonage" href="coordinator/echantillonage.html"/> + <item name="La base des navires" href="coordinator/boats.html"/> + <item name="Les contacts" href="coordinator/contacts.html"/> + <item name="Les synthèses" href="coordinator/syntheses.html"/> + </item> + <item name="Import/Export" href="import/samplingPlan.html"> <item name="Plan d'échantillonnage" href="import/samplingPlan.html"/> <item name="Navires" href="import/boats.html"/> <item name="Contacts" href="import/contacts.html"/> <!--<item name="Calendrier d'activité" href="import/activityCalendar.html"/>--> </item> + <item name="Conception/Données" href="usecases.html"> <item name="Cas d'utilisations" href="usecases.html"/> <item name="Règles métier" href="business-rules.html" />