Manage help texts with a dedicated HelpController. Refs #12

1 files changed, 55 insertions, 0 deletions

diff --git a/app/views/help/timetables.textile b/app/views/help/timetables.textile
new file mode 100644
index 000000000..57fe0d50b
--- /dev/null
+++ b/app/views/help/timetables.textile
@@ -0,0 +1,55 @@
+---
+layout: default
+title: Calendriers d'application
+---
+
+h3. Définition
+
+Un calendrier d'application permet de définir la période de validité des horaires d'une course. 
+Les calendriers d'application sont donc définis indépendamment des lignes, à l'instar du référentiel des arrêts.
+
+La manière de définir un calendrier d'application est restreinte. 
+Les calendriers sont caractérisés par : 
+
+* une liste de quantièmes (jours calendaires dans l'année)
+* une liste de jours d'application (lundis, mardis, etc.)
+* une liste de périodes
+
+L'utilisateur doit donc faire attention au nommage de ses différents calendriers d'application.
+
+Plusieurs courses peuvent référencer le même calendrier.
+
+Ainsi, il est possible de construire des calendriers d'application qui sont ensuite référencés par des courses de lignes différentes. 
+
+h3. Attributs
+
+- Commentaire := Description du calendrier
+- Version := version du calendrier (différent de la version de l'objet)
+- Jours d'application := jours de la semaine effectivement applicables dans le cas où des périodes sont définies dans le calendrier
+- Périodes d'application := périodes calendaires durant lesquelles le calendrier est applicable
+- Dates d'application := 
+dates spécifiques pour lesquelles le calendrier est applicable;
+ces dates peuvent être ajoutées dans ou en dehors des périodes calendaires.
+Un calendrier peut n'avoir que des dates calendaires, auquel cas les jours d'applications n'ont pas de signification
+=:
+
+p(attr_data). Données de gestion :
+
+- Identifiant Neptune := 
+clé unique pérenne identifiant le réseau pour les échanges Neptune
+cet identifiant est composé de 3 parties : préfixe:type:id_technique
+
+* préfixe : clé identifiant un producteur de données unique
+* type = Timetable : clé identifiant le type d'objet (valeur imposée)
+* id_technique : valeur identifiant un seul object d'un type donné pour un même producteur
+ce champ obligatoire est automatiquement généré s'il n'est pas renseigné 
+il est possible aussi de ne renseigner que le préfixe auquel cas la valeur sera complétée automatiquement.
+=:
+- Date de création := date à laquelle l'objet a été créé ou modifié pour la dernière fois
+- Version := version de l'objet (auto incrémenté à chaque modification)
+- Créé par := compte utilisateur ayant procédé à la dernière modification
+
+h3. Implémentation
+
+p. TODO
+