Commit 5fb70885 authored by Florent Michon's avatar Florent Michon

Initial import

parents
# Documentation openRéussiteÉducative version 1.0
# -*- coding: utf-8 -*-
#
# openfoncier documentation build configuration file, created by
# sphinx-quickstart on Wed Jul 20 17:30:38 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'openRéussiteÉducative 1.0'
copyright = u'2004-2017, openMairie'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'fr'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%d %m %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#html_theme = 'sphinx.openmairietheme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = ['_themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'openreussiteeducativedoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'openreussiteeducative.tex', u'openreussiteeducative Documentation',
u'openMairie', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'openreussiteeducative', u'openreussiteeducative Documentation',
[u'openMairie'], 1)
]
.. _ergonomie:
#########
Ergonomie
#########
Cette partie vise à présenter l'ergonomie du logiciel c'est-à-dire à décrire la
connexion à l'application, la structure de l'application, la navigation et
l'utilisation du menu, ainsi que la présentation et la description des
principaux icônes. Cette rubrique peut s'appliquer à toute application métier
développée avec OpenMairie.
*************************************
Connexion, déconnexion et permissions
*************************************
Connexion
#########
.. note::
Pour réaliser cette étape, votre administrateur doit vous fournir une
adresse Web pour accéder à l'application, un identifiant utilisateur ainsi
qu'un mot de passe. Ces éléments auront été préalablement configuré dans
le logiciel.
-----------------------
**Navigateur Web**
-----------------------
L'application est accessible via un navigateur Web, pour y accéder il faut
saisir l'adresse Web fournie par votre administrateur dans la barre d'adresse.
.. image:: ergo_url.jpg
.. note::
Ce logiciel est développé principalement sous le navigateur Mozilla Firefox,
il est donc conseillé d'utiliser ce navigateur pour une efficacité optimale.
-----------------------
**Saisie des informations de connexion**
-----------------------
Cet écran de connexion est composé de deux zones de texte et d'un bouton.
.. image:: ergo_identification.jpg
Dans l'écran d'identification, il faut saisir son identifiant et son mot de
passe puis cliquer sur le bouton « Se connecter ».
.. note::
L'identifiant et le mot de passe doivent être saisis en respectant la
casse, c'est-à-dire les minuscules et majuscules.
-----------------------
**Connexion échouée**
-----------------------
Si les identifiants saisis sont incorrects, un message d'erreur apparaît et il
faut ressaisir les informations de connexion.
.. image:: ergo_identification_erreur.jpg
-----------------------
**Connexion réussie**
-----------------------
Si les identifiants sont corrects, vous êtes redirigé vers la page demandée sur
laquelle le message suivant doit d'afficher.
.. image:: ergo_identification_succes.jpg
Déconnexion
###########
Pour une question de sécurité évidente, il est important de se déconnecter de
l'application pour qu'un autre utilisateur ne puisse pas accéder au logiciel
via votre compte utilisateur.
L'action "Déconnexion" est disponible à tout moment dans les actions
personnelles en haut à droite de l'écran.
.. image:: ergo_deconnexion_action.jpg
Une fois déconnecté, c'est le formulaire de donnexion qui s'affiche avec un
message expliquant la réussite de la déconnexion.
.. image:: ergo_deconnexion_ok.jpg
Les droits et profils des utilisateurs
######################################
Les droits et profils des utilisateurs permettent de limiter l'accès aux
informations et aux actions uniquement aux personnes autorisées. Chaque
utilisateur est associé à un profil. Le profil correspond à un ensemble
de permissions de l'utilisateur, par défaut il existe cinq profils :
#. Consultation,
#. Utilisateur limité,
#. Utilisateur,
#. Super utilisateur,
#. Administrateur.
Chaque page de l'application est associée à un profil. Pour chaque accès à une
page, l'application vérifie si l'utilisateur a un profil supérieur ou égal au
profil de la page consultée, si c'est le cas l'utilisateur à donc le droit
d'accéder aux informations.
******************
Ergonomie générale
******************
L'application, sur la grande majorité des écrans, conserve ses composants
disposés exactement au même endroit. Nous allons décrire ici le fonctionnement
et l'objectif de chacun de ces composants. Cette structuration de l'application
permet donc à l’utilisateur de toujours trouver les outils au même endroit
et de se repérer rapidement.
.. image:: ergo_generale.jpg
.. note::
Les actions et affichages de l'application diffèrent en fonction du profil
de l'utilisateur. Il se peut donc que dans les paragraphes qui suivent
des actions soient décrites et n'apparaissent pas sur votre interface
ou inversement que des actions ne soient pas décrites mais apparaissent sur
votre interface.
Le logo
#######
C'est le logo de l'application, il vous permet en un seul clic de revenir
rapidement au tableau de bord.
Les actions personnelles
########################
Cet élément affiche plusieurs informations importantes.
La première information est l'identifiant de l'utilisateur actuellement
connecté ce qui permet de savoir à tout moment si nous sommes bien connectés
et avec quel utilisateur. Ensuite est noté le nom de la collectivité sur
laquelle nous sommes en train de travailler. En mode multi, une action est
disponible sur cette information pour permettre de changer de collectivité.
Ensuite la liste sur laquelle nous sommes en train de travailler, une action
est disponible sur cette information pour permettre de changer de liste.
Enfin l'action pour permettre de changer de mot de passe et pour se déconnecter
sont disponibles en permanence.
Les raccourcis
##############
Cet élément permet d'afficher des raccourcis vers des écrans auxquels nous
avons besoin d'accéder très souvent. Par exemple, ici nous avons un
raccourci direct vers le tableau de bord.
Le menu
#######
Cet élément permet de classer les différents écrans de l'application en
rubriques. En cliquant sur l'entête de rubrique, nous accédons à la liste des
écrans auxquels nous avons accès dans cette rubrique.
Le nombre de rubriques disponibles dans le menu peut varier en fonction du
profil des utilisateurs. Un utilisateur ayant le profil Consultation n'aura
probablement pas accès aux six rubriques présentes sur cette capture.
Les actions globales
####################
Cet élément permet d'afficher en permanence le numéro de version du logiciel.
Ensuite les différentes actions sont des liens vers le site officiel du
logiciel ou vers la documentation.
*************************
Ergonomie des formulaires
*************************
De manière générale, il y a une règle simple dans les applicatifs openMairie :
on accède d'abord à un listing d'éléments puis depuis ce listing on peut
ajouter un nouvel élément ou modifier un élément existant en accédant au
formulaire dédié à cet élément.
Les listings
############
Un listing est un tableau qui liste des éléments récapitulant des informations
permettant d'identifier un élément parmi les autres.
.. image:: ergo_tableau.jpg
**Les actions**
*En haut à gauche*
* Ajouter : cette action représentée par un plus permet d'accéder au formulaire
de création d'un élément.
.. image:: ergo_icone_ajouter.jpg
* Autre : il peut y avoir d'autres actions positionnées ici qui représentent
des actions que l'on peut faire sur un lot d'éléments par exemple.
*A gauche devant chaque élément*
* Visualiser : cette action permet d'accéder au formulaire de visualisation
d'un élément.
.. image:: ergo_icone_visualiser.jpg
* Autre : il peut y avoir d'autres actions positionnées ici qui permettent
d'effectuer des actions rapides sans avoir besoin d'accéder au formulaire
de l'élément en visualisation puis de cliquer sur une action parmi les
actions contextuelles de l'élément.
*Sur l'élément*
* Visualiser : cette action permet d'accéder au formulaire de visualisation
d'un élément.
Les formulaires
###############
Un formulaire dans cet applicatif peut soit être de visualisation soit d'action
(ajout, modification, suppression, ...). La différence est que le premier
contient un portlet d'actions contextuelles et que le deuxième contient un
bouton qui permet de valider le formulaire en question.
Voici l'exemple d'un formulaire en mode visualisation.
.. image:: ergo_form_visualiser.jpg
Voici l'exemple d'un formulaire en mode modification.
.. image:: ergo_form_modifier.jpg
-----------------------
**Les actions**
-----------------------
Le portlet d'actions contextuelles se trouve sur le formulaire d'un élément
en mode visualisation. Il contient normalement toutes les actions possibles sur
cet élément par l'utilisateur. Il est situé en haut à droite du formulaire.
*Actions de formulaires*
* Modifier : cette action permet de transformer le mode visualisation de
l'élément en mode modification. Une fois le formulaire de modification validé
alors un bouton retour nous permet de revenir au formulaire en mode
visualisation.
* Supprimer : cette action permet de transformer le mode visualisation de
l'élément en mode suppression. Une fois le formulaire de suppression validé
alors un bouton retour nous permet de revenir au listing des éléments.
*Autres actions*
* Le portlet d'acctions contextuelles peut contenir toutes les actions
disponibles sur l'élément. Par exemple : il peut y avoir une action qui
permet d'imprimer une édition PDF de l'élément, une autre action permettant
de changer une valeur spécifique de l'élément comme "Marquer comme lu", ...
-----------------------
**Les onglets**
-----------------------
Sur le formulaire d'un élément, il peut apparaître plusieurs onglets qui
correspondent à des éléments liés à l'élément en cours. Un onglet présente un
listing de ces éléments liés avec des actions qui permettent également d'accéder
à des formulaires sur ces éléments liés.
Par exemple sur l'image suivante, on peut voir sur le "profil" un onglet
"tableau de bord" qui liste les tableaux de bord liés au profil utilisateur.
.. image:: ergo_onglet.jpg
.. openreussiteeducative documentation master file
=======================================
openRéussiteÉducative 1.0 documentation
=======================================
.. note::
Cette création est mise à disposition selon le Contrat Paternité-Partage des
Conditions Initiales à l'Identique 2.0 France disponible en ligne
http://creativecommons.org/licenses/by-sa/2.0/fr/ ou par courrier postal à
Creative Commons, 171 Second Street, Suite 300, San Francisco,
California 94105, USA.
openRéussiteÉducative a pour objet de gérer le programme de réussite éducative. http://www.openmairie.org/catalogue/openreussiteeducative
Vous trouverez dans ce document :
- les principes d'ergonomie
- l'utilisation d'openReussite_Educative
- le paramétrage
Il reste à compléter les chapitres suivants (dans une prochaine édition)
- les widgets