aboutsummaryrefslogtreecommitdiffstats
path: root/app/views/help/vehicle_journeys.textile
diff options
context:
space:
mode:
Diffstat (limited to 'app/views/help/vehicle_journeys.textile')
-rw-r--r--app/views/help/vehicle_journeys.textile39
1 files changed, 39 insertions, 0 deletions
diff --git a/app/views/help/vehicle_journeys.textile b/app/views/help/vehicle_journeys.textile
new file mode 100644
index 000000000..d5186cf57
--- /dev/null
+++ b/app/views/help/vehicle_journeys.textile
@@ -0,0 +1,39 @@
+---
+layout: default
+title: Courses
+---
+
+h3. Définition
+
+Une *course* décrit le déplacement d'un véhicule de transport public sur une "séquence d'arrêts":routes de la "ligne":lines. La course parcourt les arrêts de la séquence d'arrêts dans l'ordre, sans nécessairement s'arrêter à chacun des arrêts. A chaque arrêt desservi, la course précise l'horaire de passage.
+De plus, la course est rattachée à un nombre variable de "calendriers d'application":time_tables.
+
+h3. Attributs
+
+- Nom := nom de la course
+- Nom public := nom public pour les voyageurs
+- Commentaire := zone de texte libre
+- Mode de transport := mode de transport pour la course; par défaut, c'est le mode de transport de la ligne qui est appliqué
+- Particularité := champs libre pouvant préciser des modes de fonctionnement (TAD par exemple)
+
+p(attr_data). Données de gestion :
+
+- Identifiant Neptune :=
+clé unique pérenne identifiant la course 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 = VehicleJourney : clé identifiant le type d'objet (valeur imposée)
+* id_technique : valeur identifiant un seul objet 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 l'identifiant technique, 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
+