Première version de la documentation polynum sur le git

This commit is contained in:
Pierre Cros 2012-06-11 17:34:14 +02:00
parent 7ecbb034da
commit 732c586a66
19 changed files with 396 additions and 0 deletions

14
help/fr/admin-admin.page Normal file
View File

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-admin" xml:lang="fr">
<info>
<link type="guide" xref="admin" group="admin-admin"/>
<desc>Les administrateurs de la plate-forme.</desc>
</info>
<title>Rôle Administrateur</title>
<p>Les administrateurs ont tous les droits sur la plate-forme, et en particulier celui de modifier le rôle des autres utilisateurs et les permissions qui y sont associées.</p>
</page>

14
help/fr/admin-budget.page Normal file
View File

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-budget" xml:lang="fr">
<info>
<link type="guide" xref="admin"/>
<desc>Rôle responsable budget reprographie.</desc>
</info>
<title>Rôle responsable budget reprographie</title>
<p></p>
</page>

View File

@ -0,0 +1,21 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-demandes" xml:lang="fr">
<info>
<link type="guide" xref="admin-valideur" group="demandes"/>
<link type="guide" xref="admin-admin" group="demandes"/>
<desc>Demandes de reprographie et lieux de livraison.</desc>
</info>
<title>Demandes</title>
<p></p>
<figure>
<title>Liste des demandes</title>
<media type="image" mime="image/png" src="figures/liste-demandes.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,31 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-documents" xml:lang="fr">
<info>
<link type="guide" xref="admin-admin" group="documents"/>
<link type="guide" xref="admin-reprographie" group="documents"/>
<desc>Gestion des documents (suppression, usages, diffusion)</desc>
</info>
<title>Gestion des documents</title>
<p></p>
<figure>
<title>Liste des documents</title>
<media type="image" mime="image/png" src="figures/liste-documents.png" >
</media>
</figure>
<section id="usages">
<title>Usages d'un document</title>
<p></p>
</section>
<section id="diffusion">
<title>Diffusion d'un document</title>
<p></p>
</section>
</page>

View File

@ -0,0 +1,20 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-groupes-et-utilisateurs" xml:lang="fr">
<info>
<link type="guide" xref="admin-admin" group="groupes"/>
<desc>Création, suppression, modification des groupes et des utilisateurs dans l'application.</desc>
</info>
<title>Groupes et utilisateurs</title>
<p></p>
<figure>
<title>Liste des utilisateurs</title>
<media type="image" mime="image/png" src="figures/liste-utilisateurs.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,21 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-profils-impression" xml:lang="fr">
<info>
<link type="guide" xref="admin-reprographie" group="profils-impression"/>
<link type="guide" xref="admin-admin" group="profils-impression"/>
<desc>Paramétrage des différents profils d'impression et de leurs options (papier, reliure, couleur...)</desc>
</info>
<title>Profils d'impression</title>
<p></p>
<figure>
<title>Profils d'impressions</title>
<media type="image" mime="image/png" src="figures/profils-impression.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-reprographie" xml:lang="fr">
<info>
<link type="guide" xref="admin"/>
<desc>Rôle service reprographie</desc>
</info>
<title>Rôle service reprographie</title>
<p></p>
</page>

20
help/fr/admin-roles.page Normal file
View File

@ -0,0 +1,20 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-roles" xml:lang="fr">
<info>
<link type="guide" xref="admin-admin" group="roles"/>
<desc>Définition des rôles et de leurs interactions avec les demandes à différentes étapes.</desc>
</info>
<title>Gestion des rôles</title>
<p></p>
<figure>
<title>Gestion des rôles</title>
<media type="image" mime="image/png" src="figures/roles.png" >
</media>
</figure>
</page>

14
help/fr/admin-tice.page Normal file
View File

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-tice" xml:lang="fr">
<info>
<link type="guide" xref="admin"/>
<desc>Rôle service TICE.</desc>
</info>
<title>Rôle service TICE</title>
<p></p>
</page>

View File

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin-valideur" xml:lang="fr">
<info>
<link type="guide" xref="admin"/>
<desc>Pour valider les demandes de reprographie.</desc>
</info>
<title>Rôle valideur</title>
<p></p>
</page>

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

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="admin" xml:lang="fr">
<info>
<link type="guide" xref="index"/>
<desc>Pour administrer la plate-forme, valider les demandes, gérer les différents paramètres de reprographie, le budget...</desc>
</info>
<title>Administrateurs et gestionnaires</title>
<p>Cette partie de la documentation est réservée aux utilisateurs ayant un rôle leur permettant d'accéder à l'interface d'administration de l'application : valideur, service reprographie, responsable du budget reprographie, service TICE et administrateurs.</p>
</page>

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

@ -0,0 +1,19 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="connexion" xml:lang="fr">
<info>
<link type="guide" xref="demandeur" group="connexion"/>
<link type="guide" xref="admin-budget" group="connexion"/>
<link type="guide" xref="admin-tice" group="connexion"/>
<link type="guide" xref="admin-reprographie" group="connexion"/>
<link type="guide" xref="admin-valideur" group="connexion"/>
<link type="guide" xref="admin-admin" group="connexion"/>
<desc>Il faut s'identifier pour pouvoir utiliser l'application.</desc>
</info>
<title>Connexion</title>
<p>Pour pouvoir utiliser l'application, il faut commencer par se connecter. Un utilisateur non connecté qui cherche à accomplir une action est dirigé en premier lieu sur le serveur de l'université lui permettant de saisir son identifiant et son mot de passe. Après identification, l'utilisateur est redirigé vers sa page d'accueil.</p>
</page>

View File

@ -0,0 +1,25 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="demand-droits-d-auteur" xml:lang="fr">
<info>
<desc>Permet de définir l'étendue de la diffusion du document et les droits d'auteur s'y rapportant.</desc>
<link type="guide" xref="demandeur"/>
</info>
<title>Droits d'auteur et diffusion du document</title>
<p>La question des droits afférents au document reproduit est importante. Polynum permet de préciser quels sont les droits applicables au document objet de la demande de reproduction. Plus particulièrement, le demandeur doit préciser :</p>
<list>
<item><p>Si le document contient des extraits d'oeuvres soumises au droit d'auteur.</p></item>
<item><p>Quelle est l'étendue de la diffusions souhaitée pour le document.</p></item>
</list>
<figure>
<title>Droits et diffusion</title>
<media type="image" mime="image/png" src="figures/droits-diffusion.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,29 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="demand-informations-documents" xml:lang="fr">
<info>
<link type="guide" xref="demandeur"/>
<desc>Les informations concernant le document qui doivent être renseignées.</desc>
</info>
<title>Informations documents</title>
<p>Un certain nombre d'informations concernant le document à reproduire sont nécessaires au bon fonctionnement de l'application. L'application tente d'en récupérer certaine automatiquement depuis le fichier PDF : nombre de page et titre. Ces champs seront parfois pré-remplis donc lorsque l'application aura réussi à récuprer ces informations dans le fichier. S'ils ne sont pas correctement pré-remplis, il faut les renseigner à la main.</p>
<p>D'autres champs doivent être systématiquement renseignés :</p>
<list>
<item><p>Usage du document : indique la nature du document</p></item>
<item><p>Entité administrative : indique le service ou la composante dont dépend le document</p></item>
</list>
<figure>
<title>Informations sur le document</title>
<media type="image" mime="image/png" src="figures/informations.png" >
</media>
</figure>
<p>Enfin, le champ « Commanditaire », facultatif, permet d'indiquer si la demande est effectuée pour le compte d'un tiers.</p>
</page>

View File

@ -0,0 +1,20 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="demand-livraison" xml:lang="fr">
<info>
<link type="guide" xref="demandeur"/>
<desc>Permet de déterminer le mode de livraison</desc>
</info>
<title>Livraison</title>
<p>Polynum permet de préciser où et quand l'utilisateur prendre possession des reprographies.</p>
<figure>
<title>Livraison</title>
<media type="image" mime="image/png" src="figures/livraison.png" >
</media>
</figure>
</page>

View File

@ -0,0 +1,22 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="demand-type-document" xml:lang="fr">
<info>
<link type="guide" xref="demandeur"/>
<desc>L'application prend en charge la reproduction des documents numériques mais aussi celle des documents papiers.</desc>
</info>
<title>Document papier ou document numérique</title>
<p>Si la demande porte sur un document numérique, ce dernier doit être téléchargé au format PDF lors de la première étape de la demande.</p>
<figure>
<title>Téléchargement du document PDF</title>
<media type="image" mime="image/png" src="figures/telechargement.png" >
</media>
</figure>
<p>Si aucun document n'est téléchargé, l'application considère que la demande porte sur un document papier qui devra être transmis directement au service de reprographie pour que cette dernière soit correctement traitée.</p>
</page>

View File

@ -0,0 +1,35 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="demand-type-reproduction" xml:lang="fr">
<info>
<link type="guide" xref="demandeur"/>
<desc>Permet de choisir les options de reproduction (couleur, type de papier, type de reliure, recto-verso...).</desc>
</info>
<title>Type de reproduction souhaitée</title>
<p>Pour chaque demande de reproduction il faut au minimum indiquer :</p>
<list>
<item><p>Le nombre de copies souhaitées.</p></item>
<item><p>Le type de reprographie souhaité.</p></item>
</list>
<figure>
<title>Nombre de copies et type de reproduction</title>
<media type="image" mime="image/png" src="figures/nombre-et-type.png" >
</media>
</figure>
<p>Le « profil d'impression » est un ensemble de caractéristiques prédéfinies concernant la reliure, le type de papier utilisé, la couleur, etc. Il faut choisir par mi ceux disponibles, ils ont été pensé pour couvrir les besoins les plus usuels. Toutefois, il est possible de changer tel ou tel détail du profil d'impression retenu si ce dernier ne donne pas pleinement satisfaction :</p>
<figure>
<title>Options du profil d'impression</title>
<media type="image" mime="image/png" src="figures/options-profil-impression.png" >
</media>
</figure>
<p>Enfin, il est possible d'indiquer au service reprographie telle ou telle particularité souhaitée et n'ayant pu être précisée ailleurs grâce à un champ texte « prestations complémentaires ».</p>
</page>

14
help/fr/demandeur.page Normal file
View File

@ -0,0 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide" style="task"
id="demandeur" xml:lang="fr">
<info>
<link type="guide" xref="index"/>
<desc>Pour obtenir une reproduction d'un document.</desc>
</info>
<title>Utilisateurs du service</title>
<p>Cette partie de la documentation explique comment faire une demande de reprographie.</p>
</page>

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>
<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>Documentation de Polynum, l'application de gestion des reprographies.</desc>
<revision pkgversion="0.2" version="0.2" date="2012-05-26" status="stub"/>
<credit type="author">
<name>Pierre Cros</name>
<email>pcros@entrouvert.com</email>
</credit>
</info>
<title>Documentation de Polynum</title>
<p>Polynum est une application de gestion de la reproduction des documents pédagogiques (cours, TP...). Elle concerne les documents numériques comme les documents papiers. L'application regroupe deux types d'utilisateurs : les admininistrateurs et gestionnaires qui sont responsables du bon fonctionnement du service d'une part, les usagers qui souhaitent reproduire un document d'autre part. Des boutons en page d'accueil permettent de distinguer sans ambiguïté les deux publics.</p>
<figure>
<title>Bouton de demande de reprographie</title>
<media type="image" mime="image/png" src="figures/bouton-demande.png" >
</media>
</figure>
<figure>
<title>Bouton pour accéder à l'interface d'administration</title>
<media type="image" mime="image/png" src="figures/bouton-administration.png" >
</media>
</figure>
</page>