Documentation with PW screen captures

This commit is contained in:
Pierre Cros 2012-12-01 12:23:25 +01:00
parent 57ae238aba
commit b40c86cc2d
31 changed files with 415 additions and 0 deletions

61
help/fr/admin-all.page Normal file
View File

@ -0,0 +1,61 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-all" xml:lang="fr">
<info>
<link type="guide" xref="admin" group="all"/>
<desc>Pour administrer les types de fichier, les descriptions de contenu, les archives et les logs. Il faut être administrateur général pour pouvoir le faire</desc>
</info>
<title>Autres paramètres</title>
<p>D'autres paramètres sont accessibles aux administrateurs généraux : gestion des types de fichier, des descriptions de contenu, des archives et des logs.</p>
<section id="types">
<title>Types de fichier</title>
<p>Cet écran permet à un administrateur général de créer, modifier et supprimer des types de fichier.</p>
<figure>
<title>Types de fichier</title>
<media type="image" mime="image/png" src="figures/types-de-fichier.png" >
</media>
</figure>
</section>
<section id="description">
<title>Descriptions des contenus</title>
<p>Cet écran permet à un administrateur général de créer, modifier et supprimer des types de contenu.</p>
<figure>
<title>Descriptions des contenus</title>
<media type="image" mime="image/png" src="figures/description-des-contenus.png" >
</media>
</figure>
</section>
<section id="logs">
<title>Gestion des logs et de l'horodatage</title>
<p>Les tickets d'horodatage sont disponibles dans les traces. C'est un horodatage respectant la norme RFC3161, composé d'un jeton au format JSON contenant tous les détails de l'envoi d'un document dont entre autre l'expéditeur et la liste des destinataires, ainsi que les condensats des différents fichiers transmis.</p>
<figure>
<title>Logs et horodatage</title>
<media type="image" mime="image/png" src="figures/logs.png" >
</media>
</figure>
</section>
<section id="archives">
<title>Gestion des archives</title>
<p>Un administrateur général peut visionner et supprimer les messages envoyés et reçus sur la plate-forme pour tous les utilisateurs grâce aux liens « messages reçus » et « messages envoyés ».</p>
</section>
<section id="fin">
<title></title>
<note>
<title>Réinitialiser la plate-forme</title>
<p>À la fin de chaque exercice, la plate-forme est réinitialisée. Cela signifique l'ensemble des messages et des logs sont compressés et archivés avant d'être effacés pour permettre le bon déroulement du nouvel exercice.</p>
</note>
</section>
</page>

29
help/fr/admin-listes.page Normal file
View File

@ -0,0 +1,29 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-listes" xml:lang="fr">
<info>
<link type="guide" xref="admin" group="listes"/>
<desc>Pour faire une liste d'envoi regroupant plusieurs utilisateurs. Il faut être administrateur des listes pour pouvoir le faire.</desc>
</info>
<title>Listes d'envoi</title>
<p>L'interface permet de créer une liste en cliquant sur le bouton ajouter une liste et en donnant simplement un nom à cette dernière. Il convient ensuite de sélectionner les utilisateurs devant faire partie de cette liste. Le rôle d'un administrateur de liste s'arrête ici.</p>
<figure>
<title>Gérer une liste</title>
<media type="image" mime="image/png" src="figures/modification-liste-destinataires.png" >
</media>
</figure>
<p>
Un administrateur général pourra en plus choisir un certain nombre de limitations pour les liste en cliquant sur le lien « Limitations par liste de destinataires ». Il choisira alors la liste concernée et lui appliquera des contraintes concernant les types de fichier et/ou les destinataires disponibles pour les utilisateurs faisant partie de cette liste.</p>
<figure>
<title>Limitations sur les listes</title>
<media type="image" mime="image/png" src="figures/limitations-listes.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,22 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-profils" xml:lang="fr">
<info>
<link type="guide" xref="admin" group="profils"/>
<desc>Définir les profils. Il faut être administrateur général pour pouvoir le faire</desc>
</info>
<title>Les profils</title>
<p>En cliquant sur profils depuis l'accueil de l'administration, on arrive sur l'interface de gestion des profils :</p>
<figure>
<title>Profils</title>
<media type="image" mime="image/png" src="figures/profils.png" >
</media>
</figure>
<p>Cet écran permet à un administrateur général de créer, modifier et supprimer des profils..</p>
</page>

View File

@ -0,0 +1,20 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-utilisateurs" xml:lang="fr">
<info>
<link type="guide" xref="admin" group="utilisateurs"/>
<desc>Créer, modifier et supprimer les utilisateurs sur la plate-forme. Il faut être administrateur général pour pouvoir le faire.</desc>
</info>
<title>Gestion des utilisateurs</title>
<p>Un administrateur général peut créer, modifier ou supprimer un utilisateur. Il peut également l'activer et le désactiver et choisir s'il est administrateur ou pas.</p>
<figure>
<title>Gestion d'un utilisateur</title>
<media type="image" mime="image/png" src="figures/utilisateur.png" >
</media>
</figure>
</page>

34
help/fr/admin.page Normal file
View File

@ -0,0 +1,34 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin" xml:lang="fr">
<info>
<link type="guide" xref="index" group="admin"/>
<desc>Pour administrer la plate-forme, gérer les utilisateurs et les différents paramètres.</desc>
</info>
<title>Administration de la plate-forme</title>
<p>Cette partie de la documentation est réservée aux utilisateurs ayant le droit d'agir sur le paramétrage et le fonctionnement de l'application. L'interface d'administration de la plate-forme est disponible en ajoutant /admin à l'URL.</p>
<figure>
<title>Accueil de l'administration</title>
<media type="image" mime="image/png" src="figures/admin.png" >
</media>
</figure>
<p>Les administrateurs sont de trois types :</p>
<list>
<item><p>les administrateurs de listes qui peuvent créer, modifier et supprimer des listes d'utilisateurs.</p></item>
<item><p>Les administrateurs de contact qui vont recevoir les messages envoyés via le formulaire de contact de l'application.</p></item>
<item><p>Les administrateurs généraux qui vont faire un certain nombres d'actions d'administration supplémentaires.</p></item>
</list>
<links type="topic" groups="
utilisateurs
profils
listes
all
"/>
</page>

20
help/fr/connexion.page Normal file
View File

@ -0,0 +1,20 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="connexion" xml:lang="fr">
<info>
<link type="guide" xref="index" group="connexion"/>
<desc>Comment se connecter à la plate-forme.</desc>
</info>
<title>Connexion</title>
<p>L'application fonctionne avec n'importe quel navigateur standard et sans plugin. Pour se connecter un utilisateur doit disposer d'un idenfiant et d'un mot de passe délivrés par le service informatique.</p>
<figure>
<title>Écran de connexion</title>
<media type="image" mime="image/png" src="figures/login.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,21 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="contact-administrateur" xml:lang="fr">
<info>
<link type="guide" xref="index" group="contact"/>
<desc>Comment demander de l'aide à un administrateur en cas de problème technique.</desc>
</info>
<title>Contacter un administrateur</title>
<p>Un lien permet aussi d'accéder à un formulaire de contact pour envoyer une information, poser une question, etc. aux administrateurs.</p>
<figure>
<title>Title</title>
<media type="image" mime="image/png" src="figures/contact.png" >
</media>
</figure>
<p>Les administrateurs répondront aux demandes par le biais d'un email classique.</p>
</page>

49
help/fr/delegation.page Normal file
View File

@ -0,0 +1,49 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="delegation" xml:lang="fr">
<info>
<link type="guide" xref="index" group="delegation"/>
<desc>Donner à une autre personne le droit d'accéder à votre compte.</desc>
</info>
<title>Délégation</title>
<p>Afin de permettre à un utilisateur d'agir au nom d'un tiers (pendant les vacances de ce dernier par exemple, ou pour permettre à un collaborateur d'agir au nom de son supérieur hiérarchique), il existe un mécanisme de délégation. Pour créer un compte délégué, il faut cliquer sur le lien « Gestion des délégations ».</p>
<section id="nonuser">
<title>Délégation à un utilisateur qui n'a pas de compte sur la plate-forme</title>
<p>Pour déléguer son compte à un utilisateur n'ayant pas de compte sur la plate-forme, on utilise cette partie de l'écran :</p>
<figure>
<title>Délégation et création d'un nouveau compte</title>
<media type="image" mime="image/png" src="figures/delegation.png" >
</media>
</figure>
<p>Il faut ensuite saisir les nom, prénom et email de la personne qui doit bénéficier d'un compte délégué. Cette personne recevra par mail les informations nécessaire à la connexion sur la plate-forme.</p>
</section>
<section id="user">
<title>Délégation à un utilisateur qui a un compte sur la plate-forme</title>
<p>Lorsque l'on délègue son compte à un utilisateur disposant déjà d'un compte sur la palte-forme, on utilise la liste des utilisateurs disponibles :</p>
<figure>
<title>Délégation à un utilisateur existant</title>
<media type="image" mime="image/png" src="figures/liste-utilisateurs-delegation.png" >
</media>
</figure>
<p>Il suffit alors de double-cliquer sur le nom de l'utilisateur devant recevoir la délégation.</p>
</section>
<section id="note">
<title></title>
<note>
<title></title>
<p>La nouvelle délégation créée apparaît en haut de l'écran et peut être supprimée à tout moment grâce à l'icone poubelle. Un compte délégué agit au nom du délégataire mais il n'est pas confondu avec lui : on sait que c'est le compte délégué qui agit.</p>
</note>
</section>
</page>

View File

@ -0,0 +1,50 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="envoyer-un-message" xml:lang="fr">
<info>
<link type="guide" xref="index" group="envoyer"/>
<desc>Envoyer un message depuis la plate-forme et voir les messages envoyés.</desc>
</info>
<title>Gérer les envois de messages</title>
<section id="envoi">
<title>Envoyer un message</title>
<p>Cliquez sur nouvel envoi pour accéder à l'écran d'envoi de message.</p>
<figure>
<title>Envoi de message</title>
<media type="image" mime="image/png" src="figures/nouvel-envoi.png" >
</media>
</figure>
<p>Il faut ensuite compléter 4 éléments :</p>
<steps>
<item><p>Le type de document qui correspond à une liste rassemblant tous les types de documents utilisés au parlement</p></item>
<item><p>Le(s) fichier(s) attaché(s) : le ou les documents que l'on souhaite envoyer</p></item>
<item><p>Le(s) destinataire(s) : le ou les personnes à qui l'on envoie les documents. Dans la liste des "destinataires disponibles" on peut sélectionner un seul ou plusieurs utilisateurs et les faire passer dans la liste des "destinataires choisis" avec la flèche prévue à cet effet. À noter que les liste de destinataires, regroupant plusieurs utilisateurs, apparaissent aussi dans la liste des "destinataires disponibles".</p></item>
<item><p>La description du contenu : la liste déroulante rassemble les description de contenus les plus courantes. Elle est utilisée pour remplir la zone texte immédiatement en dessous. Si aucune desciption de contenu courante ne convient, l'utilisateur peut supprimer/modifier le message dans la zone de texte pour mettre un texte plus adéquat.</p></item>
</steps>
<p>Il suffit alors de cliquer sur le bouton envoyer le document pour que le message soit expédié et stocké dans le dossier « messages envoyés ».</p>
</section>
<section id="voir">
<title>Voir les messages envoyés</title>
<p>Depuis votre boite de réception, cliquez sur « Messages envoyés » pour consulter la liste de vos envois.</p>
<figure>
<title>Liste des messages envoyés</title>
<media type="image" mime="image/png" src="figures/documents-envoyes.png" >
</media>
</figure>
<p>Tous les messages envoyés sont stockés ici jusqu'à suppression par l'utilisateur.</p>
</section>
</page>

BIN
help/fr/figures/admin.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

BIN
help/fr/figures/contact.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

BIN
help/fr/figures/login.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

BIN
help/fr/figures/logs.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

BIN
help/fr/figures/profils.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

35
help/fr/index.page Normal file
View File

@ -0,0 +1,35 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="index" xml:lang="fr">
<info>
<revision docversion="1.0" date="2012-07-13" status="stub"/>
<license>
<p>Ce travail est publié à la fois sous
<link href="http://creativecommons.org/licenses/by-sa/3.0/fr/">licence Creatice Commons Paternité - Partage à l'Identique 3.0</link>.
et sous <link href="http://www.gnu.org/licenses/gpl.html">licence GPL v3.</link></p>
</license>
<desc>DocBow est une plate-forme sécurisée d'échanges de documents développée par <link href="http://www.entrouvert.com/">Entr'ouvert</link></desc>
<credit type="author">
<name>Pierre Cros</name>
<email>pcros@entrouvert.com</email>
</credit>
</info>
<title>DocBow</title>
<p>DocBow (Documentation Box Wallone) est une plate-forme d'échanges sécurisée. Elle permet d'échanger des documents de manière fiable et certifiée (horodatée).</p>
<links type="topic" groups="
connexion
lire
envoyer
delegation
passe
contact
"/>
</page>

View File

@ -0,0 +1,35 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="lire-un-message" xml:lang="fr">
<info>
<link type="guide" xref="index" group="lire"/>
<desc>Lire un message depuis la plate-forme.</desc>
</info>
<title>Lire un message</title>
<p>Après connexion, l'utilisateur arrive directement sur l'écran "documents reçus". Le chiffre entre parenthèses à côté du texte "documents reçus" indique le nombre de messages non lus.</p>
<figure>
<title>Boite de réception</title>
<media type="image" mime="image/png" src="figures/documents-recus.png" >
</media>
</figure>
<p>Cet écran permet de voir la description du contenu du message, le nom du fichier envoyé, le nom de l'expéditeur et la date d'envoi. Une icône poubelle permet de supprimer le message.</p>
<p>Quand on clique sur un message on obtient plus d'informations et on peut télécharger le ou les fichiers qu'il contient.</p>
<figure>
<title>Détails du message</title>
<media type="image" mime="image/png" src="figures/details-message.png" >
</media>
</figure>
<note>
<title>Pourquoi un message ouvert apparaît-il comme non lu ?</title>
<p>Un message est considéré comme non lu tant que le document qu'il contient n'a pas été téléchargé.</p>
</note>
</page>

39
help/fr/mot-de-passe.page Normal file
View File

@ -0,0 +1,39 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="mot-de-passe" xml:lang="fr">
<info>
<link type="guide" xref="index" group="passe"/>
<desc>Changer ou récupérer son mot de passe.</desc>
</info>
<title>Gestion du mot de passe</title>
<section id="changer">
<title>Changer son mot de passe</title>
<p>Il est possible de changer de mot de passe en cliquant sur le lien approprié dans la colonne de gauche.</p>
<figure>
<title>Écran de connexion</title>
<media type="image" mime="image/png" src="figures/changement-du-mot-de-passe.png" >
</media>
</figure>
<p>Il faut allors saisir l'ancien mot de passe, puis le nouveau à deux reprises.</p>
</section>
<section id="recuperer">
<title>Demander un nouveau mot de passe en cas de perte</title>
<p>En cas de perte du mot de passe, il est possible depuis l'écran de connexion de demander à recevoir un mail contenant le nouveau mot de passe. Il suffit d'indiquer son mail ou son nom d'utilisateur pour cela.</p>
<figure>
<title>Réinitialiser son mot de passe</title>
<media type="image" mime="image/png" src="figures/reinitialisation-du-mot-de-passe.png" >
</media>
</figure>
<p>Un lien dans le mail reçu permet ensuite de diriger l'utilisateur vers un écran dans lequel il saisit le nouveau mot de passe choisi.</p>
</section>
</page>