Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Commit

Permalink
Update Recent Additions pages (#47)
Browse files Browse the repository at this point in the history
* Update Schedule changes

Updates page and adds latest change (Flex adoption)

* Fix format for Realtime recent additions

* Adds latest RT changes

* Address comments 20240527

* Update section structure & navigation

* Update links on Recent Additions pages

* Update Revision History content

* Updates name for spec amendment process section

* Fix typo
  • Loading branch information
Sergiodero authored May 31, 2024
1 parent 7956724 commit 6feed51
Show file tree
Hide file tree
Showing 8 changed files with 594 additions and 157 deletions.
Original file line number Diff line number Diff line change
@@ -1,23 +1,8 @@
# GTFS Realtime Changes

The GTFS Realtime Specification is not set in stone. Instead, it is an open specification developed and maintained by the community of transit agencies, developers, and other stakeholders who use GTFS Realtime. It is expected that this community of producers and consumers of GTFS Realtime data will have proposals for extending the spec to enable new capabilities.
The GTFS Realtime Reference is not set in stone. Instead, it is an open specification developed and maintained by the community of transit agencies, developers, and other stakeholders who use GTFS Realtime. It is expected that this community of producers and consumers of GTFS Realtime data will have proposals for extending the spec to enable new capabilities.

To contribute to GTFS Realtime, read the [Specification Amendment Process](../process) and follow the discussions in the open <a href="https://github.com/google/transit/issues" target="_blank">issues</a> and <a href="https://github.com/google/transit/pulls" target="_blank">pull requests</a> on Google's Transit Github repository (<a href="https://github.com/google/transit" target="_blank">google/transit</a>). ![](../../assets/mark-github.svg)


!!! note ""

The official specification, reference and documentation are written in English. If a translation to a different language differs from the English original, the latter takes precedence. All communication is performed in English.

<!-- <br><div class="landing-page">
<a class="button" href="../process">Specification Amendment Process</a><a class="button" href="../guiding-principles">Guiding Principles</a><a class="button" href="../revision-history">Revision History</a><a class="button" href="../extensions">Realtime Extensions</a>
</div> -->

## Active Proposals &ensp;<img src="../../assets/pr-active.svg" style="height:1em;"/>

<!-- Active proposals for new features in GTFS Realtime. -->

Join the discussions on <a href="https://github.com/google/transit/pulls" target="_blank">Github</a> !
To contribute to GTFS Realtime, read the [GTFS Realtime Amendment Process](../../../../community/governance/gtfs_realtime_amendment_process) and follow the discussions in the open <a href="https://github.com/google/transit/issues" target="_blank">issues</a> and <a href="https://github.com/google/transit/pulls" target="_blank">pull requests</a> on the GTFS Github repository (<a href="https://github.com/google/transit" target="_blank">google/transit</a>). ![](../../../assets/mark-github.svg)

<!-- <div class="row">
<div class="active-container">
Expand All @@ -35,10 +20,36 @@ Join the discussions on <a href="https://github.com/google/transit/pulls" target
</div>
<div class="row"></div> -->

## Recently Merged Proposals &ensp;<img src="../../assets/pr-merged.svg" style="height:1em;"/>
## Recently Adopted Proposals &ensp;<img src="../../../../assets/pr-merged.svg" style="height:1em;"/>

Recently merged proposals that are now features of the [official GTFS Realtime reference](../../reference). See the complete [Revision History](/documentation/Realtime/change_history/revision_history) for more.


Recently merged proposals that are now features of the [official GTFS Realtime specification](../reference). See the complete [Revision History](../process#revision-history) for more.
<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/403" class="no-icon" target="_blank">Add Trip-Modifications</a></h3>
<p class="maintainer">#332 by <a href="https://github.com/gcamp" class="no-icon" target="_blank">gcamp</a> was merged on Mar 11, 2024</p>
</div>
<div class="featurelist">
<ul>
<li>Adds Trip modifications as an experimental feature which is used to describe detours, which affect a set of trips.</li>
<li>A trip modification can cancel certain stops, adjust the timing for trips, provide a new shape that trips will take and provide the location of temporary stops along the way. </li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/352" class="no-icon" target="_blank">Add DELETED enum to schedule_relationship</a></h3>
<p class="maintainer">#332 by <a href="https://github.com/mads14" class="no-icon" target="_blank">mads14</a> was merged on Nov 30, 2022</p>
</div>
<div class="featurelist">
<ul>
<li>Adds a new experimental <code>DELETED</code> trip schedule_relationship enum</li>
<li>This can be used to convey that a transit provider intends for a trip to entirely disappear from public-facing applications</li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
Expand All @@ -54,7 +65,7 @@ Recently merged proposals that are now features of the [official GTFS Realtime s

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/340" class="no-icon" target="_blank">GTFS-rt : wheelchair access update</a></h3>
<h3 class="title"><a href="https://github.com/google/transit/pull/340" class="no-icon" target="_blank">GTFS-rt: wheelchair access update</a></h3>
<p class="maintainer">#340 by <a href="https://github.com/flaktack" class="no-icon" target="_blank">flaktack</a> was merged on Jul 25, 2022</p>
</div>
<div class="featurelist">
Expand Down Expand Up @@ -91,16 +102,4 @@ Recently merged proposals that are now features of the [official GTFS Realtime s
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/260" class="no-icon" target="_blank">Add departure_occupancy_status to TripUpdate</a></h3>
<p class="maintainer">#260 by <a href="https://github.com/jakehoare" class="no-icon" target="_blank">jakehoare</a> was merged on Apr 14, 2021</p>
</div>
<div class="featurelist">
<ul>
<li>Provide the predicted occupancy of transit vehicles at future stops based on current or historical data</li>
</ul>
</div>
</div>

<div class="row"></div>
124 changes: 124 additions & 0 deletions docs/documentation/Realtime/change_history/revision_history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# GTFS Realtime

### Revision History

#### March 2024

* Adopted Trip-Modifications. See [discussion](https://github.com/google/transit/pull/403).

#### November 2022

* Added support for DELETED trips. See [discussion](https://github.com/google/transit/pull/352).

#### July 2022

* Add cause_detail and effect_detail. See [discussion](https://github.com/google/transit/pull/332)
* Added ability to specify a wheelchair_accessible value in a TripUpdate.VehicleDescriptor. See [discussion](https://github.com/google/transit/pull/340).

#### September 2021

* Feature/image in alerts. See [discussion](https://github.com/google/transit/pull/283).

#### August 2021

* Add GTFS-NewShapes as experimental. See [discussion](https://github.com/google/transit/pull/272).

#### April 2021

* Add departure_occupancy_status to TripUpdate. See [discussion](https://github.com/google/transit/pull/260).

#### February 2021

* Clarification of GTFS Realtime occupancy descriptions. See [discussion](https://github.com/google/transit/pull/259).

#### September 2020

* Support multi-car crowding. See [discussion](https://github.com/google/transit/pull/237).

#### April 2020

* Support stop assignments. See [discussion](https://github.com/google/transit/pull/219).

#### July 2020

* Support DUPLICATED trips. See [discussion](https://github.com/google/transit/pull/221).
* Alert tts_header_text, tts_description_text no longer experimental. See [discussion](https://github.com/google/transit/pull/229).
* Label GTFS-RT ADDED trips as not fully specified. See [discussion](https://github.com/google/transit/pull/230).

#### April 2020

* Mark SeverityLevel as final. See [discussion](https://github.com/google/transit/pull/214).
* Add occupancy_percentage. See [discussion](https://github.com/google/transit/pull/213).

#### March 12, 2020

* Recommend providing TripUpdate predictions for the next trip in block. See [discussion](https://github.com/google/transit/pull/206).

#### August 2019

* Document that trip_updates are not required to occur in feed in block-order. See [discussion](https://github.com/google/transit/pull/176).
* Add StopTimeUpdate.ScheduleRelationship UNSCHEDULED value. See [discussion](https://github.com/google/transit/pull/173).

#### May 2019

* Add accessibility issue alert effect. See [discussion](https://github.com/google/transit/pull/164).

#### February 2019

* Add NO_EFFECT effect option for GTFS-realtime service alert. See [discussion](https://github.com/google/transit/pull/137).
* Add new optional field SeverityLevel to Service Alerts feed. See [discussion](https://github.com/google/transit/pull/136).
* Add new optional fields for Text-to-Speech functionality in Service Alerts feed. See [discussion](https://github.com/google/transit/pull/135).

#### April 2018

* Remove requirement for stop_time_update arrival AND departure for SCHEDULED trips. See [discussion](https://github.com/google/transit/pull/165).

#### August 2017

* Define semantic cardinality for GTFS-realtime fields. See [discussion](https://github.com/google/transit/pull/64).

#### January 30, 2015

* Added Protocol Buffer extension namespace to all remaining GTFS-realtime messages that didn't already have one (such as `FeedMessage` and `FeedEntity`).

#### January 28, 2015

* Added experimental field `delay` to `TripUpdate` ([discussion](https://groups.google.com/forum/#!topic/gtfs-realtime/NsTIRQdMNN8)).

#### January 16, 2015

* Update description of `TripDescriptor.start_time`.

#### January 8, 2015

* Defined experimental enum `OccupancyStatus`.
* Added experimental field `occupancy_status` to `VehiclePosition` ([discussion](https://groups.google.com/forum/#!topic/gtfs-realtime/_HtNTGp5LxM)).

#### May 22, 2014

* Updated description of `ScheduleRelationship` enum in `StopTimeUpdate` message ([discussion](https://groups.google.com/forum/#!topic/gtfs-realtime/77c3WZrGBnI)).
* Removed REPLACEMENT from `ScheduleRelationship` enum values in `TripDescriptor` message ([discussion](https://groups.google.com/forum/#!topic/gtfs-realtime/77c3WZrGBnI)).

#### Oct 12, 2012

* Added timestamp field to `TripUpdate` message.

#### May 30, 2012

* Added specific details about Extensions to the specification.

#### November 30, 2011

* Added Protocol Buffer extension namespace to key GTFS-realtime messages to facilitate writing extensions to the spec.

#### October 25, 2011

* Updated documentation to clarify that `alert`, `header_text` and `description_text` are both plain-text values.

#### August 20, 2011

* Updated documentation to clarify semantics of the `TimeRange` message.

#### August 22, 2011

* Initial version.
110 changes: 110 additions & 0 deletions docs/documentation/schedule/change_history/recent_additions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# GTFS Schedule Changes

The GTFS Schedule Reference is not set in stone. Instead, it is an open specification developed and maintained by the community of transit agencies, developers, and other stakeholders who use GTFS. It is expected that this community of producers and consumers of GTFS data will have proposals for extending the spec to enable new capabilities.

To contribute to GTFS, read the [GTFS Schedule Amendment Process](../../../../community/governance/gtfs_schedule_amendment_process) and follow the discussions in the open <a href="https://github.com/google/transit/issues" target="_blank">issues</a> and <a href="https://github.com/google/transit/pulls" target="_blank">pull requests</a> on the GTFS Github repository (<a href="https://github.com/google/transit" target="_blank">google/transit</a>). ![](../../../assets/mark-github.svg)

<!-- <div class="row">
<div class="active-container">
<h3 class="title"><a class="no-icon" href="https://github.com/google/transit/pull/303" target="_blank">Add trip-to-trip transfers with in-seat option</a></h3>
<p class="maintainer">#303 opened on Jan 26, 2022 by <a class="no-icon" href="https://github.com/gcamp" target="_blank">gcamp</a></p>
</div>
</div>
<div class="row"></div> -->

<!-- <div class="row no-active">
<div class="no-active-container">
<h3 class="title">There are currently no active proposals for GTFS Schedule.</h3>
<p class="prompt">Have a proposal? &ensp;➜&ensp; Open a <a href="https://github.com/google/transit/pulls" target="_blank">pull request</a>.</p>
</div>
</div>
<div class="row"></div> -->

## Recently Adopted Proposals &ensp;<img src="../../../../assets/pr-merged.svg" style="height:1em;"/>

Recently merged proposals that are now features of the [official GTFS Schedule Reference](../../reference). See the complete [Revision History](/documentation/schedule/change_history/revision_history) for more.

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/433" class="no-icon" target="_blank">Adopt GTFS Flex</a></h3>
<p class="maintainer">#433 by <a href="https://github.com/tzujenchanmbd" class="no-icon" target="_blank">tzujenchanmbd</a> was merged on Mar 19, 2024</p>
</div>
<div class="featurelist">
<ul>
<li>The <a href="../../../../community/extensions/flex" class="no-icon" target="_blank">GTFS-Flex proposal</a> allows passengers to discover demand-responsive services on trip planners</li>
<li>Multiple files have been added to the specification, including locations.geojson which integrates GeoJson in GTFS </li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/405" class="no-icon" target="_blank">Add networks.txt & route_networks.txt</a></h3>
<p class="maintainer">#406 by <a href="https://github.com/tzujenchanmbd" class="no-icon" target="_blank">tzujenchanmbd</a> was merged on Nov 28, 2023</p>
</div>
<div class="featurelist">
<ul>
<li>Adds two new files: <code>networks.txt</code> and <code>route_networks.txt</code> to build networks of routes that are associated to fares</li>
<li>Provides an alternative to <code>routes.network_id</code> so that schedule and fare files can be distinct</li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/406" class="no-icon" target="_blank">Best Practices: Add Dataset Publishing guidelines<br>and Practice Recommendations for all files</a></h3>
<p class="maintainer">#406 by <a href="https://github.com/Sergiodero" class="no-icon" target="_blank">Sergiodero</a> was merged on Nov 16, 2023</p>
</div>
<div class="featurelist">
<ul>
<li>Adds two sections of the GTFS Best Practices to the specification: Dataset Publishing guidelines and Practice Recommendations for all files</li>
<li>Updates a reference to Google’s transitfeed tool merge function, so it references a list of merge tools instead</li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/386" class="no-icon" target="_blank">Best practices: add recommended presence</a></h3>
<p class="maintainer">#386 by <a href="https://github.com/emmambd" class="no-icon" target="_blank">emmambd</a> was merged on Aug 1, 2023</p>
</div>
<div class="featurelist">
<ul>
<li>Adds a new Recommended presence in the specification that conforms to RFC conventions</li>
<li>Allows to clearly state that a field or file is not required, but adding it is a best practice that should be considered</li>
<li>Updates information for multiple files and fields to reflect their recommended presence based on GTFS Best Practices</li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/357" class="no-icon" target="_blank">Add variable fares by time or day</a></h3>
<p class="maintainer">#357 by <a href="https://github.com/isabelle-dr" class="no-icon" target="_blank">isabelle-dr</a> was merged on Jul 27, 2023</p>
</div>
<div class="featurelist">
<ul>
<li>Time-variable fares is an important functionality developed as part of the <a href="../../../../community/extensions/fares-v2">GTFS Fares-v2 extension proposal</a></li>
<li>Allows to represent fares differentiated based on the time of the day or the day of the week, such as peak and off-peak fares</li>
<li>Adds a new file: <code>timeframes.txt</code>, to define moments in time where the fare applies</li>
<li>Extends <code>fare_leg_rules.txt</code> with <code>from_timeframe_id</code>, and <code>to_timeframe_id</code> to specify that a fare leg rule applies only if the beginning or end of the leg is in a specified timeframe</li>
</ul>
</div>
</div>

<div class="row">
<div class="leftcontainer">
<h3 class="title"><a href="https://github.com/google/transit/pull/355" class="no-icon" target="_blank">Add fare media</a></h3>
<p class="maintainer">#355 by <a href="https://github.com/isabelle-dr" class="no-icon" target="_blank">isabelle-dr</a> was merged on Mar 14, 2023</p>
</div>
<div class="featurelist">
<ul>
<li>Fare Media is a key element on the <a href="../../../../community/extensions/fares-v2">GTFS Fares-v2 extension proposal</a></li>
<li>It represents what a rider can use to validate their ride (e.g. a transit card, mobile app, or tap-to-pay using a contactless bank card)</li>
<li>A fare product can be associated to a specific Fare Media (e.g. a monthly pass is only available on a transit card)</li>
<li>The price of a fare product can be defined based on the Fare Media (e.g. the ticket is cheaper if bought via a mobile app)</li>
</ul>
</div>
</div>

<div class="row"></div>
Loading

0 comments on commit 6feed51

Please sign in to comment.