Create Shapes example page (#551)

* Adds shapes example page (EN only) This commit adds a new page for shapes examples along with 8 images (added to the EN assets folder) and a modification to mkdocs.yml to update navigation menu * Reduce image size in EN assets * Reduce image size (2) in EN assets * ES translation * Remove space in ES translation * Update spacing in ES translation * Add images to assets folders in FR and JA
MobilityData · Dec 5, 2024 · 804e3d7 · 804e3d7
1 parent dfb44c2
commit 804e3d7
Show file tree

Hide file tree

Showing 35 changed files with 77 additions and 0 deletions.
diff --git a/docs/en/assets/shapes-1.png b/docs/en/assets/shapes-1.png
diff --git a/docs/en/assets/shapes-2a.png b/docs/en/assets/shapes-2a.png
diff --git a/docs/en/assets/shapes-2b.png b/docs/en/assets/shapes-2b.png
diff --git a/docs/en/assets/shapes-3.png b/docs/en/assets/shapes-3.png
diff --git a/docs/en/assets/shapes-4a.png b/docs/en/assets/shapes-4a.png
diff --git a/docs/en/assets/shapes-4b.png b/docs/en/assets/shapes-4b.png
diff --git a/docs/en/assets/shapes-5.png b/docs/en/assets/shapes-5.png
diff --git a/docs/en/assets/shapes-6.png b/docs/en/assets/shapes-6.png
diff --git a/docs/en/documentation/schedule/examples/shapes.md b/docs/en/documentation/schedule/examples/shapes.md
@@ -0,0 +1,38 @@
+# Shapes
+
+## Shapes Data Guidance
+
+The data contained in shapes.txt file plays a critical role in the representation of transit services. Properly constructed shapes improve the accuracy of trip visualizations in trip planning applications, ensuring a seamless experience for riders. The following recommended practices provide guidance on creating high-quality shape data that accurately represents vehicle movements and aligns with physical travel paths.
+
+1. When the travel path between stops is not a straight line, avoid defining the shape with only two points. Ensure the shape accurately reflects the vehicle's travel path.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-1.png">
+
+
+2. Ensure that shapes start from the origin station and end at the destination station. Avoid shapes that are too short or too long.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-2a.png">
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-2b.png">
+
+3. Within a shape defined by a single shape_id, avoid illogical backtracking or unnecessary point reversals.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-3.png">
+
+4. Ensure that shapes align with the path that vehicles travel along in the WGS84 coordinate system, avoid offsets caused by differing coordinate systems.
+
+    - For roadway services (e.g., bus), alignments should follow the centerline of the roadway the vehicle travels on. This may be either the centerline of the street if there are no designated lanes or the centerline of the travel direction side if lanes are specified.
+
+        <img class="center" width="1500" height="100%" src="../../../../assets/shapes-4a.png">
+
+    - For rail services (e.g., subway, train, light rail), shapes should follow the tracks that the train travels on. If a trip does not always travel on a specific track in certain areas and multiple tracks exist, ensure the shape stays within the range of tracks on which the train may operate.
+
+        <img class="center" width="1500" height="100%" src="../../../../assets/shapes-4b.png">
+
+5. When the vehicle travels along curves, shape points should be dense enough to allow for a visually smooth presentation for riders.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-5.png">
+
+6. Alignments should not “jag” to a curb stop, platform, or boarding location.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-6.png">
diff --git a/docs/es/assets/shapes-1.png b/docs/es/assets/shapes-1.png
diff --git a/docs/es/assets/shapes-2a.png b/docs/es/assets/shapes-2a.png
diff --git a/docs/es/assets/shapes-2b.png b/docs/es/assets/shapes-2b.png
diff --git a/docs/es/assets/shapes-3.png b/docs/es/assets/shapes-3.png
diff --git a/docs/es/assets/shapes-4a.png b/docs/es/assets/shapes-4a.png
diff --git a/docs/es/assets/shapes-4b.png b/docs/es/assets/shapes-4b.png
diff --git a/docs/es/assets/shapes-5.png b/docs/es/assets/shapes-5.png
diff --git a/docs/es/assets/shapes-6.png b/docs/es/assets/shapes-6.png
diff --git a/docs/es/documentation/schedule/examples/shapes.md b/docs/es/documentation/schedule/examples/shapes.md
@@ -0,0 +1,37 @@
+# Shapes
+
+## Guía de datos de Shapes 
+
+Los datos contenidos en el archivo shapes.txt desempeñan un papel fundamental en la representación de los servicios de tránsito. Las shapes construidos correctamente mejoran la precisión de las visualizaciones en las aplicaciones de planificación de viajes, lo cual garantiza una experiencia ideal para los pasajeros. Las siguientes prácticas recomendadas brindan orientación sobre la creación shapes de alta calidad que representan con precisión los movimientos del vehículo y se alinean con las rutas físicas de los viajes.
+
+  1. Cuando la ruta de viaje entre paradas no sea una línea recta, evite definir la forma con solo dos puntos. Asegúrese de que la forma refleje con precisión la ruta de viaje del vehículo.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-1.png"> 
+
+  2. Asegúrese de que las formas comiencen en la estación de origen y finalicen en la estación de destino. Evite formas que sean demasiado cortas o demasiado largas.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-2a.png">
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-2b.png"> 
+
+  3. Dentro de una forma definida por un solo shape_id, evite retrocesos ilógicos o inversiones de puntos innecesarias.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-3.png"> 
+
+  4. Asegúrese de que las formas se alineen con la ruta que recorren los vehículos en el sistema de coordenadas WGS84, evite los desfases causados por diferentes sistemas de coordenadas.
+
+      - Para los servicios viales (por ejemplo, autobús), las alineaciones deben seguir la línea central de la calle era por la cual circula el vehículo. Esta puede ser la línea central de la calle si no hay carriles designados o la línea central del lado de la dirección de viaje si se especifican carriles.
+
+       <img class="center" width="1500" height="100%" src="../../../../assets/shapes-4a.png"> 
+
+      - En el caso de los servicios ferroviarios (por ejemplo, metro, tren, tranvía), las formas deben seguir las vías por las que circula el tren. Si un viaje no siempre transcurre por una vía específica en determinadas áreas y existen varias vías, asegúrese de que la forma se mantenga dentro del rango de vías por las que puede circular el tren.
+
+       <img class="center" width="1500" height="100%" src="../../../../assets/shapes-4b.png"> 
+
+  5. Cuando el vehículo circule por curvas, los puntos de forma deben ser lo suficientemente densos para permitir una presentación visualmente fluida para los pasajeros.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-5.png"> 
+
+  6. Las alineaciones no deben “desviarse” a una parada en la acera, una plataforma o un lugar de embarque.
+
+    <img class="center" width="1500" height="100%" src="../../../../assets/shapes-6.png">
diff --git a/docs/fr/assets/shapes-1.png b/docs/fr/assets/shapes-1.png
diff --git a/docs/fr/assets/shapes-2a.png b/docs/fr/assets/shapes-2a.png
diff --git a/docs/fr/assets/shapes-2b.png b/docs/fr/assets/shapes-2b.png
diff --git a/docs/fr/assets/shapes-3.png b/docs/fr/assets/shapes-3.png
diff --git a/docs/fr/assets/shapes-4a.png b/docs/fr/assets/shapes-4a.png
diff --git a/docs/fr/assets/shapes-4b.png b/docs/fr/assets/shapes-4b.png
diff --git a/docs/fr/assets/shapes-5.png b/docs/fr/assets/shapes-5.png
diff --git a/docs/fr/assets/shapes-6.png b/docs/fr/assets/shapes-6.png
diff --git a/docs/ja/assets/shapes-1.png b/docs/ja/assets/shapes-1.png
diff --git a/docs/ja/assets/shapes-2a.png b/docs/ja/assets/shapes-2a.png
diff --git a/docs/ja/assets/shapes-2b.png b/docs/ja/assets/shapes-2b.png
diff --git a/docs/ja/assets/shapes-3.png b/docs/ja/assets/shapes-3.png
diff --git a/docs/ja/assets/shapes-4a.png b/docs/ja/assets/shapes-4a.png
diff --git a/docs/ja/assets/shapes-4b.png b/docs/ja/assets/shapes-4b.png
diff --git a/docs/ja/assets/shapes-5.png b/docs/ja/assets/shapes-5.png
diff --git a/docs/ja/assets/shapes-6.png b/docs/ja/assets/shapes-6.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -189,6 +189,7 @@ plugins:
             Frequencies: Frecuencias
             Pathways: Recorridos (Pathways)
             Routes, Stops & Trips: Rutas, Paradas y Viajes
+            Shapes: Shapes
             Text-to-speech: Texto a voz
             Transfers: Transferencias
             Translations: Traducciones
@@ -412,6 +413,7 @@ nav:
         - Frequencies: documentation/schedule/examples/frequencies.md
         - Pathways: documentation/schedule/examples/pathways.md
         - Routes, Stops & Trips: documentation/schedule/examples/routes-stops-trips.md
+        - Shapes: documentation/schedule/examples/shapes.md
         - Text-to-speech: documentation/schedule/examples/text-to-speech.md
         - Transfers: documentation/schedule/examples/transfers.md
         - Translations: documentation/schedule/examples/translations.md