summaryrefslogtreecommitdiff
path: root/docs/fr/documentation-utilisateur.t2t
diff options
context:
space:
mode:
Diffstat (limited to 'docs/fr/documentation-utilisateur.t2t')
-rw-r--r--docs/fr/documentation-utilisateur.t2t185
1 files changed, 185 insertions, 0 deletions
diff --git a/docs/fr/documentation-utilisateur.t2t b/docs/fr/documentation-utilisateur.t2t
new file mode 100644
index 0000000..d4ff0e1
--- /dev/null
+++ b/docs/fr/documentation-utilisateur.t2t
@@ -0,0 +1,185 @@
+Documentation administrateur de Chimère
+Étienne Loks
+Last update: %%date(%m-%d-%Y)
+
+= Généralités =
+
+Trois rôles sont disponibles en administration :
+
+- modérateur de l'application ;
+- administrateur de l'application ;
+- administrateur technique.
+
+
+Le modérateur peut valider/modifier/ajouter les points d'intérêts et les
+trajets. Le paragraphe « Modération dans Chimère » décrit les fonctionnalités
+disponibles pour ce rôle.
+
+L'administrateur de l'application peut en plus administrer les catégories, les
+sous-catégories, les icônes, les nouvelles, les thèmes de couleur et les zones.
+Le paragraphe « Administration de l'application dans Chimère » décrit les
+fonctionnalités disponibles pour ce rôle.
+
+L'administrateur technique a en plus accès à la création d'utilisateurs.
+
+Pour accéder aux pages d'administration, il suffit de s'identifier sur la page
+accessible à l'adresse de base du site, suffixée par « /admin ». Bien sûr, il
+faut préalablement que l'on ait créé un compte pour vous (ou que vous soyez
+l'installateur de l'application).
+
+Attention, si une installation couvrant plusieurs zones a été faite, il faut
+retirer le suffixe de zone dans l'adresse.
+
+//ex// : depuis une URL d'accès classique http://www.carte-ouverte.org/ avec une
+zone d'accès http://www.carte-ouverte.org/rennes l'URL d'accès à
+l'administration reste http://www.carte-ouverte.org/admin
+
+= Modération dans Chimère =
+
+Une fois identifié, un utilisateur ayant les droits de modération dispose des
+éléments suivants :
+
+- Points d'intérêts
+- Trajets
+
+
+Si certains éléments ne sont pas disponibles, c'est que le compte ne bénéficie
+pas de droits suffisants pour la modération.
+
+== Modification des points d'intérêts/des trajets ==
+
+Le modérateur peut accéder à tous les points d'intérêts et tous les trajets
+validés ou non.
+Une recherche par nom parmi les éléments est possible. De même, ces éléments
+peuvent être filtrés par état ou par sous-catégorie.
+
+La modification/l'ajout d'élément est assez similaire à l'interface publique de
+création. Seul le champ État est ajouté.
+Celui-ci a trois valeurs :
+
+ - Soumis, un élément a été proposé depuis l'interface publique ;
+ - Disponible, l'élément a été validé en modération ;
+ - Désactivé, l'élément a été mis de coté.
+
+
+Il est possible de supprimer complètement un élément de la base. Cette opération
+est non réversible mais une confirmation est demandée.
+
+= Administration de l'application dans Chimère =
+
+Une fois identifié, un utilisateur ayant les droits d'administration de
+l'application dispose des éléments suivants :
+
+- Catégories
+- Icônes
+- Nouvelles
+- Points d'intérêts
+- Sous-catégories
+- Thème de couleurs
+- Trajets
+- Zones
+
+
+Si certains éléments ne sont pas disponibles, c'est que le compte ne bénéficie
+pas de droits suffisants pour la modération.
+
+La gestion des Points d'intérêts et des Trajets est décrite dans la section sur
+la modération.
+
+== Création des zones ==
+
+Les zones permettent de découper la carte en plusieurs parties. À chaque partie
+peut être associé un suffixe spécifique pour accéder directement à cette zone
+depuis une URL spécifique.
+
+//ex// : depuis une URL d'accès classique http://www.carte-ouverte.org/, il est
+possible de définir un accès direct sur la zone de Rennes par l'URL
+http://www.carte-ouverte.org/rennes
+
+Chaque partie peut être configurée pour accéder à seulement un sous-ensemble des
+catégories disponibles (les utilisateurs finaux ne pourront proposer que des
+éléments dans ces catégories sur cette zone).
+
+Pour chaque zone, les champs suivants sont disponibles :
+
+- Nom : le nom de la zone en question ;
+- Urn : le suffixe associé à la zone, attention il doit respecter les règles de
+nommage des URLs (pas d'accent, pas d'espace, etc.). Ce champ est optionnel, si
+il est non défini il n'y a pas de raccourci ;
+- Ordre : ordre d'affichage dans la liste de raccourcis (si cette liste est
+visible) ;
+- Disponible : pour rendre disponible ou non la zone ;
+- Sous-catégories : un sous-ensemble de catégories à sélectionner pour limiter
+les propositions utilisateurs. Ce champ est optionnel, si aucune sous-catégorie
+n'est sélectionnée, toutes les sous-catégories sont disponibles ;
+- Zone : la zone en question. Celle-ci correspond à ce qui est visible sur la
+carte.
+
+
+== Création d'icônes ==
+
+À chaque sous-catégorie doit être associée une icône. Cette icône apparait sur
+la légende de la carte et pour chaque point d'intérêt de la sous-catégorie. Une
+même icône peut éventuellement être utilisée pour plusieurs sous-catégories
+(même si cela est généralement une mauvaise idée). Pour une harmonie sur la
+carte, il est préférable de se tenir à une taille fixe d'icône carrée (par
+exemple 32 par 32 pixels). L'icône ne sera pas redimensionnée sur la carte. Les
+formats jpg, gif et png sont acceptés mais le png est à privilégier. En effet,
+pour de petits formats comme ceux-ci la compression jpg est peu efficace, de
+plus elle ne gère pas la transparence (utile pour des icônes ne prenant pas tout
+le carré). Le gif est aussi à déconseiller car ce format est maintenant obsolète
+(notamment il ne prend en charge que 256 couleurs).
+
+== Création des thèmes de couleurs ==
+
+Les thèmes de couleur sont utilisés par les trajets. Un thème de couleur est un
+ensemble de couleurs qui coloreront aléatoirement les trajets d'une
+sous-catégorie donnée. Pour faciliter la compréhension de la carte, il peut être
+pertinent d'utiliser des couleurs approchantes pour un même thème de couleur
+(par exemple des déclinaisons de bleu).
+
+Pour chaque thème de couleur, un nom est donné et une ou plusieurs couleurs sont
+définies. Les couleurs sont définies en notation HTML RVB avec 6 chiffres
+hexadécimaux (sans le #). Cf. une [liste de couleurs http://fr.wikipedia.org/wiki/Liste_de_couleurs].
+
+== Création des catégories ==
+
+Les catégories sont de simple conteneurs pour les sous-catégories. Elles
+permettent d'organiser logiquement ces dernières et apparaissent comme nœuds
+au niveau de la légende de la carte.
+
+Les catégories disposent des champs suivants :
+
+- Nom : le nom ;
+- Disponible : l'affichage de la catégorie, si une catégorie est indisponible
+aucune des sous-catégories sous celle-ci ne sera affichée ;
+- Ordre : l'ordre d'apparition dans la légende ;
+- Description : texte optionnel permettant de mettre à disposition une
+description dans une rubrique « en savoir plus » de la catégorie.
+
+
+== Création des sous-catégories ==
+
+Les trajets et les points d'intérêts sont rangés dans des sous-catégories.
+Les sous-catégories disposent des champs suivants :
+
+- Catégorie : la catégorie associée ;
+- Nom : le nom de la sous-catégorie ;
+- Disponible : l'affichage de la sous-catégorie ;
+- Icône : l'icône associée à la sous-catégorie ;
+- Thème de couleur : thème de couleur associé, ce champ est nécessaire pour
+les sous-catégories de type trajet ou mixte ;
+- Ordre : l'ordre d'apparition dans la légende ;
+- Type d'élément : le type d'élément associé à la sous-catégorie : Point
+d'intérêt, Trajet ou Mixte (Point d'intérêt et Trajet) ;
+- Zones : les zones pour lesquelles cette sous-catégorie est disponible. Si
+aucune zone n'est sélectionnée, cette sous-catégorie est disponible pour toutes
+les zones.
+
+
+== Création de nouvelles ==
+
+Un système de nouvelles est disponible.
+Pour chaque nouvelle, un nom et un contenu doit être renseigné. La disponibilité
+est paramétrable. Le système de nouvelles est transversal à tous les sites.
+