Author: nrannou Date: 2009-08-27 17:01:18 +0200 (Thu, 27 Aug 2009) New Revision: 2759 Added: trunk/src/site/resources/tutoriel/ trunk/src/site/resources/tutoriel/Capture-1.png trunk/src/site/resources/tutoriel/Capture-2.png trunk/src/site/resources/tutoriel/Capture-3.png trunk/src/site/resources/tutoriel/Capture-4.png trunk/src/site/resources/tutoriel/Capture-5.png trunk/src/site/resources/tutoriel/Capture-6.png trunk/src/site/resources/tutoriel/Capture.png trunk/src/site/rst/user/ trunk/src/site/rst/user/install.rst trunk/src/site/rst/user/tutoriel.rst Modified: trunk/src/site/site.xml Log: documentation utilisateur Added: trunk/src/site/resources/tutoriel/Capture-1.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture-1.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/tutoriel/Capture-2.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture-2.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/tutoriel/Capture-3.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture-3.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/tutoriel/Capture-4.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture-4.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/tutoriel/Capture-5.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture-5.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/tutoriel/Capture-6.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture-6.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/tutoriel/Capture.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/tutoriel/Capture.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/rst/user/install.rst =================================================================== --- trunk/src/site/rst/user/install.rst (rev 0) +++ trunk/src/site/rst/user/install.rst 2009-08-27 15:01:18 UTC (rev 2759) @@ -0,0 +1,46 @@ +Installation +============ + +:Author: Nolwenn Rannou <rannou@codelutin.com> +:Revision: $Revision$ +:Date: $Date$ + +Pour installer l'application il suffit de déployer l'archive war dans un conteneur Web comme Tomcat. + +Par défaut une base de donnée H2 est créée dans le répertoire */tmp*. Pour modifier ce comportement par défaut il suffit de créer le fichier */etc/pollen.properties* et de le remplir avec les propriétés suivantes :: + + # Configuration de la base de données + hibernate.show_sql=false + hibernate.dialect=org.hibernate.dialect.H2Dialect + hibernate.connection.username=username + hibernate.connection.password=password + hibernate.connection.driver_class=org.h2.Driver + hibernate.connection.url=jdbc:h2:file://tmp/pollen/pollen + + # Répertoire des images transférées + upImgDir=/tmp/pollen/uploadedImages + + # Taille maximal des images transférées (en octets) + upload.filesize-max=1048576 + upload.requestsize-max=10485760 + + # Configuration de l'envoi d'emails automatiques + email_host=smtp.free.fr + email_port=25 + email_from=bot@pollen.org + + # Répertoire des flux de syndication (Atom) + feedDir=/tmp/pollen/feeds + + # Adresse du site (utilisée pour les emails de rappel) + siteUrl=http://www.site.org/pollen/ + +Pour une base PostgreSQL on aura :: + + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + hibernate.connection.driver_class=org.postgresql.Driver + hibernate.default_schema=public + +Il peut-être nécessaire de redéployer l'application après avoir modifié ce fichier. + +Un utilisateur avec les droits d'administration est créé automatiquement (identifiant "admin", mot de passe "pollen"). Par mesure de sécurité il est important de supprimer cet utilisateur après avoir créer un autre compte. Property changes on: trunk/src/site/rst/user/install.rst ___________________________________________________________________ Added: svn:keywords + "Author Date Id Rev Revision" Added: trunk/src/site/rst/user/tutoriel.rst =================================================================== --- trunk/src/site/rst/user/tutoriel.rst (rev 0) +++ trunk/src/site/rst/user/tutoriel.rst 2009-08-27 15:01:18 UTC (rev 2759) @@ -0,0 +1,78 @@ +Tutoriel +======== + +:Author: Nolwenn Rannou <rannou@codelutin.com> +:Revision: $Revision$ +:Date: $Date$ + +Nous allons voir à travers un exemple comment créer un sondage avec Pollen. Les trois étapes nécessaires sont les suivantes : la création, le vote et la visualisation des résultats. + +Création +-------- + +La première étape consiste à fournir les informations générales à propos du sondage et de son créateur. Tous les champs ne sont pas obligatoires. Le type de sondage est défini par l'un des termes suivants : + +- **Free** : accessible à tout le monde +- **Restricted** : accessible uniquement à une liste de votants +- **Group** : accessible à plusieurs listes de votants + +Le type de dépouillement correspond à un l'un des suivants : + +- **Normal** : sélection de 1 ou n choix parmis les choix possibles +- **Percentage** : attribution d'un pourcentage à chaque choix +- **Condorcet** : classement des choix par ordre de préférence (cf `Condorcet`_ ) + +.. _Condorcet: http://fr.wikipedia.org/wiki/M%C3%A9thode_Condorcet + +.. image:: ../tutoriel/Capture.png + :alt: Création : étape 1 + +La deuxième étape permet de spécifier des options pour le sondage. Les icônes en forme de point d'interrogation permettent d'afficher des aides : + +- Sondage anonyme : les votants ainsi que leurs votes sont anonymes +- Autoriser le vote anonyme : les votants peuvent être anonymes +- Résultats continus : les résultats du sondage sont affichés en continu au moment du vote +- Résultats publics : les résultats du sondage sont consultables par tout le monde +- Autoriser l'ajout de choix : il est possible d'ajouter des choix au sondage à partir de la date donnée +- Limiter le nombre de choix par vote : le nombre de choix que l'utilisateur peut sélectionner est limité +- Recevoir des emails de notification : un email est envoyé tous les N votes pour prevenir le créateur +- Envoyer des emails de rappel : un email de rappel est envoyé aux votants qui n'ont pas encore voté N heures avant la fin du sondage + +.. image:: ../tutoriel/Capture-1.png + :alt: Création : étape 2 + +La troisième étape ne concerne que les votes restreints ou par groupe. Si vous êtes connecté vous pouvez utiliser des listes prédéfinies pour remplir les groupes de votants (le sondage sélectionné apparaît en gris). Sinon il faut saisir leurs noms et emails. Il est aussi possible de donner un poids à chaque votant ainsi qu'aux groupes. + +.. image:: ../tutoriel/Capture-2.png + :alt: Création : étape 3 + +La quatrième étape sert à indiquer les choix du sondage. Les choix peuvent être de type texte, date ou image. On peut préciser également une description par choix. + +.. image:: ../tutoriel/Capture-3.png + :alt: Création : étape 4 + +Une fois le sondage créé, une page indique deux adresses. La première est l'adresse de vote à envoyer aux votants (automatique si des emails ont été rensignés). La seconde est l'adresse de modification du sondage qui doit rester privé (elle permet aussi de clore le sondage). + +.. image:: ../tutoriel/Capture-4.png + :alt: Création : liens + +Vote +---- + +La page de vote contient un rappel des informations du sondage ainsi qu'une représentation des votes de chaque votant. Le créateur du sondage ainsi que le votant concerné peuvent modifier un vote. Si le sondage est public, il est possible de voir les résultats. De plus, l'actualité du sondage peut être suivie par flux Atom et on peut poster des commentaires. + +.. image:: ../tutoriel/Capture-5.png + :alt: Vote + +Résultats +--------- + +La page de résultats permet de visualiser les résultats du sondage sous la forme d'un diagramme. Elle rappel les informations du sondage et indique le vainqueur. Plusieurs affichage sont disponibles : cammembert, cammenbert 3D et anneau. + +.. image:: ../tutoriel/Capture-6.png + :alt: Résultats + +Autres fonctionnalités +---------------------- + +Un utilisateur identifié a accès à d'autres fonctionnalités. Il peut notamment voir la liste des sondages qu'il a créé ou auxquels il a participé. Il peut aussi créer des listes de votants manuellement ou à partir d'un fichier CSV ou d'une url LDAP. Un administrateur peut quant à lui gérer l'ensemble des sondages et des utilisateurs. Property changes on: trunk/src/site/rst/user/tutoriel.rst ___________________________________________________________________ Added: svn:keywords + "Author Date Id Rev Revision" Modified: trunk/src/site/site.xml =================================================================== --- trunk/src/site/site.xml 2009-08-27 09:58:50 UTC (rev 2758) +++ trunk/src/site/site.xml 2009-08-27 15:01:18 UTC (rev 2759) @@ -52,6 +52,10 @@ <!--item name="Téléchargement" href="http://labs.libre-entreprise.org/frs/?group_id=41"/--> </menu> + <menu name="Utilisateur"> + <item name="Installation" href="user/install.html"/> + <item name="Tutoriel" href="user/tutoriel.html"/> + </menu> <menu name="Développeur"> <item name="Analyse" href="developper/analyse.html"/> <item name="Architecture" href="developper/architecture.html"/>