Skip to content

Commit

Permalink
Renamed files and links to change _ -> -
Browse files Browse the repository at this point in the history
... to bring in sync with the english docs in main
  • Loading branch information
fredericsimard committed Nov 6, 2024
1 parent e94e230 commit 83f0f70
Show file tree
Hide file tree
Showing 51 changed files with 167 additions and 24 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions docs/en/community/extensions/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For more information, contact [specifications@mobilitydata.org](mailto:specifica

!!! info "Making an extension official in the specification"

Extensions may become active proposals and subsequently [merged](../../../documentation/schedule/change_history/recent_additions/) into the official specification via the [Specification Amendment Process](../../governance/gtfs_schedule_amendment_process/).
Extensions may become active proposals and subsequently [merged](../../../documentation/schedule/change-history/recent_additions/) into the official specification via the [Specification Amendment Process](../../governance/gtfs_schedule_amendment_process/).

!!! note "Contributing to this list"

Expand Down Expand Up @@ -149,7 +149,7 @@ For more information, contact [specifications@mobilitydata.org](mailto:specifica

!!! info "Making an extension official in the specification"
Extensions may become active proposals and subsequently [merged](../../../documentation/realtime/change_history/recent_additions/) into the official specification via the [Specification Amendment Process](../../governance/gtfs_realtime_amendment_process/).
Extensions may become active proposals and subsequently [merged](../../../documentation/realtime/change-history/recent_additions/) into the official specification via the [Specification Amendment Process](../../governance/gtfs_realtime_amendment_process/).

!!! note "Contributing to this list"

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/en/documentation/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The specification currently supports the following types of information:
- Service alerts - stop moved, unforeseen events affecting a station, route or the entire network
- Vehicle positions - information about the vehicles including location and congestion level

To learn more about them visit the [Feed Entities](../realtime/feed_entities/overview) section.
To learn more about them visit the [Feed Entities](../realtime/feed-entities/overview) section.

GTFS Realtime was designed around ease of implementation, good GTFS interoperability and a focus on passenger information. This was possible through a partnership of the [initial Live Transit Updates](https://developers.google.com/transit/google-transit#LiveTransitUpdates) partner agencies, a number of transit developers and Google. The specification is published under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ A `Modification` message describes changes to each affected trip starting at `st

The sequence of `replacement_stops` may be of arbitrary length. For example, 3 stops could be replaced by 2, 4, or 0 stops as the situation may require.

![](/../assets/trip_modification.png)
![](/../assets/trip-modification.png)

_An example showing the effect of a modification on a particular trip. This modification may also be applied to several other trips._

![](/../assets/propagated_delay.png)
![](/../assets/propagated-delay.png)

_Propagated detour delays affect all stops following the end of a modification. If a trip has multiple modifications, the delays are accumulated._

Expand All @@ -54,6 +54,6 @@ The `departure_time` always equals the `arrival_time`.

The optional fields of [`stop_times.txt`](../../../schedule/reference/#stop_timestxt) in the (CSV) GTFS specification are all set to their default values.

![](/../assets/first_stop_reference.png)
![](/../assets/first-stop-reference.png)

_If a modification affects the first stop of the trip, that stop also serves as the reference stop of the modification._
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ General guidelines for trip cancellations:
| `vehicle` | Refer to [message VehicleDescriptor](#vehicledescriptor). |
| | If separate `VehiclePosition` and `TripUpdate` feeds are provided, [TripDescriptor](#tripdescriptor) and [VehicleDescriptor](#vehicledescriptor) ID values pairing should match between the two feeds.<br><br>For example, a `VehiclePosition` entity has `vehicle_id:A` and `trip_id:4`, then the corresponding `TripUpdate` entity should also have `vehicle_id:A` and `trip_id:4`. If any `TripUpdate` entity has `trip_id:4` and any `vehicle_id` other than 4, this is an error. |
| `stop_time_update` | `stop_time_updates` for a given `trip_id` should be strictly ordered by increasing `stop_sequence` and no `stop_sequence` should be repeated. |
| | While the trip is in progress, all `TripUpdates` should include at least one `stop_time_update` with a predicted arrival or departure time in the future. Note that the [GTFS Realtime spec](../feed_entities/trip-updates/#stoptimeupdate) says that producers should not drop a past `StopTimeUpdate` if it refers to a stop with a scheduled arrival time in the future for the given trip (i.e. the vehicle has passed the stop ahead of schedule), as otherwise it will be concluded that there is no update for this stop. |
| | While the trip is in progress, all `TripUpdates` should include at least one `stop_time_update` with a predicted arrival or departure time in the future. Note that the [GTFS Realtime spec](../feed-entities/trip-updates/#stoptimeupdate) says that producers should not drop a past `StopTimeUpdate` if it refers to a stop with a scheduled arrival time in the future for the given trip (i.e. the vehicle has passed the stop ahead of schedule), as otherwise it will be concluded that there is no update for this stop. |
| `timestamp` | Should reflect the time this prediction for this trip was updated. |
| `delay` | `TripUpdate.delay` should represent schedule deviation, i.e., the observed past value for how ahead/behind schedule the vehicle is. Predictions for future stops should be provided through `StopTimeEvent.delay` or `StopTimeEvent.time`. |

Expand Down
12 changes: 6 additions & 6 deletions docs/en/documentation/realtime/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ A definition (or update) of an entity in the transit feed. If the entity is not

### _message_ TripUpdate

Realtime update on the progress of a vehicle along a trip. Please also refer to the general discussion of the [trip updates entities](../../../documentation/realtime/feed_entities/trip-updates).
Realtime update on the progress of a vehicle along a trip. Please also refer to the general discussion of the [trip updates entities](../../../documentation/realtime/feed-entities/trip-updates).
upd
Depending on the value of ScheduleRelationship, a TripUpdate can specify:

Expand Down Expand Up @@ -187,7 +187,7 @@ Uncertainty applies equally to both time and delay. The uncertainty roughly spec

### _message_ StopTimeUpdate

Realtime update for arrival and/or departure events for a given stop on a trip. Please also refer to the general discussion of stop time updates in the [TripDescriptor](#message-tripdescriptor) and [trip updates entities](../../../documentation/realtime/feed_entities/trip-updates) documentation.
Realtime update for arrival and/or departure events for a given stop on a trip. Please also refer to the general discussion of stop time updates in the [TripDescriptor](#message-tripdescriptor) and [trip updates entities](../../../documentation/realtime/feed-entities/trip-updates) documentation.

Updates can be supplied for both past and future events. The producer is allowed, although not required, to drop past events.
The update is linked to a specific stop either through stop_sequence or stop_id, so one of these fields must necessarily be set. If the same stop_id is visited more than once in a trip, then stop_sequence should be provided in all StopTimeUpdates for that stop_id on that trip.
Expand Down Expand Up @@ -617,7 +617,7 @@ A `TripModifications` message identifies a list of similar trips which are all a

<br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.

[More about Trip Modifications...](../../../documentation/realtime/feed_entities/trip-modifications)
[More about Trip Modifications...](../../../documentation/realtime/feed-entities/trip-modifications)

**Fields**

Expand All @@ -634,11 +634,11 @@ A `Modification` message describes changes to each affected trip starting at `st

<br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.

<img src="../../../assets/trip_modification.png">
<img src="../../../assets/trip-modification.png">

_An example showing the effect of a modification on a particular trip. This modification may also be applied to several other trips._

<img src="../../../assets/propagated_delay.png">
<img src="../../../assets/propagated-delay.png">

_Propagated detour delays affect all stops following the end of a modification. If a trip has multiple modifications, the delays are accumulated._

Expand Down Expand Up @@ -686,7 +686,7 @@ Each `ReplacementStop` message defines a stop that will now be visited by the tr

<br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.

<img src="../../../assets/first_stop_reference.png">
<img src="../../../assets/first-stop-reference.png">

_If a modification affects the first stop of the trip, that stop also serves as the reference stop of the modification._

Expand Down
4 changes: 2 additions & 2 deletions docs/en/documentation/schedule/examples/fares-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,6 @@ Alternatively, a user traveling in train #883 (`service_id=13`) would pay an Out
In <a href="https://apple.com/maps" target="_blank">Apple Maps</a>, riders can see how their fare price changes and compare fare prices next to the train scheduled departure:

<div class="flex-photos">
<img src="../../../../assets/TimeVariableFares_Peak.png" alt="Outbound Adult Peak Zonal Fare of 20.00 USD">
<img src="../../../../assets/TimeVariableFares_OffPeak.png" alt="Outbound Adult Off Peak Zonal Fare of 15.00 USD">
<img src="../../../../assets/TimeVariableFares-Peak.png" alt="Outbound Adult Peak Zonal Fare of 20.00 USD">
<img src="../../../../assets/TimeVariableFares-OffPeak.png" alt="Outbound Adult Off Peak Zonal Fare of 15.00 USD">
</div>
8 changes: 4 additions & 4 deletions docs/en/documentation/schedule/examples/flex.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following example demonstrates how to model different demand-responsive serv

Demand-responsive services can operate within a specific zone, allowing riders to book pickups at any point A within the zone and drop-offs at any point B within the same zone. An example of this is the [Heartland Express Transit](https://www.co.brown.mn.us/heartland-express-transit?view=category&id=56) service in Minnesota, USA.

<sup>[Download Heartland Express example dataset](../../../assets/on-demand_services_within_a_single_zone.zip)</sup>
<sup>[Download Heartland Express example dataset](../../../assets/on-demand-services-within-a-single-zone.zip)</sup>

### Define trips

Expand Down Expand Up @@ -115,7 +115,7 @@ t_5374947_b_77497_tn_0 | area_715 | 2 | 08:00:00 | 12:45:00 | 1 | 2 | booking_ro

Some demand-responsive services operate across multiple distinct zones, where riders can book pickups at any location A within one area and drop-offs at any location within another area. For example, [Minnesota River Valley Transit](https://www.saintpetermn.gov/330/Dial-a-Ride) offers on-demand services between Saint Peter and Kasota cities:

<sup>[Download River Valley Transit example dataset](../../../assets/on-demand_services_between_multiple_zones(r).zip)</sup>
<sup>[Download River Valley Transit example dataset](../../../assets/on-demand-services-between-multiple-zones(r).zip)</sup>

### Define trips

Expand Down Expand Up @@ -215,7 +215,7 @@ trip_id | location_group_id | stop_sequence | start_pickup_drop_off_window | end

In this example, the [Hermann Express](https://www.newulmmn.gov/553/Hermann-Express-City-Bus-Service) service in New Ulm City allows users to be picked up only at fixed stops and to be dropped off at any point within a specific deviation area between these stops.

**The example below has been simplified, download the [Hermann Express example dataset](../../../assets/deviated _drop-off _route.zip) for more details.**
**The example below has been simplified, download the [Hermann Express example dataset](../../../assets/deviated-drop-off-route.zip) for more details.**

### Define trips

Expand All @@ -236,7 +236,7 @@ route_id | service_id | trip_id | share_id
Using [locations.geojson](../../reference/#locationsgeojson) to define zones for deviated route. Typically, deviations are limited to keep the service on schedule. Therefore, as the vehicle travels, the deviation area between each fixed stop may vary accordingly. The area for route deviation may look like the image below:

<div class="flex-photos">
<img src="../../../../assets/deviated_route_zones.png" alt="deviated route zones">
<img src="../../../../assets/deviated-route-zones.png" alt="deviated route zones">
</div>

### Define stop times
Expand Down
2 changes: 1 addition & 1 deletion docs/en/documentation/schedule/reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## General Transit Feed Specification Reference

**Revised Aug 16, 2024. See [Revision History](../change_history/revision_history) for more details.**
**Revised Aug 16, 2024. See [Revision History](../change-history/revision_history) for more details.**

This document defines the format and structure of the files that comprise a GTFS dataset.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Specification reference amendments are subject to a higher bar of scrutiny and c

### How to check for conformance with these Best Practices?

The Canonical GTFS Schedule Validator checks for compliance against these Best Practices. You can find more about this validation tool on the [validate page](../../../getting_started/validate).
The Canonical GTFS Schedule Validator checks for compliance against these Best Practices. You can find more about this validation tool on the [validate page](../../../getting-started/validate).

### I represent a transit agency. What steps can I take so that our software service providers and vendors follow these Best Practices?

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The free and open-source [Canonical GTFS Schedule validator](https://gtfs-valida
</div>
<div class="usage-video">
<video class="center" width="560" height="315" controls>
<source src="../../assets/validator_demo_large.mp4" type="video/mp4">
<source src="../../assets/validator-demo-large.mp4" type="video/mp4">
</video>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The General Transit Feed Specification, also known as GTFS, is a standardized da

It allows public transit agencies to publish their transit data in a format that can be consumed by a wide variety of software applications, most commonly trip planners. This means that users can easily get travel information to access public transit services by using their smartphones or similar devices.

<img class="center" width="560" height="100%" src="../../../assets/what_is_gtfs_001.png">
<img class="center" width="560" height="100%" src="../../../assets/what-is-gtfs-001.png">

Today, GTFS is the go-to [Open Standard](https://www.interoperablemobility.org/definitions/#open_standard) for thousands of public transport providers worldwide. Some agencies produce this data themselves, while others employ a vendor to create and maintain data for them.

## Support for static and dynamic data

GTFS consists of two main parts: [GTFS Schedule](../../documentation/schedule/reference) and [GTFS Realtime](../../documentation/realtime/reference).

<img class="center" width="560" height="100%" src="../../../assets/what_is_gtfs_002.png">
<img class="center" width="560" height="100%" src="../../../assets/what-is-gtfs-002.png">

GTFS Schedule contains information about routes, schedules, fares, and geographic transit details among many other features, and it is presented in simple text files[^1]. This straightforward format allows for easy creation and maintenance without relying on complex or proprietary software.

Expand Down
File renamed without changes.
Loading

0 comments on commit 83f0f70

Please sign in to comment.