diff options
Diffstat (limited to 'app')
| -rw-r--r-- | app/assets/javascripts/help.js.coffee | 3 | ||||
| -rw-r--r-- | app/assets/stylesheets/help.css.scss | 70 | ||||
| -rw-r--r-- | app/controllers/help_controller.rb | 13 | ||||
| -rw-r--r-- | app/helpers/application_helper.rb | 7 | ||||
| -rw-r--r-- | app/helpers/help_helper.rb | 2 | ||||
| -rw-r--r-- | app/models/help_page.rb | 46 | ||||
| -rw-r--r-- | app/views/help/companies.textile | 44 | ||||
| -rw-r--r-- | app/views/help/dataspaces.textile | 21 | ||||
| -rw-r--r-- | app/views/help/index.textile | 37 | ||||
| -rw-r--r-- | app/views/help/introduction.textile | 15 | ||||
| -rw-r--r-- | app/views/help/lines.textile | 46 | ||||
| -rw-r--r-- | app/views/help/networks.textile | 41 | ||||
| -rw-r--r-- | app/views/help/normalisation.textile | 43 | ||||
| -rw-r--r-- | app/views/help/restapis.textile | 30 | ||||
| -rw-r--r-- | app/views/help/show.html.erb | 3 | ||||
| -rw-r--r-- | app/views/help/stop_areas.textile | 78 | ||||
| -rw-r--r-- | app/views/help/timetables.textile | 55 | ||||
| -rw-r--r-- | app/views/layouts/_user_links.erb | 6 | ||||
| -rw-r--r-- | app/views/layouts/application.html.erb | 8 |
19 files changed, 563 insertions, 5 deletions
diff --git a/app/assets/javascripts/help.js.coffee b/app/assets/javascripts/help.js.coffee new file mode 100644 index 000000000..761567942 --- /dev/null +++ b/app/assets/javascripts/help.js.coffee @@ -0,0 +1,3 @@ +# Place all the behaviors and hooks related to the matching controller here. +# All this logic will automatically be available in application.js. +# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/ diff --git a/app/assets/stylesheets/help.css.scss b/app/assets/stylesheets/help.css.scss new file mode 100644 index 000000000..ca68e15b5 --- /dev/null +++ b/app/assets/stylesheets/help.css.scss @@ -0,0 +1,70 @@ +#workspace.help { +h2 { + font-size: 17px; +} + +h3 { + font-size: 15px; +} + +h4 { + font-weight: bold; + padding: 7px 0; +} + +ul li { + list-style: circle; + margin: 7px 0 7px 20px; +} + +ol { + list-style: none; + margin: 7px 0 7px 20px; + padding: 0; + counter-reset: num; +} + +ol li:before { + content: counter(num) '. '; + counter-increment: num; +} + +ol ol li:before { + content: counters(num, '.') ' '; +} + +em { + font-style: italic; +} + +strong { + font-weight: bold; +} + +cite { + font-style: italic; +} + +p.attr_data { + font-style: italic; + text-decoration: underline; +} + +table { + width: 100%; +} + +table td { + padding: 3px 5px; + width: 30%; +} + +dt { + font-style:italic; + margin: 5px 0; +} + +dd { + padding-left: 10px; +} +} diff --git a/app/controllers/help_controller.rb b/app/controllers/help_controller.rb new file mode 100644 index 000000000..92f96ebd7 --- /dev/null +++ b/app/controllers/help_controller.rb @@ -0,0 +1,13 @@ +class HelpController < ApplicationController + + def show + @page = HelpPage.find(slug) + end + + private + + def slug + params[:slug] or "index" + end + +end diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb index cf6486306..29951da87 100644 --- a/app/helpers/application_helper.rb +++ b/app/helpers/application_helper.rb @@ -4,5 +4,12 @@ module ApplicationHelper @referential.present? and not @referential.new_record? end + def help_page? + controller_name == "help" + end + + def help_path + url_for(:controller => "help", :action => "show") + '/' + end end diff --git a/app/helpers/help_helper.rb b/app/helpers/help_helper.rb new file mode 100644 index 000000000..6a35490ac --- /dev/null +++ b/app/helpers/help_helper.rb @@ -0,0 +1,2 @@ +module HelpHelper +end diff --git a/app/models/help_page.rb b/app/models/help_page.rb new file mode 100644 index 000000000..1207c5198 --- /dev/null +++ b/app/models/help_page.rb @@ -0,0 +1,46 @@ +class HelpPage + + attr_accessor :slug, :content, :data + + def initialize(slug) + @slug = slug + @data = {}.with_indifferent_access + end + + def filename + "#{Rails.root}/app/views/help/#{slug}.textile" + end + + def exists? + File.exists? filename + end + + def load + self.content = File.read(filename) + self.data ||= {} + + if self.content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m + self.content = $POSTMATCH + self.data.merge! YAML.load($1) + end + end + + def method_missing(method, *arguments) + if arguments.empty? and data.has_key?(method) + data[method] + else + super + end + end + + def self.find(slug) + new(slug).tap do |page| + if page.exists? + page.load + else + raise ActiveRecord::RecordNotFound + end + end + end + +end diff --git a/app/views/help/companies.textile b/app/views/help/companies.textile new file mode 100644 index 000000000..c1db6f4d3 --- /dev/null +++ b/app/views/help/companies.textile @@ -0,0 +1,44 @@ +--- +layout: default +title: Transporteurs +--- + +h3. Définition + +Dans la réalité, le transporteur est l'entité en charge de l'exploitation d'une ou plusieurs lignes de transport. +Ce principe se retrouve dans ce logiciel. + +* Il s'agit de l'exploitant de la ligne; chaque ligne est rattachée à un seul transporteur, un transporteur pouvant évidemment gérer plusieurs lignes. +* Chaque transporteur dispose d'un identifiant fonctionnel (« numéro d'enregistrement ») qui est utilisé dans les échanges XML pour identifier le transporteur et le mettre à jour. Cet identifiant est unique pour toute la base CHOUETTE, quel que soit le réseau ; il est donc important que le gestionnaire de la base CHOUETTE le renseigne d'une manière bien définie et pérenne. + +h3. Attributs + +- Nom := nom du transporteur +- Nom court := nom abrégé du transporteur +- Nom d'unité := nom de l'unité de gestion dans la société de transport +- Nom du département := nom du département dans la société de transport +- Code postal := code postal de l'adresse de la société de transport +- Numéro de téléphone := Numréro de téléphone de l'unité de gestion +- Numéro de fax := Numéro de fax de l'unité de gestion +- Email := adresse électronique de l'unité de gestion de l'unité de gestion +- Numéro d'enregistrement := code référençant un transporteur au sein d'une autorité supérieure + +p(attr_data). Données de gestion : + +- Identifiant Neptune := +clé unique pérenne identifiant le transporteur 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 = Company : 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 + diff --git a/app/views/help/dataspaces.textile b/app/views/help/dataspaces.textile new file mode 100644 index 000000000..536ea4173 --- /dev/null +++ b/app/views/help/dataspaces.textile @@ -0,0 +1,21 @@ +--- +layout: default +title: Espaces de donnees +--- + +h3. Définition + +p. un espace de données est le lieu de stockage d'un ensemble de données de transport connectées entre elles. + +h3. Attributs + +- Nom := nom de l'espace de données +- Code := code de l'espace de données +- Préfixe Neptune := préfixe utilisé par défaut pour la génération des identifiants Neptune +- Projection géographique := référentiel de projection des coordonnées cartographiques en complément du WGS84 + +h3. Implémentation + +p. L'espace de données est concrétisé dans la base de données par un schéma au sens SQL portant le nom definit par l'attribut code, +les attributs sont enregistrés dans la table REFERENTIALS du schema PUBLIC + diff --git a/app/views/help/index.textile b/app/views/help/index.textile new file mode 100644 index 000000000..64a4281e5 --- /dev/null +++ b/app/views/help/index.textile @@ -0,0 +1,37 @@ +--- +layout: default +title: Présentation +--- + +Chouette v2 : itération 4 du 16/04/2012 + +Cette itération présente les formulaires de : + +* réseaux +* lignes +* arrêts +* calendriers d'application + +l'avancement actuel permet de ... + +h3. Sommaire + +# "Généralités":introduction +## "Normalisation":normalisation +# "Espaces de données":dataspaces +# "Réseaux":networks +# "Transporteurs":companies +# "Lignes":lines +## Séquences d'arrêts +## Horaires +# "Arrêts":stop_areas +## Correspondances +## Accès +## Liaisons Arrêt-Accès +# "Calendriers d'application":timetables +# Outils +## Imports +## Validation +# Divers +## "API Rest":restapis + diff --git a/app/views/help/introduction.textile b/app/views/help/introduction.textile new file mode 100644 index 000000000..71f954d53 --- /dev/null +++ b/app/views/help/introduction.textile @@ -0,0 +1,15 @@ +--- +layout: default +title: Introduction +--- + +CHOUETTE est un logiciel libre développé à l'initiative du ministère français chargé des transports (et du développement durable), +dans le but de faciliter l'échange de données d'offre (théorique) de transport collectif (TC), +en s'appuyant pour cela sur la norme NFP 99506, dite Neptune, qui spécifie un profil d'échange XML. + +Les utilisateurs visés sont les collectivités locales Autorités Organisatrices de Transport (AOT), +les exploitants des réseaux TC ,et leurs prestataires (bureaux d'étude ou société de services). +D'autres utilisateurs potentiels sont néanmoins identifiés : services de l'état, éditeurs de logiciels, +opérateurs de services d'information, chercheurs... + + diff --git a/app/views/help/lines.textile b/app/views/help/lines.textile new file mode 100644 index 000000000..9997c0d50 --- /dev/null +++ b/app/views/help/lines.textile @@ -0,0 +1,46 @@ +--- +layout: default +title: Lignes +--- + +h3. Définition + +Une ligne référence un réseau et un transporteur; par ailleurs la ligne se compose d'un ou plusieurs itinéraires. +La ligne dispose aussi d'un identifiant fonctionnel (« numéro d'enregistrement ») qui est utilisé dans les échanges XML pour identifier la ligne et la mettre à jour; il est donc important que le gestionnaire de la base CHOUETTE le renseigne d'une manière bien définie et pérenne. + +h3. Attributs + +- Réseau := réseau d'appartenance de la ligne +- Transporteur := +transporteur principal exploitant la ligne +les autres transporteurs de la lignes sont référencés au niveau de chaque course +=: +- Nom := nom de la ligne +- Nom public := nom de la ligne connu des usagers +- Numéro d'enregistrement := code référençant une ligne au sein d'une autorité supérieure +- Indice := indice de la ligne +- Mode de transport := +mode de transport principal de la ligne +les modes de transports particuliers sont indiqués au niveau de chaque course +=: +- Commentaire := zone de texte libre sur la ligne + +p(attr_data). Données de gestion : + +- Identifiant Neptune := +clé unique pérenne identifiant la ligne 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 = Line : 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 + diff --git a/app/views/help/networks.textile b/app/views/help/networks.textile new file mode 100644 index 000000000..424808f48 --- /dev/null +++ b/app/views/help/networks.textile @@ -0,0 +1,41 @@ +--- +layout: default +title: Réseaux +--- + +h3. Définition + +Un réseau est constitué par les lignes, les séquences d'arrêts, les Interdictions de Trafic Local (ITL), les horaires, et les courses qui le définissent. + +Chaque réseau dispose d'un identifiant fonctionnel (« numéro d'enregistrement ») qui est utilisé dans les échanges XML pour identifier le réseau et le mettre à jour. Il est donc important que le gestionnaire le renseigne d'une manière bien définie et pérenne. + + +h3. Attributs + +- Nom := nom du réseau +- Numéro d'enregistrement := code référençant un réseau au sein d'une autorité supérieure +- Commentaire := zone de texte libre sur le réseau +- Date de version := date de mise en référence de l'ensemble des constituants du réseau +- Description := description du réseau +- Nom du système origine := nom du système ayant produit les données du réseau +- Identifiant du système origine := identifiant du système ayant produit les données du réseau + +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 = GroupOfLine : 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 + diff --git a/app/views/help/normalisation.textile b/app/views/help/normalisation.textile new file mode 100644 index 000000000..2790d5320 --- /dev/null +++ b/app/views/help/normalisation.textile @@ -0,0 +1,43 @@ +--- +layout: default +title: Normalisation +--- + +Le projet Chouette a été développé dans le cadre de la normalisation de l'information sur les transports publics (AFNOR/BNEVT CN03/GT7), en vue de faciliter l'interopérabilité des systèmes et en particulier les échanges de données entre Systèmes d'Information Multimodale. + +h3. TRANSMODEL (EN12896) + +La norme européenne TRANSMODEL constitue le modèle conceptuel de données sur lequel s'appuie l'ensemble des travaux normatifs (Neptune, SIRI, IFOPT, NETEX) . Elle est actuellement validée dans sa version 5.1. + +Elle a pour objectif de décrire les différents concepts utilisés au sein des multiples métiers du transport public (aussi bien dans le domaine de l'exploitation, de la régulation que dans celui de l'information voyageur) en usant de la modélisation UML. Cette description a abouti à la constitution d'un "dictionnaire" dans lequel chacun peut venir piocher la terminologie adéquate pour pouvoir désigner, quels que soient la structure et le métier de l'intéressé, de façon homogène et non ambiguëc; les concepts qu'il va décliner dans son application. + +h3. de TRIDENT à NEPTUNE (PR NF P99-506) + +Dans le cadre de la commission de normalisation CN03 pour les applications télématiques dans les transports publics, miroir du groupe européen CEN TC278 / WG3, un groupe de travail GT7 a été créé en 2002 pour normaliser les échanges de données concernant l'information aux voyageurs entre exploitants et Autorités Organisatrices de transport. + +Après examen des travaux en cours au niveau européen, il est apparu au groupe que les spécifications d'échange élaborées dans le cadre du projet européen TRIDENT étaient la meilleure base de travail sur laquelle s'appuyer pour la normalisation. +Ces spécifications d'échange couvrent l'information VP et TC, théorique et en situation perturbée; elles s'appuient sur : +* un modèle d'échange pair à pair entre fournisseur et client, avec possibilité d'abonnement ; +* un modèle de données orienté objets décrit en UML, reprenant pour ce qui concerne les transports publics, le modèle conceptuel de données Transmodel V4.0, normalisé au niveau européen ; +* un format d'échange XML spécifié sous forme de schémas XSD. + +Les spécifications TRIDENT ont été implémentées dans plusieurs pays européens, et en France ont été mises en œuvre par la RATP pour son système d'information sur les situations perturbées SIPRE, et également pour les échanges d'information au niveau francilien en cours entre les systèmes de la RATP et du STIF, pour ce qui concerne l'information théorique. + +Le travail du groupe GT7 a abouti à des spécifications de profil d'échange TRIDENT / Chouette en 2006, qui ont servi de référence pour implémenter le logiciel CHOUETTE et sont utilisées depuis lors par plusieurs projets de SIM en France. + +Lors des discussions précédant l'enquête probatoire AFNOR en 2009 en vue faire de ces spécifications une norme française, ces spécifications ont été complétées par quelques éléments de données relatifs à l'accessibilité des transports : le nouveau profil d'échange baptisé *NEPTUNE* (PR NF99-506 Décembre 2009) a été adopté en janvier 2010. Il y a compatibilité ascendante avec les fichiers au profil Trident/Chouette dont Neptune est une extension. + +h3. Le profile d'échange NEPTUNE + +Le développement des Systèmes d'Information Multimodale a conduit les partenaires des transports publics en France (AOT et opérateurs, représentants d'utilisateurs et administrations publiques) dans leur ensemble à demander l'inscription de ce profil d'échange en tant que 'norme pleine'. L'adoption de ce statut de norme est d'autant plus important aujourd'hui, que les outils précités vont connaître des périodes d'évolution et d'adaptation. + +Dans le cadre du processus de normalisation, le profil d'échange a été rebaptisé NEPTUNE et complété . Le processus s'est conclu début 2010 par l'adoption d'un document AFNOR (cf. PR NF P99-506) . + +En pratique, l'essentiel est de savoir que le profil TRIDENT/CHOUETTE est compatible avec NEPTUNE : Neptune reprend l'essentiel de Trident profil Chouette, et n'a été complété qu'en ce qui concerne l'information sur l'accessibilité aux Personnes à Mobilité Réduite et les accès. En particulier, le nommage des éléments de données du profil XSD n'a pas été modifié. + +Ce profil résulte d'un consensus entre les différentes parties prenantes participant au groupe de travail de normalisation CN03/GT7. Il est rédigé en français. Dans certains cas, pour éviter des confusions ou des contre-sens, les concepts de la norme TRANSMODEL qui ont été manipulés sont rappelés dans leur terminologie, voire leur définition en anglais dans le texte original de la norme TRANSMODEL V5.1 qui vaut référence. Les rapprochements nécessaires ont été faits avec la version provisoire en français de la norme TRANSMODEL en cours de validation. + +Ce profil sera sans doute amené à évoluer en fonction des travaux réalisés dans le cadre des travaux de normalisation européens ou internationaux en cours. Ceux-ci touchent tout à la fois la représentation topographique des réseaux de transport, les interfaces entre les données d'exploitation et l'information diffusée vers le voyageur avant et pendant le voyage (NeTEX ), la description des points d'arrêts et points fixes (IFOPT2) , les interfaces avec la billettique et les autres échanges de données envisageables dans les métiers des transports publics (TRANSMODEL). + +Le profil d'échange NEPTUNE (PR NF P99-506 Décembre 2009) et donc l'outil CHOUETTE se limitent aux échanges d'information concernant la description " statique " de l'offre TC (réseau, horaires), et ne couvrent pas l'information en temps réel. + diff --git a/app/views/help/restapis.textile b/app/views/help/restapis.textile new file mode 100644 index 000000000..ed4aaf3b4 --- /dev/null +++ b/app/views/help/restapis.textile @@ -0,0 +1,30 @@ +--- +layout: default +title: API Rest +--- + +h3. Syntaxe + +Les différents objets Neptune sont accessibles dans Chouette par l'URL Rest: +??[URL_server]/[referential_id]/[Objects]/[id].[format]?? +la liste des objets d'un même type peut être obtenue par l'URL REST : +??[URL_server]/[referential_id]/[Objects].[format]?? +où : +* URL_server : l'adresse web d'installation du serveur Chouette +* referential_id: l'identifiant de l'espace de données +* Objects: le type d'objet demandé (au pluriel) +** networks +** lines +** companies +** ... +* id : l'identifiant de l'objet désiré +* format : le format de sortie : +** json +** xml + +h3. Exemples + +??http://chouette.dryade.net/chouette2/referentials/4/lines/674.json?? +??http://chouette.dryade.net/chouette2/referentials/4/lines/674.xml?? + + diff --git a/app/views/help/show.html.erb b/app/views/help/show.html.erb new file mode 100644 index 000000000..b5c8506ee --- /dev/null +++ b/app/views/help/show.html.erb @@ -0,0 +1,3 @@ +<h2><%= @page.title %></h2> + +<%= textilize(@page.content).html_safe %> diff --git a/app/views/help/stop_areas.textile b/app/views/help/stop_areas.textile new file mode 100644 index 000000000..f527798fe --- /dev/null +++ b/app/views/help/stop_areas.textile @@ -0,0 +1,78 @@ +--- +layout: default +title: Arrêts +--- + +h3. Définition + +Le référentiel des arrêts constitue un maillon essentiel du réseau, et se compose de plusieurs éléments de niveaux différents. + +On recense tout d'abord les arrêts physiques, qualifiés de *point d'embarquement* ou de *quai*. + +Du fait de l'existence de deux concepts dans TRIDENT, cet arrêt physique sera considéré par l'application comme une *zone d'arrêt de premier niveau*. Cette notion est nécessaire pour gérer les *points d'arrêts sur itinéraire* utilisés par certains réseaux. + +L'application gère ensuite les points d'arrêts sur itinéraire à partir de ces arrêts physiques, en assurant le regroupement des points d'arrêt sur itinéraire dans un arrêt physique (cas de plusieurs lignes passant par le même arrêt physique). + +Par la suite, vous pourrez regrouper deux (ou plus) arrêts physiques au sein d'un *arrêt commercial* (par exemple pour regrouper les points d'arrêt physiques correspondant à deux poteaux d'arrêt de la même ligne situés de part et d'autre d'une chaussée mais aussi pour regrouper l'ensemble des points d'arrêt physiques d'un quai de gare routière pour lesquels vous considérez que le temps de correspondance est nul). Vous aurez ainsi constitué une zone d'arrêt, avec qualification arrêt commercial, de deuxième niveau. + +Enfin, CHOUETTE vous offre la possibilité de regrouper les lieux d'arrêt agglomérés ainsi créés au sein d'une *zone d'arrêt de troisième niveau* pour constituer des *pôles d'échange*. + +Ainsi on obtient les possibilités de regroupements suivants: +* un arrêt physique regroupe plusieurs arrêts itinéraire. +* un arrêt commercial regroupe plusieurs arrêts physiques (quai, embarquement). +* un pôle d'échange regroupe plusieurs arrêts commerciaux. + +Pour ne pas aboutir à un système trop complexe, les règles suivantes sont posées: +* un pôle d'échange peut contenir des arrêts commerciaux et/ou des pôles d'échanges (qui ne peuvent pas en contenir d'autres). +* un arrêt commercial ne peut contenir que des arrêts physiques. + +Un dernier regourpement est *l'ITL* : + +*L'interdiction de trafic local* est l'interdiction faite à un service routier de prendre et de laisser un même voyageur à l'intérieur du périmètre des transports urbains _(cf. Décret nº49-1473 du 14 novembre 1949)_ . +Ainsi dans CHOUETTE: +* Une ITL est un regroupement d'arrêts représentant le périmètre d'interdiction. +* Une ITL est associée à une ou plusieurs lignes + +h3. Attributs + +- Type d'arrêt := catégorie de l'arrêt + +* !boardingposition.png! point d'embarquement +* !quay.png! quai +* !commercialstoppoint.png! arrêt commercial +* !stopplace.png! pôle d'échange + +- Nom := nom de l'arrêt +- Commentaire := zone de texte libre +- Point d'intérêt le plus proche := nom du lieu desservi par l'arrêt +- Nom de la rue := nom de la rue de l'arrêt +- Code INSEE := code INSEE de la commune de l'arrêt +- Zone tarifaire := zone de tarification applicable à cet arrêt +- Numéro d'enregistrement := code référençant un arrêt au sein d'une autorité supérieure + +p(attr_data). Données géographiques : + +- Position X := coordonnée horizontale de l'arrêt dans le référentiel de projection de l'espace de données +- Position Y := coordonnée verticale de l'arrêt dans le référentiel de projection de l'espace de données +- Longitude := longitude de l'arrêt dans le référentiel WGS84 +- latitude := latitude de l'arrêt dans le référentiel WGS84 + +p(attr_data). Données de gestion : + +- Identifiant Neptune := +clé unique pérenne identifiant la ligne 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 = Line : 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 + 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 + diff --git a/app/views/layouts/_user_links.erb b/app/views/layouts/_user_links.erb index f82d4d7b4..ccbe17596 100644 --- a/app/views/layouts/_user_links.erb +++ b/app/views/layouts/_user_links.erb @@ -9,11 +9,11 @@ <% end %> <li> | </li> - <li class="<%= language_class("fr") %>"><%= link_to_language :fr %></li> - <li class="<%= language_class("en") %>"><%= link_to_language :en %></li> + <li class="<%= language_class('fr') %>"><%= link_to_language :fr %></li> + <li class="<%= language_class('en') %>"><%= link_to_language :en %></li> <li> <li> | </li> - <%= link_to "/help/index" do %> + <%= link_to help_path do %> <span class="help"><%= t('layouts.help') %></span> <% end %> </li> diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb index ceafd8944..f75b138fe 100644 --- a/app/views/layouts/application.html.erb +++ b/app/views/layouts/application.html.erb @@ -21,6 +21,8 @@ <div class="title"> <% if selected_referential? %> <h1><%= @referential.name %></h1> + <% elsif help_page? %> + <h1>Documentation</h1> <% end %> </div> <div class="interaction"> @@ -29,8 +31,10 @@ </div> <div class="tabs"> <ul class="main"> - <% unless selected_referential? %> - <li><%= tab_link_to Referential, referentials_path %></li> + <% if help_page? %> + <li><%= link_to "Aide", help_path, :class => "current" %></li> + <% elsif ! selected_referential? %> + <li><%= tab_link_to Referential, referentials_path, :class => "current" %></li> <% else %> <li><%= link_to t("layouts.tabs.dashboard"), referential_path(@referential), :class => ("current" if current_page?(referential_path(@referential))) %></li> <li><%= tab_link_to Chouette::Network, referential_networks_path(@referential) %></li> |